<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>apt: apt-pkg/contrib/fileutl.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="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">apt
 <span id="projectnumber">1.4.6</span>
</div>
<div id="projectbrief">commandline package manager</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_18f22d4be2ca84c350e120b6506056ca.xhtml">apt-pkg</a></li><li class="navelem"><a class="el" href="dir_c6ef23f15b074dcedf6810e24f2a7676.xhtml">contrib</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">fileutl.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">// -*- mode: cpp; mode: fold -*-</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Description /*{{{*/</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// $Id: fileutl.h,v 1.26 2001/05/07 05:06:52 jgg Exp $</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"> </span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> File Utilities</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> </span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> CopyFile - Buffered copy of a single file</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> GetLock - dpkg compatible lock file manipulation (fcntl)</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> FileExists - Returns true if the file exists</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> SafeGetCWD - Returns the CWD in a string with overrun protection </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"> The file class is a handy abstraction for various functions+classes</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> that need to accept filenames.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> </span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> This source is placed in the Public Domain, do with it what you will</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> It was originally written by Jason Gunthorpe.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> </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">/*}}}*/</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef PKGLIB_FILEUTL_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define PKGLIB_FILEUTL_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <apt-pkg/macros.h></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <apt-pkg/aptconfiguration.h></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <set></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <time.h></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <zlib.h></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef APT_8_CLEANER_HEADERS</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">using</span> std::string;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#endif</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="comment">/* Define this for python-apt */</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define APT_HAS_GZIP 1</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span><a class="code" href="classFileFdPrivate.xhtml">FileFdPrivate</a>;</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classFileFd.xhtml"> 42</a></span> <span class="keyword">class </span><a class="code" href="classFileFd.xhtml">FileFd</a></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>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classFileFdPrivate.xhtml">FileFdPrivate</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classGzipFileFdPrivate.xhtml">GzipFileFdPrivate</a>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBz2FileFdPrivate.xhtml">Bz2FileFdPrivate</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classLzmaFileFdPrivate.xhtml">LzmaFileFdPrivate</a>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classLz4FileFdPrivate.xhtml">Lz4FileFdPrivate</a>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classDirectFileFdPrivate.xhtml">DirectFileFdPrivate</a>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classPipedFileFdPrivate.xhtml">PipedFileFdPrivate</a>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">int</span> iFd;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">enum</span> LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2),</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  HitEof = (1<<3), Replace = (1<<4), Compressed = (1<<5) };</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> Flags;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  std::string FileName;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::string TemporaryFileName;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">enum</span> OpenMode {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  ReadOnly = (1 << 0),</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  WriteOnly = (1 << 1),</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  ReadWrite = ReadOnly | WriteOnly,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  Create = (1 << 2),</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  Exclusive = (1 << 3),</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  Atomic = Exclusive | (1 << 4),</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  Empty = (1 << 5),</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  BufferedWrite = (1 << 6),</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>  WriteEmpty = ReadWrite | Create | Empty,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  WriteExists = ReadWrite,</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  WriteAny = ReadWrite | Create,</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  WriteTemp = ReadWrite | Create | Exclusive,</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  ReadOnlyGzip,</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  WriteAtomic = ReadWrite | Create | Atomic</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  };</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">enum</span> CompressMode { Auto = <span class="charliteral">'A'</span>, None = <span class="charliteral">'N'</span>, Extension = <span class="charliteral">'E'</span>, Gzip = <span class="charliteral">'G'</span>, Bzip2 = <span class="charliteral">'B'</span>, Lzma = <span class="charliteral">'L'</span>, Xz = <span class="charliteral">'X'</span>, Lz4=<span class="charliteral">'4'</span> };</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> Read(<span class="keywordtype">void</span> *To,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Size,<span class="keywordtype">bool</span> AllowEof)</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Jnk;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">if</span> (AllowEof)</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">return</span> Read(To,Size,&Jnk);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> Read(To,Size);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  } </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">bool</span> Read(<span class="keywordtype">void</span> *To,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Size,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *Actual = 0);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">bool</span> <span class="keyword">static</span> Read(<span class="keywordtype">int</span> <span class="keyword">const</span> Fd, <span class="keywordtype">void</span> *To, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Size, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> * <span class="keyword">const</span> Actual = 0);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">char</span>* ReadLine(<span class="keywordtype">char</span> *To, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <span class="keyword">const</span> Size);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">bool</span> Flush();</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">bool</span> Write(<span class="keyword">const</span> <span class="keywordtype">void</span> *From,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Size);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">bool</span> <span class="keyword">static</span> Write(<span class="keywordtype">int</span> Fd, <span class="keyword">const</span> <span class="keywordtype">void</span> *From, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Size);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">bool</span> Seek(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> To);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">bool</span> Skip(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> To);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">bool</span> Truncate(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> To);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Tell();</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment">// the size of the file content (compressed files will be uncompressed first)</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Size();</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// the size of the file itself</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> FileSize();</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  time_t ModificationTime();</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="comment">/* You want to use 'unsigned long long' if you are talking about a file</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> to be able to support large files (>2 or >4 GB) properly.</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> This shouldn't happen all to often for the indexes, but deb's might be…</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> And as the auto-conversation converts a 'unsigned long *' to a 'bool'</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> instead of 'unsigned long long *' we need to provide this explicitly -</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> otherwise applications magically start to fail… */</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">bool</span> Read(<span class="keywordtype">void</span> *To,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Size,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> *Actual) APT_DEPRECATED_MSG(<span class="stringliteral">"The Actual variable you pass in should be an unsigned long long"</span>)</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  {</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> R;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">bool</span> <span class="keyword">const</span> T = Read(To, Size, &R);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  *Actual = R;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">return</span> T;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  }</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="keywordtype">bool</span> Open(std::string FileName,<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> Mode,CompressMode Compress,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keyword">const</span> AccessMode = 0666);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">bool</span> Open(std::string FileName,<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> Mode,<a class="code" href="structAPT_1_1Configuration_1_1Compressor.xhtml">APT::Configuration::Compressor</a> <span class="keyword">const</span> &compressor,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keyword">const</span> AccessMode = 0666);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> Open(std::string <span class="keyword">const</span> &FileName,<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> Mode, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keyword">const</span> AccessMode = 0666) {</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordflow">return</span> Open(FileName, Mode, None, AccessMode);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  };</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">bool</span> OpenDescriptor(<span class="keywordtype">int</span> Fd, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> Mode, CompressMode Compress, <span class="keywordtype">bool</span> AutoClose=<span class="keyword">false</span>);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">bool</span> OpenDescriptor(<span class="keywordtype">int</span> Fd, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> Mode, <a class="code" href="structAPT_1_1Configuration_1_1Compressor.xhtml">APT::Configuration::Compressor</a> <span class="keyword">const</span> &compressor, <span class="keywordtype">bool</span> AutoClose=<span class="keyword">false</span>);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> OpenDescriptor(<span class="keywordtype">int</span> Fd, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> Mode, <span class="keywordtype">bool</span> AutoClose=<span class="keyword">false</span>) {</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordflow">return</span> OpenDescriptor(Fd, Mode, None, AutoClose);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  };</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">bool</span> Close();</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">bool</span> Sync();</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="comment">// Simple manipulators</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">inline</span> <span class="keywordtype">int</span> Fd() {<span class="keywordflow">return</span> iFd;};</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> Fd(<span class="keywordtype">int</span> fd) { OpenDescriptor(fd, ReadWrite);};</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  gzFile gzFd() APT_DEPRECATED_MSG(<span class="stringliteral">"Implementation detail, do not use to be able to support bzip2, xz and co"</span>) APT_PURE;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> IsOpen() {<span class="keywordflow">return</span> iFd >= 0;};</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> Failed() {<span class="keywordflow">return</span> (Flags & Fail) == Fail;};</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> EraseOnFailure() {Flags |= DelOnFail;};</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> OpFail() {Flags |= Fail;};</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> Eof() {<span class="keywordflow">return</span> (Flags & HitEof) == HitEof;};</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> IsCompressed() {<span class="keywordflow">return</span> (Flags & Compressed) == Compressed;};</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">inline</span> std::string &Name() {<span class="keywordflow">return</span> FileName;};</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <a class="code" href="classFileFd.xhtml">FileFd</a>(std::string FileName,<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> Mode,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> AccessMode = 0666);</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <a class="code" href="classFileFd.xhtml">FileFd</a>(std::string FileName,<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> Mode, CompressMode Compress, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> AccessMode = 0666);</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <a class="code" href="classFileFd.xhtml">FileFd</a>();</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <a class="code" href="classFileFd.xhtml">FileFd</a>(<span class="keywordtype">int</span> <span class="keyword">const</span> Fd, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> Mode = ReadWrite, CompressMode Compress = None);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="classFileFd.xhtml">FileFd</a>(<span class="keywordtype">int</span> <span class="keyword">const</span> Fd, <span class="keywordtype">bool</span> <span class="keyword">const</span> AutoClose);</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">virtual</span> ~<a class="code" href="classFileFd.xhtml">FileFd</a>();</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <a class="code" href="classFileFdPrivate.xhtml">FileFdPrivate</a> * d;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  APT_HIDDEN <a class="code" href="classFileFd.xhtml">FileFd</a> & operator=(<span class="keyword">const</span> <a class="code" href="classFileFd.xhtml">FileFd</a> &);</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  APT_HIDDEN <span class="keywordtype">bool</span> OpenInternDescriptor(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> Mode, <a class="code" href="structAPT_1_1Configuration_1_1Compressor.xhtml">APT::Configuration::Compressor</a> <span class="keyword">const</span> &compressor);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="comment">// private helpers to set Fail flag and call _error->Error</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  APT_HIDDEN <span class="keywordtype">bool</span> FileFdErrno(<span class="keyword">const</span> <span class="keywordtype">char</span>* Function, <span class="keyword">const</span> <span class="keywordtype">char</span>* Description,...) APT_PRINTF(3) APT_COLD;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  APT_HIDDEN <span class="keywordtype">bool</span> FileFdError(<span class="keyword">const</span> <span class="keywordtype">char</span>* Description,...) APT_PRINTF(2) APT_COLD;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> };</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="keywordtype">bool</span> RunScripts(<span class="keyword">const</span> <span class="keywordtype">char</span> *Cnf);</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="keywordtype">bool</span> CopyFile(<a class="code" href="classFileFd.xhtml">FileFd</a> &From,<a class="code" href="classFileFd.xhtml">FileFd</a> &To);</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="keywordtype">bool</span> RemoveFile(<span class="keywordtype">char</span> <span class="keyword">const</span> * <span class="keyword">const</span> Function, std::string <span class="keyword">const</span> &FileName);</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="keywordtype">int</span> GetLock(std::string File,<span class="keywordtype">bool</span> Errors = <span class="keyword">true</span>);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="keywordtype">bool</span> FileExists(std::string File);</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="keywordtype">bool</span> RealFileExists(std::string File);</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="keywordtype">bool</span> DirectoryExists(std::string <span class="keyword">const</span> &Path);</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="keywordtype">bool</span> CreateDirectory(std::string <span class="keyword">const</span> &Parent, std::string <span class="keyword">const</span> &Path);</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> time_t GetModificationTime(std::string <span class="keyword">const</span> &Path);</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="keywordtype">bool</span> Rename(std::string From, std::string To);</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> std::string GetTempDir();</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> std::string GetTempDir(std::string <span class="keyword">const</span> &User);</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <a class="code" href="classFileFd.xhtml">FileFd</a>* GetTempFile(std::string <span class="keyword">const</span> &Prefix = <span class="stringliteral">""</span>,</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordtype">bool</span> ImmediateUnlink = <span class="keyword">true</span>,</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <a class="code" href="classFileFd.xhtml">FileFd</a> * <span class="keyword">const</span> TmpFd = NULL);</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="keywordtype">bool</span> CreateAPTDirectoryIfNeeded(std::string <span class="keyword">const</span> &Parent, std::string <span class="keyword">const</span> &Path);</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> std::vector<std::string> GetListOfFilesInDir(std::string <span class="keyword">const</span> &Dir, std::string <span class="keyword">const</span> &Ext,</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keywordtype">bool</span> <span class="keyword">const</span> &SortList, <span class="keywordtype">bool</span> <span class="keyword">const</span> &AllowNoExt=<span class="keyword">false</span>);</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> std::vector<std::string> GetListOfFilesInDir(std::string <span class="keyword">const</span> &Dir, std::vector<std::string> <span class="keyword">const</span> &Ext,</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keywordtype">bool</span> <span class="keyword">const</span> &SortList);</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> std::vector<std::string> GetListOfFilesInDir(std::string <span class="keyword">const</span> &Dir, <span class="keywordtype">bool</span> SortList);</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> std::string SafeGetCWD();</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="keywordtype">void</span> SetCloseExec(<span class="keywordtype">int</span> Fd,<span class="keywordtype">bool</span> Close);</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="keywordtype">void</span> SetNonBlock(<span class="keywordtype">int</span> Fd,<span class="keywordtype">bool</span> Block);</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="keywordtype">bool</span> WaitFd(<span class="keywordtype">int</span> Fd,<span class="keywordtype">bool</span> write = <span class="keyword">false</span>,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> timeout = 0);</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> pid_t ExecFork();</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> pid_t ExecFork(std::set<int> keep_fds);</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="keywordtype">void</span> MergeKeepFdsFromConfiguration(std::set<int> &keep_fds);</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="keywordtype">bool</span> ExecWait(pid_t Pid,<span class="keyword">const</span> <span class="keywordtype">char</span> *Name,<span class="keywordtype">bool</span> Reap = <span class="keyword">false</span>);</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">// check if the given file starts with a PGP cleartext signature</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keywordtype">bool</span> StartsWithGPGClearTextSignature(std::string <span class="keyword">const</span> &FileName);</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="keywordtype">bool</span> ChangeOwnerAndPermissionOfFile(<span class="keywordtype">char</span> <span class="keyword">const</span> * <span class="keyword">const</span> requester, <span class="keywordtype">char</span> <span class="keyword">const</span> * <span class="keyword">const</span> file, <span class="keywordtype">char</span> <span class="keyword">const</span> * <span class="keyword">const</span> user, <span class="keywordtype">char</span> <span class="keyword">const</span> * <span class="keyword">const</span> group, mode_t <span class="keyword">const</span> mode);</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="keywordtype">bool</span> DropPrivileges();</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment">// File string manipulators</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> std::string flNotDir(std::string File);</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> std::string flNotFile(std::string File);</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> std::string flNoLink(std::string File);</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> std::string flExtension(std::string File);</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> std::string flCombine(std::string Dir,std::string File);</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> std::string flAbsPath(std::string File);</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> APT_HIDDEN std::string flNormalize(std::string file);</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment">// simple c++ glob</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> std::vector<std::string> Glob(std::string <span class="keyword">const</span> &pattern, <span class="keywordtype">int</span> flags=0);</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="keywordtype">bool</span> Popen(<span class="keyword">const</span> <span class="keywordtype">char</span>* Args[], <a class="code" href="classFileFd.xhtml">FileFd</a> &Fd, pid_t &Child, FileFd::OpenMode Mode, <span class="keywordtype">bool</span> CaptureStderr);</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="keywordtype">bool</span> Popen(<span class="keyword">const</span> <span class="keywordtype">char</span>* Args[], <a class="code" href="classFileFd.xhtml">FileFd</a> &Fd, pid_t &Child, FileFd::OpenMode Mode);</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> </div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> </div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="structAPT_1_1Configuration_1_1Compressor_xhtml"><div class="ttname"><a href="structAPT_1_1Configuration_1_1Compressor.xhtml">APT::Configuration::Compressor</a></div><div class="ttdoc">Representation of supported compressors. </div><div class="ttdef"><b>Definition:</b> aptconfiguration.h:94</div></div>
<div class="ttc" id="classFileFdPrivate_xhtml"><div class="ttname"><a href="classFileFdPrivate.xhtml">FileFdPrivate</a></div><div class="ttdef"><b>Definition:</b> fileutl.cc:1004</div></div>
<div class="ttc" id="classLz4FileFdPrivate_xhtml"><div class="ttname"><a href="classLz4FileFdPrivate.xhtml">Lz4FileFdPrivate</a></div><div class="ttdef"><b>Definition:</b> fileutl.cc:1527</div></div>
<div class="ttc" id="classGzipFileFdPrivate_xhtml"><div class="ttname"><a href="classGzipFileFdPrivate.xhtml">GzipFileFdPrivate</a></div><div class="ttdef"><b>Definition:</b> fileutl.cc:1346</div></div>
<div class="ttc" id="classLzmaFileFdPrivate_xhtml"><div class="ttname"><a href="classLzmaFileFdPrivate.xhtml">LzmaFileFdPrivate</a></div><div class="ttdef"><b>Definition:</b> fileutl.cc:1686</div></div>
<div class="ttc" id="classFileFd_xhtml"><div class="ttname"><a href="classFileFd.xhtml">FileFd</a></div><div class="ttdef"><b>Definition:</b> fileutl.h:42</div></div>
<div class="ttc" id="classDirectFileFdPrivate_xhtml"><div class="ttname"><a href="classDirectFileFdPrivate.xhtml">DirectFileFdPrivate</a></div><div class="ttdef"><b>Definition:</b> fileutl.cc:2025</div></div>
<div class="ttc" id="classPipedFileFdPrivate_xhtml"><div class="ttname"><a href="classPipedFileFdPrivate.xhtml">PipedFileFdPrivate</a></div><div class="ttdef"><b>Definition:</b> fileutl.cc:1893</div></div>
<div class="ttc" id="classBz2FileFdPrivate_xhtml"><div class="ttname"><a href="classBz2FileFdPrivate.xhtml">Bz2FileFdPrivate</a></div><div class="ttdef"><b>Definition:</b> fileutl.cc:1473</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
