<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>FGx: src/utilities/osdab/zip.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">FGx  <span id="projectnumber">1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_7b5d38f1875f1b693f62ca6a108a1129.html">utilities</a></li><li class="navelem"><a class="el" href="dir_c246353284562c0e10c5738b0cfa01fa.html">osdab</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">zip.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/****************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">** Filename: zip.h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">** Last updated [dd/mm/yyyy]: 27/03/2011</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">**</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">** pkzip 2.0 file compression.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">**</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">** Some of the code has been inspired by other open source projects,</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">** (mainly Info-Zip and Gilles Vollant's minizip).</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">** Compression and decompression actually uses the zlib library.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">**</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">** Copyright (C) 2007-2011 Angius Fabrizio. All rights reserved.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">**</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">** This file is part of the OSDaB project (http://osdab.42cows.org/).</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">**</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">** This file may be distributed and/or modified under the terms of the</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">** GNU General Public License version 2 as published by the Free Software</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">** Foundation and appearing in the file LICENSE.GPL included in the</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">** packaging of this file.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">**</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">**</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">** See the file LICENSE.GPL that came with this software distribution or</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">** visit http://www.gnu.org/copyleft/gpl.html for GPL licensing information.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">**</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">**********************************************************************/</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef OSDAB_ZIP__H</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define OSDAB_ZIP__H</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "zipglobal.h"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <QtCore/QMap></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <QtCore/QtGlobal></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "zlib.h"</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>QIODevice;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>QFile;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>QDir;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span>QStringList;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">class </span>QString;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> OSDAB_BEGIN_NAMESPACE(<a class="code" href="classZip.html">Zip</a>)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">class </span><a class="code" href="classZipPrivate.html">ZipPrivate</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classZip.html"> 48</a></span> <span class="keyword">class </span>OSDAB_ZIP_EXPORT <a class="code" href="classZip.html">Zip</a></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classZip.html#aa445490ca64ce3051470bed52ee9198c"> 51</a></span>  <span class="keyword">enum</span> <a class="code" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">ErrorCode</a></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  Ok,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  ZlibInit,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  ZlibError,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  FileExists,</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  OpenFailed,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  NoOpenArchive,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  FileNotFound,</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  ReadFailed,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  WriteFailed,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  SeekFailed</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  };</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6"> 65</a></span>  <span class="keyword">enum</span> <a class="code" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  Store,</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  Deflate1 = 1, Deflate2, Deflate3, Deflate4,</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  Deflate5, Deflate6, Deflate7, Deflate8, Deflate9,</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  AutoCPU, AutoMIME, AutoFull</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  };</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classZip.html#a939111cf77e16d456d380b8c68f637ab"> 73</a></span>  <span class="keyword">enum</span> <a class="code" href="classZip.html#a939111cf77e16d456d380b8c68f637ab">CompressionOption</a></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  {</div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classZip.html#a939111cf77e16d456d380b8c68f637aba7e1fd3491d002f4aecba63638327e2a1"> 76</a></span>  RelativePaths = 0x0001,</div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classZip.html#a939111cf77e16d456d380b8c68f637abacd08c4e9df1b7ac08622275db0e5ef2d"> 78</a></span>  AbsolutePaths = 0x0002,</div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classZip.html#a939111cf77e16d456d380b8c68f637aba2e40ab516c31fc25aa684628cc1167a4"> 80</a></span>  IgnorePaths = 0x0004</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  };</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  Q_DECLARE_FLAGS(CompressionOptions, CompressionOption)</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classZip.html">Zip</a>();</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">virtual</span> ~<a class="code" href="classZip.html">Zip</a>();</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">bool</span> isOpen() <span class="keyword">const</span>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">void</span> setPassword(<span class="keyword">const</span> QString& pwd);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">void</span> clearPassword();</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  QString password() <span class="keyword">const</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  ErrorCode createArchive(<span class="keyword">const</span> QString& file, <span class="keywordtype">bool</span> overwrite = <span class="keyword">true</span>);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  ErrorCode createArchive(QIODevice* device);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  QString archiveComment() <span class="keyword">const</span>;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> setArchiveComment(<span class="keyword">const</span> QString& comment);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  ErrorCode addDirectoryContents(<span class="keyword">const</span> QString& path, CompressionLevel level = AutoFull);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  ErrorCode addDirectoryContents(<span class="keyword">const</span> QString& path, <span class="keyword">const</span> QString& root, CompressionLevel level = AutoFull);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  ErrorCode addDirectory(<span class="keyword">const</span> QString& path, CompressionOptions options = RelativePaths, CompressionLevel level = AutoFull);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  ErrorCode addDirectory(<span class="keyword">const</span> QString& path, <span class="keyword">const</span> QString& root, CompressionLevel level = AutoFull);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  ErrorCode addDirectory(<span class="keyword">const</span> QString& path, <span class="keyword">const</span> QString& root, CompressionOptions options = RelativePaths, CompressionLevel level = AutoFull);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  ErrorCode closeArchive();</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  QString formatError(ErrorCode c) <span class="keyword">const</span>;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classZipPrivate.html">ZipPrivate</a>* d;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> };</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> Q_DECLARE_OPERATORS_FOR_FLAGS(Zip::CompressionOptions)</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> OSDAB_END_NAMESPACE</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">#endif // OSDAB_ZIP__H</span></div><div class="ttc" id="classZip_html"><div class="ttname"><a href="classZip.html">Zip</a></div><div class="ttdoc">Zip file compression. </div><div class="ttdef"><b>Definition:</b> zip.h:48</div></div> <div class="ttc" id="classZip_html_a939111cf77e16d456d380b8c68f637ab"><div class="ttname"><a href="classZip.html#a939111cf77e16d456d380b8c68f637ab">Zip::CompressionOption</a></div><div class="ttdeci">CompressionOption</div><div class="ttdef"><b>Definition:</b> zip.h:73</div></div> <div class="ttc" id="classZip_html_afb46e5882e74520cead7d950e0fa7ca6"><div class="ttname"><a href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">Zip::CompressionLevel</a></div><div class="ttdeci">CompressionLevel</div><div class="ttdef"><b>Definition:</b> zip.h:65</div></div> <div class="ttc" id="classZipPrivate_html"><div class="ttname"><a href="classZipPrivate.html">ZipPrivate</a></div><div class="ttdef"><b>Definition:</b> zip_p.h:57</div></div> <div class="ttc" id="classZip_html_aa445490ca64ce3051470bed52ee9198c"><div class="ttname"><a href="classZip.html#aa445490ca64ce3051470bed52ee9198c">Zip::ErrorCode</a></div><div class="ttdeci">ErrorCode</div><div class="ttdef"><b>Definition:</b> zip.h:51</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Mon Sep 24 2018 08:46:31 for FGx by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>