extensions/bintools/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@757
     1
/**
ds@757
     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@757
     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@757
    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@1226
    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@1226
    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@757
    28
 *
ds@757
    29
 * Version: $Id$
ds@757
    30
 */
ds@757
    31
ds@757
    32
#include <stdio.h>
ds@757
    33
#include <malloc.h>
ds@757
    34
#include "smsdk_ext.h"
ds@757
    35
ds@757
    36
/**
ds@757
    37
 * @file smsdk_ext.cpp
ds@757
    38
 * @brief Contains wrappers for making Extensions easier to write.
ds@757
    39
 */
ds@757
    40
dvander@943
    41
IExtension *myself = NULL;				/**< Ourself */
ds@757
    42
IShareSys *g_pShareSys = NULL;			/**< Share system */
dvander@943
    43
IShareSys *sharesys = NULL;				/**< Share system */
dvander@943
    44
ISourceMod *g_pSM = NULL;				/**< SourceMod helpers */
dvander@943
    45
ISourceMod *smutils = NULL;				/**< SourceMod helpers */
dvander@943
    46
dvander@943
    47
#if defined SMEXT_ENABLE_FORWARDSYS
dvander@943
    48
IForwardManager *g_pForwards = NULL;	/**< Forward system */
dvander@943
    49
IForwardManager *forwards = NULL;		/**< Forward system */
dvander@943
    50
#endif
dvander@943
    51
#if defined SMEXT_ENABLE_HANDLESYS
ds@757
    52
IHandleSys *g_pHandleSys = NULL;		/**< Handle system */
dvander@943
    53
IHandleSys *handlesys = NULL;			/**< Handle system */
dvander@943
    54
#endif
dvander@943
    55
#if defined SMEXT_ENABLE_PLAYERHELPERS
dvander@943
    56
IPlayerManager *playerhelpers = NULL;	/**< Player helpers */
dvander@943
    57
#endif //SMEXT_ENABLE_PLAYERHELPERS
dvander@943
    58
#if defined SMEXT_ENABLE_DBMANAGER
dvander@943
    59
IDBManager *dbi = NULL;					/**< DB Manager */
dvander@943
    60
#endif //SMEXT_ENABLE_DBMANAGER
dvander@943
    61
#if defined SMEXT_ENABLE_GAMECONF
dvander@943
    62
IGameConfigManager *gameconfs = NULL;	/**< Game config manager */
dvander@943
    63
#endif //SMEXT_ENABLE_DBMANAGER
dvander@1226
    64
#if defined SMEXT_ENABLE_MEMUTILS
dvander@1226
    65
IMemoryUtils *memutils = NULL;
dvander@1226
    66
#endif //SMEXT_ENABLE_DBMANAGER
dvander@1226
    67
#if defined SMEXT_ENABLE_GAMEHELPERS
dvander@1226
    68
IGameHelpers *gamehelpers = NULL;
dvander@1226
    69
#endif
dvander@1226
    70
#if defined SMEXT_ENABLE_TIMERSYS
dvander@1226
    71
ITimerSystem *timersys = NULL;
dvander@1226
    72
#endif
dvander@1226
    73
#if defined SMEXT_ENABLE_ADTFACTORY
dvander@1226
    74
IADTFactory *adtfactory = NULL;
dvander@1226
    75
#endif
dvander@1226
    76
#if defined SMEXT_ENABLE_THREADER
dvander@1226
    77
IThreader *threader = NULL;
dvander@1226
    78
#endif
dvander@1226
    79
#if defined SMEXT_ENABLE_LIBSYS
dvander@1226
    80
ILibrarySys *libsys = NULL;
dvander@1226
    81
#endif
ds@757
    82
ds@757
    83
/** Exports the main interface */
ds@757
    84
PLATFORM_EXTERN_C IExtensionInterface *GetSMExtAPI()
ds@757
    85
{
ds@757
    86
	return g_pExtensionIface;
ds@757
    87
}
ds@757
    88
ds@757
    89
SDKExtension::SDKExtension()
ds@757
    90
{
ds@757
    91
#if defined SMEXT_CONF_METAMOD
ds@757
    92
	m_SourceMMLoaded = false;
ds@757
    93
	m_WeAreUnloaded = false;
ds@757
    94
	m_WeGotPauseChange = false;
ds@757
    95
#endif
ds@757
    96
}
ds@757
    97
ds@757
    98
bool SDKExtension::OnExtensionLoad(IExtension *me, IShareSys *sys, char *error, size_t maxlength, bool late)
ds@757
    99
{
dvander@943
   100
	g_pShareSys = sharesys = sys;
ds@757
   101
	myself = me;
ds@757
   102
ds@757
   103
#if defined SMEXT_CONF_METAMOD
ds@757
   104
	m_WeAreUnloaded = true;
ds@757
   105
ds@757
   106
	if (!m_SourceMMLoaded)
ds@757
   107
	{
ds@757
   108
		if (error)
ds@757
   109
		{
ds@757
   110
			snprintf(error, maxlength, "Metamod attach failed");
ds@757
   111
		}
ds@757
   112
		return false;
ds@757
   113
	}
ds@757
   114
#endif
dvander@943
   115
	SM_GET_IFACE(SOURCEMOD, g_pSM);
dvander@943
   116
	smutils = g_pSM;
dvander@943
   117
#if defined SMEXT_ENABLE_HANDLESYS
ds@757
   118
	SM_GET_IFACE(HANDLESYSTEM, g_pHandleSys);
dvander@943
   119
	handlesys = g_pHandleSys;
dvander@943
   120
#endif
dvander@943
   121
#if defined SMEXT_ENABLE_FORWARDSYS
ds@757
   122
	SM_GET_IFACE(FORWARDMANAGER, g_pForwards);
dvander@943
   123
	forwards = g_pForwards;
dvander@943
   124
#endif
dvander@943
   125
#if defined SMEXT_ENABLE_PLAYERHELPERS
dvander@943
   126
	SM_GET_IFACE(PLAYERMANAGER, playerhelpers);
dvander@943
   127
#endif
dvander@943
   128
#if defined SMEXT_ENABLE_DBMANAGER
dvander@943
   129
	SM_GET_IFACE(DBI, dbi);
dvander@943
   130
#endif
dvander@943
   131
#if defined SMEXT_ENABLE_GAMECONF
dvander@943
   132
	SM_GET_IFACE(GAMECONFIG, gameconfs);
dvander@943
   133
#endif
dvander@1226
   134
#if defined SMEXT_ENABLE_MEMUTILS
dvander@1226
   135
	SM_GET_IFACE(MEMORYUTILS, memutils);
dvander@1226
   136
#endif
dvander@1226
   137
#if defined SMEXT_ENABLE_GAMEHELPERS
dvander@1226
   138
	SM_GET_IFACE(GAMEHELPERS, gamehelpers);
dvander@1226
   139
#endif
dvander@1226
   140
#if defined SMEXT_ENABLE_TIMERSYS
dvander@1226
   141
	SM_GET_IFACE(TIMERSYS, timersys);
dvander@1226
   142
#endif
dvander@1226
   143
#if defined SMEXT_ENABLE_ADTFACTORY
dvander@1226
   144
	SM_GET_IFACE(ADTFACTORY, adtfactory);
dvander@1226
   145
#endif
dvander@1226
   146
#if defined SMEXT_ENABLE_THREADER
dvander@1226
   147
	SM_GET_IFACE(THREADER, threader);
dvander@1226
   148
#endif
dvander@1226
   149
#if defined SMEXT_ENABLE_LIBSYS
dvander@1226
   150
	SM_GET_IFACE(LIBRARYSYS, libsys);
dvander@1226
   151
#endif
ds@757
   152
ds@757
   153
	if (SDK_OnLoad(error, maxlength, late))
ds@757
   154
	{
ds@757
   155
#if defined SMEXT_CONF_METAMOD
ds@757
   156
		m_WeAreUnloaded = true;
ds@757
   157
#endif
ds@757
   158
		return true;
ds@757
   159
	}
ds@757
   160
ds@757
   161
	return false;
ds@757
   162
}
ds@757
   163
ds@757
   164
bool SDKExtension::IsMetamodExtension()
ds@757
   165
{
ds@757
   166
#if defined SMEXT_CONF_METAMOD
ds@757
   167
	return true;
ds@757
   168
#else
ds@757
   169
	return false;
ds@757
   170
#endif
ds@757
   171
}
ds@757
   172
ds@757
   173
void SDKExtension::OnExtensionPauseChange(bool state)
ds@757
   174
{
ds@757
   175
#if defined SMEXT_CONF_METAMOD
ds@757
   176
	m_WeGotPauseChange = true;
ds@757
   177
#endif
ds@757
   178
	SDK_OnPauseChange(state);
ds@757
   179
}
ds@757
   180
ds@757
   181
void SDKExtension::OnExtensionsAllLoaded()
ds@757
   182
{
ds@757
   183
	SDK_OnAllLoaded();
ds@757
   184
}
ds@757
   185
ds@757
   186
void SDKExtension::OnExtensionUnload()
ds@757
   187
{
ds@757
   188
#if defined SMEXT_CONF_METAMOD
ds@757
   189
	m_WeAreUnloaded = true;
ds@757
   190
#endif
ds@757
   191
	SDK_OnUnload();
ds@757
   192
}
ds@757
   193
ds@757
   194
const char *SDKExtension::GetExtensionAuthor()
ds@757
   195
{
ds@757
   196
	return SMEXT_CONF_AUTHOR;
ds@757
   197
}
ds@757
   198
ds@757
   199
const char *SDKExtension::GetExtensionDateString()
ds@757
   200
{
ds@757
   201
	return SMEXT_CONF_DATESTRING;
ds@757
   202
}
ds@757
   203
ds@757
   204
const char *SDKExtension::GetExtensionDescription()
ds@757
   205
{
ds@757
   206
	return SMEXT_CONF_DESCRIPTION;
ds@757
   207
}
ds@757
   208
ds@757
   209
const char *SDKExtension::GetExtensionVerString()
ds@757
   210
{
ds@757
   211
	return SMEXT_CONF_VERSION;
ds@757
   212
}
ds@757
   213
ds@757
   214
const char *SDKExtension::GetExtensionName()
ds@757
   215
{
ds@757
   216
	return SMEXT_CONF_NAME;
ds@757
   217
}
ds@757
   218
ds@757
   219
const char *SDKExtension::GetExtensionTag()
ds@757
   220
{
ds@757
   221
	return SMEXT_CONF_LOGTAG;
ds@757
   222
}
ds@757
   223
ds@757
   224
const char *SDKExtension::GetExtensionURL()
ds@757
   225
{
ds@757
   226
	return SMEXT_CONF_URL;
ds@757
   227
}
ds@757
   228
ds@757
   229
bool SDKExtension::SDK_OnLoad(char *error, size_t maxlength, bool late)
ds@757
   230
{
ds@757
   231
	return true;
ds@757
   232
}
ds@757
   233
ds@757
   234
void SDKExtension::SDK_OnUnload()
ds@757
   235
{
ds@757
   236
}
ds@757
   237
ds@757
   238
void SDKExtension::SDK_OnPauseChange(bool paused)
ds@757
   239
{
ds@757
   240
}
ds@757
   241
ds@757
   242
void SDKExtension::SDK_OnAllLoaded()
ds@757
   243
{
ds@757
   244
}
ds@757
   245
ds@757
   246
#if defined SMEXT_CONF_METAMOD
ds@757
   247
ds@757
   248
PluginId g_PLID = 0;						/**< Metamod plugin ID */
ds@757
   249
ISmmPlugin *g_PLAPI = NULL;					/**< Metamod plugin API */
ds@757
   250
SourceHook::ISourceHook *g_SHPtr = NULL;	/**< SourceHook pointer */
ds@757
   251
ISmmAPI *g_SMAPI = NULL;					/**< SourceMM API pointer */
ds@757
   252
ds@757
   253
IVEngineServer *engine = NULL;				/**< IVEngineServer pointer */
ds@757
   254
IServerGameDLL *gamedll = NULL;				/**< IServerGameDLL pointer */
ds@757
   255
ds@757
   256
/** Exposes the extension to Metamod */
ds@757
   257
SMM_API void *PL_EXPOSURE(const char *name, int *code)
ds@757
   258
{
ds@757
   259
	if (name && !strcmp(name, PLAPI_NAME))
ds@757
   260
	{
ds@757
   261
		if (code)
ds@757
   262
		{
ds@757
   263
			*code = IFACE_OK;
ds@757
   264
		}
ds@757
   265
		return static_cast<void *>(g_pExtensionIface);
ds@757
   266
	}
ds@757
   267
ds@757
   268
	if (code)
ds@757
   269
	{
ds@757
   270
		*code = IFACE_FAILED;
ds@757
   271
	}
ds@757
   272
ds@757
   273
	return NULL;
ds@757
   274
}
ds@757
   275
ds@757
   276
bool SDKExtension::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen, bool late)
ds@757
   277
{
ds@757
   278
	PLUGIN_SAVEVARS();
ds@757
   279
ds@757
   280
	GET_V_IFACE_ANY(serverFactory, gamedll, IServerGameDLL, INTERFACEVERSION_SERVERGAMEDLL);
ds@757
   281
	GET_V_IFACE_CURRENT(engineFactory, engine, IVEngineServer, INTERFACEVERSION_VENGINESERVER);
ds@757
   282
ds@757
   283
	m_SourceMMLoaded = true;
ds@757
   284
ds@757
   285
	return SDK_OnMetamodLoad(ismm, error, maxlen, late);
ds@757
   286
}
ds@757
   287
ds@757
   288
bool SDKExtension::Unload(char *error, size_t maxlen)
ds@757
   289
{
ds@757
   290
	if (!m_WeAreUnloaded)
ds@757
   291
	{
ds@757
   292
		if (error)
ds@757
   293
		{
ds@757
   294
			snprintf(error, maxlen, "This extension must be unloaded by SourceMod.");
ds@757
   295
		}
ds@757
   296
		return false;
ds@757
   297
	}
ds@757
   298
ds@757
   299
	return SDK_OnMetamodUnload(error, maxlen);
ds@757
   300
}
ds@757
   301
ds@757
   302
bool SDKExtension::Pause(char *error, size_t maxlen)
ds@757
   303
{
ds@757
   304
	if (!m_WeGotPauseChange)
ds@757
   305
	{
ds@757
   306
		if (error)
ds@757
   307
		{
ds@757
   308
			snprintf(error, maxlen, "This extension must be paused by SourceMod.");
ds@757
   309
		}
ds@757
   310
		return false;
ds@757
   311
	}
ds@757
   312
ds@757
   313
	m_WeGotPauseChange = false;
ds@757
   314
ds@757
   315
	return SDK_OnMetamodPauseChange(true, error, maxlen);
ds@757
   316
}
ds@757
   317
ds@757
   318
bool SDKExtension::Unpause(char *error, size_t maxlen)
ds@757
   319
{
ds@757
   320
	if (!m_WeGotPauseChange)
ds@757
   321
	{
ds@757
   322
		if (error)
ds@757
   323
		{
ds@757
   324
			snprintf(error, maxlen, "This extension must be unpaused by SourceMod.");
ds@757
   325
		}
ds@757
   326
		return false;
ds@757
   327
	}
ds@757
   328
ds@757
   329
	m_WeGotPauseChange = false;
ds@757
   330
ds@757
   331
	return SDK_OnMetamodPauseChange(false, error, maxlen);
ds@757
   332
}
ds@757
   333
ds@757
   334
const char *SDKExtension::GetAuthor()
ds@757
   335
{
ds@757
   336
	return GetExtensionAuthor();
ds@757
   337
}
ds@757
   338
ds@757
   339
const char *SDKExtension::GetDate()
ds@757
   340
{
ds@757
   341
	return GetExtensionDateString();
ds@757
   342
}
ds@757
   343
ds@757
   344
const char *SDKExtension::GetDescription()
ds@757
   345
{
ds@757
   346
	return GetExtensionDescription();
ds@757
   347
}
ds@757
   348
ds@757
   349
const char *SDKExtension::GetLicense()
ds@757
   350
{
ds@757
   351
	return SMEXT_CONF_LICENSE;
ds@757
   352
}
ds@757
   353
ds@757
   354
const char *SDKExtension::GetLogTag()
ds@757
   355
{
ds@757
   356
	return GetExtensionTag();
ds@757
   357
}
ds@757
   358
ds@757
   359
const char *SDKExtension::GetName()
ds@757
   360
{
ds@757
   361
	return GetExtensionName();
ds@757
   362
}
ds@757
   363
ds@757
   364
const char *SDKExtension::GetURL()
ds@757
   365
{
ds@757
   366
	return GetExtensionURL();
ds@757
   367
}
ds@757
   368
ds@757
   369
const char *SDKExtension::GetVersion()
ds@757
   370
{
ds@757
   371
	return GetExtensionVerString();
ds@757
   372
}
ds@757
   373
ds@757
   374
bool SDKExtension::SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late)
ds@757
   375
{
ds@757
   376
	return true;
ds@757
   377
}
ds@757
   378
ds@757
   379
bool SDKExtension::SDK_OnMetamodUnload(char *error, size_t maxlength)
ds@757
   380
{
ds@757
   381
	return true;
ds@757
   382
}
ds@757
   383
ds@757
   384
bool SDKExtension::SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength)
ds@757
   385
{
ds@757
   386
	return true;
ds@757
   387
}
ds@757
   388
ds@757
   389
#endif
ds@757
   390
ds@757
   391
/* Overload a few things to prevent libstdc++ linking */
ds@757
   392
#if defined __linux__
ds@757
   393
extern "C" void __cxa_pure_virtual(void)
ds@757
   394
{
ds@757
   395
}
ds@757
   396
ds@757
   397
void *operator new(size_t size)
ds@757
   398
{
ds@757
   399
	return malloc(size);
ds@757
   400
}
ds@757
   401
ds@757
   402
void *operator new[](size_t size) 
ds@757
   403
{
ds@757
   404
	return malloc(size);
ds@757
   405
}
ds@757
   406
ds@757
   407
void operator delete(void *ptr) 
ds@757
   408
{
ds@757
   409
	free(ptr);
ds@757
   410
}
ds@757
   411
ds@757
   412
void operator delete[](void * ptr)
ds@757
   413
{
ds@757
   414
	free(ptr);
ds@757
   415
}
ds@757
   416
#endif