dvander@541: /* ======== SourceMM ======== dvander@541: * Copyright (C) 2004-2008 Metamod:Source Development Team dvander@541: * No warranties of any kind dvander@541: * dvander@541: * License: zlib/libpng dvander@541: * dvander@541: * Author(s): David "BAILOPAN" Anderson dvander@541: * ============================ dvander@541: */ dvander@541: dvander@541: #ifndef _INCLUDE_CPLUGIN_H dvander@541: #define _INCLUDE_CPLUGIN_H dvander@541: dvander@541: /** dvander@541: * @brief Implementation of Plugin API and Management routines dvander@541: * @file CPlugin.cpp dvander@541: */ dvander@541: dvander@541: #include dvander@541: #include dvander@541: #include "convar_smm.h" dvander@541: #include "IPluginManager.h" dvander@541: #include "oslink.h" dvander@541: #include "sh_list.h" dvander@541: #include "sh_string.h" dvander@541: dvander@541: /** dvander@541: * History of plugin versions: (M=min, C=current) dvander@541: * 1: Initial interface dvander@541: * 2: Added GetLogTag() dvander@541: * 3: Moved GetApiVersion() to top (2005-04-16) dvander@541: * 4: Added AllPluginsLoaded() callback (2005-04-18) dvander@541: * 5: Bumped version for SourceHook V4 (2005-05-01) dvander@541: * 6: Added functions for console printing (2005-05-26) dvander@541: * M 7: Changed template libraries (2005-08-11) dvander@541: * New loading structure mechanism dvander@541: * New SourceHook version dvander@541: * 8: New SourceHook version (2005-12-23) dvander@541: * New ISmmAPI additions dvander@541: * 9: New ISmmPluginManager additions dvander@541: * C 10: Added VSP listen functions to ISmmAPI and IMetamodListener (2007-02-09) dvander@541: */ dvander@541: dvander@541: #define PLAPI_MIN_VERSION 7 dvander@541: dvander@541: namespace SourceMM dvander@541: { dvander@541: struct CNameAlias dvander@541: { dvander@541: SourceHook::String alias; dvander@541: SourceHook::String value; dvander@541: }; dvander@541: dvander@541: struct CPluginEventHandler dvander@541: { dvander@541: bool got_vsp; dvander@541: IMetamodListener *event; dvander@541: }; dvander@541: dvander@541: /** dvander@541: * @brief Implements Plugin Manager API dvander@541: */ dvander@541: class CPluginManager : public ISmmPluginManager dvander@541: { dvander@541: public: dvander@541: /** dvander@541: * @brief Internal structure for holding plugin data dvander@541: */ dvander@541: class CPlugin dvander@541: { dvander@541: public: dvander@541: CPlugin(); dvander@541: public: dvander@541: PluginId m_Id; dvander@541: SourceHook::String m_File; dvander@541: Pl_Status m_Status; dvander@541: PluginId m_Source; dvander@541: ISmmPlugin *m_API; dvander@541: HINSTANCE m_Lib; dvander@541: SourceHook::List m_Cvars; dvander@541: SourceHook::List m_Cmds; dvander@541: SourceHook::List m_Events; dvander@541: }; dvander@541: public: dvander@541: CPluginManager(); dvander@541: ~CPluginManager(); dvander@541: void SetAllLoaded(); dvander@541: public: dvander@541: PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen); dvander@541: bool Unload(PluginId id, bool force, char *error, size_t maxlen); dvander@541: bool Pause(PluginId id, char *error, size_t maxlen); dvander@541: bool Unpause(PluginId id, char *error, size_t maxlen); dvander@541: bool UnloadAll(); dvander@541: void SetAlias(const char *alias, const char *value); dvander@541: public: dvander@541: bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source); dvander@541: bool QueryRunning(PluginId id, char *error, size_t maxlength); dvander@541: bool QueryHandle(PluginId id, void *&handle); dvander@541: dvander@541: void AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar); dvander@541: void AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd); dvander@541: void RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar); dvander@541: void RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd); dvander@541: dvander@541: /** dvander@541: * @brief Finds a plugin by Id dvander@541: * dvander@541: * @param id Id of plugin dvander@541: * @return CPlugin on success, NULL otherwise dvander@541: */ dvander@541: CPlugin *FindById(PluginId id); dvander@541: dvander@541: CPlugin *FindByAPI(ISmmPlugin *api); dvander@541: dvander@541: /** dvander@541: * @brief Attempts to reload a failed plugin dvander@541: * dvander@541: * @param id Id of plugin dvander@541: * @param error Error message buffer dvander@541: * @param len Maximum length of buffer dvander@541: * @return True on success, false otherwise dvander@541: */ dvander@541: bool Retry(PluginId id, char *error, size_t len); dvander@541: dvander@541: //get alias info dvander@541: const char *LookupAlias(const char *alias); dvander@541: SourceHook::List::iterator _alias_begin(); dvander@541: SourceHook::List::iterator _alias_end(); dvander@541: dvander@541: //Internal iterators dvander@541: SourceHook::List::iterator _begin(); dvander@541: SourceHook::List::iterator _end(); dvander@541: dvander@541: void SetVSPAsLoaded(); dvander@541: unsigned int GetPluginCount(); dvander@541: const char *GetStatusText(CPlugin *pl); dvander@541: private: dvander@541: //These are identical internal functions for the wrappers above. dvander@541: CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen); dvander@541: bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen); dvander@541: bool _Pause(CPlugin *pl, char *error, size_t maxlen); dvander@541: bool _Unpause(CPlugin *pl, char *error, size_t maxlen); dvander@541: void UnregAllConCmds(CPlugin *pl); dvander@541: private: dvander@541: PluginId m_LastId; dvander@541: SourceHook::List m_Plugins; dvander@541: SourceHook::List m_Aliases; dvander@541: bool m_AllLoaded; dvander@541: }; dvander@541: }; dvander@541: dvander@664: void NotifyConCommandBaseDrop(PluginId id, ConCommandBase *base); dvander@664: dvander@541: typedef SourceHook::List::iterator PluginIter; dvander@541: dvander@541: /** @brief Singleton for plugin manager */ dvander@541: extern SourceMM::CPluginManager g_PluginMngr; dvander@541: dvander@541: #endif //_INCLUDE_CPLUGIN_H