ISmmPlugin.h

Go to the documentation of this file.

/*
 * vim: set ts=4 :
 * ======================================================
 * Metamod:Source
 * Copyright (C) 2004-2007 AlliedModders LLC and authors.
 * All rights reserved.
 * ======================================================
 *
 * This software is provided 'as-is', without any express or implied warranty.
 * In no event will the authors be held liable for any damages arising from 
 * the use of this software.
 * 
 * Permission is granted to anyone to use this software for any purpose, 
 * including commercial applications, and to alter it and redistribute it 
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not 
 * claim that you wrote the original software. If you use this software in a 
 * product, an acknowledgment in the product documentation would be 
 * appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 *
 * Version: $Id: ISmmPlugin.h 605 2007-12-24 17:00:22Z dvander $
 */

#ifndef _INCLUDE_ISMM_PLUGIN_H
#define _INCLUDE_ISMM_PLUGIN_H

#include <interface.h>
#include <sourcehook.h>
#include <IPluginManager.h>
#include <ISmmAPI.h>
#include <ISmmPluginExt.h>

namespace SourceMM
{
        class ISmmAPI;

        class ISmmPlugin
        {
        public:
                virtual int GetApiVersion() 
                { 
                        return METAMOD_PLAPI_VERSION; 
                }

                virtual ~ISmmPlugin()
                {
                }

        public:
                virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0;

                virtual void AllPluginsLoaded()
                {
                }

                virtual bool QueryRunning(char *error, size_t maxlen)
                {
                        return true;
                }

                virtual bool Unload(char *error, size_t maxlen)
                {
                        return true;
                }

                virtual bool Pause(char *error, size_t maxlen)
                {
                        return true;
                }

                virtual bool Unpause(char *error, size_t maxlen)
                {
                        return true;
                }
        public:
                virtual const char *GetAuthor() =0;
        
                virtual const char *GetName() =0;
        
                virtual const char *GetDescription() =0;
        
                virtual const char *GetURL() =0;
        
                virtual const char *GetLicense() =0;
        
                virtual const char *GetVersion() =0;
        
                virtual const char *GetDate() =0;
        
                virtual const char *GetLogTag() =0;
        };

        class IMetamodListener
        {
        public:
                virtual void OnPluginLoad(PluginId id)
                {
                }

                virtual void OnPluginUnload(PluginId id)
                {
                }
        
                virtual void OnPluginPause(PluginId id)
                {
                }
        
                virtual void OnPluginUnpause(PluginId id)
                {
                }
        
                virtual void OnLevelInit(char const *pMapName, 
                                                                 char const *pMapEntities, 
                                                                 char const *pOldLevel, 
                                                                 char const *pLandmarkName, 
                                                                 bool loadGame, 
                                                                 bool background) 
                { 
                }

                virtual void OnLevelShutdown()
                {
                }

                virtual void *OnEngineQuery(const char *iface, int *ret)
                {
                        if (ret)
                        {
                                *ret = IFACE_FAILED;
                        }

                        return NULL; 
                }

                virtual void *OnPhysicsQuery(const char *iface, int *ret)
                {
                        if (ret)
                        {
                                *ret = IFACE_FAILED;
                        }
        
                        return NULL; 
                }

                virtual void *OnFileSystemQuery(const char *iface, int *ret)
                {
                        if (ret)
                        {
                                *ret = IFACE_FAILED;
                        }
                        
                        return NULL; 
                }

                virtual void *OnGameDLLQuery(const char *iface, int *ret)
                {
                        if (ret)
                        {
                                *ret = IFACE_FAILED;
                        }
        
                        return NULL; 
                }

                virtual void *OnMetamodQuery(const char *iface, int *ret)
                {
                        if (ret)
                        {
                                *ret = IFACE_FAILED;
                        }
        
                        return NULL;    
                }

                virtual void OnVSPListening(IServerPluginCallbacks *iface) 
                { 
                }

                virtual void OnUnlinkConCommandBase(PluginId id, ConCommandBase *pCommand)
                {
                }
        };
}

#if !defined METAMOD_NO_AUTO_NAMESPACE
using namespace SourceMM;
#endif

#define PL_EXPOSURE             CreateInterface
#define PL_EXPOSURE_C   "CreateInterface"

#define PLUGIN_EXPOSE(name, var) \
        ISmmAPI *g_SMAPI = NULL; \
        ISmmPlugin *g_PLAPI = NULL; \
        PluginId g_PLID = (PluginId)0; \
        SourceHook::ISourceHook *g_SHPtr = NULL; \
        SMM_API void *PL_EXPOSURE(const char *name, int *code) { \
                if (name && !strcmp(name, METAMOD_PLAPI_NAME)) { \
                        return static_cast<void *>(&var); \
                } \
                return NULL; \
        }


#define PLUGIN_GLOBALVARS()     \
        extern SourceHook::ISourceHook *g_SHPtr; \
        extern ISmmAPI *g_SMAPI; \
        extern ISmmPlugin *g_PLAPI; \
        extern PluginId g_PLID; 

#define PLUGIN_SAVEVARS() \
        g_SMAPI = ismm; \
        g_SHPtr = static_cast<SourceHook::ISourceHook *>(ismm->MetaFactory(MMIFACE_SOURCEHOOK, NULL, NULL)); \
        g_PLAPI = static_cast<ISmmPlugin *>(this); \
        g_PLID = id;

#define META_LOG                                g_SMAPI->LogMsg
#define META_REGCMD(name)               g_SMAPI->RegisterConCommandBase(g_PLAPI, name##_command)
#define META_REGCVAR(var)               g_SMAPI->RegisterConCommandBase(g_PLAPI, var)
#define META_UNREGCMD(name)             g_SMAPI->UnregisterConCommandBase(g_PLAPI, name##_command)
#define META_UNREGCVAR(var)             g_SMAPI->UnregisterConCommandBase(g_PLAPI, var)
#define META_CONPRINT                   g_SMAPI->ConPrint
#define META_CONPRINTF                  g_SMAPI->ConPrintf

/* Probably should use this up above someday */
#define CONCMD_VARNAME(name) name##_command

#if !defined SMM_API
#if defined __WIN32__ || defined _WIN32 || defined WIN32
        #define SMM_API extern "C" __declspec(dllexport)
#elif defined __GNUC__
        #if (__GNUC__ == 4) && (__GNUC_MINOR__ >= 1)
                #define SMM_API extern "C" __attribute__ ((visibility("default")))      
        #else
                #define SMM_API extern "C" 
        #endif  
#endif
#endif 


#define GET_V_IFACE_CURRENT(v_factory, v_var, v_type, v_name) \
        v_var = (v_type *)ismm->VInterfaceMatch(ismm->v_factory(), v_name); \
        if (!v_var) \
        { \
                if (error && maxlen) \
                { \
                        ismm->Format(error, maxlen, "Could not find interface: %s", v_name); \
                } \
                return false; \
        }

#define GET_V_IFACE_ANY(v_factory, v_var, v_type, v_name) \
        v_var = (v_type *)ismm->VInterfaceMatch(ismm->v_factory(), v_name, 0); \
        if (!v_var) \
        { \
                if (error && maxlen) \
                { \
                        ismm->Format(error, maxlen, "Could not find interface: %s", v_name); \
                } \
                return false; \
        }

#endif //_INCLUDE_ISMM_PLUGIN_H

---