core/metamod_provider.h
author Scott Ehlert <ds@alliedmods.net>
Sat May 22 00:45:44 2010 -0500 (2010-05-22)
changeset 716 6925fbd2b9fa
parent 683 b507295429f9
permissions -rw-r--r--
Added Mac OS X build support to stub/sample plugin makefiles (bug 4391, r=dvander).
dvander@371
     1
/**
ds@683
     2
 * vim: set ts=4 sw=4 tw=99 noet :
dvander@371
     3
 * ======================================================
dvander@371
     4
 * Metamod:Source
ds@683
     5
 * Copyright (C) 2004-2009 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
dvander@371
    26
#ifndef _INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@371
    27
#define _INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@371
    28
dvander@371
    29
namespace SourceMM
dvander@371
    30
{
dvander@371
    31
	enum
dvander@371
    32
	{
ds@520
    33
		ConVarFlag_None = 0,
ds@520
    34
		ConVarFlag_Notify = 1,
ds@520
    35
		ConVarFlag_SpOnly = 2,
dvander@371
    36
	};
dvander@371
    37
dvander@371
    38
	enum ProvidedHooks
dvander@371
    39
	{
dvander@371
    40
		ProvidedHook_LevelInit = 0,			/**< IServerGameDLL::LevelInit */
dvander@371
    41
		ProvidedHook_LevelShutdown = 1,		/**< IServerGameDLL::LevelShutdown */
dvander@371
    42
		ProvidedHook_GameInit = 4,			/**< IServerGameDLL::GameInit */
dvander@371
    43
	};
dvander@371
    44
dvander@371
    45
	/**
dvander@371
    46
	 * @brief Abstracts command information, since the new engine fixes the 
dvander@371
    47
	 * re-entrancy problems in the tokenization system.
dvander@371
    48
	 */
dvander@371
    49
	class IMetamodSourceCommandInfo
dvander@371
    50
	{
dvander@371
    51
	public:
dvander@371
    52
		/**
dvander@371
    53
		 * @brief Returns the argument count such that arguments 
dvander@371
    54
		 * 1 to N are valid arguments, and 0 is the command name.
dvander@371
    55
		 *
dvander@371
    56
		 * @return					Argument count.
dvander@371
    57
		 */
dvander@371
    58
		virtual unsigned int GetArgCount() =0;
dvander@371
    59
dvander@371
    60
		/**
dvander@371
    61
		 * @brief Returns the string of an argument number.
dvander@371
    62
		 *
dvander@371
    63
		 * @param num				Argument number.
dvander@371
    64
		 * @return					Argument text.
dvander@371
    65
		 */
dvander@371
    66
		virtual const char *GetArg(unsigned int num) =0;
dvander@371
    67
dvander@371
    68
		/**
dvander@371
    69
		 * @brief Returns the entire command argument string.
dvander@371
    70
		 *
dvander@371
    71
		 * @return					Argument string.
dvander@371
    72
		 */
dvander@371
    73
		virtual const char *GetArgString() =0;
dvander@371
    74
	};
dvander@371
    75
dvander@371
    76
	class IMetamodSourceProvider
dvander@371
    77
	{
dvander@371
    78
	public:
dvander@371
    79
		/**
dvander@371
    80
		 * @brief Returns whether source engine build is compatible.
dvander@371
    81
		 *
dvander@371
    82
		 * @param build				Source engine build.
dvander@371
    83
		 * @return					True if compatible, false otherwise.
dvander@371
    84
		 */
dvander@371
    85
		virtual bool IsSourceEngineBuildCompatible(int build) =0;
dvander@371
    86
dvander@371
    87
		/**
dvander@371
    88
		 * @brief Retrieves hook information for each callback.  Each hook 
dvander@371
    89
		 * must be implemented.
dvander@371
    90
		 *
dvander@371
    91
		 * @param hook				Hook information to provide.
dvander@371
    92
		 * @param pInfo				Non-NULL pointer to fill with information 
dvander@371
    93
		 * 							about the hook's virtual location.
dvander@371
    94
		 * @return					True if supported, false to fail, which 
dvander@371
    95
		 * 							will cause Metamod:Source to fail.
dvander@371
    96
		 */
dvander@371
    97
		virtual bool GetHookInfo(ProvidedHooks hook, SourceHook::MemFuncInfo *pInfo) =0;
dvander@371
    98
dvander@371
    99
		/**
dvander@371
   100
		 * @brief Logs a message via IVEngineServer::LogPrint.
dvander@371
   101
		 * 
dvander@371
   102
		 * @param buffer			Buffer to print.
dvander@371
   103
		 * @return					True on success, false if not supported, 
dvander@371
   104
		 * 							or IVEngineServer is not yet known.
dvander@371
   105
		 */
dvander@371
   106
		virtual bool LogMessage(const char *buffer) =0;
dvander@371
   107
dvander@371
   108
		/**
dvander@371
   109
		 * @brief Returns the command line value of a parameter.  If ICvar 
dvander@371
   110
		 * is not yet loaded, this uses an equivalent function.
dvander@371
   111
		 *
dvander@371
   112
		 * @param key				Parameter to look up.
dvander@371
   113
		 * @param val				Default string to return if none found.
dvander@371
   114
		 * @return					Parameter value.
dvander@371
   115
		 */
ds@637
   116
		virtual const char *GetCommandLineValue(const char *key, const char *defval=NULL) =0;
dvander@371
   117
dvander@371
   118
		/**
dvander@371
   119
		 * @brief Prints a string to the remote server console. 
dvander@371
   120
		 * 
dvander@371
   121
		 * Note: new lines are not appended.
dvander@371
   122
		 *
dvander@371
   123
		 * @param msg			 	Message string.
dvander@371
   124
		 */
dvander@371
   125
		virtual void ConsolePrint(const char *msg) =0;
dvander@371
   126
dvander@371
   127
		/**
dvander@371
   128
		 * @brief Returns whether remote printing is available.
dvander@371
   129
		 *
dvander@371
   130
		 * @return					True if remote printing is available, 
dvander@371
   131
		 * 							otherwise returns false.
dvander@371
   132
		 */
dvander@371
   133
		virtual bool IsRemotePrintingAvailable() =0;
dvander@371
   134
dvander@371
   135
		/**
dvander@371
   136
		 * @brief Prints text in the specified client's console.
dvander@371
   137
		 *
dvander@371
   138
		 * @param client			Client edict pointer.
dvander@371
   139
		 * @param msg				Message string.
dvander@371
   140
		 */
dvander@371
   141
		virtual void ClientConsolePrint(edict_t *client, const char *msg) =0;
dvander@371
   142
dvander@371
   143
		/**
dvander@371
   144
		 * @brief Halts the server with a fatal error message.
dvander@371
   145
		 *
dvander@371
   146
		 * No newline is appended.
dvander@371
   147
		 *
dvander@371
   148
		 * @param fmt				Formatted message string.
dvander@371
   149
		 * @param ...				Format parameters.
dvander@371
   150
		 */
dvander@371
   151
		virtual void DisplayError(const char *fmt, ...) =0;
dvander@371
   152
dvander@371
   153
		/**
dvander@371
   154
		 * @brief Sends the server a warning message.
dvander@371
   155
		 *
dvander@371
   156
		 * No newline is appended.
dvander@371
   157
		 *
dvander@371
   158
		 * @param fmt				Formatted message string.
dvander@371
   159
		 * @param ...				Format parameters.
dvander@371
   160
		 */
dvander@371
   161
		virtual void DisplayWarning(const char *fmt, ...) =0;
dvander@371
   162
dvander@371
   163
		/**
dvander@371
   164
		 * @brief Attempts to notify the provider of the gamedll version being 
dvander@371
   165
		 * used.
dvander@371
   166
		 *
dvander@371
   167
		 * @param iface				Interface string.
dvander@371
   168
		 * @return					Version number on success, 0 otherwise.
dvander@371
   169
		 */
dvander@371
   170
		virtual int TryServerGameDLL(const char *iface) =0;
dvander@371
   171
dvander@371
   172
		/**
dvander@371
   173
		 * @brief Notifies the provider that the DLLInit pre-hook is almost done.
dvander@371
   174
		 */
dvander@481
   175
		virtual void Notify_DLLInit_Pre(CreateInterfaceFn engineFactory, CreateInterfaceFn serverFactory) =0;
dvander@371
   176
dvander@371
   177
		virtual void Notify_DLLShutdown_Pre() =0;
dvander@371
   178
dvander@371
   179
		/**
dvander@371
   180
		 * @brief Wrapper around IVEngineServer::ServerCommand()
dvander@371
   181
		 *
dvander@371
   182
		 * @param cmd				Command string.
dvander@371
   183
		 */
dvander@371
   184
		virtual void ServerCommand(const char *cmd) =0;
dvander@371
   185
dvander@371
   186
		/**
dvander@371
   187
		 * @brief Creates a ConVar pointer.
dvander@371
   188
		 *
dvander@371
   189
		 * @param name				ConVar name.
dvander@371
   190
		 * @param defval			Default value string.
dvander@371
   191
		 * @param flags				ConVar flags.
dvander@371
   192
		 * @param help				Help text.
dvander@371
   193
		 * @return					ConVar pointer.
dvander@371
   194
		 */
dvander@371
   195
		virtual ConVar *CreateConVar(const char *name, 
dvander@371
   196
			const char *defval, 
dvander@371
   197
			const char *help,
dvander@371
   198
			int flags) =0;
dvander@371
   199
dvander@371
   200
		/**
dvander@371
   201
		 * @brief Returns the string value of a ConVar.
dvander@371
   202
		 *
dvander@371
   203
		 * @param convar			ConVar pointer.
dvander@371
   204
		 * @return					String value.
dvander@371
   205
		 */
dvander@371
   206
		virtual const char *GetConVarString(ConVar *convar) =0;
dvander@371
   207
dvander@371
   208
		/**
dvander@485
   209
		 * @brief Sets a ConVar string.
dvander@485
   210
		 *
dvander@485
   211
		 * @param convar			ConVar pointer.
dvander@485
   212
		 * @param str				String pointer.
dvander@485
   213
		 */
dvander@485
   214
		virtual void SetConVarString(ConVar *convar, const char *str) =0;
dvander@485
   215
dvander@485
   216
		/**
dvander@371
   217
		 * @brief Retrieves the game description.
dvander@371
   218
		 *
dvander@371
   219
		 * @return					Game description.
dvander@371
   220
		 */
dvander@371
   221
		virtual const char *GetGameDescription() =0;
dvander@371
   222
dvander@371
   223
		/**
dvander@371
   224
		 * @brief Returns the ConCommandBase accessor.
dvander@371
   225
		 *
dvander@371
   226
		 * @return				An IConCommandBaseAccessor pointer.
dvander@371
   227
		 */
dvander@371
   228
		virtual IConCommandBaseAccessor *GetConCommandBaseAccessor() =0;
dvander@371
   229
dvander@371
   230
		/**
dvander@371
   231
		 * @brief Registers a ConCommandBase.
dvander@371
   232
		 *
dvander@371
   233
		 * @param pCommand		ConCommandBase to register.
dvander@371
   234
		 * @return				True if successful, false otherwise.
dvander@371
   235
		 */
dvander@371
   236
		virtual bool RegisterConCommandBase(ConCommandBase *pCommand) =0;
dvander@371
   237
dvander@371
   238
		/**
dvander@371
   239
		 * @brief Unregisters a ConCommandBase.
dvander@371
   240
		 *
dvander@371
   241
		 * @param pCommand		ConCommandBase to unlink.
dvander@371
   242
		 */
dvander@371
   243
		virtual void UnregisterConCommandBase(ConCommandBase *pCommand) =0;
dvander@371
   244
dvander@371
   245
		/**
dvander@371
   246
		 * @brief Returns whether a ConCommandBase is a command or not.
dvander@371
   247
		 *
dvander@371
   248
		 * @param pCommand		ConCommandBase pointer.
dvander@371
   249
		 * @return				True if a command, false otherwise.
dvander@371
   250
		 */
dvander@371
   251
		virtual bool IsConCommandBaseACommand(ConCommandBase *pCommand) =0;
dvander@371
   252
dvander@371
   253
		/**
dvander@371
   254
		 * @brief Returns the number of user messages in the GameDLL.
dvander@371
   255
		 *
dvander@371
   256
		 * @return				Number of user messages, or -1 if SourceMM has 
dvander@371
   257
		 *						failed to get user message list.
dvander@371
   258
		 */
dvander@371
   259
		virtual int GetUserMessageCount() =0;
dvander@371
   260
dvander@371
   261
		/**
dvander@371
   262
		 * @brief Returns the index of the specified user message.
dvander@371
   263
		 *
dvander@371
   264
		 * @param name			User message name.
dvander@371
   265
		 * @param size			Optional pointer to store size of user message.
dvander@371
   266
		 * @return				Message index, or -1 on failure.
dvander@371
   267
		 */
dvander@371
   268
		virtual int FindUserMessage(const char *name, int *size=NULL) =0;
dvander@371
   269
dvander@371
   270
		/**
dvander@371
   271
		 * @brief Returns the name of the specified user message.
dvander@371
   272
		 *
dvander@371
   273
		 * @param index			User message index.
dvander@371
   274
		 * @param size			Optional pointer to store size of user message.
dvander@371
   275
		 * @return				Message name, or NULL on failure.
dvander@371
   276
		 */
dvander@371
   277
		virtual const char *GetUserMessage(int index, int *size=NULL) =0;
dvander@408
   278
dvander@408
   279
		/**
dvander@408
   280
		 * @brief Returns the Source Engine build.
dvander@408
   281
		 *
dvander@408
   282
		 * @param game			Game folder.
dvander@408
   283
		 * @return				SOURCE_ENGINE constant.
dvander@408
   284
		 */
dvander@408
   285
		virtual int DetermineSourceEngine(const char *game) =0;
dvander@481
   286
dvander@481
   287
		/**
dvander@485
   288
		 * @brief Processes a VDF plugin file.
dvander@485
   289
		 *
dvander@485
   290
		 */
dvander@485
   291
		virtual bool ProcessVDF(const char *file, char path[], size_t path_len, char alias[], size_t alias_len) =0;
dvander@371
   292
	};
dvander@371
   293
};
dvander@371
   294
dvander@371
   295
extern PluginId g_PLID;
dvander@371
   296
extern SourceHook::ISourceHook *g_SHPtr;
dvander@371
   297
extern SourceMM::IMetamodSourceProvider *provider;
dvander@485
   298
extern SourceMM::ISmmAPI *g_pMetamod;
dvander@371
   299
dvander@371
   300
#endif //_INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@371
   301