sourcemm/ISmmAPI.h
author David Anderson <dvander@alliedmods.net>
Wed Jan 23 21:14:20 2008 +0000 (2008-01-23)
changeset 493 35fc94065cd1
parent 480 d096210677d4
child 513 ed5a3e60826a
permissions -rw-r--r--
updated some pointless numbers
     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 <stdarg.h>
    37 #include <interface.h>
    38 #include <eiface.h>
    39 #include <sourcehook.h>
    40 #include <IPluginManager.h>
    41 #include <ISmmPlugin.h>
    42 #include <ISmmPluginExt.h>
    43 
    44 #if defined __GNUC__
    45 #if ((__GNUC__ == 3) && (__GNUC_MINOR__ < 4)) || (__GNUC__ < 3)
    46 #error "You must compile with at least GCC 3.4! If you know what you are doing, you can remove this message."
    47 #endif //version check
    48 #endif //__GNUC__
    49 
    50 #define	MMIFACE_SOURCEHOOK		"ISourceHook"			/**< ISourceHook Pointer */
    51 #define	MMIFACE_PLMANAGER		"IPluginManager"		/**< SourceMM Plugin Functions */
    52 #define MMIFACE_SH_HOOKMANAUTOGEN	"IHookManagerAutoGen"		/**< SourceHook::IHookManagerAutoGen Pointer */
    53 #define IFACE_MAXNUM			999						/**< Maximum interface version */
    54 
    55 namespace SourceMM
    56 {
    57 	class ISmmPlugin;
    58 	class IMetamodListener;
    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 		 *						If syn is false, the true function is returned.
   103 		 * @return				CreateInterfaceFn function pointer.
   104 		 */
   105 		virtual CreateInterfaceFn GetServerFactory(bool syn=true) =0;
   106 
   107 		/**
   108 		 * @brief Returns a CGlobalVars pointer from the HL2 Engine.
   109 		 *
   110 		 * @return				CGlobalVars pointer.
   111 		 */
   112 		virtual CGlobalVars *GetCGlobals() =0;
   113 
   114 		/**
   115 		 * @brief Registers a ConCommandBase.
   116 		 *
   117 		 * @param plugin		Parent plugin API pointer.
   118 		 * @param pCommand		ConCommandBase to register.
   119 		 * @return				True if successful, false otherwise.
   120 		 */
   121 		virtual bool RegisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
   122 
   123 		/**
   124 		 * @brief Unregisters a ConCommandBase.
   125 		 *
   126 		 * @param plugin		Parent plugin API pointer.
   127 		 * @param pCommand		ConCommandBase to unlink.
   128 		 */
   129 		virtual void UnregisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
   130 	
   131 		/**
   132 		 * @brief Prints an unformatted string to the remote server console.
   133 		 * 
   134 		 * Note: Newlines are not added automatically.
   135 		 *
   136 		 * @param str			Message string.
   137 		 */
   138 		virtual void ConPrint(const char *str) =0;
   139 
   140 		/**
   141 		 * @brief Prints a formatted message to the remote server console.  
   142 		 * 
   143 		 * Note: Newlines are not added automatically.
   144 		 *
   145 		 * @param fmt			Formatted message.
   146 		 */
   147 		virtual void ConPrintf(const char *fmt, ...) =0;
   148 
   149 		/**
   150 		 * @brief Returns the Metamod Version numbers as major version and 
   151 		 * minor (API) version.  Changes to minor version are guaranteed to be 
   152 		 * backwards compatible.  Changes to major version are not.
   153 		 * 
   154 		 * @param major			Filled with the major API version number.
   155 		 * @param minor			Filled with the minor API version number.
   156 		 * @param plvers		Filled with the current plugin API version number.
   157 		 * @param plmin			Filled with the minimum plugin API version number 
   158 		 * 						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 
   184 		  * 					overrode interface, 0 if none
   185 		  * @return				Returned pointer
   186 		  */
   187 		virtual void *MetaFactory(const char *iface, int *ret, PluginId *id) =0;
   188 
   189 		/**
   190 		 * @brief Given a base interface name, such as ServerGameDLL or 
   191 		 * ServerGameDLL003, reformats the string to increase the number, then 
   192 		 * returns the new number. This is the base function to InterfaceSearch() 
   193 		 * and VInterfaceMatch().
   194 		 * 
   195 		 * @param iface			Input/output interface name.  Must be writable.
   196 		 * @param maxlength		Maximum length of iface buffer.  Must be at least 
   197 		 * 						strlen(iface)+4 chars.
   198 		 * @return				The newly incremented iface version number.
   199 		 */
   200 		virtual int FormatIface(char iface[], unsigned int maxlength) =0;
   201 
   202 		/**
   203 		 * @brief Searches for an interface, eliminating the need to loop 
   204 		 * through FormatIface().
   205 		 * 
   206 		 * @param fn			InterfaceFactory function.
   207 		 * @param iface			Interface string name.
   208 		 * @param max			Maximum version to look up.
   209 		 * @param ret			Last return code from interface factory function.
   210 		 * @return				Interface pointer, or NULL if not found.
   211 		 */
   212 		virtual void *InterfaceSearch(CreateInterfaceFn fn, 
   213 									  const char *iface, 
   214 									  int max, 
   215 									  int *ret) =0;
   216 
   217 		/**
   218 		 * @brief Returns the base directory of the game/server, equivalent to 
   219 		 * IVEngineServer::GetGameDir(), except the path is absolute.
   220 		 *
   221 		 * @return				Static pointer to game's absolute basedir.
   222 		 */
   223 		virtual const char *GetBaseDir() =0;
   224 
   225 		/**
   226 		 * @brief Formats a file path to the local OS.  
   227 		 *
   228 		 * Does not include any base directories.  Note that all slashes and 
   229 		 * black slashes are reverted to the local OS's expectancy.
   230 		 *
   231 		 * @param buffer		Destination buffer to store path.
   232 		 * @param len			Maximum length of buffer, including null 
   233 		 * 						terminator.
   234 		 * @param fmt			Formatted string.
   235 		 * @param ...			Arguments in the string.
   236 		 * @return				Number of bytes written, not including the null 
   237 		 *						terminator.
   238 		 */
   239 		virtual size_t PathFormat(char *buffer, size_t len, const char *fmt, ...) =0;
   240 
   241 		/**
   242 		 * @brief Prints text in the specified client's console. Same as 
   243 		 * IVEngineServer::ClientPrintf except that it allows for string 
   244 		 * formatting.
   245 		 *
   246 		 * @param client		Client edict pointer.
   247 		 * @param fmt			Formatted string to print to the client.
   248 		 */
   249 		virtual void ClientConPrintf(edict_t *client, const char *fmt, ...) =0;
   250 
   251 		/**
   252 		 * @brief Wrapper around InterfaceSearch().  Assumes no maximum.
   253 		 * This is designed to replace the fact that searches only went upwards.
   254 		 * The "V" is intended to convey that this is for Valve formatted 
   255 		 * interface strings.
   256 		 *
   257 		 * @param fn			Interface factory function.
   258 		 * @param iface			Interface string.
   259 		 * @param min			Minimum value to search from.  If zero, searching 
   260 		 *						begins from the first available version regardless 
   261 		 *						of the interface.  Note that this can return 
   262 		 *						interfaces EARLIER than the version specified.  A 
   263 		 *						value of -1 (default) specifies the string version 
   264 		 *						as the minimum.  Any other value specifices the 
   265 		 *						minimum value to search from.
   266 		 * @return				Interface pointer, or NULL if not found.
   267 		 */
   268 		virtual void *VInterfaceMatch(CreateInterfaceFn fn, 
   269 									  const char *iface, 
   270 									  int min=-1) =0;
   271 
   272 		/**
   273 		 * @brief Tells SourceMM to add VSP hooking capability to plugins.  
   274 		 *
   275 		 * Since this  potentially uses more resources than it would otherwise, 
   276 		 * plugins have to explicitly enable the feature.  Whether requested or 
   277 		 * not, if it is enabled, all plugins will get a pointer to the VSP 
   278 		 * listener through IMetamodListener.  This will not be called more than 
   279 		 * once for a given plugin; if it is requested more than once, each 
   280 		 * successive call will only give the pointer to plugins which have not 
   281 		 * yet received it.
   282 		 */
   283 		virtual void EnableVSPListener() =0;
   284 
   285 		/**
   286 		 * @brief Returns the interface version of the GameDLL's IServerGameDLL 
   287 		 * implementation.
   288 		 *
   289 		 * @return				Interface version of the loaded IServerGameDLL.
   290 		 */
   291 		virtual int GetGameDLLVersion() =0;
   292 
   293 		/**
   294 		 * @brief Returns the number of user messages in the GameDLL.
   295 		 *
   296 		 * @return				Number of user messages, or -1 if SourceMM has 
   297 		 *						failed to get user message list.
   298 		 */
   299 		virtual int GetUserMessageCount() =0;
   300 
   301 		/**
   302 		 * @brief Returns the index of the specified user message.
   303 		 *
   304 		 * @param name			User message name.
   305 		 * @param size			Optional pointer to store size of user message.
   306 		 * @return				Message index, or -1 on failure.
   307 		 */
   308 		virtual int FindUserMessage(const char *name, int *size=NULL) =0;
   309 
   310 		/**
   311 		 * @brief Returns the name of the specified user message.
   312 		 *
   313 		 * @param index			User message index.
   314 		 * @param size			Optional pointer to store size of user message.
   315 		 * @return				Message name, or NULL on failure.
   316 		 */
   317 		virtual const char *GetUserMessage(int index, int *size=NULL) =0;
   318 
   319 		/**
   320 		 * @brief Returns the highest interface version of IServerPluginCallbacks 
   321 		 * that the engine supports.  This is useful for games that run on older 
   322 		 * versions of the Source engine, such as The Ship.
   323 		 *
   324 		 * @return				Highest interface version of IServerPluginCallbacks.
   325 		 *						Returns 0 if SourceMM's VSP listener isn't 
   326 		 *						currently enabled.
   327 		 */
   328 		virtual int GetVSPVersion() =0;
   329 
   330 		/**
   331 		 * @brief Returns the engine interface that MM:S is using as a backend.
   332 		 *
   333 		 * The values will be one of the SOURCE_ENGINE_* constants from the top
   334 		 * of this file.
   335 	 	 *
   336 	 	 * @return				A SOURCE_ENGINE_* constant value.
   337 		 */
   338 		virtual int GetSourceEngineBuild() =0;
   339 
   340 		/**
   341 		 * @brief Returns the VSP listener loaded.  
   342 		 *
   343 		 * This is useful for late-loading plugins which need to decide whether 
   344 		 * to add a listener or not (or need to get the pointer at all).
   345 		 *
   346 		 * @param				Optional pointer to store the VSP version.
   347 		 * @return				IServerPluginCallbacks pointer, or NULL if an
   348 		 * 						IMetamodListener event has yet to occur for 
   349 		 * 						EnableVSPListener().
   350 		 */
   351 		virtual IServerPluginCallbacks *GetVSPInfo(int *pVersion) =0;
   352 
   353 		/**
   354 		 * @brief Formats a string.  This is a platform safe wrapper around 
   355 		 * snprintf/_snprintf.
   356 		 *
   357 		 * @param buffer		Buffer to write to.
   358 		 * @param maxlength		Maximum length of the buffer.
   359 		 * @param format		Format specifiers.
   360 		 * @param ...			Format arguments.
   361 		 * @return				Number of bytes actually written, not including 
   362 		 * 						the null terminator.
   363 		 */
   364 	virtual size_t Format(char *buffer, 
   365 						  size_t maxlength,
   366 						  const char *format,
   367 						  ...) =0;
   368 
   369 	/**
   370 	 * @brief Formats a string.  This is a platform safe wrapper around 
   371 	 * vsnprintf/_vsnprintf.
   372 	 *
   373 	 * @param buffer		Buffer to write to.
   374 	 * @param maxlength		Maximum length of the buffer.
   375 	 * @param format		Format specifiers.
   376 	 * @param ap			Format argument list.
   377 	 * @return				Number of bytes actually written, not including the 
   378 	 *						null terminator.
   379 	 */
   380 	virtual size_t FormatArgs(char *buffer,
   381 							  size_t maxlength,
   382 							  const char *format,
   383 							  va_list ap) =0;
   384 	};
   385 }
   386 
   387 #if !defined METAMOD_NO_AUTO_NAMESPACE
   388 using namespace SourceMM;
   389 #endif
   390 
   391 /** 
   392  * Version History
   393  *
   394  * 1.1.0 Bumped API to 1:0. The breaking changes occurred in SourceHook and the plugin API.
   395  * 1.1.2 Added API call for generating iface names.
   396  * 1.2   Added API more helper functions and new SourceHook version.
   397  * 1.2.2 Added API for printing to client console (with string formatting).
   398  * 1.3   Added new interface search API.
   399  * 1.4	 Added VSP listener and user message API.
   400  * 1.5.0 Added API for getting highest supported version of IServerPluginCallbacks.
   401  * 1.6.0 Added API for Orange Box.  Broke backwards compatibility.
   402  */
   403 
   404 #endif //_INCLUDE_ISMM_API_H
   405