dvander@9: /* ======== SourceMM ======== dvander@175: * Copyright (C) 2004-2006 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@227: #define PLAPI_VERSION 9 dvander@7: #define PLAPI_NAME "ISmmPlugin" dvander@7: dvander@7: class ISmmAPI; dvander@7: dvander@7: class ISmmPlugin dvander@7: { dvander@7: public: dvander@9: virtual int GetApiVersion() { return PLAPI_VERSION; } dvander@122: virtual ~ISmmPlugin() { } dvander@9: public: dvander@7: /** dvander@7: * @brief Called on plugin load. dvander@122: * NOTE - As of API 7, this is called as DLLInit() executes - after the parameters are known, but before dvander@122: * the original GameDLL function is called. Therefore, you cannot hook it, but you don't need to - dvander@122: * Load() is basically your hook. dvander@122: * NOTE - As of API 7, you can override factories before the engine and gamedll exchange them. dvander@122: * However, take care to note that if your plugin is unloaded, and the gamedll/engine have cached dvander@122: * an interface you've passed, something will definitely crash. Be careful. dvander@7: * dvander@122: * @param id Internal id of plugin. Saved globally by PLUGIN_SAVEVARS() dvander@122: * @param ismm External API for SourceMM. Saved globally by PLUGIN_SAVEVARS() dvander@122: * @param list Contains a list of factories. Hook a factory call by setting one equal to your own function. dvander@122: * @param late Set to true if your plugin was loaded late (not at server load). dvander@7: * @param error Error message buffer dvander@7: * @param maxlen Size of error message buffer dvander@122: * @return True if successful, return false to reject the load. dvander@7: */ dvander@138: virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0; dvander@7: dvander@122: /** dvander@122: * @brief Called when your plugin is "queried". This is useful for rejecting a loaded dvander@122: * state. For example, if your plugin wants to stop operating, it can simply return dvander@122: * false and copy an error message. This will notify other plugins or MM:S of something dvander@122: * bad that happened. NOTE - MM:S will not cache the return state, so if you return false, dvander@122: * your plugin will not actually be paused or unloaded. This callback will be called when: dvander@122: * - Another plugin requests it dvander@122: * - Someone types "meta list", it will show up as "REFUSED" dvander@122: * - When Metamod need to re-check the plugin's status dvander@122: * - If the plugin does something like overload a factory, Metamod will make sure the Query() returns true dvander@122: * before calling it. dvander@122: * Also note that this query will only override Metamod when the plugin is running and not paused. dvander@7: * dvander@122: * @param error Buffer for error message. This can be NULL! dvander@122: * @param maxlen Maximum length of error buffer. dvander@122: * @return Status code - true for okay, false for badness. dvander@7: */ dvander@122: virtual bool QueryRunning(char *error, size_t maxlen) dvander@122: { dvander@122: return true; dvander@122: } dvander@122: dvander@122: /** dvander@122: * @brief Called on plugin unload. You can return false if you know your plugin dvander@122: * is not capable of restoring critical states it modifies. dvander@122: * dvander@122: * @param error Error message buffer dvander@122: * @param maxlen Size of error message buffer dvander@122: * @return True on success, return false to request no unload. dvander@122: */ dvander@122: virtual bool Unload(char *error, size_t maxlen) dvander@122: { dvander@122: return true; dvander@122: } dvander@7: dvander@30: /** @brief Called on plugin pause. dvander@7: * dvander@122: * @param error Error message buffer dvander@122: * @param maxlen Size of error message buffer dvander@122: * @return True on success, return false to request no pause. dvander@7: */ dvander@122: virtual bool Pause(char *error, size_t maxlen) dvander@122: { dvander@122: return true; dvander@122: } dvander@7: dvander@30: /** @brief Called on plugin unpause. dvander@7: * dvander@122: * @param error Error message buffer dvander@122: * @param maxlen Size of error message buffer dvander@122: * @return True on success, return false to request no unpause. dvander@7: */ dvander@122: virtual bool Unpause(char *error, size_t maxlen) dvander@122: { dvander@122: return true; dvander@122: } 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@122: * dvander@122: * This is useful for knowing when it's safe to request things another plugin might have. dvander@122: * NOTE for API 7 - This is called after DLLInit(). dvander@18: */ dvander@122: virtual void AllPluginsLoaded() dvander@122: { dvander@122: } dvander@7: }; dvander@7: dvander@138: /** dvander@166: * @brief Added in 1.1 so plugins could listen to specific events dvander@138: */ dvander@138: class IMetamodListener dvander@138: { dvander@138: public: dvander@138: virtual ~IMetamodListener() { } dvander@138: public: dvander@138: virtual void OnPluginLoad(PluginId id) { } dvander@138: dvander@138: virtual void OnPluginUnload(PluginId id) { } dvander@138: dvander@138: virtual void OnPluginPause(PluginId id) { } dvander@138: dvander@138: virtual void OnPluginUnpause(PluginId id) { } dvander@138: dvander@138: virtual void OnLevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background) { } dvander@138: dvander@141: virtual void OnLevelShutdown() { } dvander@141: dvander@138: virtual void *OnEngineQuery(const char *iface, int *ret) dvander@138: { dvander@138: if (ret) dvander@138: *ret = IFACE_FAILED; dvander@138: return NULL; dvander@138: } dvander@138: dvander@138: virtual void *OnPhysicsQuery(const char *iface, int *ret) dvander@138: { dvander@138: if (ret) dvander@138: *ret = IFACE_FAILED; dvander@138: return NULL; dvander@138: } dvander@138: dvander@138: virtual void *OnFileSystemQuery(const char *iface, int *ret) dvander@138: { dvander@138: if (ret) dvander@138: *ret = IFACE_FAILED; dvander@138: return NULL; dvander@138: } dvander@138: dvander@138: virtual void *OnGameDLLQuery(const char *iface, int *ret) dvander@138: { dvander@138: if (ret) dvander@138: *ret = IFACE_FAILED; dvander@138: return NULL; dvander@138: } dvander@138: dvander@138: virtual void *OnMetamodQuery(const char *iface, int *ret) dvander@138: { dvander@138: if (ret) dvander@138: *ret = IFACE_FAILED; dvander@138: return NULL; dvander@138: } dvander@138: }; dvander@138: dvander@122: #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@140: g_SHPtr = static_cast(ismm->MetaFactory(MMIFACE_SOURCEHOOK, NULL, NULL)); \ dvander@9: g_PLAPI = static_cast(this); \ dvander@9: g_PLID = id; dvander@7: dvander@122: #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@122: #define META_CONPRINT g_SMAPI->ConPrint dvander@122: #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@247: #if (__GNUC__ == 4) && (__GNUC_MINOR__ >= 1) dvander@247: #define SMM_API extern "C" __attribute__ ((visibility("default"))) dvander@247: #else dvander@247: #define SMM_API extern "C" dvander@247: #endif dvander@7: #endif dvander@7: #endif //!defined SMM_API dvander@7: dvander@251: /** dvander@251: * @brief Macro for automatically getting a current or newer Valve interface. dvander@251: * dvander@251: * @param v_factory Factory method to use from ISmmAPI (such as engineFactory). dvander@251: * @param v_var Variable name to store into. dvander@251: * @param v_type Interface type (do not include the pointer/asterisk). dvander@251: * @param v_name Inteface name. dvander@251: */ dvander@251: #define GET_V_IFACE_CURRENT(v_factory, v_var, v_type, v_name) \ dvander@251: v_var = (v_type *)ismm->VInterfaceMatch(ismm->v_factory(), v_name); \ dvander@251: if (!v_var) \ dvander@251: { \ dvander@251: if (error && maxlen) \ dvander@251: { \ dvander@251: snprintf(error, maxlen, "Could not find interface: %s", v_name); \ dvander@251: } \ dvander@251: return false; \ dvander@251: } dvander@251: dvander@251: /** dvander@251: * @brief Same as GET_V_IFACE, except searches for any. dvander@251: * dvander@251: * @param v_factory Factory method to use from ISmmAPI (such as engineFactory). dvander@251: * @param v_var Variable name to store into. dvander@251: * @param v_type Interface type (do not include the pointer/asterisk). dvander@251: * @param v_name Inteface name. dvander@251: */ dvander@251: #define GET_V_IFACE_ANY(v_factory, v_var, v_type, v_name) \ dvander@251: v_var = (v_type *)ismm->VInterfaceMatch(ismm->v_factory(), v_name, 0); \ dvander@251: if (!v_var) \ dvander@251: { \ dvander@251: if (error && maxlen) \ dvander@251: { \ dvander@251: snprintf(error, maxlen, "Could not find interface: %s", v_name); \ dvander@251: } \ dvander@251: return false; \ dvander@251: } dvander@251: dvander@251: dvander@7: #endif //_INCLUDE_ISMM_PLUGIN_H