sourcemm/ISmmPluginExt.h
author David Anderson <dvander@alliedmods.net>
Thu Jan 10 17:22:14 2008 +0000 (2008-01-10)
changeset 487 ddb0319e82aa
parent 406 d159cb02b2bb
child 488 c05bc47b2ecd
permissions -rw-r--r--
added ISmmFailPlugin for alternate loaders
     1 /**
     2  * vim: set ts=4 :
     3  * ======================================================
     4  * Metamod:Source
     5  * Copyright (C) 2004-2007 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  * Version: $Id$
    26  */
    27 
    28 #ifndef _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
    29 #define _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
    30 
    31 /**
    32  * @file ISmmPluginExt.h 	Definitions for extended plugin exposure syntax.
    33  * @brief Provides an alternate method for loading plugins, without needing to 
    34  * 		  include the default headers and all their Half-Life baggage.
    35  */
    36 
    37 #define SOURCE_ENGINE_UNKNOWN			0				/**< Could not determine the engine version */
    38 #define SOURCE_ENGINE_ORIGINAL			1				/**< Original Source Engine (used by The Ship) */
    39 #define SOURCE_ENGINE_EPISODEONE		2				/**< Episode 1 Source Engine (second major SDK) */
    40 #define SOURCE_ENGINE_ORANGEBOX			3				/**< Orange Box Source Engine (third major SDK) */
    41 
    42 #define METAMOD_PLAPI_VERSION			14				/**< Version of this header file */
    43 #define METAMOD_PLAPI_NAME				"ISmmPlugin"	/**< Name of the plugin interface */
    44 
    45 namespace SourceMM
    46 {
    47 	class ISmmPlugin;
    48 	class ISmmAPI;
    49 
    50 	/**
    51 	 * @brief Used to uniquely identify plugins.
    52 	 */
    53 	typedef int PluginId;
    54 
    55 	#define METAMOD_FAIL_API_V1			7				/**< Minimum API version to detect for V1 */
    56 	#define METAMOD_FAIL_API_V2			14				/**< Minimum API version to detect for V2 */
    57 
    58 	/**
    59 	 * Use this to instantiate a plugin that will always fail.
    60 	 * This class definition works against major API versions 1 and 2.
    61 	 */
    62 	class ISmmFailPlugin
    63 	{
    64 	public:
    65 		/**
    66 		 * @brief You must return METAMOD_FAIL_API_V1 or METAMOD_FAIL_API_V2 here, 
    67 		 * depending on which Metamod:Source version you detected.
    68 		 */
    69 		virtual int GetApiVersion() = 0;
    70 
    71 		/**
    72 		 * @brief Do not change.
    73 		 */
    74 		virtual ~ISmmFailPlugin()
    75 		{
    76 		}
    77 
    78 		/**
    79 		 * @brief Return false here -- fill in the error buffer appropriately.
    80 		 *
    81 		 * Do not ever return true.  If you do, MM:S will crash because the class layout is 
    82 		 * incomplete against ISmmPlugin.
    83 		 * 
    84 		 * @param id			Ignore.
    85 		 * @param ismm			Ignore.
    86 		 * @param error			Error buffer (must be filled).
    87 		 * @param maxlength		Maximum size of error buffer.
    88 		 * @param late			Ignore.
    89 		 * @return				Must return false.
    90 		 */
    91 		virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0;
    92 	};
    93 }
    94 
    95 typedef SourceMM::ISmmPlugin METAMOD_PLUGIN;
    96 
    97 /**
    98  * @brief Contains version information.
    99  */
   100 struct MetamodVersionInfo
   101 {
   102 	int api_major;			/**< ISmmAPI major version */
   103 	int api_minor;			/**< ISmmAPI minor version */
   104 	int sh_iface;			/**< SourceHook interface version */
   105 	int sh_impl;			/**< SourceHook implementation version */
   106 	int pl_min;				/**< Plugin API minimum version */
   107 	int pl_max;				/**< Plugin API maximum version */
   108 	int source_engine;		/**< Source Engine version (SOURCE_* constants) */
   109 };
   110 
   111 /**
   112  * @brief Contains information about loading a plugin.
   113  */
   114 struct MetamodLoaderInfo
   115 {
   116 	const char *pl_file;	/**< File path to the plugin being loaded. */
   117 	const char *pl_path;	/**< Folder path containing the plugin. */
   118 };
   119 
   120 /**
   121  * @brief If a function of this type is exposed as "CreateInterface_MMS", then
   122  * Metamod:Source will attempt to call this function before calling 
   123  * CreateInterface.  If this function returns a valid ISmmPlugin pointer, then 
   124  * CreateInterface will not be called.
   125  *
   126  * This is useful for implementing a mini-loader plugin for multiple versions.
   127  *
   128  * @param mvi				MetamodVersionInfo structure.
   129  * @param mli				MetamodLoaderInfo structure.
   130  * @return					ISmmAPI pointer, or NULL if none.
   131  */
   132 typedef METAMOD_PLUGIN *(*METAMOD_FN_LOAD)(const MetamodVersionInfo *mvi, 
   133 										   const MetamodLoaderInfo *mli);
   134 
   135 /**
   136  * @brief If a function of this type is exposed as "UnloadInterface_MMS", then
   137  * Metamod:Source will attempt to call this function after calling 
   138  * ISmmAPI::Unload(), and before closing the library.  This lets loader plugins 
   139  * clean up before exiting.
   140  *
   141  * Note: This function will be ignored unless CreateInterfce_MMS was exposed.
   142  * It may be called even if ISmmAPI::Unload() could not be called.
   143  */
   144 typedef void (*METAMOD_FN_UNLOAD)();
   145 
   146 /**
   147  * @brief Original type of load function.  CreateInterfaceFn from Valve.
   148  * 
   149  * Plugins will expose this as "CreateInterface".
   150  */
   151 typedef void *(*METAMOD_FN_ORIG_LOAD)(const char *, int *);
   152 
   153 #endif //INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
   154