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