<!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/pkgrecords.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">pkgrecords.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: pkgrecords.h,v 1.6 2001/03/13 06:51:46 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"> Package Records - Allows access to complete package description records</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> directly from the file.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> </span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> The package record system abstracts the actual parsing of the </span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> package files. This is different than the generators parser in that</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> it is used to access information not generate information. No </span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> information touched by the generator should be parable from here as</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> it can always be retrieved directly from the cache.</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="comment">/*}}}*/</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef PKGLIB_PKGRECORDS_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define PKGLIB_PKGRECORDS_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <<a class="code" href="pkgcache_8h.xhtml">apt-pkg/pkgcache.h</a>></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <apt-pkg/hashes.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> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <vector></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"><a class="line" href="classpkgRecords.xhtml"> 27</a></span> <span class="keyword">class </span><a class="code" href="classpkgRecords.xhtml">pkgRecords</a> <span class="comment">/*{{{*/</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">class </span><a class="code" href="classpkgRecords_1_1Parser.xhtml">Parser</a>;</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">private</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">void</span> * <span class="keyword">const</span> d;</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>  <a class="code" href="classpkgCache.xhtml">pkgCache</a> &Cache;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  std::vector<Parser *>Files;</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="keyword">public</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// Lookup function</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classpkgRecords_1_1Parser.xhtml">Parser</a> &Lookup(<a class="code" href="classpkgCache_1_1VerFileIterator.xhtml">pkgCache::VerFileIterator</a> <span class="keyword">const</span> &Ver);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classpkgRecords_1_1Parser.xhtml">Parser</a> &Lookup(<a class="code" href="classpkgCache_1_1DescFileIterator.xhtml">pkgCache::DescFileIterator</a> <span class="keyword">const</span> &Desc);</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="comment">// Construct destruct</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">explicit</span> <a class="code" href="classpkgRecords.xhtml">pkgRecords</a>(<a class="code" href="classpkgCache.xhtml">pkgCache</a> &Cache);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpkgRecords.xhtml">pkgRecords</a>();</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">/*}}}*/</span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classpkgRecords_1_1Parser.xhtml"> 49</a></span> <span class="keyword">class </span><a class="code" href="classpkgRecords_1_1Parser.xhtml">pkgRecords::Parser</a> <span class="comment">/*{{{*/</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"> 51</span>  <span class="keyword">protected</span>:</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="keyword">virtual</span> <span class="keywordtype">bool</span> Jump(<a class="code" href="classpkgCache_1_1VerFileIterator.xhtml">pkgCache::VerFileIterator</a> <span class="keyword">const</span> &Ver) = 0;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Jump(<a class="code" href="classpkgCache_1_1DescFileIterator.xhtml">pkgCache::DescFileIterator</a> <span class="keyword">const</span> &Desc) = 0;</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>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classpkgRecords.xhtml">pkgRecords</a>;</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">// These refer to the archive file for the Version</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> std::string FileName() {<span class="keywordflow">return</span> std::string();};</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">virtual</span> std::string SourcePkg() {<span class="keywordflow">return</span> std::string();};</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">virtual</span> std::string SourceVer() {<span class="keywordflow">return</span> std::string();};</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classpkgRecords_1_1Parser.xhtml#aa2579392152f7476508b7bd4e96b7b6f"> 70</a></span>  <span class="keyword">virtual</span> <a class="code" href="classHashStringList.xhtml">HashStringList</a> <a class="code" href="classpkgRecords_1_1Parser.xhtml#aa2579392152f7476508b7bd4e96b7b6f">Hashes</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classHashStringList.xhtml">HashStringList</a>(); };</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  APT_DEPRECATED_MSG(<span class="stringliteral">"Use .Hashes instead of a hardcoded hash algorithm"</span>) std::string MD5Hash()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> GetHashFromHashes(<span class="stringliteral">"MD5Sum"</span>); };</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  APT_DEPRECATED_MSG(<span class="stringliteral">"Use .Hashes instead of a hardcoded hash algorithm"</span>) std::string SHA1Hash()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> GetHashFromHashes(<span class="stringliteral">"SHA1"</span>); };</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  APT_DEPRECATED_MSG(<span class="stringliteral">"Use .Hashes instead of a hardcoded hash algorithm"</span>) std::string SHA256Hash()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> GetHashFromHashes(<span class="stringliteral">"SHA256"</span>); };</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  APT_DEPRECATED_MSG(<span class="stringliteral">"Use .Hashes instead of a hardcoded hash algorithm"</span>) std::string SHA512Hash()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> GetHashFromHashes(<span class="stringliteral">"SHA512"</span>); };</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">// These are some general stats about the package</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> std::string Maintainer() {<span class="keywordflow">return</span> std::string();};</div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classpkgRecords_1_1Parser.xhtml#a8d7d6c2367bd5d19f6597daf75a212a7"> 82</a></span>  <span class="keyword">virtual</span> std::string <a class="code" href="classpkgRecords_1_1Parser.xhtml#a8d7d6c2367bd5d19f6597daf75a212a7">ShortDesc</a>(std::string <span class="keyword">const</span> &<span class="comment">/*lang*/</span>) {<span class="keywordflow">return</span> std::string();};</div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classpkgRecords_1_1Parser.xhtml#a38f09c07085c8a7422ea5a344ccc0084"> 90</a></span>  <span class="keyword">virtual</span> std::string <a class="code" href="classpkgRecords_1_1Parser.xhtml#a38f09c07085c8a7422ea5a344ccc0084">LongDesc</a>(std::string <span class="keyword">const</span> &<span class="comment">/*lang*/</span>) {<span class="keywordflow">return</span> std::string();};</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  std::string <a class="code" href="classpkgRecords_1_1Parser.xhtml#a8d7d6c2367bd5d19f6597daf75a212a7">ShortDesc</a>() {<span class="keywordflow">return</span> <a class="code" href="classpkgRecords_1_1Parser.xhtml#a8d7d6c2367bd5d19f6597daf75a212a7">ShortDesc</a>(<span class="stringliteral">""</span>);};</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  std::string <a class="code" href="classpkgRecords_1_1Parser.xhtml#a38f09c07085c8a7422ea5a344ccc0084">LongDesc</a>() {<span class="keywordflow">return</span> <a class="code" href="classpkgRecords_1_1Parser.xhtml#a38f09c07085c8a7422ea5a344ccc0084">LongDesc</a>(<span class="stringliteral">""</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="keyword">virtual</span> std::string Name() {<span class="keywordflow">return</span> std::string();};</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">virtual</span> std::string Homepage() {<span class="keywordflow">return</span> std::string();}</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="comment">// An arbitrary custom field</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">virtual</span> std::string RecordField(<span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="comment">/*fieldName*/</span>) { <span class="keywordflow">return</span> std::string();};</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// The record in binary form</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> GetRec(<span class="keyword">const</span> <span class="keywordtype">char</span> *&Start,<span class="keyword">const</span> <span class="keywordtype">char</span> *&Stop) {Start = Stop = 0;};</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>  <a class="code" href="classpkgRecords_1_1Parser.xhtml">Parser</a>();</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpkgRecords_1_1Parser.xhtml">Parser</a>();</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">void</span> * <span class="keyword">const</span> d;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  APT_HIDDEN std::string GetHashFromHashes(<span class="keywordtype">char</span> <span class="keyword">const</span> * <span class="keyword">const</span> type)<span class="keyword"> const</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <a class="code" href="classHashStringList.xhtml">HashStringList</a> <span class="keyword">const</span> hashes = <a class="code" href="classpkgRecords_1_1Parser.xhtml#aa2579392152f7476508b7bd4e96b7b6f">Hashes</a>();</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classHashString.xhtml">HashString</a> <span class="keyword">const</span> * <span class="keyword">const</span> hs = hashes.<a class="code" href="classHashStringList.xhtml#a6af9b51411b3a757213e4c0f7b4a25b9">find</a>(type);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordflow">return</span> hs != NULL ? hs->HashValue() : <span class="stringliteral">""</span>;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  };</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> };</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="comment">/*}}}*/</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</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="classpkgRecords_1_1Parser_xhtml_aa2579392152f7476508b7bd4e96b7b6f"><div class="ttname"><a href="classpkgRecords_1_1Parser.xhtml#aa2579392152f7476508b7bd4e96b7b6f">pkgRecords::Parser::Hashes</a></div><div class="ttdeci">virtual HashStringList Hashes() const</div><div class="ttdef"><b>Definition:</b> pkgrecords.h:70</div></div>
<div class="ttc" id="classpkgRecords_1_1Parser_xhtml_a38f09c07085c8a7422ea5a344ccc0084"><div class="ttname"><a href="classpkgRecords_1_1Parser.xhtml#a38f09c07085c8a7422ea5a344ccc0084">pkgRecords::Parser::LongDesc</a></div><div class="ttdeci">virtual std::string LongDesc(std::string const &)</div><div class="ttdef"><b>Definition:</b> pkgrecords.h:90</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="classpkgRecords_1_1Parser_xhtml_a8d7d6c2367bd5d19f6597daf75a212a7"><div class="ttname"><a href="classpkgRecords_1_1Parser.xhtml#a8d7d6c2367bd5d19f6597daf75a212a7">pkgRecords::Parser::ShortDesc</a></div><div class="ttdeci">virtual std::string ShortDesc(std::string const &)</div><div class="ttdef"><b>Definition:</b> pkgrecords.h:82</div></div>
<div class="ttc" id="classHashStringList_xhtml_a6af9b51411b3a757213e4c0f7b4a25b9"><div class="ttname"><a href="classHashStringList.xhtml#a6af9b51411b3a757213e4c0f7b4a25b9">HashStringList::find</a></div><div class="ttdeci">HashString const * find(char const *const type) const</div><div class="ttdef"><b>Definition:</b> hashes.cc:181</div></div>
<div class="ttc" id="classpkgRecords_xhtml"><div class="ttname"><a href="classpkgRecords.xhtml">pkgRecords</a></div><div class="ttdef"><b>Definition:</b> pkgrecords.h:27</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_1DescFileIterator_xhtml"><div class="ttname"><a href="classpkgCache_1_1DescFileIterator.xhtml">pkgCache::DescFileIterator</a></div><div class="ttdef"><b>Definition:</b> cacheiterators.h:486</div></div>
<div class="ttc" id="classHashString_xhtml"><div class="ttname"><a href="classHashString.xhtml">HashString</a></div><div class="ttdef"><b>Definition:</b> hashes.h:40</div></div>
<div class="ttc" id="classpkgCache_1_1VerFileIterator_xhtml"><div class="ttname"><a href="classpkgCache_1_1VerFileIterator.xhtml">pkgCache::VerFileIterator</a></div><div class="ttdef"><b>Definition:</b> cacheiterators.h:468</div></div>
<div class="ttc" id="classpkgRecords_1_1Parser_xhtml"><div class="ttname"><a href="classpkgRecords_1_1Parser.xhtml">pkgRecords::Parser</a></div><div class="ttdef"><b>Definition:</b> pkgrecords.h:49</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>
