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