<!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: record-internal.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>record-internal.h</h1><a href="record-internal_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 record-internal.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Support functions, types, and templates for the</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">/// general record parsing classes in r_*.h files.</span>
<a name="l00005"></a>00005 <span class="comment"></span><span class="comment">/// This header is NOT installed for applications to</span>
<a name="l00006"></a>00006 <span class="comment"></span><span class="comment">/// use, so it is safe to put library-specific things</span>
<a name="l00007"></a>00007 <span class="comment"></span><span class="comment">/// in here.</span>
<a name="l00008"></a>00008 <span class="comment"></span><span class="comment">///</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">/*</span>
<a name="l00011"></a>00011 <span class="comment"> Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00014"></a>00014 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00015"></a>00015 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00016"></a>00016 <span class="comment"> (at your option) any later version.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00019"></a>00019 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00020"></a>00020 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00021"></a>00021 <span class="comment"></span>
<a name="l00022"></a>00022 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00023"></a>00023 <span class="comment"> root directory of this project for more details.</span>
<a name="l00024"></a>00024 <span class="comment">*/</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#ifndef __BARRY_RECORD_INTERNAL_H__</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_RECORD_INTERNAL_H__</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <string></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="protostructs_8h.html" title="USB Blackberry bulk protocol API.">protostructs.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="error_8h.html" title="Common exception classes for the Barry library.">error.h</a>"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="endian_8h.html" title="Endian conversion macros.">endian.h</a>"</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="record_8h.html" title="Blackberry database record classes.">record.h</a>"</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">// forward declarations</span>
<a name="l00036"></a>00036 <span class="keyword">namespace </span>Barry {
<a name="l00037"></a>00037 <span class="keyword">class </span>Data;
<a name="l00038"></a>00038 <span class="keyword">class </span>IConverter;
<a name="l00039"></a>00039 }
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keyword">namespace </span>Barry {
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="keyword">template</span> <<span class="keyword">class</span> RecordT>
<a name="l00044"></a>00044 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* ParseCommonFields(RecordT &rec,
<a name="l00045"></a>00045 <span class="keyword">const</span> <span class="keywordtype">void</span> *begin,
<a name="l00046"></a>00046 <span class="keyword">const</span> <span class="keywordtype">void</span> *end,
<a name="l00047"></a>00047 <span class="keyword">const</span> IConverter *ic = 0)
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *b = (<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>*) begin;
<a name="l00050"></a>00050 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *e = (<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>*) end;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keywordflow">while</span>( (b + COMMON_FIELD_HEADER_SIZE) < e )
<a name="l00053"></a>00053 b = rec.ParseField(b, e, ic);
<a name="l00054"></a>00054 <span class="keywordflow">return</span> b;
<a name="l00055"></a>00055 }
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment">// Use templates here to guarantee types are converted in the strictest manner.</span>
<a name="l00058"></a>00058 <span class="keyword">template</span> <<span class="keyword">class</span> SizeT>
<a name="l00059"></a>00059 <span class="keyword">inline</span> SizeT ConvertHtoB(SizeT s)
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061 <span class="keywordflow">throw</span> Error(<span class="stringliteral">"Not implemented."</span>);
<a name="l00062"></a>00062 }
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="comment">// specializations for specific sizes</span>
<a name="l00065"></a>00065 <span class="keyword">template</span> <> <span class="keyword">inline</span> uint8_t ConvertHtoB<uint8_t>(uint8_t s) { <span class="keywordflow">return</span> s; }
<a name="l00066"></a>00066 <span class="keyword">template</span> <> <span class="keyword">inline</span> uint16_t ConvertHtoB<uint16_t>(uint16_t s) { <span class="keywordflow">return</span> htobs(s); }
<a name="l00067"></a>00067 <span class="keyword">template</span> <> <span class="keyword">inline</span> uint32_t ConvertHtoB<uint32_t>(uint32_t s) { <span class="keywordflow">return</span> htobl(s); }
<a name="l00068"></a>00068 <span class="keyword">template</span> <> <span class="keyword">inline</span> uint64_t ConvertHtoB<uint64_t>(uint64_t s) { <span class="keywordflow">return</span> htobll(s); }
<a name="l00069"></a>00069
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keyword">template</span> <<span class="keyword">class</span> RecordT>
<a name="l00072"></a><a class="code" href="structBarry_1_1FieldLink.html">00072</a> <span class="keyword">struct </span><a class="code" href="structBarry_1_1FieldLink.html">FieldLink</a>
<a name="l00073"></a>00073 {
<a name="l00074"></a>00074 <span class="keywordtype">int</span> type;
<a name="l00075"></a>00075 <span class="keyword">const</span> <span class="keywordtype">char</span> *name;
<a name="l00076"></a>00076 <span class="keyword">const</span> <span class="keywordtype">char</span> *ldif;
<a name="l00077"></a>00077 <span class="keyword">const</span> <span class="keywordtype">char</span> *objectClass;
<a name="l00078"></a>00078 std::string RecordT::* strMember; <span class="comment">// FIXME - find a more general</span>
<a name="l00079"></a>00079 EmailAddressList RecordT::* addrMember; <span class="comment">// way to do this...</span>
<a name="l00080"></a>00080 time_t RecordT::* timeMember;
<a name="l00081"></a>00081 <a class="code" href="structBarry_1_1PostalAddress.html">PostalAddress</a> RecordT::* postMember;
<a name="l00082"></a>00082 std::string <a class="code" href="structBarry_1_1PostalAddress.html">PostalAddress</a>::* postField;
<a name="l00083"></a>00083 <span class="keywordtype">bool</span> iconvNeeded;
<a name="l00084"></a>00084 };
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="keywordtype">void</span> BuildField1900(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &size, uint8_t type, time_t t);
<a name="l00087"></a>00087 <span class="keywordtype">void</span> BuildField(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &size, uint8_t type, <span class="keywordtype">char</span> c);
<a name="l00088"></a>00088 <span class="keywordtype">void</span> BuildField(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &size, uint8_t type, uint8_t c);
<a name="l00089"></a>00089 <span class="keywordtype">void</span> BuildField(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &size, uint8_t type, uint16_t value);
<a name="l00090"></a>00090 <span class="keywordtype">void</span> BuildField(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &size, uint8_t type, uint32_t value);
<a name="l00091"></a>00091 <span class="keywordtype">void</span> BuildField(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &size, uint8_t type, uint64_t value);
<a name="l00092"></a>00092 <span class="keywordtype">void</span> BuildField(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &size, uint8_t type, <span class="keyword">const</span> std::string &str);
<a name="l00093"></a>00093 <span class="keywordtype">void</span> BuildField(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &size, uint8_t type, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> bufsize);
<a name="l00094"></a>00094 <span class="keywordtype">void</span> BuildField(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &size, <span class="keyword">const</span> <a class="code" href="structBarry_1_1UnknownField.html">Barry::UnknownField</a> &field);
<a name="l00095"></a>00095 <span class="keywordtype">void</span> BuildField(<a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &size, uint8_t type, <span class="keyword">const</span> <a class="code" href="structBarry_1_1Protocol_1_1GroupLink.html">Barry::Protocol::GroupLink</a> &link);
<a name="l00096"></a>00096 std::string ParseFieldString(<span class="keyword">const</span> <a class="code" href="structBarry_1_1Protocol_1_1CommonField.html">Barry::Protocol::CommonField</a> *field);
<a name="l00097"></a>00097 std::string ParseFieldString(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, uint16_t maxlen);
<a name="l00098"></a>00098
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="comment">// Functions to help build JDWP command packets</span>
<a name="l00101"></a>00101 <span class="keywordtype">void</span> AddJDWByte(<a class="code" href="classBarry_1_1Data.html">Barry::Data</a> &data, <span class="keywordtype">size_t</span> &size, <span class="keyword">const</span> uint8_t value);
<a name="l00102"></a>00102 <span class="keywordtype">void</span> AddJDWInt(<a class="code" href="classBarry_1_1Data.html">Barry::Data</a> &data, <span class="keywordtype">size_t</span> &size, <span class="keyword">const</span> uint32_t value);
<a name="l00103"></a>00103 <span class="keywordtype">void</span> AddJDWChar(<a class="code" href="classBarry_1_1Data.html">Barry::Data</a> &data, <span class="keywordtype">size_t</span> &size, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> bufsize);
<a name="l00104"></a>00104 <span class="keywordtype">void</span> AddJDWString(<a class="code" href="classBarry_1_1Data.html">Barry::Data</a> &data, <span class="keywordtype">size_t</span> &size, <span class="keyword">const</span> std::string &str);
<a name="l00105"></a>00105
<a name="l00106"></a>00106 } <span class="comment">// namespace Barry</span>
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="preprocessor">#endif</span>
<a name="l00109"></a>00109 <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>
