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