sourcemm/ISmmPlugin.h
author David Anderson <dvander@alliedmods.net>
Thu Oct 20 14:37:47 2005 +0000 (2005-10-20)
changeset 138 dfa3b31cc042
parent 122 7c36121e2dfe
child 139 84948190c34b
permissions -rw-r--r--
initial import of new events system
dvander@9
     1
/* ======== SourceMM ========
dvander@9
     2
* Copyright (C) 2004-2005 Metamod:Source Development Team
dvander@9
     3
* No warranties of any kind
dvander@9
     4
*
dvander@9
     5
* License: zlib/libpng
dvander@9
     6
*
dvander@9
     7
* Author(s): David "BAILOPAN" Anderson
dvander@9
     8
* ============================
dvander@9
     9
*/
dvander@9
    10
dvander@7
    11
#ifndef _INCLUDE_ISMM_PLUGIN_H
dvander@7
    12
#define _INCLUDE_ISMM_PLUGIN_H
dvander@7
    13
dvander@9
    14
/**
dvander@9
    15
 * @brief Plugin API interface
dvander@9
    16
 * @file ISmmPlugin.h
dvander@9
    17
 */
dvander@9
    18
dvander@7
    19
#include <interface.h>
dvander@7
    20
#include <sourcehook/sourcehook.h>
dvander@7
    21
#include "ISmmAPI.h"
dvander@7
    22
dvander@97
    23
#define PLAPI_VERSION	7
dvander@7
    24
#define PLAPI_NAME		"ISmmPlugin"
dvander@7
    25
dvander@7
    26
class ISmmAPI;
dvander@29
    27
typedef int PluginId;
dvander@7
    28
dvander@7
    29
class ISmmPlugin
dvander@7
    30
{
dvander@7
    31
public:
dvander@9
    32
	virtual int GetApiVersion() { return PLAPI_VERSION; }
dvander@122
    33
	virtual ~ISmmPlugin() { }
dvander@9
    34
public:
dvander@7
    35
	/**
dvander@7
    36
	 * @brief Called on plugin load.
dvander@122
    37
	 * NOTE - As of API 7, this is called as DLLInit() executes - after the parameters are known, but before 
dvander@122
    38
	 *  the original GameDLL function is called.  Therefore, you cannot hook it, but you don't need to - 
dvander@122
    39
	 *  Load() is basically your hook.
dvander@122
    40
	 * NOTE - As of API 7, you can override factories before the engine and gamedll exchange them.
dvander@122
    41
	 *  However, take care to note that if your plugin is unloaded, and the gamedll/engine have cached
dvander@122
    42
	 *  an interface you've passed, something will definitely crash.  Be careful.
dvander@7
    43
	 *
dvander@122
    44
	 * @param id	Internal id of plugin.  Saved globally by PLUGIN_SAVEVARS()
dvander@122
    45
	 * @param ismm	External API for SourceMM.  Saved globally by PLUGIN_SAVEVARS()
dvander@122
    46
	 * @param list	Contains a list of factories.  Hook a factory call by setting one equal to your own function.
dvander@122
    47
	 * @param late	Set to true if your plugin was loaded late (not at server load).
dvander@7
    48
	 * @param error Error message buffer
dvander@7
    49
	 * @param maxlen Size of error message buffer
dvander@122
    50
	 * @return		True if successful, return false to reject the load.
dvander@7
    51
	 */
dvander@138
    52
	virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0;
dvander@7
    53
dvander@122
    54
	/**
dvander@122
    55
	 * @brief Called when your plugin is "queried".  This is useful for rejecting a loaded
dvander@122
    56
	 *  state.  For example, if your plugin wants to stop operating, it can simply return
dvander@122
    57
	 *  false and copy an error message.  This will notify other plugins or MM:S of something
dvander@122
    58
	 *  bad that happened.  NOTE - MM:S will not cache the return state, so if you return false,
dvander@122
    59
	 *  your plugin will not actually be paused or unloaded.  This callback will be called when:
dvander@122
    60
	 *  - Another plugin requests it
dvander@122
    61
	 *  - Someone types "meta list", it will show up as "REFUSED"
dvander@122
    62
	 *  - When Metamod need to re-check the plugin's status
dvander@122
    63
	 *  - If the plugin does something like overload a factory, Metamod will make sure the Query() returns true
dvander@122
    64
	 *    before calling it.
dvander@122
    65
	 *  Also note that this query will only override Metamod when the plugin is running and not paused.
dvander@7
    66
	 *
dvander@122
    67
	 * @param error		Buffer for error message.  This can be NULL!
dvander@122
    68
	 * @param maxlen	Maximum length of error buffer.
dvander@122
    69
	 * @return			Status code - true for okay, false for badness.
dvander@7
    70
	 */
dvander@122
    71
	virtual bool QueryRunning(char *error, size_t maxlen)
dvander@122
    72
	{
dvander@122
    73
		return true;
dvander@122
    74
	}
dvander@122
    75
dvander@122
    76
	/** 
dvander@122
    77
	 * @brief Called on plugin unload.  You can return false if you know your plugin
dvander@122
    78
	 *  is not capable of restoring critical states it modifies.
dvander@122
    79
	 *
dvander@122
    80
	 * @param	error Error message buffer
dvander@122
    81
	 * @param	maxlen Size of error message buffer
dvander@122
    82
	 * @return	True on success, return false to request no unload.
dvander@122
    83
	 */
dvander@122
    84
	virtual bool Unload(char *error, size_t maxlen)
dvander@122
    85
	{
dvander@122
    86
		return true;
dvander@122
    87
	}
dvander@7
    88
dvander@30
    89
	/** @brief Called on plugin pause.
dvander@7
    90
	 *
dvander@122
    91
	 * @param	error Error message buffer
dvander@122
    92
	 * @param	maxlen Size of error message buffer
dvander@122
    93
	 * @return	True on success, return false to request no pause.
dvander@7
    94
	 */
dvander@122
    95
	virtual bool Pause(char *error, size_t maxlen)
dvander@122
    96
	{
dvander@122
    97
		return true;
dvander@122
    98
	}
dvander@7
    99
dvander@30
   100
	/** @brief Called on plugin unpause.
dvander@7
   101
	 *
dvander@122
   102
	 * @param	error Error message buffer
dvander@122
   103
	 * @param	maxlen Size of error message buffer
dvander@122
   104
	 * @return	True on success, return false to request no unpause.
dvander@7
   105
	 */
dvander@122
   106
	virtual bool Unpause(char *error, size_t maxlen)
dvander@122
   107
	{
dvander@122
   108
		return true;
dvander@122
   109
	}
dvander@7
   110
public:
dvander@30
   111
	/** @brief Return author as string */
dvander@7
   112
	virtual const char *GetAuthor() =0;
dvander@30
   113
dvander@30
   114
	/** @brief Return plugin name as string */
dvander@7
   115
	virtual const char *GetName() =0;
dvander@30
   116
dvander@30
   117
	/** @brief Return a description as string */
dvander@7
   118
	virtual const char *GetDescription() =0;
dvander@30
   119
dvander@30
   120
	/** @brief Return a URL as string */
dvander@7
   121
	virtual const char *GetURL() =0;
dvander@30
   122
dvander@30
   123
	/** @brief Return quick license code as string */
dvander@7
   124
	virtual const char *GetLicense() =0;
dvander@30
   125
dvander@30
   126
	/** @brief Return version as string */
dvander@7
   127
	virtual const char *GetVersion() =0;
dvander@30
   128
dvander@30
   129
	/** @brief Return author as string */
dvander@7
   130
	virtual const char *GetDate() =0;
dvander@30
   131
dvander@30
   132
	/** @brief Return author as string */
dvander@7
   133
	virtual const char *GetLogTag() =0;
dvander@18
   134
public:
dvander@18
   135
	/**
dvander@18
   136
	 * @brief Called when all plugins have been loaded - API version 4
dvander@122
   137
	 *
dvander@122
   138
	 * This is useful for knowing when it's safe to request things another plugin might have.
dvander@122
   139
	 * NOTE for API 7 - This is called after DLLInit(). 
dvander@18
   140
	 */
dvander@122
   141
	virtual void AllPluginsLoaded()
dvander@122
   142
	{
dvander@122
   143
	}
dvander@7
   144
};
dvander@7
   145
dvander@138
   146
/**
dvander@138
   147
 * @brief Added in 1.2 so plugins could listen to specific events
dvander@138
   148
 */
dvander@138
   149
class IMetamodListener
dvander@138
   150
{
dvander@138
   151
public:
dvander@138
   152
	virtual ~IMetamodListener() { }
dvander@138
   153
public:
dvander@138
   154
	virtual void OnPluginLoad(PluginId id) { }
dvander@138
   155
dvander@138
   156
	virtual void OnPluginUnload(PluginId id) { }
dvander@138
   157
dvander@138
   158
	virtual void OnPluginPause(PluginId id) { }
dvander@138
   159
dvander@138
   160
	virtual void OnPluginUnpause(PluginId id) { }
dvander@138
   161
dvander@138
   162
	virtual void OnLevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background) { }
dvander@138
   163
dvander@138
   164
	virtual void *OnEngineQuery(const char *iface, int *ret)
dvander@138
   165
	{
dvander@138
   166
		if (ret)
dvander@138
   167
			*ret = IFACE_FAILED;
dvander@138
   168
		return NULL; 
dvander@138
   169
	}
dvander@138
   170
dvander@138
   171
	virtual void *OnPhysicsQuery(const char *iface, int *ret)
dvander@138
   172
	{
dvander@138
   173
		if (ret)
dvander@138
   174
			*ret = IFACE_FAILED;
dvander@138
   175
		return NULL; 
dvander@138
   176
	}
dvander@138
   177
dvander@138
   178
	virtual void *OnFileSystemQuery(const char *iface, int *ret)
dvander@138
   179
	{
dvander@138
   180
		if (ret)
dvander@138
   181
			*ret = IFACE_FAILED;
dvander@138
   182
		return NULL; 
dvander@138
   183
	}
dvander@138
   184
dvander@138
   185
	virtual void *OnGameDLLQuery(const char *iface, int *ret)
dvander@138
   186
	{
dvander@138
   187
		if (ret)
dvander@138
   188
			*ret = IFACE_FAILED;
dvander@138
   189
		return NULL; 
dvander@138
   190
	}
dvander@138
   191
dvander@138
   192
	virtual void *OnMetamodQuery(const char *iface, int *ret)
dvander@138
   193
	{
dvander@138
   194
		if (ret)
dvander@138
   195
			*ret = IFACE_FAILED;
dvander@138
   196
		return NULL; 	
dvander@138
   197
	}
dvander@138
   198
};
dvander@138
   199
dvander@122
   200
#define PL_EXPOSURE		CreateInterface
dvander@7
   201
#define PL_EXPOSURE_C	"CreateInterface"
dvander@7
   202
dvander@7
   203
#define PLUGIN_EXPOSE(name, var) \
dvander@7
   204
	ISmmAPI *g_SMAPI = NULL; \
dvander@9
   205
	ISmmPlugin *g_PLAPI = NULL; \
dvander@9
   206
	PluginId g_PLID = (PluginId)0; \
dvander@7
   207
	SourceHook::ISourceHook *g_SHPtr = NULL; \
dvander@7
   208
	SMM_API void *PL_EXPOSURE(const char *name, int *code) { \
dvander@7
   209
		if (name && !strcmp(name, PLAPI_NAME)) { \
dvander@7
   210
			return static_cast<void *>(&var); \
dvander@7
   211
		} \
dvander@7
   212
		return NULL; \
dvander@7
   213
	}
dvander@7
   214
dvander@7
   215
#define PLUGIN_GLOBALVARS()	\
dvander@7
   216
	extern SourceHook::ISourceHook *g_SHPtr; \
dvander@7
   217
	extern ISmmAPI *g_SMAPI; \
dvander@9
   218
	extern ISmmPlugin *g_PLAPI; \
dvander@9
   219
	extern PluginId g_PLID; 
dvander@7
   220
dvander@7
   221
#define PLUGIN_SAVEVARS() \
dvander@7
   222
	g_SMAPI = ismm; \
dvander@138
   223
	g_SHPtr = ismm->MetaQuery(MMIFACE_SOURCEHOOK, NULL); \
dvander@9
   224
	g_PLAPI = static_cast<ISmmPlugin *>(this); \
dvander@9
   225
	g_PLID = id;
dvander@7
   226
dvander@7
   227
#define FACTORY_RETURN(mres, value) \
dvander@7
   228
	g_SMAPI->SetLastMetaReturn(mres); \
dvander@7
   229
	return value;
dvander@7
   230
dvander@122
   231
#define META_LOG				g_SMAPI->LogMsg
dvander@67
   232
#define META_REGCMD(name)		g_SMAPI->RegisterConCmdBase(g_PLAPI, name##_command)
dvander@67
   233
#define META_REGCVAR(var)		g_SMAPI->RegisterConCmdBase(g_PLAPI, var)
dvander@67
   234
#define META_UNREGCMD(name)		g_SMAPI->UnregisterConCmdBase(g_PLAPI, name##_command)
dvander@67
   235
#define META_UNREGCVAR(var)		g_SMAPI->UnregisterConCmdBase(g_PLAPI, var)
dvander@122
   236
#define	META_CONPRINT			g_SMAPI->ConPrint
dvander@122
   237
#define META_CONPRINTF			g_SMAPI->ConPrintf
dvander@7
   238
dvander@67
   239
//probably should use this up above someday
ds@66
   240
#define CONCMD_VARNAME(name) name##_command
ds@66
   241
dvander@7
   242
#if !defined SMM_API
dvander@7
   243
#if defined __WIN32__ || defined _WIN32 || defined WIN32
dvander@7
   244
	#define SMM_API extern "C" __declspec(dllexport)
dvander@7
   245
#elif defined __GNUC__
dvander@7
   246
	#define SMM_API	extern "C"
dvander@7
   247
#endif
dvander@7
   248
#endif //!defined SMM_API
dvander@7
   249
dvander@7
   250
#endif //_INCLUDE_ISMM_PLUGIN_H