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