<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Barry: parser.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_3e14c0bb4416cf979afc3165665fc916.html">src</a>
</div>
</div>
<div class="contents">
<h1>parser.h</h1><a href="parser_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file parser.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Virtual parser wrapper</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2005-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_PARSER_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_PARSER_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="data_8h.html" title="Class to deal with pre-saved data files.">data.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="protocol_8h.html" title="USB Blackberry bulk protocol API constants.">protocol.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <stdint.h></span> <span class="comment">// for uint32_t</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <iosfwd></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <map></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">// forward declarations</span>
<a name="l00033"></a>00033 <span class="keyword">namespace </span>Barry {
<a name="l00034"></a>00034 <span class="keyword">class </span>IConverter;
<a name="l00035"></a>00035 <span class="keyword">class </span>Contact;
<a name="l00036"></a>00036 <span class="keyword">class </span>Message;
<a name="l00037"></a>00037 <span class="keyword">class </span>Calendar;
<a name="l00038"></a>00038 <span class="keyword">class </span>CalendarAll;
<a name="l00039"></a>00039 <span class="keyword">class </span>CallLog;
<a name="l00040"></a>00040 <span class="keyword">class </span>Bookmark;
<a name="l00041"></a>00041 <span class="keyword">class </span>ServiceBook;
<a name="l00042"></a>00042 <span class="keyword">class </span>Memo;
<a name="l00043"></a>00043 <span class="keyword">class </span>Task;
<a name="l00044"></a>00044 <span class="keyword">class </span>PINMessage;
<a name="l00045"></a>00045 <span class="keyword">class </span>SavedMessage;
<a name="l00046"></a>00046 <span class="keyword">class </span>Sms;
<a name="l00047"></a>00047 <span class="keyword">class </span>Folder;
<a name="l00048"></a>00048 <span class="keyword">class </span>Timezone;
<a name="l00049"></a>00049 <span class="keyword">class </span>ContentStore;
<a name="l00050"></a>00050 }
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="comment">//</span>
<a name="l00053"></a>00053 <span class="comment">// This macro can be used to automatically generate code for all known</span>
<a name="l00054"></a>00054 <span class="comment">// record types. Just #undef HANDLE_PARSER, then #define it to whatever</span>
<a name="l00055"></a>00055 <span class="comment">// you need, then use ALL_KNOWN_PARSER_TYPES. See parser.cc for</span>
<a name="l00056"></a>00056 <span class="comment">// various examples.</span>
<a name="l00057"></a>00057 <span class="comment">//</span>
<a name="l00058"></a>00058 <span class="comment">// These are sorted so their GetDBName()'s will display in alphabetical order.</span>
<a name="l00059"></a>00059 <span class="comment">//</span>
<a name="l00060"></a>00060 <span class="preprocessor">#define ALL_KNOWN_PARSER_TYPES \</span>
<a name="l00061"></a>00061 <span class="preprocessor"> HANDLE_PARSER(Contact) \</span>
<a name="l00062"></a>00062 <span class="preprocessor"> HANDLE_PARSER(Bookmark) \</span>
<a name="l00063"></a>00063 <span class="preprocessor"> HANDLE_PARSER(Calendar) \</span>
<a name="l00064"></a>00064 <span class="preprocessor"> HANDLE_PARSER(CalendarAll) \</span>
<a name="l00065"></a>00065 <span class="preprocessor"> HANDLE_PARSER(ContentStore) \</span>
<a name="l00066"></a>00066 <span class="preprocessor"> HANDLE_PARSER(Folder) \</span>
<a name="l00067"></a>00067 <span class="preprocessor"> HANDLE_PARSER(Memo) \</span>
<a name="l00068"></a>00068 <span class="preprocessor"> HANDLE_PARSER(Message) \</span>
<a name="l00069"></a>00069 <span class="preprocessor"> HANDLE_PARSER(CallLog) \</span>
<a name="l00070"></a>00070 <span class="preprocessor"> HANDLE_PARSER(PINMessage) \</span>
<a name="l00071"></a>00071 <span class="preprocessor"> HANDLE_PARSER(SavedMessage) \</span>
<a name="l00072"></a>00072 <span class="preprocessor"> HANDLE_PARSER(ServiceBook) \</span>
<a name="l00073"></a>00073 <span class="preprocessor"> HANDLE_PARSER(Sms) \</span>
<a name="l00074"></a>00074 <span class="preprocessor"> HANDLE_PARSER(Task) \</span>
<a name="l00075"></a>00075 <span class="preprocessor"> HANDLE_PARSER(Timezone)</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span>
<a name="l00077"></a>00077 <span class="keyword">namespace </span>Barry {
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">//</span>
<a name="l00080"></a>00080 <span class="comment">// Parser class</span>
<a name="l00081"></a>00081 <span class="comment">//</span><span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment">/// Base class for the parser hierarchy.</span>
<a name="l00083"></a>00083 <span class="comment">///</span>
<a name="l00084"></a>00084 <span class="comment">/// This class provides the interface that the Controller class uses</span>
<a name="l00085"></a>00085 <span class="comment">/// to pass raw data it reads from the device. The Controller, along</span>
<a name="l00086"></a>00086 <span class="comment">/// with the Packet class, calls each of the virtual functions below</span>
<a name="l00087"></a>00087 <span class="comment">/// in the same order.</span>
<a name="l00088"></a>00088 <span class="comment">///</span>
<a name="l00089"></a>00089 <span class="comment">/// This class is kept as a pure abstract class, in order to make sure</span>
<a name="l00090"></a>00090 <span class="comment">/// that the compiler will catch any API changes, for code derived</span>
<a name="l00091"></a>00091 <span class="comment">/// from it.</span>
<a name="l00092"></a>00092 <span class="comment">///</span>
<a name="l00093"></a><a class="code" href="classBarry_1_1Parser.html">00093</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a>
<a name="l00094"></a>00094 {
<a name="l00095"></a>00095 <span class="keyword">public</span>:
<a name="l00096"></a>00096 <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a>() {}
<a name="l00097"></a>00097 <span class="keyword">virtual</span> ~<a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a>() {}
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> /// Called to parse sub fields in the raw data packet.</span>
<a name="l00100"></a>00100 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> ParseRecord(<span class="keyword">const</span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> &data, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic) = 0;
<a name="l00101"></a>00101 };
<a name="l00102"></a>00102
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="comment">//</span>
<a name="l00105"></a>00105 <span class="comment">// NullParser class</span>
<a name="l00106"></a>00106 <span class="comment">//</span><span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment">/// If in debug mode, this class can be used as a null parser.</span>
<a name="l00108"></a>00108 <span class="comment">/// Call Init() and the protocol will be dumped to stdout and</span>
<a name="l00109"></a>00109 <span class="comment">/// no parsing will be done.</span>
<a name="l00110"></a>00110 <span class="comment">///</span>
<a name="l00111"></a>00111 <span class="comment">/// Do NOT derive your own personal parser classes from this,</span>
<a name="l00112"></a>00112 <span class="comment">/// unless you are perfectly confident that you will catch</span>
<a name="l00113"></a>00113 <span class="comment">/// future API changes on the devel tree without the compiler's</span>
<a name="l00114"></a>00114 <span class="comment">/// help.</span>
<a name="l00115"></a>00115 <span class="comment">///</span>
<a name="l00116"></a><a class="code" href="classBarry_1_1NullParser.html">00116</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1NullParser.html" title="If in debug mode, this class can be used as a null parser.">NullParser</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a>
<a name="l00117"></a>00117 {
<a name="l00118"></a>00118 <span class="keyword">public</span>:
<a name="l00119"></a>00119 <a class="code" href="classBarry_1_1NullParser.html" title="If in debug mode, this class can be used as a null parser.">NullParser</a>() {}
<a name="l00120"></a>00120 <span class="keyword">virtual</span> ~<a class="code" href="classBarry_1_1NullParser.html" title="If in debug mode, this class can be used as a null parser.">NullParser</a>() {}
<a name="l00121"></a>00121
<a name="l00122"></a><a class="code" href="classBarry_1_1NullParser.html#5e2f6a47214e9162b04c589c7f75b341">00122</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> ParseRecord(<span class="keyword">const</span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> &data, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic) {}
<a name="l00123"></a>00123 };
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="comment">//</span>
<a name="l00126"></a>00126 <span class="comment">// HexDumpParser</span>
<a name="l00127"></a>00127 <span class="comment">//</span><span class="comment"></span>
<a name="l00128"></a>00128 <span class="comment">/// Dumps raw hex of the given DBData to the given stream.</span>
<a name="l00129"></a>00129 <span class="comment">///</span>
<a name="l00130"></a>00130 <span class="comment">/// Do NOT derive your own personal parser classes from this,</span>
<a name="l00131"></a>00131 <span class="comment">/// unless you are perfectly confident that you will catch</span>
<a name="l00132"></a>00132 <span class="comment">/// future API changes on the devel tree without the compiler's</span>
<a name="l00133"></a>00133 <span class="comment">/// help.</span>
<a name="l00134"></a>00134 <span class="comment">///</span>
<a name="l00135"></a><a class="code" href="classBarry_1_1HexDumpParser.html">00135</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1HexDumpParser.html" title="Dumps raw hex of the given DBData to the given stream.">HexDumpParser</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a>
<a name="l00136"></a>00136 {
<a name="l00137"></a>00137 std::ostream &m_os;
<a name="l00138"></a>00138 std::string m_last_dbname;
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="keyword">public</span>:
<a name="l00141"></a>00141 <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1HexDumpParser.html" title="Dumps raw hex of the given DBData to the given stream.">HexDumpParser</a>(std::ostream &os);
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ParseRecord(<span class="keyword">const</span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">Barry::DBData</a> &data,
<a name="l00144"></a>00144 <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic);
<a name="l00145"></a>00145 };
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="comment">//</span>
<a name="l00148"></a>00148 <span class="comment">// RecordParserBase</span>
<a name="l00149"></a>00149 <span class="comment">//</span><span class="comment"></span>
<a name="l00150"></a>00150 <span class="comment">/// Abstract base class for the following RecordParser template, that exposes</span>
<a name="l00151"></a>00151 <span class="comment">/// some information on the specifics that the record parser can handle.</span>
<a name="l00152"></a>00152 <span class="comment">/// Specifically, it exposes the database name it is able to parse</span>
<a name="l00153"></a>00153 <span class="comment">///</span>
<a name="l00154"></a><a class="code" href="classBarry_1_1RecordParserBase.html">00154</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1RecordParserBase.html" title="Abstract base class for the following RecordParser template, that exposes some information...">RecordParserBase</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a>
<a name="l00155"></a>00155 {
<a name="l00156"></a>00156 <span class="keyword">public</span>:
<a name="l00157"></a>00157 <span class="comment">// These functions are always valid, regardless of the</span>
<a name="l00158"></a>00158 <span class="comment">// state of the parser.</span>
<a name="l00159"></a>00159 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * GetDBName() <span class="keyword">const</span> = 0;
<a name="l00160"></a>00160 <span class="keyword">virtual</span> uint8_t GetDefaultRecType() <span class="keyword">const</span> = 0;
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="comment">// These functions depend on the parser having just parsed</span>
<a name="l00163"></a>00163 <span class="comment">// a record successfully.</span>
<a name="l00164"></a>00164 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsRecordValid() <span class="keyword">const</span> = 0;
<a name="l00165"></a>00165 <span class="keyword">virtual</span> uint8_t GetRecType() <span class="keyword">const</span> = 0;
<a name="l00166"></a>00166 <span class="keyword">virtual</span> uint32_t GetUniqueId() <span class="keyword">const</span> = 0;
<a name="l00167"></a>00167 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Dump(std::ostream &os) <span class="keyword">const</span> = 0;
<a name="l00168"></a>00168 };
<a name="l00169"></a>00169
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="comment">//</span>
<a name="l00172"></a>00172 <span class="comment">// Note: Store classes take parsed Record objects as a functor.</span>
<a name="l00173"></a>00173 <span class="comment">// Parser classes deal with raw data, while Store classes deal with</span>
<a name="l00174"></a>00174 <span class="comment">// parsed Record objects.</span>
<a name="l00175"></a>00175 <span class="comment">//</span>
<a name="l00176"></a>00176
<a name="l00177"></a>00177 <span class="comment">//</span>
<a name="l00178"></a>00178 <span class="comment">// NullStore</span>
<a name="l00179"></a>00179 <span class="comment">//</span><span class="comment"></span>
<a name="l00180"></a>00180 <span class="comment">/// A Storage class for RecordParser<> that does nothing, for the cases</span>
<a name="l00181"></a>00181 <span class="comment">/// where you only want to dump parsed record data to a stream.</span>
<a name="l00182"></a>00182 <span class="comment">///</span>
<a name="l00183"></a>00183 <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> RecordT>
<a name="l00184"></a><a class="code" href="classBarry_1_1NullStore.html">00184</a> <span class="keyword">class </span><a class="code" href="classBarry_1_1NullStore.html" title="A Storage class for RecordParser&lt;&gt; that does nothing, for the cases where you...">NullStore</a>
<a name="l00185"></a>00185 {
<a name="l00186"></a>00186 <span class="keyword">public</span>:
<a name="l00187"></a>00187 <span class="keywordtype">void</span> operator() (<span class="keyword">const</span> RecordT &r)
<a name="l00188"></a>00188 {
<a name="l00189"></a>00189 }
<a name="l00190"></a>00190 };
<a name="l00191"></a>00191
<a name="l00192"></a>00192 <span class="comment">//</span>
<a name="l00193"></a>00193 <span class="comment">// DumpStore</span>
<a name="l00194"></a>00194 <span class="comment">//</span><span class="comment"></span>
<a name="l00195"></a>00195 <span class="comment">/// A Storage class for RecordParser<> that dumps the parsed record data</span>
<a name="l00196"></a>00196 <span class="comment">/// to the given stream.</span>
<a name="l00197"></a>00197 <span class="comment">///</span>
<a name="l00198"></a>00198 <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> RecordT>
<a name="l00199"></a><a class="code" href="classBarry_1_1DumpStore.html">00199</a> <span class="keyword">class </span><a class="code" href="classBarry_1_1DumpStore.html" title="A Storage class for RecordParser&lt;&gt; that dumps the parsed record data to the...">DumpStore</a>
<a name="l00200"></a>00200 {
<a name="l00201"></a>00201 std::ostream &m_os;
<a name="l00202"></a>00202
<a name="l00203"></a>00203 <span class="keyword">public</span>:
<a name="l00204"></a>00204 <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1DumpStore.html" title="A Storage class for RecordParser&lt;&gt; that dumps the parsed record data to the...">DumpStore</a>(std::ostream &os)
<a name="l00205"></a>00205 : m_os(os)
<a name="l00206"></a>00206 {
<a name="l00207"></a>00207 }
<a name="l00208"></a>00208
<a name="l00209"></a>00209 <span class="keywordtype">void</span> operator() (<span class="keyword">const</span> RecordT &r)
<a name="l00210"></a>00210 {
<a name="l00211"></a>00211 r.Dump(m_os);
<a name="l00212"></a>00212 }
<a name="l00213"></a>00213 };
<a name="l00214"></a>00214
<a name="l00215"></a>00215 <span class="comment">//</span>
<a name="l00216"></a>00216 <span class="comment">// ParseDBData</span>
<a name="l00217"></a>00217 <span class="comment">//</span><span class="comment"></span>
<a name="l00218"></a>00218 <span class="comment">/// Contains the proper way to convert a DBData object into a record.</span>
<a name="l00219"></a>00219 <span class="comment">///</span>
<a name="l00220"></a>00220 <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> RecordT>
<a name="l00221"></a><a class="code" href="namespaceBarry.html#d9b9de17676484b0a956a2944602f84c">00221</a> <span class="keywordtype">void</span> <a class="code" href="namespaceBarry.html#d9b9de17676484b0a956a2944602f84c" title="Contains the proper way to convert a DBData object into a record.">ParseDBData</a>(<span class="keyword">const</span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> &data, RecordT &rec, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic)
<a name="l00222"></a>00222 {
<a name="l00223"></a>00223 <span class="comment">// start fresh</span>
<a name="l00224"></a>00224 rec = RecordT();
<a name="l00225"></a>00225
<a name="l00226"></a>00226 <span class="comment">// parse</span>
<a name="l00227"></a>00227 rec.SetIds(data.<a class="code" href="classBarry_1_1DBData.html#07523eb3b1dcfd99a917a184b61cb10a">GetRecType</a>(), data.<a class="code" href="classBarry_1_1DBData.html#2a0106c7330842c455fc5393a3abfbc7">GetUniqueId</a>());
<a name="l00228"></a>00228 <span class="keywordtype">size_t</span> offset = data.<a class="code" href="classBarry_1_1DBData.html#5b301bfdcda5a74ccfd3f7e54fd69d99">GetOffset</a>();
<a name="l00229"></a>00229 rec.ParseHeader(data.<a class="code" href="classBarry_1_1DBData.html#a7cacc9655376447ffbf3aa4d664a03b">GetData</a>(), offset);
<a name="l00230"></a>00230 rec.ParseFields(data.<a class="code" href="classBarry_1_1DBData.html#a7cacc9655376447ffbf3aa4d664a03b">GetData</a>(), offset, ic);
<a name="l00231"></a>00231 }
<a name="l00232"></a>00232
<a name="l00233"></a>00233 <span class="comment">//</span>
<a name="l00234"></a>00234 <span class="comment">// RecordParser template class</span>
<a name="l00235"></a>00235 <span class="comment">//</span><span class="comment"></span>
<a name="l00236"></a>00236 <span class="comment">/// Template class for easy creation of specific parser objects. This template</span>
<a name="l00237"></a>00237 <span class="comment">/// takes the following template arguments:</span>
<a name="l00238"></a>00238 <span class="comment">///</span>
<a name="l00239"></a>00239 <span class="comment">/// - RecordT: One of the record parser classes in record.h</span>
<a name="l00240"></a>00240 <span class="comment">/// - StorageT: A custom storage functor class. An object of this type</span>
<a name="l00241"></a>00241 <span class="comment">/// will be called as a function with parsed Record as an</span>
<a name="l00242"></a>00242 <span class="comment">/// argument. This happens on the fly as the data is retrieved</span>
<a name="l00243"></a>00243 <span class="comment">/// from the device over USB, so it should not block forever.</span>
<a name="l00244"></a>00244 <span class="comment">///</span>
<a name="l00245"></a>00245 <span class="comment">/// Example LoadDatabase() call:</span>
<a name="l00246"></a>00246 <span class="comment">///</span>
<a name="l00247"></a>00247 <span class="comment">/// <pre></span>
<a name="l00248"></a>00248 <span class="comment">/// struct StoreContact</span>
<a name="l00249"></a>00249 <span class="comment">/// {</span>
<a name="l00250"></a>00250 <span class="comment">/// std::vector<Contact> &amp;array;</span>
<a name="l00251"></a>00251 <span class="comment">/// StoreContact(std::vector<Contact> &amp;a) : array(a) {}</span>
<a name="l00252"></a>00252 <span class="comment">/// void operator() (const Contact &amp;c)</span>
<a name="l00253"></a>00253 <span class="comment">/// {</span>
<a name="l00254"></a>00254 <span class="comment">/// array.push_back(c);</span>
<a name="l00255"></a>00255 <span class="comment">/// }</span>
<a name="l00256"></a>00256 <span class="comment">/// };</span>
<a name="l00257"></a>00257 <span class="comment">///</span>
<a name="l00258"></a>00258 <span class="comment">/// Controller con(probeResult);</span>
<a name="l00259"></a>00259 <span class="comment">/// con.OpenMode(Controller::Desktop);</span>
<a name="l00260"></a>00260 <span class="comment">/// std::vector<Contact> contactList;</span>
<a name="l00261"></a>00261 <span class="comment">/// StoreContact storage(contactList);</span>
<a name="l00262"></a>00262 <span class="comment">/// RecordParser<Contact, StoreContact> parser(storage);</span>
<a name="l00263"></a>00263 <span class="comment">/// con.LoadDatabase(con.GetDBID("Address Book"), parser);</span>
<a name="l00264"></a>00264 <span class="comment">/// </pre></span>
<a name="l00265"></a>00265 <span class="comment">///</span>
<a name="l00266"></a>00266 <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> RecordT, <span class="keyword">class</span> StorageT>
<a name="l00267"></a><a class="code" href="classBarry_1_1RecordParser.html">00267</a> <span class="keyword">class </span><a class="code" href="classBarry_1_1RecordParser.html" title="Template class for easy creation of specific parser objects.">RecordParser</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1RecordParserBase.html" title="Abstract base class for the following RecordParser template, that exposes some information...">RecordParserBase</a>
<a name="l00268"></a>00268 {
<a name="l00269"></a>00269 StorageT *m_store;
<a name="l00270"></a>00270 <span class="keywordtype">bool</span> m_owned;
<a name="l00271"></a>00271 RecordT m_rec;
<a name="l00272"></a>00272 <span class="keywordtype">bool</span> m_record_valid;
<a name="l00273"></a>00273
<a name="l00274"></a>00274 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00275"></a>00275 <span class="comment"> /// Constructor that references an externally managed storage object.</span>
<a name="l00276"></a><a class="code" href="classBarry_1_1RecordParser.html#a52373dc3d72cea727838bae98d5f8af">00276</a> <span class="comment"></span> <a class="code" href="classBarry_1_1RecordParser.html#a52373dc3d72cea727838bae98d5f8af" title="Constructor that references an externally managed storage object.">RecordParser</a>(StorageT &storage)
<a name="l00277"></a>00277 : m_store(&storage)
<a name="l00278"></a>00278 , m_owned(false)
<a name="l00279"></a>00279 , m_record_valid(false)
<a name="l00280"></a>00280 {
<a name="l00281"></a>00281 }
<a name="l00282"></a>00282 <span class="comment"></span>
<a name="l00283"></a>00283 <span class="comment"> /// Constructor that references a locally managed storage object.</span>
<a name="l00284"></a>00284 <span class="comment"> /// The pointer passed in will be stored, and freed when this class</span>
<a name="l00285"></a>00285 <span class="comment"> /// is destroyed. It is safe to call this constructor with</span>
<a name="l00286"></a>00286 <span class="comment"> /// a 'new'ly created storage object.</span>
<a name="l00287"></a><a class="code" href="classBarry_1_1RecordParser.html#f837f09991b62116b13e9e6c13b4dfd3">00287</a> <span class="comment"></span> <a class="code" href="classBarry_1_1RecordParser.html#a52373dc3d72cea727838bae98d5f8af" title="Constructor that references an externally managed storage object.">RecordParser</a>(StorageT *storage = 0)
<a name="l00288"></a>00288 : m_store(storage)
<a name="l00289"></a>00289 , m_owned(true)
<a name="l00290"></a>00290 , m_record_valid(false)
<a name="l00291"></a>00291 {
<a name="l00292"></a>00292 }
<a name="l00293"></a>00293
<a name="l00294"></a>00294 ~<a class="code" href="classBarry_1_1RecordParser.html" title="Template class for easy creation of specific parser objects.">RecordParser</a>()
<a name="l00295"></a>00295 {
<a name="l00296"></a>00296 <span class="keywordflow">if</span>( this->m_owned )
<a name="l00297"></a>00297 <span class="keyword">delete</span> m_store;
<a name="l00298"></a>00298 }
<a name="l00299"></a>00299
<a name="l00300"></a>00300 <span class="keyword">virtual</span> StorageT* GetStore()
<a name="l00301"></a>00301 {
<a name="l00302"></a>00302 <span class="keywordflow">return</span> m_store;
<a name="l00303"></a>00303 }
<a name="l00304"></a>00304
<a name="l00305"></a>00305 <span class="keyword">virtual</span> <span class="keyword">const</span> StorageT* GetStore()<span class="keyword"> const</span>
<a name="l00306"></a>00306 <span class="keyword"> </span>{
<a name="l00307"></a>00307 <span class="keywordflow">return</span> m_store;
<a name="l00308"></a>00308 }
<a name="l00309"></a>00309
<a name="l00310"></a><a class="code" href="classBarry_1_1RecordParser.html#83fe40db19e22eeb7ac94d8385650b75">00310</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1RecordParser.html#83fe40db19e22eeb7ac94d8385650b75" title="Called to parse sub fields in the raw data packet.">ParseRecord</a>(<span class="keyword">const</span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> &data, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic)
<a name="l00311"></a>00311 {
<a name="l00312"></a>00312 m_record_valid = <span class="keyword">false</span>;
<a name="l00313"></a>00313 <a class="code" href="namespaceBarry.html#d9b9de17676484b0a956a2944602f84c" title="Contains the proper way to convert a DBData object into a record.">ParseDBData</a>(data, m_rec, ic);
<a name="l00314"></a>00314 m_record_valid = <span class="keyword">true</span>;
<a name="l00315"></a>00315
<a name="l00316"></a>00316 <span class="keywordflow">if</span>( m_store )
<a name="l00317"></a>00317 (*m_store)(m_rec);
<a name="l00318"></a>00318 }
<a name="l00319"></a>00319
<a name="l00320"></a>00320 <span class="comment">//</span>
<a name="l00321"></a>00321 <span class="comment">// RecordParserBase overrides</span>
<a name="l00322"></a>00322 <span class="comment">//</span>
<a name="l00323"></a>00323
<a name="l00324"></a>00324 <span class="comment">// These functions are always valid, regardless of the</span>
<a name="l00325"></a>00325 <span class="comment">// state of the parser.</span>
<a name="l00326"></a>00326 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * GetDBName()<span class="keyword"> const</span>
<a name="l00327"></a>00327 <span class="keyword"> </span>{
<a name="l00328"></a>00328 <span class="keywordflow">return</span> RecordT::GetDBName();
<a name="l00329"></a>00329 }
<a name="l00330"></a>00330
<a name="l00331"></a>00331 <span class="keyword">virtual</span> uint8_t GetDefaultRecType()<span class="keyword"> const</span>
<a name="l00332"></a>00332 <span class="keyword"> </span>{
<a name="l00333"></a>00333 <span class="keywordflow">return</span> RecordT::GetDefaultRecType();
<a name="l00334"></a>00334 }
<a name="l00335"></a>00335
<a name="l00336"></a>00336 <span class="comment">// These functions depend on the parser having just parsed</span>
<a name="l00337"></a>00337 <span class="comment">// a record successfully.</span>
<a name="l00338"></a>00338 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsRecordValid()<span class="keyword"> const</span>
<a name="l00339"></a>00339 <span class="keyword"> </span>{
<a name="l00340"></a>00340 <span class="keywordflow">return</span> m_record_valid;
<a name="l00341"></a>00341 }
<a name="l00342"></a>00342
<a name="l00343"></a>00343 <span class="keyword">virtual</span> uint8_t GetRecType()<span class="keyword"> const</span>
<a name="l00344"></a>00344 <span class="keyword"> </span>{
<a name="l00345"></a>00345 <span class="keywordflow">return</span> m_rec.GetRecType();
<a name="l00346"></a>00346 }
<a name="l00347"></a>00347
<a name="l00348"></a>00348 <span class="keyword">virtual</span> uint32_t GetUniqueId()<span class="keyword"> const</span>
<a name="l00349"></a>00349 <span class="keyword"> </span>{
<a name="l00350"></a>00350 <span class="keywordflow">return</span> m_rec.GetUniqueId();
<a name="l00351"></a>00351 }
<a name="l00352"></a>00352
<a name="l00353"></a>00353 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Dump(std::ostream &os)<span class="keyword"> const</span>
<a name="l00354"></a>00354 <span class="keyword"> </span>{
<a name="l00355"></a>00355 m_rec.Dump(os);
<a name="l00356"></a>00356 }
<a name="l00357"></a>00357 };
<a name="l00358"></a>00358
<a name="l00359"></a>00359 <span class="comment">//</span>
<a name="l00360"></a>00360 <span class="comment">// AllRecordStore</span>
<a name="l00361"></a>00361 <span class="comment">//</span><span class="comment"></span>
<a name="l00362"></a>00362 <span class="comment">/// Base class with overloaded functor behaviour for all available</span>
<a name="l00363"></a>00363 <span class="comment">/// record classes. To be used with AllRecordParser.</span>
<a name="l00364"></a>00364 <span class="comment">///</span>
<a name="l00365"></a><a class="code" href="classBarry_1_1AllRecordStore.html">00365</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1AllRecordStore.html" title="Base class with overloaded functor behaviour for all available record classes.">AllRecordStore</a>
<a name="l00366"></a>00366 {
<a name="l00367"></a>00367 <span class="keyword">public</span>:
<a name="l00368"></a>00368 <a class="code" href="classBarry_1_1AllRecordStore.html" title="Base class with overloaded functor behaviour for all available record classes.">AllRecordStore</a>() {}
<a name="l00369"></a>00369 <span class="keyword">virtual</span> ~<a class="code" href="classBarry_1_1AllRecordStore.html" title="Base class with overloaded functor behaviour for all available record classes.">AllRecordStore</a>() {}
<a name="l00370"></a>00370
<a name="l00371"></a>00371 <span class="preprocessor">#undef HANDLE_PARSER</span>
<a name="l00372"></a>00372 <span class="preprocessor"></span><span class="preprocessor">#define HANDLE_PARSER(tname) \</span>
<a name="l00373"></a>00373 <span class="preprocessor"> virtual void operator() (const Barry::tname &) = 0;</span>
<a name="l00374"></a>00374 <span class="preprocessor"></span>
<a name="l00375"></a>00375 ALL_KNOWN_PARSER_TYPES
<a name="l00376"></a>00376 };
<a name="l00377"></a>00377
<a name="l00378"></a>00378 <span class="comment">//</span>
<a name="l00379"></a>00379 <span class="comment">// MultiRecordParser</span>
<a name="l00380"></a>00380 <span class="comment">//</span><span class="comment"></span>
<a name="l00381"></a>00381 <span class="comment">/// Container parser class that accepts multiple Parser objects</span>
<a name="l00382"></a>00382 <span class="comment">/// (often RecordParser<> objects but they don't have to be) and</span>
<a name="l00383"></a>00383 <span class="comment">/// automatically routes incoming records to the appropriate parser.</span>
<a name="l00384"></a>00384 <span class="comment">/// Note that this container owns *all* Parser objects, and will</span>
<a name="l00385"></a>00385 <span class="comment">/// free them upon destruction.</span>
<a name="l00386"></a>00386 <span class="comment">///</span>
<a name="l00387"></a>00387 <span class="comment">/// Incoming records that have no matching parser are passed to the</span>
<a name="l00388"></a>00388 <span class="comment">/// default parser object, if one exists, otherwise they are dropped</span>
<a name="l00389"></a>00389 <span class="comment">/// silently. The default parser object is also owned by the container,</span>
<a name="l00390"></a>00390 <span class="comment">/// and will be freed on destruction.</span>
<a name="l00391"></a>00391 <span class="comment">///</span>
<a name="l00392"></a>00392 <span class="comment">/// Do NOT derive your own personal parser classes from this,</span>
<a name="l00393"></a>00393 <span class="comment">/// unless you are perfectly confident that you will catch</span>
<a name="l00394"></a>00394 <span class="comment">/// future API changes on the devel tree without the compiler's</span>
<a name="l00395"></a>00395 <span class="comment">/// help.</span>
<a name="l00396"></a>00396 <span class="comment">///</span>
<a name="l00397"></a><a class="code" href="classBarry_1_1MultiRecordParser.html">00397</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1MultiRecordParser.html" title="Container parser class that accepts multiple Parser objects (often RecordParser&lt;&gt;...">MultiRecordParser</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a>
<a name="l00398"></a>00398 {
<a name="l00399"></a>00399 <span class="keyword">typedef</span> std::map<std::string, Parser*> map_type;
<a name="l00400"></a>00400
<a name="l00401"></a>00401 <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> *m_delete_default; <span class="comment">// if set, will be freed</span>
<a name="l00402"></a>00402 <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> *m_default; <span class="comment">// used by all code for actual work</span>
<a name="l00403"></a>00403 <span class="comment">// and may or may not be "owned" by us</span>
<a name="l00404"></a>00404 map_type m_parsers;
<a name="l00405"></a>00405
<a name="l00406"></a>00406 <span class="keyword">public</span>:
<a name="l00407"></a>00407 <span class="comment">// takes ownership of default_parser!</span>
<a name="l00408"></a>00408 <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1MultiRecordParser.html" title="Container parser class that accepts multiple Parser objects (often RecordParser&lt;&gt;...">MultiRecordParser</a>(<a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> *default_parser = 0);
<a name="l00409"></a>00409
<a name="l00410"></a>00410 <span class="comment">// does not take ownership of the default_parser</span>
<a name="l00411"></a>00411 <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1MultiRecordParser.html" title="Container parser class that accepts multiple Parser objects (often RecordParser&lt;&gt;...">MultiRecordParser</a>(<a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> &default_parser);
<a name="l00412"></a>00412
<a name="l00413"></a>00413 ~<a class="code" href="classBarry_1_1MultiRecordParser.html" title="Container parser class that accepts multiple Parser objects (often RecordParser&lt;&gt;...">MultiRecordParser</a>();
<a name="l00414"></a>00414 <span class="comment"></span>
<a name="l00415"></a>00415 <span class="comment"> /// Adds given parser to list and takes ownership of it</span>
<a name="l00416"></a>00416 <span class="comment"></span> <span class="keywordtype">void</span> Add(<span class="keyword">const</span> std::string &dbname, <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> *parser);
<a name="l00417"></a>00417 <span class="comment"></span>
<a name="l00418"></a>00418 <span class="comment"> /// Adds given parser to list and takes ownership of it</span>
<a name="l00419"></a>00419 <span class="comment"></span> <span class="keywordtype">void</span> Add(<a class="code" href="classBarry_1_1RecordParserBase.html" title="Abstract base class for the following RecordParser template, that exposes some information...">RecordParserBase</a> *parser);
<a name="l00420"></a>00420 <span class="comment"></span>
<a name="l00421"></a>00421 <span class="comment"> /// Creates a RecordParser<> object using the given record</span>
<a name="l00422"></a>00422 <span class="comment"> /// type and AllRecordStore. Does NOT take ownership of the</span>
<a name="l00423"></a>00423 <span class="comment"> /// store object, since it can be used multiple times for</span>
<a name="l00424"></a>00424 <span class="comment"> /// multiple records.</span>
<a name="l00425"></a>00425 <span class="comment"></span> <span class="keyword">template</span> <<span class="keyword">class</span> RecordT>
<a name="l00426"></a><a class="code" href="classBarry_1_1MultiRecordParser.html#5d304e359e51ce5f2682ae12402b5426">00426</a> <span class="keywordtype">void</span> Add(<a class="code" href="classBarry_1_1AllRecordStore.html" title="Base class with overloaded functor behaviour for all available record classes.">AllRecordStore</a> &store)
<a name="l00427"></a>00427 {
<a name="l00428"></a>00428 Add( RecordT::GetDBName(),
<a name="l00429"></a>00429 <span class="keyword">new</span> <a class="code" href="classBarry_1_1RecordParser.html" title="Template class for easy creation of specific parser objects.">RecordParser<RecordT, AllRecordStore></a>(store) );
<a name="l00430"></a>00430 }
<a name="l00431"></a>00431 <span class="comment"></span>
<a name="l00432"></a>00432 <span class="comment"> /// Two helper template functions that create the RecordParser<></span>
<a name="l00433"></a>00433 <span class="comment"> /// automatically based on the function call. Both pointer and</span>
<a name="l00434"></a>00434 <span class="comment"> /// reference versions.</span>
<a name="l00435"></a>00435 <span class="comment"></span> <span class="keyword">template</span> <<span class="keyword">class</span> RecordT, <span class="keyword">class</span> StorageT>
<a name="l00436"></a><a class="code" href="classBarry_1_1MultiRecordParser.html#139b883183f84b3052dbc464a4396177">00436</a> <span class="keywordtype">void</span> Add(StorageT *store)
<a name="l00437"></a>00437 {
<a name="l00438"></a>00438 Add( RecordT::GetDBName(),
<a name="l00439"></a>00439 <span class="keyword">new</span> <a class="code" href="classBarry_1_1RecordParser.html" title="Template class for easy creation of specific parser objects.">RecordParser<RecordT, StorageT></a>(store) );
<a name="l00440"></a>00440 }
<a name="l00441"></a>00441
<a name="l00442"></a>00442 <span class="keyword">template</span> <<span class="keyword">class</span> RecordT, <span class="keyword">class</span> StorageT>
<a name="l00443"></a>00443 <span class="keywordtype">void</span> Add(StorageT &store)
<a name="l00444"></a>00444 {
<a name="l00445"></a>00445 Add( RecordT::GetDBName(),
<a name="l00446"></a>00446 <span class="keyword">new</span> <a class="code" href="classBarry_1_1RecordParser.html" title="Template class for easy creation of specific parser objects.">RecordParser<RecordT, StorageT></a>(store) );
<a name="l00447"></a>00447 }
<a name="l00448"></a>00448 <span class="comment"></span>
<a name="l00449"></a>00449 <span class="comment"> /// Creates a RecordParser<> object for the given database name,</span>
<a name="l00450"></a>00450 <span class="comment"> /// using DumpStore<> with the given stream for the output,</span>
<a name="l00451"></a>00451 <span class="comment"> /// and adds it to list.</span>
<a name="l00452"></a>00452 <span class="comment"> /// Returns false if there is no known Record class for dbname.</span>
<a name="l00453"></a>00453 <span class="comment"></span> <span class="keywordtype">bool</span> Add(<span class="keyword">const</span> std::string &dbname, std::ostream &os);
<a name="l00454"></a>00454 <span class="comment"></span>
<a name="l00455"></a>00455 <span class="comment"> /// Creates a RecordParser<> object for the given database name,</span>
<a name="l00456"></a>00456 <span class="comment"> /// using the given store object.</span>
<a name="l00457"></a>00457 <span class="comment"> /// Returns false if there is no known Record class for dbname.</span>
<a name="l00458"></a>00458 <span class="comment"></span> <span class="keywordtype">bool</span> Add(<span class="keyword">const</span> std::string &dbname, AllRecordStore &store);
<a name="l00459"></a>00459
<a name="l00460"></a>00460 <span class="comment">// Parser overrides</span>
<a name="l00461"></a>00461 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ParseRecord(<span class="keyword">const</span> DBData &data, <span class="keyword">const</span> IConverter *ic);
<a name="l00462"></a>00462 };
<a name="l00463"></a>00463
<a name="l00464"></a>00464 <span class="comment">//</span>
<a name="l00465"></a>00465 <span class="comment">// AllRecordDumpStore</span>
<a name="l00466"></a>00466 <span class="comment">//</span><span class="comment"></span>
<a name="l00467"></a>00467 <span class="comment">/// Derived from AllRecordStore, which just calls each record's</span>
<a name="l00468"></a>00468 <span class="comment">/// Dump() member with the given stream.</span>
<a name="l00469"></a>00469 <span class="comment">///</span>
<a name="l00470"></a><a class="code" href="classBarry_1_1AllRecordDumpStore.html">00470</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1AllRecordDumpStore.html" title="Derived from AllRecordStore, which just calls each record&#39;s Dump() member with...">AllRecordDumpStore</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1AllRecordStore.html" title="Base class with overloaded functor behaviour for all available record classes.">AllRecordStore</a>
<a name="l00471"></a>00471 {
<a name="l00472"></a>00472 <span class="keyword">protected</span>:
<a name="l00473"></a>00473 std::ostream &m_os;
<a name="l00474"></a>00474
<a name="l00475"></a>00475 <span class="keyword">public</span>:
<a name="l00476"></a>00476 <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1AllRecordDumpStore.html" title="Derived from AllRecordStore, which just calls each record&#39;s Dump() member with...">AllRecordDumpStore</a>(std::ostream &os)
<a name="l00477"></a>00477 : m_os(os)
<a name="l00478"></a>00478 {
<a name="l00479"></a>00479 }
<a name="l00480"></a>00480
<a name="l00481"></a>00481 <span class="preprocessor">#undef HANDLE_PARSER</span>
<a name="l00482"></a>00482 <span class="preprocessor"></span><span class="preprocessor">#define HANDLE_PARSER(tname) \</span>
<a name="l00483"></a>00483 <span class="preprocessor"> virtual void operator() (const Barry::tname &);</span>
<a name="l00484"></a>00484 <span class="preprocessor"></span>
<a name="l00485"></a>00485 ALL_KNOWN_PARSER_TYPES
<a name="l00486"></a>00486 };
<a name="l00487"></a>00487
<a name="l00488"></a>00488 <span class="comment">//</span>
<a name="l00489"></a>00489 <span class="comment">// AllRecordParser</span>
<a name="l00490"></a>00490 <span class="comment">//</span><span class="comment"></span>
<a name="l00491"></a>00491 <span class="comment">/// Convenience parser that creates a MultiRecordParser with all known</span>
<a name="l00492"></a>00492 <span class="comment">/// record parsers added. If an AllRecordStore pointer is passed in,</span>
<a name="l00493"></a>00493 <span class="comment">/// this class takes ownership of it, and uses it as the store object</span>
<a name="l00494"></a>00494 <span class="comment">/// for all the RecordParser<> objects it creates. If not, then</span>
<a name="l00495"></a>00495 <span class="comment">/// a custom DumpStore<> object is created with the given stream</span>
<a name="l00496"></a>00496 <span class="comment">/// for each RecordParser<> added.</span>
<a name="l00497"></a>00497 <span class="comment">///</span>
<a name="l00498"></a>00498 <span class="comment">/// The default parser object behaves just like MultiRecordParser</span>
<a name="l00499"></a>00499 <span class="comment">///</span>
<a name="l00500"></a>00500 <span class="comment">/// This class takes ownership of all pointers passed in.</span>
<a name="l00501"></a>00501 <span class="comment">///</span>
<a name="l00502"></a><a class="code" href="classBarry_1_1AllRecordParser.html">00502</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1AllRecordParser.html" title="Convenience parser that creates a MultiRecordParser with all known record parsers...">AllRecordParser</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1MultiRecordParser.html" title="Container parser class that accepts multiple Parser objects (often RecordParser&lt;&gt;...">MultiRecordParser</a>
<a name="l00503"></a>00503 {
<a name="l00504"></a>00504 <a class="code" href="classBarry_1_1AllRecordStore.html" title="Base class with overloaded functor behaviour for all available record classes.">AllRecordStore</a> *m_store;
<a name="l00505"></a>00505
<a name="l00506"></a>00506 <span class="keyword">protected</span>:
<a name="l00507"></a>00507 <span class="comment">// does not take ownership of store, by itself,</span>
<a name="l00508"></a>00508 <span class="comment">// but the constructor that calls it might</span>
<a name="l00509"></a>00509 <span class="keywordtype">void</span> AddRecords(std::ostream *os, <a class="code" href="classBarry_1_1AllRecordStore.html" title="Base class with overloaded functor behaviour for all available record classes.">AllRecordStore</a> *store);
<a name="l00510"></a>00510
<a name="l00511"></a>00511 <span class="keyword">public</span>:
<a name="l00512"></a>00512 <span class="comment">// takes ownership of default_parser and store!</span>
<a name="l00513"></a>00513 <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1AllRecordParser.html" title="Convenience parser that creates a MultiRecordParser with all known record parsers...">AllRecordParser</a>(std::ostream &os,
<a name="l00514"></a>00514 <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> *default_parser = 0,
<a name="l00515"></a>00515 <a class="code" href="classBarry_1_1AllRecordStore.html" title="Base class with overloaded functor behaviour for all available record classes.">AllRecordStore</a> *store = 0);
<a name="l00516"></a>00516
<a name="l00517"></a>00517 <span class="comment">// does not take ownership of default_parser or store</span>
<a name="l00518"></a>00518 <a class="code" href="classBarry_1_1AllRecordParser.html" title="Convenience parser that creates a MultiRecordParser with all known record parsers...">AllRecordParser</a>(<a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> &default_parser, <a class="code" href="classBarry_1_1AllRecordStore.html" title="Base class with overloaded functor behaviour for all available record classes.">AllRecordStore</a> &store);
<a name="l00519"></a>00519
<a name="l00520"></a>00520 ~<a class="code" href="classBarry_1_1AllRecordParser.html" title="Convenience parser that creates a MultiRecordParser with all known record parsers...">AllRecordParser</a>();
<a name="l00521"></a>00521 };
<a name="l00522"></a>00522
<a name="l00523"></a>00523 <span class="comment">//</span>
<a name="l00524"></a>00524 <span class="comment">// TeeParser</span>
<a name="l00525"></a>00525 <span class="comment">//</span><span class="comment"></span>
<a name="l00526"></a>00526 <span class="comment">/// Sends incoming DBData objects to all the parsers in its list.</span>
<a name="l00527"></a>00527 <span class="comment">/// This parser container does NOT own the parsers added.</span>
<a name="l00528"></a>00528 <span class="comment">///</span>
<a name="l00529"></a><a class="code" href="classBarry_1_1TeeParser.html">00529</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1TeeParser.html" title="Sends incoming DBData objects to all the parsers in its list.">TeeParser</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a>
<a name="l00530"></a>00530 {
<a name="l00531"></a>00531 <span class="keyword">typedef</span> std::vector<Parser*> parser_list_type;
<a name="l00532"></a>00532
<a name="l00533"></a>00533 parser_list_type m_external_parsers, m_owned_parsers;
<a name="l00534"></a>00534
<a name="l00535"></a>00535 <span class="keyword">public</span>:
<a name="l00536"></a>00536 <a class="code" href="classBarry_1_1TeeParser.html" title="Sends incoming DBData objects to all the parsers in its list.">TeeParser</a>();
<a name="l00537"></a>00537 ~<a class="code" href="classBarry_1_1TeeParser.html" title="Sends incoming DBData objects to all the parsers in its list.">TeeParser</a>();
<a name="l00538"></a>00538 <span class="comment"></span>
<a name="l00539"></a>00539 <span class="comment"> /// Adds parser to internal list, and takes ownership of the</span>
<a name="l00540"></a>00540 <span class="comment"> /// pointer.</span>
<a name="l00541"></a>00541 <span class="comment"></span> <span class="keywordtype">void</span> Add(<a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> *p);
<a name="l00542"></a>00542 <span class="comment"></span>
<a name="l00543"></a>00543 <span class="comment"> /// Adds parser to internal list. Does NOT own the parser reference.</span>
<a name="l00544"></a>00544 <span class="comment"></span> <span class="keywordtype">void</span> Add(<a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> &p);
<a name="l00545"></a>00545
<a name="l00546"></a>00546 <span class="keywordtype">void</span> ParseRecord(<span class="keyword">const</span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> &data, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic);
<a name="l00547"></a>00547 };
<a name="l00548"></a>00548
<a name="l00549"></a>00549 } <span class="comment">// namespace Barry</span>
<a name="l00550"></a>00550
<a name="l00551"></a>00551 <span class="preprocessor">#endif</span>
<a name="l00552"></a>00552 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:15 2011 for Barry by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
