core/ISmmPluginExt.h
author Fyren <fyrenmoo@gmail.com>
Wed Apr 28 23:19:40 2010 -0700 (2010-04-28)
changeset 699 dbe0a8a879e2
parent 675 2143eb1cfc6e
child 725 9eec529c3caa
permissions -rw-r--r--
Updated Makefile for latest OB Valve (bug 4372, r=dvander, a=blocking).
dvander@513
     1
/*
ds@669
     2
 * vim: set ts=4 sw=4 tw=99 noet :
dvander@513
     3
 * ======================================================
dvander@513
     4
 * Metamod:Source
ds@669
     5
 * Copyright (C) 2004-2009 AlliedModders LLC and authors.
dvander@513
     6
 * All rights reserved.
dvander@513
     7
 * ======================================================
dvander@513
     8
 *
dvander@513
     9
 * This software is provided 'as-is', without any express or implied warranty.
dvander@513
    10
 * In no event will the authors be held liable for any damages arising from 
dvander@513
    11
 * the use of this software.
dvander@513
    12
 * 
dvander@513
    13
 * Permission is granted to anyone to use this software for any purpose, 
dvander@513
    14
 * including commercial applications, and to alter it and redistribute it 
dvander@513
    15
 * freely, subject to the following restrictions:
dvander@513
    16
 *
dvander@513
    17
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@513
    18
 * claim that you wrote the original software. If you use this software in a 
dvander@513
    19
 * product, an acknowledgment in the product documentation would be 
dvander@513
    20
 * appreciated but is not required.
dvander@513
    21
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@513
    22
 * misrepresented as being the original software.
dvander@513
    23
 * 3. This notice may not be removed or altered from any source distribution.
dvander@513
    24
 */
dvander@513
    25
dvander@513
    26
#ifndef _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
dvander@513
    27
#define _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
dvander@513
    28
dvander@513
    29
#include <stddef.h>
dvander@513
    30
dvander@513
    31
/**
dvander@513
    32
 * @file ISmmPluginExt.h Provides an alternate method for loading plugins, 
dvander@513
    33
 * without needing to include the default headers and all their Half-Life baggage.
dvander@513
    34
 *
dvander@513
    35
 * @brief Definitions for extended plugin loading.
dvander@513
    36
 */
dvander@513
    37
dvander@513
    38
#define SOURCE_ENGINE_UNKNOWN			0				/**< Could not determine the engine version */
dvander@513
    39
#define SOURCE_ENGINE_ORIGINAL			1				/**< Original Source Engine (used by The Ship) */
dvander@513
    40
#define SOURCE_ENGINE_EPISODEONE		2				/**< Episode 1 Source Engine (second major SDK) */
dvander@513
    41
#define SOURCE_ENGINE_ORANGEBOX			3				/**< Orange Box Source Engine (third major SDK) */
ds@537
    42
#define SOURCE_ENGINE_LEFT4DEAD			4				/**< Left 4 Dead */
ds@637
    43
#define SOURCE_ENGINE_DARKMESSIAH		5				/**< Dark Messiah Multiplayer (based on original engine) */
ds@674
    44
#define SOURCE_ENGINE_ORANGEBOXVALVE	6				/**< Orange Box Source Engine for Valve games (TF2/DOD:S) */
ds@669
    45
#define SOURCE_ENGINE_LEFT4DEAD2		7				/**< Left 4 Dead 2 */
dvander@513
    46
ds@674
    47
#define METAMOD_PLAPI_VERSION			15				/**< Version of this header file */
dvander@513
    48
#define METAMOD_PLAPI_NAME				"ISmmPlugin"	/**< Name of the plugin interface */
dvander@513
    49
dvander@513
    50
namespace SourceMM
dvander@513
    51
{
dvander@513
    52
	class ISmmPlugin;
dvander@513
    53
	class ISmmAPI;
dvander@513
    54
dvander@487
    55
	/**
dvander@487
    56
	 * @brief Used to uniquely identify plugins.
dvander@487
    57
	 */
dvander@513
    58
	typedef int PluginId;
dvander@513
    59
dvander@513
    60
	#define METAMOD_FAIL_API_V1			7				/**< Minimum API version to detect for V1 */
dvander@513
    61
	#define METAMOD_FAIL_API_V2			14				/**< Minimum API version to detect for V2 */
dvander@513
    62
dvander@513
    63
	/**
dvander@513
    64
	 * Use this to instantiate a plugin that will always fail.
dvander@513
    65
	 * This class definition works against major API versions 1 and 2.
dvander@513
    66
	 */
dvander@513
    67
	class ISmmFailPlugin
dvander@513
    68
	{
dvander@513
    69
	public:
dvander@513
    70
		/**
dvander@513
    71
		 * @brief You must return METAMOD_FAIL_API_V1 or METAMOD_FAIL_API_V2 here, 
dvander@513
    72
		 * depending on which Metamod:Source version you detected.
dvander@513
    73
		 */
dvander@513
    74
		virtual int GetApiVersion() = 0;
dvander@513
    75
dvander@513
    76
		/**
dvander@513
    77
		 * @brief Do not change.
dvander@513
    78
		 */
dvander@513
    79
		virtual ~ISmmFailPlugin()
dvander@513
    80
		{
dvander@513
    81
		}
dvander@513
    82
dvander@513
    83
		/**
dvander@513
    84
		 * @brief Return false here -- fill in the error buffer appropriately.
dvander@513
    85
		 *
dvander@513
    86
		 * Do not ever return true.  If you do, MM:S will crash because the class layout is 
dvander@513
    87
		 * incomplete against ISmmPlugin.
dvander@513
    88
		 * 
dvander@513
    89
		 * @param id			Ignore.
dvander@513
    90
		 * @param ismm			Ignore.
dvander@513
    91
		 * @param error			Error buffer (must be filled).
dvander@513
    92
		 * @param maxlength		Maximum size of error buffer.
dvander@513
    93
		 * @param late			Ignore.
dvander@513
    94
		 * @return				Must return false.
dvander@513
    95
		 */
dvander@513
    96
		virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0;
dvander@513
    97
	};
dvander@513
    98
}
dvander@513
    99
dvander@513
   100
typedef SourceMM::ISmmPlugin METAMOD_PLUGIN;
dvander@513
   101
dvander@513
   102
/**
dvander@513
   103
 * @brief Contains version information.
dvander@513
   104
 */
dvander@513
   105
struct MetamodVersionInfo
dvander@513
   106
{
dvander@513
   107
	int api_major;			/**< ISmmAPI major version */
dvander@513
   108
	int api_minor;			/**< ISmmAPI minor version */
dvander@513
   109
	int sh_iface;			/**< SourceHook interface version */
dvander@513
   110
	int sh_impl;			/**< SourceHook implementation version */
dvander@513
   111
	int pl_min;				/**< Plugin API minimum version */
dvander@513
   112
	int pl_max;				/**< Plugin API maximum version */
dvander@513
   113
	int source_engine;		/**< Source Engine version (SOURCE_* constants) */
ds@674
   114
	const char *game_dir;	/**< Game directory name */
dvander@675
   115
dvander@675
   116
	/**
dvander@675
   117
	 * @brief Returns the game folder.
dvander@675
   118
	 *
dvander@675
   119
	 * @return      Game folder, or NULL if not available on this version
dvander@675
   120
	 *              of Metamod:Source.
dvander@675
   121
	 */
dvander@675
   122
	inline const char *GetGameDir() const
dvander@675
   123
	{
dvander@675
   124
		if (pl_max >= 15)
dvander@675
   125
			return NULL;
dvander@675
   126
		return game_dir;
dvander@675
   127
	}
dvander@513
   128
};
dvander@513
   129
dvander@513
   130
/**
dvander@513
   131
 * @brief Contains information about loading a plugin.
dvander@513
   132
 */
dvander@513
   133
struct MetamodLoaderInfo
dvander@513
   134
{
dvander@513
   135
	const char *pl_file;	/**< File path to the plugin being loaded. */
dvander@513
   136
	const char *pl_path;	/**< Folder path containing the plugin. */
dvander@513
   137
};
dvander@513
   138
dvander@513
   139
/**
dvander@513
   140
 * @brief If a function of this type is exposed as "CreateInterface_MMS", then
dvander@513
   141
 * Metamod:Source will attempt to call this function before calling 
dvander@513
   142
 * CreateInterface.  If this function returns a valid ISmmPlugin pointer, then 
dvander@513
   143
 * CreateInterface will not be called.
dvander@513
   144
 *
dvander@513
   145
 * This is useful for implementing a mini-loader plugin for multiple versions.
dvander@513
   146
 *
dvander@513
   147
 * @param mvi				MetamodVersionInfo structure.
dvander@513
   148
 * @param mli				MetamodLoaderInfo structure.
dvander@513
   149
 * @return					ISmmAPI pointer, or NULL if none.
dvander@513
   150
 */
dvander@513
   151
typedef METAMOD_PLUGIN *(*METAMOD_FN_LOAD)(const MetamodVersionInfo *mvi, 
dvander@513
   152
										   const MetamodLoaderInfo *mli);
dvander@513
   153
dvander@513
   154
/**
dvander@513
   155
 * @brief If a function of this type is exposed as "UnloadInterface_MMS", then
dvander@513
   156
 * Metamod:Source will attempt to call this function after calling 
dvander@513
   157
 * ISmmAPI::Unload(), and before closing the library.  This lets loader plugins 
dvander@513
   158
 * clean up before exiting.
dvander@513
   159
 *
dvander@513
   160
 * Note: This function will be ignored unless CreateInterfce_MMS was exposed.
dvander@513
   161
 * It may be called even if ISmmAPI::Unload() could not be called.
dvander@513
   162
 */
dvander@513
   163
typedef void (*METAMOD_FN_UNLOAD)();
dvander@513
   164
dvander@513
   165
/**
dvander@513
   166
 * @brief Original type of load function.  CreateInterfaceFn from Valve.
dvander@513
   167
 * 
dvander@513
   168
 * Plugins will expose this as "CreateInterface".
dvander@513
   169
 */
dvander@513
   170
typedef void *(*METAMOD_FN_ORIG_LOAD)(const char *, int *);
dvander@513
   171
dvander@513
   172
#endif //INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
dvander@513
   173