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