<!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/contrib/progress.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><li class="navelem"><a class="el" href="dir_c6ef23f15b074dcedf6810e24f2a7676.xhtml">contrib</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">progress.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: progress.h,v 1.6 2001/05/07 05:06:52 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"> OpProgress - Operation Progress</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> </span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> This class allows lengthy operations to communicate their progress </span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> to the GUI. The progress model is simple and is not designed to handle</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> the complex case of the multi-activity acquire class.</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="comment"> The model is based on the concept of an overall operation consisting</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> of a series of small sub operations. Each sub operation has it's own</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> completion status and the overall operation has it's completion status.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> The units of the two are not mixed and are completely independent.</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"> The UI is expected to subclass this to provide the visuals to the user.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> </span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> ##################################################################### */</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="preprocessor">#ifndef PKGLIB_PROGRESS_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define PKGLIB_PROGRESS_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> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <sys/time.h></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <apt-pkg/macros.h></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="preprocessor">#ifndef APT_8_CLEANER_HEADERS</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">using</span> std::string;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span><a class="code" href="classConfiguration.xhtml">Configuration</a>;</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classOpProgress.xhtml"> 34</a></span> <span class="keyword">class </span><a class="code" href="classOpProgress.xhtml">OpProgress</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>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Current;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Total;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Size;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> SubTotal;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">float</span> LastPercent;</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="comment">// Change reduction code</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">struct </span>timeval LastTime;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  std::string LastOp;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  std::string LastSubOp;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">protected</span>:</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>  std::string Op;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  std::string SubOp;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">float</span> Percent;</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="keywordtype">bool</span> MajorChange;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">bool</span> CheckChange(<span class="keywordtype">float</span> Interval = 0.7); </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Update() {};</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">public</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> Progress(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Current);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">void</span> SubProgress(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> SubTotal, <span class="keyword">const</span> std::string &Op = <span class="stringliteral">""</span>, <span class="keywordtype">float</span> <span class="keyword">const</span> Percent = -1);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> OverallProgress(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Current,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Total,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Size,<span class="keyword">const</span> std::string &Op);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Done() {};</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classOpProgress.xhtml">OpProgress</a>();</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">virtual</span> ~<a class="code" href="classOpProgress.xhtml">OpProgress</a>() {};</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"><a class="line" href="classOpTextProgress.xhtml"> 70</a></span> <span class="keyword">class </span><a class="code" href="classOpTextProgress.xhtml">OpTextProgress</a> : <span class="keyword">public</span> <a class="code" href="classOpProgress.xhtml">OpProgress</a></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">protected</span>:</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>  std::string OldOp;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">bool</span> NoUpdate;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">bool</span> NoDisplay;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> LastLen;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Update() APT_OVERRIDE;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">void</span> Write(<span class="keyword">const</span> <span class="keywordtype">char</span> *S);</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">public</span>:</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Done() APT_OVERRIDE;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="classOpTextProgress.xhtml">OpTextProgress</a>(<span class="keywordtype">bool</span> NoUpdate = <span class="keyword">false</span>) : NoUpdate(NoUpdate), </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  NoDisplay(<span class="keyword">false</span>), LastLen(0) {};</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classOpTextProgress.xhtml">OpTextProgress</a>(<a class="code" href="classConfiguration.xhtml">Configuration</a> &Config);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> ~<a class="code" href="classOpTextProgress.xhtml">OpTextProgress</a>() {Done();};</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="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="classOpTextProgress_xhtml"><div class="ttname"><a href="classOpTextProgress.xhtml">OpTextProgress</a></div><div class="ttdef"><b>Definition:</b> progress.h:70</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><!-- 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>
