<!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.8"/> <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  <span id="projectnumber">0.6.6</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <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 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 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> <span class="comment">/* SLV2</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2008-2009 Dave Robillard <http://drobilla.net></span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <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> <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> <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> <span class="comment"> * any later version.</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <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> <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> <span class="comment"> * for more details.</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <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> <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> <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> <span class="comment"> */</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef __SLV2_PLUGINS_H__</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define __SLV2_PLUGINS_H__</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "slv2/types.h"</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "slv2/value.h"</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/* **** GENERIC COLLECTION FUNCTIONS **** */</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#define SLV2_COLLECTION(CollType, ElemType, prefix) \</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">\</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"> \</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">void \</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">prefix ## _free(CollType collection); \</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">\</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">\</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"> \</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">unsigned \</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">prefix ## _size(CollType collection); \</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">\</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">\</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"> \</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">ElemType \</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">prefix ## _get_at(CollType collection, \</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> unsigned index);</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> SLV2_COLLECTION(SLV2PluginClasses, SLV2PluginClass, slv2_plugin_classes)</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> SLV2_COLLECTION(SLV2ScalePoints, SLV2ScalePoint, slv2_scale_points)</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> SLV2_COLLECTION(SLV2Values, SLV2Value, slv2_values)</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> SLV2_COLLECTION(SLV2UIs, SLV2UI, slv2_uis)</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> </div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/* **** PLUGINS **** */</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">void</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <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>  SLV2Plugins plugins);</div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">unsigned</span></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <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> </div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> SLV2Plugin</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <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>  SLV2Value uri);</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> SLV2Plugin</div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <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>  <span class="keywordtype">unsigned</span> index);</div> <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </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> </div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">/* **** PLUGIN CLASSES **** */</span></div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> SLV2PluginClass</div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <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>  SLV2Value uri);</div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div> <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div> <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">/* **** SCALE POINTS **** */</span></div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div> <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> SLV2ScalePoints</div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <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> </div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">/* **** VALUES **** */</span></div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> SLV2Values</div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <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> </div> <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="keywordtype">bool</span></div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <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> </div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment">/* **** PLUGIN UIS **** */</span></div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> SLV2UI</div> <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <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>  SLV2Value uri);</div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div> <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> } <span class="comment">/* extern "C" */</span></div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div> <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <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 on Sat Oct 18 2014 14:30:57 for SLV2 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.8 </small></address> </body> </html>