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