<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Barry: data.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<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="classes.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="navpath"><a class="el" href="dir_3e14c0bb4416cf979afc3165665fc916.html">src</a>
</div>
</div>
<div class="contents">
<h1>data.h</h1><a href="data_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 data.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Class to deal with pre-saved data files</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-2011, 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 __SB_DATA_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __SB_DATA_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 <iosfwd></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <vector></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <stdint.h></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="keyword">namespace </span>Barry {
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">class </span>BXEXPORT Data
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *m_data;
<a name="l00036"></a>00036 <span class="keywordtype">size_t</span> m_bufsize; <span class="comment">//< size of m_data buffer allocated</span>
<a name="l00037"></a>00037 <span class="keywordtype">size_t</span> m_datasize; <span class="comment">//< number of bytes of actual data</span>
<a name="l00038"></a>00038 <span class="keywordtype">int</span> m_endpoint;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">// copy on write feature</span>
<a name="l00041"></a>00041 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *m_externalData;
<a name="l00042"></a>00042 <span class="keywordtype">bool</span> m_external;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">// output format flags</span>
<a name="l00045"></a>00045 <span class="keyword">static</span> <span class="keywordtype">bool</span> bPrintAscii;
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">protected</span>:
<a name="l00048"></a>00048 <span class="keywordtype">void</span> MakeSpace(<span class="keywordtype">size_t</span> desiredsize);
<a name="l00049"></a>00049 <span class="keywordtype">void</span> CopyOnWrite(<span class="keywordtype">size_t</span> desiredsize);
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">public</span>:
<a name="l00052"></a>00052 Data();
<a name="l00053"></a>00053 <span class="keyword">explicit</span> Data(<span class="keywordtype">int</span> endpoint, <span class="keywordtype">size_t</span> startsize = 0x4000);
<a name="l00054"></a>00054 Data(<span class="keyword">const</span> <span class="keywordtype">void</span> *ValidData, <span class="keywordtype">size_t</span> size);
<a name="l00055"></a>00055 Data(<span class="keyword">const</span> Data &other);
<a name="l00056"></a>00056 ~Data();
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="keywordtype">void</span> InputHexLine(std::istream &is);
<a name="l00059"></a>00059 <span class="keywordtype">void</span> DumpHexLine(std::ostream &os, <span class="keywordtype">size_t</span> index, <span class="keywordtype">size_t</span> size) <span class="keyword">const</span>;
<a name="l00060"></a>00060 <span class="keywordtype">void</span> DumpHex(std::ostream &os) <span class="keyword">const</span>;
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keywordtype">int</span> GetEndpoint()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_endpoint; }
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * GetData()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_external ? m_externalData : m_data; }
<a name="l00065"></a>00065 <span class="keywordtype">size_t</span> GetSize()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_datasize; }
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * GetBuffer(<span class="keywordtype">size_t</span> requiredsize = 0);
<a name="l00068"></a>00068 <span class="keywordtype">size_t</span> GetBufSize()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_bufsize; }
<a name="l00069"></a>00069 <span class="keywordtype">void</span> ReleaseBuffer(<span class="keywordtype">int</span> datasize = -1);
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keywordtype">void</span> AppendHexString(<span class="keyword">const</span> <span class="keywordtype">char</span> *str);
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment"> /// set buffer to 0 size, but don't bother overwriting memory with 0</span>
<a name="l00074"></a>00074 <span class="comment"></span> <span class="keywordtype">void</span> QuickZap() { m_datasize = 0; }
<a name="l00075"></a>00075 <span class="keywordtype">void</span> Zap(); <span class="comment">// does a memset too</span>
<a name="l00076"></a>00076
<a name="l00077"></a>00077 Data& operator=(<span class="keyword">const</span> Data &other);
<a name="l00078"></a>00078
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="comment">//</span>
<a name="l00081"></a>00081 <span class="comment">// Utility functions</span>
<a name="l00082"></a>00082 <span class="comment">//</span>
<a name="l00083"></a>00083 <span class="comment">// Writing data... basically does a memcpy(dst,src,sizeof(src))</span>
<a name="l00084"></a>00084 <span class="comment">// for each type. Does no endian conversions.</span>
<a name="l00085"></a>00085 <span class="comment">// dst is calculated as buffer + offset.</span>
<a name="l00086"></a>00086 <span class="comment">// The buffer is expanded automatically if needed.</span>
<a name="l00087"></a>00087 <span class="comment">// The offset is advanced by the size of the data.</span>
<a name="l00088"></a>00088 <span class="comment">//</span>
<a name="l00089"></a>00089 <span class="keywordtype">void</span> MemCpy(<span class="keywordtype">size_t</span> &offset, <span class="keyword">const</span> <span class="keywordtype">void</span> *src, <span class="keywordtype">size_t</span> size);
<a name="l00090"></a>00090 <span class="keywordtype">void</span> Append(<span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> size);
<a name="l00091"></a>00091 <span class="keyword">template</span> <<span class="keyword">class</span> ValueT>
<a name="l00092"></a>00092 <span class="keywordtype">void</span> SetValue(<span class="keywordtype">size_t</span> &offset, ValueT value)
<a name="l00093"></a>00093 {
<a name="l00094"></a>00094 this->MemCpy(offset, &value, <span class="keyword">sizeof</span>(value));
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="comment">// static functions</span>
<a name="l00099"></a>00099 <span class="keyword">static</span> <span class="keywordtype">void</span> PrintAscii(<span class="keywordtype">bool</span> setting) { bPrintAscii = setting; }
<a name="l00100"></a>00100 <span class="keyword">static</span> <span class="keywordtype">bool</span> PrintAscii() { <span class="keywordflow">return</span> bPrintAscii; }
<a name="l00101"></a>00101 };
<a name="l00102"></a>00102
<a name="l00103"></a>00103 BXEXPORT std::istream& operator>> (std::istream &is, Data &data);
<a name="l00104"></a>00104 BXEXPORT std::ostream& operator<< (std::ostream &os, <span class="keyword">const</span> Data &data);
<a name="l00105"></a>00105
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">class </span>BXEXPORT Diff
<a name="l00108"></a>00108 {
<a name="l00109"></a>00109 <span class="keyword">const</span> Data &m_old, &m_new;
<a name="l00110"></a>00110
<a name="l00111"></a>00111 BXLOCAL <span class="keywordtype">void</span> Compare(std::ostream &os, <span class="keywordtype">size_t</span> index, <span class="keywordtype">size_t</span> size) <span class="keyword">const</span>;
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keyword">public</span>:
<a name="l00114"></a>00114 Diff(<span class="keyword">const</span> Data &old, <span class="keyword">const</span> Data &new_);
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="keywordtype">void</span> Dump(std::ostream &os) <span class="keyword">const</span>;
<a name="l00117"></a>00117 };
<a name="l00118"></a>00118
<a name="l00119"></a>00119 BXEXPORT std::ostream& operator<< (std::ostream &os, <span class="keyword">const</span> Diff &diff);
<a name="l00120"></a>00120
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="comment">// utility functions</span>
<a name="l00123"></a>00123 BXEXPORT <span class="keywordtype">bool</span> LoadDataArray(<span class="keyword">const</span> std::string &filename, std::vector<Data> &array);
<a name="l00124"></a>00124 BXEXPORT <span class="keywordtype">bool</span> ReadDataArray(std::istream &is, std::vector<Data> &array);
<a name="l00125"></a>00125
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="comment">//</span>
<a name="l00128"></a>00128 <span class="comment">// DBData</span>
<a name="l00129"></a>00129 <span class="comment">//</span><span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment">/// Database record data class. The purpose of this class is to contain</span>
<a name="l00131"></a>00131 <span class="comment">/// the raw data that flows between low level activity such as device</span>
<a name="l00132"></a>00132 <span class="comment">/// read/writes, backup read/writes, and record parsing.</span>
<a name="l00133"></a>00133 <span class="comment">///</span>
<a name="l00134"></a>00134 <span class="comment">/// This class contains the low level record data block, unparsed, as well</span>
<a name="l00135"></a>00135 <span class="comment">/// as the surrounding meta data, such as the database name it belongs</span>
<a name="l00136"></a>00136 <span class="comment">/// to, the Unique ID, the Rec Type, and format version/type based on what</span>
<a name="l00137"></a>00137 <span class="comment">/// commands were used to extract the data from the device. (When using</span>
<a name="l00138"></a>00138 <span class="comment">/// newer commands, the format of the records, potentially including the</span>
<a name="l00139"></a>00139 <span class="comment">/// individual field type codes, are different.)</span>
<a name="l00140"></a>00140 <span class="comment">///</span>
<a name="l00141"></a>00141 <span class="comment">/// Possible bi-directional data flow in all of Barry:</span>
<a name="l00142"></a>00142 <span class="comment">/// Note that this class, DBData, represents the data+meta stage.</span>
<a name="l00143"></a>00143 <span class="comment">///</span>
<a name="l00144"></a>00144 <span class="comment">/// data+meta <-> device</span>
<a name="l00145"></a>00145 <span class="comment">/// data+meta <-> backup file</span>
<a name="l00146"></a>00146 <span class="comment">/// data+meta <-> record object</span>
<a name="l00147"></a>00147 <span class="comment">/// record object <-> boost serialization</span>
<a name="l00148"></a>00148 <span class="comment">/// contact record object <-> ldif</span>
<a name="l00149"></a>00149 <span class="comment">///</span>
<a name="l00150"></a>00150 <span class="comment">/// Possible uni-directional data flow in all of Barry:</span>
<a name="l00151"></a>00151 <span class="comment">///</span>
<a name="l00152"></a>00152 <span class="comment">/// record object -> text dump</span>
<a name="l00153"></a>00153 <span class="comment">///</span>
<a name="l00154"></a><a class="code" href="classBarry_1_1DBData.html">00154</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a>
<a name="l00155"></a>00155 {
<a name="l00156"></a>00156 <span class="keyword">public</span>:
<a name="l00157"></a>00157 <span class="keyword">enum</span> RecordFormatVersion
<a name="l00158"></a>00158 {
<a name="l00159"></a>00159 REC_VERSION_1,
<a name="l00160"></a>00160 REC_VERSION_2
<a name="l00161"></a>00161 };
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="keyword">private</span>:
<a name="l00164"></a>00164 <span class="comment">// record meta data</span>
<a name="l00165"></a>00165 RecordFormatVersion m_version;
<a name="l00166"></a>00166 std::string m_dbName;
<a name="l00167"></a>00167 uint8_t m_recType;
<a name="l00168"></a>00168 uint32_t m_uniqueId;
<a name="l00169"></a>00169 <span class="keywordtype">size_t</span> m_offset;
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="comment">// the raw data block, internal</span>
<a name="l00172"></a>00172 Data *m_localData;
<a name="l00173"></a>00173
<a name="l00174"></a>00174 <span class="comment">// the data block to use... could be external or internal,</span>
<a name="l00175"></a>00175 <span class="comment">// and does not change for the life of the object</span>
<a name="l00176"></a>00176 Data &m_data;
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00179"></a>00179 <span class="comment"> /// Default constructor, constructs an empty local Data object</span>
<a name="l00180"></a>00180 <span class="comment"></span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a>();
<a name="l00181"></a>00181 <span class="comment"></span>
<a name="l00182"></a>00182 <span class="comment"> /// Constructs a local Data object that points to external memory</span>
<a name="l00183"></a>00183 <span class="comment"></span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *ValidData, <span class="keywordtype">size_t</span> size);
<a name="l00184"></a>00184 <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a>(RecordFormatVersion ver, <span class="keyword">const</span> std::string &dbName,
<a name="l00185"></a>00185 uint8_t recType, uint32_t uniqueId, <span class="keywordtype">size_t</span> offset,
<a name="l00186"></a>00186 <span class="keyword">const</span> <span class="keywordtype">void</span> *ValidData, <span class="keywordtype">size_t</span> size);
<a name="l00187"></a>00187 <span class="comment"></span>
<a name="l00188"></a>00188 <span class="comment"> /// If copy == false, constructs an external Data object, no local.</span>
<a name="l00189"></a>00189 <span class="comment"> /// If copy == true, constructs an internal Data object copy</span>
<a name="l00190"></a>00190 <span class="comment"> /// For speed, set copy to false.</span>
<a name="l00191"></a>00191 <span class="comment"> /// If you want Copy On Write behaviour, similar to Data(buf,size),</span>
<a name="l00192"></a>00192 <span class="comment"> /// then use the above (buf, size) constructor, not this one,</span>
<a name="l00193"></a>00193 <span class="comment"> /// since this constructor uses Data's copy constructor.</span>
<a name="l00194"></a>00194 <span class="comment"></span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a>(Data &externalData, <span class="keywordtype">bool</span> copy);
<a name="l00195"></a>00195 <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a>(RecordFormatVersion ver, <span class="keyword">const</span> std::string &dbName,
<a name="l00196"></a>00196 uint8_t recType, uint32_t uniqueId, <span class="keywordtype">size_t</span> offset,
<a name="l00197"></a>00197 Data &externalData, <span class="keywordtype">bool</span> copy);
<a name="l00198"></a>00198
<a name="l00199"></a>00199 ~<a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a>();
<a name="l00200"></a>00200
<a name="l00201"></a>00201 <span class="comment">// access meta data</span>
<a name="l00202"></a>00202 RecordFormatVersion GetVersion()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_version; }
<a name="l00203"></a>00203 <span class="keyword">const</span> std::string& GetDBName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_dbName; }
<a name="l00204"></a>00204 uint8_t GetRecType()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_recType; }
<a name="l00205"></a>00205 uint32_t GetUniqueId()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_uniqueId; }
<a name="l00206"></a>00206 <span class="keywordtype">size_t</span> GetOffset()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_offset; }
<a name="l00207"></a>00207
<a name="l00208"></a>00208 <span class="keyword">const</span> Data& GetData()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_data; }
<a name="l00209"></a>00209 Data& UseData();
<a name="l00210"></a>00210
<a name="l00211"></a>00211 <span class="comment">// operations</span>
<a name="l00212"></a>00212 <span class="keywordtype">void</span> SetVersion(RecordFormatVersion ver)
<a name="l00213"></a>00213 {
<a name="l00214"></a>00214 m_version = ver;
<a name="l00215"></a>00215 }
<a name="l00216"></a>00216
<a name="l00217"></a>00217 <span class="keywordtype">void</span> SetDBName(<span class="keyword">const</span> std::string &dbName)
<a name="l00218"></a>00218 {
<a name="l00219"></a>00219 m_dbName = dbName;
<a name="l00220"></a>00220 }
<a name="l00221"></a>00221
<a name="l00222"></a>00222 <span class="keywordtype">void</span> SetIds(uint8_t recType, uint32_t uniqueId)
<a name="l00223"></a>00223 {
<a name="l00224"></a>00224 m_recType = recType;
<a name="l00225"></a>00225 m_uniqueId = uniqueId;
<a name="l00226"></a>00226 }
<a name="l00227"></a>00227
<a name="l00228"></a>00228 <span class="keywordtype">void</span> SetOffset(<span class="keywordtype">size_t</span> offset)
<a name="l00229"></a>00229 {
<a name="l00230"></a>00230 m_offset = offset;
<a name="l00231"></a>00231 }
<a name="l00232"></a>00232
<a name="l00233"></a>00233 <span class="keywordtype">void</span> CopyMeta(<span class="keyword">const</span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> &src)
<a name="l00234"></a>00234 {
<a name="l00235"></a>00235 m_version = src.<a class="code" href="classBarry_1_1DBData.html#71cded3e27d6a9dc00983fb6c9c81e4c">m_version</a>;
<a name="l00236"></a>00236 m_dbName = src.<a class="code" href="classBarry_1_1DBData.html#26af7c9fdeadbdbb466caf5f0d00f376">m_dbName</a>;
<a name="l00237"></a>00237 m_recType = src.<a class="code" href="classBarry_1_1DBData.html#4037f1dc786487f1d4dfdf81cef4481d">m_recType</a>;
<a name="l00238"></a>00238 m_uniqueId = src.<a class="code" href="classBarry_1_1DBData.html#51c8e7fb05cce50a8f5121f25d70cd3b">m_uniqueId</a>;
<a name="l00239"></a>00239 m_offset = src.<a class="code" href="classBarry_1_1DBData.html#073e10cd15898b83e609f1f0bdef59ef">m_offset</a>;
<a name="l00240"></a>00240 }
<a name="l00241"></a>00241
<a name="l00242"></a>00242 <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a>& operator=(<span class="keyword">const</span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> &other);
<a name="l00243"></a>00243 };
<a name="l00244"></a>00244
<a name="l00245"></a>00245 } <span class="comment">// namespace Barry</span>
<a name="l00246"></a>00246
<a name="l00247"></a>00247 <span class="preprocessor">#endif</span>
<a name="l00248"></a>00248 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:15 2011 for Barry by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
