<!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: cod.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>cod.h</h1><a href="cod_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 cod.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// COD file API</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) 2009-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 __BARRY_COD_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_COD_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="data_8h.html" title="Class to deal with pre-saved data files.">data.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <sys/types.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <stdint.h></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <iostream></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <sstream></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">namespace </span>Barry {
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">//</span>
<a name="l00036"></a>00036 <span class="comment">// SeekNextCod</span>
<a name="l00037"></a>00037 <span class="comment">//</span><span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/// Seeks the input stream to the next packed sibling .cod file and returns</span>
<a name="l00039"></a>00039 <span class="comment">/// the packed .cod file size. When all siblings have been read, zero is</span>
<a name="l00040"></a>00040 <span class="comment">/// returned.</span>
<a name="l00041"></a>00041 <span class="comment">///</span>
<a name="l00042"></a>00042 <span class="comment">/// When input stream does not contain the signature for a packed .cod file,</span>
<a name="l00043"></a>00043 <span class="comment">/// it's assumed the entire stream is the .cod file.</span>
<a name="l00044"></a>00044 <span class="comment">///</span>
<a name="l00045"></a>00045 <span class="comment">/// \param input stream to read from</span>
<a name="l00046"></a>00046 <span class="comment">///</span>
<a name="l00047"></a>00047 <span class="comment">/// \return size of next packed .cod file, or 0 finished reading .cod files</span>
<a name="l00048"></a>00048 <span class="comment">///</span>
<a name="l00049"></a>00049 <span class="comment"></span><span class="keywordtype">size_t</span> <a class="code" href="namespaceBarry.html#07808b7a4cabe1399d5432eb1ee1eabf" title="Seeks the input stream to the next packed sibling .cod file and returns the packed...">SeekNextCod</a>(std::istream &input);
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment"></span>
<a name="l00052"></a>00052 <span class="comment">///</span>
<a name="l00053"></a>00053 <span class="comment">/// The CodFileBuilder class is used to assemble multiple .cod files into</span>
<a name="l00054"></a>00054 <span class="comment">/// a single packed .cod file using the pkzip file format.</span>
<a name="l00055"></a>00055 <span class="comment">///</span>
<a name="l00056"></a><a class="code" href="classBarry_1_1CodFileBuilder.html">00056</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1CodFileBuilder.html" title="The CodFileBuilder class is used to assemble multiple .cod files into a single packed...">CodFileBuilder</a>
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 std::string m_module_name;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keywordtype">size_t</span> m_module_count;
<a name="l00061"></a>00061 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_current_module;
<a name="l00062"></a>00062
<a name="l00063"></a>00063 std::ostringstream m_directory;
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keyword">public</span>:
<a name="l00066"></a>00066 <a class="code" href="classBarry_1_1CodFileBuilder.html" title="The CodFileBuilder class is used to assemble multiple .cod files into a single packed...">CodFileBuilder</a>(<span class="keyword">const</span> std::string &module_name, <span class="keywordtype">size_t</span> module_count = 1);
<a name="l00067"></a>00067
<a name="l00068"></a>00068 ~<a class="code" href="classBarry_1_1CodFileBuilder.html" title="The CodFileBuilder class is used to assemble multiple .cod files into a single packed...">CodFileBuilder</a>();
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> ///</span>
<a name="l00071"></a>00071 <span class="comment"> /// Writes packed .cod file header to the output stream, and appends</span>
<a name="l00072"></a>00072 <span class="comment"> /// an entry to the central directory. If the module count used to</span>
<a name="l00073"></a>00073 <span class="comment"> /// create CodFileBuilder is equal to one, the call is ignored.</span>
<a name="l00074"></a>00074 <span class="comment"> ///</span>
<a name="l00075"></a>00075 <span class="comment"> /// Note: it is the caller's responsibility to write the actual</span>
<a name="l00076"></a>00076 <span class="comment"> /// COD file data after calling this function.</span>
<a name="l00077"></a>00077 <span class="comment"> ///</span>
<a name="l00078"></a>00078 <span class="comment"> /// \param output stream to write to</span>
<a name="l00079"></a>00079 <span class="comment"> ///</span>
<a name="l00080"></a>00080 <span class="comment"> /// \param buffer buffered .cod file data, input to CRC-32 function</span>
<a name="l00081"></a>00081 <span class="comment"> ///</span>
<a name="l00082"></a>00082 <span class="comment"> /// \param module_size total size of .cod file data</span>
<a name="l00083"></a>00083 <span class="comment"> ///</span>
<a name="l00084"></a>00084 <span class="comment"></span> <span class="keywordtype">void</span> WriteNextHeader(std::ostream &output, <span class="keyword">const</span> uint8_t* buffer,
<a name="l00085"></a>00085 uint32_t module_size);
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment"> ///</span>
<a name="l00088"></a>00088 <span class="comment"> /// Write the central directory and central directory ending indicator</span>
<a name="l00089"></a>00089 <span class="comment"> /// to the output stream.</span>
<a name="l00090"></a>00090 <span class="comment"> ///</span>
<a name="l00091"></a>00091 <span class="comment"> /// \param output stream to write to</span>
<a name="l00092"></a>00092 <span class="comment"> ///</span>
<a name="l00093"></a>00093 <span class="comment"></span> <span class="keywordtype">void</span> WriteFooter(std::ostream &output);
<a name="l00094"></a>00094 };
<a name="l00095"></a>00095
<a name="l00096"></a>00096 }
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="preprocessor">#endif</span>
<a name="l00099"></a>00099 <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>
