sourcemm/metamod_provider.h
author David Anderson <dvander@alliedmods.net>
Sat Sep 29 15:01:32 2007 +0000 (2007-09-29)
branchsourcemm-1.6.0
changeset 365 afdf36dee1a6
parent 359 9b3c625f3a83
child 367 fc76472b980f
permissions -rw-r--r--
- fixed shutdown crash
- fixed makefile for linux
dvander@353
     1
#ifndef _INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@353
     2
#define _INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@353
     3
dvander@353
     4
namespace SourceMM
dvander@353
     5
{
dvander@353
     6
	enum
dvander@353
     7
	{
dvander@353
     8
		ConVarFlag_None,
dvander@353
     9
		ConVarFlag_Notify,
dvander@353
    10
		ConVarFlag_Replicated,
dvander@353
    11
		ConVarFlag_SpOnly
dvander@353
    12
	};
dvander@353
    13
dvander@353
    14
	enum ProvidedHooks
dvander@353
    15
	{
dvander@353
    16
		ProvidedHook_LevelInit = 0,			/**< IServerGameDLL::LevelInit */
dvander@353
    17
		ProvidedHook_LevelShutdown = 1,		/**< IServerGameDLL::LevelShutdown */
dvander@353
    18
		ProvidedHook_DLLInit = 2,			/**< IServerGameDLL::DLLInit */
dvander@353
    19
		ProvidedHook_DLLShutdown = 3,		/**< IServerGameDLL::DLLShutdown */
dvander@353
    20
		ProvidedHook_GameInit = 4,			/**< IServerGameDLL::GameInit */
dvander@353
    21
	};
dvander@353
    22
dvander@353
    23
	/**
dvander@353
    24
	 * @brief Abstracts command information, since the new engine fixes the 
dvander@353
    25
	 * re-entrancy problems in the tokenization system.
dvander@353
    26
	 */
dvander@353
    27
	class IMetamodSourceCommandInfo
dvander@353
    28
	{
dvander@353
    29
	public:
dvander@353
    30
		/**
dvander@353
    31
		 * @brief Returns the argument count such that arguments 
dvander@353
    32
		 * 1 to N are valid arguments, and 0 is the command name.
dvander@353
    33
		 *
dvander@353
    34
		 * @return					Argument count.
dvander@353
    35
		 */
dvander@353
    36
		virtual unsigned int GetArgCount() =0;
dvander@353
    37
dvander@353
    38
		/**
dvander@353
    39
		 * @brief Returns the string of an argument number.
dvander@353
    40
		 *
dvander@353
    41
		 * @param num				Argument number.
dvander@353
    42
		 * @return					Argument text.
dvander@353
    43
		 */
dvander@353
    44
		virtual const char *GetArg(unsigned int num) =0;
dvander@353
    45
dvander@353
    46
		/**
dvander@353
    47
		 * @brief Returns the entire command argument string.
dvander@353
    48
		 *
dvander@353
    49
		 * @return					Argument string.
dvander@353
    50
		 */
dvander@353
    51
		virtual const char *GetArgString() =0;
dvander@353
    52
	};
dvander@353
    53
dvander@353
    54
	class IMetamodSourceProvider
dvander@353
    55
	{
dvander@353
    56
	public:
dvander@353
    57
		/**
dvander@353
    58
		 * @brief Returns whether source engine build is compatible.
dvander@353
    59
		 *
dvander@353
    60
		 * @param build				Source engine build.
dvander@353
    61
		 * @return					True if compatible, false otherwise.
dvander@353
    62
		 */
dvander@353
    63
		virtual bool IsSourceEngineBuildCompatible(int build) =0;
dvander@353
    64
dvander@353
    65
		/**
dvander@353
    66
		 * @brief Retrieves hook information for each callback.  Each hook 
dvander@353
    67
		 * must be implemented.
dvander@353
    68
		 *
dvander@353
    69
		 * @param hook				Hook information to provide.
dvander@353
    70
		 * @param pInfo				Non-NULL pointer to fill with information 
dvander@353
    71
		 * 							about the hook's virtual location.
dvander@353
    72
		 * @return					True if supported, false to fail, which 
dvander@353
    73
		 * 							will cause Metamod:Source to fail.
dvander@353
    74
		 */
dvander@353
    75
		virtual bool GetHookInfo(ProvidedHooks hook, SourceHook::MemFuncInfo *pInfo) =0;
dvander@353
    76
dvander@353
    77
		/**
dvander@353
    78
		 * @brief Logs a message via IVEngineServer::LogPrint.
dvander@353
    79
		 * 
dvander@353
    80
		 * @param buffer			Buffer to print.
dvander@353
    81
		 * @return					True on success, false if not supported, 
dvander@353
    82
		 * 							or IVEngineServer is not yet known.
dvander@353
    83
		 */
dvander@353
    84
		virtual bool LogMessage(const char *buffer) =0;
dvander@353
    85
dvander@353
    86
		/**
dvander@353
    87
		 * @brief Returns the command line value of a parameter.  If ICvar 
dvander@353
    88
		 * is not yet loaded, this uses an equivalent function.
dvander@353
    89
		 *
dvander@353
    90
		 * @param key				Parameter to look up.
dvander@353
    91
		 * @param val				Default string to return if none found.
dvander@353
    92
		 * @return					Parameter value.
dvander@353
    93
		 */
dvander@353
    94
		virtual const char *GetCommandLineValue(const char *key, const char *defval) =0;
dvander@353
    95
dvander@353
    96
		/**
dvander@353
    97
		 * @brief Prints a string to the remote server console. 
dvander@353
    98
		 * 
dvander@353
    99
		 * Note: new lines are not appended.
dvander@353
   100
		 *
dvander@353
   101
		 * @param msg			 	Message string.
dvander@353
   102
		 */
dvander@353
   103
		virtual void ConsolePrint(const char *msg) =0;
dvander@353
   104
dvander@353
   105
		/**
dvander@353
   106
		 * @brief Returns whether remote printing is available.
dvander@353
   107
		 *
dvander@353
   108
		 * @return					True if remote printing is available, 
dvander@353
   109
		 * 							otherwise returns false.
dvander@353
   110
		 */
dvander@353
   111
		virtual bool IsRemotePrintingAvailable() =0;
dvander@353
   112
dvander@353
   113
		/**
dvander@353
   114
		 * @brief Prints text in the specified client's console.
dvander@353
   115
		 *
dvander@353
   116
		 * @param client			Client edict pointer.
dvander@353
   117
		 * @param msg				Message string.
dvander@353
   118
		 */
dvander@353
   119
		virtual void ClientConsolePrint(edict_t *client, const char *msg) =0;
dvander@353
   120
dvander@353
   121
		/**
dvander@353
   122
		 * @brief Returns a server plugin helper for the given interface 
dvander@353
   123
		 * string.
dvander@353
   124
		 *
dvander@353
   125
		 * @param iface				Interface version
dvander@353
   126
		 * @return					IServerPluginCallbacks pointer.
dvander@353
   127
		 */
dvander@353
   128
		virtual IServerPluginCallbacks *GetVSPCallbacks(const char *iface) =0;
dvander@353
   129
dvander@353
   130
		/**
dvander@353
   131
		 * @brief Halts the server with a fatal error message.
dvander@353
   132
		 *
dvander@356
   133
		 * No newline is appended.
dvander@356
   134
		 *
dvander@353
   135
		 * @param fmt				Formatted message string.
dvander@353
   136
		 * @param ...				Format parameters.
dvander@353
   137
		 */
dvander@353
   138
		virtual void DisplayError(const char *fmt, ...) =0;
dvander@353
   139
dvander@353
   140
		/**
dvander@353
   141
		 * @brief Sends the server a warning message.
dvander@353
   142
		 *
dvander@356
   143
		 * No newline is appended.
dvander@356
   144
		 *
dvander@353
   145
		 * @param fmt				Formatted message string.
dvander@353
   146
		 * @param ...				Format parameters.
dvander@353
   147
		 */
dvander@353
   148
		virtual void DisplayWarning(const char *fmt, ...) =0;
dvander@353
   149
dvander@353
   150
		/**
dvander@353
   151
		 * @brief Attempts to notify the provider of the gamedll version being 
dvander@353
   152
		 * used.
dvander@353
   153
		 *
dvander@353
   154
		 * @param iface				Interface string.
dvander@353
   155
		 * @return					Version number on success, 0 otherwise.
dvander@353
   156
		 */
dvander@353
   157
		virtual int TryServerGameDLL(const char *iface) =0;
dvander@353
   158
dvander@353
   159
		/**
dvander@353
   160
		 * @brief Notifies the provider that the DLLInit pre-hook is almost done.
dvander@353
   161
		 */
dvander@359
   162
		virtual void Notify_DLLInit_Pre(void *gamedll,
dvander@359
   163
			CreateInterfaceFn engineFactory, 
dvander@359
   164
			CreateInterfaceFn serverFactory) =0;
dvander@353
   165
dvander@365
   166
		virtual void Notify_DLLShutdown_Pre() =0;
dvander@365
   167
dvander@353
   168
		/**
dvander@353
   169
		 * @brief Wrapper around IVEngineServer::ServerCommand()
dvander@353
   170
		 *
dvander@353
   171
		 * @param cmd				Command string.
dvander@353
   172
		 */
dvander@353
   173
		virtual void ServerCommand(const char *cmd) =0;
dvander@353
   174
dvander@353
   175
		/**
dvander@353
   176
		 * @brief Creates a ConVar pointer.
dvander@353
   177
		 *
dvander@353
   178
		 * @param name				ConVar name.
dvander@353
   179
		 * @param defval			Default value string.
dvander@353
   180
		 * @param flags				ConVar flags.
dvander@353
   181
		 * @param help				Help text.
dvander@353
   182
		 * @return					ConVar pointer.
dvander@353
   183
		 */
dvander@353
   184
		virtual ConVar *CreateConVar(const char *name, 
dvander@353
   185
			const char *defval, 
dvander@353
   186
			const char *help,
dvander@353
   187
			int flags) =0;
dvander@353
   188
dvander@353
   189
		/**
dvander@353
   190
		 * @brief Returns the string value of a ConVar.
dvander@353
   191
		 *
dvander@353
   192
		 * @param convar			ConVar pointer.
dvander@353
   193
		 * @return					String value.
dvander@353
   194
		 */
dvander@353
   195
		virtual const char *GetConVarString(ConVar *convar) =0;
dvander@353
   196
dvander@353
   197
		/**
dvander@353
   198
		 * @brief Retrieves the game description.
dvander@353
   199
		 *
dvander@353
   200
		 * @return					Game description.
dvander@353
   201
		 */
dvander@353
   202
		virtual const char *GetGameDescription() =0;
dvander@353
   203
dvander@353
   204
		/**
dvander@353
   205
		 * @brief Returns the ConCommandBase accessor.
dvander@353
   206
		 *
dvander@353
   207
		 * @return				An IConCommandBaseAccessor pointer.
dvander@353
   208
		 */
dvander@353
   209
		virtual IConCommandBaseAccessor *GetConCommandBaseAccessor() =0;
dvander@353
   210
dvander@353
   211
		/**
dvander@353
   212
		 * @brief Registers a ConCommandBase.
dvander@353
   213
		 *
dvander@353
   214
		 * @param pCommand		ConCommandBase to register.
dvander@353
   215
		 * @return				True if successful, false otherwise.
dvander@353
   216
		 */
dvander@353
   217
		virtual bool RegisterConCommandBase(ConCommandBase *pCommand) =0;
dvander@353
   218
dvander@353
   219
		/**
dvander@353
   220
		 * @brief Unregisters a ConCommandBase.
dvander@353
   221
		 *
dvander@353
   222
		 * @param pCommand		ConCommandBase to unlink.
dvander@353
   223
		 */
dvander@353
   224
		virtual void UnregisterConCommandBase(ConCommandBase *pCommand) =0;
dvander@353
   225
dvander@353
   226
		/**
dvander@353
   227
		 * @brief Returns whether a ConCommandBase is a command or not.
dvander@353
   228
		 *
dvander@353
   229
		 * @param pCommand		ConCommandBase pointer.
dvander@353
   230
		 * @return				True if a command, false otherwise.
dvander@353
   231
		 */
dvander@353
   232
		virtual bool IsConCommandBaseACommand(ConCommandBase *pCommand) =0;
dvander@353
   233
dvander@353
   234
		/**
dvander@353
   235
		 * @brief Returns the number of user messages in the GameDLL.
dvander@353
   236
		 *
dvander@353
   237
		 * @return				Number of user messages, or -1 if SourceMM has 
dvander@353
   238
		 *						failed to get user message list.
dvander@353
   239
		 */
dvander@353
   240
		virtual int GetUserMessageCount() =0;
dvander@353
   241
dvander@353
   242
		/**
dvander@353
   243
		 * @brief Returns the index of the specified user message.
dvander@353
   244
		 *
dvander@353
   245
		 * @param name			User message name.
dvander@353
   246
		 * @param size			Optional pointer to store size of user message.
dvander@353
   247
		 * @return				Message index, or -1 on failure.
dvander@353
   248
		 */
dvander@353
   249
		virtual int FindUserMessage(const char *name, int *size=NULL) =0;
dvander@353
   250
dvander@353
   251
		/**
dvander@353
   252
		 * @brief Returns the name of the specified user message.
dvander@353
   253
		 *
dvander@353
   254
		 * @param index			User message index.
dvander@353
   255
		 * @param size			Optional pointer to store size of user message.
dvander@353
   256
		 * @return				Message name, or NULL on failure.
dvander@353
   257
		 */
dvander@353
   258
		virtual const char *GetUserMessage(int index, int *size=NULL) =0;
dvander@353
   259
	};
dvander@353
   260
};
dvander@353
   261
dvander@359
   262
extern PluginId g_PLID;
dvander@359
   263
extern SourceHook::ISourceHook *g_SHPtr;
dvander@359
   264
extern SourceMM::IMetamodSourceProvider *provider;
dvander@359
   265
dvander@353
   266
#endif //_INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@353
   267