Mercurial > hg > vamp-docs

comparison code-docs/plugguard_8h.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

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