doc/www/doxygen/html/record_8h-source.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: record.h Source File</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>record.h</h1><a href="record_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>
  24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file       record.h</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             Blackberry database record classes.  Help translate data</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///             from data packets to useful structurs, and back.</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span><span class="comment">///             This header provides the common types and classes</span>
  28 <a name="l00006"></a>00006 <span class="comment"></span><span class="comment">///             used by the general record parser classes in the</span>
  29 <a name="l00007"></a>00007 <span class="comment"></span><span class="comment">///             r_*.h files.  Only application-safe API stuff goes in</span>
  30 <a name="l00008"></a>00008 <span class="comment"></span><span class="comment">///             here.  Internal library types go in record-internal.h</span>
  31 <a name="l00009"></a>00009 <span class="comment"></span><span class="comment">///</span>
  32 <a name="l00010"></a>00010 <span class="comment"></span>
  33 <a name="l00011"></a>00011 <span class="comment">/*</span>
  34 <a name="l00012"></a>00012 <span class="comment">    Copyright (C) 2005-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
  35 <a name="l00013"></a>00013 <span class="comment"></span>
  36 <a name="l00014"></a>00014 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  37 <a name="l00015"></a>00015 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  38 <a name="l00016"></a>00016 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  39 <a name="l00017"></a>00017 <span class="comment">    (at your option) any later version.</span>
  40 <a name="l00018"></a>00018 <span class="comment"></span>
  41 <a name="l00019"></a>00019 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  42 <a name="l00020"></a>00020 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  43 <a name="l00021"></a>00021 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  44 <a name="l00022"></a>00022 <span class="comment"></span>
  45 <a name="l00023"></a>00023 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  46 <a name="l00024"></a>00024 <span class="comment">    root directory of this project for more details.</span>
  47 <a name="l00025"></a>00025 <span class="comment">*/</span>
  48 <a name="l00026"></a>00026
  49 <a name="l00027"></a>00027 <span class="preprocessor">#ifndef __BARRY_RECORD_H__</span>
  50 <a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_RECORD_H__</span>
  51 <a name="l00029"></a>00029 <span class="preprocessor"></span>
  52 <a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
  53 <a name="l00031"></a>00031 <span class="preprocessor">#include &lt;iosfwd&gt;</span>
  54 <a name="l00032"></a>00032 <span class="preprocessor">#include &lt;string&gt;</span>
  55 <a name="l00033"></a>00033 <span class="preprocessor">#include &lt;vector&gt;</span>
  56 <a name="l00034"></a>00034 <span class="preprocessor">#include &lt;map&gt;</span>
  57 <a name="l00035"></a>00035 <span class="preprocessor">#include &lt;stdint.h&gt;</span>
  58 <a name="l00036"></a>00036
  59 <a name="l00037"></a>00037 <span class="comment">// forward declarations</span>
  60 <a name="l00038"></a>00038 <span class="keyword">namespace </span>Barry { <span class="keyword">class </span>Data; }
  61 <a name="l00039"></a>00039
  62 <a name="l00040"></a>00040 <span class="keyword">namespace </span>Barry {
  63 <a name="l00041"></a>00041
  64 <a name="l00042"></a>00042 <span class="comment">//</span>
  65 <a name="l00043"></a>00043 <span class="comment">// NOTE:  All classes here must be container-safe!  Perhaps add sorting</span>
  66 <a name="l00044"></a>00044 <span class="comment">//        operators in the future.</span>
  67 <a name="l00045"></a>00045 <span class="comment">//</span>
  68 <a name="l00046"></a>00046
  69 <a name="l00047"></a>00047
  70 <a name="l00048"></a>00048 <span class="comment">// stream-based wrapper to avoid printing strings that contain</span>
  71 <a name="l00049"></a>00049 <span class="comment">// the \r carriage return characters</span>
  72 <a name="l00050"></a>00050 <span class="keyword">class </span>BXEXPORT Cr2LfWrapper
  73 <a name="l00051"></a>00051 {
  74 <a name="l00052"></a>00052         <span class="keyword">friend</span> std::ostream&amp; operator&lt;&lt; (std::ostream &amp;os, <span class="keyword">const</span> Cr2LfWrapper &amp;str);
  75 <a name="l00053"></a>00053         <span class="keyword">const</span> std::string &amp;m_str;
  76 <a name="l00054"></a>00054 <span class="keyword">public</span>:
  77 <a name="l00055"></a>00055         <span class="keyword">explicit</span> Cr2LfWrapper(<span class="keyword">const</span> std::string &amp;str)
  78 <a name="l00056"></a>00056                 : m_str(str)
  79 <a name="l00057"></a>00057         {
  80 <a name="l00058"></a>00058         }
  81 <a name="l00059"></a>00059 };
  82 <a name="l00060"></a>00060 BXEXPORT std::ostream&amp; operator&lt;&lt; (std::ostream &amp;os, <span class="keyword">const</span> Cr2LfWrapper &amp;str);
  83 <a name="l00061"></a>00061
  84 <a name="l00062"></a>00062 <span class="keyword">struct </span>BXEXPORT CommandTableCommand
  85 <a name="l00063"></a>00063 {
  86 <a name="l00064"></a>00064         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Code;
  87 <a name="l00065"></a>00065         std::string Name;
  88 <a name="l00066"></a>00066 };
  89 <a name="l00067"></a>00067
  90 <a name="l00068"></a>00068 <span class="keyword">class </span>BXEXPORT CommandTable
  91 <a name="l00069"></a>00069 {
  92 <a name="l00070"></a>00070 <span class="keyword">public</span>:
  93 <a name="l00071"></a>00071         <span class="keyword">typedef</span> CommandTableCommand Command;
  94 <a name="l00072"></a>00072         <span class="keyword">typedef</span> std::vector&lt;Command&gt; CommandArrayType;
  95 <a name="l00073"></a>00073
  96 <a name="l00074"></a>00074         CommandArrayType Commands;
  97 <a name="l00075"></a>00075
  98 <a name="l00076"></a>00076 <span class="keyword">private</span>:
  99 <a name="l00077"></a>00077         BXLOCAL <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* ParseField(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *begin,
 100 <a name="l00078"></a>00078                 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end);
 101 <a name="l00079"></a>00079 <span class="keyword">public</span>:
 102 <a name="l00080"></a>00080         CommandTable();
 103 <a name="l00081"></a>00081         ~CommandTable();
 104 <a name="l00082"></a>00082
 105 <a name="l00083"></a>00083         <span class="keywordtype">void</span> Parse(<span class="keyword">const</span> Data &amp;data, <span class="keywordtype">size_t</span> offset);
 106 <a name="l00084"></a>00084         <span class="keywordtype">void</span> Clear();
 107 <a name="l00085"></a>00085
 108 <a name="l00086"></a>00086         <span class="comment">// returns 0 if unable to find command name, which is safe, since</span>
 109 <a name="l00087"></a>00087         <span class="comment">// 0 is a special command that shouldn't be in the table anyway</span>
 110 <a name="l00088"></a>00088         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetCommand(<span class="keyword">const</span> std::string &amp;name) <span class="keyword">const</span>;
 111 <a name="l00089"></a>00089
 112 <a name="l00090"></a>00090         <span class="keywordtype">void</span> Dump(std::ostream &amp;os) <span class="keyword">const</span>;
 113 <a name="l00091"></a>00091 };
 114 <a name="l00092"></a>00092
 115 <a name="l00093"></a>00093 BXEXPORT <span class="keyword">inline</span> std::ostream&amp; operator&lt;&lt; (std::ostream &amp;os, <span class="keyword">const</span> CommandTable &amp;command) {
 116 <a name="l00094"></a>00094         command.Dump(os);
 117 <a name="l00095"></a>00095         <span class="keywordflow">return</span> os;
 118 <a name="l00096"></a>00096 }
 119 <a name="l00097"></a>00097
 120 <a name="l00098"></a>00098
 121 <a name="l00099"></a>00099
 122 <a name="l00100"></a>00100 <span class="keyword">struct </span>BXEXPORT RecordStateTableState
 123 <a name="l00101"></a>00101 {
 124 <a name="l00102"></a>00102         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Index;
 125 <a name="l00103"></a>00103         uint32_t RecordId;
 126 <a name="l00104"></a>00104         <span class="keywordtype">bool</span> Dirty;
 127 <a name="l00105"></a>00105         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> RecType;
 128 <a name="l00106"></a>00106         std::string Unknown2;
 129 <a name="l00107"></a>00107 };
 130 <a name="l00108"></a>00108
 131 <a name="l00109"></a>00109 <span class="keyword">class </span>BXEXPORT RecordStateTable
 132 <a name="l00110"></a>00110 {
 133 <a name="l00111"></a>00111 <span class="keyword">public</span>:
 134 <a name="l00112"></a>00112         <span class="keyword">typedef</span> RecordStateTableState State;
 135 <a name="l00113"></a>00113         <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> IndexType;
 136 <a name="l00114"></a>00114         <span class="keyword">typedef</span> std::map&lt;IndexType, State&gt; StateMapType;
 137 <a name="l00115"></a>00115
 138 <a name="l00116"></a>00116         StateMapType StateMap;
 139 <a name="l00117"></a>00117
 140 <a name="l00118"></a>00118 <span class="keyword">private</span>:
 141 <a name="l00119"></a>00119         <span class="keyword">mutable</span> IndexType m_LastNewRecordId;
 142 <a name="l00120"></a>00120
 143 <a name="l00121"></a>00121 <span class="keyword">private</span>:
 144 <a name="l00122"></a>00122         BXLOCAL <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* ParseField(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *begin,
 145 <a name="l00123"></a>00123                 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end);
 146 <a name="l00124"></a>00124
 147 <a name="l00125"></a>00125 <span class="keyword">public</span>:
 148 <a name="l00126"></a>00126         RecordStateTable();
 149 <a name="l00127"></a>00127         ~RecordStateTable();
 150 <a name="l00128"></a>00128
 151 <a name="l00129"></a>00129         <span class="keywordtype">void</span> Parse(<span class="keyword">const</span> Data &amp;data);
 152 <a name="l00130"></a>00130         <span class="keywordtype">void</span> Clear();
 153 <a name="l00131"></a>00131
 154 <a name="l00132"></a>00132         <span class="keywordtype">bool</span> GetIndex(uint32_t RecordId, IndexType *pFoundIndex = 0) <span class="keyword">const</span>;
 155 <a name="l00133"></a>00133         uint32_t MakeNewRecordId() <span class="keyword">const</span>;
 156 <a name="l00134"></a>00134
 157 <a name="l00135"></a>00135         <span class="keywordtype">void</span> Dump(std::ostream &amp;os) <span class="keyword">const</span>;
 158 <a name="l00136"></a>00136 };
 159 <a name="l00137"></a>00137
 160 <a name="l00138"></a>00138 BXEXPORT <span class="keyword">inline</span> std::ostream&amp; operator&lt;&lt; (std::ostream &amp;os, <span class="keyword">const</span> RecordStateTable &amp;rst) {
 161 <a name="l00139"></a>00139         rst.Dump(os);
 162 <a name="l00140"></a>00140         <span class="keywordflow">return</span> os;
 163 <a name="l00141"></a>00141 }
 164 <a name="l00142"></a>00142
 165 <a name="l00143"></a>00143
 166 <a name="l00144"></a>00144
 167 <a name="l00145"></a>00145 <span class="keyword">struct </span>BXEXPORT DatabaseItem
 168 <a name="l00146"></a>00146 {
 169 <a name="l00147"></a>00147         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Number;
 170 <a name="l00148"></a>00148         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> RecordCount;
 171 <a name="l00149"></a>00149         std::string Name;
 172 <a name="l00150"></a>00150 };
 173 <a name="l00151"></a>00151
 174 <a name="l00152"></a>00152 <span class="keyword">class </span>BXEXPORT DatabaseDatabase
 175 <a name="l00153"></a>00153 {
 176 <a name="l00154"></a>00154 <span class="keyword">public</span>:
 177 <a name="l00155"></a>00155         <span class="keyword">typedef</span> DatabaseItem Database;
 178 <a name="l00156"></a>00156         <span class="keyword">typedef</span> std::vector&lt;Database&gt; DatabaseArrayType;
 179 <a name="l00157"></a>00157
 180 <a name="l00158"></a>00158         DatabaseArrayType Databases;
 181 <a name="l00159"></a>00159
 182 <a name="l00160"></a>00160 <span class="keyword">private</span>:
 183 <a name="l00161"></a>00161         <span class="keyword">template</span> &lt;<span class="keyword">class</span> RecordType, <span class="keyword">class</span> FieldType&gt;
 184 <a name="l00162"></a>00162         <span class="keywordtype">void</span> ParseRec(<span class="keyword">const</span> RecordType &amp;rec, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end);
 185 <a name="l00163"></a>00163
 186 <a name="l00164"></a>00164         <span class="keyword">template</span> &lt;<span class="keyword">class</span> FieldType&gt;
 187 <a name="l00165"></a>00165         <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* ParseField(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *begin,
 188 <a name="l00166"></a>00166                 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end);
 189 <a name="l00167"></a>00167
 190 <a name="l00168"></a>00168 <span class="keyword">public</span>:
 191 <a name="l00169"></a>00169         DatabaseDatabase();
 192 <a name="l00170"></a>00170         ~DatabaseDatabase();
 193 <a name="l00171"></a>00171
 194 <a name="l00172"></a>00172         <span class="keywordtype">void</span> Parse(<span class="keyword">const</span> Data &amp;data);
 195 <a name="l00173"></a>00173         <span class="keywordtype">void</span> Clear();
 196 <a name="l00174"></a>00174
 197 <a name="l00175"></a>00175         <span class="keywordtype">void</span> SortByName();
 198 <a name="l00176"></a>00176
 199 <a name="l00177"></a>00177         <span class="comment">// returns true on success, and fills target</span>
 200 <a name="l00178"></a>00178         <span class="keywordtype">bool</span> GetDBNumber(<span class="keyword">const</span> std::string &amp;name, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &amp;number) <span class="keyword">const</span>;
 201 <a name="l00179"></a>00179         <span class="keywordtype">bool</span> GetDBName(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> number, std::string &amp;name) <span class="keyword">const</span>;
 202 <a name="l00180"></a>00180
 203 <a name="l00181"></a>00181         <span class="keywordtype">void</span> Dump(std::ostream &amp;os) <span class="keyword">const</span>;
 204 <a name="l00182"></a>00182 };
 205 <a name="l00183"></a>00183
 206 <a name="l00184"></a>00184 BXEXPORT <span class="keyword">inline</span> std::ostream&amp; operator&lt;&lt;(std::ostream &amp;os, <span class="keyword">const</span> DatabaseDatabase &amp;dbdb) {
 207 <a name="l00185"></a>00185         dbdb.Dump(os);
 208 <a name="l00186"></a>00186         <span class="keywordflow">return</span> os;
 209 <a name="l00187"></a>00187 }
 210 <a name="l00188"></a>00188
 211 <a name="l00189"></a>00189 <span class="keyword">struct </span>UnknownData
 212 <a name="l00190"></a>00190 {
 213 <a name="l00191"></a>00191         std::string raw_data;
 214 <a name="l00192"></a>00192
 215 <a name="l00193"></a>00193         <span class="keyword">const</span> std::string::value_type* data()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> raw_data.data(); }
 216 <a name="l00194"></a>00194         std::string::size_type size()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> raw_data.size(); }
 217 <a name="l00195"></a>00195         <span class="keywordtype">void</span> assign(<span class="keyword">const</span> std::string::value_type *s, std::string::size_type n)
 218 <a name="l00196"></a>00196                 { raw_data.assign(s, n); }
 219 <a name="l00197"></a>00197 };
 220 <a name="l00198"></a>00198
 221 <a name="l00199"></a>00199 <span class="keyword">struct </span>BXEXPORT UnknownField
 222 <a name="l00200"></a>00200 {
 223 <a name="l00201"></a>00201         uint8_t type;
 224 <a name="l00202"></a>00202         UnknownData data;
 225 <a name="l00203"></a>00203 };
 226 <a name="l00204"></a>00204 <span class="keyword">typedef</span> std::vector&lt;UnknownField&gt; UnknownsType;
 227 <a name="l00205"></a>00205 BXEXPORT std::ostream&amp; operator&lt;&lt; (std::ostream &amp;os, <span class="keyword">const</span> UnknownsType &amp;unknowns);
 228 <a name="l00206"></a>00206
 229 <a name="l00207"></a>00207 <span class="keyword">struct </span>BXEXPORT EmailAddress
 230 <a name="l00208"></a>00208 {
 231 <a name="l00209"></a>00209         std::string Name;
 232 <a name="l00210"></a>00210         std::string Email;
 233 <a name="l00211"></a>00211
 234 <a name="l00212"></a>00212         <span class="keywordtype">void</span> clear()
 235 <a name="l00213"></a>00213         {
 236 <a name="l00214"></a>00214                 Name.clear();
 237 <a name="l00215"></a>00215                 Email.clear();
 238 <a name="l00216"></a>00216         }
 239 <a name="l00217"></a>00217
 240 <a name="l00218"></a>00218         <span class="keywordtype">size_t</span> size()<span class="keyword"> const</span>
 241 <a name="l00219"></a>00219 <span class="keyword">        </span>{
 242 <a name="l00220"></a>00220                 <span class="keywordflow">return</span> Name.size() + Email.size();
 243 <a name="l00221"></a>00221         }
 244 <a name="l00222"></a>00222 };
 245 <a name="l00223"></a>00223 BXEXPORT std::ostream&amp; operator&lt;&lt;(std::ostream &amp;os, <span class="keyword">const</span> EmailAddress &amp;msga);
 246 <a name="l00224"></a>00224
 247 <a name="l00225"></a>00225 <span class="keyword">typedef</span> std::vector&lt;EmailAddress&gt;       EmailAddressList;
 248 <a name="l00226"></a>00226 BXEXPORT std::ostream&amp; operator&lt;&lt;(std::ostream &amp;os, <span class="keyword">const</span> EmailAddressList &amp;elist);
 249 <a name="l00227"></a>00227
 250 <a name="l00228"></a>00228 <span class="keyword">struct </span>BXEXPORT PostalAddress
 251 <a name="l00229"></a>00229 {
 252 <a name="l00230"></a>00230         std::string
 253 <a name="l00231"></a>00231                 Address1,
 254 <a name="l00232"></a>00232                 Address2,
 255 <a name="l00233"></a>00233                 Address3,
 256 <a name="l00234"></a>00234                 City,
 257 <a name="l00235"></a>00235                 Province,
 258 <a name="l00236"></a>00236                 PostalCode,
 259 <a name="l00237"></a>00237                 Country;
 260 <a name="l00238"></a>00238
 261 <a name="l00239"></a>00239         std::string GetLabel() <span class="keyword">const</span>;
 262 <a name="l00240"></a>00240         <span class="keywordtype">void</span> Clear();
 263 <a name="l00241"></a>00241
 264 <a name="l00242"></a>00242         <span class="keywordtype">bool</span> HasData()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> Address1.size() || Address2.size() ||
 265 <a name="l00243"></a>00243                 Address3.size() || City.size() || Province.size() ||
 266 <a name="l00244"></a>00244                 PostalCode.size() || Country.size(); }
 267 <a name="l00245"></a>00245 };
 268 <a name="l00246"></a>00246 BXEXPORT std::ostream&amp; operator&lt;&lt;(std::ostream &amp;os, <span class="keyword">const</span> PostalAddress &amp;msga);
 269 <a name="l00247"></a>00247
 270 <a name="l00248"></a>00248 <span class="keyword">struct </span>BXEXPORT Date
 271 <a name="l00249"></a>00249 {
 272 <a name="l00250"></a>00250         <span class="keywordtype">int</span> Month;                      <span class="comment">// 0 to 11</span>
 273 <a name="l00251"></a>00251         <span class="keywordtype">int</span> Day;                        <span class="comment">// 1 to 31</span>
 274 <a name="l00252"></a>00252         <span class="keywordtype">int</span> Year;                       <span class="comment">// exact number, eg. 2008</span>
 275 <a name="l00253"></a>00253
 276 <a name="l00254"></a>00254         Date() : Month(0), Day(0), Year(0) {}
 277 <a name="l00255"></a>00255         <span class="keyword">explicit</span> Date(<span class="keyword">const</span> <span class="keyword">struct</span> tm *timep);
 278 <a name="l00256"></a>00256
 279 <a name="l00257"></a>00257         <span class="keywordtype">bool</span> HasData()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> Month || Day || Year; }
 280 <a name="l00258"></a>00258         <span class="keywordtype">void</span> Clear();
 281 <a name="l00259"></a>00259
 282 <a name="l00260"></a>00260         <span class="keywordtype">void</span> ToTm(<span class="keyword">struct</span> tm *timep) <span class="keyword">const</span>;
 283 <a name="l00261"></a>00261         std::string ToYYYYMMDD() <span class="keyword">const</span>;
 284 <a name="l00262"></a>00262         std::string ToBBString() <span class="keyword">const</span>; <span class="comment">// converts to Blackberry string</span>
 285 <a name="l00263"></a>00263                                         <span class="comment">// format of DD/MM/YYYY</span>
 286 <a name="l00264"></a>00264
 287 <a name="l00265"></a>00265         <span class="keywordtype">bool</span> FromTm(<span class="keyword">const</span> <span class="keyword">struct</span> tm *timep);
 288 <a name="l00266"></a>00266         <span class="keywordtype">bool</span> FromBBString(<span class="keyword">const</span> std::string &amp;str);
 289 <a name="l00267"></a>00267         <span class="keywordtype">bool</span> FromYYYYMMDD(<span class="keyword">const</span> std::string &amp;str);
 290 <a name="l00268"></a>00268 };
 291 <a name="l00269"></a>00269 BXEXPORT std::ostream&amp; operator&lt;&lt;(std::ostream &amp;os, <span class="keyword">const</span> Date &amp;date);
 292 <a name="l00270"></a>00270
 293 <a name="l00271"></a>00271 <span class="keyword">class </span>BXEXPORT CategoryList : <span class="keyword">public</span> std::vector&lt;std::string&gt;
 294 <a name="l00272"></a>00272 {
 295 <a name="l00273"></a>00273 <span class="keyword">public</span>:<span class="comment"></span>
 296 <a name="l00274"></a>00274 <span class="comment">        /// Parses the given comma delimited category string into</span>
 297 <a name="l00275"></a>00275 <span class="comment">        /// this CategoryList object, appending each token to the vector.</span>
 298 <a name="l00276"></a>00276 <span class="comment">        /// Will clear vector beforehand.</span>
 299 <a name="l00277"></a>00277 <span class="comment"></span>        <span class="keywordtype">void</span> CategoryStr2List(<span class="keyword">const</span> std::string &amp;str);
 300 <a name="l00278"></a>00278 <span class="comment"></span>
 301 <a name="l00279"></a>00279 <span class="comment">        /// Turns the current vectory into a comma delimited category</span>
 302 <a name="l00280"></a>00280 <span class="comment">        /// string suitable for use in Calendar, Task, and Memo</span>
 303 <a name="l00281"></a>00281 <span class="comment">        /// protocol values.</span>
 304 <a name="l00282"></a>00282 <span class="comment"></span>        <span class="keywordtype">void</span> CategoryList2Str(std::string &amp;str) <span class="keyword">const</span>;
 305 <a name="l00283"></a>00283
 306 <a name="l00284"></a>00284         <span class="keyword">using</span> std::vector&lt;std::string&gt;::operator=;
 307 <a name="l00285"></a>00285 };
 308 <a name="l00286"></a>00286
 309 <a name="l00287"></a>00287 <span class="comment"></span>
 310 <a name="l00288"></a>00288 <span class="comment">/// \addtogroup RecordParserClasses</span>
 311 <a name="l00289"></a>00289 <span class="comment">///             Parser and data storage classes.  These classes take a</span>
 312 <a name="l00290"></a>00290 <span class="comment">///             Database Database record and convert them into C++ objects.</span>
 313 <a name="l00291"></a>00291 <span class="comment">///             Each of these classes are safe to be used in standard</span>
 314 <a name="l00292"></a>00292 <span class="comment">///             containers, and are meant to be used in conjunction with the</span>
 315 <a name="l00293"></a>00293 <span class="comment">///             RecordParser&lt;&gt; template when calling Controller::LoadDatabase().</span>
 316 <a name="l00294"></a>00294 <span class="comment">/// @{</span>
 317 <a name="l00295"></a>00295 <span class="comment">/// @}</span>
 318 <a name="l00296"></a>00296 <span class="comment"></span>
 319 <a name="l00297"></a>00297 } <span class="comment">// namespace Barry</span>
 320 <a name="l00298"></a>00298
 321 <a name="l00299"></a>00299 <span class="preprocessor">#ifndef __BARRY_LIBRARY_BUILD__</span>
 322 <a name="l00300"></a>00300 <span class="preprocessor"></span><span class="comment">// Include all parser classes, to make it easy for the application to use.</span>
 323 <a name="l00301"></a>00301 <span class="preprocessor">#include "<a class="code" href="r__calendar_8h.html" title="Blackberry database record parser class for calendar records.">r_calendar.h</a>"</span>
 324 <a name="l00302"></a>00302 <span class="preprocessor">#include "<a class="code" href="r__calllog_8h.html" title="Record parsing class for call logs.">r_calllog.h</a>"</span>
 325 <a name="l00303"></a>00303 <span class="preprocessor">#include "<a class="code" href="r__bookmark_8h.html" title="Record parsing class for call logs.">r_bookmark.h</a>"</span>
 326 <a name="l00304"></a>00304 <span class="preprocessor">#include "<a class="code" href="r__contact_8h.html" title="Blackberry database record parser class for contact records.">r_contact.h</a>"</span>
 327 <a name="l00305"></a>00305 <span class="preprocessor">#include "<a class="code" href="r__cstore_8h.html" title="Blackberry database record parser class for Content Store records.">r_cstore.h</a>"</span>
 328 <a name="l00306"></a>00306 <span class="preprocessor">#include "<a class="code" href="r__memo_8h.html" title="Record parsing class for the memo database.">r_memo.h</a>"</span>
 329 <a name="l00307"></a>00307 <span class="preprocessor">#include "<a class="code" href="r__message_8h.html" title="Blackberry database record parser class for email records.">r_message.h</a>"</span>
 330 <a name="l00308"></a>00308 <span class="preprocessor">#include "<a class="code" href="r__servicebook_8h.html" title="Blackberry database record parser class for the Service Book record.">r_servicebook.h</a>"</span>
 331 <a name="l00309"></a>00309 <span class="preprocessor">#include "<a class="code" href="r__task_8h.html" title="Record parsing class for the task database.">r_task.h</a>"</span>
 332 <a name="l00310"></a>00310 <span class="preprocessor">#include "<a class="code" href="r__pin__message_8h.html" title="Blackberry database record parser class for pin message records.">r_pin_message.h</a>"</span>
 333 <a name="l00311"></a>00311 <span class="preprocessor">#include "r_saved_message.h"</span>
 334 <a name="l00312"></a>00312 <span class="preprocessor">#include "r_sms.h"</span>
 335 <a name="l00313"></a>00313 <span class="preprocessor">#include "<a class="code" href="r__folder_8h.html" title="Record parsing class for the Folder database.">r_folder.h</a>"</span>
 336 <a name="l00314"></a>00314 <span class="preprocessor">#include "<a class="code" href="r__timezone_8h.html" title="Record parsing class for the timezone database.">r_timezone.h</a>"</span>
 337 <a name="l00315"></a>00315 <span class="preprocessor">#endif</span>
 338 <a name="l00316"></a>00316 <span class="preprocessor"></span>
 339 <a name="l00317"></a>00317 <span class="preprocessor">#endif</span>
 340 <a name="l00318"></a>00318 <span class="preprocessor"></span>
 341 </pre></div></div>
 342 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:13:59 2011 for Barry by&nbsp;
 343 <a href="http://www.doxygen.org/index.html">
 344 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 345 </body>
 346 </html>