|
dvander@7
|
1 |
/* ======== SourceMM ======== |
|
ds@294
|
2 |
* Copyright (C) 2004-2007 Metamod:Source Development Team |
|
dvander@7
|
3 |
* No warranties of any kind |
|
dvander@7
|
4 |
* |
|
dvander@7
|
5 |
* License: zlib/libpng |
|
dvander@7
|
6 |
* |
|
dvander@7
|
7 |
* Author(s): David "BAILOPAN" Anderson |
|
dvander@7
|
8 |
* ============================ |
|
dvander@7
|
9 |
*/ |
|
dvander@7
|
10 |
|
|
dvander@7
|
11 |
#ifndef _INCLUDE_CPLUGIN_H |
|
dvander@7
|
12 |
#define _INCLUDE_CPLUGIN_H |
|
dvander@7
|
13 |
|
|
dvander@7
|
14 |
/** |
|
dvander@7
|
15 |
* @brief Implementation of Plugin API and Management routines |
|
dvander@7
|
16 |
* @file CPlugin.cpp |
|
dvander@7
|
17 |
*/ |
|
dvander@7
|
18 |
|
|
dvander@67
|
19 |
#include <interface.h> |
|
dvander@67
|
20 |
#include <eiface.h> |
|
ds@280
|
21 |
#include "convar_smm.h" |
|
dvander@7
|
22 |
#include "IPluginManager.h" |
|
dvander@7
|
23 |
#include "oslink.h" |
|
dvander@98
|
24 |
#include "sh_list.h" |
|
dvander@98
|
25 |
#include "sh_string.h" |
|
dvander@7
|
26 |
|
|
dvander@51
|
27 |
/** |
|
dvander@51
|
28 |
* History of plugin versions: (M=min, C=current) |
|
dvander@282
|
29 |
* 1: Initial interface |
|
dvander@282
|
30 |
* 2: Added GetLogTag() |
|
dvander@282
|
31 |
* 3: Moved GetApiVersion() to top (2005-04-16) |
|
dvander@282
|
32 |
* 4: Added AllPluginsLoaded() callback (2005-04-18) |
|
dvander@282
|
33 |
* 5: Bumped version for SourceHook V4 (2005-05-01) |
|
dvander@282
|
34 |
* 6: Added functions for console printing (2005-05-26) |
|
dvander@282
|
35 |
* M 7: Changed template libraries (2005-08-11) |
|
dvander@282
|
36 |
* New loading structure mechanism |
|
dvander@282
|
37 |
* New SourceHook version |
|
dvander@282
|
38 |
* 8: New SourceHook version (2005-12-23) |
|
dvander@282
|
39 |
* New ISmmAPI additions |
|
dvander@282
|
40 |
* 9: New ISmmPluginManager additions |
|
dvander@282
|
41 |
* C 10: Added VSP listen functions to ISmmAPI and IMetamodListener (2007-02-09) |
|
dvander@51
|
42 |
*/ |
|
dvander@51
|
43 |
|
|
dvander@105
|
44 |
#define PLAPI_MIN_VERSION 7 |
|
dvander@51
|
45 |
|
|
dvander@7
|
46 |
namespace SourceMM |
|
dvander@7
|
47 |
{ |
|
dvander@205
|
48 |
struct CNameAlias |
|
dvander@205
|
49 |
{ |
|
dvander@205
|
50 |
SourceHook::String alias; |
|
dvander@205
|
51 |
SourceHook::String value; |
|
dvander@205
|
52 |
}; |
|
dvander@7
|
53 |
/** |
|
dvander@7
|
54 |
* @brief Implements Plugin Manager API |
|
dvander@7
|
55 |
*/ |
|
dvander@7
|
56 |
class CPluginManager : public ISmmPluginManager |
|
dvander@7
|
57 |
{ |
|
dvander@7
|
58 |
public: |
|
dvander@7
|
59 |
/** |
|
dvander@7
|
60 |
* @brief Internal structure for holding plugin data |
|
dvander@7
|
61 |
*/ |
|
dvander@7
|
62 |
class CPlugin |
|
dvander@7
|
63 |
{ |
|
dvander@7
|
64 |
public: |
|
dvander@7
|
65 |
CPlugin(); |
|
dvander@7
|
66 |
public: |
|
dvander@7
|
67 |
PluginId m_Id; |
|
dvander@98
|
68 |
SourceHook::String m_File; |
|
dvander@7
|
69 |
Pl_Status m_Status; |
|
dvander@7
|
70 |
PluginId m_Source; |
|
dvander@7
|
71 |
ISmmPlugin *m_API; |
|
dvander@7
|
72 |
HINSTANCE m_Lib; |
|
dvander@98
|
73 |
SourceHook::List<ConCommandBase *> m_Cvars; |
|
dvander@98
|
74 |
SourceHook::List<ConCommandBase *> m_Cmds; |
|
dvander@138
|
75 |
SourceHook::List<IMetamodListener *> m_Events; |
|
dvander@7
|
76 |
}; |
|
dvander@7
|
77 |
public: |
|
dvander@7
|
78 |
CPluginManager(); |
|
dvander@7
|
79 |
~CPluginManager(); |
|
dvander@18
|
80 |
void SetAllLoaded(); |
|
dvander@7
|
81 |
public: |
|
dvander@7
|
82 |
PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen); |
|
dvander@9
|
83 |
bool Unload(PluginId id, bool force, char *error, size_t maxlen); |
|
dvander@7
|
84 |
bool Pause(PluginId id, char *error, size_t maxlen); |
|
dvander@7
|
85 |
bool Unpause(PluginId id, char *error, size_t maxlen); |
|
dvander@7
|
86 |
bool UnloadAll(); |
|
dvander@205
|
87 |
void SetAlias(const char *alias, const char *value); |
|
dvander@7
|
88 |
public: |
|
dvander@138
|
89 |
bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source); |
|
dvander@122
|
90 |
bool QueryRunning(PluginId id, char *error, size_t maxlength); |
|
dvander@227
|
91 |
bool QueryHandle(PluginId id, void *&handle); |
|
dvander@7
|
92 |
|
|
dvander@67
|
93 |
void AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar); |
|
dvander@67
|
94 |
void AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd); |
|
dvander@67
|
95 |
void RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar); |
|
dvander@67
|
96 |
void RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd); |
|
dvander@67
|
97 |
|
|
dvander@7
|
98 |
/** |
|
dvander@7
|
99 |
* @brief Finds a plugin by Id |
|
dvander@7
|
100 |
* |
|
dvander@7
|
101 |
* @param id Id of plugin |
|
dvander@7
|
102 |
* @return CPlugin on success, NULL otherwise |
|
dvander@7
|
103 |
*/ |
|
dvander@7
|
104 |
CPlugin *FindById(PluginId id); |
|
dvander@7
|
105 |
|
|
dvander@67
|
106 |
CPlugin *FindByAPI(ISmmPlugin *api); |
|
dvander@67
|
107 |
|
|
dvander@29
|
108 |
/** |
|
dvander@29
|
109 |
* @brief Attempts to reload a failed plugin |
|
dvander@29
|
110 |
* |
|
dvander@29
|
111 |
* @param id Id of plugin |
|
dvander@29
|
112 |
* @param error Error message buffer |
|
dvander@29
|
113 |
* @param len Maximum length of buffer |
|
dvander@29
|
114 |
* @return True on success, false otherwise |
|
dvander@29
|
115 |
*/ |
|
dvander@29
|
116 |
bool Retry(PluginId id, char *error, size_t len); |
|
dvander@29
|
117 |
|
|
dvander@205
|
118 |
//get alias info |
|
dvander@205
|
119 |
const char *LookupAlias(const char *alias); |
|
dvander@205
|
120 |
SourceHook::List<SourceMM::CNameAlias *>::iterator _alias_begin(); |
|
dvander@205
|
121 |
SourceHook::List<SourceMM::CNameAlias *>::iterator _alias_end(); |
|
dvander@205
|
122 |
|
|
dvander@7
|
123 |
//Internal iterators |
|
dvander@98
|
124 |
SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _begin(); |
|
dvander@98
|
125 |
SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _end(); |
|
dvander@7
|
126 |
private: |
|
dvander@7
|
127 |
//These are identical internal functions for the wrappers above. |
|
dvander@7
|
128 |
CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen); |
|
dvander@9
|
129 |
bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen); |
|
dvander@7
|
130 |
bool _Pause(CPlugin *pl, char *error, size_t maxlen); |
|
dvander@7
|
131 |
bool _Unpause(CPlugin *pl, char *error, size_t maxlen); |
|
dvander@67
|
132 |
void UnregAllConCmds(CPlugin *pl); |
|
dvander@7
|
133 |
private: |
|
dvander@7
|
134 |
PluginId m_LastId; |
|
dvander@98
|
135 |
SourceHook::List<CPlugin *> m_Plugins; |
|
dvander@205
|
136 |
SourceHook::List<CNameAlias *> m_Aliases; |
|
dvander@18
|
137 |
bool m_AllLoaded; |
|
dvander@7
|
138 |
}; |
|
dvander@7
|
139 |
}; |
|
dvander@7
|
140 |
|
|
dvander@98
|
141 |
typedef SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator PluginIter; |
|
dvander@7
|
142 |
|
|
dvander@7
|
143 |
/** @brief Singleton for plugin manager */ |
|
dvander@7
|
144 |
extern SourceMM::CPluginManager g_PluginMngr; |
|
dvander@7
|
145 |
|
|
dvander@7
|
146 |
#endif //_INCLUDE_CPLUGIN_H |