sourcemm/ISmmPluginExt.h
author David Anderson <dvander@alliedmods.net>
Tue Oct 16 16:14:30 2007 +0000 (2007-10-16)
changeset 423 45d08a37745a
parent 406 d159cb02b2bb
child 487 ddb0319e82aa
permissions -rw-r--r--
nonsense change to push new build through
     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 #define SOURCE_ENGINE_UNKNOWN			0				/**< Could not determine the engine version */
    32 #define SOURCE_ENGINE_ORIGINAL			1				/**< Original Source Engine (used by The Ship) */
    33 #define SOURCE_ENGINE_EPISODEONE		2				/**< Episode 1 Source Engine (second major SDK) */
    34 #define SOURCE_ENGINE_ORANGEBOX			3				/**< Orange Box Source Engine (third major SDK) */
    35 
    36 #define METAMOD_PLAPI_VERSION			14				/**< Version of this header file */
    37 #define METAMOD_PLAPI_NAME				"ISmmPlugin"	/**< Name of the plugin interface */
    38 
    39 namespace SourceMM
    40 {
    41 	class ISmmPlugin;
    42 }
    43 
    44 typedef SourceMM::ISmmPlugin METAMOD_PLUGIN;
    45 
    46 /**
    47  * @file ISmmPluginExt.h 	Definitions for extended plugin exposure syntax.
    48  * @brief Provides an alternate method for loading plugins, without needing to 
    49  * 		  include the default headers and all their Half-Life baggage.
    50  */
    51 
    52 /**
    53  * @brief Contains version information.
    54  */
    55 struct MetamodVersionInfo
    56 {
    57 	int api_major;			/**< ISmmAPI major version */
    58 	int api_minor;			/**< ISmmAPI minor version */
    59 	int sh_iface;			/**< SourceHook interface version */
    60 	int sh_impl;			/**< SourceHook implementation version */
    61 	int pl_min;				/**< Plugin API minimum version */
    62 	int pl_max;				/**< Plugin API maximum version */
    63 	int source_engine;		/**< Source Engine version (SOURCE_* constants) */
    64 };
    65 
    66 /**
    67  * @brief Contains information about loading a plugin.
    68  */
    69 struct MetamodLoaderInfo
    70 {
    71 	const char *pl_file;	/**< File path to the plugin being loaded. */
    72 	const char *pl_path;	/**< Folder path containing the plugin. */
    73 };
    74 
    75 /**
    76  * @brief If a function of this type is exposed as "CreateInterface_MMS", then
    77  * Metamod:Source will attempt to call this function before calling 
    78  * CreateInterface.  If this function returns a valid ISmmPlugin pointer, then 
    79  * CreateInterface will not be called.
    80  *
    81  * This is useful for implementing a mini-loader plugin for multiple versions.
    82  *
    83  * @param mvi				MetamodVersionInfo structure.
    84  * @param mli				MetamodLoaderInfo structure.
    85  * @return					ISmmAPI pointer, or NULL if none.
    86  */
    87 typedef METAMOD_PLUGIN *(*METAMOD_FN_LOAD)(const MetamodVersionInfo *mvi, 
    88 										   const MetamodLoaderInfo *mli);
    89 
    90 /**
    91  * @brief If a function of this type is exposed as "UnloadInterface_MMS", then
    92  * Metamod:Source will attempt to call this function after calling 
    93  * ISmmAPI::Unload(), and before closing the library.  This lets loader plugins 
    94  * clean up before exiting.
    95  *
    96  * Note: This function will be ignored unless CreateInterfce_MMS was exposed.
    97  * It may be called even if ISmmAPI::Unload() could not be called.
    98  */
    99 typedef void (*METAMOD_FN_UNLOAD)();
   100 
   101 /**
   102  * @brief Original type of load function.  CreateInterfaceFn from Valve.
   103  * 
   104  * Plugins will expose this as "CreateInterface".
   105  */
   106 typedef void *(*METAMOD_FN_ORIG_LOAD)(const char *, int *);
   107 
   108 #endif //INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_
   109