<!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/srcrecords.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">srcrecords.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"> Source Package Records - Allows access to source package records</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"> Parses and allows access to the list of source records and searching by</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> source name on that list.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> </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">/*}}}*/</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef PKGLIB_SRCRECORDS_H</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define PKGLIB_SRCRECORDS_H</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <apt-pkg/macros.h></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <apt-pkg/hashes.h></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <vector></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">#ifndef APT_8_CLEANER_HEADERS</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">using</span> std::string;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">using</span> std::vector;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#endif</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="keyword">class </span><a class="code" href="classpkgSourceList.xhtml">pkgSourceList</a>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">class </span><a class="code" href="classpkgIndexFile.xhtml">pkgIndexFile</a>;</div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classpkgSrcRecords.xhtml"> 28</a></span> <span class="keyword">class </span><a class="code" href="classpkgSrcRecords.xhtml">pkgSrcRecords</a></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">public</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> APT_IGNORE_DEPRECATED_PUSH</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// Describes a single file</span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structpkgSrcRecords_1_1File.xhtml"> 34</a></span>  <span class="keyword">struct </span><a class="code" href="structpkgSrcRecords_1_1File.xhtml">File</a></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  APT_DEPRECATED_MSG(<span class="stringliteral">"Use Hashes member instead of hardcoded hash algorithm"</span>) std::string MD5Hash;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  APT_DEPRECATED_MSG(<span class="stringliteral">"Use FileSize member instead"</span>) <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> Size;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  std::string Path;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  std::string Type;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  };</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structpkgSrcRecords_1_1File2.xhtml"> 41</a></span>  <span class="keyword">struct </span><a class="code" href="structpkgSrcRecords_1_1File2.xhtml">File2</a> : <span class="keyword">public</span> <a class="code" href="structpkgSrcRecords_1_1File.xhtml">File</a></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="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> FileSize;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classHashStringList.xhtml">HashStringList</a> <a class="code" href="classHashes.xhtml">Hashes</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  };</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> APT_IGNORE_DEPRECATED_POP</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="comment">// Abstract parser for each source record</span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classpkgSrcRecords_1_1Parser.xhtml"> 49</a></span>  <span class="keyword">class </span><a class="code" href="classpkgSrcRecords_1_1Parser.xhtml">Parser</a></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">void</span> * <span class="keyword">const</span> d;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">protected</span>:</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">const</span> <a class="code" href="classpkgIndexFile.xhtml">pkgIndexFile</a> *iIndex;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">public</span>:</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>  <span class="keyword">enum</span> BuildDep {BuildDepend=0x0,BuildDependIndep=0x1,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  BuildConflict=0x2,BuildConflictIndep=0x3,</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  BuildDependArch=0x4,BuildConflictArch=0x5};</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structpkgSrcRecords_1_1Parser_1_1BuildDepRec.xhtml"> 62</a></span>  <span class="keyword">struct </span><a class="code" href="structpkgSrcRecords_1_1Parser_1_1BuildDepRec.xhtml">BuildDepRec</a> </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>  std::string Package;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  std::string Version;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Op;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Type;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  };</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="classpkgIndexFile.xhtml">pkgIndexFile</a> &Index()<span class="keyword"> const </span>{<span class="keywordflow">return</span> *iIndex;};</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="keyword">virtual</span> <span class="keywordtype">bool</span> Restart() = 0;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Step() = 0;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Jump(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keyword">const</span> &Off) = 0;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> Offset() = 0;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">virtual</span> std::string AsStr() = 0;</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="keyword">virtual</span> std::string Package() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> std::string Version() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">virtual</span> std::string Maintainer() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">virtual</span> std::string Section() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> **Binaries() = 0; <span class="comment">// Ownership does not transfer</span></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">//FIXME: Add a parameter to specify which architecture to use for [wildcard] matching</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> BuildDepends(std::vector<BuildDepRec> &BuildDeps, <span class="keywordtype">bool</span> <span class="keyword">const</span> &ArchOnly, <span class="keywordtype">bool</span> <span class="keyword">const</span> &StripMultiArch = <span class="keyword">true</span>) = 0;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *BuildDepType(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="keyword">const</span> &Type) APT_PURE;</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">virtual</span> <span class="keywordtype">bool</span> Files(std::vector<pkgSrcRecords::File> &F) = 0;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">bool</span> Files2(std::vector<pkgSrcRecords::File2> &F);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">explicit</span> <a class="code" href="classpkgSrcRecords_1_1Parser.xhtml">Parser</a>(<span class="keyword">const</span> <a class="code" href="classpkgIndexFile.xhtml">pkgIndexFile</a> *Index);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpkgSrcRecords_1_1Parser.xhtml">Parser</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="keyword">private</span>:</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> * <span class="keyword">const</span> d;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="comment">// The list of files and the current parser pointer</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  std::vector<Parser*> Files;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  std::vector<Parser *>::iterator Current;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">// Reset the search</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">bool</span> Restart();</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="comment">// Step to the next SourcePackage and return pointer to the </span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="comment">// next SourceRecord. The pointer is owned by libapt.</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">const</span> <a class="code" href="classpkgSrcRecords_1_1Parser.xhtml">Parser</a>* Step();</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="comment">// Locate a package by name and return pointer to the Parser.</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="comment">// The pointer is owned by libapt.</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <a class="code" href="classpkgSrcRecords_1_1Parser.xhtml">Parser</a>* Find(<span class="keyword">const</span> <span class="keywordtype">char</span> *Package,<span class="keywordtype">bool</span> <span class="keyword">const</span> &SrcOnly = <span class="keyword">false</span>);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">explicit</span> <a class="code" href="classpkgSrcRecords.xhtml">pkgSrcRecords</a>(<a class="code" href="classpkgSourceList.xhtml">pkgSourceList</a> &List);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpkgSrcRecords.xhtml">pkgSrcRecords</a>();</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> };</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classHashStringList_xhtml"><div class="ttname"><a href="classHashStringList.xhtml">HashStringList</a></div><div class="ttdef"><b>Definition:</b> hashes.h:79</div></div>
<div class="ttc" id="structpkgSrcRecords_1_1File2_xhtml"><div class="ttname"><a href="structpkgSrcRecords_1_1File2.xhtml">pkgSrcRecords::File2</a></div><div class="ttdef"><b>Definition:</b> srcrecords.h:41</div></div>
<div class="ttc" id="classHashes_xhtml"><div class="ttname"><a href="classHashes.xhtml">Hashes</a></div><div class="ttdef"><b>Definition:</b> hashes.h:184</div></div>
<div class="ttc" id="classpkgSrcRecords_xhtml"><div class="ttname"><a href="classpkgSrcRecords.xhtml">pkgSrcRecords</a></div><div class="ttdef"><b>Definition:</b> srcrecords.h:28</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="classpkgSrcRecords_1_1Parser_xhtml"><div class="ttname"><a href="classpkgSrcRecords_1_1Parser.xhtml">pkgSrcRecords::Parser</a></div><div class="ttdef"><b>Definition:</b> srcrecords.h:49</div></div>
<div class="ttc" id="structpkgSrcRecords_1_1File_xhtml"><div class="ttname"><a href="structpkgSrcRecords_1_1File.xhtml">pkgSrcRecords::File</a></div><div class="ttdef"><b>Definition:</b> srcrecords.h:34</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 class="ttc" id="structpkgSrcRecords_1_1Parser_1_1BuildDepRec_xhtml"><div class="ttname"><a href="structpkgSrcRecords_1_1Parser_1_1BuildDepRec.xhtml">pkgSrcRecords::Parser::BuildDepRec</a></div><div class="ttdef"><b>Definition:</b> srcrecords.h:62</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>
