<!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/cdrom.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">cdrom.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="preprocessor">#ifndef PKGLIB_CDROM_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PKGLIB_CDROM_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <apt-pkg/macros.h></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include<string></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include<vector></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <stddef.h></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#ifndef APT_8_CLEANER_HEADERS</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <apt-pkg/init.h></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">using namespace </span><a class="code" href="namespacestd.xhtml">std</a>;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">class </span><a class="code" href="classConfiguration.xhtml">Configuration</a>;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">class </span><a class="code" href="classOpProgress.xhtml">OpProgress</a>;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classpkgCdromStatus.xhtml"> 19</a></span> <span class="keyword">class </span><a class="code" href="classpkgCdromStatus.xhtml">pkgCdromStatus</a> <span class="comment">/*{{{*/</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="keywordtype">void</span> * <span class="keyword">const</span> d;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordtype">int</span> totalSteps;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="classpkgCdromStatus.xhtml">pkgCdromStatus</a>();</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpkgCdromStatus.xhtml">pkgCdromStatus</a>();</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="comment">// total steps</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetTotal(<span class="keywordtype">int</span> total) { totalSteps = total; };</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// update steps, will be called regularly as a "pulse"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Update(std::string text=<span class="stringliteral">""</span>, <span class="keywordtype">int</span> current=0) = 0;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// ask for cdrom insert</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ChangeCdrom() = 0;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">// ask for cdrom name</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> AskCdromName(std::string &Name) = 0;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// Progress indicator for the Index rewriter</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">virtual</span> <a class="code" href="classOpProgress.xhtml">OpProgress</a>* GetOpProgress() {<span class="keywordflow">return</span> NULL; };</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> };</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">/*}}}*/</span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classpkgCdrom.xhtml"> 42</a></span> <span class="keyword">class </span><a class="code" href="classpkgCdrom.xhtml">pkgCdrom</a> <span class="comment">/*{{{*/</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="keyword">protected</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">enum</span> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  STEP_PREPARE = 1,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  STEP_UNMOUNT,</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  STEP_WAIT,</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  STEP_MOUNT,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  STEP_IDENT,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  STEP_SCAN,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  STEP_COPY,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  STEP_WRITE,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  STEP_UNMOUNT3,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  STEP_LAST</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> </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="keywordtype">bool</span> FindPackages(std::string CD,</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  std::vector<std::string> &List,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  std::vector<std::string> &SList, </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  std::vector<std::string> &SigList,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  std::vector<std::string> &TransList,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  std::string &InfoDir, <a class="code" href="classpkgCdromStatus.xhtml">pkgCdromStatus</a> *log,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Depth = 0);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">bool</span> DropBinaryArch(std::vector<std::string> &List);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">bool</span> DropRepeats(std::vector<std::string> &List,<span class="keyword">const</span> <span class="keywordtype">char</span> *Name);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">bool</span> DropTranslation(std::vector<std::string> &List);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">void</span> ReduceSourcelist(std::string CD,std::vector<std::string> &List);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">bool</span> WriteDatabase(<a class="code" href="classConfiguration.xhtml">Configuration</a> &Cnf);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">bool</span> WriteSourceList(std::string Name,std::vector<std::string> &List,<span class="keywordtype">bool</span> Source);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">int</span> Score(std::string Path);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">bool</span> Ident(std::string &ident, <a class="code" href="classpkgCdromStatus.xhtml">pkgCdromStatus</a> *log);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">bool</span> Add(<a class="code" href="classpkgCdromStatus.xhtml">pkgCdromStatus</a> *log);</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>  <a class="code" href="classpkgCdrom.xhtml">pkgCdrom</a>();</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpkgCdrom.xhtml">pkgCdrom</a>();</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> * <span class="keyword">const</span> d;</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>  APT_HIDDEN <span class="keywordtype">bool</span> MountAndIdentCDROM(<a class="code" href="classConfiguration.xhtml">Configuration</a> &Database, std::string &CDROM,</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  std::string &ident, <a class="code" href="classpkgCdromStatus.xhtml">pkgCdromStatus</a> * <span class="keyword">const</span> log, <span class="keywordtype">bool</span> <span class="keyword">const</span> interactive);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  APT_HIDDEN <span class="keywordtype">bool</span> UnmountCDROM(std::string <span class="keyword">const</span> &CDROM, <a class="code" href="classpkgCdromStatus.xhtml">pkgCdromStatus</a> * <span class="keyword">const</span> log);</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="comment">/*}}}*/</span></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> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// class that uses libudev to find cdrom/removable devices dynamically</span></div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="structCdromDevice.xhtml"> 92</a></span> <span class="keyword">struct </span><a class="code" href="structCdromDevice.xhtml">CdromDevice</a> <span class="comment">/*{{{*/</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>  std::string DeviceName;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">bool</span> Mounted;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  std::string MountPath;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> };</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment">/*}}}*/</span></div><div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classpkgUdevCdromDevices.xhtml"> 99</a></span> <span class="keyword">class </span><a class="code" href="classpkgUdevCdromDevices.xhtml">pkgUdevCdromDevices</a> <span class="comment">/*{{{*/</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> {</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">void</span> * <span class="keyword">const</span> d;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">// libudev dlopen structure</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">void</span> *libudev_handle;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">struct </span>udev* (*udev_new)(void);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  int (*udev_enumerate_add_match_property)(<span class="keyword">struct </span>udev_enumerate *udev_enumerate, <span class="keyword">const</span> <span class="keywordtype">char</span> *property, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  int (*udev_enumerate_scan_devices)(<span class="keyword">struct </span>udev_enumerate *udev_enumerate);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">struct </span>udev_list_entry* (*udev_enumerate_get_list_entry)(<span class="keyword">struct </span>udev_enumerate *udev_enumerate);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">struct </span>udev_device* (*udev_device_new_from_syspath)(<span class="keyword">struct </span>udev *udev, <span class="keyword">const</span> <span class="keywordtype">char</span> *syspath);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">struct </span>udev* (*udev_enumerate_get_udev)(<span class="keyword">struct </span>udev_enumerate *udev_enumerate);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* (*udev_list_entry_get_name)(<span class="keyword">struct </span>udev_list_entry *list_entry);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* (*udev_device_get_devnode)(<span class="keyword">struct </span>udev_device *udev_device);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">struct </span>udev_enumerate *(*udev_enumerate_new) (<span class="keyword">struct </span>udev *udev);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">struct </span>udev_list_entry *(*udev_list_entry_get_next)(<span class="keyword">struct </span>udev_list_entry *list_entry);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* (*udev_device_get_property_value)(<span class="keyword">struct </span>udev_device *udev_device, <span class="keyword">const</span> <span class="keywordtype">char</span> *key);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  int (*udev_enumerate_add_match_sysattr)(<span class="keyword">struct </span>udev_enumerate *udev_enumerate, <span class="keyword">const</span> <span class="keywordtype">char</span> *property, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="comment">// end libudev dlopen</span></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>  <span class="keyword">public</span>:</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <a class="code" href="classpkgUdevCdromDevices.xhtml">pkgUdevCdromDevices</a>();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpkgUdevCdromDevices.xhtml">pkgUdevCdromDevices</a>();</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="comment">// try to open </span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">bool</span> Dlopen();</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>  <span class="comment">// convenience interface, this will just call ScanForRemovable</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="comment">// with "APT::cdrom::CdromOnly"</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  std::vector<CdromDevice> Scan();</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>  std::vector<CdromDevice> ScanForRemovable(<span class="keywordtype">bool</span> CdromOnly);</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> };</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="comment">/*}}}*/</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif</span></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="classpkgCdromStatus_xhtml"><div class="ttname"><a href="classpkgCdromStatus.xhtml">pkgCdromStatus</a></div><div class="ttdef"><b>Definition:</b> cdrom.h:19</div></div>
<div class="ttc" id="namespacestd_xhtml"><div class="ttname"><a href="namespacestd.xhtml">std</a></div><div class="ttdoc">STL namespace. </div></div>
<div class="ttc" id="structCdromDevice_xhtml"><div class="ttname"><a href="structCdromDevice.xhtml">CdromDevice</a></div><div class="ttdef"><b>Definition:</b> cdrom.h:92</div></div>
<div class="ttc" id="classpkgCdrom_xhtml"><div class="ttname"><a href="classpkgCdrom.xhtml">pkgCdrom</a></div><div class="ttdef"><b>Definition:</b> cdrom.h:42</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="classpkgUdevCdromDevices_xhtml"><div class="ttname"><a href="classpkgUdevCdromDevices.xhtml">pkgUdevCdromDevices</a></div><div class="ttdef"><b>Definition:</b> cdrom.h:99</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>
