/usr/share/doc/libcupt4-doc/html/namespacecupt.html is in libcupt4-doc 2.10.0.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 | <!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>Cupt: cupt Namespace Reference</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">Cupt
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> |
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">cupt Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacecupt_1_1cache"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecupt_1_1cache.html">cache</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:namespacecupt_1_1download"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecupt_1_1download.html">download</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:namespacecupt_1_1system"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecupt_1_1system.html">system</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcupt_1_1Cache.html">Cache</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">the source of package and version information <a href="classcupt_1_1Cache.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcupt_1_1Config.html">Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">stores library's configuration variables <a href="classcupt_1_1Config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcupt_1_1Exception.html">Exception</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">general library exception class <a href="classcupt_1_1Exception.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcupt_1_1HashSums.html">HashSums</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">hash sums <a href="classcupt_1_1HashSums.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcupt_1_1Range.html">Range</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcupt_1_1StringRange.html">StringRange</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a2c2e33373863857990a70ede9e310f27"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecupt.html#a2c2e33373863857990a70ede9e310f27">__</a> (const char *message)</td></tr>
<tr class="memdesc:a2c2e33373863857990a70ede9e310f27"><td class="mdescLeft"> </td><td class="mdescRight">localizes message <a href="#a2c2e33373863857990a70ede9e310f27">More...</a><br /></td></tr>
<tr class="separator:a2c2e33373863857990a70ede9e310f27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af65b6005ac3e369624b7e37efc55db0b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecupt.html#af65b6005ac3e369624b7e37efc55db0b">consumePackageName</a> (const char *begin, const char *end, const char *&resultEnd)</td></tr>
<tr class="memdesc:af65b6005ac3e369624b7e37efc55db0b"><td class="mdescLeft"> </td><td class="mdescRight">reads package name in range <a href="#af65b6005ac3e369624b7e37efc55db0b">More...</a><br /></td></tr>
<tr class="separator:af65b6005ac3e369624b7e37efc55db0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b62f43df9b74fbaf647b8ea8b144e06"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecupt.html#a6b62f43df9b74fbaf647b8ea8b144e06">checkPackageName</a> (<a class="el" href="structcupt_1_1StringRange.html">StringRange</a> packageName, bool throwOnError=true)</td></tr>
<tr class="memdesc:a6b62f43df9b74fbaf647b8ea8b144e06"><td class="mdescLeft"> </td><td class="mdescRight">checks package name for correctness <a href="#a6b62f43df9b74fbaf647b8ea8b144e06">More...</a><br /></td></tr>
<tr class="separator:a6b62f43df9b74fbaf647b8ea8b144e06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae0935cae7f91c6339f030c49deb1337"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecupt.html#aae0935cae7f91c6339f030c49deb1337">checkVersionString</a> (const string &versionString, bool throwOnError=true)</td></tr>
<tr class="memdesc:aae0935cae7f91c6339f030c49deb1337"><td class="mdescLeft"> </td><td class="mdescRight">checks version string for correctness <a href="#aae0935cae7f91c6339f030c49deb1337">More...</a><br /></td></tr>
<tr class="separator:aae0935cae7f91c6339f030c49deb1337"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a655bf83fadbab4bd56ebccd87dfc0198"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecupt.html#a655bf83fadbab4bd56ebccd87dfc0198">compareVersionStrings</a> (const string &left, const string &right)</td></tr>
<tr class="memdesc:a655bf83fadbab4bd56ebccd87dfc0198"><td class="mdescLeft"> </td><td class="mdescRight">compares two version strings <a href="#a655bf83fadbab4bd56ebccd87dfc0198">More...</a><br /></td></tr>
<tr class="separator:a655bf83fadbab4bd56ebccd87dfc0198"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac120ab5eb7a980ec13d359959233bf55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcupt_1_1StringRange.html">StringRange</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecupt.html#ac120ab5eb7a980ec13d359959233bf55">getOriginalVersionString</a> (const <a class="el" href="structcupt_1_1StringRange.html">StringRange</a> &versionString)</td></tr>
<tr class="memdesc:ac120ab5eb7a980ec13d359959233bf55"><td class="mdescLeft"> </td><td class="mdescRight">gets the original part of possibly Cupt-modified version string <a href="#ac120ab5eb7a980ec13d359959233bf55">More...</a><br /></td></tr>
<tr class="separator:ac120ab5eb7a980ec13d359959233bf55"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a67a75837cbdb040bc53a80a75cbcd30d"><td class="memItemLeft" align="right" valign="top"><a id="a67a75837cbdb040bc53a80a75cbcd30d"></a>
const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecupt.html#a67a75837cbdb040bc53a80a75cbcd30d">libraryVersion</a></td></tr>
<tr class="memdesc:a67a75837cbdb040bc53a80a75cbcd30d"><td class="mdescLeft"> </td><td class="mdescRight">the version of Cupt library <br /></td></tr>
<tr class="separator:a67a75837cbdb040bc53a80a75cbcd30d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ab475a966187e7e6e24d3113c4d5437"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecupt.html#a7ab475a966187e7e6e24d3113c4d5437">messageFd</a></td></tr>
<tr class="memdesc:a7ab475a966187e7e6e24d3113c4d5437"><td class="mdescLeft"> </td><td class="mdescRight">message file descriptor <a href="#a7ab475a966187e7e6e24d3113c4d5437">More...</a><br /></td></tr>
<tr class="separator:a7ab475a966187e7e6e24d3113c4d5437"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"></div><h2 class="groupheader">Function Documentation</h2>
<a id="a2c2e33373863857990a70ede9e310f27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c2e33373863857990a70ede9e310f27">◆ </a></span>__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* cupt::__ </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>localizes message </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>input string </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>localized message </dd></dl>
</div>
</div>
<a id="a6b62f43df9b74fbaf647b8ea8b144e06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b62f43df9b74fbaf647b8ea8b144e06">◆ </a></span>checkPackageName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cupt::checkPackageName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcupt_1_1StringRange.html">StringRange</a> </td>
<td class="paramname"><em>packageName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>throwOnError</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>checks package name for correctness </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">packageName</td><td>package name </td></tr>
<tr><td class="paramname">throwOnError</td><td>if set to <code>true</code>, function will throw exception if <em>packageName</em> is not correct </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the <em>packageName</em> is correct, <code>false</code> if <em>packageName</em> is not correct and <em>throwOnError</em> is <code>false</code> </dd></dl>
</div>
</div>
<a id="aae0935cae7f91c6339f030c49deb1337"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae0935cae7f91c6339f030c49deb1337">◆ </a></span>checkVersionString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cupt::checkVersionString </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>versionString</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>throwOnError</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>checks version string for correctness </p>
<p>Equal to <a class="el" href="namespacecupt.html#a6b62f43df9b74fbaf647b8ea8b144e06">checkPackageName</a>, only checks version string instead of package name </p>
</div>
</div>
<a id="a655bf83fadbab4bd56ebccd87dfc0198"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a655bf83fadbab4bd56ebccd87dfc0198">◆ </a></span>compareVersionStrings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cupt::compareVersionStrings </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"><em>right</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>compares two version strings </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">left</td><td>left version string </td></tr>
<tr><td class="paramname">right</td><td>right version string </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>-1</code>, if <em>left</em> <code><</code> <em>right</em>, <code>0</code> if <em>left</em> <code>==</code> <em>right</em>, <code>1</code> if <em>left</em> <code>></code> <em>right</em> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The version strings may be logically equal even if they are not physically equal. Unless you are comparing version strings that belong to the same <a class="el" href="classcupt_1_1cache_1_1Package.html" title="a container for all versions of the same package name ">cache::Package</a>, you should use this function to test their equality. </dd></dl>
</div>
</div>
<a id="af65b6005ac3e369624b7e37efc55db0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af65b6005ac3e369624b7e37efc55db0b">◆ </a></span>consumePackageName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void cupt::consumePackageName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *& </td>
<td class="paramname"><em>resultEnd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>reads package name in range </p>
<p>Tries to read as more characters as possible from the <em>begin</em>, which form a valid package name, until <em>end</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">begin</td><td>range begin iterator </td></tr>
<tr><td class="paramdir"></td><td class="paramname">end</td><td>range end iterator </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">resultEnd</td><td>consumed range end iterator</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">string</span> input = <span class="stringliteral">"zzuf (>= 1.2)"</span>;</div><div class="line">string::const_iterator resultEnd;</div><div class="line"><a class="code" href="namespacecupt.html#af65b6005ac3e369624b7e37efc55db0b">consumePackageName</a>(input.begin(), input.end(), resultEnd);</div><div class="line">cout << string(input.begin(), resultEnd) << endl;</div></div><!-- fragment --> <code>"zzuf"</code> will be printed </dd></dl>
</div>
</div>
<a id="ac120ab5eb7a980ec13d359959233bf55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac120ab5eb7a980ec13d359959233bf55">◆ </a></span>getOriginalVersionString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcupt_1_1StringRange.html">StringRange</a> cupt::getOriginalVersionString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structcupt_1_1StringRange.html">StringRange</a> & </td>
<td class="paramname"><em>versionString</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets the original part of possibly Cupt-modified version string </p>
<p>Cupt may apply Cupt-specific id suffixes to original version strings for its own use, mainly for distinguishing version which declare same version strings in the metadata but (possibly) having different content.</p>
<p>This function tells the version string as it was seen in the metadata.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">versionString</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a7ab475a966187e7e6e24d3113c4d5437"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ab475a966187e7e6e24d3113c4d5437">◆ </a></span>messageFd</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cupt::messageFd</td>
</tr>
</table>
</div><div class="memdoc">
<p>message file descriptor </p>
<p>All library error, warning, debug and simulate messages will be pointed here. If <em>messageFd</em> <code>==</code> <code>-1</code>, messages will be suppressed. Defaults to <code>-1</code>. </p>
</div>
</div>
</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>
|