1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2005 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * ============================
11 #ifndef _INCLUDE_CPLUGIN_H
12 #define _INCLUDE_CPLUGIN_H
15 * @brief Implementation of Plugin API and Management routines
19 #include <interface.h>
22 #include "IPluginManager.h"
25 #include "sh_string.h"
28 * History of plugin versions: (M=min, C=current)
29 * 1: Initial interface
30 * 2: Added GetLogTag()
31 * 3: Moved GetApiVersion() to top (2005-04-16)
32 * 4: Added AllPluginsLoaded() callback (2005-04-18)
33 * 5: Bumped version for SourceHook V4 (2005-05-01)
34 * 6: Added functions for console printing (2005-05-26)
35 * MC 7: Changed template libraries (2005-08-11)
36 * New loading structure mechanism
37 * New SourceHook version
40 #define PLAPI_MIN_VERSION 7
45 * @brief Implements Plugin Manager API
47 class CPluginManager : public ISmmPluginManager
51 * @brief Internal structure for holding plugin data
59 SourceHook::String m_File;
65 SourceHook::List<ConCommandBase *> m_Cvars;
66 SourceHook::List<ConCommandBase *> m_Cmds;
73 PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen);
74 bool Unload(PluginId id, bool force, char *error, size_t maxlen);
75 bool Pause(PluginId id, char *error, size_t maxlen);
76 bool Unpause(PluginId id, char *error, size_t maxlen);
79 bool Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source);
80 bool QueryRunning(PluginId id, char *error, size_t maxlength);
82 void AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
83 void AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
84 void RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
85 void RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
88 * @brief Finds a plugin by Id
90 * @param id Id of plugin
91 * @return CPlugin on success, NULL otherwise
93 CPlugin *FindById(PluginId id);
95 CPlugin *FindByAPI(ISmmPlugin *api);
98 * @brief Attempts to reload a failed plugin
100 * @param id Id of plugin
101 * @param error Error message buffer
102 * @param len Maximum length of buffer
103 * @return True on success, false otherwise
105 bool Retry(PluginId id, char *error, size_t len);
108 SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _begin();
109 SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _end();
111 //These are identical internal functions for the wrappers above.
112 CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen);
113 bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen);
114 bool _Pause(CPlugin *pl, char *error, size_t maxlen);
115 bool _Unpause(CPlugin *pl, char *error, size_t maxlen);
116 void UnregAllConCmds(CPlugin *pl);
119 SourceHook::List<CPlugin *> m_Plugins;
124 typedef SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator PluginIter;
126 /** @brief Singleton for plugin manager */
127 extern SourceMM::CPluginManager g_PluginMngr;
129 #endif //_INCLUDE_CPLUGIN_H