2 * vim: set ts=4 sw=4 tw=99 noet:
3 * =============================================================================
4 * SourceMod Base Extension Code
5 * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
6 * =============================================================================
8 * This program is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, version 3.0, as published by the
10 * Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License along with
18 * this program. If not, see <http://www.gnu.org/licenses/>.
20 * As a special exception, AlliedModders LLC gives you permission to link the
21 * code of this program (as well as its derivative works) to "Half-Life 2," the
22 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
23 * by the Valve Corporation. You must obey the GNU General Public License in
24 * all respects for all other code used. Additionally, AlliedModders LLC grants
25 * this exception to all derivative works. AlliedModders LLC defines further
26 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
27 * or <http://www.sourcemod.net/license.php>.
34 #include "smsdk_ext.h"
38 * @brief Contains wrappers for making Extensions easier to write.
41 IExtension *myself = NULL; /**< Ourself */
42 IShareSys *g_pShareSys = NULL; /**< Share system */
43 IShareSys *sharesys = NULL; /**< Share system */
44 ISourceMod *g_pSM = NULL; /**< SourceMod helpers */
45 ISourceMod *smutils = NULL; /**< SourceMod helpers */
47 #if defined SMEXT_ENABLE_FORWARDSYS
48 IForwardManager *g_pForwards = NULL; /**< Forward system */
49 IForwardManager *forwards = NULL; /**< Forward system */
51 #if defined SMEXT_ENABLE_HANDLESYS
52 IHandleSys *g_pHandleSys = NULL; /**< Handle system */
53 IHandleSys *handlesys = NULL; /**< Handle system */
55 #if defined SMEXT_ENABLE_PLAYERHELPERS
56 IPlayerManager *playerhelpers = NULL; /**< Player helpers */
57 #endif //SMEXT_ENABLE_PLAYERHELPERS
58 #if defined SMEXT_ENABLE_DBMANAGER
59 IDBManager *dbi = NULL; /**< DB Manager */
60 #endif //SMEXT_ENABLE_DBMANAGER
61 #if defined SMEXT_ENABLE_GAMECONF
62 IGameConfigManager *gameconfs = NULL; /**< Game config manager */
63 #endif //SMEXT_ENABLE_DBMANAGER
64 #if defined SMEXT_ENABLE_MEMUTILS
65 IMemoryUtils *memutils = NULL;
66 #endif //SMEXT_ENABLE_DBMANAGER
67 #if defined SMEXT_ENABLE_GAMEHELPERS
68 IGameHelpers *gamehelpers = NULL;
70 #if defined SMEXT_ENABLE_TIMERSYS
71 ITimerSystem *timersys = NULL;
73 #if defined SMEXT_ENABLE_ADTFACTORY
74 IADTFactory *adtfactory = NULL;
76 #if defined SMEXT_ENABLE_THREADER
77 IThreader *threader = NULL;
79 #if defined SMEXT_ENABLE_LIBSYS
80 ILibrarySys *libsys = NULL;
82 #if defined SMEXT_ENABLE_PLUGINSYS
83 SourceMod::IPluginManager *plsys;
85 #if defined SMEXT_ENABLE_MENUS
86 IMenuManager *menus = NULL;
88 #if defined SMEXT_ENABLE_ADMINSYS
89 IAdminSystem *adminsys = NULL;
91 #if defined SMEXT_ENABLE_TEXTPARSERS
92 ITextParsers *textparsers = NULL;
94 #if defined SMEXT_ENABLE_USERMSGS
95 IUserMessages *usermsgs = NULL;
97 #if defined SMEXT_ENABLE_TRANSLATOR
98 ITranslator *translator = NULL;
100 #if defined SMEXT_ENABLE_NINVOKE
101 INativeInterface *ninvoke = NULL;
103 #if defined SMEXT_ENABLE_ROOTCONSOLEMENU
104 IRootConsole *rootconsole = NULL;
107 /** Exports the main interface */
108 PLATFORM_EXTERN_C IExtensionInterface *GetSMExtAPI()
110 return g_pExtensionIface;
113 SDKExtension::SDKExtension()
115 #if defined SMEXT_CONF_METAMOD
116 m_SourceMMLoaded = false;
117 m_WeAreUnloaded = false;
118 m_WeGotPauseChange = false;
122 bool SDKExtension::OnExtensionLoad(IExtension *me, IShareSys *sys, char *error, size_t maxlength, bool late)
124 g_pShareSys = sharesys = sys;
127 #if defined SMEXT_CONF_METAMOD
128 m_WeAreUnloaded = true;
130 if (!m_SourceMMLoaded)
134 snprintf(error, maxlength, "Metamod attach failed");
139 SM_GET_IFACE(SOURCEMOD, g_pSM);
141 #if defined SMEXT_ENABLE_HANDLESYS
142 SM_GET_IFACE(HANDLESYSTEM, g_pHandleSys);
143 handlesys = g_pHandleSys;
145 #if defined SMEXT_ENABLE_FORWARDSYS
146 SM_GET_IFACE(FORWARDMANAGER, g_pForwards);
147 forwards = g_pForwards;
149 #if defined SMEXT_ENABLE_PLAYERHELPERS
150 SM_GET_IFACE(PLAYERMANAGER, playerhelpers);
152 #if defined SMEXT_ENABLE_DBMANAGER
153 SM_GET_IFACE(DBI, dbi);
155 #if defined SMEXT_ENABLE_GAMECONF
156 SM_GET_IFACE(GAMECONFIG, gameconfs);
158 #if defined SMEXT_ENABLE_MEMUTILS
159 SM_GET_IFACE(MEMORYUTILS, memutils);
161 #if defined SMEXT_ENABLE_GAMEHELPERS
162 SM_GET_IFACE(GAMEHELPERS, gamehelpers);
164 #if defined SMEXT_ENABLE_TIMERSYS
165 SM_GET_IFACE(TIMERSYS, timersys);
167 #if defined SMEXT_ENABLE_ADTFACTORY
168 SM_GET_IFACE(ADTFACTORY, adtfactory);
170 #if defined SMEXT_ENABLE_THREADER
171 SM_GET_IFACE(THREADER, threader);
173 #if defined SMEXT_ENABLE_LIBSYS
174 SM_GET_IFACE(LIBRARYSYS, libsys);
176 #if defined SMEXT_ENABLE_PLUGINSYS
177 SM_GET_IFACE(PLUGINSYSTEM, plsys);
179 #if defined SMEXT_ENABLE_MENUS
180 SM_GET_IFACE(MENUMANAGER, menus);
182 #if defined SMEXT_ENABLE_ADMINSYS
183 SM_GET_IFACE(ADMINSYS, adminsys);
185 #if defined SMEXT_ENABLE_TEXTPARSERS
186 SM_GET_IFACE(TEXTPARSERS, textparsers);
188 #if defined SMEXT_ENABLE_USERMSGS
189 SM_GET_IFACE(USERMSGS, usermsgs);
191 #if defined SMEXT_ENABLE_TRANSLATOR
192 SM_GET_IFACE(TRANSLATOR, translator);
194 #if defined SMEXT_ENABLE_NINVOKE
195 SM_GET_IFACE(NINVOKE, ninvoke);
197 #if defined SMEXT_ENABLE_ROOTCONSOLEMENU
198 SM_GET_IFACE(ROOTCONSOLE, rootconsole);
201 if (SDK_OnLoad(error, maxlength, late))
203 #if defined SMEXT_CONF_METAMOD
204 m_WeAreUnloaded = true;
212 bool SDKExtension::IsMetamodExtension()
214 #if defined SMEXT_CONF_METAMOD
221 void SDKExtension::OnExtensionPauseChange(bool state)
223 #if defined SMEXT_CONF_METAMOD
224 m_WeGotPauseChange = true;
226 SDK_OnPauseChange(state);
229 void SDKExtension::OnExtensionsAllLoaded()
234 void SDKExtension::OnExtensionUnload()
236 #if defined SMEXT_CONF_METAMOD
237 m_WeAreUnloaded = true;
242 void SDKExtension::OnDependenciesDropped()
244 SDK_OnDependenciesDropped();
247 const char *SDKExtension::GetExtensionAuthor()
249 return SMEXT_CONF_AUTHOR;
252 const char *SDKExtension::GetExtensionDateString()
254 return SMEXT_CONF_DATESTRING;
257 const char *SDKExtension::GetExtensionDescription()
259 return SMEXT_CONF_DESCRIPTION;
262 const char *SDKExtension::GetExtensionVerString()
264 return SMEXT_CONF_VERSION;
267 const char *SDKExtension::GetExtensionName()
269 return SMEXT_CONF_NAME;
272 const char *SDKExtension::GetExtensionTag()
274 return SMEXT_CONF_LOGTAG;
277 const char *SDKExtension::GetExtensionURL()
279 return SMEXT_CONF_URL;
282 bool SDKExtension::SDK_OnLoad(char *error, size_t maxlength, bool late)
287 void SDKExtension::SDK_OnUnload()
291 void SDKExtension::SDK_OnPauseChange(bool paused)
295 void SDKExtension::SDK_OnAllLoaded()
299 void SDKExtension::SDK_OnDependenciesDropped()
303 #if defined SMEXT_CONF_METAMOD
305 PluginId g_PLID = 0; /**< Metamod plugin ID */
306 ISmmPlugin *g_PLAPI = NULL; /**< Metamod plugin API */
307 SourceHook::ISourceHook *g_SHPtr = NULL; /**< SourceHook pointer */
308 ISmmAPI *g_SMAPI = NULL; /**< SourceMM API pointer */
310 IVEngineServer *engine = NULL; /**< IVEngineServer pointer */
311 IServerGameDLL *gamedll = NULL; /**< IServerGameDLL pointer */
313 /** Exposes the extension to Metamod */
314 SMM_API void *PL_EXPOSURE(const char *name, int *code)
316 #if defined METAMOD_PLAPI_VERSION
317 if (name && !strcmp(name, METAMOD_PLAPI_NAME))
319 if (name && !strcmp(name, PLAPI_NAME))
326 return static_cast<void *>(g_pExtensionIface);
331 *code = IFACE_FAILED;
337 bool SDKExtension::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen, bool late)
341 #if !defined METAMOD_PLAPI_VERSION
342 GET_V_IFACE_ANY(serverFactory, gamedll, IServerGameDLL, INTERFACEVERSION_SERVERGAMEDLL);
343 GET_V_IFACE_CURRENT(engineFactory, engine, IVEngineServer, INTERFACEVERSION_VENGINESERVER);
345 GET_V_IFACE_ANY(GetServerFactory, gamedll, IServerGameDLL, INTERFACEVERSION_SERVERGAMEDLL);
346 GET_V_IFACE_CURRENT(GetEngineFactory, engine, IVEngineServer, INTERFACEVERSION_VENGINESERVER);
349 m_SourceMMLoaded = true;
351 return SDK_OnMetamodLoad(ismm, error, maxlen, late);
354 bool SDKExtension::Unload(char *error, size_t maxlen)
356 if (!m_WeAreUnloaded)
360 snprintf(error, maxlen, "This extension must be unloaded by SourceMod.");
365 return SDK_OnMetamodUnload(error, maxlen);
368 bool SDKExtension::Pause(char *error, size_t maxlen)
370 if (!m_WeGotPauseChange)
374 snprintf(error, maxlen, "This extension must be paused by SourceMod.");
379 m_WeGotPauseChange = false;
381 return SDK_OnMetamodPauseChange(true, error, maxlen);
384 bool SDKExtension::Unpause(char *error, size_t maxlen)
386 if (!m_WeGotPauseChange)
390 snprintf(error, maxlen, "This extension must be unpaused by SourceMod.");
395 m_WeGotPauseChange = false;
397 return SDK_OnMetamodPauseChange(false, error, maxlen);
400 const char *SDKExtension::GetAuthor()
402 return GetExtensionAuthor();
405 const char *SDKExtension::GetDate()
407 return GetExtensionDateString();
410 const char *SDKExtension::GetDescription()
412 return GetExtensionDescription();
415 const char *SDKExtension::GetLicense()
417 return SMEXT_CONF_LICENSE;
420 const char *SDKExtension::GetLogTag()
422 return GetExtensionTag();
425 const char *SDKExtension::GetName()
427 return GetExtensionName();
430 const char *SDKExtension::GetURL()
432 return GetExtensionURL();
435 const char *SDKExtension::GetVersion()
437 return GetExtensionVerString();
440 bool SDKExtension::SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late)
445 bool SDKExtension::SDK_OnMetamodUnload(char *error, size_t maxlength)
450 bool SDKExtension::SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength)
457 /* Overload a few things to prevent libstdc++ linking */
458 #if defined __linux__ || defined __APPLE__
459 extern "C" void __cxa_pure_virtual(void)
463 void *operator new(size_t size)
468 void *operator new[](size_t size)
473 void operator delete(void *ptr)
478 void operator delete[](void * ptr)