doc/www/doxygen/html/r__memo_8cc-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: r_memo.cc 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>r_memo.cc</h1><a href="r__memo_8cc.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       r_memo.cc</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             Record parsing class for the memo database.</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span>
  28 <a name="l00006"></a>00006 <span class="comment">/*</span>
  29 <a name="l00007"></a>00007 <span class="comment">    Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)</span>
  30 <a name="l00008"></a>00008 <span class="comment">    Copyright (C) 2007, Brian Edginton</span>
  31 <a name="l00009"></a>00009 <span class="comment"></span>
  32 <a name="l00010"></a>00010 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  33 <a name="l00011"></a>00011 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  34 <a name="l00012"></a>00012 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  35 <a name="l00013"></a>00013 <span class="comment">    (at your option) any later version.</span>
  36 <a name="l00014"></a>00014 <span class="comment"></span>
  37 <a name="l00015"></a>00015 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  38 <a name="l00016"></a>00016 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  39 <a name="l00017"></a>00017 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  40 <a name="l00018"></a>00018 <span class="comment"></span>
  41 <a name="l00019"></a>00019 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  42 <a name="l00020"></a>00020 <span class="comment">    root directory of this project for more details.</span>
  43 <a name="l00021"></a>00021 <span class="comment">*/</span>
  44 <a name="l00022"></a>00022
  45 <a name="l00023"></a>00023 <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>
  46 <a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="record-internal_8h.html" title="Support functions, types, and templates for the general record parsing classes in...">record-internal.h</a>"</span>
  47 <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="protostructs_8h.html" title="USB Blackberry bulk protocol API.">protostructs.h</a>"</span>
  48 <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>
  49 <a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="time_8h.html" title="Time related conversion routines.">time.h</a>"</span>
  50 <a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="iconv_8h.html" title="iconv wrapper class, and pluggable interface for records">iconv.h</a>"</span>
  51 <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;ostream&gt;</span>
  52 <a name="l00030"></a>00030 <span class="preprocessor">#include &lt;iomanip&gt;</span>
  53 <a name="l00031"></a>00031
  54 <a name="l00032"></a>00032 <span class="keyword">using namespace </span>std;
  55 <a name="l00033"></a>00033 <span class="keyword">using namespace </span>Barry::Protocol;
  56 <a name="l00034"></a>00034
  57 <a name="l00035"></a>00035 <span class="keyword">namespace </span>Barry {
  58 <a name="l00036"></a>00036 <span class="comment"></span>
  59 <a name="l00037"></a>00037 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
  60 <a name="l00038"></a>00038 <span class="comment"></span><span class="comment">// Memo Class</span>
  61 <a name="l00039"></a>00039
  62 <a name="l00040"></a>00040 <span class="comment">// Memo Field Codes</span>
  63 <a name="l00041"></a>00041 <span class="preprocessor">#define MEMFC_TITLE             0x01</span>
  64 <a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define MEMFC_BODY              0x02</span>
  65 <a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define MEMFC_MEMO_TYPE         0x03</span>
  66 <a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define MEMFC_CATEGORY          0x04</span>
  67 <a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#define MEMFC_END               0xffff</span>
  68 <a name="l00046"></a>00046 <span class="preprocessor"></span>
  69 <a name="l00047"></a>00047 <span class="keyword">static</span> FieldLink&lt;Memo&gt; MemoFieldLinks[] = {
  70 <a name="l00048"></a>00048     { MEMFC_TITLE,     <span class="stringliteral">"Title"</span>,       0, 0, &amp;Memo::Title, 0, 0, 0, 0, <span class="keyword">true</span> },
  71 <a name="l00049"></a>00049     { MEMFC_BODY,      <span class="stringliteral">"Body"</span>,        0, 0, &amp;Memo::Body, 0, 0, 0, 0, <span class="keyword">true</span> },
  72 <a name="l00050"></a>00050     { MEMFC_END,       <span class="stringliteral">"End of List"</span>, 0, 0, 0, 0, 0, 0, 0, <span class="keyword">false</span> }
  73 <a name="l00051"></a>00051 };
  74 <a name="l00052"></a>00052
  75 <a name="l00053"></a>00053 Memo::Memo()
  76 <a name="l00054"></a>00054 {
  77 <a name="l00055"></a>00055         Clear();
  78 <a name="l00056"></a>00056 }
  79 <a name="l00057"></a>00057
  80 <a name="l00058"></a>00058 Memo::~Memo()
  81 <a name="l00059"></a>00059 {
  82 <a name="l00060"></a>00060 }
  83 <a name="l00061"></a>00061
  84 <a name="l00062"></a>00062 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* Memo::ParseField(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *begin,
  85 <a name="l00063"></a>00063                                       <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end,
  86 <a name="l00064"></a>00064                                       <span class="keyword">const</span> IConverter *ic)
  87 <a name="l00065"></a>00065 {
  88 <a name="l00066"></a>00066         <span class="keyword">const</span> CommonField *field = (<span class="keyword">const</span> CommonField *) begin;
  89 <a name="l00067"></a>00067
  90 <a name="l00068"></a>00068         <span class="comment">// advance and check size</span>
  91 <a name="l00069"></a>00069         begin += COMMON_FIELD_HEADER_SIZE + btohs(field-&gt;size);
  92 <a name="l00070"></a>00070         <span class="keywordflow">if</span>( begin &gt; end )       <span class="comment">// if begin==end, we are ok</span>
  93 <a name="l00071"></a>00071                 <span class="keywordflow">return</span> begin;
  94 <a name="l00072"></a>00072
  95 <a name="l00073"></a>00073         <span class="keywordflow">if</span>( !btohs(field-&gt;size) )   <span class="comment">// if field has no size, something's up</span>
  96 <a name="l00074"></a>00074                 <span class="keywordflow">return</span> begin;
  97 <a name="l00075"></a>00075
  98 <a name="l00076"></a>00076         <span class="keywordflow">if</span>( field-&gt;type == MEMFC_MEMO_TYPE ) {
  99 <a name="l00077"></a>00077                 <span class="keywordflow">if</span>( field-&gt;u.raw[0] != <span class="charliteral">'m'</span> ) {
 100 <a name="l00078"></a>00078                         <span class="keywordflow">throw</span> Error( <span class="stringliteral">"Memo::ParseField: MemoType is not 'm'"</span> );
 101 <a name="l00079"></a>00079                 }
 102 <a name="l00080"></a>00080                 <span class="keywordflow">return</span> begin;
 103 <a name="l00081"></a>00081         }
 104 <a name="l00082"></a>00082
 105 <a name="l00083"></a>00083
 106 <a name="l00084"></a>00084         <span class="comment">// cycle through the type table</span>
 107 <a name="l00085"></a>00085         <span class="keywordflow">for</span>(    FieldLink&lt;Memo&gt; *b = MemoFieldLinks;
 108 <a name="l00086"></a>00086                 b-&gt;type != MEMFC_END;
 109 <a name="l00087"></a>00087                 b++ )
 110 <a name="l00088"></a>00088         {
 111 <a name="l00089"></a>00089                 <span class="keywordflow">if</span>( b-&gt;type == field-&gt;type ) {
 112 <a name="l00090"></a>00090                         <span class="keywordflow">if</span>( b-&gt;strMember ) {
 113 <a name="l00091"></a>00091                                 std::string &amp;s = this-&gt;*(b-&gt;strMember);
 114 <a name="l00092"></a>00092                                 s = ParseFieldString(field);
 115 <a name="l00093"></a>00093                                 <span class="keywordflow">if</span>( b-&gt;iconvNeeded &amp;&amp; ic )
 116 <a name="l00094"></a>00094                                         s = ic-&gt;FromBB(s);
 117 <a name="l00095"></a>00095                                 <span class="keywordflow">return</span> begin;   <span class="comment">// done!</span>
 118 <a name="l00096"></a>00096                         }
 119 <a name="l00097"></a>00097                         <span class="keywordflow">else</span> <span class="keywordflow">if</span>( b-&gt;timeMember &amp;&amp; btohs(field-&gt;size) == 4 ) {
 120 <a name="l00098"></a>00098                                 time_t &amp;t = this-&gt;*(b-&gt;timeMember);
 121 <a name="l00099"></a>00099                                 t = min2time(field-&gt;u.min1900);
 122 <a name="l00100"></a>00100                                 <span class="keywordflow">return</span> begin;
 123 <a name="l00101"></a>00101                         }
 124 <a name="l00102"></a>00102                 }
 125 <a name="l00103"></a>00103         }
 126 <a name="l00104"></a>00104         <span class="comment">// handle special cases</span>
 127 <a name="l00105"></a>00105         <span class="keywordflow">switch</span>( field-&gt;type )
 128 <a name="l00106"></a>00106         {
 129 <a name="l00107"></a>00107         <span class="keywordflow">case</span> MEMFC_CATEGORY:
 130 <a name="l00108"></a>00108                 {
 131 <a name="l00109"></a>00109                         std::string catstring = ParseFieldString(field);
 132 <a name="l00110"></a>00110                         <span class="keywordflow">if</span>( ic )
 133 <a name="l00111"></a>00111                                 catstring = ic-&gt;FromBB(catstring);
 134 <a name="l00112"></a>00112                         Categories.CategoryStr2List(catstring);
 135 <a name="l00113"></a>00113                 }
 136 <a name="l00114"></a>00114                 <span class="keywordflow">return</span> begin;
 137 <a name="l00115"></a>00115         }
 138 <a name="l00116"></a>00116
 139 <a name="l00117"></a>00117         <span class="comment">// if still not handled, add to the Unknowns list</span>
 140 <a name="l00118"></a>00118         UnknownField uf;
 141 <a name="l00119"></a>00119         uf.type = field-&gt;type;
 142 <a name="l00120"></a>00120         uf.data.assign((<span class="keyword">const</span> <span class="keywordtype">char</span>*)field-&gt;u.raw, btohs(field-&gt;size));
 143 <a name="l00121"></a>00121         Unknowns.push_back(uf);
 144 <a name="l00122"></a>00122
 145 <a name="l00123"></a>00123         <span class="comment">// return new pointer for next field</span>
 146 <a name="l00124"></a>00124         <span class="keywordflow">return</span> begin;
 147 <a name="l00125"></a>00125 }
 148 <a name="l00126"></a>00126
 149 <a name="l00127"></a>00127 <span class="keywordtype">void</span> Memo::ParseHeader(<span class="keyword">const</span> Data &amp;data, <span class="keywordtype">size_t</span> &amp;offset)
 150 <a name="l00128"></a>00128 {
 151 <a name="l00129"></a>00129         <span class="comment">// no header in Memo records</span>
 152 <a name="l00130"></a>00130 }
 153 <a name="l00131"></a>00131
 154 <a name="l00132"></a>00132 <span class="keywordtype">void</span> Memo::ParseFields(<span class="keyword">const</span> Data &amp;data, <span class="keywordtype">size_t</span> &amp;offset, <span class="keyword">const</span> IConverter *ic)
 155 <a name="l00133"></a>00133 {
 156 <a name="l00134"></a>00134         <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *finish = ParseCommonFields(*<span class="keyword">this</span>,
 157 <a name="l00135"></a>00135                 data.GetData() + offset, data.GetData() + data.GetSize(), ic);
 158 <a name="l00136"></a>00136         offset += finish - (data.GetData() + offset);
 159 <a name="l00137"></a>00137 }
 160 <a name="l00138"></a>00138
 161 <a name="l00139"></a>00139
 162 <a name="l00140"></a>00140 <span class="keywordtype">void</span> Memo::BuildHeader(Data &amp;data, <span class="keywordtype">size_t</span> &amp;offset)<span class="keyword"> const</span>
 163 <a name="l00141"></a>00141 <span class="keyword"></span>{
 164 <a name="l00142"></a>00142         <span class="comment">// no header in Memo records</span>
 165 <a name="l00143"></a>00143 }
 166 <a name="l00144"></a>00144
 167 <a name="l00145"></a>00145
 168 <a name="l00146"></a>00146 <span class="comment">//</span>
 169 <a name="l00147"></a>00147 <span class="comment">// Build</span>
 170 <a name="l00148"></a>00148 <span class="comment">//</span><span class="comment"></span>
 171 <a name="l00149"></a>00149 <span class="comment">/// Build fields part of record.</span>
 172 <a name="l00150"></a>00150 <span class="comment">///</span>
 173 <a name="l00151"></a>00151 <span class="comment"></span><span class="keywordtype">void</span> Memo::BuildFields(Data &amp;data, <span class="keywordtype">size_t</span> &amp;offset, <span class="keyword">const</span> IConverter *ic)<span class="keyword"> const</span>
 174 <a name="l00152"></a>00152 <span class="keyword"></span>{
 175 <a name="l00153"></a>00153         data.Zap();
 176 <a name="l00154"></a>00154
 177 <a name="l00155"></a>00155         <span class="comment">// tack on the 'm' memo type field first</span>
 178 <a name="l00156"></a>00156         BuildField(data, offset, MEMFC_MEMO_TYPE, <span class="charliteral">'m'</span>);
 179 <a name="l00157"></a>00157
 180 <a name="l00158"></a>00158         <span class="comment">// Categories</span>
 181 <a name="l00159"></a>00159         <span class="keywordflow">if</span>( Categories.size() ) {
 182 <a name="l00160"></a>00160                 <span class="keywordtype">string</span> store;
 183 <a name="l00161"></a>00161                 Categories.CategoryList2Str(store);
 184 <a name="l00162"></a>00162                 BuildField(data, offset, MEMFC_CATEGORY, ic ? ic-&gt;ToBB(store) : store);
 185 <a name="l00163"></a>00163         }
 186 <a name="l00164"></a>00164
 187 <a name="l00165"></a>00165         <span class="comment">// cycle through the type table</span>
 188 <a name="l00166"></a>00166         <span class="keywordflow">for</span>(    FieldLink&lt;Memo&gt; *b = MemoFieldLinks;
 189 <a name="l00167"></a>00167                 b-&gt;type != MEMFC_END;
 190 <a name="l00168"></a>00168                 b++ )
 191 <a name="l00169"></a>00169         {
 192 <a name="l00170"></a>00170                 <span class="comment">// print only fields with data</span>
 193 <a name="l00171"></a>00171                 <span class="keywordflow">if</span>( b-&gt;strMember ) {
 194 <a name="l00172"></a>00172                         <span class="keyword">const</span> std::string &amp;field = this-&gt;*(b-&gt;strMember);
 195 <a name="l00173"></a>00173                         <span class="keywordflow">if</span>( field.size() ) {
 196 <a name="l00174"></a>00174                                 std::string s = (b-&gt;iconvNeeded &amp;&amp; ic) ? ic-&gt;ToBB(field) : field;
 197 <a name="l00175"></a>00175                                 BuildField(data, offset, b-&gt;type, s);
 198 <a name="l00176"></a>00176                         }
 199 <a name="l00177"></a>00177                 }
 200 <a name="l00178"></a>00178                 <span class="keywordflow">else</span> <span class="keywordflow">if</span>( b-&gt;postMember &amp;&amp; b-&gt;postField ) {
 201 <a name="l00179"></a>00179                         <span class="keyword">const</span> std::string &amp;field = (this-&gt;*(b-&gt;postMember)).*(b-&gt;postField);
 202 <a name="l00180"></a>00180                         <span class="keywordflow">if</span>( field.size() ) {
 203 <a name="l00181"></a>00181                                 std::string s = (b-&gt;iconvNeeded &amp;&amp; ic) ? ic-&gt;ToBB(field) : field;
 204 <a name="l00182"></a>00182                                 BuildField(data, offset, b-&gt;type, s);
 205 <a name="l00183"></a>00183                         }
 206 <a name="l00184"></a>00184                 }
 207 <a name="l00185"></a>00185         }
 208 <a name="l00186"></a>00186
 209 <a name="l00187"></a>00187         <span class="comment">// and finally save unknowns</span>
 210 <a name="l00188"></a>00188         UnknownsType::const_iterator
 211 <a name="l00189"></a>00189                 ub = Unknowns.begin(), ue = Unknowns.end();
 212 <a name="l00190"></a>00190         <span class="keywordflow">for</span>( ; ub != ue; ub++ ) {
 213 <a name="l00191"></a>00191                 BuildField(data, offset, *ub);
 214 <a name="l00192"></a>00192         }
 215 <a name="l00193"></a>00193
 216 <a name="l00194"></a>00194         data.ReleaseBuffer(offset);
 217 <a name="l00195"></a>00195 }
 218 <a name="l00196"></a>00196
 219 <a name="l00197"></a>00197
 220 <a name="l00198"></a>00198
 221 <a name="l00199"></a>00199 <span class="keywordtype">void</span> Memo::Dump(std::ostream &amp;os)<span class="keyword"> const</span>
 222 <a name="l00200"></a>00200 <span class="keyword"></span>{
 223 <a name="l00201"></a>00201         os &lt;&lt; <span class="stringliteral">"Memo entry: 0x"</span> &lt;&lt; setbase(16) &lt;&lt; RecordId
 224 <a name="l00202"></a>00202            &lt;&lt; <span class="stringliteral">" ("</span> &lt;&lt; (<span class="keywordtype">unsigned</span> int)RecType &lt;&lt; <span class="stringliteral">")\n"</span>;
 225 <a name="l00203"></a>00203         os &lt;&lt; <span class="stringliteral">"    Title: "</span> &lt;&lt; Title &lt;&lt; <span class="stringliteral">"\n"</span>;
 226 <a name="l00204"></a>00204         os &lt;&lt; <span class="stringliteral">"    Body: "</span> &lt;&lt; Body &lt;&lt; <span class="stringliteral">"\n"</span>;
 227 <a name="l00205"></a>00205         <span class="keywordflow">if</span>( Categories.size() ) {
 228 <a name="l00206"></a>00206                 <span class="keywordtype">string</span> display;
 229 <a name="l00207"></a>00207                 Categories.CategoryList2Str(display);
 230 <a name="l00208"></a>00208                 os &lt;&lt; <span class="stringliteral">"    Categories: "</span> &lt;&lt; display &lt;&lt; <span class="stringliteral">"\n"</span>;
 231 <a name="l00209"></a>00209         }
 232 <a name="l00210"></a>00210
 233 <a name="l00211"></a>00211         os &lt;&lt; Unknowns;
 234 <a name="l00212"></a>00212         os &lt;&lt; <span class="stringliteral">"\n\n"</span>;
 235 <a name="l00213"></a>00213 }
 236 <a name="l00214"></a>00214
 237 <a name="l00215"></a>00215 <span class="keywordtype">void</span> Memo::Clear()
 238 <a name="l00216"></a>00216 {
 239 <a name="l00217"></a>00217         Title.clear();
 240 <a name="l00218"></a>00218         Body.clear();
 241 <a name="l00219"></a>00219         Categories.clear();
 242 <a name="l00220"></a>00220
 243 <a name="l00221"></a>00221         Unknowns.clear();
 244 <a name="l00222"></a>00222 }
 245 <a name="l00223"></a>00223
 246 <a name="l00224"></a>00224
 247 <a name="l00225"></a>00225 } <span class="comment">// namespace Barry</span>
 248 <a name="l00226"></a>00226
 249 </pre></div></div>
 250 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 00:01:53 2009 for Barry by&nbsp;
 251 <a href="http://www.doxygen.org/index.html">
 252 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 253 </body>
 254 </html>