<!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/cachefile.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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">cachefile.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">/* ######################################################################</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"> CacheFile - Simple wrapper class for opening, generating and whatnot</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"> This class implements a simple 2 line mechanism to open various sorts</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> of caches. It can operate as root, as not root, show progress and so on,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> it transparently handles everything necessary.</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"> This means it can rebuild caches from the source list and instantiates</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> and prepares the standard policy mechanism.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> </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">/*}}}*/</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#ifndef PKGLIB_CACHEFILE_H</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define PKGLIB_CACHEFILE_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <stddef.h></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <apt-pkg/depcache.h></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <apt-pkg/macros.h></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="code" href="pkgcache_8h.xhtml">apt-pkg/pkgcache.h</a>></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <apt-pkg/cacheiterators.h></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef APT_8_CLEANER_HEADERS</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="acquire_8h.xhtml">apt-pkg/acquire.h</a>></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <apt-pkg/policy.h></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <apt-pkg/sourcelist.h></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif</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="keyword">class </span><a class="code" href="classMMap.xhtml">MMap</a>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span><a class="code" href="classpkgPolicy.xhtml">pkgPolicy</a>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span><a class="code" href="classpkgSourceList.xhtml">pkgSourceList</a>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span><a class="code" href="classpkgIndexFile.xhtml">pkgIndexFile</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span><a class="code" href="classOpProgress.xhtml">OpProgress</a>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classpkgCacheFile.xhtml"> 38</a></span> <span class="keyword">class </span><a class="code" href="classpkgCacheFile.xhtml">pkgCacheFile</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">void</span> * <span class="keyword">const</span> d;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">bool</span> ExternOwner;</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">protected</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classMMap.xhtml">MMap</a> *Map;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classpkgCache.xhtml">pkgCache</a> *Cache;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classpkgDepCache.xhtml">pkgDepCache</a> *DCache;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classpkgSourceList.xhtml">pkgSourceList</a> *SrcList;</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"> 51</span>  <a class="code" href="classpkgPolicy.xhtml">pkgPolicy</a> *Policy;</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>  <span class="comment">// We look pretty much exactly like a pointer to a dep cache</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">inline</span> <span class="keyword">operator</span> <a class="code" href="classpkgCache.xhtml">pkgCache</a> &() <span class="keyword">const</span> {<span class="keywordflow">return</span> *Cache;};</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">inline</span> <span class="keyword">operator</span> <a class="code" href="classpkgCache.xhtml">pkgCache</a> *() <span class="keyword">const</span> {<span class="keywordflow">return</span> Cache;};</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">inline</span> <span class="keyword">operator</span> <a class="code" href="classpkgDepCache.xhtml">pkgDepCache</a> &() <span class="keyword">const</span> {<span class="keywordflow">return</span> *DCache;};</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">inline</span> <span class="keyword">operator</span> <a class="code" href="classpkgDepCache.xhtml">pkgDepCache</a> *() <span class="keyword">const</span> {<span class="keywordflow">return</span> DCache;};</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">inline</span> <span class="keyword">operator</span> <a class="code" href="classpkgPolicy.xhtml">pkgPolicy</a> &() <span class="keyword">const</span> {<span class="keywordflow">return</span> *Policy;};</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">inline</span> <span class="keyword">operator</span> <a class="code" href="classpkgPolicy.xhtml">pkgPolicy</a> *() <span class="keyword">const</span> {<span class="keywordflow">return</span> Policy;};</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">inline</span> <span class="keyword">operator</span> <a class="code" href="classpkgSourceList.xhtml">pkgSourceList</a> &() <span class="keyword">const</span> {<span class="keywordflow">return</span> *SrcList;};</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">inline</span> <span class="keyword">operator</span> <a class="code" href="classpkgSourceList.xhtml">pkgSourceList</a> *() <span class="keyword">const</span> {<span class="keywordflow">return</span> SrcList;};</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">inline</span> <a class="code" href="classpkgDepCache.xhtml">pkgDepCache</a> *operator ->()<span class="keyword"> const </span>{<span class="keywordflow">return</span> DCache;};</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">inline</span> <a class="code" href="classpkgDepCache.xhtml">pkgDepCache</a> &operator *()<span class="keyword"> const </span>{<span class="keywordflow">return</span> *DCache;};</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">inline</span> <a class="code" href="structpkgDepCache_1_1StateCache.xhtml">pkgDepCache::StateCache</a> &operator [](<a class="code" href="classpkgCache_1_1PkgIterator.xhtml">pkgCache::PkgIterator</a> <span class="keyword">const</span> &I)<span class="keyword"> const </span>{<span class="keywordflow">return</span> (*DCache)[I];};</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> &operator [](<a class="code" href="classpkgCache_1_1DepIterator.xhtml">pkgCache::DepIterator</a> <span class="keyword">const</span> &I)<span class="keyword"> const </span>{<span class="keywordflow">return</span> (*DCache)[I];};</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>  <span class="keywordtype">bool</span> BuildCaches(<a class="code" href="classOpProgress.xhtml">OpProgress</a> *Progress = NULL,<span class="keywordtype">bool</span> WithLock = <span class="keyword">true</span>);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  APT_DEPRECATED_MSG(<span class="stringliteral">"Pass Progress in as a pointer"</span>) <span class="keywordtype">bool</span> BuildCaches(<a class="code" href="classOpProgress.xhtml">OpProgress</a> &Progress,<span class="keywordtype">bool</span> <span class="keyword">const</span> &WithLock = <span class="keyword">true</span>) { <span class="keywordflow">return</span> BuildCaches(&Progress, WithLock); };</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">bool</span> BuildSourceList(<a class="code" href="classOpProgress.xhtml">OpProgress</a> *Progress = NULL);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">bool</span> BuildPolicy(<a class="code" href="classOpProgress.xhtml">OpProgress</a> *Progress = NULL);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">bool</span> BuildDepCache(<a class="code" href="classOpProgress.xhtml">OpProgress</a> *Progress = NULL);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">bool</span> Open(<a class="code" href="classOpProgress.xhtml">OpProgress</a> *Progress = NULL, <span class="keywordtype">bool</span> WithLock = <span class="keyword">true</span>);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> ReadOnlyOpen(<a class="code" href="classOpProgress.xhtml">OpProgress</a> *Progress = NULL) { <span class="keywordflow">return</span> Open(Progress, <span class="keyword">false</span>); };</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  APT_DEPRECATED_MSG(<span class="stringliteral">"Pass Progress in as a pointer"</span>) <span class="keywordtype">bool</span> Open(<a class="code" href="classOpProgress.xhtml">OpProgress</a> &Progress,<span class="keywordtype">bool</span> <span class="keyword">const</span> &WithLock = <span class="keyword">true</span>) { <span class="keywordflow">return</span> Open(&Progress, WithLock); };</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> RemoveCaches();</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> Close();</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">bool</span> AddIndexFile(<a class="code" href="classpkgIndexFile.xhtml">pkgIndexFile</a> * <span class="keyword">const</span> File);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">inline</span> <a class="code" href="classpkgCache.xhtml">pkgCache</a>* GetPkgCache() { BuildCaches(NULL, <span class="keyword">false</span>); <span class="keywordflow">return</span> Cache; };</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">inline</span> <a class="code" href="classpkgDepCache.xhtml">pkgDepCache</a>* GetDepCache() { BuildDepCache(); <span class="keywordflow">return</span> DCache; };</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">inline</span> <a class="code" href="classpkgPolicy.xhtml">pkgPolicy</a>* GetPolicy() { BuildPolicy(); <span class="keywordflow">return</span> Policy; };</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">inline</span> <a class="code" href="classpkgSourceList.xhtml">pkgSourceList</a>* GetSourceList() { BuildSourceList(); <span class="keywordflow">return</span> SrcList; };</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> IsPkgCacheBuilt()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (Cache != NULL); };</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> IsDepCacheBuilt()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (DCache != NULL); };</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> IsPolicyBuilt()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (Policy != NULL); };</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> IsSrcListBuilt()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (SrcList != NULL); };</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="classpkgCacheFile.xhtml">pkgCacheFile</a>();</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">explicit</span> <a class="code" href="classpkgCacheFile.xhtml">pkgCacheFile</a>(<a class="code" href="classpkgDepCache.xhtml">pkgDepCache</a> * <span class="keyword">const</span> Owner);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpkgCacheFile.xhtml">pkgCacheFile</a>();</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> };</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classpkgCache_1_1DepIterator_xhtml"><div class="ttname"><a href="classpkgCache_1_1DepIterator.xhtml">pkgCache::DepIterator</a></div><div class="ttdef"><b>Definition:</b> cacheiterators.h:277</div></div>
<div class="ttc" id="classOpProgress_xhtml"><div class="ttname"><a href="classOpProgress.xhtml">OpProgress</a></div><div class="ttdef"><b>Definition:</b> progress.h:34</div></div>
<div class="ttc" id="structpkgDepCache_1_1StateCache_xhtml"><div class="ttname"><a href="structpkgDepCache_1_1StateCache.xhtml">pkgDepCache::StateCache</a></div><div class="ttdef"><b>Definition:</b> depcache.h:210</div></div>
<div class="ttc" id="classpkgCache_xhtml"><div class="ttname"><a href="classpkgCache.xhtml">pkgCache</a></div><div class="ttdef"><b>Definition:</b> pkgcache.h:109</div></div>
<div class="ttc" id="classpkgDepCache_xhtml"><div class="ttname"><a href="classpkgDepCache.xhtml">pkgDepCache</a></div><div class="ttdef"><b>Definition:</b> depcache.h:64</div></div>
<div class="ttc" id="acquire_8h_xhtml"><div class="ttname"><a href="acquire_8h.xhtml">acquire.h</a></div></div>
<div class="ttc" id="classMMap_xhtml"><div class="ttname"><a href="classMMap.xhtml">MMap</a></div><div class="ttdef"><b>Definition:</b> mmap.h:43</div></div>
<div class="ttc" id="classpkgCacheFile_xhtml"><div class="ttname"><a href="classpkgCacheFile.xhtml">pkgCacheFile</a></div><div class="ttdef"><b>Definition:</b> cachefile.h:38</div></div>
<div class="ttc" id="classpkgPolicy_xhtml"><div class="ttname"><a href="classpkgPolicy.xhtml">pkgPolicy</a></div><div class="ttdef"><b>Definition:</b> policy.h:47</div></div>
<div class="ttc" id="pkgcache_8h_xhtml"><div class="ttname"><a href="pkgcache_8h.xhtml">pkgcache.h</a></div><div class="ttdoc">pkgCache - Structure definitions for the cache file </div></div>
<div class="ttc" id="classpkgIndexFile_xhtml"><div class="ttname"><a href="classpkgIndexFile.xhtml">pkgIndexFile</a></div><div class="ttdef"><b>Definition:</b> indexfile.h:106</div></div>
<div class="ttc" id="classpkgCache_1_1PkgIterator_xhtml"><div class="ttname"><a href="classpkgCache_1_1PkgIterator.xhtml">pkgCache::PkgIterator</a></div><div class="ttdef"><b>Definition:</b> cacheiterators.h:144</div></div>
<div class="ttc" id="classpkgSourceList_xhtml"><div class="ttname"><a href="classpkgSourceList.xhtml">pkgSourceList</a></div><div class="ttdef"><b>Definition:</b> sourcelist.h:51</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>
