core-legacy/sourcemm.h
author Scott Ehlert <ds@alliedmods.net>
Sat Nov 14 00:49:35 2009 -0600 (2009-11-14)
changeset 680 39d0803bdb6e
parent 666 acab40e6dbd7
child 683 b507295429f9
permissions -rw-r--r--
Fixed issue with vsnprintf macro being defined under MSVC 9/2008 (bug 3887, r=dvander).
dvander@541
     1
/* ======== SourceMM ========
dvander@541
     2
 * Copyright (C) 2004-2008 Metamod:Source Development Team
dvander@541
     3
 * No warranties of any kind
dvander@541
     4
 *
dvander@541
     5
 * License: zlib/libpng
dvander@541
     6
 *
dvander@541
     7
 * Author(s): David "BAILOPAN" Anderson
dvander@541
     8
 * ============================
dvander@541
     9
 */
dvander@541
    10
dvander@541
    11
#ifndef _INCLUDE_SOURCEMM_H
dvander@541
    12
#define _INCLUDE_SOURCEMM_H
dvander@541
    13
dvander@541
    14
/**
dvander@541
    15
 * @brief SourceMM main functionality for GameDLL interception
dvander@541
    16
 * @file sourcemm.h
dvander@541
    17
 */
dvander@541
    18
dvander@541
    19
#include <string>
dvander@541
    20
#include <interface.h>
dvander@541
    21
#include <eiface.h>
dvander@541
    22
#include <sourcehook/sourcehook_impl.h>
dvander@541
    23
#include <sourcehook/sourcehook.h>
dvander@541
    24
#include "ISmmAPI.h"
dvander@541
    25
#include "CPlugin.h"
dvander@541
    26
#include "oslink.h"
dvander@558
    27
#include "version.h"
dvander@580
    28
#include "loader_bridge.h"
dvander@541
    29
dvander@541
    30
/**
dvander@541
    31
 * Versioning
dvander@541
    32
 *   increase api_major when API breaks
dvander@541
    33
 *   increase api_minor when new functions are added (non-breaking)
dvander@541
    34
 */
dvander@541
    35
#define		SOURCEMM_VERSION	SVN_FILE_VERSION_STRING
dvander@541
    36
#define		SOURCEMM_DATE		__DATE__
dvander@541
    37
#define		SM_VERS_API_MAJOR	1		//increase this on a breaking change
dvander@541
    38
#define		SM_VERS_API_MINOR	5		//increase this on a non-breaking API change
dvander@541
    39
dvander@541
    40
//We need a good CServerGameDLL version to work properly.  We support these inclusively.
dvander@541
    41
#define	MIN_GAMEDLL_VERSION	3
dvander@541
    42
#define	MAX_GAMEDLL_VERSION	8
dvander@541
    43
dvander@541
    44
dvander@583
    45
void *ServerFactory(const char *name, int *code);
dvander@541
    46
void *EngineFactory(const char *name, int *code);
dvander@541
    47
void *PhysicsFactory(const char *name, int *code);
dvander@541
    48
void *FileSystemFactory(const char *name, int *code);
dvander@541
    49
ds@601
    50
/** @brief Loads all plugins found from the mm_pluginsfile file and from VDFs in mm_basedir */
ds@601
    51
int LoadPlugins(const char *filepath, const char *vdfdir);
dvander@541
    52
dvander@541
    53
/** @brief Logs a message to the standard log file */
dvander@541
    54
void LogMessage(const char *msg, ...);
dvander@541
    55
dvander@541
    56
/** @brief Stores information about the GameDLL */
dvander@541
    57
struct GameDllInfo
dvander@541
    58
{
dvander@541
    59
	bool loaded;
dvander@541
    60
	CreateInterfaceFn factory;
dvander@541
    61
	IServerGameDLL *pGameDLL;
dvander@541
    62
	IServerGameClients *pGameClients;
dvander@541
    63
};
dvander@541
    64
dvander@541
    65
/** @brief Stores information about the HL2 Engine pointers */
dvander@541
    66
struct EngineInfo
dvander@541
    67
{
dvander@541
    68
	EngineInfo() : loaded(false), original(false),
dvander@541
    69
		engineFactory(NULL), physicsFactory(NULL), fileSystemFactory(NULL),
dvander@541
    70
		pGlobals(NULL), icvar(NULL), engine(NULL)
dvander@541
    71
	{ };
dvander@541
    72
	bool loaded;
dvander@541
    73
	bool original;
dvander@541
    74
	CreateInterfaceFn engineFactory;
dvander@541
    75
	CreateInterfaceFn physicsFactory;
dvander@541
    76
	CreateInterfaceFn fileSystemFactory;
dvander@541
    77
	CGlobalVars *pGlobals;
dvander@541
    78
	ICvar *icvar;
dvander@541
    79
	IVEngineServer *engine;
dvander@541
    80
};
dvander@541
    81
dvander@541
    82
bool AlternatelyLoadMetamod(CreateInterfaceFn ifaceFactory, CreateInterfaceFn serverFactory);
dvander@541
    83
dvander@548
    84
extern IServerPluginCallbacks *g_pRealVspCallbacks;
dvander@548
    85
extern bool g_bIsBridgedAsVsp;
dvander@548
    86
dvander@541
    87
/** @brief Global variable for GameDLL info */
dvander@541
    88
extern GameDllInfo g_GameDll;
dvander@541
    89
dvander@541
    90
/** @brief Global variable for Engine info */
dvander@541
    91
extern EngineInfo g_Engine;
dvander@541
    92
dvander@541
    93
/** @brief Global singleton for SourceHook */
dvander@541
    94
extern SourceHook::CSourceHookImpl g_SourceHook;
dvander@541
    95
dvander@541
    96
/** @brief Mod path (important!)*/
dvander@541
    97
extern SourceHook::String g_ModPath;
dvander@541
    98
dvander@541
    99
/** @brief Global variable for SourceHook macros */
dvander@541
   100
extern SourceHook::ISourceHook *g_SHPtr;
dvander@541
   101
dvander@541
   102
/** @brief We have our own internal plugin id... */
dvander@541
   103
extern PluginId g_PLID;
dvander@541
   104
dvander@541
   105
/** @brief ServerGameDLL version that is currently loaded */
dvander@541
   106
extern int g_GameDllVersion;
dvander@541
   107
dvander@580
   108
extern bool g_bGameInit;
dvander@541
   109
extern bool g_bLevelChanged;
dvander@541
   110
dvander@666
   111
extern unsigned int g_vsp_version;
dvander@666
   112
dvander@541
   113
void UnloadMetamod(bool shutting_down);
dvander@541
   114
dvander@580
   115
void LoadAsGameDLL(const gamedll_bridge_info *info);
dvander@580
   116
dvander@541
   117
#endif //_INCLUDE_SOURCEMM_H
dvander@580
   118