<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>The MRPT project: zip.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.2 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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 id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</span><span class="right"></span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>zip.h</h1> </div>
</div>
<div class="contents">
<a href="zip_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"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span>
<a name="l00003"></a>00003 <span class="comment"> | |</span>
<a name="l00004"></a>00004 <span class="comment"> | http://mrpt.sourceforge.net/ |</span>
<a name="l00005"></a>00005 <span class="comment"> | |</span>
<a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span>
<a name="l00007"></a>00007 <span class="comment"> | |</span>
<a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span>
<a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span>
<a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span>
<a name="l00011"></a>00011 <span class="comment"> | |</span>
<a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span>
<a name="l00013"></a>00013 <span class="comment"> | |</span>
<a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span>
<a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span>
<a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span>
<a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span>
<a name="l00018"></a>00018 <span class="comment"> | |</span>
<a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span>
<a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span>
<a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span>
<a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span>
<a name="l00023"></a>00023 <span class="comment"> | |</span>
<a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span>
<a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef ZipCompression_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define ZipCompression_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="utils__defs_8h.html">mrpt/utils/utils_defs.h</a>></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">namespace </span>mrpt
<a name="l00034"></a>00034 {
<a name="l00035"></a><a class="code" href="namespacemrpt_1_1utils.html">00035</a> <span class="keyword">namespace </span>utils { <span class="keyword">class </span><a class="code" href="classmrpt_1_1utils_1_1_c_stream.html" title="This base class is used to provide a unified interface to files,memory buffers,..Please see the deriv...">CStream</a>; }
<a name="l00036"></a>00036 <span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment"> /** Data compression/decompression algorithms.</span>
<a name="l00038"></a>00038 <span class="comment"> */</span>
<a name="l00039"></a><a class="code" href="namespacemrpt_1_1compress.html">00039</a> <span class="keyword">namespace </span><a class="code" href="namespacemrpt_1_1compress_1_1zip.html#ae52b391cb61c044dda8397469c22835f" title="Compress an array of bytes into another one.">compress</a>
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="keyword">using namespace </span>mrpt::utils;
<a name="l00042"></a>00042 <span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment"> /** Compression using the "zip" algorithm and from/to gzip (gz) files.</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a><a class="code" href="namespacemrpt_1_1compress_1_1zip.html">00045</a> <span class="keyword">namespace </span>zip
<a name="l00046"></a>00046 {<span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> /** Compress an array of bytes into another one.</span>
<a name="l00048"></a>00048 <span class="comment"> */</span>
<a name="l00049"></a>00049 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1compress_1_1zip.html#ae52b391cb61c044dda8397469c22835f" title="Compress an array of bytes into another one.">compress</a>(
<a name="l00050"></a>00050 <span class="keywordtype">void</span> *inData,
<a name="l00051"></a>00051 <span class="keywordtype">size_t</span> inDataSize,
<a name="l00052"></a>00052 std::vector<unsigned char> &outData);
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> /** Compress an array of bytes into another one.</span>
<a name="l00055"></a>00055 <span class="comment"> */</span>
<a name="l00056"></a>00056 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1compress_1_1zip.html#ae52b391cb61c044dda8397469c22835f" title="Compress an array of bytes into another one.">compress</a>(
<a name="l00057"></a>00057 <span class="keyword">const</span> std::vector<unsigned char> &inData,
<a name="l00058"></a>00058 std::vector<unsigned char> &outData);
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment"> /** Compress an array of bytes and write the result into a stream.</span>
<a name="l00061"></a>00061 <span class="comment"> */</span>
<a name="l00062"></a>00062 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1compress_1_1zip.html#ae52b391cb61c044dda8397469c22835f" title="Compress an array of bytes into another one.">compress</a>(
<a name="l00063"></a>00063 <span class="keywordtype">void</span> *inData,
<a name="l00064"></a>00064 <span class="keywordtype">size_t</span> inDataSize,
<a name="l00065"></a>00065 <a class="code" href="classmrpt_1_1utils_1_1_c_stream.html" title="This base class is used to provide a unified interface to files,memory buffers,..Please see the deriv...">CStream</a> &out);
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /** Compress an array of bytes and write the result into a stream.</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1compress_1_1zip.html#ae52b391cb61c044dda8397469c22835f" title="Compress an array of bytes into another one.">compress</a>(
<a name="l00070"></a>00070 <span class="keyword">const</span> std::vector<unsigned char> &inData,
<a name="l00071"></a>00071 <a class="code" href="classmrpt_1_1utils_1_1_c_stream.html" title="This base class is used to provide a unified interface to files,memory buffers,..Please see the deriv...">CStream</a> &out);
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment"> /** Decompress an array of bytes into another one</span>
<a name="l00074"></a>00074 <span class="comment"> * \exception std::exception If the apriori estimated decompressed size is not enought</span>
<a name="l00075"></a>00075 <span class="comment"> */</span>
<a name="l00076"></a>00076 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1compress_1_1zip.html#a8ca9abfd0c9c7f97c7731629e6a47cec" title="Decompress an array of bytes into another one If the apriori estimated decompressed size is not enoug...">decompress</a>(
<a name="l00077"></a>00077 <span class="keywordtype">void</span> *inData,
<a name="l00078"></a>00078 <span class="keywordtype">size_t</span> inDataSize,
<a name="l00079"></a>00079 std::vector<unsigned char> &outData,
<a name="l00080"></a>00080 <span class="keywordtype">size_t</span> outDataEstimatedSize);
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /** Decompress an array of bytes into another one</span>
<a name="l00083"></a>00083 <span class="comment"> * \exception std::exception If the apriori estimated decompressed size is not enought</span>
<a name="l00084"></a>00084 <span class="comment"> */</span>
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1compress_1_1zip.html#a8ca9abfd0c9c7f97c7731629e6a47cec" title="Decompress an array of bytes into another one If the apriori estimated decompressed size is not enoug...">decompress</a>(
<a name="l00086"></a>00086 <span class="keywordtype">void</span> *inData,
<a name="l00087"></a>00087 <span class="keywordtype">size_t</span> inDataSize,
<a name="l00088"></a>00088 <span class="keywordtype">void</span> *outData,
<a name="l00089"></a>00089 <span class="keywordtype">size_t</span> outDataBufferSize,
<a name="l00090"></a>00090 <span class="keywordtype">size_t</span> &outDataActualSize);
<a name="l00091"></a>00091 <span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment"> /** Decompress an array of bytes into another one</span>
<a name="l00093"></a>00093 <span class="comment"> * \exception std::exception If the apriori estimated decompressed size is not enought</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1compress_1_1zip.html#a8ca9abfd0c9c7f97c7731629e6a47cec" title="Decompress an array of bytes into another one If the apriori estimated decompressed size is not enoug...">decompress</a>(
<a name="l00096"></a>00096 <a class="code" href="classmrpt_1_1utils_1_1_c_stream.html" title="This base class is used to provide a unified interface to files,memory buffers,..Please see the deriv...">CStream</a> &inStream,
<a name="l00097"></a>00097 <span class="keywordtype">size_t</span> inDataSize,
<a name="l00098"></a>00098 <span class="keywordtype">void</span> *outData,
<a name="l00099"></a>00099 <span class="keywordtype">size_t</span> outDataBufferSize,
<a name="l00100"></a>00100 <span class="keywordtype">size_t</span> &outDataActualSize);
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment"> /** Decompress a gzip file (xxxx.gz) into a memory buffer. If the file is not a .gz file, it just read the whole file unmodified.</span>
<a name="l00104"></a>00104 <span class="comment"> * \return true on success, false on error.</span>
<a name="l00105"></a>00105 <span class="comment"> * \sa compress_gz_file, decompress_gz_data_block</span>
<a name="l00106"></a>00106 <span class="comment"> */</span>
<a name="l00107"></a>00107 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1compress_1_1zip.html#afe61b6cf04bb3bec480ea736a3bc8df6" title="Decompress a gzip file (xxxx.gz) into a memory buffer.">decompress_gz_file</a>(
<a name="l00108"></a>00108 <span class="keyword">const</span> std::string &file_path,
<a name="l00109"></a>00109 <a class="code" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> & buffer);
<a name="l00110"></a>00110 <span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment"> /** Compress a memory buffer into a gzip file (xxxx.gz).</span>
<a name="l00112"></a>00112 <span class="comment"> * compress_level: 0=no compression, 1=best speed, 9=maximum</span>
<a name="l00113"></a>00113 <span class="comment"> * \return true on success, false on error.</span>
<a name="l00114"></a>00114 <span class="comment"> * \sa decompress_gz_file, compress_gz_data_block</span>
<a name="l00115"></a>00115 <span class="comment"> */</span>
<a name="l00116"></a>00116 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1compress_1_1zip.html#a849da35d535ba5933724907e99dba83c" title="Compress a memory buffer into a gzip file (xxxx.gz).">compress_gz_file</a>(
<a name="l00117"></a>00117 <span class="keyword">const</span> std::string &file_path,
<a name="l00118"></a>00118 <span class="keyword">const</span> <a class="code" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> &buffer,
<a name="l00119"></a>00119 <span class="keyword">const</span> <span class="keywordtype">int</span> compress_level = 9
<a name="l00120"></a>00120 );
<a name="l00121"></a>00121 <span class="comment"></span>
<a name="l00122"></a>00122 <span class="comment"> /** Compress a memory buffer in gz-file format and return it as a block a memory.</span>
<a name="l00123"></a>00123 <span class="comment"> * compress_level: 0=no compression, 1=best speed, 9=maximum</span>
<a name="l00124"></a>00124 <span class="comment"> * \return true on success, false on error.</span>
<a name="l00125"></a>00125 <span class="comment"> * \note If in_data is empty, an empty buffer is returned in out_gz_data and no error is reported.</span>
<a name="l00126"></a>00126 <span class="comment"> * \sa compress_gz_file, de</span>
<a name="l00127"></a>00127 <span class="comment"> */</span>
<a name="l00128"></a>00128 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1compress_1_1zip.html#a19ffeb11cd206759b10f07dabd180faa" title="Compress a memory buffer in gz-file format and return it as a block a memory.">compress_gz_data_block</a>(
<a name="l00129"></a>00129 <span class="keyword">const</span> <a class="code" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> &in_data,
<a name="l00130"></a>00130 <a class="code" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> &out_gz_data,
<a name="l00131"></a>00131 <span class="keyword">const</span> <span class="keywordtype">int</span> compress_level = 9);
<a name="l00132"></a>00132 <span class="comment"></span>
<a name="l00133"></a>00133 <span class="comment"> /** Decompress an array of bytes storing a gz-compressed stream of data into a memory buffer. If the input data is not recognized as a .gz file, the output data will be an exact copy of the input.</span>
<a name="l00134"></a>00134 <span class="comment"> * \return true on success, false on error.</span>
<a name="l00135"></a>00135 <span class="comment"> * \sa decompress_gz_file, compress_gz_data_block</span>
<a name="l00136"></a>00136 <span class="comment"> */</span>
<a name="l00137"></a>00137 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1compress_1_1zip.html#a9f33fa39c5dc810d14fa459141e8b6b1" title="Decompress an array of bytes storing a gz-compressed stream of data into a memory buffer...">decompress_gz_data_block</a>(
<a name="l00138"></a>00138 <span class="keyword">const</span> <a class="code" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> &in_gz_data,
<a name="l00139"></a>00139 <a class="code" href="namespacemrpt.html#a3250fe562baad62b3da2e166eb8867df">vector_byte</a> &out_data);
<a name="l00140"></a>00140
<a name="l00141"></a>00141
<a name="l00142"></a>00142 } <span class="comment">// End of namespace</span>
<a name="l00143"></a>00143 } <span class="comment">// End of namespace</span>
<a name="l00144"></a>00144
<a name="l00145"></a>00145 } <span class="comment">// End of namespace</span>
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.2</a> for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
