<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Barry: r_memo.cc Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<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="annotated.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="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<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>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file r_memo.cc</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Record parsing class for the memo database.</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-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"> Copyright (C) 2007, Brian Edginton</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00011"></a>00011 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00012"></a>00012 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00013"></a>00013 <span class="comment"> (at your option) any later version.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00016"></a>00016 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00017"></a>00017 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00020"></a>00020 <span class="comment"> root directory of this project for more details.</span>
<a name="l00021"></a>00021 <span class="comment">*/</span>
<a name="l00022"></a>00022
<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>
<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>
<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>
<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="time_8h.html" title="Time related conversion routines.">time.h</a>"</span>
<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>
<a name="l00029"></a>00029 <span class="preprocessor">#include <ostream></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <iomanip></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">using namespace </span>std;
<a name="l00033"></a>00033 <span class="keyword">using namespace </span>Barry::Protocol;
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">namespace </span>Barry {
<a name="l00036"></a>00036 <span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
<a name="l00038"></a>00038 <span class="comment"></span><span class="comment">// Memo Class</span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">// Memo Field Codes</span>
<a name="l00041"></a>00041 <span class="preprocessor">#define MEMFC_TITLE 0x01</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define MEMFC_BODY 0x02</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define MEMFC_MEMO_TYPE 0x03</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define MEMFC_CATEGORY 0x04</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#define MEMFC_END 0xffff</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00047"></a>00047 <span class="keyword">static</span> FieldLink<Memo> MemoFieldLinks[] = {
<a name="l00048"></a>00048 { MEMFC_TITLE, <span class="stringliteral">"Title"</span>, 0, 0, &Memo::Title, 0, 0, 0, 0, <span class="keyword">true</span> },
<a name="l00049"></a>00049 { MEMFC_BODY, <span class="stringliteral">"Body"</span>, 0, 0, &Memo::Body, 0, 0, 0, 0, <span class="keyword">true</span> },
<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> }
<a name="l00051"></a>00051 };
<a name="l00052"></a>00052
<a name="l00053"></a>00053 Memo::Memo()
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055 Clear();
<a name="l00056"></a>00056 }
<a name="l00057"></a>00057
<a name="l00058"></a>00058 Memo::~Memo()
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061
<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,
<a name="l00063"></a>00063 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end,
<a name="l00064"></a>00064 <span class="keyword">const</span> IConverter *ic)
<a name="l00065"></a>00065 {
<a name="l00066"></a>00066 <span class="keyword">const</span> <a class="code" href="structBarry_1_1Protocol_1_1CommonField.html">CommonField</a> *field = (<span class="keyword">const</span> <a class="code" href="structBarry_1_1Protocol_1_1CommonField.html">CommonField</a> *) begin;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="comment">// advance and check size</span>
<a name="l00069"></a>00069 begin += COMMON_FIELD_HEADER_SIZE + btohs(field->size);
<a name="l00070"></a>00070 <span class="keywordflow">if</span>( begin > end ) <span class="comment">// if begin==end, we are ok</span>
<a name="l00071"></a>00071 <span class="keywordflow">return</span> begin;
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keywordflow">if</span>( !btohs(field->size) ) <span class="comment">// if field has no size, something's up</span>
<a name="l00074"></a>00074 <span class="keywordflow">return</span> begin;
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keywordflow">if</span>( field->type == MEMFC_MEMO_TYPE ) {
<a name="l00077"></a>00077 <span class="keywordflow">if</span>( field->u.raw[0] != <span class="charliteral">'m'</span> ) {
<a name="l00078"></a>00078 <span class="keywordflow">throw</span> Error( <span class="stringliteral">"Memo::ParseField: MemoType is not 'm'"</span> );
<a name="l00079"></a>00079 }
<a name="l00080"></a>00080 <span class="keywordflow">return</span> begin;
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment">// cycle through the type table</span>
<a name="l00085"></a>00085 <span class="keywordflow">for</span>( FieldLink<Memo> *b = MemoFieldLinks;
<a name="l00086"></a>00086 b->type != MEMFC_END;
<a name="l00087"></a>00087 b++ )
<a name="l00088"></a>00088 {
<a name="l00089"></a>00089 <span class="keywordflow">if</span>( b->type == field->type ) {
<a name="l00090"></a>00090 <span class="keywordflow">if</span>( b->strMember ) {
<a name="l00091"></a>00091 std::string &s = this->*(b->strMember);
<a name="l00092"></a>00092 s = ParseFieldString(field);
<a name="l00093"></a>00093 <span class="keywordflow">if</span>( b->iconvNeeded && ic )
<a name="l00094"></a>00094 s = ic->FromBB(s);
<a name="l00095"></a>00095 <span class="keywordflow">return</span> begin; <span class="comment">// done!</span>
<a name="l00096"></a>00096 }
<a name="l00097"></a>00097 <span class="keywordflow">else</span> <span class="keywordflow">if</span>( b->timeMember && btohs(field->size) == 4 ) {
<a name="l00098"></a>00098 time_t &t = this->*(b->timeMember);
<a name="l00099"></a>00099 t = min2time(field->u.min1900);
<a name="l00100"></a>00100 <span class="keywordflow">return</span> begin;
<a name="l00101"></a>00101 }
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103 }
<a name="l00104"></a>00104 <span class="comment">// handle special cases</span>
<a name="l00105"></a>00105 <span class="keywordflow">switch</span>( field->type )
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 <span class="keywordflow">case</span> MEMFC_CATEGORY:
<a name="l00108"></a>00108 {
<a name="l00109"></a>00109 std::string catstring = ParseFieldString(field);
<a name="l00110"></a>00110 <span class="keywordflow">if</span>( ic )
<a name="l00111"></a>00111 catstring = ic->FromBB(catstring);
<a name="l00112"></a>00112 Categories.CategoryStr2List(catstring);
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114 <span class="keywordflow">return</span> begin;
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="comment">// if still not handled, add to the Unknowns list</span>
<a name="l00118"></a>00118 UnknownField uf;
<a name="l00119"></a>00119 uf.type = field->type;
<a name="l00120"></a>00120 uf.data.assign((<span class="keyword">const</span> <span class="keywordtype">char</span>*)field->u.raw, btohs(field->size));
<a name="l00121"></a>00121 Unknowns.push_back(uf);
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="comment">// return new pointer for next field</span>
<a name="l00124"></a>00124 <span class="keywordflow">return</span> begin;
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keywordtype">void</span> Memo::ParseHeader(<span class="keyword">const</span> Data &data, <span class="keywordtype">size_t</span> &offset)
<a name="l00128"></a>00128 {
<a name="l00129"></a>00129 <span class="comment">// no header in Memo records</span>
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="keywordtype">void</span> Memo::ParseFields(<span class="keyword">const</span> Data &data, <span class="keywordtype">size_t</span> &offset, <span class="keyword">const</span> IConverter *ic)
<a name="l00133"></a>00133 {
<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>,
<a name="l00135"></a>00135 data.GetData() + offset, data.GetData() + data.GetSize(), ic);
<a name="l00136"></a>00136 offset += finish - (data.GetData() + offset);
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="keywordtype">void</span> Memo::BuildHeader(Data &data, <span class="keywordtype">size_t</span> &offset)<span class="keyword"> const</span>
<a name="l00141"></a>00141 <span class="keyword"></span>{
<a name="l00142"></a>00142 <span class="comment">// no header in Memo records</span>
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="comment">//</span>
<a name="l00147"></a>00147 <span class="comment">// Build</span>
<a name="l00148"></a>00148 <span class="comment">//</span><span class="comment"></span>
<a name="l00149"></a>00149 <span class="comment">/// Build fields part of record.</span>
<a name="l00150"></a>00150 <span class="comment">///</span>
<a name="l00151"></a><a class="code" href="classBarry_1_1Memo.html#a203bd76ee27f27bf76a0e03566b32158">00151</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Memo.html#a203bd76ee27f27bf76a0e03566b32158" title="Build fields part of record.">Memo::BuildFields</a>(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &offset, <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)<span class="keyword"> const</span>
<a name="l00152"></a>00152 <span class="keyword"></span>{
<a name="l00153"></a>00153 data.<a class="code" href="classBarry_1_1Data.html#a034f95733ad4e34a3a3f3be874f3c555" title="set buffer to 0 and remove all data">Zap</a>();
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="comment">// tack on the 'm' memo type field first</span>
<a name="l00156"></a>00156 BuildField(data, offset, MEMFC_MEMO_TYPE, <span class="charliteral">'m'</span>);
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="comment">// Categories</span>
<a name="l00159"></a>00159 <span class="keywordflow">if</span>( Categories.size() ) {
<a name="l00160"></a>00160 <span class="keywordtype">string</span> store;
<a name="l00161"></a>00161 Categories.<a class="code" href="classBarry_1_1CategoryList.html#ac0ba2e29841783f5dbdaccf41c549be6" title="Turns the current vectory into a comma delimited category string suitable for use...">CategoryList2Str</a>(store);
<a name="l00162"></a>00162 BuildField(data, offset, MEMFC_CATEGORY, ic ? ic->ToBB(store) : store);
<a name="l00163"></a>00163 }
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="comment">// cycle through the type table</span>
<a name="l00166"></a>00166 <span class="keywordflow">for</span>( <a class="code" href="structBarry_1_1FieldLink.html">FieldLink<Memo></a> *b = MemoFieldLinks;
<a name="l00167"></a>00167 b->type != MEMFC_END;
<a name="l00168"></a>00168 b++ )
<a name="l00169"></a>00169 {
<a name="l00170"></a>00170 <span class="comment">// print only fields with data</span>
<a name="l00171"></a>00171 <span class="keywordflow">if</span>( b->strMember ) {
<a name="l00172"></a>00172 <span class="keyword">const</span> std::string &field = this->*(b->strMember);
<a name="l00173"></a>00173 <span class="keywordflow">if</span>( field.size() ) {
<a name="l00174"></a>00174 std::string s = (b->iconvNeeded && ic) ? ic->ToBB(field) : field;
<a name="l00175"></a>00175 BuildField(data, offset, b->type, s);
<a name="l00176"></a>00176 }
<a name="l00177"></a>00177 }
<a name="l00178"></a>00178 <span class="keywordflow">else</span> <span class="keywordflow">if</span>( b->postMember && b->postField ) {
<a name="l00179"></a>00179 <span class="keyword">const</span> std::string &field = (this->*(b->postMember)).*(b->postField);
<a name="l00180"></a>00180 <span class="keywordflow">if</span>( field.size() ) {
<a name="l00181"></a>00181 std::string s = (b->iconvNeeded && ic) ? ic->ToBB(field) : field;
<a name="l00182"></a>00182 BuildField(data, offset, b->type, s);
<a name="l00183"></a>00183 }
<a name="l00184"></a>00184 }
<a name="l00185"></a>00185 }
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="comment">// and finally save unknowns</span>
<a name="l00188"></a>00188 UnknownsType::const_iterator
<a name="l00189"></a>00189 ub = Unknowns.begin(), ue = Unknowns.end();
<a name="l00190"></a>00190 <span class="keywordflow">for</span>( ; ub != ue; ub++ ) {
<a name="l00191"></a>00191 BuildField(data, offset, *ub);
<a name="l00192"></a>00192 }
<a name="l00193"></a>00193
<a name="l00194"></a>00194 data.ReleaseBuffer(offset);
<a name="l00195"></a>00195 }
<a name="l00196"></a>00196
<a name="l00197"></a>00197
<a name="l00198"></a>00198
<a name="l00199"></a>00199 <span class="keywordtype">void</span> Memo::Dump(std::ostream &os)<span class="keyword"> const</span>
<a name="l00200"></a>00200 <span class="keyword"></span>{
<a name="l00201"></a>00201 os << <span class="stringliteral">"Memo entry: 0x"</span> << setbase(16) << RecordId
<a name="l00202"></a>00202 << <span class="stringliteral">" ("</span> << (<span class="keywordtype">unsigned</span> int)RecType << <span class="stringliteral">")\n"</span>;
<a name="l00203"></a>00203 os << <span class="stringliteral">" Title: "</span> << Title << <span class="stringliteral">"\n"</span>;
<a name="l00204"></a>00204 os << <span class="stringliteral">" Body: "</span>;
<a name="l00205"></a>00205
<a name="l00206"></a>00206 <span class="comment">// The Body may have '\r' characters... translate them</span>
<a name="l00207"></a>00207 <span class="comment">// in the output to make it look more pretty</span>
<a name="l00208"></a>00208 <span class="keywordflow">for</span>( string::const_iterator i = Body.begin(); i != Body.end(); ++i ) {
<a name="l00209"></a>00209 <span class="keywordflow">if</span>( *i == <span class="charliteral">'\r'</span> )
<a name="l00210"></a>00210 os << <span class="stringliteral">"\n "</span>;
<a name="l00211"></a>00211 <span class="keywordflow">else</span>
<a name="l00212"></a>00212 os << *i;
<a name="l00213"></a>00213 }
<a name="l00214"></a>00214 os << <span class="stringliteral">"\n"</span>;
<a name="l00215"></a>00215
<a name="l00216"></a>00216 <span class="keywordflow">if</span>( Categories.size() ) {
<a name="l00217"></a>00217 <span class="keywordtype">string</span> display;
<a name="l00218"></a>00218 Categories.CategoryList2Str(display);
<a name="l00219"></a>00219 os << <span class="stringliteral">" Categories: "</span> << display << <span class="stringliteral">"\n"</span>;
<a name="l00220"></a>00220 }
<a name="l00221"></a>00221
<a name="l00222"></a>00222 os << Unknowns;
<a name="l00223"></a>00223 os << <span class="stringliteral">"\n\n"</span>;
<a name="l00224"></a>00224 }
<a name="l00225"></a>00225
<a name="l00226"></a>00226 <span class="keywordtype">bool</span> Memo::operator<(<span class="keyword">const</span> Memo &other)<span class="keyword"> const</span>
<a name="l00227"></a>00227 <span class="keyword"></span>{
<a name="l00228"></a>00228 <span class="keywordtype">int</span> cmp = Title.compare(other.Title);
<a name="l00229"></a>00229 <span class="keywordflow">if</span>( cmp == 0 )
<a name="l00230"></a>00230 cmp = Body.compare(other.Body);
<a name="l00231"></a>00231 <span class="keywordflow">return</span> cmp < 0;
<a name="l00232"></a>00232 }
<a name="l00233"></a>00233
<a name="l00234"></a>00234 <span class="keywordtype">void</span> Memo::Clear()
<a name="l00235"></a>00235 {
<a name="l00236"></a>00236 Title.clear();
<a name="l00237"></a>00237 Body.clear();
<a name="l00238"></a>00238 Categories.clear();
<a name="l00239"></a>00239
<a name="l00240"></a>00240 Unknowns.clear();
<a name="l00241"></a>00241 }
<a name="l00242"></a>00242
<a name="l00243"></a>00243
<a name="l00244"></a>00244 } <span class="comment">// namespace Barry</span>
<a name="l00245"></a>00245
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
