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