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