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