Mercurial > hg > vamp-website

annotate code-doc/plugguard_8h.html @ 35:0976232e353b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update for 2.1 release; add wiki link
author cannam
date Fri, 25 Sep 2009 15:40:18 +0000
parents cc0be37dc9d3
children 8260c0f4e05b
rev   line source
cannam@21 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@21 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@21 3 <title>VampPluginSDK: plugguard.h File Reference</title>
cannam@35 4 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@21 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@21 6 </head><body>
cannam@35 7 <!-- Generated by Doxygen 1.5.8 -->
cannam@21 8 <div class="navigation" id="top">
cannam@21 9 <div class="tabs">
cannam@21 10 <ul>
cannam@21 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@21 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@21 13 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@21 14 <li class="current"><a href="files.html"><span>Files</span></a></li>
cannam@21 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@21 16 </ul>
cannam@21 17 </div>
cannam@35 18 <div class="tabs">
cannam@35 19 <ul>
cannam@35 20 <li><a href="files.html"><span>File&nbsp;List</span></a></li>
cannam@35 21 <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
cannam@35 22 </ul>
cannam@35 23 </div>
cannam@21 24 <div class="navpath"><a class="el" href="dir_5b77fce4b90561041d958141b45c7c55.html">vamp-sdk</a>
cannam@21 25 </div>
cannam@21 26 </div>
cannam@21 27 <div class="contents">
cannam@21 28 <h1>plugguard.h File Reference</h1>
cannam@21 29 <p>
cannam@21 30 <a href="plugguard_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
cannam@21 31 <tr><td></td></tr>
cannam@21 32 <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
cannam@21 33 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#3bf4e97f131677e5e1505a7a9582d68a">_VAMP_IN_PLUGINSDK</a>&nbsp;&nbsp;&nbsp;1</td></tr>
cannam@21 34
cannam@21 35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normal usage should be:. <a href="#3bf4e97f131677e5e1505a7a9582d68a"></a><br></td></tr>
cannam@21 36 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(h)</td></tr>
cannam@21 37
cannam@21 38 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugguard_8h.html#c879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(h)</td></tr>
cannam@21 39
cannam@21 40 </table>
cannam@21 41 <hr><h2>Define Documentation</h2>
cannam@21 42 <a class="anchor" name="3bf4e97f131677e5e1505a7a9582d68a"></a><!-- doxytag: member="plugguard.h::_VAMP_IN_PLUGINSDK" ref="3bf4e97f131677e5e1505a7a9582d68a" args="" -->
cannam@21 43 <div class="memitem">
cannam@21 44 <div class="memproto">
cannam@21 45 <table class="memname">
cannam@21 46 <tr>
cannam@21 47 <td class="memname">#define _VAMP_IN_PLUGINSDK&nbsp;&nbsp;&nbsp;1 </td>
cannam@21 48 </tr>
cannam@21 49 </table>
cannam@21 50 </div>
cannam@21 51 <div class="memdoc">
cannam@21 52
cannam@21 53 <p>
cannam@21 54 Normal usage should be:.
cannam@21 55 <p>
cannam@21 56 <ul>
cannam@21 57 <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></ul>
cannam@21 58 <p>
cannam@21 59 <ul>
cannam@21 60 <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></ul>
cannam@21 61 <p>
cannam@21 62 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>
cannam@21 63 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.
cannam@21 64 <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>
cannam@21 65
cannam@21 66 </div>
cannam@21 67 </div><p>
cannam@21 68 <a class="anchor" name="1a2724ea453971288d3218e4eab3072c"></a><!-- doxytag: member="plugguard.h::_VAMP_SDK_PLUGSPACE_BEGIN" ref="1a2724ea453971288d3218e4eab3072c" args="(h)" -->
cannam@21 69 <div class="memitem">
cannam@21 70 <div class="memproto">
cannam@21 71 <table class="memname">
cannam@21 72 <tr>
cannam@21 73 <td class="memname">#define _VAMP_SDK_PLUGSPACE_BEGIN </td>
cannam@21 74 <td>(</td>
cannam@21 75 <td class="paramtype">h&nbsp;</td>
cannam@21 76 <td class="paramname"> </td>
cannam@21 77 <td>&nbsp;)&nbsp;</td>
cannam@21 78 <td></td>
cannam@21 79 </tr>
cannam@21 80 </table>
cannam@21 81 </div>
cannam@21 82 <div class="memdoc">
cannam@21 83
cannam@21 84 <p>
cannam@21 85
cannam@21 86 <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>
cannam@21 87
cannam@21 88 </div>
cannam@21 89 </div><p>
cannam@21 90 <a class="anchor" name="c879bb1077ecc6132ea3581ef9033753"></a><!-- doxytag: member="plugguard.h::_VAMP_SDK_PLUGSPACE_END" ref="c879bb1077ecc6132ea3581ef9033753" args="(h)" -->
cannam@21 91 <div class="memitem">
cannam@21 92 <div class="memproto">
cannam@21 93 <table class="memname">
cannam@21 94 <tr>
cannam@21 95 <td class="memname">#define _VAMP_SDK_PLUGSPACE_END </td>
cannam@21 96 <td>(</td>
cannam@21 97 <td class="paramtype">h&nbsp;</td>
cannam@21 98 <td class="paramname"> </td>
cannam@21 99 <td>&nbsp;)&nbsp;</td>
cannam@21 100 <td></td>
cannam@21 101 </tr>
cannam@21 102 </table>
cannam@21 103 </div>
cannam@21 104 <div class="memdoc">
cannam@21 105
cannam@21 106 <p>
cannam@21 107
cannam@21 108 <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>
cannam@21 109
cannam@21 110 </div>
cannam@21 111 </div><p>
cannam@21 112 </div>
cannam@35 113 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
cannam@21 114 <a href="http://www.doxygen.org/index.html">
cannam@35 115 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@21 116 </body>
cannam@21 117 </html>