doc/www/doxygen/html/r__contact_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: r_contact.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>r_contact.h</h1><a href="r__contact_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_contact.h</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             Blackberry database record parser class for contact records.</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"></span>
  31 <a name="l00009"></a>00009 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  32 <a name="l00010"></a>00010 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  33 <a name="l00011"></a>00011 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  34 <a name="l00012"></a>00012 <span class="comment">    (at your option) any later version.</span>
  35 <a name="l00013"></a>00013 <span class="comment"></span>
  36 <a name="l00014"></a>00014 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  37 <a name="l00015"></a>00015 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  38 <a name="l00016"></a>00016 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  39 <a name="l00017"></a>00017 <span class="comment"></span>
  40 <a name="l00018"></a>00018 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  41 <a name="l00019"></a>00019 <span class="comment">    root directory of this project for more details.</span>
  42 <a name="l00020"></a>00020 <span class="comment">*/</span>
  43 <a name="l00021"></a>00021
  44 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_RECORD_CONTACT_H__</span>
  45 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_RECORD_CONTACT_H__</span>
  46 <a name="l00024"></a>00024 <span class="preprocessor"></span>
  47 <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>
  48 <a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="record_8h.html" title="Blackberry database record classes.">record.h</a>"</span>
  49 <a name="l00027"></a>00027 <span class="preprocessor">#include &lt;iosfwd&gt;</span>
  50 <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;string&gt;</span>
  51 <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;vector&gt;</span>
  52 <a name="l00030"></a>00030 <span class="preprocessor">#include &lt;map&gt;</span>
  53 <a name="l00031"></a>00031 <span class="preprocessor">#include &lt;stdint.h&gt;</span>
  54 <a name="l00032"></a>00032
  55 <a name="l00033"></a>00033 <span class="keyword">namespace </span>Barry {
  56 <a name="l00034"></a>00034
  57 <a name="l00035"></a>00035 <span class="comment">// forward declarations</span>
  58 <a name="l00036"></a>00036 <span class="keyword">class </span>IConverter;
  59 <a name="l00037"></a>00037
  60 <a name="l00038"></a>00038 <span class="comment">//</span>
  61 <a name="l00039"></a>00039 <span class="comment">// NOTE:  All classes here must be container-safe!  Perhaps add sorting</span>
  62 <a name="l00040"></a>00040 <span class="comment">//        operators in the future.</span>
  63 <a name="l00041"></a>00041 <span class="comment">//</span>
  64 <a name="l00042"></a>00042
  65 <a name="l00043"></a>00043 <span class="keyword">struct </span>BXEXPORT ContactGroupLink
  66 <a name="l00044"></a>00044 {
  67 <a name="l00045"></a>00045         uint32_t Link;
  68 <a name="l00046"></a>00046         uint16_t Unknown;
  69 <a name="l00047"></a>00047
  70 <a name="l00048"></a>00048         ContactGroupLink() : Link(0), Unknown(0) {}
  71 <a name="l00049"></a>00049         ContactGroupLink(uint32_t link, uint16_t unknown)
  72 <a name="l00050"></a>00050                 : Link(link), Unknown(unknown)
  73 <a name="l00051"></a>00051         {}
  74 <a name="l00052"></a>00052 };
  75 <a name="l00053"></a>00053 <span class="comment"></span>
  76 <a name="l00054"></a>00054 <span class="comment">/// \addtogroup RecordParserClasses</span>
  77 <a name="l00055"></a>00055 <span class="comment">/// @{</span>
  78 <a name="l00056"></a>00056 <span class="comment"></span>
  79 <a name="l00057"></a>00057 <span class="comment">//</span>
  80 <a name="l00058"></a>00058 <span class="comment">// Contact record class</span>
  81 <a name="l00059"></a>00059 <span class="comment">//</span><span class="comment"></span>
  82 <a name="l00060"></a>00060 <span class="comment">/// Represents a single record in the Address Book Blackberry database.</span>
  83 <a name="l00061"></a>00061 <span class="comment">///</span>
  84 <a name="l00062"></a><a class="code" href="classBarry_1_1Contact.html">00062</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Contact</a>
  85 <a name="l00063"></a>00063 {
  86 <a name="l00064"></a>00064 <span class="keyword">public</span>:
  87 <a name="l00065"></a>00065         <span class="keyword">typedef</span> Barry::CategoryList                     CategoryList;
  88 <a name="l00066"></a>00066         <span class="keyword">typedef</span> ContactGroupLink                        GroupLink;
  89 <a name="l00067"></a>00067         <span class="keyword">typedef</span> std::vector&lt;GroupLink&gt;                  GroupLinksType;
  90 <a name="l00068"></a>00068         <span class="keyword">typedef</span> Barry::UnknownsType                     UnknownsType;
  91 <a name="l00069"></a>00069         <span class="keyword">typedef</span> std::string                             EmailType;
  92 <a name="l00070"></a>00070         <span class="keyword">typedef</span> std::vector&lt;EmailType&gt;                  EmailList;
  93 <a name="l00071"></a>00071
  94 <a name="l00072"></a>00072         <span class="comment">//</span>
  95 <a name="l00073"></a>00073         <span class="comment">// Record fields</span>
  96 <a name="l00074"></a>00074         <span class="comment">//</span>
  97 <a name="l00075"></a>00075
  98 <a name="l00076"></a>00076         <span class="comment">// contact specific data</span>
  99 <a name="l00077"></a>00077         uint8_t RecType;
 100 <a name="l00078"></a>00078         uint32_t RecordId;
 101 <a name="l00079"></a>00079         EmailList EmailAddresses;
 102 <a name="l00080"></a>00080 <span class="comment"></span>
 103 <a name="l00081"></a>00081 <span class="comment">        /// This field, Phone, is deprecated.  It is possible</span>
 104 <a name="l00082"></a>00082 <span class="comment">        /// to write to this field to the Blackberry,</span>
 105 <a name="l00083"></a>00083 <span class="comment">        /// but modern devices won't let you add it</span>
 106 <a name="l00084"></a>00084 <span class="comment">        /// through their GUIs.  This field only seems</span>
 107 <a name="l00085"></a>00085 <span class="comment">        /// to exist on the 7750.  While other devices</span>
 108 <a name="l00086"></a>00086 <span class="comment">        /// accept the field and display it, it is</span>
 109 <a name="l00087"></a>00087 <span class="comment">        /// not accessible by default.</span>
 110 <a name="l00088"></a><a class="code" href="classBarry_1_1Contact.html#8dc3a41ab1daa9f744c20c20708e2833">00088</a> <span class="comment"></span>        std::string Phone;
 111 <a name="l00089"></a>00089
 112 <a name="l00090"></a>00090         std::string
 113 <a name="l00091"></a>00091                 Fax,
 114 <a name="l00092"></a>00092                 HomeFax,
 115 <a name="l00093"></a>00093                 WorkPhone,
 116 <a name="l00094"></a>00094                 HomePhone,
 117 <a name="l00095"></a>00095                 MobilePhone,
 118 <a name="l00096"></a>00096                 MobilePhone2,
 119 <a name="l00097"></a>00097                 Pager,
 120 <a name="l00098"></a>00098                 PIN,
 121 <a name="l00099"></a>00099                 Radio,
 122 <a name="l00100"></a>00100                 WorkPhone2,
 123 <a name="l00101"></a>00101                 HomePhone2,
 124 <a name="l00102"></a>00102                 OtherPhone,
 125 <a name="l00103"></a>00103                 FirstName,
 126 <a name="l00104"></a>00104                 LastName,
 127 <a name="l00105"></a>00105                 Company,
 128 <a name="l00106"></a>00106                 DefaultCommunicationsMethod,
 129 <a name="l00107"></a>00107                 JobTitle,
 130 <a name="l00108"></a>00108                 PublicKey,
 131 <a name="l00109"></a>00109                 URL,
 132 <a name="l00110"></a>00110                 Prefix,
 133 <a name="l00111"></a>00111                 Notes,
 134 <a name="l00112"></a>00112                 UserDefined1,
 135 <a name="l00113"></a>00113                 UserDefined2,
 136 <a name="l00114"></a>00114                 UserDefined3,
 137 <a name="l00115"></a>00115                 UserDefined4,
 138 <a name="l00116"></a>00116                 Image,
 139 <a name="l00117"></a>00117                 Nickname;
 140 <a name="l00118"></a>00118
 141 <a name="l00119"></a>00119         Date Birthday;
 142 <a name="l00120"></a>00120         Date Anniversary;
 143 <a name="l00121"></a>00121
 144 <a name="l00122"></a>00122         PostalAddress WorkAddress;
 145 <a name="l00123"></a>00123         PostalAddress HomeAddress;
 146 <a name="l00124"></a>00124
 147 <a name="l00125"></a>00125         <span class="comment">// Categories are not allowed to have commas in them.</span>
 148 <a name="l00126"></a>00126         <span class="comment">// A category name containing a comma will be split into</span>
 149 <a name="l00127"></a>00127         <span class="comment">// two categories, not only by this library, but by the</span>
 150 <a name="l00128"></a>00128         <span class="comment">// device itself.</span>
 151 <a name="l00129"></a>00129         CategoryList Categories;
 152 <a name="l00130"></a>00130
 153 <a name="l00131"></a>00131         GroupLinksType GroupLinks;
 154 <a name="l00132"></a>00132         UnknownsType Unknowns;
 155 <a name="l00133"></a>00133
 156 <a name="l00134"></a>00134 <span class="keyword">private</span>:
 157 <a name="l00135"></a>00135         <span class="keywordtype">bool</span> m_FirstNameSeen;
 158 <a name="l00136"></a>00136
 159 <a name="l00137"></a>00137 <span class="keyword">public</span>:
 160 <a name="l00138"></a>00138         <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,
 161 <a name="l00139"></a>00139                 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end, <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);
 162 <a name="l00140"></a>00140
 163 <a name="l00141"></a>00141 <span class="keyword">public</span>:
 164 <a name="l00142"></a>00142         <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Contact</a>();
 165 <a name="l00143"></a>00143         ~<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Contact</a>();
 166 <a name="l00144"></a>00144
 167 <a name="l00145"></a>00145         uint32_t GetID()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> RecordId; }
 168 <a name="l00146"></a>00146         std::string GetFullName() <span class="keyword">const</span>;
 169 <a name="l00147"></a>00147         <span class="keyword">const</span> std::string&amp; GetEmail(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index = 0) <span class="keyword">const</span>;
 170 <a name="l00148"></a>00148
 171 <a name="l00149"></a>00149         <span class="comment">// Parser / Builder API (see parser.h / builder.h)</span>
 172 <a name="l00150"></a>00150         uint8_t GetRecType()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> RecType; }
 173 <a name="l00151"></a>00151         uint32_t GetUniqueId()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> RecordId; }
 174 <a name="l00152"></a>00152         <span class="keywordtype">void</span> SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
 175 <a name="l00153"></a>00153         <span class="keywordtype">void</span> ParseHeader(<span class="keyword">const</span> Data &amp;data, <span class="keywordtype">size_t</span> &amp;offset);
 176 <a name="l00154"></a>00154         <span class="keywordtype">void</span> ParseFields(<span class="keyword">const</span> Data &amp;data, <span class="keywordtype">size_t</span> &amp;offset, <span class="keyword">const</span> IConverter *ic = 0);
 177 <a name="l00155"></a>00155         <span class="keywordtype">void</span> BuildHeader(Data &amp;data, <span class="keywordtype">size_t</span> &amp;offset) <span class="keyword">const</span>;
 178 <a name="l00156"></a>00156         <span class="keywordtype">void</span> BuildFields(Data &amp;data, <span class="keywordtype">size_t</span> &amp;offset, <span class="keyword">const</span> IConverter *ic = 0) <span class="keyword">const</span>;
 179 <a name="l00157"></a>00157
 180 <a name="l00158"></a>00158         <span class="comment">// operations (common among record classes)</span>
 181 <a name="l00159"></a>00159         <span class="keywordtype">void</span> Clear();                   <span class="comment">// erase everything</span>
 182 <a name="l00160"></a>00160         <span class="keywordtype">void</span> Dump(std::ostream &amp;os) <span class="keyword">const</span>;
 183 <a name="l00161"></a>00161         std::string GetDescription() <span class="keyword">const</span>;
 184 <a name="l00162"></a>00162
 185 <a name="l00163"></a>00163         <span class="comment">// Sorting - use enough data to make the sorting as</span>
 186 <a name="l00164"></a>00164         <span class="comment">//           consistent as possible</span>
 187 <a name="l00165"></a>00165         <span class="keywordtype">bool</span> operator&lt;(<span class="keyword">const</span> Contact &amp;other) <span class="keyword">const</span>;
 188 <a name="l00166"></a>00166
 189 <a name="l00167"></a>00167         <span class="comment">// database name</span>
 190 <a name="l00168"></a>00168         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * GetDBName() { <span class="keywordflow">return</span> <span class="stringliteral">"Address Book"</span>; }
 191 <a name="l00169"></a>00169         <span class="keyword">static</span> uint8_t GetDefaultRecType() { <span class="keywordflow">return</span> 0; }
 192 <a name="l00170"></a>00170
 193 <a name="l00171"></a>00171         <span class="comment">// helpers</span>
 194 <a name="l00172"></a>00172         <span class="keyword">static</span> <span class="keywordtype">void</span> SplitName(<span class="keyword">const</span> std::string &amp;full, std::string &amp;first, std::string &amp;last);
 195 <a name="l00173"></a>00173 };
 196 <a name="l00174"></a>00174
 197 <a name="l00175"></a>00175 BXEXPORT <span class="keyword">inline</span> std::ostream&amp; operator&lt;&lt; (std::ostream &amp;os, <span class="keyword">const</span> Contact &amp;contact) {
 198 <a name="l00176"></a>00176         contact.Dump(os);
 199 <a name="l00177"></a>00177         <span class="keywordflow">return</span> os;
 200 <a name="l00178"></a>00178 }
 201 <a name="l00179"></a>00179 <span class="comment"></span>
 202 <a name="l00180"></a>00180 <span class="comment">/// @}</span>
 203 <a name="l00181"></a>00181 <span class="comment"></span>
 204 <a name="l00182"></a>00182 } <span class="comment">// namespace Barry</span>
 205 <a name="l00183"></a>00183
 206 <a name="l00184"></a>00184 <span class="preprocessor">#endif</span>
 207 <a name="l00185"></a>00185 <span class="preprocessor"></span>
 208 </pre></div></div>
 209 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:13:59 2011 for Barry by&nbsp;
 210 <a href="http://www.doxygen.org/index.html">
 211 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 212 </body>
 213 </html>