core-legacy/sourcemm.h
author David Anderson <dvander@alliedmods.net>
Sun Nov 23 21:22:04 2008 -0600 (2008-11-23)
changeset 580 783e91c5f445
parent 558 0ed2a4a6e31d
child 583 dbdc331492b6
permissions -rw-r--r--
Initial import of core-legacy as a gameinfo provider.
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@541
    27
#include "util.h"
dvander@558
    28
#include "version.h"
dvander@580
    29
#include "loader_bridge.h"
dvander@541
    30
dvander@541
    31
/**
dvander@541
    32
 * Versioning
dvander@541
    33
 *   increase api_major when API breaks
dvander@541
    34
 *   increase api_minor when new functions are added (non-breaking)
dvander@541
    35
 */
dvander@541
    36
#define		SOURCEMM_VERSION	SVN_FILE_VERSION_STRING
dvander@541
    37
#define		SOURCEMM_DATE		__DATE__
dvander@541
    38
#define		SM_VERS_API_MAJOR	1		//increase this on a breaking change
dvander@541
    39
#define		SM_VERS_API_MINOR	5		//increase this on a non-breaking API change
dvander@541
    40
dvander@541
    41
//We need a good CServerGameDLL version to work properly.  We support these inclusively.
dvander@541
    42
#define	MIN_GAMEDLL_VERSION	3
dvander@541
    43
#define	MAX_GAMEDLL_VERSION	8
dvander@541
    44
dvander@541
    45
/**
dvander@541
    46
 * @brief Entry point for HL2 Engine
dvander@541
    47
 */
dvander@541
    48
SMM_API void *CreateInterface(const char *name, int *code);
dvander@541
    49
dvander@541
    50
/** @brief Wrapper to catch GameDLL calls */
dvander@541
    51
void *EngineFactory(const char *name, int *code);
dvander@541
    52
dvander@541
    53
/** @brief Wrapper to catch GameDLL calls */
dvander@541
    54
void *PhysicsFactory(const char *name, int *code);
dvander@541
    55
dvander@541
    56
/** @brief Wrapper to catch GameDLL calls */
dvander@541
    57
void *FileSystemFactory(const char *name, int *code);
dvander@541
    58
dvander@541
    59
/** @brief Loads all plugins found in a file */
dvander@541
    60
int LoadPluginsFromFile(const char *file);
dvander@541
    61
dvander@541
    62
/** @brief Logs a message to the standard log file */
dvander@541
    63
void LogMessage(const char *msg, ...);
dvander@541
    64
dvander@541
    65
/** @brief Stores information about the GameDLL */
dvander@541
    66
struct GameDllInfo
dvander@541
    67
{
dvander@541
    68
	bool loaded;
dvander@541
    69
	CreateInterfaceFn factory;
dvander@541
    70
	IServerGameDLL *pGameDLL;
dvander@541
    71
	IServerGameClients *pGameClients;
dvander@541
    72
};
dvander@541
    73
dvander@541
    74
/** @brief Stores information about the HL2 Engine pointers */
dvander@541
    75
struct EngineInfo
dvander@541
    76
{
dvander@541
    77
	EngineInfo() : loaded(false), original(false),
dvander@541
    78
		engineFactory(NULL), physicsFactory(NULL), fileSystemFactory(NULL),
dvander@541
    79
		pGlobals(NULL), icvar(NULL), engine(NULL)
dvander@541
    80
	{ };
dvander@541
    81
	bool loaded;
dvander@541
    82
	bool original;
dvander@541
    83
	CreateInterfaceFn engineFactory;
dvander@541
    84
	CreateInterfaceFn physicsFactory;
dvander@541
    85
	CreateInterfaceFn fileSystemFactory;
dvander@541
    86
	CGlobalVars *pGlobals;
dvander@541
    87
	ICvar *icvar;
dvander@541
    88
	IVEngineServer *engine;
dvander@541
    89
};
dvander@541
    90
dvander@541
    91
bool AlternatelyLoadMetamod(CreateInterfaceFn ifaceFactory, CreateInterfaceFn serverFactory);
dvander@541
    92
dvander@548
    93
extern IServerPluginCallbacks *g_pRealVspCallbacks;
dvander@548
    94
extern bool g_bIsBridgedAsVsp;
dvander@548
    95
dvander@541
    96
/** @brief Global variable for GameDLL info */
dvander@541
    97
extern GameDllInfo g_GameDll;
dvander@541
    98
dvander@541
    99
/** @brief Global variable for Engine info */
dvander@541
   100
extern EngineInfo g_Engine;
dvander@541
   101
dvander@541
   102
/** @brief Global singleton for SourceHook */
dvander@541
   103
extern SourceHook::CSourceHookImpl g_SourceHook;
dvander@541
   104
dvander@541
   105
/** @brief Mod path (important!)*/
dvander@541
   106
extern SourceHook::String g_ModPath;
dvander@541
   107
dvander@541
   108
/** @brief Global variable for SourceHook macros */
dvander@541
   109
extern SourceHook::ISourceHook *g_SHPtr;
dvander@541
   110
dvander@541
   111
/** @brief We have our own internal plugin id... */
dvander@541
   112
extern PluginId g_PLID;
dvander@541
   113
dvander@541
   114
/** @brief ServerGameDLL version that is currently loaded */
dvander@541
   115
extern int g_GameDllVersion;
dvander@541
   116
dvander@580
   117
extern bool g_bGameInit;
dvander@541
   118
extern bool g_bLevelChanged;
dvander@541
   119
dvander@541
   120
void UnloadMetamod(bool shutting_down);
dvander@541
   121
dvander@541
   122
/** @brief Global CallClass for IServerGameDLL */
dvander@541
   123
extern SourceHook::CallClass<IServerGameDLL> *g_GameDllPatch;
dvander@541
   124
dvander@580
   125
void LoadAsGameDLL(const gamedll_bridge_info *info);
dvander@580
   126
dvander@541
   127
/** @brief Global CallClass for ICvar */
dvander@541
   128
extern SourceHook::CallClass<ICvar> *g_CvarPatch;
dvander@541
   129
dvander@541
   130
#endif //_INCLUDE_SOURCEMM_H
dvander@580
   131