<!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_contact.h 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_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>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file r_contact.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Blackberry database record parser class for contact records.</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"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_RECORD_CONTACT_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_RECORD_CONTACT_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<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>
<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>
<a name="l00027"></a>00027 <span class="preprocessor">#include <iosfwd></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <vector></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <map></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <stdint.h></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">namespace </span>Barry {
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">// forward declarations</span>
<a name="l00036"></a>00036 <span class="keyword">class </span>IConverter;
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="comment">//</span>
<a name="l00039"></a>00039 <span class="comment">// NOTE: All classes here must be container-safe! Perhaps add sorting</span>
<a name="l00040"></a>00040 <span class="comment">// operators in the future.</span>
<a name="l00041"></a>00041 <span class="comment">//</span>
<a name="l00042"></a>00042
<a name="l00043"></a><a class="code" href="structBarry_1_1ContactGroupLink.html">00043</a> <span class="keyword">struct </span>BXEXPORT <a class="code" href="structBarry_1_1ContactGroupLink.html">ContactGroupLink</a>
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 uint32_t Link;
<a name="l00046"></a>00046 uint16_t Unknown;
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <a class="code" href="structBarry_1_1ContactGroupLink.html">ContactGroupLink</a>() : Link(0), Unknown(0) {}
<a name="l00049"></a>00049 <a class="code" href="structBarry_1_1ContactGroupLink.html">ContactGroupLink</a>(uint32_t link, uint16_t unknown)
<a name="l00050"></a>00050 : Link(link), Unknown(unknown)
<a name="l00051"></a>00051 {}
<a name="l00052"></a>00052 };
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment">/// \addtogroup RecordParserClasses</span>
<a name="l00055"></a>00055 <span class="comment">/// @{</span>
<a name="l00056"></a>00056 <span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment">//</span>
<a name="l00058"></a>00058 <span class="comment">// Contact record class</span>
<a name="l00059"></a>00059 <span class="comment">//</span><span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment">/// Represents a single record in the Address Book Blackberry database.</span>
<a name="l00061"></a>00061 <span class="comment">///</span>
<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>
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064 <span class="keyword">public</span>:
<a name="l00065"></a>00065 <span class="keyword">typedef</span> <a class="code" href="classBarry_1_1CategoryList.html">Barry::CategoryList</a> <a class="code" href="classBarry_1_1CategoryList.html">CategoryList</a>;
<a name="l00066"></a>00066 <span class="keyword">typedef</span> <a class="code" href="structBarry_1_1ContactGroupLink.html">ContactGroupLink</a> <a class="code" href="structBarry_1_1ContactGroupLink.html">GroupLink</a>;
<a name="l00067"></a>00067 <span class="keyword">typedef</span> std::vector<GroupLink> GroupLinksType;
<a name="l00068"></a>00068 <span class="keyword">typedef</span> std::vector<UnknownField> UnknownsType;
<a name="l00069"></a>00069 <span class="keyword">typedef</span> std::string EmailType;
<a name="l00070"></a>00070 <span class="keyword">typedef</span> std::vector<EmailType> EmailList;
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="comment">//</span>
<a name="l00073"></a>00073 <span class="comment">// Record fields</span>
<a name="l00074"></a>00074 <span class="comment">//</span>
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="comment">// contact specific data</span>
<a name="l00077"></a>00077 uint8_t RecType;
<a name="l00078"></a>00078 uint32_t RecordId;
<a name="l00079"></a>00079 EmailList EmailAddresses;
<a name="l00080"></a>00080 <span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment"> /// This field, Phone, is deprecated. It is possible</span>
<a name="l00082"></a>00082 <span class="comment"> /// to write to this field to the Blackberry,</span>
<a name="l00083"></a>00083 <span class="comment"> /// but modern devices won't let you add it</span>
<a name="l00084"></a>00084 <span class="comment"> /// through their GUIs. This field only seems</span>
<a name="l00085"></a>00085 <span class="comment"> /// to exist on the 7750. While other devices</span>
<a name="l00086"></a>00086 <span class="comment"> /// accept the field and display it, it is</span>
<a name="l00087"></a>00087 <span class="comment"> /// not accessible by default.</span>
<a name="l00088"></a><a class="code" href="classBarry_1_1Contact.html#a8dc3a41ab1daa9f744c20c20708e2833">00088</a> <span class="comment"></span> std::string Phone;
<a name="l00089"></a>00089
<a name="l00090"></a>00090 std::string
<a name="l00091"></a>00091 Fax,
<a name="l00092"></a>00092 WorkPhone,
<a name="l00093"></a>00093 HomePhone,
<a name="l00094"></a>00094 MobilePhone,
<a name="l00095"></a>00095 Pager,
<a name="l00096"></a>00096 PIN,
<a name="l00097"></a>00097 Radio,
<a name="l00098"></a>00098 WorkPhone2,
<a name="l00099"></a>00099 HomePhone2,
<a name="l00100"></a>00100 OtherPhone,
<a name="l00101"></a>00101 FirstName,
<a name="l00102"></a>00102 LastName,
<a name="l00103"></a>00103 Company,
<a name="l00104"></a>00104 DefaultCommunicationsMethod,
<a name="l00105"></a>00105 JobTitle,
<a name="l00106"></a>00106 PublicKey,
<a name="l00107"></a>00107 URL,
<a name="l00108"></a>00108 Prefix,
<a name="l00109"></a>00109 Notes,
<a name="l00110"></a>00110 UserDefined1,
<a name="l00111"></a>00111 UserDefined2,
<a name="l00112"></a>00112 UserDefined3,
<a name="l00113"></a>00113 UserDefined4,
<a name="l00114"></a>00114 Image;
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <a class="code" href="structBarry_1_1Date.html">Date</a> Birthday;
<a name="l00117"></a>00117 <a class="code" href="structBarry_1_1Date.html">Date</a> Anniversary;
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <a class="code" href="structBarry_1_1PostalAddress.html">PostalAddress</a> WorkAddress;
<a name="l00120"></a>00120 <a class="code" href="structBarry_1_1PostalAddress.html">PostalAddress</a> HomeAddress;
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="comment">// Categories are not allowed to have commas in them.</span>
<a name="l00123"></a>00123 <span class="comment">// A category name containing a comma will be split into</span>
<a name="l00124"></a>00124 <span class="comment">// two categories, not only by this library, but by the</span>
<a name="l00125"></a>00125 <span class="comment">// device itself.</span>
<a name="l00126"></a>00126 <a class="code" href="classBarry_1_1CategoryList.html">CategoryList</a> Categories;
<a name="l00127"></a>00127
<a name="l00128"></a>00128 GroupLinksType GroupLinks;
<a name="l00129"></a>00129 UnknownsType Unknowns;
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keyword">private</span>:
<a name="l00132"></a>00132 <span class="keywordtype">bool</span> m_FirstNameSeen;
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="keyword">public</span>:
<a name="l00135"></a>00135 <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,
<a name="l00136"></a>00136 <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);
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="keyword">public</span>:
<a name="l00139"></a>00139 <a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Contact</a>();
<a name="l00140"></a>00140 ~<a class="code" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Contact</a>();
<a name="l00141"></a>00141
<a name="l00142"></a>00142 uint32_t GetID()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> RecordId; }
<a name="l00143"></a>00143 std::string GetFullName() <span class="keyword">const</span>;
<a name="l00144"></a>00144 <span class="keyword">const</span> std::string& GetEmail(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index = 0) <span class="keyword">const</span>;
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="comment">// Parser / Builder API (see parser.h / builder.h)</span>
<a name="l00147"></a>00147 uint8_t GetRecType()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> RecType; }
<a name="l00148"></a>00148 uint32_t GetUniqueId()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> RecordId; }
<a name="l00149"></a>00149 <span class="keywordtype">void</span> SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
<a name="l00150"></a>00150 <span class="keywordtype">void</span> ParseHeader(<span class="keyword">const</span> Data &data, <span class="keywordtype">size_t</span> &offset);
<a name="l00151"></a>00151 <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);
<a name="l00152"></a>00152 <span class="keywordtype">void</span> BuildHeader(Data &data, <span class="keywordtype">size_t</span> &offset) <span class="keyword">const</span>;
<a name="l00153"></a>00153 <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>;
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="keywordtype">void</span> Clear(); <span class="comment">// erase everything</span>
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="keywordtype">void</span> Dump(std::ostream &os) <span class="keyword">const</span>;
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="comment">// Sorting - use enough data to make the sorting as</span>
<a name="l00160"></a>00160 <span class="comment">// consistent as possible</span>
<a name="l00161"></a>00161 <span class="keywordtype">bool</span> operator<(<span class="keyword">const</span> Contact &other) <span class="keyword">const</span>;
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="comment">// database name</span>
<a name="l00164"></a>00164 <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>; }
<a name="l00165"></a>00165 <span class="keyword">static</span> uint8_t GetDefaultRecType() { <span class="keywordflow">return</span> 0; }
<a name="l00166"></a>00166
<a name="l00167"></a>00167 <span class="comment">// helpers</span>
<a name="l00168"></a>00168 <span class="keyword">static</span> <span class="keywordtype">void</span> SplitName(<span class="keyword">const</span> std::string &full, std::string &first, std::string &last);
<a name="l00169"></a>00169 };
<a name="l00170"></a>00170
<a name="l00171"></a>00171 BXEXPORT <span class="keyword">inline</span> std::ostream& operator<< (std::ostream &os, <span class="keyword">const</span> Contact &contact) {
<a name="l00172"></a>00172 contact.Dump(os);
<a name="l00173"></a>00173 <span class="keywordflow">return</span> os;
<a name="l00174"></a>00174 }
<a name="l00175"></a>00175 <span class="comment"></span>
<a name="l00176"></a>00176 <span class="comment">/// @}</span>
<a name="l00177"></a>00177 <span class="comment"></span>
<a name="l00178"></a>00178 } <span class="comment">// namespace Barry</span>
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="preprocessor">#endif</span>
<a name="l00181"></a>00181 <span class="preprocessor"></span>
</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>
