sourcemm/ISmmPlugin.h
changeset 7 8ef11f6189e4
child 9 01b8b7435e67
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/sourcemm/ISmmPlugin.h	Sat Apr 16 19:59:26 2005 +0000
     1.3 @@ -0,0 +1,112 @@
     1.4 +#ifndef _INCLUDE_ISMM_PLUGIN_H
     1.5 +#define _INCLUDE_ISMM_PLUGIN_H
     1.6 +
     1.7 +#include <interface.h>
     1.8 +#include <sourcehook/sourcehook.h>
     1.9 +#include "ISmmAPI.h"
    1.10 +
    1.11 +#define PLAPI_VERSION	003
    1.12 +#define PLAPI_NAME		"ISmmPlugin"
    1.13 +
    1.14 +struct factories
    1.15 +{
    1.16 +	CreateInterfaceFn engine;
    1.17 +	CreateInterfaceFn server;
    1.18 +	CreateInterfaceFn physics;
    1.19 +	CreateInterfaceFn fileSystem;
    1.20 +};
    1.21 +
    1.22 +class ISmmAPI;
    1.23 +typedef unsigned int PluginId;
    1.24 +
    1.25 +class ISmmPlugin
    1.26 +{
    1.27 +public:
    1.28 +	/**
    1.29 +	 * @brief Called on plugin load.
    1.30 +	 *
    1.31 +	 * @param id Internal id of plugin.
    1.32 +	 * @param ismm External API for SourceMM.  Saved globally by PLUGIN_SAVEVARS()
    1.33 +	 * @param list Contains a list of factories.  Hook a factory call by setting one equal to your own function.
    1.34 +	 * @param error Error message buffer
    1.35 +	 * @param maxlen Size of error message buffer
    1.36 +	 * @return True on success, return false to request no load.
    1.37 +	 */
    1.38 +	virtual bool Load(PluginId id, ISmmAPI *ismm, factories *list, char *error, size_t maxlen) =0;
    1.39 +
    1.40 +	/* @brief Called on plugin unload.
    1.41 +	 *
    1.42 +	 * @param error Error message buffer
    1.43 +	 * @param maxlen Size of error message buffer
    1.44 +	 * @return True on success, return false to request no unload.
    1.45 +	 */
    1.46 +	virtual bool Unload(char *error, size_t maxlen) =0;
    1.47 +
    1.48 +	/* @brief Called on plugin pause.
    1.49 +	 *
    1.50 +	 * @param error Error message buffer
    1.51 +	 * @param maxlen Size of error message buffer
    1.52 +	 * @return True on success, return false to request no pause.
    1.53 +	 */
    1.54 +	virtual bool Pause(char *error, size_t maxlen) =0;
    1.55 +
    1.56 +	/* @brief Called on plugin unpause.
    1.57 +	 *
    1.58 +	 * @param error Error message buffer
    1.59 +	 * @param maxlen Size of error message buffer
    1.60 +	 * @return True on success, return false to request no unpause.
    1.61 +	 */
    1.62 +	virtual bool Unpause(char *error, size_t maxlen) =0;
    1.63 +public:
    1.64 +	virtual int GetApiVersion() { return PLAPI_VERSION; }
    1.65 +public:
    1.66 +	virtual const char *GetAuthor() =0;
    1.67 +	virtual const char *GetName() =0;
    1.68 +	virtual const char *GetDescription() =0;
    1.69 +	virtual const char *GetURL() =0;
    1.70 +	virtual const char *GetLicense() =0;
    1.71 +	virtual const char *GetVersion() =0;
    1.72 +	virtual const char *GetDate() =0;
    1.73 +	virtual const char *GetLogTag() =0;
    1.74 +};
    1.75 +
    1.76 +#define PL_EXPOSURE	CreateInterface
    1.77 +#define PL_EXPOSURE_C	"CreateInterface"
    1.78 +#define PLAPI_MIN_VERSION	002
    1.79 +
    1.80 +#define PLUGIN_EXPOSE(name, var) \
    1.81 +	ISmmAPI *g_SMAPI = NULL; \
    1.82 +	ISmmPlugin *g_PLID = NULL; \
    1.83 +	SourceHook::ISourceHook *g_SHPtr = NULL; \
    1.84 +	SMM_API void *PL_EXPOSURE(const char *name, int *code) { \
    1.85 +		if (name && !strcmp(name, PLAPI_NAME)) { \
    1.86 +			return static_cast<void *>(&var); \
    1.87 +		} \
    1.88 +		return NULL; \
    1.89 +	}
    1.90 +
    1.91 +#define PLUGIN_GLOBALVARS()	\
    1.92 +	extern SourceHook::ISourceHook *g_SHPtr; \
    1.93 +	extern ISmmAPI *g_SMAPI; \
    1.94 +	extern ISmmPlugin *g_PLID; 
    1.95 +
    1.96 +#define PLUGIN_SAVEVARS() \
    1.97 +	g_SMAPI = ismm; \
    1.98 +	g_SHPtr = ismm->SourceHook(); \
    1.99 +	g_PLID = static_cast<ISmmPlugin *>(this);
   1.100 +
   1.101 +#define FACTORY_RETURN(mres, value) \
   1.102 +	g_SMAPI->SetLastMetaReturn(mres); \
   1.103 +	return value;
   1.104 +
   1.105 +#define META_LOG	g_SMAPI->LogMsg
   1.106 +
   1.107 +#if !defined SMM_API
   1.108 +#if defined __WIN32__ || defined _WIN32 || defined WIN32
   1.109 +	#define SMM_API extern "C" __declspec(dllexport)
   1.110 +#elif defined __GNUC__
   1.111 +	#define SMM_API	extern "C"
   1.112 +#endif
   1.113 +#endif //!defined SMM_API
   1.114 +
   1.115 +#endif //_INCLUDE_ISMM_PLUGIN_H