<!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/policy.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">policy.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"> Package Version Policy implementation</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 implements the more advanced 'Version 4' APT policy engine. The</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> standard 'Version 0' engine is included inside the DepCache which is</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> it's historical location.</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"> The V4 engine allows the user to completely control all aspects of</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> version selection. There are three primary means to choose a version</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Selection by version match</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * Selection by Release file match</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Selection by origin server</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> </span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> Each package may be 'pinned' with a single criteria, which will ultimately</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> result in the selection of a single version, or no version, for each</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> package.</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="comment"> Furthermore, the default selection can be influenced by specifying</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> the ordering of package files. The order is derived by reading the</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> package file preferences and assigning a priority to each package </span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> file.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> </span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> A special flag may be set to indicate if no version should be returned</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> if no matching versions are found, otherwise the default matching</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> rules are used to locate a hit.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> </span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> ##################################################################### */</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">/*}}}*/</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#ifndef PKGLIB_POLICY_H</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define PKGLIB_POLICY_H</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <apt-pkg/depcache.h></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <<a class="code" href="pkgcache_8h.xhtml">apt-pkg/pkgcache.h</a>></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <apt-pkg/cacheiterators.h></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include <apt-pkg/versionmatch.h></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#ifndef APT_8_CLEANER_HEADERS</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">using</span> std::vector;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classpkgPolicy.xhtml"> 47</a></span> <span class="keyword">class </span><a class="code" href="classpkgPolicy.xhtml">pkgPolicy</a> : <span class="keyword">public</span> <a class="code" href="classpkgDepCache_1_1Policy.xhtml">pkgDepCache::Policy</a></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structpkgPolicy_1_1Pin.xhtml"> 51</a></span>  <span class="keyword">struct </span><a class="code" href="structpkgPolicy_1_1Pin.xhtml">Pin</a></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>  pkgVersionMatch::MatchType Type;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  std::string Data;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">signed</span> <span class="keywordtype">short</span> Priority;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="structpkgPolicy_1_1Pin.xhtml">Pin</a>() : Type(pkgVersionMatch::None), Priority(0) {};</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</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"><a class="line" href="structpkgPolicy_1_1PkgPin.xhtml"> 59</a></span>  <span class="keyword">struct </span><a class="code" href="structpkgPolicy_1_1PkgPin.xhtml">PkgPin</a> : <a class="code" href="structpkgPolicy_1_1Pin.xhtml">Pin</a></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  std::string Pkg;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">explicit</span> <a class="code" href="structpkgPolicy_1_1PkgPin.xhtml">PkgPin</a>(std::string <span class="keyword">const</span> &Pkg) : <a class="code" href="structpkgPolicy_1_1Pin.xhtml">Pin</a>(), Pkg(Pkg) {};</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>  </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="structpkgPolicy_1_1Pin.xhtml">Pin</a> *Pins;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="structpkgPolicy_1_1Pin.xhtml">Pin</a> *VerPins;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">signed</span> <span class="keywordtype">short</span> *PFPriority;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  std::vector<Pin> Defaults;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  std::vector<PkgPin> Unmatched;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classpkgCache.xhtml">pkgCache</a> *Cache;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">bool</span> StatusOverride;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// Things for manipulating pins</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> CreatePin(pkgVersionMatch::MatchType Type,std::string Pkg,</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  std::string Data,<span class="keywordtype">signed</span> <span class="keywordtype">short</span> Priority);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classpkgCache_1_1VerIterator.xhtml">pkgCache::VerIterator</a> GetMatch(<a class="code" href="classpkgCache_1_1PkgIterator.xhtml">pkgCache::PkgIterator</a> <span class="keyword">const</span> &Pkg);</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">// Things for the cache interface.</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">virtual</span> <a class="code" href="classpkgCache_1_1VerIterator.xhtml">pkgCache::VerIterator</a> GetCandidateVer(<a class="code" href="classpkgCache_1_1PkgIterator.xhtml">pkgCache::PkgIterator</a> <span class="keyword">const</span> &Pkg) APT_OVERRIDE;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">virtual</span> <span class="keywordtype">signed</span> <span class="keywordtype">short</span> GetPriority(<a class="code" href="classpkgCache_1_1PkgIterator.xhtml">pkgCache::PkgIterator</a> <span class="keyword">const</span> &Pkg) APT_OVERRIDE;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">virtual</span> <span class="keywordtype">signed</span> <span class="keywordtype">short</span> GetPriority(<a class="code" href="classpkgCache_1_1VerIterator.xhtml">pkgCache::VerIterator</a> <span class="keyword">const</span> &Ver, <span class="keywordtype">bool</span> ConsiderFiles = <span class="keyword">true</span>) APT_OVERRIDE;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">virtual</span> <span class="keywordtype">signed</span> <span class="keywordtype">short</span> GetPriority(<a class="code" href="classpkgCache_1_1PkgFileIterator.xhtml">pkgCache::PkgFileIterator</a> <span class="keyword">const</span> &File) APT_OVERRIDE;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">bool</span> InitDefaults();</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="keyword">explicit</span> <a class="code" href="classpkgPolicy.xhtml#a09125a1b5560d8c43c8e669560663a7d">pkgPolicy</a>(<a class="code" href="classpkgCache.xhtml">pkgCache</a> *Owner);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpkgPolicy.xhtml">pkgPolicy</a>();</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">void</span> * <span class="keyword">const</span> d;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> };</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> <span class="keywordtype">bool</span> ReadPinFile(<a class="code" href="classpkgPolicy.xhtml">pkgPolicy</a> &Plcy, std::string File = <span class="stringliteral">""</span>);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">bool</span> ReadPinDir(<a class="code" href="classpkgPolicy.xhtml">pkgPolicy</a> &Plcy, std::string Dir = <span class="stringliteral">""</span>);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classpkgPolicy_xhtml_a09125a1b5560d8c43c8e669560663a7d"><div class="ttname"><a href="classpkgPolicy.xhtml#a09125a1b5560d8c43c8e669560663a7d">pkgPolicy::pkgPolicy</a></div><div class="ttdeci">pkgPolicy(pkgCache *Owner)</div><div class="ttdef"><b>Definition:</b> policy.cc:47</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="classpkgCache_1_1VerIterator_xhtml"><div class="ttname"><a href="classpkgCache_1_1VerIterator.xhtml">pkgCache::VerIterator</a></div><div class="ttdef"><b>Definition:</b> cacheiterators.h:194</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="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="classpkgDepCache_1_1Policy_xhtml"><div class="ttname"><a href="classpkgDepCache_1_1Policy.xhtml">pkgDepCache::Policy</a></div><div class="ttdef"><b>Definition:</b> depcache.h:273</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="structpkgPolicy_1_1PkgPin_xhtml"><div class="ttname"><a href="structpkgPolicy_1_1PkgPin.xhtml">pkgPolicy::PkgPin</a></div><div class="ttdef"><b>Definition:</b> policy.h:59</div></div> <div class="ttc" id="structpkgPolicy_1_1Pin_xhtml"><div class="ttname"><a href="structpkgPolicy_1_1Pin.xhtml">pkgPolicy::Pin</a></div><div class="ttdef"><b>Definition:</b> policy.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>