core/ISmmPluginExt.h
author Nicholas Hastings <skamonkey@gmail.com>
Sat Aug 03 13:56:58 2013 -0400 (2013-08-03)
changeset 855 2b6068989da7
parent 850 3d9258ef9a30
child 856 4bf3ed73bba4
permissions -rw-r--r--
Fixed MetamodVersionInfo::GetGameDir always returning NULL or garbage.
     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_DEPRECATED	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 #define SOURCE_ENGINE_HL2DM				15				/**< Half-Life 2 Deathmatch */
    61 #define SOURCE_ENGINE_DODS				16				/**< Day of Defeat: Source */
    62 #define SOURCE_ENGINE_TF2				17				/**< Team Fortress 2 */
    63 #define SOURCE_ENGINE_NUCLEARDAWN		18				/**< Nuclear Dawn */
    64 
    65 #define METAMOD_PLAPI_VERSION			15				/**< Version of this header file */
    66 #define METAMOD_PLAPI_NAME				"ISmmPlugin"	/**< Name of the plugin interface */
    67 
    68 namespace SourceMM
    69 {
    70 	class ISmmPlugin;
    71 	class ISmmAPI;
    72 
    73 	/**
    74 	 * @brief Used to uniquely identify plugins.
    75 	 */
    76 	typedef int PluginId;
    77 
    78 	#define METAMOD_FAIL_API_V1			7				/**< Minimum API version to detect for V1 */
    79 	#define METAMOD_FAIL_API_V2			14				/**< Minimum API version to detect for V2 */
    80 
    81 	/**
    82 	 * Use this to instantiate a plugin that will always fail.
    83 	 * This class definition works against major API versions 1 and 2.
    84 	 */
    85 	class ISmmFailPlugin
    86 	{
    87 	public:
    88 		/**
    89 		 * @brief You must return METAMOD_FAIL_API_V1 or METAMOD_FAIL_API_V2 here, 
    90 		 * depending on which Metamod:Source version you detected.
    91 		 */
    92 		virtual int GetApiVersion() = 0;
    93 
    94 		/**
    95 		 * @brief Do not change.
    96 		 */
    97 		virtual ~ISmmFailPlugin()
    98 		{
    99 		}
   100 
   101 		/**
   102 		 * @brief Return false here -- fill in the error buffer appropriately.
   103 		 *
   104 		 * Do not ever return true.  If you do, MM:S will crash because the class layout is 
   105 		 * incomplete against ISmmPlugin.
   106 		 * 
   107 		 * @param id			Ignore.
   108 		 * @param ismm			Ignore.
   109 		 * @param error			Error buffer (must be filled).
   110 		 * @param maxlength		Maximum size of error buffer.
   111 		 * @param late			Ignore.
   112 		 * @return				Must return false.
   113 		 */
   114 		virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0;
   115 	};
   116 }
   117 
   118 typedef SourceMM::ISmmPlugin METAMOD_PLUGIN;
   119 
   120 /**
   121  * @brief Contains version information.
   122  */
   123 struct MetamodVersionInfo
   124 {
   125 	int api_major;			/**< ISmmAPI major version */
   126 	int api_minor;			/**< ISmmAPI minor version */
   127 	int sh_iface;			/**< SourceHook interface version */
   128 	int sh_impl;			/**< SourceHook implementation version */
   129 	int pl_min;				/**< Plugin API minimum version */
   130 	int pl_max;				/**< Plugin API maximum version */
   131 	int source_engine;		/**< Source Engine version (SOURCE_* constants) */
   132 	const char *game_dir;	/**< Game directory name */
   133 
   134 	/**
   135 	 * @brief Returns the game folder.
   136 	 *
   137 	 * @return      Game folder, or NULL if not available on this version
   138 	 *              of Metamod:Source.
   139 	 */
   140 	inline const char *GetGameDir() const
   141 	{
   142 		if (pl_max < 15)
   143 			return NULL;
   144 		return game_dir;
   145 	}
   146 };
   147 
   148 /**
   149  * @brief Contains information about loading a plugin.
   150  */
   151 struct MetamodLoaderInfo
   152 {
   153 	const char *pl_file;	/**< File path to the plugin being loaded. */
   154 	const char *pl_path;	/**< Folder path containing the plugin. */
   155 };
   156 
   157 /**
   158  * @brief If a function of this type is exposed as "CreateInterface_MMS", then
   159  * Metamod:Source will attempt to call this function before calling 
   160  * CreateInterface.  If this function returns a valid ISmmPlugin pointer, then 
   161  * CreateInterface will not be called.
   162  *
   163  * This is useful for implementing a mini-loader plugin for multiple versions.
   164  *
   165  * @param mvi				MetamodVersionInfo structure.
   166  * @param mli				MetamodLoaderInfo structure.
   167  * @return					ISmmAPI pointer, or NULL if none.
   168  */
   169 typedef METAMOD_PLUGIN *(*METAMOD_FN_LOAD)(const MetamodVersionInfo *mvi, 
   170 										   const MetamodLoaderInfo *mli);
   171 
   172 /**
   173  * @brief If a function of this type is exposed as "UnloadInterface_MMS", then
   174  * Metamod:Source will attempt to call this function after calling 
   175  * ISmmAPI::Unload(), and before closing the library.  This lets loader plugins 
   176  * clean up before exiting.
   177  *
   178  * Note: This function will be ignored unless CreateInterfce_MMS was exposed.
   179  * It may be called even if ISmmAPI::Unload() could not be called.
   180  */
   181 typedef void (*METAMOD_FN_UNLOAD)();
   182 
   183 /**
   184  * @brief Original type of load function.  CreateInterfaceFn from Valve.
   185  * 
   186  * Plugins will expose this as "CreateInterface".
   187  */
   188 typedef void *(*METAMOD_FN_ORIG_LOAD)(const char *, int *);
   189 
   190 #endif //INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
   191