|
dvander@371
|
1 |
/** |
|
dvander@371
|
2 |
* vim: set ts=4 : |
|
dvander@371
|
3 |
* ====================================================== |
|
dvander@371
|
4 |
* Metamod:Source |
|
dvander@371
|
5 |
* Copyright (C) 2004-2007 AlliedModders LLC and authors. |
|
dvander@371
|
6 |
* All rights reserved. |
|
dvander@371
|
7 |
* ====================================================== |
|
dvander@371
|
8 |
* |
|
dvander@371
|
9 |
* This software is provided 'as-is', without any express or implied warranty. |
|
dvander@371
|
10 |
* In no event will the authors be held liable for any damages arising from |
|
dvander@371
|
11 |
* the use of this software. |
|
dvander@371
|
12 |
* |
|
dvander@371
|
13 |
* Permission is granted to anyone to use this software for any purpose, |
|
dvander@371
|
14 |
* including commercial applications, and to alter it and redistribute it |
|
dvander@371
|
15 |
* freely, subject to the following restrictions: |
|
dvander@371
|
16 |
* |
|
dvander@371
|
17 |
* 1. The origin of this software must not be misrepresented; you must not |
|
dvander@371
|
18 |
* claim that you wrote the original software. If you use this software in a |
|
dvander@371
|
19 |
* product, an acknowledgment in the product documentation would be |
|
dvander@371
|
20 |
* appreciated but is not required. |
|
dvander@371
|
21 |
* 2. Altered source versions must be plainly marked as such, and must not be |
|
dvander@371
|
22 |
* misrepresented as being the original software. |
|
dvander@371
|
23 |
* 3. This notice may not be removed or altered from any source distribution. |
|
dvander@371
|
24 |
* |
|
dvander@371
|
25 |
* Version: $Id$ |
|
dvander@371
|
26 |
*/ |
|
dvander@371
|
27 |
|
|
dvander@371
|
28 |
#ifndef _INCLUDE_CPLUGIN_H |
|
dvander@371
|
29 |
#define _INCLUDE_CPLUGIN_H |
|
dvander@371
|
30 |
|
|
dvander@371
|
31 |
/** |
|
dvander@371
|
32 |
* @brief Implementation of Plugin API and Management routines |
|
dvander@371
|
33 |
* @file CPlugin.cpp |
|
dvander@371
|
34 |
*/ |
|
dvander@371
|
35 |
|
|
dvander@371
|
36 |
#include <interface.h> |
|
dvander@371
|
37 |
#include <eiface.h> |
|
dvander@396
|
38 |
#include <convar.h> |
|
dvander@371
|
39 |
#include <sh_list.h> |
|
dvander@371
|
40 |
#include <sh_string.h> |
|
dvander@371
|
41 |
#include "IPluginManager.h" |
|
dvander@371
|
42 |
#include "metamod_oslink.h" |
|
dvander@371
|
43 |
|
|
dvander@371
|
44 |
/** |
|
dvander@371
|
45 |
* History of plugin versions: (M=min, C=current) |
|
dvander@371
|
46 |
* 1: Initial interface |
|
dvander@371
|
47 |
* 2: Added GetLogTag() |
|
dvander@371
|
48 |
* 3: Moved GetApiVersion() to top (2005-04-16) |
|
dvander@371
|
49 |
* 4: Added AllPluginsLoaded() callback (2005-04-18) |
|
dvander@371
|
50 |
* 5: Bumped version for SourceHook V4 (2005-05-01) |
|
dvander@371
|
51 |
* 6: Added functions for console printing (2005-05-26) |
|
dvander@375
|
52 |
* 7: Changed template libraries (2005-08-11) |
|
dvander@371
|
53 |
* New loading structure mechanism |
|
dvander@371
|
54 |
* New SourceHook version |
|
dvander@371
|
55 |
* 8: New SourceHook version (2005-12-23) |
|
dvander@371
|
56 |
* New ISmmAPI additions |
|
dvander@371
|
57 |
* 9: New ISmmPluginManager additions |
|
dvander@375
|
58 |
* 10: Added VSP listen functions to ISmmAPI and IMetamodListener (2007-02-09) |
|
dvander@375
|
59 |
* 11: New SourceHook version v4.5 (May, 2007) |
|
dvander@375
|
60 |
* 12: Orange Box API |
|
dvander@375
|
61 |
* MC 13: Breaking of API for next SH version and other API changes |
|
dvander@371
|
62 |
*/ |
|
dvander@371
|
63 |
|
|
dvander@375
|
64 |
#define PLAPI_MIN_VERSION 13 |
|
dvander@371
|
65 |
|
|
dvander@396
|
66 |
struct CNameAlias |
|
dvander@371
|
67 |
{ |
|
dvander@396
|
68 |
SourceHook::String alias; |
|
dvander@396
|
69 |
SourceHook::String value; |
|
dvander@396
|
70 |
}; |
|
dvander@396
|
71 |
/** |
|
dvander@396
|
72 |
* @brief Implements Plugin Manager API |
|
dvander@396
|
73 |
*/ |
|
dvander@396
|
74 |
class CPluginManager : public ISmmPluginManager |
|
dvander@396
|
75 |
{ |
|
dvander@396
|
76 |
public: |
|
dvander@396
|
77 |
/** |
|
dvander@396
|
78 |
* @brief Internal structure for holding plugin data |
|
dvander@396
|
79 |
*/ |
|
dvander@396
|
80 |
class CPlugin |
|
dvander@371
|
81 |
{ |
|
dvander@396
|
82 |
public: |
|
dvander@396
|
83 |
CPlugin(); |
|
dvander@371
|
84 |
public: |
|
dvander@396
|
85 |
PluginId m_Id; |
|
dvander@396
|
86 |
SourceHook::String m_File; |
|
dvander@396
|
87 |
Pl_Status m_Status; |
|
dvander@396
|
88 |
PluginId m_Source; |
|
dvander@396
|
89 |
ISmmPlugin *m_API; |
|
dvander@396
|
90 |
HINSTANCE m_Lib; |
|
dvander@396
|
91 |
SourceHook::List<ConCommandBase *> m_Cvars; |
|
dvander@396
|
92 |
SourceHook::List<ConCommandBase *> m_Cmds; |
|
dvander@396
|
93 |
SourceHook::List<IMetamodListener *> m_Events; |
|
dvander@396
|
94 |
}; |
|
dvander@396
|
95 |
public: |
|
dvander@396
|
96 |
CPluginManager(); |
|
dvander@396
|
97 |
~CPluginManager(); |
|
dvander@396
|
98 |
void SetAllLoaded(); |
|
dvander@396
|
99 |
public: |
|
dvander@396
|
100 |
PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen); |
|
dvander@396
|
101 |
bool Unload(PluginId id, bool force, char *error, size_t maxlen); |
|
dvander@396
|
102 |
bool Pause(PluginId id, char *error, size_t maxlen); |
|
dvander@396
|
103 |
bool Unpause(PluginId id, char *error, size_t maxlen); |
|
dvander@396
|
104 |
bool UnloadAll(); |
|
dvander@396
|
105 |
void SetAlias(const char *alias, const char *value); |
|
dvander@396
|
106 |
public: |
|
dvander@397
|
107 |
bool Query(PluginId id, const char **file, Pl_Status *status, PluginId *source); |
|
dvander@396
|
108 |
bool QueryRunning(PluginId id, char *error, size_t maxlength); |
|
dvander@397
|
109 |
bool QueryHandle(PluginId id, void **handle); |
|
dvander@371
|
110 |
|
|
dvander@396
|
111 |
void AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar); |
|
dvander@396
|
112 |
void AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd); |
|
dvander@396
|
113 |
void RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar); |
|
dvander@396
|
114 |
void RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd); |
|
dvander@371
|
115 |
|
|
dvander@396
|
116 |
/** |
|
dvander@396
|
117 |
* @brief Finds a plugin by Id |
|
dvander@396
|
118 |
* |
|
dvander@396
|
119 |
* @param id Id of plugin |
|
dvander@396
|
120 |
* @return CPlugin on success, NULL otherwise |
|
dvander@396
|
121 |
*/ |
|
dvander@396
|
122 |
CPlugin *FindById(PluginId id); |
|
dvander@371
|
123 |
|
|
dvander@396
|
124 |
CPlugin *FindByAPI(ISmmPlugin *api); |
|
dvander@371
|
125 |
|
|
dvander@396
|
126 |
/** |
|
dvander@396
|
127 |
* @brief Attempts to reload a failed plugin |
|
dvander@396
|
128 |
* |
|
dvander@396
|
129 |
* @param id Id of plugin |
|
dvander@396
|
130 |
* @param error Error message buffer |
|
dvander@396
|
131 |
* @param len Maximum length of buffer |
|
dvander@396
|
132 |
* @return True on success, false otherwise |
|
dvander@396
|
133 |
*/ |
|
dvander@396
|
134 |
bool Retry(PluginId id, char *error, size_t len); |
|
dvander@371
|
135 |
|
|
dvander@396
|
136 |
int GetPluginCount(); |
|
dvander@396
|
137 |
const char *GetStatusText(CPlugin *pl); |
|
dvander@371
|
138 |
|
|
dvander@396
|
139 |
//get alias info |
|
dvander@396
|
140 |
const char *LookupAlias(const char *alias); |
|
dvander@396
|
141 |
SourceHook::List<CNameAlias *>::iterator _alias_begin(); |
|
dvander@396
|
142 |
SourceHook::List<CNameAlias *>::iterator _alias_end(); |
|
dvander@396
|
143 |
|
|
dvander@396
|
144 |
//Internal iterators |
|
dvander@396
|
145 |
SourceHook::List<CPluginManager::CPlugin *>::iterator _begin(); |
|
dvander@396
|
146 |
SourceHook::List<CPluginManager::CPlugin *>::iterator _end(); |
|
dvander@396
|
147 |
private: |
|
dvander@396
|
148 |
//These are identical internal functions for the wrappers above. |
|
dvander@396
|
149 |
CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen); |
|
dvander@396
|
150 |
bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen); |
|
dvander@396
|
151 |
bool _Pause(CPlugin *pl, char *error, size_t maxlen); |
|
dvander@396
|
152 |
bool _Unpause(CPlugin *pl, char *error, size_t maxlen); |
|
dvander@396
|
153 |
void UnregAllConCmds(CPlugin *pl); |
|
dvander@396
|
154 |
private: |
|
dvander@396
|
155 |
PluginId m_LastId; |
|
dvander@396
|
156 |
SourceHook::List<CPlugin *> m_Plugins; |
|
dvander@396
|
157 |
SourceHook::List<CNameAlias *> m_Aliases; |
|
dvander@396
|
158 |
bool m_AllLoaded; |
|
dvander@371
|
159 |
}; |
|
dvander@371
|
160 |
|
|
dvander@396
|
161 |
typedef SourceHook::List<CPluginManager::CPlugin *>::iterator PluginIter; |
|
dvander@371
|
162 |
|
|
dvander@371
|
163 |
/** @brief Singleton for plugin manager */ |
|
dvander@396
|
164 |
extern CPluginManager g_PluginMngr; |
|
dvander@371
|
165 |
|
|
dvander@371
|
166 |
#endif //_INCLUDE_CPLUGIN_H |
|
dvander@371
|
167 |
|