IExtensionSys.h

Go to the documentation of this file.

#ifndef _INCLUDE_SOURCEMOD_MODULE_INTERFACE_H_
#define _INCLUDE_SOURCEMOD_MODULE_INTERFACE_H_

#include <IShareSys.h>
#include <ILibrarySys.h>

struct edict_t;

namespace SourceMod
{
        class IExtensionInterface;
        typedef void *          ITERATOR;               
        class IExtension
        {
        public:
                virtual bool IsLoaded() =0;

                virtual IExtensionInterface *GetAPI() =0;

                virtual const char *GetFilename() =0;

                virtual IdentityToken_t *GetIdentity() =0;

                virtual ITERATOR *FindFirstDependency(IExtension **pOwner, SMInterface **pInterface) =0;

                virtual bool FindNextDependency(ITERATOR *iter, IExtension **pOwner, SMInterface **pInterface) =0;

                virtual void FreeDependencyIterator(ITERATOR *iter) =0;

                virtual bool IsRunning(char *error, size_t maxlength) =0;

                virtual bool IsExternal() =0;
        };

        #define SMINTERFACE_EXTENSIONAPI_VERSION        8

        class IExtensionInterface
        {
        public:
                virtual unsigned int GetExtensionVersion()
                {
                        return SMINTERFACE_EXTENSIONAPI_VERSION;
                }
        public:
                virtual bool OnExtensionLoad(IExtension *me,
                        IShareSys *sys, 
                        char *error, 
                        size_t maxlength, 
                        bool late) =0;

                virtual void OnExtensionUnload() =0;

                virtual void OnExtensionsAllLoaded() =0;

                virtual void OnExtensionPauseChange(bool pause) =0;

                virtual bool QueryInterfaceDrop(SMInterface *pInterface)
                {
                        return false;
                }

                virtual void NotifyInterfaceDrop(SMInterface *pInterface)
                {
                }

                virtual bool QueryRunning(char *error, size_t maxlength)
                {
                        return true;
                }
        public:
                virtual bool IsMetamodExtension() =0;

                virtual const char *GetExtensionName() =0;

                virtual const char *GetExtensionURL() =0;

                virtual const char *GetExtensionTag() =0;

                virtual const char *GetExtensionAuthor() =0;

                virtual const char *GetExtensionVerString() =0;

                virtual const char *GetExtensionDescription() =0;

                virtual const char *GetExtensionDateString() =0;

                virtual void OnCoreMapStart(edict_t *pEdictList, int edictCount, int clientMax)
                {
                }

                virtual void OnDependenciesDropped()
                {
                }

                virtual void OnCoreMapEnd()
                {
                }
        };

        #define SOURCEMOD_INTERFACE_EXTENSIONS                          "SM_ExtensionManager"

        #define SOURCEMOD_NOTICE_EXTENSIONS                                     "SM_ExtensionsAttachable"

        #define SMINTERFACE_EXTENSIONMANAGER_NAME                       "IExtensionManager"
        #define SMINTERFACE_EXTENSIONMANAGER_VERSION            2

        class IExtensionManager : public SMInterface
        {
        public:
                virtual const char *GetInterfaceName()
                {
                        return SMINTERFACE_EXTENSIONMANAGER_NAME;
                }
                virtual unsigned int GetInterfaceVersion()
                {
                        return SMINTERFACE_EXTENSIONMANAGER_VERSION;
                }
                virtual bool IsVersionCompatible(unsigned int version)
                {
                        if (version < 2)
                        {
                                return false;
                        }
                        return SMInterface::IsVersionCompatible(version);
                }
        public:
                virtual IExtension *LoadExtension(const char *path, 
                        char *error,
                        size_t maxlength) =0;

                virtual IExtension *LoadExternal(IExtensionInterface *pInterface,
                        const char *filepath,
                        const char *filename,
                        char *error,
                        size_t maxlength) =0;

                virtual bool UnloadExtension(IExtension *pExt) =0;
        };

        #define SM_IFACEPAIR(name) SMINTERFACE_##name##_NAME, SMINTERFACE_##name##_VERSION

        #define SM_FIND_IFACE_OR_FAIL(prefix, variable, errbuf, errsize) \
                if (!sharesys->RequestInterface(SM_IFACEPAIR(prefix), myself, (SMInterface **)&variable)) \
                { \
                        if (errbuf) \
                        { \
                                size_t len = snprintf(errbuf, \
                                        errsize, \
                                        "Could not find interface: %s (version: %d)", \
                                        SM_IFACEPAIR(prefix)); \
                                if (len >= errsize) \
                                { \
                                        errbuf[errsize - 1] = '\0'; \
                                } \
                        } \
                        return false; \
                }

        #define SM_FIND_IFACE(prefix, variable) \
                sharesys->RequestInterface(SM_IFACEPAIR(prefix), myself, (SMInterface **)&variable);
}

#endif //_INCLUDE_SOURCEMOD_MODULE_INTERFACE_H_