sourcemm/ISmmPlugin.h
author David Anderson <dvander@alliedmods.net>
Thu Oct 06 00:59:01 2005 +0000 (2005-10-06)
changeset 122 7c36121e2dfe
parent 97 7d3a2a8d5bf5
child 138 dfa3b31cc042
permissions -rw-r--r--
Initial import of new GameDLL loading code
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
struct factories
dvander@7
    27
{
dvander@7
    28
	CreateInterfaceFn engine;
dvander@7
    29
	CreateInterfaceFn server;
dvander@7
    30
	CreateInterfaceFn physics;
dvander@7
    31
	CreateInterfaceFn fileSystem;
dvander@7
    32
};
dvander@7
    33
dvander@7
    34
class ISmmAPI;
dvander@29
    35
typedef int PluginId;
dvander@7
    36
dvander@7
    37
class ISmmPlugin
dvander@7
    38
{
dvander@7
    39
public:
dvander@9
    40
	virtual int GetApiVersion() { return PLAPI_VERSION; }
dvander@122
    41
	virtual ~ISmmPlugin() { }
dvander@9
    42
public:
dvander@7
    43
	/**
dvander@7
    44
	 * @brief Called on plugin load.
dvander@122
    45
	 * NOTE - As of API 7, this is called as DLLInit() executes - after the parameters are known, but before 
dvander@122
    46
	 *  the original GameDLL function is called.  Therefore, you cannot hook it, but you don't need to - 
dvander@122
    47
	 *  Load() is basically your hook.
dvander@122
    48
	 * NOTE - As of API 7, you can override factories before the engine and gamedll exchange them.
dvander@122
    49
	 *  However, take care to note that if your plugin is unloaded, and the gamedll/engine have cached
dvander@122
    50
	 *  an interface you've passed, something will definitely crash.  Be careful.
dvander@7
    51
	 *
dvander@122
    52
	 * @param id	Internal id of plugin.  Saved globally by PLUGIN_SAVEVARS()
dvander@122
    53
	 * @param ismm	External API for SourceMM.  Saved globally by PLUGIN_SAVEVARS()
dvander@122
    54
	 * @param list	Contains a list of factories.  Hook a factory call by setting one equal to your own function.
dvander@122
    55
	 * @param late	Set to true if your plugin was loaded late (not at server load).
dvander@7
    56
	 * @param error Error message buffer
dvander@7
    57
	 * @param maxlen Size of error message buffer
dvander@122
    58
	 * @return		True if successful, return false to reject the load.
dvander@7
    59
	 */
dvander@122
    60
	virtual bool Load(PluginId id, ISmmAPI *ismm, factories *list, char *error, size_t maxlength, bool late) =0;
dvander@7
    61
dvander@122
    62
	/**
dvander@122
    63
	 * @brief Called when your plugin is "queried".  This is useful for rejecting a loaded
dvander@122
    64
	 *  state.  For example, if your plugin wants to stop operating, it can simply return
dvander@122
    65
	 *  false and copy an error message.  This will notify other plugins or MM:S of something
dvander@122
    66
	 *  bad that happened.  NOTE - MM:S will not cache the return state, so if you return false,
dvander@122
    67
	 *  your plugin will not actually be paused or unloaded.  This callback will be called when:
dvander@122
    68
	 *  - Another plugin requests it
dvander@122
    69
	 *  - Someone types "meta list", it will show up as "REFUSED"
dvander@122
    70
	 *  - When Metamod need to re-check the plugin's status
dvander@122
    71
	 *  - If the plugin does something like overload a factory, Metamod will make sure the Query() returns true
dvander@122
    72
	 *    before calling it.
dvander@122
    73
	 *  Also note that this query will only override Metamod when the plugin is running and not paused.
dvander@7
    74
	 *
dvander@122
    75
	 * @param error		Buffer for error message.  This can be NULL!
dvander@122
    76
	 * @param maxlen	Maximum length of error buffer.
dvander@122
    77
	 * @return			Status code - true for okay, false for badness.
dvander@7
    78
	 */
dvander@122
    79
	virtual bool QueryRunning(char *error, size_t maxlen)
dvander@122
    80
	{
dvander@122
    81
		return true;
dvander@122
    82
	}
dvander@122
    83
dvander@122
    84
	/** 
dvander@122
    85
	 * @brief Called on plugin unload.  You can return false if you know your plugin
dvander@122
    86
	 *  is not capable of restoring critical states it modifies.
dvander@122
    87
	 *
dvander@122
    88
	 * @param	error Error message buffer
dvander@122
    89
	 * @param	maxlen Size of error message buffer
dvander@122
    90
	 * @return	True on success, return false to request no unload.
dvander@122
    91
	 */
dvander@122
    92
	virtual bool Unload(char *error, size_t maxlen)
dvander@122
    93
	{
dvander@122
    94
		return true;
dvander@122
    95
	}
dvander@7
    96
dvander@30
    97
	/** @brief Called on plugin pause.
dvander@7
    98
	 *
dvander@122
    99
	 * @param	error Error message buffer
dvander@122
   100
	 * @param	maxlen Size of error message buffer
dvander@122
   101
	 * @return	True on success, return false to request no pause.
dvander@7
   102
	 */
dvander@122
   103
	virtual bool Pause(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 unpause.
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 unpause.
dvander@7
   113
	 */
dvander@122
   114
	virtual bool Unpause(char *error, size_t maxlen)
dvander@122
   115
	{
dvander@122
   116
		return true;
dvander@122
   117
	}
dvander@7
   118
public:
dvander@30
   119
	/** @brief Return author as string */
dvander@7
   120
	virtual const char *GetAuthor() =0;
dvander@30
   121
dvander@30
   122
	/** @brief Return plugin name as string */
dvander@7
   123
	virtual const char *GetName() =0;
dvander@30
   124
dvander@30
   125
	/** @brief Return a description as string */
dvander@7
   126
	virtual const char *GetDescription() =0;
dvander@30
   127
dvander@30
   128
	/** @brief Return a URL as string */
dvander@7
   129
	virtual const char *GetURL() =0;
dvander@30
   130
dvander@30
   131
	/** @brief Return quick license code as string */
dvander@7
   132
	virtual const char *GetLicense() =0;
dvander@30
   133
dvander@30
   134
	/** @brief Return version as string */
dvander@7
   135
	virtual const char *GetVersion() =0;
dvander@30
   136
dvander@30
   137
	/** @brief Return author as string */
dvander@7
   138
	virtual const char *GetDate() =0;
dvander@30
   139
dvander@30
   140
	/** @brief Return author as string */
dvander@7
   141
	virtual const char *GetLogTag() =0;
dvander@18
   142
public:
dvander@18
   143
	/**
dvander@18
   144
	 * @brief Called when all plugins have been loaded - API version 4
dvander@122
   145
	 *
dvander@122
   146
	 * This is useful for knowing when it's safe to request things another plugin might have.
dvander@122
   147
	 * NOTE for API 7 - This is called after DLLInit(). 
dvander@18
   148
	 */
dvander@122
   149
	virtual void AllPluginsLoaded()
dvander@122
   150
	{
dvander@122
   151
	}
dvander@7
   152
};
dvander@7
   153
dvander@122
   154
#define PL_EXPOSURE		CreateInterface
dvander@7
   155
#define PL_EXPOSURE_C	"CreateInterface"
dvander@7
   156
dvander@7
   157
#define PLUGIN_EXPOSE(name, var) \
dvander@7
   158
	ISmmAPI *g_SMAPI = NULL; \
dvander@9
   159
	ISmmPlugin *g_PLAPI = NULL; \
dvander@9
   160
	PluginId g_PLID = (PluginId)0; \
dvander@7
   161
	SourceHook::ISourceHook *g_SHPtr = NULL; \
dvander@7
   162
	SMM_API void *PL_EXPOSURE(const char *name, int *code) { \
dvander@7
   163
		if (name && !strcmp(name, PLAPI_NAME)) { \
dvander@7
   164
			return static_cast<void *>(&var); \
dvander@7
   165
		} \
dvander@7
   166
		return NULL; \
dvander@7
   167
	}
dvander@7
   168
dvander@7
   169
#define PLUGIN_GLOBALVARS()	\
dvander@7
   170
	extern SourceHook::ISourceHook *g_SHPtr; \
dvander@7
   171
	extern ISmmAPI *g_SMAPI; \
dvander@9
   172
	extern ISmmPlugin *g_PLAPI; \
dvander@9
   173
	extern PluginId g_PLID; 
dvander@7
   174
dvander@7
   175
#define PLUGIN_SAVEVARS() \
dvander@7
   176
	g_SMAPI = ismm; \
dvander@7
   177
	g_SHPtr = ismm->SourceHook(); \
dvander@9
   178
	g_PLAPI = static_cast<ISmmPlugin *>(this); \
dvander@9
   179
	g_PLID = id;
dvander@7
   180
dvander@7
   181
#define FACTORY_RETURN(mres, value) \
dvander@7
   182
	g_SMAPI->SetLastMetaReturn(mres); \
dvander@7
   183
	return value;
dvander@7
   184
dvander@122
   185
#define META_LOG				g_SMAPI->LogMsg
dvander@67
   186
#define META_REGCMD(name)		g_SMAPI->RegisterConCmdBase(g_PLAPI, name##_command)
dvander@67
   187
#define META_REGCVAR(var)		g_SMAPI->RegisterConCmdBase(g_PLAPI, var)
dvander@67
   188
#define META_UNREGCMD(name)		g_SMAPI->UnregisterConCmdBase(g_PLAPI, name##_command)
dvander@67
   189
#define META_UNREGCVAR(var)		g_SMAPI->UnregisterConCmdBase(g_PLAPI, var)
dvander@122
   190
#define	META_CONPRINT			g_SMAPI->ConPrint
dvander@122
   191
#define META_CONPRINTF			g_SMAPI->ConPrintf
dvander@7
   192
dvander@67
   193
//probably should use this up above someday
ds@66
   194
#define CONCMD_VARNAME(name) name##_command
ds@66
   195
dvander@7
   196
#if !defined SMM_API
dvander@7
   197
#if defined __WIN32__ || defined _WIN32 || defined WIN32
dvander@7
   198
	#define SMM_API extern "C" __declspec(dllexport)
dvander@7
   199
#elif defined __GNUC__
dvander@7
   200
	#define SMM_API	extern "C"
dvander@7
   201
#endif
dvander@7
   202
#endif //!defined SMM_API
dvander@7
   203
dvander@7
   204
#endif //_INCLUDE_ISMM_PLUGIN_H