extensions/sdktools/sdk/smsdk_ext.cpp
author Scott Ehlert <ds@alliedmods.net>
Sun Sep 14 03:01:05 2008 -0500 (2008-09-14)
changeset 2289 44045ead61cd
parent 1952 b7aa2b626807
parent 1947 e73a1e51833b
child 2471 194be299b700
permissions -rw-r--r--
Eliminated head: da55a80522cf, a remnant of sourcemod-1.1.0 branch
ds@783
     1
/**
ds@783
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
ds@1330
     4
 * SourceMod Base Extension Code
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
ds@783
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
ds@783
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1233
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1233
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
ds@783
    28
 *
ds@783
    29
 * Version: $Id$
ds@783
    30
 */
ds@783
    31
ds@783
    32
#include <stdio.h>
ds@783
    33
#include <malloc.h>
ds@783
    34
#include "smsdk_ext.h"
ds@783
    35
ds@783
    36
/**
ds@783
    37
 * @file smsdk_ext.cpp
ds@783
    38
 * @brief Contains wrappers for making Extensions easier to write.
ds@783
    39
 */
ds@783
    40
dvander@950
    41
IExtension *myself = NULL;				/**< Ourself */
ds@783
    42
IShareSys *g_pShareSys = NULL;			/**< Share system */
dvander@950
    43
IShareSys *sharesys = NULL;				/**< Share system */
dvander@950
    44
ISourceMod *g_pSM = NULL;				/**< SourceMod helpers */
dvander@950
    45
ISourceMod *smutils = NULL;				/**< SourceMod helpers */
dvander@950
    46
dvander@950
    47
#if defined SMEXT_ENABLE_FORWARDSYS
dvander@950
    48
IForwardManager *g_pForwards = NULL;	/**< Forward system */
dvander@950
    49
IForwardManager *forwards = NULL;		/**< Forward system */
dvander@950
    50
#endif
dvander@950
    51
#if defined SMEXT_ENABLE_HANDLESYS
ds@783
    52
IHandleSys *g_pHandleSys = NULL;		/**< Handle system */
dvander@950
    53
IHandleSys *handlesys = NULL;			/**< Handle system */
dvander@950
    54
#endif
dvander@950
    55
#if defined SMEXT_ENABLE_PLAYERHELPERS
dvander@950
    56
IPlayerManager *playerhelpers = NULL;	/**< Player helpers */
dvander@950
    57
#endif //SMEXT_ENABLE_PLAYERHELPERS
dvander@950
    58
#if defined SMEXT_ENABLE_DBMANAGER
dvander@950
    59
IDBManager *dbi = NULL;					/**< DB Manager */
dvander@950
    60
#endif //SMEXT_ENABLE_DBMANAGER
dvander@950
    61
#if defined SMEXT_ENABLE_GAMECONF
dvander@950
    62
IGameConfigManager *gameconfs = NULL;	/**< Game config manager */
dvander@1233
    63
#endif //SMEXT_ENABLE_DBMANAGER
dvander@950
    64
#if defined SMEXT_ENABLE_MEMUTILS
dvander@950
    65
IMemoryUtils *memutils = NULL;
dvander@1233
    66
#endif //SMEXT_ENABLE_DBMANAGER
dvander@1028
    67
#if defined SMEXT_ENABLE_GAMEHELPERS
dvander@1028
    68
IGameHelpers *gamehelpers = NULL;
dvander@1028
    69
#endif
dvander@1028
    70
#if defined SMEXT_ENABLE_TIMERSYS
dvander@1028
    71
ITimerSystem *timersys = NULL;
dvander@1028
    72
#endif
dvander@1028
    73
#if defined SMEXT_ENABLE_ADTFACTORY
dvander@1028
    74
IADTFactory *adtfactory = NULL;
dvander@1028
    75
#endif
dvander@1233
    76
#if defined SMEXT_ENABLE_THREADER
dvander@1233
    77
IThreader *threader = NULL;
dvander@1233
    78
#endif
dvander@1233
    79
#if defined SMEXT_ENABLE_LIBSYS
dvander@1233
    80
ILibrarySys *libsys = NULL;
dvander@1233
    81
#endif
dvander@1430
    82
#if defined SMEXT_ENABLE_PLUGINSYS
dvander@1430
    83
SourceMod::IPluginManager *plsys;
dvander@1430
    84
#endif
ds@783
    85
ds@783
    86
/** Exports the main interface */
ds@783
    87
PLATFORM_EXTERN_C IExtensionInterface *GetSMExtAPI()
ds@783
    88
{
ds@783
    89
	return g_pExtensionIface;
ds@783
    90
}
ds@783
    91
ds@783
    92
SDKExtension::SDKExtension()
ds@783
    93
{
ds@783
    94
#if defined SMEXT_CONF_METAMOD
ds@783
    95
	m_SourceMMLoaded = false;
ds@783
    96
	m_WeAreUnloaded = false;
ds@783
    97
	m_WeGotPauseChange = false;
ds@783
    98
#endif
ds@783
    99
}
ds@783
   100
ds@783
   101
bool SDKExtension::OnExtensionLoad(IExtension *me, IShareSys *sys, char *error, size_t maxlength, bool late)
ds@783
   102
{
dvander@950
   103
	g_pShareSys = sharesys = sys;
ds@783
   104
	myself = me;
ds@783
   105
ds@783
   106
#if defined SMEXT_CONF_METAMOD
ds@783
   107
	m_WeAreUnloaded = true;
ds@783
   108
ds@783
   109
	if (!m_SourceMMLoaded)
ds@783
   110
	{
ds@783
   111
		if (error)
ds@783
   112
		{
ds@783
   113
			snprintf(error, maxlength, "Metamod attach failed");
ds@783
   114
		}
ds@783
   115
		return false;
ds@783
   116
	}
ds@783
   117
#endif
dvander@950
   118
	SM_GET_IFACE(SOURCEMOD, g_pSM);
dvander@950
   119
	smutils = g_pSM;
dvander@950
   120
#if defined SMEXT_ENABLE_HANDLESYS
ds@783
   121
	SM_GET_IFACE(HANDLESYSTEM, g_pHandleSys);
dvander@950
   122
	handlesys = g_pHandleSys;
dvander@950
   123
#endif
dvander@950
   124
#if defined SMEXT_ENABLE_FORWARDSYS
ds@783
   125
	SM_GET_IFACE(FORWARDMANAGER, g_pForwards);
dvander@950
   126
	forwards = g_pForwards;
dvander@950
   127
#endif
dvander@950
   128
#if defined SMEXT_ENABLE_PLAYERHELPERS
dvander@950
   129
	SM_GET_IFACE(PLAYERMANAGER, playerhelpers);
dvander@950
   130
#endif
dvander@950
   131
#if defined SMEXT_ENABLE_DBMANAGER
dvander@950
   132
	SM_GET_IFACE(DBI, dbi);
dvander@950
   133
#endif
dvander@950
   134
#if defined SMEXT_ENABLE_GAMECONF
dvander@950
   135
	SM_GET_IFACE(GAMECONFIG, gameconfs);
dvander@950
   136
#endif
dvander@950
   137
#if defined SMEXT_ENABLE_MEMUTILS
dvander@950
   138
	SM_GET_IFACE(MEMORYUTILS, memutils);
dvander@950
   139
#endif
dvander@1028
   140
#if defined SMEXT_ENABLE_GAMEHELPERS
dvander@1028
   141
	SM_GET_IFACE(GAMEHELPERS, gamehelpers);
dvander@1028
   142
#endif
dvander@1028
   143
#if defined SMEXT_ENABLE_TIMERSYS
dvander@1028
   144
	SM_GET_IFACE(TIMERSYS, timersys);
dvander@1028
   145
#endif
dvander@1028
   146
#if defined SMEXT_ENABLE_ADTFACTORY
dvander@1028
   147
	SM_GET_IFACE(ADTFACTORY, adtfactory);
dvander@1028
   148
#endif
dvander@1233
   149
#if defined SMEXT_ENABLE_THREADER
dvander@1233
   150
	SM_GET_IFACE(THREADER, threader);
dvander@1233
   151
#endif
dvander@1233
   152
#if defined SMEXT_ENABLE_LIBSYS
dvander@1233
   153
	SM_GET_IFACE(LIBRARYSYS, libsys);
dvander@1233
   154
#endif
dvander@1430
   155
#if defined SMEXT_ENABLE_PLUGINSYS
dvander@1430
   156
	SM_GET_IFACE(PLUGINSYSTEM, plsys);
dvander@1430
   157
#endif
ds@783
   158
ds@783
   159
	if (SDK_OnLoad(error, maxlength, late))
ds@783
   160
	{
ds@783
   161
#if defined SMEXT_CONF_METAMOD
ds@783
   162
		m_WeAreUnloaded = true;
ds@783
   163
#endif
ds@783
   164
		return true;
ds@783
   165
	}
ds@783
   166
ds@783
   167
	return false;
ds@783
   168
}
ds@783
   169
ds@783
   170
bool SDKExtension::IsMetamodExtension()
ds@783
   171
{
ds@783
   172
#if defined SMEXT_CONF_METAMOD
ds@783
   173
	return true;
ds@783
   174
#else
ds@783
   175
	return false;
ds@783
   176
#endif
ds@783
   177
}
ds@783
   178
ds@783
   179
void SDKExtension::OnExtensionPauseChange(bool state)
ds@783
   180
{
ds@783
   181
#if defined SMEXT_CONF_METAMOD
ds@783
   182
	m_WeGotPauseChange = true;
ds@783
   183
#endif
ds@783
   184
	SDK_OnPauseChange(state);
ds@783
   185
}
ds@783
   186
ds@783
   187
void SDKExtension::OnExtensionsAllLoaded()
ds@783
   188
{
ds@783
   189
	SDK_OnAllLoaded();
ds@783
   190
}
ds@783
   191
ds@783
   192
void SDKExtension::OnExtensionUnload()
ds@783
   193
{
ds@783
   194
#if defined SMEXT_CONF_METAMOD
ds@783
   195
	m_WeAreUnloaded = true;
ds@783
   196
#endif
ds@783
   197
	SDK_OnUnload();
ds@783
   198
}
ds@783
   199
ds@783
   200
const char *SDKExtension::GetExtensionAuthor()
ds@783
   201
{
ds@783
   202
	return SMEXT_CONF_AUTHOR;
ds@783
   203
}
ds@783
   204
ds@783
   205
const char *SDKExtension::GetExtensionDateString()
ds@783
   206
{
ds@783
   207
	return SMEXT_CONF_DATESTRING;
ds@783
   208
}
ds@783
   209
ds@783
   210
const char *SDKExtension::GetExtensionDescription()
ds@783
   211
{
ds@783
   212
	return SMEXT_CONF_DESCRIPTION;
ds@783
   213
}
ds@783
   214
ds@783
   215
const char *SDKExtension::GetExtensionVerString()
ds@783
   216
{
ds@783
   217
	return SMEXT_CONF_VERSION;
ds@783
   218
}
ds@783
   219
ds@783
   220
const char *SDKExtension::GetExtensionName()
ds@783
   221
{
ds@783
   222
	return SMEXT_CONF_NAME;
ds@783
   223
}
ds@783
   224
ds@783
   225
const char *SDKExtension::GetExtensionTag()
ds@783
   226
{
ds@783
   227
	return SMEXT_CONF_LOGTAG;
ds@783
   228
}
ds@783
   229
ds@783
   230
const char *SDKExtension::GetExtensionURL()
ds@783
   231
{
ds@783
   232
	return SMEXT_CONF_URL;
ds@783
   233
}
ds@783
   234
ds@783
   235
bool SDKExtension::SDK_OnLoad(char *error, size_t maxlength, bool late)
ds@783
   236
{
ds@783
   237
	return true;
ds@783
   238
}
ds@783
   239
ds@783
   240
void SDKExtension::SDK_OnUnload()
ds@783
   241
{
ds@783
   242
}
ds@783
   243
ds@783
   244
void SDKExtension::SDK_OnPauseChange(bool paused)
ds@783
   245
{
ds@783
   246
}
ds@783
   247
ds@783
   248
void SDKExtension::SDK_OnAllLoaded()
ds@783
   249
{
ds@783
   250
}
ds@783
   251
ds@783
   252
#if defined SMEXT_CONF_METAMOD
ds@783
   253
ds@783
   254
PluginId g_PLID = 0;						/**< Metamod plugin ID */
ds@783
   255
ISmmPlugin *g_PLAPI = NULL;					/**< Metamod plugin API */
ds@783
   256
SourceHook::ISourceHook *g_SHPtr = NULL;	/**< SourceHook pointer */
ds@783
   257
ISmmAPI *g_SMAPI = NULL;					/**< SourceMM API pointer */
ds@783
   258
ds@783
   259
IVEngineServer *engine = NULL;				/**< IVEngineServer pointer */
ds@783
   260
IServerGameDLL *gamedll = NULL;				/**< IServerGameDLL pointer */
ds@783
   261
ds@783
   262
/** Exposes the extension to Metamod */
ds@783
   263
SMM_API void *PL_EXPOSURE(const char *name, int *code)
ds@783
   264
{
faluco@1560
   265
	if (name && !strcmp(name, METAMOD_PLAPI_NAME))
ds@783
   266
	{
ds@783
   267
		if (code)
ds@783
   268
		{
ds@783
   269
			*code = IFACE_OK;
ds@783
   270
		}
ds@783
   271
		return static_cast<void *>(g_pExtensionIface);
ds@783
   272
	}
ds@783
   273
ds@783
   274
	if (code)
ds@783
   275
	{
ds@783
   276
		*code = IFACE_FAILED;
ds@783
   277
	}
ds@783
   278
ds@783
   279
	return NULL;
ds@783
   280
}
ds@783
   281
ds@783
   282
bool SDKExtension::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen, bool late)
ds@783
   283
{
ds@783
   284
	PLUGIN_SAVEVARS();
ds@783
   285
faluco@1560
   286
	GET_V_IFACE_ANY(GetServerFactory, gamedll, IServerGameDLL, INTERFACEVERSION_SERVERGAMEDLL);
faluco@1560
   287
	GET_V_IFACE_CURRENT(GetEngineFactory, engine, IVEngineServer, INTERFACEVERSION_VENGINESERVER);
ds@783
   288
ds@783
   289
	m_SourceMMLoaded = true;
ds@783
   290
ds@783
   291
	return SDK_OnMetamodLoad(ismm, error, maxlen, late);
ds@783
   292
}
ds@783
   293
ds@783
   294
bool SDKExtension::Unload(char *error, size_t maxlen)
ds@783
   295
{
ds@783
   296
	if (!m_WeAreUnloaded)
ds@783
   297
	{
ds@783
   298
		if (error)
ds@783
   299
		{
ds@783
   300
			snprintf(error, maxlen, "This extension must be unloaded by SourceMod.");
ds@783
   301
		}
ds@783
   302
		return false;
ds@783
   303
	}
ds@783
   304
ds@783
   305
	return SDK_OnMetamodUnload(error, maxlen);
ds@783
   306
}
ds@783
   307
ds@783
   308
bool SDKExtension::Pause(char *error, size_t maxlen)
ds@783
   309
{
ds@783
   310
	if (!m_WeGotPauseChange)
ds@783
   311
	{
ds@783
   312
		if (error)
ds@783
   313
		{
ds@783
   314
			snprintf(error, maxlen, "This extension must be paused by SourceMod.");
ds@783
   315
		}
ds@783
   316
		return false;
ds@783
   317
	}
ds@783
   318
ds@783
   319
	m_WeGotPauseChange = false;
ds@783
   320
ds@783
   321
	return SDK_OnMetamodPauseChange(true, error, maxlen);
ds@783
   322
}
ds@783
   323
ds@783
   324
bool SDKExtension::Unpause(char *error, size_t maxlen)
ds@783
   325
{
ds@783
   326
	if (!m_WeGotPauseChange)
ds@783
   327
	{
ds@783
   328
		if (error)
ds@783
   329
		{
ds@783
   330
			snprintf(error, maxlen, "This extension must be unpaused by SourceMod.");
ds@783
   331
		}
ds@783
   332
		return false;
ds@783
   333
	}
ds@783
   334
ds@783
   335
	m_WeGotPauseChange = false;
ds@783
   336
ds@783
   337
	return SDK_OnMetamodPauseChange(false, error, maxlen);
ds@783
   338
}
ds@783
   339
ds@783
   340
const char *SDKExtension::GetAuthor()
ds@783
   341
{
ds@783
   342
	return GetExtensionAuthor();
ds@783
   343
}
ds@783
   344
ds@783
   345
const char *SDKExtension::GetDate()
ds@783
   346
{
ds@783
   347
	return GetExtensionDateString();
ds@783
   348
}
ds@783
   349
ds@783
   350
const char *SDKExtension::GetDescription()
ds@783
   351
{
ds@783
   352
	return GetExtensionDescription();
ds@783
   353
}
ds@783
   354
ds@783
   355
const char *SDKExtension::GetLicense()
ds@783
   356
{
ds@783
   357
	return SMEXT_CONF_LICENSE;
ds@783
   358
}
ds@783
   359
ds@783
   360
const char *SDKExtension::GetLogTag()
ds@783
   361
{
ds@783
   362
	return GetExtensionTag();
ds@783
   363
}
ds@783
   364
ds@783
   365
const char *SDKExtension::GetName()
ds@783
   366
{
ds@783
   367
	return GetExtensionName();
ds@783
   368
}
ds@783
   369
ds@783
   370
const char *SDKExtension::GetURL()
ds@783
   371
{
ds@783
   372
	return GetExtensionURL();
ds@783
   373
}
ds@783
   374
ds@783
   375
const char *SDKExtension::GetVersion()
ds@783
   376
{
ds@783
   377
	return GetExtensionVerString();
ds@783
   378
}
ds@783
   379
ds@783
   380
bool SDKExtension::SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late)
ds@783
   381
{
ds@783
   382
	return true;
ds@783
   383
}
ds@783
   384
ds@783
   385
bool SDKExtension::SDK_OnMetamodUnload(char *error, size_t maxlength)
ds@783
   386
{
ds@783
   387
	return true;
ds@783
   388
}
ds@783
   389
ds@783
   390
bool SDKExtension::SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength)
ds@783
   391
{
ds@783
   392
	return true;
ds@783
   393
}
ds@783
   394
ds@783
   395
#endif
ds@783
   396
ds@783
   397
/* Overload a few things to prevent libstdc++ linking */
ds@783
   398
#if defined __linux__
ds@783
   399
extern "C" void __cxa_pure_virtual(void)
ds@783
   400
{
ds@783
   401
}
ds@783
   402
ds@783
   403
void *operator new(size_t size)
ds@783
   404
{
ds@783
   405
	return malloc(size);
ds@783
   406
}
ds@783
   407
ds@783
   408
void *operator new[](size_t size) 
ds@783
   409
{
ds@783
   410
	return malloc(size);
ds@783
   411
}
ds@783
   412
ds@783
   413
void operator delete(void *ptr) 
ds@783
   414
{
ds@783
   415
	free(ptr);
ds@783
   416
}
ds@783
   417
ds@783
   418
void operator delete[](void * ptr)
ds@783
   419
{
ds@783
   420
	free(ptr);
ds@783
   421
}
ds@783
   422
#endif