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