sourcemm/ISmmPlugin.h
author David Anderson <dvander@alliedmods.net>
Fri Aug 12 17:33:59 2005 +0000 (2005-08-12)
changeset 97 7d3a2a8d5bf5
parent 76 39266faeec97
child 122 7c36121e2dfe
permissions -rw-r--r--
Replaced std::list with List class
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@9
    41
public:
dvander@7
    42
	/**
dvander@7
    43
	 * @brief Called on plugin load.
dvander@7
    44
	 *
dvander@9
    45
	 * @param id Internal id of plugin.  Saved globally by PLUGIN_SAVEVARS()
dvander@7
    46
	 * @param ismm External API for SourceMM.  Saved globally by PLUGIN_SAVEVARS()
dvander@7
    47
	 * @param list Contains a list of factories.  Hook a factory call by setting one equal to your own function.
dvander@7
    48
	 * @param error Error message buffer
dvander@7
    49
	 * @param maxlen Size of error message buffer
dvander@7
    50
	 * @return True on success, return false to request no load.
dvander@7
    51
	 */
dvander@7
    52
	virtual bool Load(PluginId id, ISmmAPI *ismm, factories *list, char *error, size_t maxlen) =0;
dvander@7
    53
dvander@30
    54
	/** @brief Called on plugin unload.
dvander@7
    55
	 *
dvander@7
    56
	 * @param error Error message buffer
dvander@7
    57
	 * @param maxlen Size of error message buffer
dvander@7
    58
	 * @return True on success, return false to request no unload.
dvander@7
    59
	 */
dvander@7
    60
	virtual bool Unload(char *error, size_t maxlen) =0;
dvander@7
    61
dvander@30
    62
	/** @brief Called on plugin pause.
dvander@7
    63
	 *
dvander@7
    64
	 * @param error Error message buffer
dvander@7
    65
	 * @param maxlen Size of error message buffer
dvander@7
    66
	 * @return True on success, return false to request no pause.
dvander@7
    67
	 */
dvander@7
    68
	virtual bool Pause(char *error, size_t maxlen) =0;
dvander@7
    69
dvander@30
    70
	/** @brief Called on plugin unpause.
dvander@7
    71
	 *
dvander@7
    72
	 * @param error Error message buffer
dvander@7
    73
	 * @param maxlen Size of error message buffer
dvander@7
    74
	 * @return True on success, return false to request no unpause.
dvander@7
    75
	 */
dvander@7
    76
	virtual bool Unpause(char *error, size_t maxlen) =0;
dvander@7
    77
public:
dvander@30
    78
	/** @brief Return author as string */
dvander@7
    79
	virtual const char *GetAuthor() =0;
dvander@30
    80
dvander@30
    81
	/** @brief Return plugin name as string */
dvander@7
    82
	virtual const char *GetName() =0;
dvander@30
    83
dvander@30
    84
	/** @brief Return a description as string */
dvander@7
    85
	virtual const char *GetDescription() =0;
dvander@30
    86
dvander@30
    87
	/** @brief Return a URL as string */
dvander@7
    88
	virtual const char *GetURL() =0;
dvander@30
    89
dvander@30
    90
	/** @brief Return quick license code as string */
dvander@7
    91
	virtual const char *GetLicense() =0;
dvander@30
    92
dvander@30
    93
	/** @brief Return version as string */
dvander@7
    94
	virtual const char *GetVersion() =0;
dvander@30
    95
dvander@30
    96
	/** @brief Return author as string */
dvander@7
    97
	virtual const char *GetDate() =0;
dvander@30
    98
dvander@30
    99
	/** @brief Return author as string */
dvander@7
   100
	virtual const char *GetLogTag() =0;
dvander@18
   101
public:
dvander@18
   102
	/**
dvander@18
   103
	 * @brief Called when all plugins have been loaded - API version 4
dvander@30
   104
         *
dvander@30
   105
         * Ths is useful for knowing when it's safe to request things another plugin might have.
dvander@18
   106
	 */
dvander@18
   107
	virtual void AllPluginsLoaded() =0;
dvander@7
   108
};
dvander@7
   109
dvander@7
   110
#define PL_EXPOSURE	CreateInterface
dvander@7
   111
#define PL_EXPOSURE_C	"CreateInterface"
dvander@7
   112
dvander@7
   113
#define PLUGIN_EXPOSE(name, var) \
dvander@7
   114
	ISmmAPI *g_SMAPI = NULL; \
dvander@9
   115
	ISmmPlugin *g_PLAPI = NULL; \
dvander@9
   116
	PluginId g_PLID = (PluginId)0; \
dvander@7
   117
	SourceHook::ISourceHook *g_SHPtr = NULL; \
dvander@7
   118
	SMM_API void *PL_EXPOSURE(const char *name, int *code) { \
dvander@7
   119
		if (name && !strcmp(name, PLAPI_NAME)) { \
dvander@7
   120
			return static_cast<void *>(&var); \
dvander@7
   121
		} \
dvander@7
   122
		return NULL; \
dvander@7
   123
	}
dvander@7
   124
dvander@7
   125
#define PLUGIN_GLOBALVARS()	\
dvander@7
   126
	extern SourceHook::ISourceHook *g_SHPtr; \
dvander@7
   127
	extern ISmmAPI *g_SMAPI; \
dvander@9
   128
	extern ISmmPlugin *g_PLAPI; \
dvander@9
   129
	extern PluginId g_PLID; 
dvander@7
   130
dvander@7
   131
#define PLUGIN_SAVEVARS() \
dvander@7
   132
	g_SMAPI = ismm; \
dvander@7
   133
	g_SHPtr = ismm->SourceHook(); \
dvander@9
   134
	g_PLAPI = static_cast<ISmmPlugin *>(this); \
dvander@9
   135
	g_PLID = id;
dvander@7
   136
dvander@7
   137
#define FACTORY_RETURN(mres, value) \
dvander@7
   138
	g_SMAPI->SetLastMetaReturn(mres); \
dvander@7
   139
	return value;
dvander@7
   140
dvander@67
   141
#define META_LOG		g_SMAPI->LogMsg
dvander@67
   142
#define META_REGCMD(name)		g_SMAPI->RegisterConCmdBase(g_PLAPI, name##_command)
dvander@67
   143
#define META_REGCVAR(var)		g_SMAPI->RegisterConCmdBase(g_PLAPI, var)
dvander@67
   144
#define META_UNREGCMD(name)		g_SMAPI->UnregisterConCmdBase(g_PLAPI, name##_command)
dvander@67
   145
#define META_UNREGCVAR(var)		g_SMAPI->UnregisterConCmdBase(g_PLAPI, var)
dvander@76
   146
#define	META_CONPRINT	g_SMAPI->ConPrint
dvander@76
   147
#define META_CONPRINTF	g_SMAPI->ConPrintf
dvander@7
   148
dvander@67
   149
//probably should use this up above someday
ds@66
   150
#define CONCMD_VARNAME(name) name##_command
ds@66
   151
dvander@7
   152
#if !defined SMM_API
dvander@7
   153
#if defined __WIN32__ || defined _WIN32 || defined WIN32
dvander@7
   154
	#define SMM_API extern "C" __declspec(dllexport)
dvander@7
   155
#elif defined __GNUC__
dvander@7
   156
	#define SMM_API	extern "C"
dvander@7
   157
#endif
dvander@7
   158
#endif //!defined SMM_API
dvander@7
   159
dvander@7
   160
#endif //_INCLUDE_ISMM_PLUGIN_H