| author | Scott Ehlert <ds@alliedmods.net> |
| Tue Sep 16 04:41:32 2008 -0500 (2008-09-16) | |
| changeset 533 | 591b88a78e35 |
| parent 523 | 6f1630519b81 |
| child 537 | 2ebaf6a4f86f |
| permissions | -rw-r--r-- |
| dvander@513 | 1 |
/* |
| dvander@513 | 2 |
* vim: set ts=4 : |
| dvander@513 | 3 |
* ====================================================== |
| dvander@513 | 4 |
* Metamod:Source |
| ds@523 | 5 |
* Copyright (C) 2004-2008 AlliedModders LLC and authors. |
| dvander@513 | 6 |
* All rights reserved. |
| dvander@513 | 7 |
* ====================================================== |
| dvander@513 | 8 |
* |
| dvander@513 | 9 |
* This software is provided 'as-is', without any express or implied warranty. |
| dvander@513 | 10 |
* In no event will the authors be held liable for any damages arising from |
| dvander@513 | 11 |
* the use of this software. |
| dvander@513 | 12 |
* |
| dvander@513 | 13 |
* Permission is granted to anyone to use this software for any purpose, |
| dvander@513 | 14 |
* including commercial applications, and to alter it and redistribute it |
| dvander@513 | 15 |
* freely, subject to the following restrictions: |
| dvander@513 | 16 |
* |
| dvander@513 | 17 |
* 1. The origin of this software must not be misrepresented; you must not |
| dvander@513 | 18 |
* claim that you wrote the original software. If you use this software in a |
| dvander@513 | 19 |
* product, an acknowledgment in the product documentation would be |
| dvander@513 | 20 |
* appreciated but is not required. |
| dvander@513 | 21 |
* 2. Altered source versions must be plainly marked as such, and must not be |
| dvander@513 | 22 |
* misrepresented as being the original software. |
| dvander@513 | 23 |
* 3. This notice may not be removed or altered from any source distribution. |
| dvander@513 | 24 |
* |
| dvander@513 | 25 |
* Version: $Id$ |
| dvander@513 | 26 |
*/ |
| dvander@513 | 27 |
|
| dvander@513 | 28 |
#ifndef _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_ |
| dvander@513 | 29 |
#define _INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_ |
| dvander@513 | 30 |
|
| dvander@513 | 31 |
#include <stddef.h> |
| dvander@513 | 32 |
|
| dvander@513 | 33 |
/** |
| dvander@513 | 34 |
* @file ISmmPluginExt.h Provides an alternate method for loading plugins, |
| dvander@513 | 35 |
* without needing to include the default headers and all their Half-Life baggage. |
| dvander@513 | 36 |
* |
| dvander@513 | 37 |
* @brief Definitions for extended plugin loading. |
| dvander@513 | 38 |
*/ |
| dvander@513 | 39 |
|
| dvander@513 | 40 |
#define SOURCE_ENGINE_UNKNOWN 0 /**< Could not determine the engine version */ |
| dvander@513 | 41 |
#define SOURCE_ENGINE_ORIGINAL 1 /**< Original Source Engine (used by The Ship) */ |
| dvander@513 | 42 |
#define SOURCE_ENGINE_EPISODEONE 2 /**< Episode 1 Source Engine (second major SDK) */ |
| dvander@513 | 43 |
#define SOURCE_ENGINE_ORANGEBOX 3 /**< Orange Box Source Engine (third major SDK) */ |
| dvander@513 | 44 |
|
| dvander@513 | 45 |
#define METAMOD_PLAPI_VERSION 14 /**< Version of this header file */ |
| dvander@513 | 46 |
#define METAMOD_PLAPI_NAME "ISmmPlugin" /**< Name of the plugin interface */ |
| dvander@513 | 47 |
|
| dvander@513 | 48 |
namespace SourceMM |
| dvander@513 | 49 |
{ |
| dvander@513 | 50 |
class ISmmPlugin; |
| dvander@513 | 51 |
class ISmmAPI; |
| dvander@513 | 52 |
|
| dvander@487 | 53 |
/** |
| dvander@487 | 54 |
* @brief Used to uniquely identify plugins. |
| dvander@487 | 55 |
*/ |
| dvander@513 | 56 |
typedef int PluginId; |
| dvander@513 | 57 |
|
| dvander@513 | 58 |
#define METAMOD_FAIL_API_V1 7 /**< Minimum API version to detect for V1 */ |
| dvander@513 | 59 |
#define METAMOD_FAIL_API_V2 14 /**< Minimum API version to detect for V2 */ |
| dvander@513 | 60 |
|
| dvander@513 | 61 |
/** |
| dvander@513 | 62 |
* Use this to instantiate a plugin that will always fail. |
| dvander@513 | 63 |
* This class definition works against major API versions 1 and 2. |
| dvander@513 | 64 |
*/ |
| dvander@513 | 65 |
class ISmmFailPlugin |
| dvander@513 | 66 |
{ |
| dvander@513 | 67 |
public: |
| dvander@513 | 68 |
/** |
| dvander@513 | 69 |
* @brief You must return METAMOD_FAIL_API_V1 or METAMOD_FAIL_API_V2 here, |
| dvander@513 | 70 |
* depending on which Metamod:Source version you detected. |
| dvander@513 | 71 |
*/ |
| dvander@513 | 72 |
virtual int GetApiVersion() = 0; |
| dvander@513 | 73 |
|
| dvander@513 | 74 |
/** |
| dvander@513 | 75 |
* @brief Do not change. |
| dvander@513 | 76 |
*/ |
| dvander@513 | 77 |
virtual ~ISmmFailPlugin() |
| dvander@513 | 78 |
{ |
| dvander@513 | 79 |
} |
| dvander@513 | 80 |
|
| dvander@513 | 81 |
/** |
| dvander@513 | 82 |
* @brief Return false here -- fill in the error buffer appropriately. |
| dvander@513 | 83 |
* |
| dvander@513 | 84 |
* Do not ever return true. If you do, MM:S will crash because the class layout is |
| dvander@513 | 85 |
* incomplete against ISmmPlugin. |
| dvander@513 | 86 |
* |
| dvander@513 | 87 |
* @param id Ignore. |
| dvander@513 | 88 |
* @param ismm Ignore. |
| dvander@513 | 89 |
* @param error Error buffer (must be filled). |
| dvander@513 | 90 |
* @param maxlength Maximum size of error buffer. |
| dvander@513 | 91 |
* @param late Ignore. |
| dvander@513 | 92 |
* @return Must return false. |
| dvander@513 | 93 |
*/ |
| dvander@513 | 94 |
virtual bool Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlength, bool late) =0; |
| dvander@513 | 95 |
}; |
| dvander@513 | 96 |
} |
| dvander@513 | 97 |
|
| dvander@513 | 98 |
typedef SourceMM::ISmmPlugin METAMOD_PLUGIN; |
| dvander@513 | 99 |
|
| dvander@513 | 100 |
/** |
| dvander@513 | 101 |
* @brief Contains version information. |
| dvander@513 | 102 |
*/ |
| dvander@513 | 103 |
struct MetamodVersionInfo |
| dvander@513 | 104 |
{ |
| dvander@513 | 105 |
int api_major; /**< ISmmAPI major version */ |
| dvander@513 | 106 |
int api_minor; /**< ISmmAPI minor version */ |
| dvander@513 | 107 |
int sh_iface; /**< SourceHook interface version */ |
| dvander@513 | 108 |
int sh_impl; /**< SourceHook implementation version */ |
| dvander@513 | 109 |
int pl_min; /**< Plugin API minimum version */ |
| dvander@513 | 110 |
int pl_max; /**< Plugin API maximum version */ |
| dvander@513 | 111 |
int source_engine; /**< Source Engine version (SOURCE_* constants) */ |
| dvander@513 | 112 |
}; |
| dvander@513 | 113 |
|
| dvander@513 | 114 |
/** |
| dvander@513 | 115 |
* @brief Contains information about loading a plugin. |
| dvander@513 | 116 |
*/ |
| dvander@513 | 117 |
struct MetamodLoaderInfo |
| dvander@513 | 118 |
{ |
| dvander@513 | 119 |
const char *pl_file; /**< File path to the plugin being loaded. */ |
| dvander@513 | 120 |
const char *pl_path; /**< Folder path containing the plugin. */ |
| dvander@513 | 121 |
}; |
| dvander@513 | 122 |
|
| dvander@513 | 123 |
/** |
| dvander@513 | 124 |
* @brief If a function of this type is exposed as "CreateInterface_MMS", then |
| dvander@513 | 125 |
* Metamod:Source will attempt to call this function before calling |
| dvander@513 | 126 |
* CreateInterface. If this function returns a valid ISmmPlugin pointer, then |
| dvander@513 | 127 |
* CreateInterface will not be called. |
| dvander@513 | 128 |
* |
| dvander@513 | 129 |
* This is useful for implementing a mini-loader plugin for multiple versions. |
| dvander@513 | 130 |
* |
| dvander@513 | 131 |
* @param mvi MetamodVersionInfo structure. |
| dvander@513 | 132 |
* @param mli MetamodLoaderInfo structure. |
| dvander@513 | 133 |
* @return ISmmAPI pointer, or NULL if none. |
| dvander@513 | 134 |
*/ |
| dvander@513 | 135 |
typedef METAMOD_PLUGIN *(*METAMOD_FN_LOAD)(const MetamodVersionInfo *mvi, |
| dvander@513 | 136 |
const MetamodLoaderInfo *mli); |
| dvander@513 | 137 |
|
| dvander@513 | 138 |
/** |
| dvander@513 | 139 |
* @brief If a function of this type is exposed as "UnloadInterface_MMS", then |
| dvander@513 | 140 |
* Metamod:Source will attempt to call this function after calling |
| dvander@513 | 141 |
* ISmmAPI::Unload(), and before closing the library. This lets loader plugins |
| dvander@513 | 142 |
* clean up before exiting. |
| dvander@513 | 143 |
* |
| dvander@513 | 144 |
* Note: This function will be ignored unless CreateInterfce_MMS was exposed. |
| dvander@513 | 145 |
* It may be called even if ISmmAPI::Unload() could not be called. |
| dvander@513 | 146 |
*/ |
| dvander@513 | 147 |
typedef void (*METAMOD_FN_UNLOAD)(); |
| dvander@513 | 148 |
|
| dvander@513 | 149 |
/** |
| dvander@513 | 150 |
* @brief Original type of load function. CreateInterfaceFn from Valve. |
| dvander@513 | 151 |
* |
| dvander@513 | 152 |
* Plugins will expose this as "CreateInterface". |
| dvander@513 | 153 |
*/ |
| dvander@513 | 154 |
typedef void *(*METAMOD_FN_ORIG_LOAD)(const char *, int *); |
| dvander@513 | 155 |
|
| dvander@513 | 156 |
#endif //INCLUDE_METAMOD_SOURCE_PLUGIN_EXT_H_ |
| dvander@513 | 157 |