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.h Source File
</title>
4 <link href=
"doxygen.css" rel=
"stylesheet" type=
"text/css">
5 <link href=
"tabs.css" rel=
"stylesheet" type=
"text/css">
7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class=
"navigation" id=
"top">
11 <li><a href=
"index.html"><span>Main
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>
19 <div class=
"navpath"><a class=
"el" href=
"dir_edc0f428e3eefcfdce9c25befd901c57.html">src
</a>
22 <div class=
"contents">
23 <h1>r_memo.h
</h1><a href=
"r__memo_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 r_memo.h
</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-
2011, 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">#ifndef __BARRY_RECORD_MEMO_H__
</span>
46 <a name=
"l00024"></a>00024 <span class=
"preprocessor"></span><span class=
"preprocessor">#define __BARRY_RECORD_MEMO_H__
</span>
47 <a name=
"l00025"></a>00025 <span class=
"preprocessor"></span>
48 <a name=
"l00026"></a>00026 <span class=
"preprocessor">#include
"<a class="code
" href="dll_8h.html
" title="Macros for handling DLL/library API visibility.
">dll.h</a>"</span>
49 <a name=
"l00027"></a>00027 <span class=
"preprocessor">#include
"<a class="code
" href="record_8h.html
" title="Blackberry database record classes.
">record.h</a>"</span>
50 <a name=
"l00028"></a>00028 <span class=
"preprocessor">#include
<vector
></span>
51 <a name=
"l00029"></a>00029 <span class=
"preprocessor">#include
<string
></span>
52 <a name=
"l00030"></a>00030 <span class=
"preprocessor">#include
<stdint.h
></span>
53 <a name=
"l00031"></a>00031
54 <a name=
"l00032"></a>00032 <span class=
"keyword">namespace
</span>Barry {
55 <a name=
"l00033"></a>00033
56 <a name=
"l00034"></a>00034 <span class=
"comment">// forward declarations
</span>
57 <a name=
"l00035"></a>00035 <span class=
"keyword">class
</span>IConverter;
58 <a name=
"l00036"></a>00036
59 <a name=
"l00037"></a>00037 <span class=
"keyword">class
</span>BXEXPORT Memo
60 <a name=
"l00038"></a>00038 {
61 <a name=
"l00039"></a>00039 <span class=
"keyword">public
</span>:
62 <a name=
"l00040"></a>00040 <span class=
"keyword">typedef
</span> Barry::UnknownsType UnknownsType;
63 <a name=
"l00041"></a>00041
64 <a name=
"l00042"></a>00042 uint8_t RecType;
65 <a name=
"l00043"></a>00043 uint32_t RecordId;
66 <a name=
"l00044"></a>00044
67 <a name=
"l00045"></a>00045 std::string Title;
68 <a name=
"l00046"></a>00046 std::string Body;
69 <a name=
"l00047"></a>00047 CategoryList Categories;
70 <a name=
"l00048"></a>00048
71 <a name=
"l00049"></a>00049 UnknownsType Unknowns;
72 <a name=
"l00050"></a>00050
73 <a name=
"l00051"></a>00051 <span class=
"keyword">public
</span>:
74 <a name=
"l00052"></a>00052 <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,
75 <a name=
"l00053"></a>00053 <span class=
"keyword">const
</span> <span class=
"keywordtype">unsigned
</span> <span class=
"keywordtype">char
</span> *end,
<span class=
"keyword">const
</span> IConverter *ic =
0);
76 <a name=
"l00054"></a>00054
77 <a name=
"l00055"></a>00055 <span class=
"keyword">public
</span>:
78 <a name=
"l00056"></a>00056 Memo();
79 <a name=
"l00057"></a>00057 ~Memo();
80 <a name=
"l00058"></a>00058
81 <a name=
"l00059"></a>00059 <span class=
"comment">// Parser / Builder API (see parser.h / builder.h)
</span>
82 <a name=
"l00060"></a>00060 uint8_t GetRecType()
<span class=
"keyword"> const
</span>{
<span class=
"keywordflow">return
</span> RecType; }
83 <a name=
"l00061"></a>00061 uint32_t GetUniqueId()
<span class=
"keyword"> const
</span>{
<span class=
"keywordflow">return
</span> RecordId; }
84 <a name=
"l00062"></a>00062 <span class=
"keywordtype">void
</span> SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
85 <a name=
"l00063"></a>00063 <span class=
"keywordtype">void
</span> ParseHeader(
<span class=
"keyword">const
</span> Data
&data,
<span class=
"keywordtype">size_t
</span> &offset);
86 <a name=
"l00064"></a>00064 <span class=
"keywordtype">void
</span> ParseFields(
<span class=
"keyword">const
</span> Data
&data,
<span class=
"keywordtype">size_t
</span> &offset,
<span class=
"keyword">const
</span> IConverter *ic =
0);
87 <a name=
"l00065"></a>00065 <span class=
"keywordtype">void
</span> BuildHeader(Data
&data,
<span class=
"keywordtype">size_t
</span> &offset)
<span class=
"keyword">const
</span>;
88 <a name=
"l00066"></a>00066 <span class=
"keywordtype">void
</span> BuildFields(Data
&data,
<span class=
"keywordtype">size_t
</span> &offset,
<span class=
"keyword">const
</span> IConverter *ic =
0)
<span class=
"keyword">const
</span>;
89 <a name=
"l00067"></a>00067
90 <a name=
"l00068"></a>00068 <span class=
"comment">// operations (common among record classes)
</span>
91 <a name=
"l00069"></a>00069 <span class=
"keywordtype">void
</span> Clear();
92 <a name=
"l00070"></a>00070 <span class=
"keywordtype">void
</span> Dump(std::ostream
&os)
<span class=
"keyword">const
</span>;
93 <a name=
"l00071"></a>00071 std::string GetDescription()
<span class=
"keyword">const
</span>;
94 <a name=
"l00072"></a>00072
95 <a name=
"l00073"></a>00073 <span class=
"keywordtype">bool
</span> operator
<(
<span class=
"keyword">const
</span> Memo
&other)
<span class=
"keyword">const
</span>;
96 <a name=
"l00074"></a>00074
97 <a name=
"l00075"></a>00075 <span class=
"comment">// database name
</span>
98 <a name=
"l00076"></a>00076 <span class=
"keyword">static
</span> <span class=
"keyword">const
</span> <span class=
"keywordtype">char
</span> * GetDBName() {
<span class=
"keywordflow">return
</span> <span class=
"stringliteral">"Memos"</span>; }
99 <a name=
"l00077"></a>00077 <span class=
"keyword">static
</span> uint8_t GetDefaultRecType() {
<span class=
"keywordflow">return
</span> 0; }
<span class=
"comment">// or
0?
</span>
100 <a name=
"l00078"></a>00078 };
101 <a name=
"l00079"></a>00079
102 <a name=
"l00080"></a>00080 BXEXPORT
<span class=
"keyword">inline
</span> std::ostream
& operator
<<(std::ostream
&os,
<span class=
"keyword">const
</span> Memo
&msg) {
103 <a name=
"l00081"></a>00081 msg.Dump(os);
104 <a name=
"l00082"></a>00082 <span class=
"keywordflow">return
</span> os;
105 <a name=
"l00083"></a>00083 }
106 <a name=
"l00084"></a>00084
107 <a name=
"l00085"></a>00085 }
<span class=
"comment">// namespace Barry
</span>
108 <a name=
"l00086"></a>00086
109 <a name=
"l00087"></a>00087 <span class=
"preprocessor">#endif
</span>
110 <a name=
"l00088"></a>00088 <span class=
"preprocessor"></span>
112 <hr size=
"1"><address style=
"text-align: right;"><small>Generated on Thu Feb
10 16:
13:
59 2011 for Barry by
113 <a href=
"http://www.doxygen.org/index.html">
114 <img src=
"doxygen.png" alt=
"doxygen" align=
"middle" border=
"0"></a> 1.5.6 </small></address>