core/ISmmPluginExt.h
author Nicholas Hastings <skamonkey@gmail.com>
Sun Mar 23 23:37:46 2014 -0400 (2014-03-23)
changeset 909 57797db1d513
parent 858 a534b75f1b59
permissions -rw-r--r--
Add support for Contagion (bug 6006).
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
asherkin@790
    31
// Interface return status, binary-compatible with HL2SDK's IFACE_OK and IFACE_FAILED.
asherkin@790
    32
enum 
asherkin@790
    33
{
asherkin@790
    34
	META_IFACE_OK = 0,
asherkin@790
    35
	META_IFACE_FAILED
asherkin@790
    36
};
asherkin@790
    37
dvander@513
    38
/**
dvander@513
    39
 * @file ISmmPluginExt.h Provides an alternate method for loading plugins, 
dvander@513
    40
 * without needing to include the default headers and all their Half-Life baggage.
dvander@513
    41
 *
dvander@513
    42
 * @brief Definitions for extended plugin loading.
dvander@513
    43
 */
dvander@513
    44
dvander@513
    45
#define SOURCE_ENGINE_UNKNOWN			0				/**< Could not determine the engine version */
dvander@513
    46
#define SOURCE_ENGINE_ORIGINAL			1				/**< Original Source Engine (used by The Ship) */
dvander@513
    47
#define SOURCE_ENGINE_EPISODEONE		2				/**< Episode 1 Source Engine (second major SDK) */
dvander@513
    48
#define SOURCE_ENGINE_ORANGEBOX			3				/**< Orange Box Source Engine (third major SDK) */
ds@537
    49
#define SOURCE_ENGINE_LEFT4DEAD			4				/**< Left 4 Dead */
ds@637
    50
#define SOURCE_ENGINE_DARKMESSIAH		5				/**< Dark Messiah Multiplayer (based on original engine) */
skamonkey@850
    51
#define SOURCE_ENGINE_ORANGEBOXVALVE_DEPRECATED	6				/**< Orange Box Source Engine for Valve games (TF2/DOD:S/HL2DM) */
skamonkey@793
    52
#define SOURCE_ENGINE_LEFT4DEAD2		7				/**< Left 4 Dead 2 */
skamonkey@793
    53
#define SOURCE_ENGINE_ALIENSWARM		8				/**< Alien Swarm */
skamonkey@793
    54
#define SOURCE_ENGINE_BLOODYGOODTIME	9				/**< Bloody Good Time */
skamonkey@793
    55
#define SOURCE_ENGINE_EYE				10				/**< E.Y.E Divine Cybermancy */
skamonkey@793
    56
#define SOURCE_ENGINE_PORTAL2			11				/**< Portal 2 */
skamonkey@793
    57
#define SOURCE_ENGINE_CSGO				12				/**< Counter-Strike: Global Offensive */
skamonkey@793
    58
#define SOURCE_ENGINE_CSS				13				/**< Counter-Strike: Source (sometimes older version of Orange Box Valve) */
skamonkey@818
    59
#define SOURCE_ENGINE_DOTA				14				/**< Dota 2 */
skamonkey@850
    60
#define SOURCE_ENGINE_HL2DM				15				/**< Half-Life 2 Deathmatch */
skamonkey@850
    61
#define SOURCE_ENGINE_DODS				16				/**< Day of Defeat: Source */
skamonkey@850
    62
#define SOURCE_ENGINE_TF2				17				/**< Team Fortress 2 */
skamonkey@850
    63
#define SOURCE_ENGINE_NUCLEARDAWN		18				/**< Nuclear Dawn */
skamonkey@856
    64
#define SOURCE_ENGINE_SDK2013			19				/**< Source SDK 2013 */
skamonkey@857
    65
#define SOURCE_ENGINE_BLADE				20				/**< Blade Symphony */
skamonkey@858
    66
#define SOURCE_ENGINE_INSURGENCY		21				/**< Insurgency */
skamonkey@909
    67
#define SOURCE_ENGINE_CONTAGION			22				/**< Contagion */
dvander@513
    68
ds@674
    69
#define METAMOD_PLAPI_VERSION			15				/**< Version of this header file */
dvander@513
    70
#define METAMOD_PLAPI_NAME				"ISmmPlugin"	/**< Name of the plugin interface */
dvander@513
    71
dvander@513
    72
namespace SourceMM
dvander@513
    73
{
dvander@513
    74
	class ISmmPlugin;
dvander@513
    75
	class ISmmAPI;
dvander@513
    76
dvander@487
    77
	/**
dvander@487
    78
	 * @brief Used to uniquely identify plugins.
dvander@487
    79
	 */
dvander@513
    80
	typedef int PluginId;
dvander@513
    81
dvander@513
    82
	#define METAMOD_FAIL_API_V1			7				/**< Minimum API version to detect for V1 */
dvander@513
    83
	#define METAMOD_FAIL_API_V2			14				/**< Minimum API version to detect for V2 */
dvander@513
    84
dvander@513
    85
	/**
dvander@513
    86
	 * Use this to instantiate a plugin that will always fail.
dvander@513
    87
	 * This class definition works against major API versions 1 and 2.
dvander@513
    88
	 */
dvander@513
    89
	class ISmmFailPlugin
dvander@513
    90
	{
dvander@513
    91
	public:
dvander@513
    92
		/**
dvander@513
    93
		 * @brief You must return METAMOD_FAIL_API_V1 or METAMOD_FAIL_API_V2 here, 
dvander@513
    94
		 * depending on which Metamod:Source version you detected.
dvander@513
    95
		 */
dvander@513
    96
		virtual int GetApiVersion() = 0;
dvander@513
    97
dvander@513
    98
		/**
dvander@513
    99
		 * @brief Do not change.
dvander@513
   100
		 */
dvander@513
   101
		virtual ~ISmmFailPlugin()
dvander@513
   102
		{
dvander@513
   103
		}
dvander@513
   104
dvander@513
   105
		/**
dvander@513
   106
		 * @brief Return false here -- fill in the error buffer appropriately.
dvander@513
   107
		 *
dvander@513
   108
		 * Do not ever return true.  If you do, MM:S will crash because the class layout is 
dvander@513
   109
		 * incomplete against ISmmPlugin.
dvander@513
   110
		 * 
dvander@513
   111
		 * @param id			Ignore.
dvander@513
   112
		 * @param ismm			Ignore.
dvander@513
   113
		 * @param error			Error buffer (must be filled).
dvander@513
   114
		 * @param maxlength		Maximum size of error buffer.
dvander@513
   115
		 * @param late			Ignore.
dvander@513
   116
		 * @return				Must return false.
dvander@513
   117
		 */
dvander@513
   118
		virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0;
dvander@513
   119
	};
dvander@513
   120
}
dvander@513
   121
dvander@513
   122
typedef SourceMM::ISmmPlugin METAMOD_PLUGIN;
dvander@513
   123
dvander@513
   124
/**
dvander@513
   125
 * @brief Contains version information.
dvander@513
   126
 */
dvander@513
   127
struct MetamodVersionInfo
dvander@513
   128
{
dvander@513
   129
	int api_major;			/**< ISmmAPI major version */
dvander@513
   130
	int api_minor;			/**< ISmmAPI minor version */
dvander@513
   131
	int sh_iface;			/**< SourceHook interface version */
dvander@513
   132
	int sh_impl;			/**< SourceHook implementation version */
dvander@513
   133
	int pl_min;				/**< Plugin API minimum version */
dvander@513
   134
	int pl_max;				/**< Plugin API maximum version */
dvander@513
   135
	int source_engine;		/**< Source Engine version (SOURCE_* constants) */
ds@674
   136
	const char *game_dir;	/**< Game directory name */
dvander@675
   137
dvander@675
   138
	/**
dvander@675
   139
	 * @brief Returns the game folder.
dvander@675
   140
	 *
dvander@675
   141
	 * @return      Game folder, or NULL if not available on this version
dvander@675
   142
	 *              of Metamod:Source.
dvander@675
   143
	 */
dvander@675
   144
	inline const char *GetGameDir() const
dvander@675
   145
	{
skamonkey@855
   146
		if (pl_max < 15)
dvander@675
   147
			return NULL;
dvander@675
   148
		return game_dir;
dvander@675
   149
	}
dvander@513
   150
};
dvander@513
   151
dvander@513
   152
/**
dvander@513
   153
 * @brief Contains information about loading a plugin.
dvander@513
   154
 */
dvander@513
   155
struct MetamodLoaderInfo
dvander@513
   156
{
dvander@513
   157
	const char *pl_file;	/**< File path to the plugin being loaded. */
dvander@513
   158
	const char *pl_path;	/**< Folder path containing the plugin. */
dvander@513
   159
};
dvander@513
   160
dvander@513
   161
/**
dvander@513
   162
 * @brief If a function of this type is exposed as "CreateInterface_MMS", then
dvander@513
   163
 * Metamod:Source will attempt to call this function before calling 
dvander@513
   164
 * CreateInterface.  If this function returns a valid ISmmPlugin pointer, then 
dvander@513
   165
 * CreateInterface will not be called.
dvander@513
   166
 *
dvander@513
   167
 * This is useful for implementing a mini-loader plugin for multiple versions.
dvander@513
   168
 *
dvander@513
   169
 * @param mvi				MetamodVersionInfo structure.
dvander@513
   170
 * @param mli				MetamodLoaderInfo structure.
dvander@513
   171
 * @return					ISmmAPI pointer, or NULL if none.
dvander@513
   172
 */
dvander@513
   173
typedef METAMOD_PLUGIN *(*METAMOD_FN_LOAD)(const MetamodVersionInfo *mvi, 
dvander@513
   174
										   const MetamodLoaderInfo *mli);
dvander@513
   175
dvander@513
   176
/**
dvander@513
   177
 * @brief If a function of this type is exposed as "UnloadInterface_MMS", then
dvander@513
   178
 * Metamod:Source will attempt to call this function after calling 
dvander@513
   179
 * ISmmAPI::Unload(), and before closing the library.  This lets loader plugins 
dvander@513
   180
 * clean up before exiting.
dvander@513
   181
 *
dvander@513
   182
 * Note: This function will be ignored unless CreateInterfce_MMS was exposed.
dvander@513
   183
 * It may be called even if ISmmAPI::Unload() could not be called.
dvander@513
   184
 */
dvander@513
   185
typedef void (*METAMOD_FN_UNLOAD)();
dvander@513
   186
dvander@513
   187
/**
dvander@513
   188
 * @brief Original type of load function.  CreateInterfaceFn from Valve.
dvander@513
   189
 * 
dvander@513
   190
 * Plugins will expose this as "CreateInterface".
dvander@513
   191
 */
dvander@513
   192
typedef void *(*METAMOD_FN_ORIG_LOAD)(const char *, int *);
dvander@513
   193
dvander@513
   194
#endif //INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
dvander@513
   195