sourcemm/ISmmPlugin.h
author David Anderson <dvander@alliedmods.net>
Sat Apr 16 19:59:26 2005 +0000 (2005-04-16)
changeset 7 8ef11f6189e4
child 9 01b8b7435e67
permissions -rw-r--r--
Initial import
dvander@7
     1
#ifndef _INCLUDE_ISMM_PLUGIN_H
dvander@7
     2
#define _INCLUDE_ISMM_PLUGIN_H
dvander@7
     3
dvander@7
     4
#include <interface.h>
dvander@7
     5
#include <sourcehook/sourcehook.h>
dvander@7
     6
#include "ISmmAPI.h"
dvander@7
     7
dvander@7
     8
#define PLAPI_VERSION	003
dvander@7
     9
#define PLAPI_NAME		"ISmmPlugin"
dvander@7
    10
dvander@7
    11
struct factories
dvander@7
    12
{
dvander@7
    13
	CreateInterfaceFn engine;
dvander@7
    14
	CreateInterfaceFn server;
dvander@7
    15
	CreateInterfaceFn physics;
dvander@7
    16
	CreateInterfaceFn fileSystem;
dvander@7
    17
};
dvander@7
    18
dvander@7
    19
class ISmmAPI;
dvander@7
    20
typedef unsigned int PluginId;
dvander@7
    21
dvander@7
    22
class ISmmPlugin
dvander@7
    23
{
dvander@7
    24
public:
dvander@7
    25
	/**
dvander@7
    26
	 * @brief Called on plugin load.
dvander@7
    27
	 *
dvander@7
    28
	 * @param id Internal id of plugin.
dvander@7
    29
	 * @param ismm External API for SourceMM.  Saved globally by PLUGIN_SAVEVARS()
dvander@7
    30
	 * @param list Contains a list of factories.  Hook a factory call by setting one equal to your own function.
dvander@7
    31
	 * @param error Error message buffer
dvander@7
    32
	 * @param maxlen Size of error message buffer
dvander@7
    33
	 * @return True on success, return false to request no load.
dvander@7
    34
	 */
dvander@7
    35
	virtual bool Load(PluginId id, ISmmAPI *ismm, factories *list, char *error, size_t maxlen) =0;
dvander@7
    36
dvander@7
    37
	/* @brief Called on plugin unload.
dvander@7
    38
	 *
dvander@7
    39
	 * @param error Error message buffer
dvander@7
    40
	 * @param maxlen Size of error message buffer
dvander@7
    41
	 * @return True on success, return false to request no unload.
dvander@7
    42
	 */
dvander@7
    43
	virtual bool Unload(char *error, size_t maxlen) =0;
dvander@7
    44
dvander@7
    45
	/* @brief Called on plugin pause.
dvander@7
    46
	 *
dvander@7
    47
	 * @param error Error message buffer
dvander@7
    48
	 * @param maxlen Size of error message buffer
dvander@7
    49
	 * @return True on success, return false to request no pause.
dvander@7
    50
	 */
dvander@7
    51
	virtual bool Pause(char *error, size_t maxlen) =0;
dvander@7
    52
dvander@7
    53
	/* @brief Called on plugin unpause.
dvander@7
    54
	 *
dvander@7
    55
	 * @param error Error message buffer
dvander@7
    56
	 * @param maxlen Size of error message buffer
dvander@7
    57
	 * @return True on success, return false to request no unpause.
dvander@7
    58
	 */
dvander@7
    59
	virtual bool Unpause(char *error, size_t maxlen) =0;
dvander@7
    60
public:
dvander@7
    61
	virtual int GetApiVersion() { return PLAPI_VERSION; }
dvander@7
    62
public:
dvander@7
    63
	virtual const char *GetAuthor() =0;
dvander@7
    64
	virtual const char *GetName() =0;
dvander@7
    65
	virtual const char *GetDescription() =0;
dvander@7
    66
	virtual const char *GetURL() =0;
dvander@7
    67
	virtual const char *GetLicense() =0;
dvander@7
    68
	virtual const char *GetVersion() =0;
dvander@7
    69
	virtual const char *GetDate() =0;
dvander@7
    70
	virtual const char *GetLogTag() =0;
dvander@7
    71
};
dvander@7
    72
dvander@7
    73
#define PL_EXPOSURE	CreateInterface
dvander@7
    74
#define PL_EXPOSURE_C	"CreateInterface"
dvander@7
    75
#define PLAPI_MIN_VERSION	002
dvander@7
    76
dvander@7
    77
#define PLUGIN_EXPOSE(name, var) \
dvander@7
    78
	ISmmAPI *g_SMAPI = NULL; \
dvander@7
    79
	ISmmPlugin *g_PLID = NULL; \
dvander@7
    80
	SourceHook::ISourceHook *g_SHPtr = NULL; \
dvander@7
    81
	SMM_API void *PL_EXPOSURE(const char *name, int *code) { \
dvander@7
    82
		if (name && !strcmp(name, PLAPI_NAME)) { \
dvander@7
    83
			return static_cast<void *>(&var); \
dvander@7
    84
		} \
dvander@7
    85
		return NULL; \
dvander@7
    86
	}
dvander@7
    87
dvander@7
    88
#define PLUGIN_GLOBALVARS()	\
dvander@7
    89
	extern SourceHook::ISourceHook *g_SHPtr; \
dvander@7
    90
	extern ISmmAPI *g_SMAPI; \
dvander@7
    91
	extern ISmmPlugin *g_PLID; 
dvander@7
    92
dvander@7
    93
#define PLUGIN_SAVEVARS() \
dvander@7
    94
	g_SMAPI = ismm; \
dvander@7
    95
	g_SHPtr = ismm->SourceHook(); \
dvander@7
    96
	g_PLID = static_cast<ISmmPlugin *>(this);
dvander@7
    97
dvander@7
    98
#define FACTORY_RETURN(mres, value) \
dvander@7
    99
	g_SMAPI->SetLastMetaReturn(mres); \
dvander@7
   100
	return value;
dvander@7
   101
dvander@7
   102
#define META_LOG	g_SMAPI->LogMsg
dvander@7
   103
dvander@7
   104
#if !defined SMM_API
dvander@7
   105
#if defined __WIN32__ || defined _WIN32 || defined WIN32
dvander@7
   106
	#define SMM_API extern "C" __declspec(dllexport)
dvander@7
   107
#elif defined __GNUC__
dvander@7
   108
	#define SMM_API	extern "C"
dvander@7
   109
#endif
dvander@7
   110
#endif //!defined SMM_API
dvander@7
   111
dvander@7
   112
#endif //_INCLUDE_ISMM_PLUGIN_H