<!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: tarfile.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>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>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file tarfile.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// API for reading and writing sequentially from compressed</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">/// tar files.</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) 2007-2011, Chris Frey <cdfrey@foursquare.net></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 __REUSE_TARFILE_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __REUSE_TARFILE_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 <string></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <stdexcept></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <libtar.h></span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">namespace </span>Barry {
<a name="l00031"></a>00031 <span class="keyword">class </span>Data;
<a name="l00032"></a>00032 }
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">namespace </span>reuse {
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="comment">//</span>
<a name="l00037"></a>00037 <span class="comment">// Compression options... more op sets can be added based on</span>
<a name="l00038"></a>00038 <span class="comment">// threading needs, or threading library support.</span>
<a name="l00039"></a>00039 <span class="comment">//</span>
<a name="l00040"></a>00040 <span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment">/// Compression op set for zlib, non-threadsafe.</span>
<a name="l00042"></a>00042 <span class="comment"></span><span class="keyword">extern</span> tartype_t gztar_ops_nonthread;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">class </span>BXLOCAL TarFile
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 TAR *m_tar;
<a name="l00047"></a>00047 <span class="keywordtype">bool</span> m_throw;
<a name="l00048"></a>00048 <span class="keywordtype">bool</span> m_writemode;
<a name="l00049"></a>00049 std::string m_last_error;
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">private</span>:
<a name="l00052"></a>00052 <span class="keywordtype">bool</span> False(<span class="keyword">const</span> <span class="keywordtype">char</span> *msg);
<a name="l00053"></a>00053 <span class="keywordtype">bool</span> False(<span class="keyword">const</span> std::string &str) { <span class="keywordflow">return</span> False(str.c_str()); }
<a name="l00054"></a>00054 <span class="keywordtype">bool</span> False(<span class="keyword">const</span> std::string &msg, <span class="keywordtype">int</span> err);
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">public</span>:
<a name="l00057"></a>00057 <span class="keyword">class </span>TarError : <span class="keyword">public</span> std::runtime_error
<a name="l00058"></a>00058 {
<a name="l00059"></a>00059 <span class="keyword">public</span>:
<a name="l00060"></a>00060 TarError(<span class="keyword">const</span> std::string &msg) : std::runtime_error(msg) {}
<a name="l00061"></a>00061 };
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keyword">public</span>:
<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>,
<a name="l00065"></a>00065 tartype_t *compress_ops = 0, <span class="keywordtype">bool</span> always_throw = <span class="keyword">false</span>);
<a name="l00066"></a>00066 ~TarFile();
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keyword">const</span> std::string& get_last_error()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_last_error; }
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keywordtype">bool</span> Close();
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /// Appends a new file to the current tarfile, using tarpath as</span>
<a name="l00073"></a>00073 <span class="comment"> /// its internal filename, and data as the complete file contents.</span>
<a name="l00074"></a>00074 <span class="comment"> /// Uses current date and time as file mtime.</span>
<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 &data);
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> /// Reads next available file into data, filling tarpath with</span>
<a name="l00078"></a>00078 <span class="comment"> /// internal filename from tarball.</span>
<a name="l00079"></a>00079 <span class="comment"> /// Returns false on end of archive.</span>
<a name="l00080"></a>00080 <span class="comment"></span> <span class="keywordtype">bool</span> ReadNextFile(std::string &tarpath, std::string &data);
<a name="l00081"></a>00081 <span class="keywordtype">bool</span> ReadNextFile(std::string &tarpath, Barry::Data &data);
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment"> /// Read next available filename, skipping the data if it is</span>
<a name="l00084"></a>00084 <span class="comment"> /// a regular file</span>
<a name="l00085"></a>00085 <span class="comment"></span> <span class="keywordtype">bool</span> ReadNextFilenameOnly(std::string &tarpath);
<a name="l00086"></a>00086 };
<a name="l00087"></a>00087
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="preprocessor">#endif</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:16 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>
