sourcemm/ISmmAPI.h
author David Anderson <dvander@alliedmods.net>
Sat Oct 06 15:47:59 2007 +0000 (2007-10-06)
changeset 375 17ca1d5645ac
parent 371 751179604513
child 376 f2d55f90f697
permissions -rw-r--r--
broke api! refactored a bunch of very, very old things
     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_ISMM_API_H
    29 #define _INCLUDE_ISMM_API_H
    30 
    31 /**
    32  * @brief External API interface
    33  * @file ISmmAPI.h
    34  */
    35 
    36 #include <interface.h>
    37 #include <eiface.h>
    38 #include <sourcehook.h>
    39 #include "IPluginManager.h"
    40 
    41 #if defined __GNUC__
    42 #if ((__GNUC__ == 3) && (__GNUC_MINOR__ < 4)) || (__GNUC__ < 3)
    43 #error "You must compile with at least GCC 3.4! If you know what you are doing, you can remove this message."
    44 #endif //version check
    45 #endif //__GNUC__
    46 
    47 class IMetamodListener;
    48 class ISmmPluginManager;
    49 class ISmmPlugin;
    50 
    51 #define	MMIFACE_SOURCEHOOK		"ISourceHook"			/**< ISourceHook Pointer */
    52 #define	MMIFACE_PLMANAGER		"IPluginManager"		/**< SourceMM Plugin Functions */
    53 #define IFACE_MAXNUM			999						/**< Maximum interface version */
    54 
    55 #define SOURCE_ENGINE_UNKNOWN			0				/**< Could not determine the engine version */
    56 #define SOURCE_ENGINE_ORIGINAL			1				/**< Original Source Engine (used by The Ship) */
    57 #define SOURCE_ENGINE_EPISODEONE		2				/**< Episode 1 Source Engine (second major SDK) */
    58 #define SOURCE_ENGINE_ORANGEBOX			3				/**< Orange Box Source Engine (third major SDK) */
    59 
    60 class ISmmAPI
    61 {
    62 public:
    63 	/**
    64 	 * @brief Logs a message through the HL2 log system.
    65 	 * Note: Newlines are appended automatically.
    66 	 *
    67 	 * @param pl			Plugin API pointer (used for tagging message)
    68 	 * @param msg			Formatted string.
    69 	 */
    70 	virtual void LogMsg(ISmmPlugin *pl, const char *msg, ...) =0;
    71 
    72 	/**
    73 	 * @brief Returns an interface factory for the HL2 engine.
    74 	 *
    75 	 * @param syn			If syn is true, the synthetic wrapper is returned.  
    76 	 *						If syn is false, the true function is returned.
    77 	 * @return				CreateInterfaceFn function pointer.
    78 	 */
    79 	virtual CreateInterfaceFn GetEngineFactory(bool syn=true) =0;
    80 
    81 	/**
    82 	 * @brief Returns an interface factory for the HL2 physics engine.
    83 	 *
    84 	 * @param syn			If syn is true, the synthetic wrapper is returned.  
    85 	 *						If syn is false, the true function is returned.
    86 	 * @return				CreateInterfaceFn function pointer.
    87 	 */
    88 	virtual CreateInterfaceFn GetPhysicsFactory(bool syn=true) =0;
    89 
    90 	/**
    91 	 * @brief Returns an interface factory for the HL2 file system.
    92 	 *
    93 	 * @param syn			If syn is true, the synthetic wrapper is returned.  
    94 	 *						If syn is false, the true function is returned.
    95 	 * @return				CreateInterfaceFn function pointer.
    96 	 */
    97 	virtual CreateInterfaceFn GetFileSystemFactory(bool syn=true) =0;
    98 
    99 	/**
   100 	 * @brief Returns an interface factory for the GameDLL.
   101 	 *
   102 	 * @param syn			If syn is true, the synthetic wrapper is returned.  
   103 	 *						If syn is false, the true function is returned.
   104 	 * @return				CreateInterfaceFn function pointer.
   105 	 */
   106 	virtual CreateInterfaceFn GetServerFactory(bool syn=true) =0;
   107 
   108 	/**
   109 	 * @brief Returns a CGlobalVars pointer from the HL2 Engine.
   110 	 *
   111 	 * @return				CGlobalVars pointer.
   112 	 */
   113 	virtual CGlobalVars *GetCGlobals() =0;
   114 
   115 	/**
   116 	 * @brief Registers a ConCommandBase.
   117 	 *
   118 	 * @param plugin		Parent plugin API pointer.
   119 	 * @param pCommand		ConCommandBase to register.
   120 	 * @return				True if successful, false otherwise.
   121 	 */
   122 	virtual bool RegisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
   123 
   124 	/**
   125 	 * @brief Unregisters a ConCommandBase.
   126 	 *
   127 	 * @param plugin		Parent plugin API pointer.
   128 	 * @param pCommand		ConCommandBase to unlink.
   129 	 */
   130 	virtual void UnregisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
   131 	
   132 	/**
   133 	 * @brief Prints an unformatted string to the remote server console.
   134 	 * 
   135 	 * Note: Newlines are not added automatically.
   136 	 *
   137 	 * @param str			Message string.
   138 	 */
   139 	virtual void ConPrint(const char *str) =0;
   140 
   141 	/**
   142 	 * @brief Prints a formatted message to the remote server console.  
   143 	 * 
   144 	 * Note: Newlines are not added automatically.
   145 	 *
   146 	 * @param fmt			Formatted message.
   147 	 */
   148 	virtual void ConPrintf(const char *fmt, ...) =0;
   149 
   150 	/**
   151 	 * @brief Returns the Metamod Version numbers as major version and minor (API) version.
   152 	 * Changes to minor version are guaranteed to be backwards compatible.
   153 	 * Changes to major version are not.
   154 	 * 
   155 	 * @param major			Filled with the major API version number.
   156 	 * @param minor			Filled with the minor API version number.
   157 	 * @param plvers		Filled with the current plugin API version number.
   158 	 * @param plmin			Filled with the minimum plugin API version number supported.
   159 	 */
   160 	virtual void GetApiVersions(int &major, int &minor, int &plvers, int &plmin) =0;
   161 	
   162 	/** 
   163 	 * @brief Returns sourcehook API version and implementation version.
   164 	 *
   165 	 * @param shvers		Filled with the SourceHook API version number.
   166 	 * @param shimpl		Filled with the SourceHook implementation number.
   167 	 */
   168 	virtual void GetShVersions(int &shvers, int &shimpl) =0;
   169 	
   170 	/**
   171 	 * @brief Adds a Metamod listener.
   172 	 *
   173 	 * @param plugin		Plugin interface pointer.
   174 	 * @param pListener		Listener interface pointer to add.
   175 	 */
   176 	virtual void AddListener(ISmmPlugin *plugin, IMetamodListener *pListener) =0;
   177 
   178 	/**
   179 	  * @brief Queries the metamod factory
   180 	  *
   181 	  * @param iface		String containing interface name
   182 	  * @param ret			Optional pointer to store return status
   183 	  * @param id			Optional pointer to store id of plugin that overrode interface, 0 if none
   184 	  * @return				Returned pointer
   185 	  */
   186 	virtual void *MetaFactory(const char *iface, int *ret, PluginId *id) =0;
   187 
   188 	/**
   189 	 * @brief Given a base interface name, such as ServerGameDLL or ServerGameDLL003, 
   190 	 * reformats the string to increase the number, then returns the new number.
   191 	 * This is the base function to InterfaceSearch() and VInterfaceMatch().
   192 	 * 
   193 	 * @param iface			Input/output interface name.  Must be writable.
   194 	 * @param maxlength		Maximum length of iface buffer.  Must be at least strlen(iface)+4 chars.
   195 	 * @return				The newly incremented iface version number.
   196 	 */
   197 	virtual int FormatIface(char iface[], unsigned int maxlength) =0;
   198 
   199 	/**
   200 	 * @brief Searches for an interface, eliminating the need to loop through FormatIface().
   201 	 * 
   202 	 * @param fn			InterfaceFactory function.
   203 	 * @param iface			Interface string name.
   204 	 * @param max			Maximum version to look up.
   205 	 * @param ret			Last return code from interface factory function.
   206 	 * @return				Interface pointer, or NULL if not found.
   207 	 */
   208 	virtual void *InterfaceSearch(CreateInterfaceFn fn, const char *iface, int max, int *ret) =0;
   209 
   210 	/**
   211 	 * @brief Returns the base directory of the game/server, equivalent to 
   212 	 * IVEngineServer::GetGameDir(), except the path is absolute.
   213 	 *
   214 	 * @return				Static pointer to game's absolute basedir.
   215 	 */
   216 	virtual const char *GetBaseDir() =0;
   217 
   218 	/**
   219 	 * @brief Formats a file path to the local OS.  
   220 	 *
   221 	 * Does not include any base directories.  Note that all slashes and black 
   222 	 * slashes are reverted to the local OS's expectancy.
   223 	 *
   224 	 * @param buffer		Destination buffer to store path.
   225 	 * @param len			Maximum length of buffer, including null terminator.
   226 	 * @param fmt			Formatted string.
   227 	 */
   228 	virtual void PathFormat(char *buffer, size_t len, const char *fmt, ...) =0;
   229 
   230 	/**
   231 	 * @brief Prints text in the specified client's console. Same as 
   232 	 * IVEngineServer::ClientPrintf except that it allows for string formatting.
   233 	 *
   234 	 * @param client		Client edict pointer.
   235 	 * @param fmt			Formatted string to print to the client.
   236 	 */
   237 	virtual void ClientConPrintf(edict_t *client, const char *fmt, ...) =0;
   238 
   239 	/**
   240 	 * @brief Wrapper around InterfaceSearch().  Assumes no maximum.
   241 	 * This is designed to replace the fact that searches only went upwards.
   242 	 * The "V" is intended to convey that this is for Valve formatted interface strings.
   243 	 *
   244 	 * @param fn			Interface factory function.
   245 	 * @param iface			Interface string.
   246 	 * @param min			Minimum value to search from.  If zero, searching 
   247 	 *						begins from the first available version regardless 
   248 	 *						of the interface.  Note that this can return 
   249 	 *						interfaces EARLIER than the version specified.  A 
   250 	 *						value of -1 (default) specifies the string version 
   251 	 *						as the minimum.  Any other value specifices the 
   252 	 *						minimum value to search from.
   253 	 * @return				Interface pointer, or NULL if not found.
   254 	 */
   255 	virtual void *VInterfaceMatch(CreateInterfaceFn fn, const char *iface, int min=-1) =0;
   256 
   257 	/**
   258 	 * @brief Tells SourceMM to add VSP hooking capability to plugins.  
   259 	 *
   260 	 * Since this  potentially uses more resources than it would otherwise, 
   261 	 * plugins have to explicitly enable the feature.  Whether requested or 
   262 	 * not, if it is enabled, all plugins will get a pointer to the VSP 
   263 	 * listener through IMetamodListener.  This will not be called more than 
   264 	 * once for a given plugin; if it is requested more than once, each 
   265 	 * successive call will only give the pointer to plugins which have not 
   266 	 * yet received it.
   267 	 */
   268 	virtual void EnableVSPListener() =0;
   269 
   270 	/**
   271 	 * @brief Returns the interface version of the GameDLL's IServerGameDLL 
   272 	 * implementation.
   273 	 *
   274 	 * @return				Interface version of the loaded IServerGameDLL.
   275 	 */
   276 	virtual int GetGameDLLVersion() =0;
   277 
   278 	/**
   279 	 * @brief Returns the number of user messages in the GameDLL.
   280 	 *
   281 	 * @return				Number of user messages, or -1 if SourceMM has 
   282 	 *						failed to get user message list.
   283 	 */
   284 	virtual int GetUserMessageCount() =0;
   285 
   286 	/**
   287 	 * @brief Returns the index of the specified user message.
   288 	 *
   289 	 * @param name			User message name.
   290 	 * @param size			Optional pointer to store size of user message.
   291 	 * @return				Message index, or -1 on failure.
   292 	 */
   293 	virtual int FindUserMessage(const char *name, int *size=NULL) =0;
   294 
   295 	/**
   296 	 * @brief Returns the name of the specified user message.
   297 	 *
   298 	 * @param index			User message index.
   299 	 * @param size			Optional pointer to store size of user message.
   300 	 * @return				Message name, or NULL on failure.
   301 	 */
   302 	virtual const char *GetUserMessage(int index, int *size=NULL) =0;
   303 
   304 	/**
   305 	 * @brief Returns the highest interface version of IServerPluginCallbacks 
   306 	 * that the engine supports.  This is useful for games that run on older 
   307 	 * versions of the Source engine, such as The Ship.
   308 	 *
   309 	 * @return				Highest interface version of IServerPluginCallbacks.
   310 	 *						Returns 0 if SourceMM's VSP listener isn't currently 
   311 	 *						enabled.
   312 	 */
   313 	virtual int GetVSPVersion() =0;
   314 
   315 	/**
   316 	 * @brief Returns the engine interface that MM:S is using as a backend.
   317 	 *
   318 	 * The values will be one of the SOURCE_ENGINE_* constants from the top
   319 	 * of this file.
   320 	 *
   321 	 * @return				A SOURCE_ENGINE_* constant value.
   322 	 */
   323 	virtual int GetSourceEngineBuild() =0;
   324 
   325 	/**
   326 	 * @brief Returns the VSP listener loaded.  
   327 	 *
   328 	 * This is useful for late-loading plugins which need to decide whether 
   329 	 * to add a listener or not (or need to get the pointer at all).
   330 	 *
   331 	 * @param				Optional pointer to store the VSP version.
   332 	 * @return				IServerPluginCallbacks pointer, or NULL if an
   333 	 * 						IMetamodListener event has yet to occur for 
   334 	 * 						EnableVSPListener().
   335 	 */
   336 	virtual IServerPluginCallbacks *GetVSPInfo(int *pVersion) =0;
   337 };
   338 
   339 
   340 /** 
   341  * Version History
   342  *
   343  * 1.1.0 Bumped API to 1:0. The breaking changes occurred in SourceHook and the plugin API.
   344  * 1.1.2 Added API call for generating iface names.
   345  * 1.2   Added API more helper functions and new SourceHook version.
   346  * 1.2.2 Added API for printing to client console (with string formatting).
   347  * 1.3   Added new interface search API.
   348  * 1.4	 Added VSP listener and user message API.
   349  * 1.5.0 Added API for getting highest supported version of IServerPluginCallbacks.
   350  * 1.6.0 Added API for Orange Box.  Broke backwards compatibility.
   351  */
   352 
   353 #endif //_INCLUDE_ISMM_API_H
   354