<!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/pkgsystem.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">pkgsystem.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"> System - Abstraction for running on different systems.</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"> Instances of this class can be thought of as factories or meta-classes</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> for a variety of more specialized classes. Together this class and </span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> it's specialized offspring completely define the environment and how</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> to access resources for a specific system. There are several sub</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> areas that are all orthogonal - each system has a unique combination of</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> these sub areas:</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> - Versioning. Different systems have different ideas on versions.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> Within a system all sub classes must follow the same versioning </span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> rules.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> - Local tool locking to prevent multiple tools from accessing the</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> same database.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> - Candidate Version selection policy - this is probably almost always</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> managed using a standard APT class</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> - Actual Package installation </span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * Indication of what kind of binary formats are supported</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> - Selection of local 'status' indexes that make up the pkgCache.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> </span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> It is important to note that the handling of index files is not a </span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> function of the system. Index files are handled through a separate</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> abstraction - the only requirement is that the index files have the</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> same idea of versioning as the target system.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> </span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> Upon startup each supported system instantiates an instance of the</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> pkgSystem class (using a global constructor) which will make itself</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> available to the main APT init routine. That routine will select the</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> proper system and make it the global default.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> </span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> ##################################################################### */</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">/*}}}*/</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#ifndef PKGLIB_PKGSYSTEM_H</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define PKGLIB_PKGSYSTEM_H</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <<a class="code" href="pkgcache_8h.xhtml">apt-pkg/pkgcache.h</a>></span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include <apt-pkg/cacheiterators.h></span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include <vector></span></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="preprocessor">#ifndef APT_8_CLEANER_HEADERS</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#include <apt-pkg/depcache.h></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">class </span><a class="code" href="classpkgDepCache.xhtml">pkgDepCache</a>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">class </span><a class="code" href="classpkgPackageManager.xhtml">pkgPackageManager</a>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">class </span><a class="code" href="classpkgVersioningSystem.xhtml">pkgVersioningSystem</a>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">class </span><a class="code" href="classConfiguration.xhtml">Configuration</a>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">class </span><a class="code" href="classpkgIndexFile.xhtml">pkgIndexFile</a>;</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">class </span><a class="code" href="classpkgSystemPrivate.xhtml">pkgSystemPrivate</a>;</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classpkgSystem.xhtml"> 55</a></span> <span class="keyword">class </span><a class="code" href="classpkgSystem.xhtml">pkgSystem</a></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// Global list of supported systems</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">static</span> <a class="code" href="classpkgSystem.xhtml">pkgSystem</a> **GlobalList;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> GlobalListLen;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">static</span> <a class="code" href="classpkgSystem.xhtml">pkgSystem</a> *GetSystem(<span class="keyword">const</span> <span class="keywordtype">char</span> *Label);</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>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="keyword">const</span> Label;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classpkgVersioningSystem.xhtml">pkgVersioningSystem</a> * <span class="keyword">const</span> VS;</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="comment">/* Prevent other programs from touching shared data not covered by</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> other locks (cache or state locks) */</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Lock() = 0;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> UnLock(<span class="keywordtype">bool</span> NoErrors = <span class="keyword">false</span>) = 0;</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>  <span class="comment">/* Various helper classes to interface with specific bits of this</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> environment */</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">virtual</span> <a class="code" href="classpkgPackageManager.xhtml">pkgPackageManager</a> *CreatePM(<a class="code" href="classpkgDepCache.xhtml">pkgDepCache</a> *Cache) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">/* Load environment specific configuration and perform any other setup</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> necessary */</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Initialize(<a class="code" href="classConfiguration.xhtml">Configuration</a> &<span class="comment">/*Cnf*/</span>) {<span class="keywordflow">return</span> <span class="keyword">true</span>;};</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="comment">/* Type is some kind of Globally Unique way of differentiating</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> archive file types.. */</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ArchiveSupported(<span class="keyword">const</span> <span class="keywordtype">char</span> *Type) = 0;</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>  <span class="comment">// Return a list of system index files..</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> AddStatusFiles(std::vector<pkgIndexFile *> &List) = 0;</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="keyword">virtual</span> <span class="keywordtype">bool</span> FindIndex(<a class="code" href="classpkgCache_1_1PkgFileIterator.xhtml">pkgCache::PkgFileIterator</a> File,</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classpkgIndexFile.xhtml">pkgIndexFile</a> *&Found) <span class="keyword">const</span> = 0;</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>  <span class="comment">/* Evauluate how 'right' we are for this system based on the filesystem</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> etc.. */</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">virtual</span> <span class="keywordtype">signed</span> Score(<a class="code" href="classConfiguration.xhtml">Configuration</a> <span class="keyword">const</span> &<span class="comment">/*Cnf*/</span>) {</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">return</span> 0;</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> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment">//FIXME: these methods should be virtual</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classpkgSystem.xhtml#abcebaae46433e8bfd54b6f93dd485331">MultiArchSupported</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  std::vector<std::string> <a class="code" href="classpkgSystem.xhtml#ae993f36a37c46cd6c1a39b76b6a08fc2">ArchitecturesSupported</a>() <span class="keyword">const</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>  APT_HIDDEN <span class="keywordtype">void</span> SetVersionMapping(map_id_t <span class="keyword">const</span> in, map_id_t <span class="keyword">const</span> out);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  APT_HIDDEN map_id_t GetVersionMapping(map_id_t <span class="keyword">const</span> in) <span class="keyword">const</span>;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="classpkgSystem.xhtml">pkgSystem</a>(<span class="keywordtype">char</span> <span class="keyword">const</span> * <span class="keyword">const</span> Label, <a class="code" href="classpkgVersioningSystem.xhtml">pkgVersioningSystem</a> * <span class="keyword">const</span> VS);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpkgSystem.xhtml">pkgSystem</a>();</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <a class="code" href="classpkgSystemPrivate.xhtml">pkgSystemPrivate</a> * <span class="keyword">const</span> d;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> };</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">// The environment we are operating in.</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">extern</span> <a class="code" href="classpkgSystem.xhtml">pkgSystem</a> *_system;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classpkgSystemPrivate_xhtml"><div class="ttname"><a href="classpkgSystemPrivate.xhtml">pkgSystemPrivate</a></div><div class="ttdef"><b>Definition:</b> pkgsystem.cc:29</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="classpkgSystem_xhtml_abcebaae46433e8bfd54b6f93dd485331"><div class="ttname"><a href="classpkgSystem.xhtml#abcebaae46433e8bfd54b6f93dd485331">pkgSystem::MultiArchSupported</a></div><div class="ttdeci">bool MultiArchSupported() const</div><div class="ttdef"><b>Definition:</b> pkgsystem.cc:59</div></div>
<div class="ttc" id="classpkgPackageManager_xhtml"><div class="ttname"><a href="classpkgPackageManager.xhtml">pkgPackageManager</a></div><div class="ttdef"><b>Definition:</b> packagemanager.h:55</div></div>
<div class="ttc" id="classpkgSystem_xhtml"><div class="ttname"><a href="classpkgSystem.xhtml">pkgSystem</a></div><div class="ttdef"><b>Definition:</b> pkgsystem.h:55</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="classpkgVersioningSystem_xhtml"><div class="ttname"><a href="classpkgVersioningSystem.xhtml">pkgVersioningSystem</a></div><div class="ttdef"><b>Definition:</b> version.h:30</div></div>
<div class="ttc" id="classpkgCache_1_1PkgFileIterator_xhtml"><div class="ttname"><a href="classpkgCache_1_1PkgFileIterator.xhtml">pkgCache::PkgFileIterator</a></div><div class="ttdef"><b>Definition:</b> cacheiterators.h:433</div></div>
<div class="ttc" id="classConfiguration_xhtml"><div class="ttname"><a href="classConfiguration.xhtml">Configuration</a></div><div class="ttdef"><b>Definition:</b> configuration.h:43</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="classpkgSystem_xhtml_ae993f36a37c46cd6c1a39b76b6a08fc2"><div class="ttname"><a href="classpkgSystem.xhtml#ae993f36a37c46cd6c1a39b76b6a08fc2">pkgSystem::ArchitecturesSupported</a></div><div class="ttdeci">std::vector< std::string > ArchitecturesSupported() const</div><div class="ttdef"><b>Definition:</b> pkgsystem.cc:67</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>
