sourcemm/metamod_provider.h
author David Anderson <dvander@alliedmods.net>
Sat Jul 26 05:02:29 2008 +0000 (2008-07-26)
changeset 529 7f1c8e49df8f
parent 524 131160b48219
permissions -rw-r--r--
Bumped version for tagging
Removed unused update_tool from trunk
dvander@371
     1
/**
dvander@371
     2
 * vim: set ts=4 :
dvander@371
     3
 * ======================================================
dvander@371
     4
 * Metamod:Source
ds@523
     5
 * Copyright (C) 2004-2008 AlliedModders LLC and authors.
dvander@371
     6
 * All rights reserved.
dvander@371
     7
 * ======================================================
dvander@371
     8
 *
dvander@371
     9
 * This software is provided 'as-is', without any express or implied warranty.
dvander@371
    10
 * In no event will the authors be held liable for any damages arising from 
dvander@371
    11
 * the use of this software.
dvander@371
    12
 * 
dvander@371
    13
 * Permission is granted to anyone to use this software for any purpose, 
dvander@371
    14
 * including commercial applications, and to alter it and redistribute it 
dvander@371
    15
 * freely, subject to the following restrictions:
dvander@371
    16
 *
dvander@371
    17
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@371
    18
 * claim that you wrote the original software. If you use this software in a 
dvander@371
    19
 * product, an acknowledgment in the product documentation would be 
dvander@371
    20
 * appreciated but is not required.
dvander@371
    21
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@371
    22
 * misrepresented as being the original software.
dvander@371
    23
 * 3. This notice may not be removed or altered from any source distribution.
dvander@371
    24
 *
dvander@371
    25
 * Version: $Id$
dvander@371
    26
 */
dvander@371
    27
dvander@371
    28
#ifndef _INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@371
    29
#define _INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@371
    30
dvander@371
    31
namespace SourceMM
dvander@371
    32
{
dvander@371
    33
	enum
dvander@371
    34
	{
ds@520
    35
		ConVarFlag_None = 0,
ds@520
    36
		ConVarFlag_Notify = 1,
ds@520
    37
		ConVarFlag_SpOnly = 2,
dvander@371
    38
	};
dvander@371
    39
dvander@371
    40
	enum ProvidedHooks
dvander@371
    41
	{
dvander@371
    42
		ProvidedHook_LevelInit = 0,			/**< IServerGameDLL::LevelInit */
dvander@371
    43
		ProvidedHook_LevelShutdown = 1,		/**< IServerGameDLL::LevelShutdown */
dvander@371
    44
		ProvidedHook_DLLInit = 2,			/**< IServerGameDLL::DLLInit */
dvander@371
    45
		ProvidedHook_DLLShutdown = 3,		/**< IServerGameDLL::DLLShutdown */
dvander@371
    46
		ProvidedHook_GameInit = 4,			/**< IServerGameDLL::GameInit */
dvander@371
    47
	};
dvander@371
    48
dvander@371
    49
	/**
dvander@371
    50
	 * @brief Abstracts command information, since the new engine fixes the 
dvander@371
    51
	 * re-entrancy problems in the tokenization system.
dvander@371
    52
	 */
dvander@371
    53
	class IMetamodSourceCommandInfo
dvander@371
    54
	{
dvander@371
    55
	public:
dvander@371
    56
		/**
dvander@371
    57
		 * @brief Returns the argument count such that arguments 
dvander@371
    58
		 * 1 to N are valid arguments, and 0 is the command name.
dvander@371
    59
		 *
dvander@371
    60
		 * @return					Argument count.
dvander@371
    61
		 */
dvander@371
    62
		virtual unsigned int GetArgCount() =0;
dvander@371
    63
dvander@371
    64
		/**
dvander@371
    65
		 * @brief Returns the string of an argument number.
dvander@371
    66
		 *
dvander@371
    67
		 * @param num				Argument number.
dvander@371
    68
		 * @return					Argument text.
dvander@371
    69
		 */
dvander@371
    70
		virtual const char *GetArg(unsigned int num) =0;
dvander@371
    71
dvander@371
    72
		/**
dvander@371
    73
		 * @brief Returns the entire command argument string.
dvander@371
    74
		 *
dvander@371
    75
		 * @return					Argument string.
dvander@371
    76
		 */
dvander@371
    77
		virtual const char *GetArgString() =0;
dvander@371
    78
	};
dvander@371
    79
dvander@371
    80
	class IMetamodSourceProvider
dvander@371
    81
	{
dvander@371
    82
	public:
dvander@371
    83
		/**
dvander@371
    84
		 * @brief Returns whether source engine build is compatible.
dvander@371
    85
		 *
dvander@371
    86
		 * @param build				Source engine build.
dvander@371
    87
		 * @return					True if compatible, false otherwise.
dvander@371
    88
		 */
dvander@371
    89
		virtual bool IsSourceEngineBuildCompatible(int build) =0;
dvander@371
    90
dvander@371
    91
		/**
dvander@371
    92
		 * @brief Retrieves hook information for each callback.  Each hook 
dvander@371
    93
		 * must be implemented.
dvander@371
    94
		 *
dvander@371
    95
		 * @param hook				Hook information to provide.
dvander@371
    96
		 * @param pInfo				Non-NULL pointer to fill with information 
dvander@371
    97
		 * 							about the hook's virtual location.
dvander@371
    98
		 * @return					True if supported, false to fail, which 
dvander@371
    99
		 * 							will cause Metamod:Source to fail.
dvander@371
   100
		 */
dvander@371
   101
		virtual bool GetHookInfo(ProvidedHooks hook, SourceHook::MemFuncInfo *pInfo) =0;
dvander@371
   102
dvander@371
   103
		/**
dvander@371
   104
		 * @brief Logs a message via IVEngineServer::LogPrint.
dvander@371
   105
		 * 
dvander@371
   106
		 * @param buffer			Buffer to print.
dvander@371
   107
		 * @return					True on success, false if not supported, 
dvander@371
   108
		 * 							or IVEngineServer is not yet known.
dvander@371
   109
		 */
dvander@371
   110
		virtual bool LogMessage(const char *buffer) =0;
dvander@371
   111
dvander@371
   112
		/**
dvander@371
   113
		 * @brief Returns the command line value of a parameter.  If ICvar 
dvander@371
   114
		 * is not yet loaded, this uses an equivalent function.
dvander@371
   115
		 *
dvander@371
   116
		 * @param key				Parameter to look up.
dvander@371
   117
		 * @param val				Default string to return if none found.
dvander@371
   118
		 * @return					Parameter value.
dvander@371
   119
		 */
dvander@371
   120
		virtual const char *GetCommandLineValue(const char *key, const char *defval) =0;
dvander@371
   121
dvander@371
   122
		/**
dvander@371
   123
		 * @brief Prints a string to the remote server console. 
dvander@371
   124
		 * 
dvander@371
   125
		 * Note: new lines are not appended.
dvander@371
   126
		 *
dvander@371
   127
		 * @param msg			 	Message string.
dvander@371
   128
		 */
dvander@371
   129
		virtual void ConsolePrint(const char *msg) =0;
dvander@371
   130
dvander@371
   131
		/**
dvander@371
   132
		 * @brief Returns whether remote printing is available.
dvander@371
   133
		 *
dvander@371
   134
		 * @return					True if remote printing is available, 
dvander@371
   135
		 * 							otherwise returns false.
dvander@371
   136
		 */
dvander@371
   137
		virtual bool IsRemotePrintingAvailable() =0;
dvander@371
   138
dvander@371
   139
		/**
dvander@371
   140
		 * @brief Prints text in the specified client's console.
dvander@371
   141
		 *
dvander@371
   142
		 * @param client			Client edict pointer.
dvander@371
   143
		 * @param msg				Message string.
dvander@371
   144
		 */
dvander@371
   145
		virtual void ClientConsolePrint(edict_t *client, const char *msg) =0;
dvander@371
   146
dvander@371
   147
		/**
dvander@371
   148
		 * @brief Returns a server plugin helper for the given interface 
dvander@371
   149
		 * string.
dvander@371
   150
		 *
dvander@371
   151
		 * @param iface				Interface version
dvander@371
   152
		 * @return					IServerPluginCallbacks pointer.
dvander@371
   153
		 */
dvander@524
   154
		virtual IServerPluginCallbacks *GetVSPCallbacks(int version) =0;
dvander@371
   155
dvander@371
   156
		/**
dvander@371
   157
		 * @brief Halts the server with a fatal error message.
dvander@371
   158
		 *
dvander@371
   159
		 * No newline is appended.
dvander@371
   160
		 *
dvander@371
   161
		 * @param fmt				Formatted message string.
dvander@371
   162
		 * @param ...				Format parameters.
dvander@371
   163
		 */
dvander@371
   164
		virtual void DisplayError(const char *fmt, ...) =0;
dvander@371
   165
dvander@371
   166
		/**
dvander@371
   167
		 * @brief Sends the server a warning message.
dvander@371
   168
		 *
dvander@371
   169
		 * No newline is appended.
dvander@371
   170
		 *
dvander@371
   171
		 * @param fmt				Formatted message string.
dvander@371
   172
		 * @param ...				Format parameters.
dvander@371
   173
		 */
dvander@371
   174
		virtual void DisplayWarning(const char *fmt, ...) =0;
dvander@371
   175
dvander@371
   176
		/**
dvander@371
   177
		 * @brief Attempts to notify the provider of the gamedll version being 
dvander@371
   178
		 * used.
dvander@371
   179
		 *
dvander@371
   180
		 * @param iface				Interface string.
dvander@371
   181
		 * @return					Version number on success, 0 otherwise.
dvander@371
   182
		 */
dvander@371
   183
		virtual int TryServerGameDLL(const char *iface) =0;
dvander@371
   184
dvander@371
   185
		/**
dvander@371
   186
		 * @brief Notifies the provider that the DLLInit pre-hook is almost done.
dvander@371
   187
		 */
dvander@481
   188
		virtual void Notify_DLLInit_Pre(CreateInterfaceFn engineFactory, CreateInterfaceFn serverFactory) =0;
dvander@371
   189
dvander@371
   190
		virtual void Notify_DLLShutdown_Pre() =0;
dvander@371
   191
dvander@371
   192
		/**
dvander@371
   193
		 * @brief Wrapper around IVEngineServer::ServerCommand()
dvander@371
   194
		 *
dvander@371
   195
		 * @param cmd				Command string.
dvander@371
   196
		 */
dvander@371
   197
		virtual void ServerCommand(const char *cmd) =0;
dvander@371
   198
dvander@371
   199
		/**
dvander@371
   200
		 * @brief Creates a ConVar pointer.
dvander@371
   201
		 *
dvander@371
   202
		 * @param name				ConVar name.
dvander@371
   203
		 * @param defval			Default value string.
dvander@371
   204
		 * @param flags				ConVar flags.
dvander@371
   205
		 * @param help				Help text.
dvander@371
   206
		 * @return					ConVar pointer.
dvander@371
   207
		 */
dvander@371
   208
		virtual ConVar *CreateConVar(const char *name, 
dvander@371
   209
			const char *defval, 
dvander@371
   210
			const char *help,
dvander@371
   211
			int flags) =0;
dvander@371
   212
dvander@371
   213
		/**
dvander@371
   214
		 * @brief Returns the string value of a ConVar.
dvander@371
   215
		 *
dvander@371
   216
		 * @param convar			ConVar pointer.
dvander@371
   217
		 * @return					String value.
dvander@371
   218
		 */
dvander@371
   219
		virtual const char *GetConVarString(ConVar *convar) =0;
dvander@371
   220
dvander@371
   221
		/**
dvander@485
   222
		 * @brief Sets a ConVar string.
dvander@485
   223
		 *
dvander@485
   224
		 * @param convar			ConVar pointer.
dvander@485
   225
		 * @param str				String pointer.
dvander@485
   226
		 */
dvander@485
   227
		virtual void SetConVarString(ConVar *convar, const char *str) =0;
dvander@485
   228
dvander@485
   229
		/**
dvander@371
   230
		 * @brief Retrieves the game description.
dvander@371
   231
		 *
dvander@371
   232
		 * @return					Game description.
dvander@371
   233
		 */
dvander@371
   234
		virtual const char *GetGameDescription() =0;
dvander@371
   235
dvander@371
   236
		/**
dvander@371
   237
		 * @brief Returns the ConCommandBase accessor.
dvander@371
   238
		 *
dvander@371
   239
		 * @return				An IConCommandBaseAccessor pointer.
dvander@371
   240
		 */
dvander@371
   241
		virtual IConCommandBaseAccessor *GetConCommandBaseAccessor() =0;
dvander@371
   242
dvander@371
   243
		/**
dvander@371
   244
		 * @brief Registers a ConCommandBase.
dvander@371
   245
		 *
dvander@371
   246
		 * @param pCommand		ConCommandBase to register.
dvander@371
   247
		 * @return				True if successful, false otherwise.
dvander@371
   248
		 */
dvander@371
   249
		virtual bool RegisterConCommandBase(ConCommandBase *pCommand) =0;
dvander@371
   250
dvander@371
   251
		/**
dvander@371
   252
		 * @brief Unregisters a ConCommandBase.
dvander@371
   253
		 *
dvander@371
   254
		 * @param pCommand		ConCommandBase to unlink.
dvander@371
   255
		 */
dvander@371
   256
		virtual void UnregisterConCommandBase(ConCommandBase *pCommand) =0;
dvander@371
   257
dvander@371
   258
		/**
dvander@371
   259
		 * @brief Returns whether a ConCommandBase is a command or not.
dvander@371
   260
		 *
dvander@371
   261
		 * @param pCommand		ConCommandBase pointer.
dvander@371
   262
		 * @return				True if a command, false otherwise.
dvander@371
   263
		 */
dvander@371
   264
		virtual bool IsConCommandBaseACommand(ConCommandBase *pCommand) =0;
dvander@371
   265
dvander@371
   266
		/**
dvander@371
   267
		 * @brief Returns the number of user messages in the GameDLL.
dvander@371
   268
		 *
dvander@371
   269
		 * @return				Number of user messages, or -1 if SourceMM has 
dvander@371
   270
		 *						failed to get user message list.
dvander@371
   271
		 */
dvander@371
   272
		virtual int GetUserMessageCount() =0;
dvander@371
   273
dvander@371
   274
		/**
dvander@371
   275
		 * @brief Returns the index of the specified user message.
dvander@371
   276
		 *
dvander@371
   277
		 * @param name			User message name.
dvander@371
   278
		 * @param size			Optional pointer to store size of user message.
dvander@371
   279
		 * @return				Message index, or -1 on failure.
dvander@371
   280
		 */
dvander@371
   281
		virtual int FindUserMessage(const char *name, int *size=NULL) =0;
dvander@371
   282
dvander@371
   283
		/**
dvander@371
   284
		 * @brief Returns the name of the specified user message.
dvander@371
   285
		 *
dvander@371
   286
		 * @param index			User message index.
dvander@371
   287
		 * @param size			Optional pointer to store size of user message.
dvander@371
   288
		 * @return				Message name, or NULL on failure.
dvander@371
   289
		 */
dvander@371
   290
		virtual const char *GetUserMessage(int index, int *size=NULL) =0;
dvander@408
   291
dvander@408
   292
		/**
dvander@408
   293
		 * @brief Returns the Source Engine build.
dvander@408
   294
		 *
dvander@408
   295
		 * @param game			Game folder.
dvander@408
   296
		 * @return				SOURCE_ENGINE constant.
dvander@408
   297
		 */
dvander@408
   298
		virtual int DetermineSourceEngine(const char *game) =0;
dvander@481
   299
dvander@481
   300
		/**
dvander@481
   301
		 * @brief Returns if the provider has loaded itself through an 
dvander@481
   302
		 * alternate means (that is, not through gameinfo.txt.
dvander@481
   303
		 *
dvander@481
   304
		 * @return				True if loaded, false otherwise.
dvander@481
   305
		 */
dvander@481
   306
		virtual bool IsAlternatelyLoaded() =0;
dvander@485
   307
dvander@485
   308
		/**
dvander@485
   309
		 * @brief Processes a VDF plugin file.
dvander@485
   310
		 *
dvander@485
   311
		 */
dvander@485
   312
		virtual bool ProcessVDF(const char *file, char path[], size_t path_len, char alias[], size_t alias_len) =0;
dvander@371
   313
	};
dvander@371
   314
};
dvander@371
   315
dvander@371
   316
extern PluginId g_PLID;
dvander@371
   317
extern SourceHook::ISourceHook *g_SHPtr;
dvander@371
   318
extern SourceMM::IMetamodSourceProvider *provider;
dvander@485
   319
extern SourceMM::ISmmAPI *g_pMetamod;
dvander@371
   320
dvander@371
   321
#endif //_INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@371
   322