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