dvander@371: /** dvander@371: * vim: set ts=4 : dvander@371: * ====================================================== dvander@371: * Metamod:Source ds@523: * Copyright (C) 2004-2008 AlliedModders LLC and authors. dvander@371: * All rights reserved. dvander@371: * ====================================================== dvander@371: * dvander@371: * This software is provided 'as-is', without any express or implied warranty. dvander@371: * In no event will the authors be held liable for any damages arising from dvander@371: * the use of this software. dvander@371: * dvander@371: * Permission is granted to anyone to use this software for any purpose, dvander@371: * including commercial applications, and to alter it and redistribute it dvander@371: * freely, subject to the following restrictions: dvander@371: * dvander@371: * 1. The origin of this software must not be misrepresented; you must not dvander@371: * claim that you wrote the original software. If you use this software in a dvander@371: * product, an acknowledgment in the product documentation would be dvander@371: * appreciated but is not required. dvander@371: * 2. Altered source versions must be plainly marked as such, and must not be dvander@371: * misrepresented as being the original software. dvander@371: * 3. This notice may not be removed or altered from any source distribution. dvander@371: * dvander@371: * Version: $Id$ dvander@371: */ dvander@371: dvander@371: #ifndef _INCLUDE_CPLUGIN_H dvander@371: #define _INCLUDE_CPLUGIN_H dvander@371: dvander@371: /** dvander@371: * @brief Implementation of Plugin API and Management routines dvander@371: * @file CPlugin.cpp dvander@371: */ dvander@371: dvander@371: #include dvander@371: #include dvander@396: #include dvander@371: #include dvander@371: #include dvander@400: #include dvander@400: #include dvander@371: #include "metamod_oslink.h" dvander@371: dvander@371: /** dvander@371: * History of plugin versions: (M=min, C=current) dvander@371: * 1: Initial interface dvander@371: * 2: Added GetLogTag() dvander@371: * 3: Moved GetApiVersion() to top (2005-04-16) dvander@371: * 4: Added AllPluginsLoaded() callback (2005-04-18) dvander@371: * 5: Bumped version for SourceHook V4 (2005-05-01) dvander@371: * 6: Added functions for console printing (2005-05-26) dvander@375: * 7: Changed template libraries (2005-08-11) dvander@371: * New loading structure mechanism dvander@371: * New SourceHook version dvander@371: * 8: New SourceHook version (2005-12-23) dvander@371: * New ISmmAPI additions dvander@371: * 9: New ISmmPluginManager additions dvander@375: * 10: Added VSP listen functions to ISmmAPI and IMetamodListener (2007-02-09) dvander@375: * 11: New SourceHook version v4.5 (May, 2007) dvander@375: * 12: Orange Box API dvander@400: * 13: Breaking of API for next SH version and other API changes dvander@400: * MC 14: ABI stability reached for 1.6.0 changes dvander@371: */ dvander@371: dvander@400: #define PLAPI_MIN_VERSION 14 dvander@371: dvander@396: struct CNameAlias dvander@371: { dvander@396: SourceHook::String alias; dvander@396: SourceHook::String value; dvander@396: }; dvander@396: /** dvander@396: * @brief Implements Plugin Manager API dvander@396: */ dvander@396: class CPluginManager : public ISmmPluginManager dvander@396: { dvander@396: public: dvander@396: /** dvander@396: * @brief Internal structure for holding plugin data dvander@396: */ dvander@396: class CPlugin dvander@371: { dvander@396: public: dvander@396: CPlugin(); dvander@371: public: dvander@396: PluginId m_Id; dvander@396: SourceHook::String m_File; dvander@396: Pl_Status m_Status; dvander@396: PluginId m_Source; dvander@396: ISmmPlugin *m_API; dvander@396: HINSTANCE m_Lib; dvander@396: SourceHook::List m_Cvars; dvander@396: SourceHook::List m_Cmds; dvander@396: SourceHook::List m_Events; dvander@400: METAMOD_FN_UNLOAD m_UnloadFn; dvander@396: }; dvander@396: public: dvander@396: CPluginManager(); dvander@396: ~CPluginManager(); dvander@396: void SetAllLoaded(); dvander@396: public: dvander@396: PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen); dvander@396: bool Unload(PluginId id, bool force, char *error, size_t maxlen); dvander@396: bool Pause(PluginId id, char *error, size_t maxlen); dvander@396: bool Unpause(PluginId id, char *error, size_t maxlen); dvander@396: bool UnloadAll(); dvander@396: void SetAlias(const char *alias, const char *value); dvander@396: public: dvander@397: bool Query(PluginId id, const char **file, Pl_Status *status, PluginId *source); dvander@396: bool QueryRunning(PluginId id, char *error, size_t maxlength); dvander@397: bool QueryHandle(PluginId id, void **handle); dvander@371: dvander@396: void AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar); dvander@396: void AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd); dvander@396: void RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar); dvander@396: void RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd); dvander@371: dvander@396: /** dvander@396: * @brief Finds a plugin by Id dvander@396: * dvander@396: * @param id Id of plugin dvander@396: * @return CPlugin on success, NULL otherwise dvander@396: */ dvander@396: CPlugin *FindById(PluginId id); dvander@371: dvander@396: CPlugin *FindByAPI(ISmmPlugin *api); dvander@371: dvander@396: /** dvander@396: * @brief Attempts to reload a failed plugin dvander@396: * dvander@396: * @param id Id of plugin dvander@396: * @param error Error message buffer dvander@396: * @param len Maximum length of buffer dvander@396: * @return True on success, false otherwise dvander@396: */ dvander@396: bool Retry(PluginId id, char *error, size_t len); dvander@371: dvander@396: int GetPluginCount(); dvander@396: const char *GetStatusText(CPlugin *pl); dvander@371: dvander@396: //get alias info dvander@396: const char *LookupAlias(const char *alias); dvander@396: SourceHook::List::iterator _alias_begin(); dvander@396: SourceHook::List::iterator _alias_end(); dvander@396: dvander@396: //Internal iterators dvander@396: SourceHook::List::iterator _begin(); dvander@396: SourceHook::List::iterator _end(); dvander@396: private: dvander@396: //These are identical internal functions for the wrappers above. dvander@396: CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen); dvander@396: bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen); dvander@396: bool _Pause(CPlugin *pl, char *error, size_t maxlen); dvander@396: bool _Unpause(CPlugin *pl, char *error, size_t maxlen); dvander@396: void UnregAllConCmds(CPlugin *pl); dvander@396: private: dvander@396: PluginId m_LastId; dvander@396: SourceHook::List m_Plugins; dvander@396: SourceHook::List m_Aliases; dvander@396: bool m_AllLoaded; dvander@371: }; dvander@371: dvander@396: typedef SourceHook::List::iterator PluginIter; dvander@371: dvander@371: /** @brief Singleton for plugin manager */ dvander@396: extern CPluginManager g_PluginMngr; dvander@371: dvander@371: #endif //_INCLUDE_CPLUGIN_H dvander@371: