slv2-doc 0.6.6+dfsg1-3build1 / usr / share / doc / slv2 / collections_8h_source.html

This file is indexed.

/usr/share/doc/slv2/collections_8h_source.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
<!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.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 style="padding-left: 0.5em;">
   <div id="projectname">SLV2
   &#160;<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&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_43ce19c2fde330572805b23b6d868e0b.html">slv2</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">collections.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/* SLV2</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (C) 2008-2009 Dave Robillard &lt;http://drobilla.net&gt;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * This library is free software; you can redistribute it and/or modify it</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * under the terms of the GNU General Public License as published by the Free</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Software Foundation; either version 2 of the License, or (at your option)</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * any later version.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * This library is distributed in the hope that it will be useful, but WITHOUT</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * for more details.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * You should have received a copy of the GNU General Public License along</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#ifndef __SLV2_PLUGINS_H__</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#define __SLV2_PLUGINS_H__</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &quot;slv2/types.h&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &quot;slv2/value.h&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">/* **** GENERIC COLLECTION FUNCTIONS **** */</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">#define SLV2_COLLECTION(CollType, ElemType, prefix) \</span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="preprocessor">\</span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="preprocessor"> \</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">void \</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="preprocessor">prefix ## _free(CollType collection); \</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="preprocessor">\</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="preprocessor">\</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="preprocessor"> \</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor">unsigned \</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">prefix ## _size(CollType collection); \</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="preprocessor">\</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">\</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="preprocessor"> \</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="preprocessor">ElemType \</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="preprocessor">prefix ## _get_at(CollType collection, \</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="preprocessor">                  unsigned    index);</span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;SLV2_COLLECTION(SLV2PluginClasses, SLV2PluginClass, slv2_plugin_classes)</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;SLV2_COLLECTION(SLV2ScalePoints, SLV2ScalePoint, slv2_scale_points)</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;SLV2_COLLECTION(SLV2Values, SLV2Value, slv2_values)</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;SLV2_COLLECTION(SLV2UIs, SLV2UI, slv2_uis)</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment">/* **** PLUGINS **** */</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<a class="code" href="group__slv2__collections.html#ga35cd03984bd0691a0bc34bba236c630b">slv2_plugins_free</a>(SLV2World   world,</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;                  SLV2Plugins plugins);</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="keywordtype">unsigned</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<a class="code" href="group__slv2__collections.html#ga56153ceb788339033aa09608eca46970">slv2_plugins_size</a>(SLV2Plugins plugins);</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;SLV2Plugin</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<a class="code" href="group__slv2__collections.html#ga6d32f0d3ae66ba3e0b67a1d4866163cd">slv2_plugins_get_by_uri</a>(SLV2Plugins plugins,</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;                        SLV2Value   uri);</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;SLV2Plugin</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<a class="code" href="group__slv2__collections.html#gafd2c9e947e9c68c3451c6bb9e78aa330">slv2_plugins_get_at</a>(SLV2Plugins plugins,</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;                    <span class="keywordtype">unsigned</span>    index);</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment">/* **** PLUGIN CLASSES **** */</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;SLV2PluginClass</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<a class="code" href="group__slv2__collections.html#ga0e00631c2eb0015911193a3aefbd43ae">slv2_plugin_classes_get_by_uri</a>(SLV2PluginClasses classes,</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;                               SLV2Value         uri);</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment">/* **** SCALE POINTS **** */</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;SLV2ScalePoints</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<a class="code" href="group__slv2__collections.html#ga836dcd41f32fde088d3d3efae1014462">slv2_scale_points_new</a>();</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">/* **** VALUES **** */</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;SLV2Values</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<a class="code" href="group__slv2__collections.html#gaa1f3a520406557f1ed369e0d303c5294">slv2_values_new</a>();</div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="keywordtype">bool</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<a class="code" href="group__slv2__collections.html#ga388b3c593f35af97b3810ba9140cf96d">slv2_values_contains</a>(SLV2Values values, SLV2Value value);</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment">/* **** PLUGIN UIS **** */</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;SLV2UI</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;<a class="code" href="group__slv2__collections.html#ga934838df06bdcc0901412c4fa576e7de">slv2_uis_get_by_uri</a>(SLV2UIs   list,</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;                    SLV2Value uri);</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;} <span class="comment">/* extern &quot;C&quot; */</span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* __SLV2_COLLECTIONS_H__ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="group__slv2__collections_html_ga56153ceb788339033aa09608eca46970"><div class="ttname"><a href="group__slv2__collections.html#ga56153ceb788339033aa09608eca46970">slv2_plugins_size</a></div><div class="ttdeci">unsigned slv2_plugins_size(SLV2Plugins plugins)</div><div class="ttdoc">Get the number of plugins in the collection. </div></div>
<div class="ttc" id="group__slv2__collections_html_gafd2c9e947e9c68c3451c6bb9e78aa330"><div class="ttname"><a href="group__slv2__collections.html#gafd2c9e947e9c68c3451c6bb9e78aa330">slv2_plugins_get_at</a></div><div class="ttdeci">SLV2Plugin slv2_plugins_get_at(SLV2Plugins plugins, unsigned index)</div><div class="ttdoc">Get a plugin from the plugins by index. </div></div>
<div class="ttc" id="group__slv2__collections_html_ga6d32f0d3ae66ba3e0b67a1d4866163cd"><div class="ttname"><a href="group__slv2__collections.html#ga6d32f0d3ae66ba3e0b67a1d4866163cd">slv2_plugins_get_by_uri</a></div><div class="ttdeci">SLV2Plugin slv2_plugins_get_by_uri(SLV2Plugins plugins, SLV2Value uri)</div><div class="ttdoc">Get a plugin from the collection by URI. </div></div>
<div class="ttc" id="group__slv2__collections_html_ga0e00631c2eb0015911193a3aefbd43ae"><div class="ttname"><a href="group__slv2__collections.html#ga0e00631c2eb0015911193a3aefbd43ae">slv2_plugin_classes_get_by_uri</a></div><div class="ttdeci">SLV2PluginClass slv2_plugin_classes_get_by_uri(SLV2PluginClasses classes, SLV2Value uri)</div><div class="ttdoc">Get a plugin class from the collection by URI. </div></div>
<div class="ttc" id="group__slv2__collections_html_ga35cd03984bd0691a0bc34bba236c630b"><div class="ttname"><a href="group__slv2__collections.html#ga35cd03984bd0691a0bc34bba236c630b">slv2_plugins_free</a></div><div class="ttdeci">void slv2_plugins_free(SLV2World world, SLV2Plugins plugins)</div><div class="ttdoc">Free a plugin collection. </div></div>
<div class="ttc" id="group__slv2__collections_html_ga836dcd41f32fde088d3d3efae1014462"><div class="ttname"><a href="group__slv2__collections.html#ga836dcd41f32fde088d3d3efae1014462">slv2_scale_points_new</a></div><div class="ttdeci">SLV2ScalePoints slv2_scale_points_new()</div><div class="ttdoc">Allocate a new, empty SLV2ScalePoints. </div></div>
<div class="ttc" id="group__slv2__collections_html_ga934838df06bdcc0901412c4fa576e7de"><div class="ttname"><a href="group__slv2__collections.html#ga934838df06bdcc0901412c4fa576e7de">slv2_uis_get_by_uri</a></div><div class="ttdeci">SLV2UI slv2_uis_get_by_uri(SLV2UIs list, SLV2Value uri)</div><div class="ttdoc">Get a plugin from the list by URI. </div></div>
<div class="ttc" id="group__slv2__collections_html_ga388b3c593f35af97b3810ba9140cf96d"><div class="ttname"><a href="group__slv2__collections.html#ga388b3c593f35af97b3810ba9140cf96d">slv2_values_contains</a></div><div class="ttdeci">bool slv2_values_contains(SLV2Values values, SLV2Value value)</div><div class="ttdoc">Return whether values contains value. </div></div>
<div class="ttc" id="group__slv2__collections_html_gaa1f3a520406557f1ed369e0d303c5294"><div class="ttname"><a href="group__slv2__collections.html#gaa1f3a520406557f1ed369e0d303c5294">slv2_values_new</a></div><div class="ttdeci">SLV2Values slv2_values_new()</div><div class="ttdoc">Allocate a new, empty SLV2Values. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<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>

APT Browse - Built by Thomas Orozco.