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