sourcemm/ISmmPlugin.h
author David Anderson <dvander@alliedmods.net>
Mon Oct 08 20:21:14 2007 +0000 (2007-10-08)
changeset 400 beabd7f601c2
parent 398 13e6e510cc6c
child 405 4699669af081
permissions -rw-r--r--
abi is now locked
dvander@371
     1
/**
dvander@371
     2
 * vim: set ts=4 :
dvander@371
     3
 * ======================================================
dvander@371
     4
 * Metamod:Source
dvander@371
     5
 * Copyright (C) 2004-2007 AlliedModders LLC and authors.
dvander@371
     6
 * All rights reserved.
dvander@371
     7
 * ======================================================
dvander@371
     8
 *
dvander@371
     9
 * This software is provided 'as-is', without any express or implied warranty.
dvander@371
    10
 * In no event will the authors be held liable for any damages arising from 
dvander@371
    11
 * the use of this software.
dvander@371
    12
 * 
dvander@371
    13
 * Permission is granted to anyone to use this software for any purpose, 
dvander@371
    14
 * including commercial applications, and to alter it and redistribute it 
dvander@371
    15
 * freely, subject to the following restrictions:
dvander@371
    16
 *
dvander@371
    17
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@371
    18
 * claim that you wrote the original software. If you use this software in a 
dvander@371
    19
 * product, an acknowledgment in the product documentation would be 
dvander@371
    20
 * appreciated but is not required.
dvander@371
    21
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@371
    22
 * misrepresented as being the original software.
dvander@371
    23
 * 3. This notice may not be removed or altered from any source distribution.
dvander@371
    24
 *
dvander@371
    25
 * Version: $Id$
dvander@371
    26
 */
dvander@9
    27
dvander@7
    28
#ifndef _INCLUDE_ISMM_PLUGIN_H
dvander@7
    29
#define _INCLUDE_ISMM_PLUGIN_H
dvander@7
    30
dvander@9
    31
/**
dvander@9
    32
 * @brief Plugin API interface
dvander@9
    33
 * @file ISmmPlugin.h
dvander@9
    34
 */
dvander@9
    35
dvander@7
    36
#include <interface.h>
dvander@371
    37
#include <sourcehook.h>
dvander@396
    38
#include <IPluginManager.h>
dvander@396
    39
#include <ISmmAPI.h>
dvander@7
    40
dvander@400
    41
#define METAMOD_PLAPI_VERSION		14				/**< Version of this header file */
dvander@396
    42
#define METAMOD_PLAPI_NAME			"ISmmPlugin"	/**< Name of the plugin interface */
dvander@7
    43
dvander@396
    44
namespace SourceMM
dvander@7
    45
{
dvander@396
    46
	class ISmmAPI;
dvander@7
    47
dvander@122
    48
	/**
dvander@396
    49
	 * @brief Callbacks that a plugin must expose.
dvander@7
    50
	 */
dvander@396
    51
	class ISmmPlugin
dvander@122
    52
	{
dvander@396
    53
	public:
dvander@396
    54
		/**
dvander@396
    55
		 * @brief Called to request the plugin's API version.
dvander@396
    56
		 *
dvander@396
    57
		 * This is the first callback invoked, and always remains at the top 
dvander@396
    58
		 * of the virtual table.  
dvander@396
    59
		 *
dvander@396
    60
		 * @return			Plugin API version.
dvander@396
    61
		 */
dvander@396
    62
		virtual int GetApiVersion() 
dvander@396
    63
		{ 
dvander@396
    64
			return METAMOD_PLAPI_VERSION; 
dvander@396
    65
		}
dvander@396
    66
dvander@396
    67
		/**
dvander@396
    68
		 * @brief Virtual destructor so GCC doesn't complain.
dvander@396
    69
		 */
dvander@396
    70
		virtual ~ISmmPlugin()
dvander@396
    71
		{
dvander@396
    72
		}
dvander@122
    73
dvander@396
    74
	public:
dvander@396
    75
		/**
dvander@396
    76
		 * @brief Called on plugin load.
dvander@396
    77
		 *
dvander@396
    78
		 * This is called as DLLInit() executes - after the parameters are 
dvander@396
    79
		 * known, but before the original GameDLL function is called.  
dvander@396
    80
		 * Therefore, you cannot hook it, but you don't need to - Load() is 
dvander@396
    81
		 * basically your hook.  You can override factories before the engine 
dvander@396
    82
		 * and gamedll exchange them.  However, take care to note that if your 
dvander@396
    83
		 * plugin is unloaded, and the gamedll/engine have cached an interface 
dvander@396
    84
		 * you've passed, something will definitely crash.  Be careful.
dvander@396
    85
		 *
dvander@396
    86
		 * @param id		Internal id of plugin.  Saved globally by PLUGIN_SAVEVARS()
dvander@396
    87
		 * @param ismm		External API for SourceMM.  Saved globally by PLUGIN_SAVEVARS()
dvander@396
    88
		 * @param error		Error message buffer
dvander@396
    89
		 * @param maxlength	Size of error message buffer
dvander@396
    90
		 * @param late		Set to true if your plugin was loaded late (not at server load).
dvander@396
    91
		 * @return			True if successful, return false to reject the load.
dvander@396
    92
		 */
dvander@396
    93
		virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0;
dvander@7
    94
dvander@396
    95
		/**
dvander@396
    96
		 * @brief Called when all plugins have been loaded.  
dvander@396
    97
		 *
dvander@396
    98
		 * This is called after DLLInit(), and thus the mod has been mostly initialized. 
dvander@396
    99
		 * It is also safe to assume that all other (automatically loaded) plugins are now 
dvander@396
   100
		 * ready to start interacting, because they are all loaded.
dvander@396
   101
		 */
dvander@396
   102
		virtual void AllPluginsLoaded()
dvander@396
   103
		{
dvander@396
   104
		}
dvander@30
   105
dvander@396
   106
		/**
dvander@396
   107
		 * @brief Called when your plugin is "queried".  
dvander@396
   108
		 * 
dvander@396
   109
		 * This is useful for rejecting a loaded state.  For example, if your 
dvander@396
   110
		 * plugin wants to stop operating, it can simply return false and copy 
dvander@396
   111
		 * an error message.  This will notify other plugins or MM:S of 
dvander@396
   112
		 * something bad that happened.  MM:S will not cache the return state, 
dvander@396
   113
		 * so if you return false,  your plugin will not actually be paused or 
dvander@396
   114
		 * unloaded.  This callback will be called when:
dvander@396
   115
		 *  - Another plugin requests it
dvander@396
   116
		 *  - Someone types "meta list", it will show up as "REFUSED"
dvander@396
   117
		 *  - When Metamod need to re-check the plugin's status
dvander@396
   118
		 *  - If the plugin does something like overload a factory, Metamod 
dvander@396
   119
		 *    will make sure the Query() returns true before calling it.
dvander@396
   120
		 *  Also note that this query will only override Metamod when the 
dvander@396
   121
		 *  plugin is running and not paused.
dvander@396
   122
		 *
dvander@396
   123
		 * @param error		Buffer for error message, or NULL if none.
dvander@396
   124
		 * @param maxlen	Maximum length of error buffer.
dvander@396
   125
		 * @return			Status code - true for okay, false for badness.
dvander@396
   126
		 */
dvander@396
   127
		virtual bool QueryRunning(char *error, size_t maxlen)
dvander@396
   128
		{
dvander@396
   129
			return true;
dvander@396
   130
		}
dvander@30
   131
dvander@396
   132
		/** 
dvander@396
   133
		 * @brief Called on plugin unload.  You can return false if you know 
dvander@396
   134
		 * your plugin is not capable of restoring critical states it modifies.
dvander@396
   135
		 *
dvander@396
   136
		 * @param error		Error message buffer
dvander@396
   137
		 * @param maxlen	Size of error message buffer
dvander@396
   138
		 * @return			True on success, return false to request no unload.
dvander@396
   139
		 */
dvander@396
   140
		virtual bool Unload(char *error, size_t maxlen)
dvander@396
   141
		{
dvander@396
   142
			return true;
dvander@396
   143
		}
dvander@30
   144
dvander@396
   145
		/** 
dvander@396
   146
		 * @brief Called on plugin pause.
dvander@396
   147
		 *
dvander@396
   148
		 * @param	error Error message buffer
dvander@396
   149
		 * @param	maxlen Size of error message buffer
dvander@396
   150
		 * @return	True on success, return false to request no pause.
dvander@396
   151
		 */
dvander@396
   152
		virtual bool Pause(char *error, size_t maxlen)
dvander@396
   153
		{
dvander@396
   154
			return true;
dvander@396
   155
		}
dvander@7
   156
dvander@396
   157
		/** 
dvander@396
   158
		 * @brief Called on plugin unpause.
dvander@396
   159
		 *
dvander@396
   160
		 * @param	error Error message buffer
dvander@396
   161
		 * @param	maxlen Size of error message buffer
dvander@396
   162
		 * @return	True on success, return false to request no unpause.
dvander@396
   163
		 */
dvander@396
   164
		virtual bool Unpause(char *error, size_t maxlen)
dvander@396
   165
		{
dvander@396
   166
			return true;
dvander@396
   167
		}
dvander@396
   168
	public:
dvander@396
   169
		/** @brief Return author as string */
dvander@396
   170
		virtual const char *GetAuthor() =0;
dvander@396
   171
	
dvander@396
   172
		/** @brief Return plugin name as string */
dvander@396
   173
		virtual const char *GetName() =0;
dvander@396
   174
	
dvander@396
   175
		/** @brief Return a description as string */
dvander@396
   176
		virtual const char *GetDescription() =0;
dvander@396
   177
	
dvander@396
   178
		/** @brief Return a URL as string */
dvander@396
   179
		virtual const char *GetURL() =0;
dvander@396
   180
	
dvander@396
   181
		/** @brief Return quick license code as string */
dvander@396
   182
		virtual const char *GetLicense() =0;
dvander@396
   183
	
dvander@396
   184
		/** @brief Return version as string */
dvander@396
   185
		virtual const char *GetVersion() =0;
dvander@396
   186
	
dvander@396
   187
		/** @brief Return author as string */
dvander@396
   188
		virtual const char *GetDate() =0;
dvander@396
   189
	
dvander@396
   190
		/** @brief Return author as string */
dvander@396
   191
		virtual const char *GetLogTag() =0;
dvander@396
   192
	};
dvander@138
   193
dvander@282
   194
	/**
dvander@396
   195
	 * @brief Various events that Metamod can fire.
dvander@282
   196
	 */
dvander@396
   197
	class IMetamodListener
dvander@371
   198
	{
dvander@396
   199
	public:
dvander@396
   200
		/**
dvander@396
   201
		 * @brief Called when a plugin is loaded.
dvander@396
   202
		 *
dvander@396
   203
		 * @param id		Id of the plugin.
dvander@396
   204
		 */
dvander@396
   205
		virtual void OnPluginLoad(PluginId id)
dvander@282
   206
		{
dvander@282
   207
		}
dvander@282
   208
dvander@396
   209
		/**
dvander@396
   210
		 * @brief Called when a plugin is unloaded.
dvander@396
   211
		 *
dvander@396
   212
		 * @param id		Id of the plugin.
dvander@396
   213
		 */
dvander@396
   214
		virtual void OnPluginUnload(PluginId id)
dvander@396
   215
		{
dvander@396
   216
		}
dvander@396
   217
	
dvander@396
   218
		/**
dvander@396
   219
		 * @brief Called when a plugin is paused.
dvander@396
   220
		 *
dvander@396
   221
		 * @param id		Id of the plugin.
dvander@396
   222
		 */
dvander@396
   223
		virtual void OnPluginPause(PluginId id)
dvander@396
   224
		{
dvander@396
   225
		}
dvander@396
   226
	
dvander@396
   227
		/**
dvander@396
   228
		 * @brief Called when a plugin is unpaused.
dvander@396
   229
		 *
dvander@396
   230
		 * @param id		Id of the plugin.
dvander@396
   231
		 */
dvander@396
   232
		virtual void OnPluginUnpause(PluginId id)
dvander@396
   233
		{
dvander@396
   234
		}
dvander@396
   235
	
dvander@396
   236
		/**
dvander@396
   237
		 * @brief Called when the level is loaded (after GameInit, before 
dvander@396
   238
		 * ServerActivate).
dvander@396
   239
		 *
dvander@396
   240
		 * To override this, hook IServerGameDLL::LevelInit().
dvander@396
   241
		 *
dvander@396
   242
		 * @param pMapName		Name of the map.
dvander@396
   243
		 * @param pMapEntities	Lump string of the map entities, in KeyValues
dvander@396
   244
		 * 						format.
dvander@396
   245
		 * @param pOldLevel		Unknown.
dvander@396
   246
		 * @param pLandmarkName	Unknown.
dvander@396
   247
		 * @param loadGame		Unknown.
dvander@396
   248
		 * @param background	Unknown.
dvander@396
   249
		 */
dvander@396
   250
		virtual void OnLevelInit(char const *pMapName, 
dvander@396
   251
								 char const *pMapEntities, 
dvander@396
   252
								 char const *pOldLevel, 
dvander@396
   253
								 char const *pLandmarkName, 
dvander@396
   254
								 bool loadGame, 
dvander@396
   255
								 bool background) 
dvander@396
   256
		{ 
dvander@396
   257
		}
dvander@138
   258
dvander@396
   259
		/**
dvander@396
   260
		 * @brief Called when the level is shut down.  May be called more than 
dvander@396
   261
		 * once.
dvander@396
   262
		 */
dvander@396
   263
		virtual void OnLevelShutdown()
dvander@282
   264
		{
dvander@396
   265
		}
dvander@396
   266
dvander@396
   267
		/**
dvander@396
   268
		 * @brief Called when engineFactory() is used through Metamod:Source's 
dvander@396
   269
		 * wrapper.  This can be used to provide interfaces to other plugins or
dvander@396
   270
		 * the GameDLL.
dvander@396
   271
		 *
dvander@396
   272
		 * If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED.
dvander@396
   273
		 *
dvander@396
   274
		 * @param iface			Interface string.
dvander@396
   275
		 * @param ret			Optional pointer to store return code.
dvander@396
   276
		 * @return				Generic pointer to the interface, or NULL if 
dvander@396
   277
		 * 						not found.
dvander@396
   278
		 */
dvander@396
   279
		virtual void *OnEngineQuery(const char *iface, int *ret)
dvander@396
   280
		{
dvander@396
   281
			if (ret)
dvander@396
   282
			{
dvander@396
   283
				*ret = IFACE_FAILED;
dvander@396
   284
			}
dvander@396
   285
dvander@396
   286
			return NULL; 
dvander@282
   287
		}
dvander@282
   288
dvander@396
   289
		/**
dvander@396
   290
		 * @brief Called when the physics factory is used through 
dvander@396
   291
		 * Metamod:Source's wrapper. This can be used to provide interfaces to 
dvander@396
   292
		 * other plugins.
dvander@396
   293
		 *
dvander@396
   294
		 * If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED.
dvander@396
   295
		 *
dvander@396
   296
		 * @param iface			Interface string.
dvander@396
   297
		 * @param ret			Optional pointer to store return code.
dvander@396
   298
		 * @return				Generic pointer to the interface, or NULL if 
dvander@396
   299
		 * 						not found.
dvander@396
   300
		 */
dvander@396
   301
		virtual void *OnPhysicsQuery(const char *iface, int *ret)
dvander@282
   302
		{
dvander@396
   303
			if (ret)
dvander@396
   304
			{
dvander@396
   305
				*ret = IFACE_FAILED;
dvander@396
   306
			}
dvander@396
   307
	
dvander@396
   308
			return NULL; 
dvander@282
   309
		}
dvander@138
   310
dvander@396
   311
		/**
dvander@396
   312
		 * @brief Called when the filesystem factory is used through 
dvander@396
   313
		 * Metamod:Source's wrapper.  This can be used to provide interfaces to 
dvander@396
   314
		 * other plugins.
dvander@396
   315
		 *
dvander@396
   316
		 * If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED.
dvander@396
   317
		 *
dvander@396
   318
		 * @param iface			Interface string.
dvander@396
   319
		 * @param ret			Optional pointer to store return code.
dvander@396
   320
		 * @return				Generic pointer to the interface, or NULL if not 
dvander@396
   321
		 * 						found.
dvander@396
   322
		 */
dvander@396
   323
		virtual void *OnFileSystemQuery(const char *iface, int *ret)
dvander@282
   324
		{
dvander@396
   325
			if (ret)
dvander@396
   326
			{
dvander@396
   327
				*ret = IFACE_FAILED;
dvander@396
   328
			}
dvander@396
   329
			
dvander@396
   330
			return NULL; 
dvander@282
   331
		}
dvander@282
   332
dvander@396
   333
		/**
dvander@396
   334
		 * @brief Called when the server DLL's factory is used through 
dvander@396
   335
		 * Metamod:Source's wrapper.  This can be used to provide interfaces to 
dvander@396
   336
		 * other plugins.
dvander@396
   337
		 *
dvander@396
   338
		 * If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED.
dvander@396
   339
		 *
dvander@396
   340
		 * @param iface			Interface string.
dvander@396
   341
		 * @param ret			Optional pointer to store return code.
dvander@396
   342
		 * @return				Generic pointer to the interface, or NULL if not 
dvander@396
   343
		 * 						found.
dvander@396
   344
		 */
dvander@396
   345
		virtual void *OnGameDLLQuery(const char *iface, int *ret)
dvander@396
   346
		{
dvander@396
   347
			if (ret)
dvander@396
   348
			{
dvander@396
   349
				*ret = IFACE_FAILED;
dvander@396
   350
			}
dvander@396
   351
	
dvander@396
   352
			return NULL; 
dvander@396
   353
		}
dvander@138
   354
dvander@396
   355
		/**
dvander@396
   356
		 * @brief Called when Metamod's own factory is invoked.  
dvander@396
   357
		 * This can be used to provide interfaces to other plugins.
dvander@396
   358
		 *
dvander@396
   359
		 * If ret is passed, you should fill it with IFACE_OK or IFACE_FAILED.
dvander@396
   360
		 *
dvander@396
   361
		 * @param iface			Interface string.
dvander@396
   362
		 * @param ret			Optional pointer to store return code.
dvander@396
   363
		 * @return				Generic pointer to the interface, or NULL if not 
dvander@396
   364
		 * 						found.
dvander@396
   365
		 */
dvander@396
   366
		virtual void *OnMetamodQuery(const char *iface, int *ret)
dvander@282
   367
		{
dvander@396
   368
			if (ret)
dvander@396
   369
			{
dvander@396
   370
				*ret = IFACE_FAILED;
dvander@396
   371
			}
dvander@396
   372
	
dvander@396
   373
			return NULL; 	
dvander@282
   374
		}
dvander@282
   375
dvander@396
   376
		/**
dvander@396
   377
		 * @brief Called when Metamod:Source acquires a valid 
dvander@396
   378
		 * IServerPluginCallbacks pointer to be used for hooking by plugins.
dvander@396
   379
		 *
dvander@396
   380
		 * This will only be called after a call to ISmmAPI::EnableVSPListener().
dvander@396
   381
		 * If called before GameInit, this callback will occur before LevelInit.
dvander@396
   382
		 * Otherwise, it will be called on the first call after that.
dvander@396
   383
		 *
dvander@396
   384
		 * This callback is provided to all plugins regardless of which (or how 
dvander@396
   385
		 * many) called EnableVSPListener(), but only if at least one did in 
dvander@396
   386
		 * fact enable it, and only once for all plugins.  That is, a late 
dvander@396
   387
		 * loading plugin should use ISmmAPI::GetVSPInfo() before relying on 
dvander@396
   388
		 * this callback.
dvander@396
   389
		 *
dvander@396
   390
		 * @param iface			Interface pointer.  If NULL, then the VSP 
dvander@396
   391
		 * 						listening construct failed to initialize and 
dvander@396
   392
		 * 						is not available.
dvander@396
   393
		 */
dvander@396
   394
		virtual void OnVSPListening(IServerPluginCallbacks *iface) 
dvander@396
   395
		{ 
dvander@396
   396
		}
dvander@282
   397
dvander@396
   398
		/**
dvander@396
   399
		 * @brief Called when Metamod:Source is about to remove a concommand or 
dvander@396
   400
		 * convar.  This can also be called if ISmmAPI::UnregisterConCmdBase is 
dvander@396
   401
		 * used by a plugin.
dvander@396
   402
		 *
dvander@396
   403
		 * @param id			Id of the plugin that created the concommand or 
dvander@396
   404
		 * 						convar.
dvander@396
   405
		 * @param pCommand		Pointer to concommand or convar that is being 
dvander@396
   406
		 * 						removed.
dvander@396
   407
		 */
dvander@396
   408
		virtual void OnUnlinkConCommandBase(PluginId id, ConCommandBase *pCommand)
dvander@396
   409
		{
dvander@396
   410
		}
dvander@396
   411
	};
dvander@396
   412
}
ds@345
   413
dvander@396
   414
#if !defined METAMOD_NO_AUTO_NAMESPACE
dvander@396
   415
using namespace SourceMM;
dvander@396
   416
#endif
dvander@396
   417
dvander@122
   418
#define PL_EXPOSURE		CreateInterface
dvander@7
   419
#define PL_EXPOSURE_C	"CreateInterface"
dvander@7
   420
dvander@7
   421
#define PLUGIN_EXPOSE(name, var) \
dvander@7
   422
	ISmmAPI *g_SMAPI = NULL; \
dvander@9
   423
	ISmmPlugin *g_PLAPI = NULL; \
dvander@9
   424
	PluginId g_PLID = (PluginId)0; \
dvander@7
   425
	SourceHook::ISourceHook *g_SHPtr = NULL; \
dvander@7
   426
	SMM_API void *PL_EXPOSURE(const char *name, int *code) { \
dvander@396
   427
		if (name && !strcmp(name, METAMOD_PLAPI_NAME)) { \
dvander@7
   428
			return static_cast<void *>(&var); \
dvander@7
   429
		} \
dvander@7
   430
		return NULL; \
dvander@7
   431
	}
dvander@7
   432
dvander@7
   433
#define PLUGIN_GLOBALVARS()	\
dvander@7
   434
	extern SourceHook::ISourceHook *g_SHPtr; \
dvander@7
   435
	extern ISmmAPI *g_SMAPI; \
dvander@9
   436
	extern ISmmPlugin *g_PLAPI; \
dvander@9
   437
	extern PluginId g_PLID; 
dvander@7
   438
dvander@7
   439
#define PLUGIN_SAVEVARS() \
dvander@7
   440
	g_SMAPI = ismm; \
dvander@140
   441
	g_SHPtr = static_cast<SourceHook::ISourceHook *>(ismm->MetaFactory(MMIFACE_SOURCEHOOK, NULL, NULL)); \
dvander@9
   442
	g_PLAPI = static_cast<ISmmPlugin *>(this); \
dvander@9
   443
	g_PLID = id;
dvander@7
   444
dvander@122
   445
#define META_LOG				g_SMAPI->LogMsg
dvander@375
   446
#define META_REGCMD(name)		g_SMAPI->RegisterConCommandBase(g_PLAPI, name##_command)
dvander@375
   447
#define META_REGCVAR(var)		g_SMAPI->RegisterConCommandBase(g_PLAPI, var)
dvander@375
   448
#define META_UNREGCMD(name)		g_SMAPI->UnregisterConCommandBase(g_PLAPI, name##_command)
dvander@375
   449
#define META_UNREGCVAR(var)		g_SMAPI->UnregisterConCommandBase(g_PLAPI, var)
dvander@122
   450
#define	META_CONPRINT			g_SMAPI->ConPrint
dvander@122
   451
#define META_CONPRINTF			g_SMAPI->ConPrintf
dvander@7
   452
ds@296
   453
/* Probably should use this up above someday */
ds@66
   454
#define CONCMD_VARNAME(name) name##_command
ds@66
   455
dvander@7
   456
#if !defined SMM_API
dvander@7
   457
#if defined __WIN32__ || defined _WIN32 || defined WIN32
dvander@7
   458
	#define SMM_API extern "C" __declspec(dllexport)
dvander@7
   459
#elif defined __GNUC__
dvander@247
   460
	#if (__GNUC__ == 4) && (__GNUC_MINOR__ >= 1)
dvander@247
   461
		#define SMM_API extern "C" __attribute__ ((visibility("default")))	
dvander@247
   462
	#else
dvander@247
   463
		#define SMM_API	extern "C" 
dvander@247
   464
	#endif	
dvander@7
   465
#endif
dvander@7
   466
#endif //!defined SMM_API
dvander@7
   467
dvander@251
   468
/**
dvander@251
   469
 * @brief Macro for automatically getting a current or newer Valve interface.
dvander@251
   470
 *
dvander@251
   471
 * @param v_factory		Factory method to use from ISmmAPI (such as engineFactory).
dvander@251
   472
 * @param v_var			Variable name to store into.
dvander@251
   473
 * @param v_type		Interface type (do not include the pointer/asterisk).
ds@296
   474
 * @param v_name		Interface name.
dvander@251
   475
 */
dvander@251
   476
#define GET_V_IFACE_CURRENT(v_factory, v_var, v_type, v_name) \
dvander@251
   477
	v_var = (v_type *)ismm->VInterfaceMatch(ismm->v_factory(), v_name); \
dvander@251
   478
	if (!v_var) \
dvander@251
   479
	{ \
dvander@251
   480
		if (error && maxlen) \
dvander@251
   481
		{ \
dvander@376
   482
			ismm->Format(error, maxlen, "Could not find interface: %s", v_name); \
dvander@251
   483
		} \
dvander@251
   484
		return false; \
dvander@251
   485
	}
dvander@251
   486
dvander@251
   487
 /**
dvander@251
   488
  * @brief Same as GET_V_IFACE, except searches for any.
dvander@251
   489
  *
ds@296
   490
  * @param v_factory	Factory method to use from ISmmAPI (such as engineFactory).
ds@296
   491
  * @param v_var		Variable name to store into.
dvander@251
   492
  * @param v_type		Interface type (do not include the pointer/asterisk).
ds@296
   493
  * @param v_name		Interface name.
dvander@251
   494
  */
dvander@251
   495
#define GET_V_IFACE_ANY(v_factory, v_var, v_type, v_name) \
dvander@251
   496
	v_var = (v_type *)ismm->VInterfaceMatch(ismm->v_factory(), v_name, 0); \
dvander@251
   497
	if (!v_var) \
dvander@251
   498
	{ \
dvander@251
   499
		if (error && maxlen) \
dvander@251
   500
		{ \
dvander@376
   501
			ismm->Format(error, maxlen, "Could not find interface: %s", v_name); \
dvander@251
   502
		} \
dvander@251
   503
		return false; \
dvander@251
   504
	}
dvander@251
   505
dvander@7
   506
#endif //_INCLUDE_ISMM_PLUGIN_H
dvander@371
   507