/usr/share/doc/slv2/group__slv2__collections.html is in slv2-doc 0.6.6+dfsg1-3build1.
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 | <!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.9.1"/>
<title>SLV2: Collections of values/objects</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 style="padding-left: 0.5em;">
<div id="projectname">SLV2
 <span id="projectnumber">0.6.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Collections of values/objects</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga35cd03984bd0691a0bc34bba236c630b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga35cd03984bd0691a0bc34bba236c630b">slv2_plugins_free</a> (SLV2World world, SLV2Plugins plugins)</td></tr>
<tr class="separator:ga35cd03984bd0691a0bc34bba236c630b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga56153ceb788339033aa09608eca46970"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga56153ceb788339033aa09608eca46970">slv2_plugins_size</a> (SLV2Plugins plugins)</td></tr>
<tr class="separator:ga56153ceb788339033aa09608eca46970"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6d32f0d3ae66ba3e0b67a1d4866163cd"><td class="memItemLeft" align="right" valign="top">SLV2Plugin </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga6d32f0d3ae66ba3e0b67a1d4866163cd">slv2_plugins_get_by_uri</a> (SLV2Plugins plugins, SLV2Value uri)</td></tr>
<tr class="separator:ga6d32f0d3ae66ba3e0b67a1d4866163cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafd2c9e947e9c68c3451c6bb9e78aa330"><td class="memItemLeft" align="right" valign="top">SLV2Plugin </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#gafd2c9e947e9c68c3451c6bb9e78aa330">slv2_plugins_get_at</a> (SLV2Plugins plugins, unsigned index)</td></tr>
<tr class="separator:gafd2c9e947e9c68c3451c6bb9e78aa330"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0e00631c2eb0015911193a3aefbd43ae"><td class="memItemLeft" align="right" valign="top">SLV2PluginClass </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga0e00631c2eb0015911193a3aefbd43ae">slv2_plugin_classes_get_by_uri</a> (SLV2PluginClasses classes, SLV2Value uri)</td></tr>
<tr class="separator:ga0e00631c2eb0015911193a3aefbd43ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga388b3c593f35af97b3810ba9140cf96d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga388b3c593f35af97b3810ba9140cf96d">slv2_values_contains</a> (SLV2Values values, SLV2Value value)</td></tr>
<tr class="separator:ga388b3c593f35af97b3810ba9140cf96d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga934838df06bdcc0901412c4fa576e7de"><td class="memItemLeft" align="right" valign="top">SLV2UI </td><td class="memItemRight" valign="bottom"><a class="el" href="group__slv2__collections.html#ga934838df06bdcc0901412c4fa576e7de">slv2_uis_get_by_uri</a> (SLV2UIs list, SLV2Value uri)</td></tr>
<tr class="separator:ga934838df06bdcc0901412c4fa576e7de"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>a fancy array). </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga35cd03984bd0691a0bc34bba236c630b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void slv2_plugins_free </td>
<td>(</td>
<td class="paramtype">SLV2World </td>
<td class="paramname"><em>world</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SLV2Plugins </td>
<td class="paramname"><em>plugins</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a plugin collection. </p>
<p>Freeing a plugin collection does not destroy the plugins it contains (plugins are owned by the world). <em>plugins</em> is invalid after this call. Time = O(1) </p>
</div>
</div>
<a class="anchor" id="ga56153ceb788339033aa09608eca46970"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned slv2_plugins_size </td>
<td>(</td>
<td class="paramtype">SLV2Plugins </td>
<td class="paramname"><em>plugins</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of plugins in the collection. </p>
<p>Time = O(1) </p>
</div>
</div>
<a class="anchor" id="ga6d32f0d3ae66ba3e0b67a1d4866163cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SLV2Plugin slv2_plugins_get_by_uri </td>
<td>(</td>
<td class="paramtype">SLV2Plugins </td>
<td class="paramname"><em>plugins</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SLV2Value </td>
<td class="paramname"><em>uri</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a plugin from the collection by URI. </p>
<p>Return value is shared (stored in <em>plugins</em>) and must not be freed or modified by the caller in any way.</p>
<p>Time = O(log2(n))</p>
<dl class="section return"><dt>Returns</dt><dd>NULL if plugin with <em>url</em> not found in <em>plugins</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="gafd2c9e947e9c68c3451c6bb9e78aa330"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SLV2Plugin slv2_plugins_get_at </td>
<td>(</td>
<td class="paramtype">SLV2Plugins </td>
<td class="paramname"><em>plugins</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a plugin from the plugins by index. </p>
<p><em>index</em> has no significance other than as an index into this plugins. Any <em>index</em> not less than slv2_plugins_get_length(plugins) will return NULL, so all plugins in a plugins can be enumerated by repeated calls to this function starting with <em>index</em> = 0.</p>
<p>Time = O(1)</p>
<dl class="section return"><dt>Returns</dt><dd>NULL if <em>index</em> out of range. </dd></dl>
</div>
</div>
<a class="anchor" id="ga0e00631c2eb0015911193a3aefbd43ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SLV2PluginClass slv2_plugin_classes_get_by_uri </td>
<td>(</td>
<td class="paramtype">SLV2PluginClasses </td>
<td class="paramname"><em>classes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SLV2Value </td>
<td class="paramname"><em>uri</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a plugin class from the collection by URI. </p>
<p>Return value is shared (stored in <em>classes</em>) and must not be freed or modified by the caller in any way.</p>
<p>Time = O(log2(n))</p>
<dl class="section return"><dt>Returns</dt><dd>NULL if plugin with <em>url</em> not found in <em>classes</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga388b3c593f35af97b3810ba9140cf96d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool slv2_values_contains </td>
<td>(</td>
<td class="paramtype">SLV2Values </td>
<td class="paramname"><em>values</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SLV2Value </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return whether <em>values</em> contains <em>value</em>. </p>
<p>Time = O(n) </p>
</div>
</div>
<a class="anchor" id="ga934838df06bdcc0901412c4fa576e7de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SLV2UI slv2_uis_get_by_uri </td>
<td>(</td>
<td class="paramtype">SLV2UIs </td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SLV2Value </td>
<td class="paramname"><em>uri</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a plugin from the list by URI. </p>
<p>Return value is shared (stored in <em>list</em>) and must not be freed or modified by the caller in any way.</p>
<p>Time = O(log2(n))</p>
<dl class="section return"><dt>Returns</dt><dd>NULL if plugin with <em>url</em> not found in <em>list</em>. </dd></dl>
</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.9.1
</small></address>
</body>
</html>
|