doc/www/doxygen/html/tarfile_8h-source.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: tarfile.h Source File</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>tarfile.h</h1><a href="tarfile_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>
  24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file       tarfile.h</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             API for reading and writing sequentially from compressed</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///             tar files.</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span>
  28 <a name="l00006"></a>00006 <span class="comment">/*</span>
  29 <a name="l00007"></a>00007 <span class="comment">    Copyright (C) 2007-2011, Chris Frey &lt;cdfrey@foursquare.net&gt;</span>
  30 <a name="l00008"></a>00008 <span class="comment"></span>
  31 <a name="l00009"></a>00009 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  32 <a name="l00010"></a>00010 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  33 <a name="l00011"></a>00011 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  34 <a name="l00012"></a>00012 <span class="comment">    (at your option) any later version.</span>
  35 <a name="l00013"></a>00013 <span class="comment"></span>
  36 <a name="l00014"></a>00014 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  37 <a name="l00015"></a>00015 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  38 <a name="l00016"></a>00016 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  39 <a name="l00017"></a>00017 <span class="comment"></span>
  40 <a name="l00018"></a>00018 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  41 <a name="l00019"></a>00019 <span class="comment">    root directory of this project for more details.</span>
  42 <a name="l00020"></a>00020 <span class="comment">*/</span>
  43 <a name="l00021"></a>00021
  44 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef __REUSE_TARFILE_H__</span>
  45 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __REUSE_TARFILE_H__</span>
  46 <a name="l00024"></a>00024 <span class="preprocessor"></span>
  47 <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>
  48 <a name="l00026"></a>00026 <span class="preprocessor">#include &lt;string&gt;</span>
  49 <a name="l00027"></a>00027 <span class="preprocessor">#include &lt;stdexcept&gt;</span>
  50 <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;libtar.h&gt;</span>
  51 <a name="l00029"></a>00029
  52 <a name="l00030"></a>00030 <span class="keyword">namespace </span>Barry {
  53 <a name="l00031"></a>00031         <span class="keyword">class </span>Data;
  54 <a name="l00032"></a>00032 }
  55 <a name="l00033"></a>00033
  56 <a name="l00034"></a>00034 <span class="keyword">namespace </span>reuse {
  57 <a name="l00035"></a>00035
  58 <a name="l00036"></a>00036 <span class="comment">//</span>
  59 <a name="l00037"></a>00037 <span class="comment">// Compression options... more op sets can be added based on</span>
  60 <a name="l00038"></a>00038 <span class="comment">// threading needs, or threading library support.</span>
  61 <a name="l00039"></a>00039 <span class="comment">//</span>
  62 <a name="l00040"></a>00040 <span class="comment"></span>
  63 <a name="l00041"></a>00041 <span class="comment">/// Compression op set for zlib, non-threadsafe.</span>
  64 <a name="l00042"></a>00042 <span class="comment"></span><span class="keyword">extern</span> tartype_t gztar_ops_nonthread;
  65 <a name="l00043"></a>00043
  66 <a name="l00044"></a>00044 <span class="keyword">class </span>BXLOCAL TarFile
  67 <a name="l00045"></a>00045 {
  68 <a name="l00046"></a>00046         TAR *m_tar;
  69 <a name="l00047"></a>00047         <span class="keywordtype">bool</span> m_throw;
  70 <a name="l00048"></a>00048         <span class="keywordtype">bool</span> m_writemode;
  71 <a name="l00049"></a>00049         std::string m_last_error;
  72 <a name="l00050"></a>00050
  73 <a name="l00051"></a>00051 <span class="keyword">private</span>:
  74 <a name="l00052"></a>00052         <span class="keywordtype">bool</span> False(<span class="keyword">const</span> <span class="keywordtype">char</span> *msg);
  75 <a name="l00053"></a>00053         <span class="keywordtype">bool</span> False(<span class="keyword">const</span> std::string &amp;str) { <span class="keywordflow">return</span> False(str.c_str()); }
  76 <a name="l00054"></a>00054         <span class="keywordtype">bool</span> False(<span class="keyword">const</span> std::string &amp;msg, <span class="keywordtype">int</span> err);
  77 <a name="l00055"></a>00055
  78 <a name="l00056"></a>00056 <span class="keyword">public</span>:
  79 <a name="l00057"></a>00057         <span class="keyword">class </span>TarError : <span class="keyword">public</span> std::runtime_error
  80 <a name="l00058"></a>00058         {
  81 <a name="l00059"></a>00059         <span class="keyword">public</span>:
  82 <a name="l00060"></a>00060                 TarError(<span class="keyword">const</span> std::string &amp;msg) : std::runtime_error(msg) {}
  83 <a name="l00061"></a>00061         };
  84 <a name="l00062"></a>00062
  85 <a name="l00063"></a>00063 <span class="keyword">public</span>:
  86 <a name="l00064"></a>00064         <span class="keyword">explicit</span> TarFile(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, <span class="keywordtype">bool</span> write = <span class="keyword">false</span>,
  87 <a name="l00065"></a>00065                 tartype_t *compress_ops = 0, <span class="keywordtype">bool</span> always_throw = <span class="keyword">false</span>);
  88 <a name="l00066"></a>00066         ~TarFile();
  89 <a name="l00067"></a>00067
  90 <a name="l00068"></a>00068         <span class="keyword">const</span> std::string&amp; get_last_error()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_last_error; }
  91 <a name="l00069"></a>00069
  92 <a name="l00070"></a>00070         <span class="keywordtype">bool</span> Close();
  93 <a name="l00071"></a>00071 <span class="comment"></span>
  94 <a name="l00072"></a>00072 <span class="comment">        /// Appends a new file to the current tarfile, using tarpath as</span>
  95 <a name="l00073"></a>00073 <span class="comment">        /// its internal filename, and data as the complete file contents.</span>
  96 <a name="l00074"></a>00074 <span class="comment">        /// Uses current date and time as file mtime.</span>
  97 <a name="l00075"></a>00075 <span class="comment"></span>        <span class="keywordtype">bool</span> AppendFile(<span class="keyword">const</span> <span class="keywordtype">char</span> *tarpath, <span class="keyword">const</span> std::string &amp;data);
  98 <a name="l00076"></a>00076 <span class="comment"></span>
  99 <a name="l00077"></a>00077 <span class="comment">        /// Reads next available file into data, filling tarpath with</span>
 100 <a name="l00078"></a>00078 <span class="comment">        /// internal filename from tarball.</span>
 101 <a name="l00079"></a>00079 <span class="comment">        /// Returns false on end of archive.</span>
 102 <a name="l00080"></a>00080 <span class="comment"></span>        <span class="keywordtype">bool</span> ReadNextFile(std::string &amp;tarpath, std::string &amp;data);
 103 <a name="l00081"></a>00081         <span class="keywordtype">bool</span> ReadNextFile(std::string &amp;tarpath, Barry::Data &amp;data);
 104 <a name="l00082"></a>00082 <span class="comment"></span>
 105 <a name="l00083"></a>00083 <span class="comment">        /// Read next available filename, skipping the data if it is</span>
 106 <a name="l00084"></a>00084 <span class="comment">        /// a regular file</span>
 107 <a name="l00085"></a>00085 <span class="comment"></span>        <span class="keywordtype">bool</span> ReadNextFilenameOnly(std::string &amp;tarpath);
 108 <a name="l00086"></a>00086 };
 109 <a name="l00087"></a>00087
 110 <a name="l00088"></a>00088 }
 111 <a name="l00089"></a>00089
 112 <a name="l00090"></a>00090 <span class="preprocessor">#endif</span>
 113 <a name="l00091"></a>00091 <span class="preprocessor"></span>
 114 </pre></div></div>
 115 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:13:59 2011 for Barry by&nbsp;
 116 <a href="http://www.doxygen.org/index.html">
 117 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 118 </body>
 119 </html>