IPluginSys.h

Go to the documentation of this file.

#ifndef _INCLUDE_SOURCEMOD_PLUGINMNGR_INTERFACE_H_
#define _INCLUDE_SOURCEMOD_PLUGINMNGR_INTERFACE_H_

#include <IShareSys.h>
#include <IHandleSys.h>
#include <sp_vm_api.h>

#define SMINTERFACE_PLUGINSYSTEM_NAME           "IPluginManager"
#define SMINTERFACE_PLUGINSYSTEM_VERSION        5

#define SM_CONTEXTVAR_USER              3

namespace SourceMod
{
        class IPlugin;

        typedef struct sm_plugininfo_s
        {
                const char *name;                       
                const char *author;                     
                const char *description;        
                const char *version;            
                const char *url;                        
        } sm_plugininfo_t;


        enum PluginStatus
        {
                Plugin_Running=0,               
                /* All states below are unexecutable */
                Plugin_Paused,                  
                Plugin_Error,                   
                /* All states below do not have all natives */
                Plugin_Loaded,                  
                Plugin_Failed,                  
                Plugin_Created,                 
                Plugin_Uncompiled,              
                Plugin_BadLoad,                 
        };


        enum PluginType
        {
                PluginType_Private,                     
                PluginType_MapUpdated,          
                PluginType_MapOnly,                     
                PluginType_Global,                      
        };

        class IPhraseCollection;

        class IPlugin
        {
        public:
                virtual ~IPlugin()
                {
                }

                virtual PluginType GetType() =0;

                virtual SourcePawn::IPluginContext *GetBaseContext() =0;

                virtual sp_context_t *GetContext() =0;

                virtual void *GetPluginStructure() =0;

                virtual const sm_plugininfo_t *GetPublicInfo() =0;

                virtual const char *GetFilename() =0;

                virtual bool IsDebugging() =0;

                virtual PluginStatus GetStatus() =0;
                
                virtual bool SetPauseState(bool paused) =0;

                virtual unsigned int GetSerial() =0;

                virtual IdentityToken_t *GetIdentity() =0;

                virtual bool SetProperty(const char *prop, void *ptr) =0;

                virtual bool GetProperty(const char *prop, void **ptr, bool remove=false) =0;

                virtual SourcePawn::IPluginRuntime *GetRuntime() =0;

                virtual IPhraseCollection *GetPhrases() =0;

                virtual Handle_t GetMyHandle() =0;
        };


        class IPluginIterator
        {
        public:
                virtual ~IPluginIterator()
                {
                };
        public:
                virtual bool MorePlugins() =0;

                virtual IPlugin *GetPlugin() =0;

                virtual void NextPlugin() =0;

                virtual void Release() =0;
        };

        class IPluginsListener
        {
        public:
                virtual void OnPluginCreated(IPlugin *plugin)
                {
                }

                virtual void OnPluginLoaded(IPlugin *plugin)
                {
                }

                virtual void OnPluginPauseChange(IPlugin *plugin, bool paused)
                {
                }

                virtual void OnPluginUnloaded(IPlugin *plugin)
                {
                }

                virtual void OnPluginDestroyed(IPlugin *plugin)
                {
                }
        };


        class IPluginManager : public SMInterface
        {
        public:
                virtual const char *GetInterfaceName()
                {
                        return SMINTERFACE_PLUGINSYSTEM_NAME;
                }

                virtual unsigned int GetInterfaceVersion()
                {
                        return SMINTERFACE_PLUGINSYSTEM_VERSION;
                }
        public:
                virtual IPlugin *LoadPlugin(const char *path, 
                                                                        bool debug,
                                                                        PluginType type,
                                                                        char error[],
                                                                        size_t maxlength,
                                                                        bool *wasloaded) =0;

                virtual bool UnloadPlugin(IPlugin *plugin) =0;

                virtual IPlugin *FindPluginByContext(const sp_context_t *ctx) =0;

                virtual unsigned int GetPluginCount() =0;

                virtual IPluginIterator *GetPluginIterator() =0;

                virtual void AddPluginsListener(IPluginsListener *listener) =0;

                virtual void RemovePluginsListener(IPluginsListener *listener) =0;

                virtual IPlugin *PluginFromHandle(Handle_t handle, HandleError *err) =0;
        };
}

#endif //_INCLUDE_SOURCEMOD_PLUGINMNGR_INTERFACE_H_