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