Mercurial > hg > vamp-website

annotate code-doc/plugguard_8h.html @ 128:817c3988afc7 website tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a page about the Vamp Plugin Pack, including links to download mirrors
author Chris Cannam
date Tue, 11 Aug 2020 16:41:11 +0100
parents 8260c0f4e05b
children
rev   line source
cannam@50 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
cannam@50 2 <html xmlns="http://www.w3.org/1999/xhtml">
cannam@50 3 <head>
cannam@50 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
cannam@21 5 <title>VampPluginSDK: plugguard.h File Reference</title>
cannam@50 6
cannam@50 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
cannam@50 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
cannam@50 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
cannam@50 10 <script type="text/javascript" src="jquery.js"></script>
cannam@50 11 <script type="text/javascript" src="resize.js"></script>
cannam@50 12 <script type="text/javascript" src="navtree.js"></script>
cannam@50 13 <script type="text/javascript">
cannam@50 14 $(document).ready(initResizable);
cannam@50 15 </script>
cannam@50 16
cannam@50 17
cannam@50 18 </head>
cannam@50 19 <body>
cannam@50 20 <div id="top"><!-- do not remove this div! -->
cannam@50 21
cannam@50 22
cannam@50 23 <div id="titlearea">
cannam@50 24 <table cellspacing="0" cellpadding="0">
cannam@50 25 <tbody>
cannam@50 26 <tr style="height: 56px;">
cannam@50 27
cannam@50 28
cannam@50 29 <td style="padding-left: 0.5em;">
cannam@50 30 <div id="projectname">VampPluginSDK
cannam@50 31 &#160;<span id="projectnumber">2.1</span>
cannam@50 32 </div>
cannam@50 33
cannam@50 34 </td>
cannam@50 35
cannam@50 36
cannam@50 37
cannam@50 38 </tr>
cannam@50 39 </tbody>
cannam@50 40 </table>
cannam@50 41 </div>
cannam@50 42
cannam@50 43 <!-- Generated by Doxygen 1.7.5.1 -->
cannam@50 44 <div id="navrow1" class="tabs">
cannam@50 45 <ul class="tablist">
cannam@50 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
cannam@21 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@21 48 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@21 49 <li class="current"><a href="files.html"><span>Files</span></a></li>
cannam@21 50 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@21 51 </ul>
cannam@21 52 </div>
cannam@50 53 <div id="navrow2" class="tabs2">
cannam@50 54 <ul class="tablist">
cannam@50 55 <li><a href="files.html"><span>File&#160;List</span></a></li>
cannam@50 56 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
cannam@35 57 </ul>
cannam@35 58 </div>
cannam@50 59 </div>
cannam@50 60 <div id="side-nav" class="ui-resizable side-nav-resizable">
cannam@50 61 <div id="nav-tree">
cannam@50 62 <div id="nav-tree-contents">
cannam@50 63 </div>
cannam@50 64 </div>
cannam@50 65 <div id="splitbar" style="-moz-user-select:none;"
cannam@50 66 class="ui-resizable-handle">
cannam@21 67 </div>
cannam@21 68 </div>
cannam@50 69 <script type="text/javascript">
cannam@50 70 initNavTree('plugguard_8h.html','');
cannam@50 71 </script>
cannam@50 72 <div id="doc-content">
cannam@50 73 <div class="header">
cannam@50 74 <div class="summary">
cannam@50 75 <a href="#define-members">Defines</a> </div>
cannam@50 76 <div class="headertitle">
cannam@50 77 <div class="title">plugguard.h File Reference</div> </div>
cannam@50 78 </div>
cannam@21 79 <div class="contents">
cannam@21 80
cannam@50 81 <p><a href="plugguard_8h_source.html">Go to the source code of this file.</a></p>
cannam@50 82 <table class="memberdecls">
cannam@50 83 <tr><td colspan="2"><h2><a name="define-members"></a>
cannam@50 84 Defines</h2></td></tr>
cannam@50 85 <tr><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>
cannam@50 86 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Normal usage should be: <a href="#a3bf4e97f131677e5e1505a7a9582d68a"></a><br/></td></tr>
cannam@50 87 <tr><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>
cannam@50 88 <tr><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>
cannam@21 89 </table>
cannam@50 90 <hr/><h2>Define Documentation</h2>
cannam@50 91 <a class="anchor" id="a3bf4e97f131677e5e1505a7a9582d68a"></a><!-- doxytag: member="plugguard.h::_VAMP_IN_PLUGINSDK" ref="a3bf4e97f131677e5e1505a7a9582d68a" args="" -->
cannam@21 92 <div class="memitem">
cannam@21 93 <div class="memproto">
cannam@21 94 <table class="memname">
cannam@21 95 <tr>
cannam@50 96 <td class="memname">#define _VAMP_IN_PLUGINSDK&#160;&#160;&#160;1</td>
cannam@21 97 </tr>
cannam@21 98 </table>
cannam@21 99 </div>
cannam@21 100 <div class="memdoc">
cannam@21 101
cannam@50 102 <p>Normal usage should be: </p>
cannam@21 103 <ul>
cannam@50 104 <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>
cannam@50 105 </ul>
cannam@21 106 <ul>
cannam@50 107 <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>
cannam@50 108 </ul>
cannam@50 109 <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>
cannam@50 110 <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>
cannam@50 111
cannam@50 112 <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 113
cannam@21 114 </div>
cannam@50 115 </div>
cannam@50 116 <a class="anchor" id="a1a2724ea453971288d3218e4eab3072c"></a><!-- doxytag: member="plugguard.h::_VAMP_SDK_PLUGSPACE_BEGIN" ref="a1a2724ea453971288d3218e4eab3072c" args="(h)" -->
cannam@21 117 <div class="memitem">
cannam@21 118 <div class="memproto">
cannam@21 119 <table class="memname">
cannam@21 120 <tr>
cannam@50 121 <td class="memname">#define _VAMP_SDK_PLUGSPACE_BEGIN</td>
cannam@21 122 <td>(</td>
cannam@50 123 <td class="paramtype">&#160;</td>
cannam@50 124 <td class="paramname">h</td><td>)</td>
cannam@21 125 <td></td>
cannam@21 126 </tr>
cannam@21 127 </table>
cannam@21 128 </div>
cannam@21 129 <div class="memdoc">
cannam@21 130
cannam@50 131 <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 132
cannam@21 133 </div>
cannam@50 134 </div>
cannam@50 135 <a class="anchor" id="ac879bb1077ecc6132ea3581ef9033753"></a><!-- doxytag: member="plugguard.h::_VAMP_SDK_PLUGSPACE_END" ref="ac879bb1077ecc6132ea3581ef9033753" args="(h)" -->
cannam@21 136 <div class="memitem">
cannam@21 137 <div class="memproto">
cannam@21 138 <table class="memname">
cannam@21 139 <tr>
cannam@50 140 <td class="memname">#define _VAMP_SDK_PLUGSPACE_END</td>
cannam@21 141 <td>(</td>
cannam@50 142 <td class="paramtype">&#160;</td>
cannam@50 143 <td class="paramname">h</td><td>)</td>
cannam@21 144 <td></td>
cannam@21 145 </tr>
cannam@21 146 </table>
cannam@21 147 </div>
cannam@21 148 <div class="memdoc">
cannam@21 149
cannam@50 150 <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 151
cannam@21 152 </div>
cannam@21 153 </div>
cannam@50 154 </div>
cannam@50 155 </div>
cannam@50 156 <div id="nav-path" class="navpath">
cannam@50 157 <ul>
cannam@50 158 <li class="navelem"><a class="el" href="plugguard_8h.html">plugguard.h</a> </li>
cannam@50 159
cannam@50 160 <li class="footer">Generated on Tue Oct 4 2011 14:38:49 for VampPluginSDK by
cannam@50 161 <a href="http://www.doxygen.org/index.html">
cannam@50 162 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
cannam@50 163 </ul>
cannam@50 164 </div>
cannam@50 165
cannam@50 166
cannam@21 167 </body>
cannam@21 168 </html>