core/ISmmPluginExt.h
author David Anderson <dvander@alliedmods.net>
Sat Oct 15 22:16:50 2011 -0700 (2011-10-15)
changeset 767 fd3ff8d792ce
parent 763 e5a02b89021c
child 780 35f2a207badf
permissions -rw-r--r--
Fix page protection bug causing a rare startup crash (bug 5133, r=fyren).
     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 /**
    32  * @file ISmmPluginExt.h Provides an alternate method for loading plugins, 
    33  * without needing to include the default headers and all their Half-Life baggage.
    34  *
    35  * @brief Definitions for extended plugin loading.
    36  */
    37 
    38 #define SOURCE_ENGINE_UNKNOWN			0				/**< Could not determine the engine version */
    39 #define SOURCE_ENGINE_ORIGINAL			1				/**< Original Source Engine (used by The Ship) */
    40 #define SOURCE_ENGINE_EPISODEONE		2				/**< Episode 1 Source Engine (second major SDK) */
    41 #define SOURCE_ENGINE_ORANGEBOX			3				/**< Orange Box Source Engine (third major SDK) */
    42 #define SOURCE_ENGINE_LEFT4DEAD			4				/**< Left 4 Dead */
    43 #define SOURCE_ENGINE_DARKMESSIAH		5				/**< Dark Messiah Multiplayer (based on original engine) */
    44 #define SOURCE_ENGINE_ORANGEBOXVALVE	6				/**< Orange Box Source Engine for Valve games (TF2/DOD:S) */
    45 #define SOURCE_ENGINE_LEFT4DEAD2		7				/**< Left 4 Dead 2 */
    46 #define SOURCE_ENGINE_ALIENSWARM		8				/**< Alien Swarm */
    47 #define SOURCE_ENGINE_BLOODYGOODTIME	9				/**< Bloody Good Time */
    48 #define SOURCE_ENGINE_EYE				10				/**< E.Y.E Divine Cybermancy */
    49 
    50 #define METAMOD_PLAPI_VERSION			15				/**< Version of this header file */
    51 #define METAMOD_PLAPI_NAME				"ISmmPlugin"	/**< Name of the plugin interface */
    52 
    53 namespace SourceMM
    54 {
    55 	class ISmmPlugin;
    56 	class ISmmAPI;
    57 
    58 	/**
    59 	 * @brief Used to uniquely identify plugins.
    60 	 */
    61 	typedef int PluginId;
    62 
    63 	#define METAMOD_FAIL_API_V1			7				/**< Minimum API version to detect for V1 */
    64 	#define METAMOD_FAIL_API_V2			14				/**< Minimum API version to detect for V2 */
    65 
    66 	/**
    67 	 * Use this to instantiate a plugin that will always fail.
    68 	 * This class definition works against major API versions 1 and 2.
    69 	 */
    70 	class ISmmFailPlugin
    71 	{
    72 	public:
    73 		/**
    74 		 * @brief You must return METAMOD_FAIL_API_V1 or METAMOD_FAIL_API_V2 here, 
    75 		 * depending on which Metamod:Source version you detected.
    76 		 */
    77 		virtual int GetApiVersion() = 0;
    78 
    79 		/**
    80 		 * @brief Do not change.
    81 		 */
    82 		virtual ~ISmmFailPlugin()
    83 		{
    84 		}
    85 
    86 		/**
    87 		 * @brief Return false here -- fill in the error buffer appropriately.
    88 		 *
    89 		 * Do not ever return true.  If you do, MM:S will crash because the class layout is 
    90 		 * incomplete against ISmmPlugin.
    91 		 * 
    92 		 * @param id			Ignore.
    93 		 * @param ismm			Ignore.
    94 		 * @param error			Error buffer (must be filled).
    95 		 * @param maxlength		Maximum size of error buffer.
    96 		 * @param late			Ignore.
    97 		 * @return				Must return false.
    98 		 */
    99 		virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0;
   100 	};
   101 }
   102 
   103 typedef SourceMM::ISmmPlugin METAMOD_PLUGIN;
   104 
   105 /**
   106  * @brief Contains version information.
   107  */
   108 struct MetamodVersionInfo
   109 {
   110 	int api_major;			/**< ISmmAPI major version */
   111 	int api_minor;			/**< ISmmAPI minor version */
   112 	int sh_iface;			/**< SourceHook interface version */
   113 	int sh_impl;			/**< SourceHook implementation version */
   114 	int pl_min;				/**< Plugin API minimum version */
   115 	int pl_max;				/**< Plugin API maximum version */
   116 	int source_engine;		/**< Source Engine version (SOURCE_* constants) */
   117 	const char *game_dir;	/**< Game directory name */
   118 
   119 	/**
   120 	 * @brief Returns the game folder.
   121 	 *
   122 	 * @return      Game folder, or NULL if not available on this version
   123 	 *              of Metamod:Source.
   124 	 */
   125 	inline const char *GetGameDir() const
   126 	{
   127 		if (pl_max >= 15)
   128 			return NULL;
   129 		return game_dir;
   130 	}
   131 };
   132 
   133 /**
   134  * @brief Contains information about loading a plugin.
   135  */
   136 struct MetamodLoaderInfo
   137 {
   138 	const char *pl_file;	/**< File path to the plugin being loaded. */
   139 	const char *pl_path;	/**< Folder path containing the plugin. */
   140 };
   141 
   142 /**
   143  * @brief If a function of this type is exposed as "CreateInterface_MMS", then
   144  * Metamod:Source will attempt to call this function before calling 
   145  * CreateInterface.  If this function returns a valid ISmmPlugin pointer, then 
   146  * CreateInterface will not be called.
   147  *
   148  * This is useful for implementing a mini-loader plugin for multiple versions.
   149  *
   150  * @param mvi				MetamodVersionInfo structure.
   151  * @param mli				MetamodLoaderInfo structure.
   152  * @return					ISmmAPI pointer, or NULL if none.
   153  */
   154 typedef METAMOD_PLUGIN *(*METAMOD_FN_LOAD)(const MetamodVersionInfo *mvi, 
   155 										   const MetamodLoaderInfo *mli);
   156 
   157 /**
   158  * @brief If a function of this type is exposed as "UnloadInterface_MMS", then
   159  * Metamod:Source will attempt to call this function after calling 
   160  * ISmmAPI::Unload(), and before closing the library.  This lets loader plugins 
   161  * clean up before exiting.
   162  *
   163  * Note: This function will be ignored unless CreateInterfce_MMS was exposed.
   164  * It may be called even if ISmmAPI::Unload() could not be called.
   165  */
   166 typedef void (*METAMOD_FN_UNLOAD)();
   167 
   168 /**
   169  * @brief Original type of load function.  CreateInterfaceFn from Valve.
   170  * 
   171  * Plugins will expose this as "CreateInterface".
   172  */
   173 typedef void *(*METAMOD_FN_ORIG_LOAD)(const char *, int *);
   174 
   175 #endif //INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
   176