dvander@9: /* ======== SourceMM ======== dvander@9: * Copyright (C) 2004-2005 Metamod:Source Development Team dvander@9: * No warranties of any kind dvander@9: * dvander@9: * License: zlib/libpng dvander@9: * dvander@9: * Author(s): David "BAILOPAN" Anderson dvander@9: * ============================ dvander@9: */ dvander@9: dvander@7: #ifndef _INCLUDE_ISMM_PLUGIN_H dvander@7: #define _INCLUDE_ISMM_PLUGIN_H dvander@7: dvander@9: /** dvander@9: * @brief Plugin API interface dvander@9: * @file ISmmPlugin.h dvander@9: */ dvander@9: dvander@7: #include dvander@7: #include dvander@7: #include "ISmmAPI.h" dvander@7: dvander@76: #define PLAPI_VERSION 6 dvander@7: #define PLAPI_NAME "ISmmPlugin" dvander@7: dvander@7: struct factories dvander@7: { dvander@7: CreateInterfaceFn engine; dvander@7: CreateInterfaceFn server; dvander@7: CreateInterfaceFn physics; dvander@7: CreateInterfaceFn fileSystem; dvander@7: }; dvander@7: dvander@7: class ISmmAPI; dvander@29: typedef int PluginId; dvander@7: dvander@7: class ISmmPlugin dvander@7: { dvander@7: public: dvander@9: virtual int GetApiVersion() { return PLAPI_VERSION; } dvander@9: public: dvander@7: /** dvander@7: * @brief Called on plugin load. dvander@7: * dvander@9: * @param id Internal id of plugin. Saved globally by PLUGIN_SAVEVARS() dvander@7: * @param ismm External API for SourceMM. Saved globally by PLUGIN_SAVEVARS() dvander@7: * @param list Contains a list of factories. Hook a factory call by setting one equal to your own function. dvander@7: * @param error Error message buffer dvander@7: * @param maxlen Size of error message buffer dvander@7: * @return True on success, return false to request no load. dvander@7: */ dvander@7: virtual bool Load(PluginId id, ISmmAPI *ismm, factories *list, char *error, size_t maxlen) =0; dvander@7: dvander@30: /** @brief Called on plugin unload. dvander@7: * dvander@7: * @param error Error message buffer dvander@7: * @param maxlen Size of error message buffer dvander@7: * @return True on success, return false to request no unload. dvander@7: */ dvander@7: virtual bool Unload(char *error, size_t maxlen) =0; dvander@7: dvander@30: /** @brief Called on plugin pause. dvander@7: * dvander@7: * @param error Error message buffer dvander@7: * @param maxlen Size of error message buffer dvander@7: * @return True on success, return false to request no pause. dvander@7: */ dvander@7: virtual bool Pause(char *error, size_t maxlen) =0; dvander@7: dvander@30: /** @brief Called on plugin unpause. dvander@7: * dvander@7: * @param error Error message buffer dvander@7: * @param maxlen Size of error message buffer dvander@7: * @return True on success, return false to request no unpause. dvander@7: */ dvander@7: virtual bool Unpause(char *error, size_t maxlen) =0; dvander@7: public: dvander@30: /** @brief Return author as string */ dvander@7: virtual const char *GetAuthor() =0; dvander@30: dvander@30: /** @brief Return plugin name as string */ dvander@7: virtual const char *GetName() =0; dvander@30: dvander@30: /** @brief Return a description as string */ dvander@7: virtual const char *GetDescription() =0; dvander@30: dvander@30: /** @brief Return a URL as string */ dvander@7: virtual const char *GetURL() =0; dvander@30: dvander@30: /** @brief Return quick license code as string */ dvander@7: virtual const char *GetLicense() =0; dvander@30: dvander@30: /** @brief Return version as string */ dvander@7: virtual const char *GetVersion() =0; dvander@30: dvander@30: /** @brief Return author as string */ dvander@7: virtual const char *GetDate() =0; dvander@30: dvander@30: /** @brief Return author as string */ dvander@7: virtual const char *GetLogTag() =0; dvander@18: public: dvander@18: /** dvander@18: * @brief Called when all plugins have been loaded - API version 4 dvander@30: * dvander@30: * Ths is useful for knowing when it's safe to request things another plugin might have. dvander@18: */ dvander@18: virtual void AllPluginsLoaded() =0; dvander@7: }; dvander@7: dvander@7: #define PL_EXPOSURE CreateInterface dvander@7: #define PL_EXPOSURE_C "CreateInterface" dvander@7: dvander@7: #define PLUGIN_EXPOSE(name, var) \ dvander@7: ISmmAPI *g_SMAPI = NULL; \ dvander@9: ISmmPlugin *g_PLAPI = NULL; \ dvander@9: PluginId g_PLID = (PluginId)0; \ dvander@7: SourceHook::ISourceHook *g_SHPtr = NULL; \ dvander@7: SMM_API void *PL_EXPOSURE(const char *name, int *code) { \ dvander@7: if (name && !strcmp(name, PLAPI_NAME)) { \ dvander@7: return static_cast(&var); \ dvander@7: } \ dvander@7: return NULL; \ dvander@7: } dvander@7: dvander@7: #define PLUGIN_GLOBALVARS() \ dvander@7: extern SourceHook::ISourceHook *g_SHPtr; \ dvander@7: extern ISmmAPI *g_SMAPI; \ dvander@9: extern ISmmPlugin *g_PLAPI; \ dvander@9: extern PluginId g_PLID; dvander@7: dvander@7: #define PLUGIN_SAVEVARS() \ dvander@7: g_SMAPI = ismm; \ dvander@7: g_SHPtr = ismm->SourceHook(); \ dvander@9: g_PLAPI = static_cast(this); \ dvander@9: g_PLID = id; dvander@7: dvander@7: #define FACTORY_RETURN(mres, value) \ dvander@7: g_SMAPI->SetLastMetaReturn(mres); \ dvander@7: return value; dvander@7: dvander@67: #define META_LOG g_SMAPI->LogMsg dvander@67: #define META_REGCMD(name) g_SMAPI->RegisterConCmdBase(g_PLAPI, name##_command) dvander@67: #define META_REGCVAR(var) g_SMAPI->RegisterConCmdBase(g_PLAPI, var) dvander@67: #define META_UNREGCMD(name) g_SMAPI->UnregisterConCmdBase(g_PLAPI, name##_command) dvander@67: #define META_UNREGCVAR(var) g_SMAPI->UnregisterConCmdBase(g_PLAPI, var) dvander@76: #define META_CONPRINT g_SMAPI->ConPrint dvander@76: #define META_CONPRINTF g_SMAPI->ConPrintf dvander@7: dvander@67: //probably should use this up above someday ds@66: #define CONCMD_VARNAME(name) name##_command ds@66: dvander@7: #if !defined SMM_API dvander@7: #if defined __WIN32__ || defined _WIN32 || defined WIN32 dvander@7: #define SMM_API extern "C" __declspec(dllexport) dvander@7: #elif defined __GNUC__ dvander@7: #define SMM_API extern "C" dvander@7: #endif dvander@7: #endif //!defined SMM_API dvander@7: dvander@7: #endif //_INCLUDE_ISMM_PLUGIN_H