dvander@347: /* ======== SourceMM ======== dvander@347: * Copyright (C) 2004-2007 Metamod:Source Development Team dvander@347: * No warranties of any kind dvander@347: * dvander@347: * License: zlib/libpng dvander@347: * dvander@347: * Author(s): David "BAILOPAN" Anderson dvander@347: * ============================ dvander@347: */ dvander@347: dvander@347: #ifndef _INCLUDE_ISMM_PLUGIN_H dvander@347: #define _INCLUDE_ISMM_PLUGIN_H dvander@347: dvander@347: /** dvander@347: * @brief Plugin API interface dvander@347: * @file ISmmPlugin.h dvander@347: */ dvander@347: dvander@347: #include dvander@347: #include dvander@347: #include "ISmmAPI.h" dvander@347: dvander@348: #define PLAPI_VERSION 12 dvander@347: #define PLAPI_NAME "ISmmPlugin" dvander@347: dvander@347: class ISmmAPI; dvander@347: dvander@347: class ISmmPlugin dvander@347: { dvander@347: public: dvander@347: virtual int GetApiVersion() { return PLAPI_VERSION; } dvander@347: virtual ~ISmmPlugin() { } dvander@347: public: dvander@347: /** dvander@347: * @brief Called on plugin load. dvander@351: * dvander@347: * NOTE - As of API 7, this is called as DLLInit() executes - after the parameters are known, but before dvander@347: * the original GameDLL function is called. Therefore, you cannot hook it, but you don't need to - dvander@347: * Load() is basically your hook. dvander@347: * NOTE - As of API 7, you can override factories before the engine and gamedll exchange them. dvander@347: * However, take care to note that if your plugin is unloaded, and the gamedll/engine have cached dvander@347: * an interface you've passed, something will definitely crash. Be careful. dvander@347: * dvander@351: * @param id Internal id of plugin. Saved globally by PLUGIN_SAVEVARS() dvander@351: * @param ismm External API for SourceMM. Saved globally by PLUGIN_SAVEVARS() dvander@351: * @param list Contains a list of factories. Hook a factory call by setting one equal to your own function. dvander@351: * @param late Set to true if your plugin was loaded late (not at server load). dvander@351: * @param error Error message buffer dvander@351: * @param maxlen Size of error message buffer dvander@351: * @return True if successful, return false to reject the load. dvander@347: */ dvander@347: virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0; dvander@347: dvander@347: /** dvander@351: * @brief Called when your plugin is "queried". dvander@351: * dvander@351: * This is useful for rejecting a loaded state. For example, if your plugin wants dvander@351: * to stop operating, it can simply return false and copy an error message. This dvander@351: * will notify other plugins or MM:S of something bad that happened. NOTE - MM:S dvander@351: * will not cache the return state, so if you return false, your plugin will not dvander@351: * actually be paused or unloaded. This callback will be called when: dvander@347: * - Another plugin requests it dvander@347: * - Someone types "meta list", it will show up as "REFUSED" dvander@347: * - When Metamod need to re-check the plugin's status dvander@347: * - If the plugin does something like overload a factory, Metamod will make sure the Query() returns true dvander@347: * before calling it. dvander@347: * Also note that this query will only override Metamod when the plugin is running and not paused. dvander@347: * dvander@347: * @param error Buffer for error message. This can be NULL! dvander@347: * @param maxlen Maximum length of error buffer. dvander@347: * @return Status code - true for okay, false for badness. dvander@347: */ dvander@347: virtual bool QueryRunning(char *error, size_t maxlen) dvander@347: { dvander@347: return true; dvander@347: } dvander@347: dvander@347: /** dvander@347: * @brief Called on plugin unload. You can return false if you know your plugin dvander@347: * is not capable of restoring critical states it modifies. dvander@347: * dvander@347: * @param error Error message buffer dvander@347: * @param maxlen Size of error message buffer dvander@347: * @return True on success, return false to request no unload. dvander@347: */ dvander@347: virtual bool Unload(char *error, size_t maxlen) dvander@347: { dvander@347: return true; dvander@347: } dvander@347: dvander@347: /** @brief Called on plugin pause. dvander@347: * dvander@347: * @param error Error message buffer dvander@347: * @param maxlen Size of error message buffer dvander@347: * @return True on success, return false to request no pause. dvander@347: */ dvander@347: virtual bool Pause(char *error, size_t maxlen) dvander@347: { dvander@347: return true; dvander@347: } dvander@347: dvander@347: /** @brief Called on plugin unpause. dvander@347: * dvander@347: * @param error Error message buffer dvander@347: * @param maxlen Size of error message buffer dvander@347: * @return True on success, return false to request no unpause. dvander@347: */ dvander@347: virtual bool Unpause(char *error, size_t maxlen) dvander@347: { dvander@347: return true; dvander@347: } dvander@347: public: dvander@347: /** @brief Return author as string */ dvander@347: virtual const char *GetAuthor() =0; dvander@347: dvander@347: /** @brief Return plugin name as string */ dvander@347: virtual const char *GetName() =0; dvander@347: dvander@347: /** @brief Return a description as string */ dvander@347: virtual const char *GetDescription() =0; dvander@347: dvander@347: /** @brief Return a URL as string */ dvander@347: virtual const char *GetURL() =0; dvander@347: dvander@347: /** @brief Return quick license code as string */ dvander@347: virtual const char *GetLicense() =0; dvander@347: dvander@347: /** @brief Return version as string */ dvander@347: virtual const char *GetVersion() =0; dvander@347: dvander@347: /** @brief Return author as string */ dvander@347: virtual const char *GetDate() =0; dvander@347: dvander@347: /** @brief Return author as string */ dvander@347: virtual const char *GetLogTag() =0; dvander@347: public: dvander@347: /** dvander@351: * @brief Called when all plugins have been loaded. dvander@347: * dvander@351: * This is called after DLLInit(), and thus the mod has been mostly initialized. dvander@351: * It is also safe to assume that all other (automatically loaded) plugins are now dvander@351: * ready to start interacting, because they are all loaded. dvander@347: */ dvander@347: virtual void AllPluginsLoaded() dvander@347: { dvander@347: } dvander@347: }; dvander@347: dvander@347: /** dvander@347: * @brief Added in 1.1 so plugins could listen to specific events dvander@347: */ dvander@347: class IMetamodListener dvander@347: { dvander@347: public: dvander@351: virtual ~IMetamodListener() dvander@351: { dvander@351: } dvander@347: public: dvander@347: /** dvander@347: * @brief Called when a plugin is loaded. dvander@347: * dvander@347: * @param id Id of the plugin. dvander@347: */ dvander@351: virtual void OnPluginLoad(PluginId id) dvander@351: { dvander@351: } dvander@347: dvander@347: /** dvander@347: * @brief Called when a plugin is unloaded. dvander@347: * dvander@347: * @param id Id of the plugin. dvander@347: */ dvander@351: virtual void OnPluginUnload(PluginId id) dvander@351: { dvander@351: } dvander@347: dvander@347: /** dvander@347: * @brief Called when a plugin is paused. dvander@347: * dvander@347: * @param id Id of the plugin. dvander@347: */ dvander@351: virtual void OnPluginPause(PluginId id) dvander@351: { dvander@351: } dvander@347: dvander@347: /** dvander@347: * @brief Called when a plugin is unpaused. dvander@347: * dvander@347: * @param id Id of the plugin. dvander@347: */ dvander@351: virtual void OnPluginUnpause(PluginId id) dvander@351: { dvander@351: } dvander@347: dvander@347: /** dvander@347: * @brief Called when the level is loaded (after GameInit, before ServerActivate). dvander@347: * dvander@347: * To override this, hook IServerGameDLL::LevelInit(). dvander@347: * dvander@347: * @param pMapName Name of the map. dvander@347: * @param pMapEntities Lump string of the map entities, in KeyValue format. dvander@347: * @param pOldLevel Unknown. dvander@347: * @param pLandmarkName Unknown. dvander@347: * @param loadGame Unknown. dvander@347: * @param background Unknown. dvander@347: */ dvander@347: virtual void OnLevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background) { } dvander@347: dvander@347: /** dvander@347: * @brief Called when the level is shut down. May be called more than once. dvander@347: */ dvander@351: virtual void OnLevelShutdown() dvander@351: { dvander@351: } dvander@347: dvander@347: /** dvander@347: * @brief Called when engineFactory() is used through Metamod:Source's wrapper. dvander@347: * This can be used to provide interfaces to other plugins or the GameDLL. dvander@347: * dvander@347: * If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED. dvander@347: * dvander@347: * @param iface Interface string. dvander@347: * @param ret Optional pointer to store return code. dvander@347: * @return Generic pointer to the interface, or NULL if not found. dvander@347: */ dvander@347: virtual void *OnEngineQuery(const char *iface, int *ret) dvander@347: { dvander@347: if (ret) dvander@347: { dvander@347: *ret = IFACE_FAILED; dvander@347: } dvander@347: dvander@347: return NULL; dvander@347: } dvander@347: dvander@347: /** dvander@347: * @brief Called when the physics factory is used through Metamod:Source's wrapper. dvander@347: * This can be used to provide interfaces to other plugins. dvander@347: * dvander@347: * If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED. dvander@347: * dvander@347: * @param iface Interface string. dvander@347: * @param ret Optional pointer to store return code. dvander@347: * @return Generic pointer to the interface, or NULL if not found. dvander@347: */ dvander@347: virtual void *OnPhysicsQuery(const char *iface, int *ret) dvander@347: { dvander@347: if (ret) dvander@347: { dvander@347: *ret = IFACE_FAILED; dvander@347: } dvander@347: dvander@347: return NULL; dvander@347: } dvander@347: dvander@347: /** dvander@347: * @brief Called when the filesystem factory is used through Metamod:Source's wrapper. dvander@347: * This can be used to provide interfaces to other plugins. dvander@347: * dvander@347: * If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED. dvander@347: * dvander@347: * @param iface Interface string. dvander@347: * @param ret Optional pointer to store return code. dvander@347: * @return Generic pointer to the interface, or NULL if not found. dvander@347: */ dvander@347: virtual void *OnFileSystemQuery(const char *iface, int *ret) dvander@347: { dvander@347: if (ret) dvander@347: { dvander@347: *ret = IFACE_FAILED; dvander@347: } dvander@347: dvander@347: return NULL; dvander@347: } dvander@347: dvander@347: /** dvander@347: * @brief Called when the server DLL's factory is used through Metamod:Source's wrapper. dvander@347: * This can be used to provide interfaces to other plugins. dvander@347: * dvander@347: * If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED. dvander@347: * dvander@347: * @param iface Interface string. dvander@347: * @param ret Optional pointer to store return code. dvander@347: * @return Generic pointer to the interface, or NULL if not found. dvander@347: */ dvander@347: virtual void *OnGameDLLQuery(const char *iface, int *ret) dvander@347: { dvander@347: if (ret) dvander@347: { dvander@347: *ret = IFACE_FAILED; dvander@347: } dvander@347: dvander@347: return NULL; dvander@347: } dvander@347: dvander@347: /** dvander@347: * @brief Called when Metamod's own factory is invoked. dvander@347: * This can be used to provide interfaces to other plugins. dvander@347: * dvander@347: * If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED. dvander@347: * dvander@347: * @param iface Interface string. dvander@347: * @param ret Optional pointer to store return code. dvander@347: * @return Generic pointer to the interface, or NULL if not found. dvander@347: */ dvander@347: virtual void *OnMetamodQuery(const char *iface, int *ret) dvander@347: { dvander@347: if (ret) dvander@347: { dvander@347: *ret = IFACE_FAILED; dvander@347: } dvander@347: dvander@347: return NULL; dvander@347: } dvander@347: dvander@347: /** dvander@347: * @brief Called when Metamod:Source acquires a valid IServerPluginCallbacks dvander@347: * pointer to be used for hooking by plugins. dvander@347: * dvander@347: * This will only be called after a call to ISmmAPI::EnableVSPListener(). dvander@347: * If called before GameInit, this callback will occur before LevelInit. dvander@347: * Otherwise, it will be called on the first call after that. dvander@347: * dvander@347: * This callback is provided to all plugins regardless of which (or how many) dvander@347: * called EnableVSPListener(), but only if at least one did in fact enable it. dvander@347: * dvander@351: * This callback is only available for plugins using API v1:5 (Metamod:Source 1.4+). dvander@351: * If a plugin loads lately, it may still call EnableVSPListener(). dvander@347: * dvander@347: * @param iface Interface pointer. If NULL, then the VSP listening construct dvander@347: * failed to initialize and is not available. dvander@347: */ dvander@347: virtual void OnVSPListening(IServerPluginCallbacks *iface) dvander@347: { dvander@347: } dvander@348: dvander@351: /** dvander@351: * @brief Called when Metamod:Source is about to remove a concommand or convar. dvander@348: * This can also be called if ISmmAPI::UnregisterConCmdBase is used by a plugin. dvander@348: * dvander@348: * @param id Id of the plugin that created the concommand or convar. dvander@348: * @param pCommand Pointer to concommand or convar that is being removed. dvander@348: */ dvander@348: virtual void OnUnlinkConCommandBase(PluginId id, ConCommandBase *pCommand) dvander@348: { dvander@348: } dvander@347: }; dvander@347: dvander@347: #define PL_EXPOSURE CreateInterface dvander@347: #define PL_EXPOSURE_C "CreateInterface" dvander@347: dvander@347: #define PLUGIN_EXPOSE(name, var) \ dvander@347: ISmmAPI *g_SMAPI = NULL; \ dvander@347: ISmmPlugin *g_PLAPI = NULL; \ dvander@347: PluginId g_PLID = (PluginId)0; \ dvander@347: SourceHook::ISourceHook *g_SHPtr = NULL; \ dvander@347: SMM_API void *PL_EXPOSURE(const char *name, int *code) { \ dvander@347: if (name && !strcmp(name, PLAPI_NAME)) { \ dvander@347: return static_cast(&var); \ dvander@347: } \ dvander@347: return NULL; \ dvander@347: } dvander@347: dvander@347: #define PLUGIN_GLOBALVARS() \ dvander@347: extern SourceHook::ISourceHook *g_SHPtr; \ dvander@347: extern ISmmAPI *g_SMAPI; \ dvander@347: extern ISmmPlugin *g_PLAPI; \ dvander@347: extern PluginId g_PLID; dvander@347: dvander@347: #define PLUGIN_SAVEVARS() \ dvander@347: g_SMAPI = ismm; \ dvander@347: g_SHPtr = static_cast(ismm->MetaFactory(MMIFACE_SOURCEHOOK, NULL, NULL)); \ dvander@347: g_PLAPI = static_cast(this); \ dvander@347: g_PLID = id; dvander@347: dvander@347: #define META_LOG g_SMAPI->LogMsg dvander@347: #define META_REGCMD(name) g_SMAPI->RegisterConCmdBase(g_PLAPI, name##_command) dvander@347: #define META_REGCVAR(var) g_SMAPI->RegisterConCmdBase(g_PLAPI, var) dvander@347: #define META_UNREGCMD(name) g_SMAPI->UnregisterConCmdBase(g_PLAPI, name##_command) dvander@347: #define META_UNREGCVAR(var) g_SMAPI->UnregisterConCmdBase(g_PLAPI, var) dvander@347: #define META_CONPRINT g_SMAPI->ConPrint dvander@347: #define META_CONPRINTF g_SMAPI->ConPrintf dvander@347: dvander@347: /* Probably should use this up above someday */ dvander@347: #define CONCMD_VARNAME(name) name##_command dvander@347: dvander@347: #if !defined SMM_API dvander@347: #if defined __WIN32__ || defined _WIN32 || defined WIN32 dvander@347: #define SMM_API extern "C" __declspec(dllexport) dvander@347: #elif defined __GNUC__ dvander@347: #if (__GNUC__ == 4) && (__GNUC_MINOR__ >= 1) dvander@347: #define SMM_API extern "C" __attribute__ ((visibility("default"))) dvander@347: #else dvander@347: #define SMM_API extern "C" dvander@347: #endif dvander@347: #endif dvander@347: #endif //!defined SMM_API dvander@347: dvander@347: /** dvander@347: * @brief Macro for automatically getting a current or newer Valve interface. dvander@347: * dvander@347: * @param v_factory Factory method to use from ISmmAPI (such as engineFactory). dvander@347: * @param v_var Variable name to store into. dvander@347: * @param v_type Interface type (do not include the pointer/asterisk). dvander@347: * @param v_name Interface name. dvander@347: */ dvander@347: #define GET_V_IFACE_CURRENT(v_factory, v_var, v_type, v_name) \ dvander@347: v_var = (v_type *)ismm->VInterfaceMatch(ismm->v_factory(), v_name); \ dvander@347: if (!v_var) \ dvander@347: { \ dvander@347: if (error && maxlen) \ dvander@347: { \ dvander@347: snprintf(error, maxlen, "Could not find interface: %s", v_name); \ dvander@347: } \ dvander@347: return false; \ dvander@347: } dvander@347: dvander@347: /** dvander@347: * @brief Same as GET_V_IFACE, except searches for any. dvander@347: * dvander@347: * @param v_factory Factory method to use from ISmmAPI (such as engineFactory). dvander@347: * @param v_var Variable name to store into. dvander@347: * @param v_type Interface type (do not include the pointer/asterisk). dvander@347: * @param v_name Interface name. dvander@347: */ dvander@347: #define GET_V_IFACE_ANY(v_factory, v_var, v_type, v_name) \ dvander@347: v_var = (v_type *)ismm->VInterfaceMatch(ismm->v_factory(), v_name, 0); \ dvander@347: if (!v_var) \ dvander@347: { \ dvander@347: if (error && maxlen) \ dvander@347: { \ dvander@347: snprintf(error, maxlen, "Could not find interface: %s", v_name); \ dvander@347: } \ dvander@347: return false; \ dvander@347: } dvander@347: dvander@347: #endif //_INCLUDE_ISMM_PLUGIN_H dvander@355: