Mercurial > hg > vamp-docs

annotate code-docs/plugguard_8h.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@1 6 <title>VampPluginSDK: plugguard.h File Reference</title>
Chris@1 7
Chris@1 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 11 <script type="text/javascript" src="jquery.js"></script>
Chris@1 12 <script type="text/javascript" src="resize.js"></script>
Chris@1 13 <script type="text/javascript" src="navtree.js"></script>
Chris@1 14 <script type="text/javascript">
Chris@1 15 $(document).ready(initResizable);
Chris@1 16 </script>
Chris@1 17
Chris@1 18
Chris@1 19 </head>
Chris@1 20 <body>
Chris@1 21 <div id="top"><!-- do not remove this div! -->
Chris@1 22
Chris@1 23
Chris@1 24 <div id="titlearea">
Chris@1 25 <table cellspacing="0" cellpadding="0">
Chris@1 26 <tbody>
Chris@1 27 <tr style="height: 56px;">
Chris@1 28
Chris@1 29
Chris@1 30 <td style="padding-left: 0.5em;">
Chris@1 31 <div id="projectname">VampPluginSDK
Chris@3 32 &#160;<span id="projectnumber">2.4</span>
Chris@1 33 </div>
Chris@1 34
Chris@1 35 </td>
Chris@1 36
Chris@1 37
Chris@1 38
Chris@1 39 </tr>
Chris@1 40 </tbody>
Chris@1 41 </table>
Chris@1 42 </div>
Chris@1 43
Chris@3 44 <!-- Generated by Doxygen 1.8.0 -->
Chris@1 45 <div id="navrow1" class="tabs">
Chris@1 46 <ul class="tablist">
Chris@1 47 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 49 <li><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 50 <li class="current"><a href="files.html"><span>Files</span></a></li>
Chris@1 51 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 52 </ul>
Chris@1 53 </div>
Chris@1 54 <div id="navrow2" class="tabs2">
Chris@1 55 <ul class="tablist">
Chris@1 56 <li><a href="files.html"><span>File&#160;List</span></a></li>
Chris@1 57 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
Chris@1 58 </ul>
Chris@1 59 </div>
Chris@1 60 </div>
Chris@1 61 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 62 <div id="nav-tree">
Chris@1 63 <div id="nav-tree-contents">
Chris@1 64 </div>
Chris@1 65 </div>
Chris@1 66 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 67 class="ui-resizable-handle">
Chris@1 68 </div>
Chris@1 69 </div>
Chris@1 70 <script type="text/javascript">
Chris@1 71 initNavTree('plugguard_8h.html','');
Chris@1 72 </script>
Chris@1 73 <div id="doc-content">
Chris@1 74 <div class="header">
Chris@1 75 <div class="summary">
Chris@1 76 <a href="#define-members">Defines</a> </div>
Chris@1 77 <div class="headertitle">
Chris@1 78 <div class="title">plugguard.h File Reference</div> </div>
Chris@3 79 </div><!--header-->
Chris@1 80 <div class="contents">
Chris@1 81
Chris@1 82 <p><a href="plugguard_8h_source.html">Go to the source code of this file.</a></p>
Chris@1 83 <table class="memberdecls">
Chris@1 84 <tr><td colspan="2"><h2><a name="define-members"></a>
Chris@1 85 Defines</h2></td></tr>
Chris@3 86 <tr class="memitem:a3bf4e97f131677e5e1505a7a9582d68a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#a3bf4e97f131677e5e1505a7a9582d68a">_VAMP_IN_PLUGINSDK</a>&#160;&#160;&#160;1</td></tr>
Chris@3 87 <tr class="memdesc:a3bf4e97f131677e5e1505a7a9582d68a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normal usage should be: <a href="#a3bf4e97f131677e5e1505a7a9582d68a"></a><br/></td></tr>
Chris@3 88 <tr class="memitem:a9b7a8e1ac1c91366bec5f2f33c137a2f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#a9b7a8e1ac1c91366bec5f2f33c137a2f">VAMP_SDK_VERSION</a>&#160;&#160;&#160;&quot;2.4&quot;</td></tr>
Chris@3 89 <tr class="memitem:ab5f7da6acf45065a6c7b7cd38a0bf588"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#ab5f7da6acf45065a6c7b7cd38a0bf588">VAMP_SDK_MAJOR_VERSION</a>&#160;&#160;&#160;2</td></tr>
Chris@3 90 <tr class="memitem:ad5eef1e2154b42769cd642d2a1d42257"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#ad5eef1e2154b42769cd642d2a1d42257">VAMP_SDK_MINOR_VERSION</a>&#160;&#160;&#160;4</td></tr>
Chris@3 91 <tr class="memitem:a1a2724ea453971288d3218e4eab3072c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(h)</td></tr>
Chris@3 92 <tr class="memitem:ac879bb1077ecc6132ea3581ef9033753"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(h)</td></tr>
Chris@1 93 </table>
Chris@1 94 <hr/><h2>Define Documentation</h2>
Chris@3 95 <a class="anchor" id="a3bf4e97f131677e5e1505a7a9582d68a"></a>
Chris@1 96 <div class="memitem">
Chris@1 97 <div class="memproto">
Chris@1 98 <table class="memname">
Chris@1 99 <tr>
Chris@3 100 <td class="memname">#define <a class="el" href="plugguard_8h.html#a3bf4e97f131677e5e1505a7a9582d68a">_VAMP_IN_PLUGINSDK</a>&#160;&#160;&#160;1</td>
Chris@1 101 </tr>
Chris@1 102 </table>
Chris@1 103 </div>
Chris@1 104 <div class="memdoc">
Chris@1 105
Chris@1 106 <p>Normal usage should be: </p>
Chris@1 107 <ul>
Chris@1 108 <li>Plugins include <a class="el" href="vamp-sdk_2Plugin_8h.html">vamp-sdk/Plugin.h</a> or <a class="el" href="vamp-sdk_2PluginBase_8h.html">vamp-sdk/PluginBase.h</a>. These files include this header, which specifies an appropriate namespace for the plugin classes to avoid any risk of conflict with non-plugin class implementations in the host on load.</li>
Chris@1 109 </ul>
Chris@1 110 <ul>
Chris@1 111 <li>Hosts include <a class="el" href="vamp-hostsdk_2Plugin_8h.html">vamp-hostsdk/Plugin.h</a>, <a class="el" href="vamp-hostsdk_2PluginBase_8h.html">vamp-hostsdk/PluginBase.h</a>, vamp-hostsdk/PluginHostAdapter, <a class="el" href="PluginLoader_8h.html">vamp-hostsdk/PluginLoader.h</a> etc. These files include <a class="el" href="hostguard_8h.html">vamp-hostsdk/hostguard.h</a>, which makes a note that we are in a host. A file such as <a class="el" href="vamp-hostsdk_2Plugin_8h.html">vamp-hostsdk/Plugin.h</a> then simply includes <a class="el" href="vamp-sdk_2Plugin_8h.html">vamp-sdk/Plugin.h</a>, and this guard header takes notice of the fact that it has been included from a host and leaves the plugin namespace unset.</li>
Chris@1 112 </ul>
Chris@1 113 <p>Problems will occur when a host includes files directly from the vamp-sdk directory. There are two reasons this might happen: mistake, perhaps owing to ignorance of the fact that this isn't allowed (particularly since it was the normal mechanism in v1 of the SDK); and a wish to incorporate plugin code directly into the host rather than having to load it.</p>
Chris@1 114 <p>What if the host does include a vamp-sdk header by mistake? We can catch it if it's included before something from vamp-hostsdk. If it's included after something from vamp-hostsdk, it will work OK anyway. The remaining problem case is where nothing from vamp-hostsdk is included in the same file. We can't catch that. </p>
Chris@1 115
Chris@1 116 <p>Definition at line <a class="el" href="plugguard_8h_source.html#l00072">72</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@1 117
Chris@1 118 </div>
Chris@1 119 </div>
Chris@3 120 <a class="anchor" id="a9b7a8e1ac1c91366bec5f2f33c137a2f"></a>
Chris@1 121 <div class="memitem">
Chris@1 122 <div class="memproto">
Chris@1 123 <table class="memname">
Chris@1 124 <tr>
Chris@3 125 <td class="memname">#define <a class="el" href="hostguard_8h.html#a9b7a8e1ac1c91366bec5f2f33c137a2f">VAMP_SDK_VERSION</a>&#160;&#160;&#160;&quot;2.4&quot;</td>
Chris@3 126 </tr>
Chris@3 127 </table>
Chris@3 128 </div>
Chris@3 129 <div class="memdoc">
Chris@3 130
Chris@3 131 <p>Definition at line <a class="el" href="plugguard_8h_source.html#l00074">74</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@3 132
Chris@3 133 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00137">main()</a>.</p>
Chris@3 134
Chris@3 135 </div>
Chris@3 136 </div>
Chris@3 137 <a class="anchor" id="ab5f7da6acf45065a6c7b7cd38a0bf588"></a>
Chris@3 138 <div class="memitem">
Chris@3 139 <div class="memproto">
Chris@3 140 <table class="memname">
Chris@3 141 <tr>
Chris@3 142 <td class="memname">#define <a class="el" href="hostguard_8h.html#ab5f7da6acf45065a6c7b7cd38a0bf588">VAMP_SDK_MAJOR_VERSION</a>&#160;&#160;&#160;2</td>
Chris@3 143 </tr>
Chris@3 144 </table>
Chris@3 145 </div>
Chris@3 146 <div class="memdoc">
Chris@3 147
Chris@3 148 <p>Definition at line <a class="el" href="plugguard_8h_source.html#l00075">75</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@3 149
Chris@3 150 </div>
Chris@3 151 </div>
Chris@3 152 <a class="anchor" id="ad5eef1e2154b42769cd642d2a1d42257"></a>
Chris@3 153 <div class="memitem">
Chris@3 154 <div class="memproto">
Chris@3 155 <table class="memname">
Chris@3 156 <tr>
Chris@3 157 <td class="memname">#define <a class="el" href="hostguard_8h.html#ad5eef1e2154b42769cd642d2a1d42257">VAMP_SDK_MINOR_VERSION</a>&#160;&#160;&#160;4</td>
Chris@3 158 </tr>
Chris@3 159 </table>
Chris@3 160 </div>
Chris@3 161 <div class="memdoc">
Chris@3 162
Chris@3 163 <p>Definition at line <a class="el" href="plugguard_8h_source.html#l00076">76</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@3 164
Chris@3 165 </div>
Chris@3 166 </div>
Chris@3 167 <a class="anchor" id="a1a2724ea453971288d3218e4eab3072c"></a>
Chris@3 168 <div class="memitem">
Chris@3 169 <div class="memproto">
Chris@3 170 <table class="memname">
Chris@3 171 <tr>
Chris@3 172 <td class="memname">#define <a class="el" href="hostguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a></td>
Chris@1 173 <td>(</td>
Chris@1 174 <td class="paramtype">&#160;</td>
Chris@1 175 <td class="paramname">h</td><td>)</td>
Chris@1 176 <td></td>
Chris@1 177 </tr>
Chris@1 178 </table>
Chris@1 179 </div>
Chris@1 180 <div class="memdoc">
Chris@1 181
Chris@3 182 <p>Definition at line <a class="el" href="plugguard_8h_source.html#l00079">79</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@1 183
Chris@1 184 </div>
Chris@1 185 </div>
Chris@3 186 <a class="anchor" id="ac879bb1077ecc6132ea3581ef9033753"></a>
Chris@1 187 <div class="memitem">
Chris@1 188 <div class="memproto">
Chris@1 189 <table class="memname">
Chris@1 190 <tr>
Chris@3 191 <td class="memname">#define <a class="el" href="hostguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a></td>
Chris@1 192 <td>(</td>
Chris@1 193 <td class="paramtype">&#160;</td>
Chris@1 194 <td class="paramname">h</td><td>)</td>
Chris@1 195 <td></td>
Chris@1 196 </tr>
Chris@1 197 </table>
Chris@1 198 </div>
Chris@1 199 <div class="memdoc">
Chris@1 200
Chris@3 201 <p>Definition at line <a class="el" href="plugguard_8h_source.html#l00080">80</a> of file <a class="el" href="plugguard_8h_source.html">plugguard.h</a>.</p>
Chris@1 202
Chris@1 203 </div>
Chris@1 204 </div>
Chris@3 205 </div><!-- contents -->
Chris@1 206 </div>
Chris@1 207 <div id="nav-path" class="navpath">
Chris@1 208 <ul>
Chris@1 209 <li class="navelem"><a class="el" href="plugguard_8h.html">plugguard.h</a> </li>
Chris@1 210
Chris@3 211 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
Chris@1 212 <a href="http://www.doxygen.org/index.html">
Chris@3 213 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
Chris@1 214 </ul>
Chris@1 215 </div>
Chris@1 216
Chris@1 217
Chris@1 218 </body>
Chris@1 219 </html>