<!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: data.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>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-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 __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
<a name="l00029"></a>00029 <span class="keyword">namespace </span>Barry {
<a name="l00030"></a>00030
<a name="l00031"></a><a class="code" href="classBarry_1_1Data.html">00031</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Data.html">Data</a>
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *m_data;
<a name="l00034"></a>00034 <span class="keywordtype">size_t</span> m_bufsize; <span class="comment">//< size of m_data buffer allocated</span>
<a name="l00035"></a>00035 <span class="keywordtype">size_t</span> m_datasize; <span class="comment">//< number of bytes of actual data</span>
<a name="l00036"></a>00036 <span class="keywordtype">int</span> m_endpoint;
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="comment">// copy on write feature</span>
<a name="l00039"></a>00039 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *m_externalData;
<a name="l00040"></a>00040 <span class="keywordtype">bool</span> m_external;
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="comment">// output format flags</span>
<a name="l00043"></a>00043 <span class="keyword">static</span> <span class="keywordtype">bool</span> bPrintAscii;
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="keyword">protected</span>:
<a name="l00046"></a>00046 <span class="keywordtype">void</span> MakeSpace(<span class="keywordtype">size_t</span> desiredsize);
<a name="l00047"></a>00047 <span class="keywordtype">void</span> CopyOnWrite(<span class="keywordtype">size_t</span> desiredsize);
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050 <a class="code" href="classBarry_1_1Data.html">Data</a>();
<a name="l00051"></a>00051 <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1Data.html">Data</a>(<span class="keywordtype">int</span> endpoint, <span class="keywordtype">size_t</span> startsize = 0x4000);
<a name="l00052"></a>00052 <a class="code" href="classBarry_1_1Data.html">Data</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *ValidData, <span class="keywordtype">size_t</span> size);
<a name="l00053"></a>00053 <a class="code" href="classBarry_1_1Data.html">Data</a>(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &other);
<a name="l00054"></a>00054 ~<a class="code" href="classBarry_1_1Data.html">Data</a>();
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keywordtype">void</span> InputHexLine(std::istream &is);
<a name="l00057"></a>00057 <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="l00058"></a>00058 <span class="keywordtype">void</span> DumpHex(std::ostream &os) <span class="keyword">const</span>;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keywordtype">int</span> GetEndpoint()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_endpoint; }
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <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="l00063"></a>00063 <span class="keywordtype">size_t</span> GetSize()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_datasize; }
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * GetBuffer(<span class="keywordtype">size_t</span> requiredsize = 0);
<a name="l00066"></a>00066 <span class="keywordtype">size_t</span> GetBufSize()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_bufsize; }
<a name="l00067"></a>00067 <span class="keywordtype">void</span> ReleaseBuffer(<span class="keywordtype">int</span> datasize = -1);
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keywordtype">void</span> AppendHexString(<span class="keyword">const</span> <span class="keywordtype">char</span> *str);
<a name="l00070"></a>00070 <span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment"> /// set buffer to 0 size, but don't bother overwriting memory with 0</span>
<a name="l00072"></a><a class="code" href="classBarry_1_1Data.html#a609a9523ce8ce8b94724c66751468858">00072</a> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Data.html#a609a9523ce8ce8b94724c66751468858" title="set buffer to 0 size, but don&#39;t bother overwriting memory with 0">QuickZap</a>() { m_datasize = 0; }
<a name="l00073"></a>00073 <span class="keywordtype">void</span> Zap(); <span class="comment">// does a memset too</span>
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <a class="code" href="classBarry_1_1Data.html">Data</a>& operator=(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &other);
<a name="l00076"></a>00076
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="comment">//</span>
<a name="l00079"></a>00079 <span class="comment">// Utility functions</span>
<a name="l00080"></a>00080 <span class="comment">//</span>
<a name="l00081"></a>00081 <span class="comment">// Writing data... basically does a memcpy(dst,src,sizeof(src))</span>
<a name="l00082"></a>00082 <span class="comment">// for each type. Does no endian conversions.</span>
<a name="l00083"></a>00083 <span class="comment">// dst is calculated as buffer + offset.</span>
<a name="l00084"></a>00084 <span class="comment">// The buffer is expanded automatically if needed.</span>
<a name="l00085"></a>00085 <span class="comment">// The offset is advanced by the size of the data.</span>
<a name="l00086"></a>00086 <span class="comment">//</span>
<a name="l00087"></a>00087 <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="l00088"></a>00088 <span class="keyword">template</span> <<span class="keyword">class</span> ValueT>
<a name="l00089"></a>00089 <span class="keywordtype">void</span> SetValue(<span class="keywordtype">size_t</span> &offset, ValueT value)
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 this->MemCpy(offset, &value, <span class="keyword">sizeof</span>(value));
<a name="l00092"></a>00092 }
<a name="l00093"></a>00093
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="comment">// static functions</span>
<a name="l00096"></a>00096 <span class="keyword">static</span> <span class="keywordtype">void</span> PrintAscii(<span class="keywordtype">bool</span> setting) { bPrintAscii = setting; }
<a name="l00097"></a>00097 <span class="keyword">static</span> <span class="keywordtype">bool</span> PrintAscii() { <span class="keywordflow">return</span> bPrintAscii; }
<a name="l00098"></a>00098 };
<a name="l00099"></a>00099
<a name="l00100"></a>00100 BXEXPORT std::istream& operator>> (std::istream &is, Data &data);
<a name="l00101"></a>00101 BXEXPORT std::ostream& operator<< (std::ostream &os, <span class="keyword">const</span> Data &data);
<a name="l00102"></a>00102
<a name="l00103"></a>00103
<a name="l00104"></a><a class="code" href="classBarry_1_1Diff.html">00104</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Diff.html">Diff</a>
<a name="l00105"></a>00105 {
<a name="l00106"></a>00106 <span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &m_old, &m_new;
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <a class="code" href="structBXLOCAL.html">BXLOCAL</a> <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="l00109"></a>00109
<a name="l00110"></a>00110 <span class="keyword">public</span>:
<a name="l00111"></a>00111 <a class="code" href="classBarry_1_1Diff.html">Diff</a>(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &old, <span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &new_);
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keywordtype">void</span> Dump(std::ostream &os) <span class="keyword">const</span>;
<a name="l00114"></a>00114 };
<a name="l00115"></a>00115
<a name="l00116"></a>00116 BXEXPORT std::ostream& operator<< (std::ostream &os, <span class="keyword">const</span> <a class="code" href="classBarry_1_1Diff.html">Diff</a> &diff);
<a name="l00117"></a>00117
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="comment">// utility functions</span>
<a name="l00120"></a>00120 BXEXPORT <span class="keywordtype">bool</span> LoadDataArray(<span class="keyword">const</span> std::string &filename, std::vector<Data> &array);
<a name="l00121"></a>00121 BXEXPORT <span class="keywordtype">bool</span> ReadDataArray(std::istream &is, std::vector<Data> &array);
<a name="l00122"></a>00122
<a name="l00123"></a>00123 } <span class="comment">// namespace Barry</span>
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="preprocessor">#endif</span>
<a name="l00126"></a>00126 <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>
