plugguard.h File Reference

Go to the source code of this file.

Defines
#define	_VAMP_IN_PLUGINSDK   1
	Normal usage should be:
#define	_VAMP_SDK_PLUGSPACE_BEGIN(h)
#define	_VAMP_SDK_PLUGSPACE_END(h)

---

Define Documentation

#define _VAMP_IN_PLUGINSDK   1

Normal usage should be:

• Plugins include vamp-sdk/Plugin.h or vamp-sdk/PluginBase.h. 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.

• Hosts include vamp-hostsdk/Plugin.h, vamp-hostsdk/PluginBase.h, vamp-hostsdk/PluginHostAdapter, vamp-hostsdk/PluginLoader.h etc. These files include vamp-hostsdk/hostguard.h, which makes a note that we are in a host. A file such as vamp-hostsdk/Plugin.h then simply includes vamp-sdk/Plugin.h, and this guard header takes notice of the fact that it has been included from a host and leaves the plugin namespace unset.

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.

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.

Definition at line 72 of file plugguard.h.

#define _VAMP_SDK_PLUGSPACE_BEGIN

(

h

)

Definition at line 75 of file plugguard.h.

#define _VAMP_SDK_PLUGSPACE_END

(

h

)

Definition at line 76 of file plugguard.h.