[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

/home/tetron/hack/vos/libs/vos/vos/vosplugin.hh

Go to the documentation of this file.

#ifndef _VOSPLUGIN_HH_
#define _VOSPLUGIN_HH_

#include <vos/vos/metaobject.hh>

#if defined(WIN32)
# define PLUGIN_API __declspec(dllexport)
#else
# ifdef HAVE_GCC_VISIBILITY
#  define PLUGIN_API __attribute__ ((visibility("default")))
# else
#  define PLUGIN_API
# endif
#endif


namespace VOS
{
    class VOS_API VOSPlugin : public MetaObject
    {
    protected:
        VOSPlugin(VOS::VobjectBase* superobject);
        std::vector<std::string> searchPath;

    public:
        /** Get the name for this loadable plugin */
        virtual std::string getModuleName() = 0;

        /** Get the version of the plugin module */
        virtual void getModuleVersion(int& major, int& minor) = 0;

        struct HelpOption
        {
            HelpOption(const std::string& a, const std::string& b)
                : option(a), description(b) { }
            std::string option;
            std::string description;
        };

        struct PluginHelp
        {
            std::string header;
            std::vector<HelpOption> options;
            std::string footer;
        };

        /** Fills in the supplied plugin help structure */
        virtual void getHelp(PluginHelp& ph) = 0;

        /** Trigger the actual loading, setup and execution of the module */
        virtual void initialize() = 0;

        virtual void setSearchPath(std::vector<std::string>& path);
        virtual std::vector<std::string> getSearchPath();
    };

    class VOS_API VOSPluginSharedObject : public virtual VOSPlugin
    {
    protected:
        VOSPluginSharedObject(VOS::VobjectBase* superobject);

        typedef void (*NameFunc)(std::string* name);
        typedef void (*VersionFunc)(int* major, int* minor);
        typedef void (*HelpFunc)(VOSPlugin::PluginHelp* help);
        typedef void (*InitFunc)(Vobject* parent);

        void* pluginModule;
        NameFunc nameFunc;
        VersionFunc versionFunc;
        HelpFunc helpFunc;
        InitFunc initFunc;

        virtual void checkLoadModule();

    public:
        static MetaObject* new_VOSPluginSharedObject(VOS::VobjectBase* superobject,
                                                     const std::string& type);

        virtual const std::string getVOSType();

        virtual std::string getModuleName();
        virtual void getModuleVersion(int& major, int& minor);
        virtual void getHelp(VOSPlugin::PluginHelp& ph);
        virtual void initialize();
    };

#define DECLARE_VOS_PLUGIN(name, major, minor) \
  PLUGIN_API void vosplugin_name(std::string* n) { *n = (name); } \
  PLUGIN_API void vosplugin_version(int* maj, int* min) { *maj = (major); *min = (minor); }
}

#ifndef VOS_EXPORTS
IMPORT_METAOBJECT_FACTORIES(VOSPluginSharedObject)
#endif

#endif