core/metamod.h
author Nicholas Hastings <skamonkey@gmail.com>
Sun Mar 23 23:37:46 2014 -0400 (2014-03-23)
changeset 909 57797db1d513
parent 887 e30d4a37f5e5
permissions -rw-r--r--
Add support for Contagion (bug 6006).
dvander@371
     1
/**
ds@683
     2
 * vim: set ts=4 sw=4 tw=99 noet :
dvander@371
     3
 * ======================================================
dvander@371
     4
 * Metamod:Source
ds@714
     5
 * Copyright (C) 2004-2010 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_SOURCEMM_H
dvander@371
    27
#define _INCLUDE_SOURCEMM_H
dvander@371
    28
dvander@371
    29
/**
dvander@371
    30
 * @brief SourceMM main functionality for GameDLL interception
dvander@371
    31
 * @file sourcemm.h
dvander@371
    32
 */
dvander@371
    33
dvander@371
    34
#include <interface.h>
dvander@371
    35
#include <eiface.h>
dvander@371
    36
#include <sourcehook/sourcehook_impl.h>
pavolmarko@480
    37
#include <sourcehook/sourcehook_hookmangen.h>
dvander@371
    38
#include <sourcehook/sourcehook.h>
dvander@396
    39
#include <ISmmPlugin.h>
dvander@371
    40
#include "metamod_provider.h"
dvander@371
    41
dvander@371
    42
using namespace SourceMM;
dvander@371
    43
dvander@371
    44
/**
dvander@371
    45
 * Versioning
dvander@371
    46
 *   increase api_major when API breaks
dvander@371
    47
 *   increase api_minor when new functions are added (non-breaking)
dvander@371
    48
 */
dvander@371
    49
#define SOURCEMM_VERSION	SVN_FILE_VERSION_STRING
dvander@371
    50
#define SOURCEMM_DATE		__DATE__
dvander@400
    51
#define METAMOD_API_MAJOR	2		/* increase this on a breaking change */
dvander@400
    52
#define METAMOD_API_MINOR	0		/* increase this on a non-breaking API change */
dvander@371
    53
dvander@371
    54
class MetamodSource : public ISmmAPI
dvander@371
    55
{
dvander@371
    56
public:
dvander@371
    57
	void LogMsg(ISmmPlugin *pl, const char *msg, ...);
dvander@375
    58
	CreateInterfaceFn GetEngineFactory(bool syn=true);
dvander@375
    59
	CreateInterfaceFn GetPhysicsFactory(bool syn=true);
dvander@375
    60
	CreateInterfaceFn GetFileSystemFactory(bool syn=true);
dvander@375
    61
	CreateInterfaceFn GetServerFactory(bool syn=true);
dvander@375
    62
	CGlobalVars *GetCGlobals();
dvander@371
    63
	void SetLastMetaReturn(META_RES res);
dvander@371
    64
	META_RES GetLastMetaReturn();
dvander@371
    65
	IConCommandBaseAccessor *GetCvarBaseAccessor();
dvander@375
    66
	bool RegisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand);
dvander@375
    67
	void UnregisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand);
dvander@371
    68
	void ConPrint(const char *str);
dvander@371
    69
	void ConPrintf(const char *fmt, ...);
dvander@371
    70
	bool RemotePrintingAvailable();
dvander@371
    71
	void GetApiVersions(int &major, int &minor, int &plvers, int &plmin);
dvander@371
    72
	void GetShVersions(int &shvers, int &shimpl);
dvander@371
    73
	void AddListener(ISmmPlugin *plugin, IMetamodListener *pListener);
dvander@371
    74
	void *MetaFactory(const char *iface, int *ret, PluginId *id);
dvander@371
    75
	int FormatIface(char iface[], unsigned int maxlength);
dvander@371
    76
	void *InterfaceSearch(CreateInterfaceFn fn, const char *iface, int max, int *ret);
dvander@371
    77
	const char *GetBaseDir();
dvander@407
    78
	size_t PathFormat(char *buffer, size_t len, const char *fmt, ...);
skamonkey@839
    79
#if SOURCE_ENGINE == SE_DOTA
skamonkey@839
    80
	// Shim
skamonkey@839
    81
	void ClientConPrintf(int clientIndex, const char *fmt, ...);
skamonkey@839
    82
#endif
dvander@371
    83
	void ClientConPrintf(edict_t *client, const char *fmt, ...);
dvander@371
    84
	void *VInterfaceMatch(CreateInterfaceFn fn, const char *iface, int min=-1);
dvander@371
    85
	void EnableVSPListener();
dvander@371
    86
	int GetGameDLLVersion();
dvander@371
    87
	int GetUserMessageCount();
dvander@371
    88
	int FindUserMessage(const char *name, int *size=NULL);
dvander@371
    89
	const char *GetUserMessage(int index, int *size=NULL);
dvander@371
    90
	int GetVSPVersion();
dvander@371
    91
	int GetSourceEngineBuild();
dvander@371
    92
	IServerPluginCallbacks *GetVSPInfo(int *pVersion);
dvander@376
    93
	size_t Format(char *buffer, size_t maxlength, const char *format, ...);
dvander@376
    94
	size_t FormatArgs(char *buffer, size_t maxlength, const char *format, va_list ap);
dvander@371
    95
public:
dvander@481
    96
	bool IsLoadedAsGameDLL();
dvander@371
    97
	const char *GetGameBinaryPath();
dvander@371
    98
	const char *GetPluginsFile();
ds@601
    99
	const char *GetVDFDir();
dvander@371
   100
	void UnregisterConCommandBase(PluginId id, ConCommandBase *pCommand);
dvander@592
   101
	void NotifyVSPListening(IServerPluginCallbacks *callbacks, int version);
dvander@589
   102
	void SetGameDLLInfo(CreateInterfaceFn serverFactory, int version, bool loaded);
ds@683
   103
	void SetVSPListener(const char *path);
ds@714
   104
	size_t GetFullPluginPath(const char *plugin, char *buffer, size_t len);
dvander@371
   105
};
dvander@371
   106
dvander@552
   107
bool
dvander@552
   108
mm_DetectGameInformation();
dvander@552
   109
dvander@552
   110
void
dvander@552
   111
mm_LogMessage(const char *msg, ...);
dvander@552
   112
dvander@552
   113
int
ds@601
   114
mm_LoadPlugins(const char *filepath, const char *vdfpath);
dvander@552
   115
dvander@552
   116
void
dvander@552
   117
mm_InitializeForLoad();
dvander@552
   118
dvander@552
   119
void
dvander@552
   120
mm_InitializeGlobals(CreateInterfaceFn engineFactory, 
dvander@552
   121
					 CreateInterfaceFn physicsFactory,
dvander@552
   122
					 CreateInterfaceFn filesystemFactory,
dvander@552
   123
					 CGlobalVars *pGlobals);
dvander@552
   124
void
dvander@552
   125
mm_StartupMetamod(bool is_vsp_load);
dvander@552
   126
dvander@552
   127
void
dvander@552
   128
mm_UnloadMetamod();
dvander@552
   129
dvander@552
   130
bool
dvander@552
   131
mm_IsVspBridged();
dvander@552
   132
dvander@552
   133
bool
dvander@552
   134
mm_IsVspLoadComplete();
dvander@371
   135
dvander@371
   136
extern MetamodSource g_Metamod;
dvander@392
   137
extern SourceHook::Impl::CSourceHookImpl g_SourceHook;
dvander@371
   138
dvander@371
   139
#endif //_INCLUDE_SOURCEMM_H
dvander@392
   140