sourcemm/sourcemm.h
author David Anderson <dvander@alliedmods.net>
Thu Oct 06 21:59:10 2005 +0000 (2005-10-06)
changeset 124 b04971393ee4
parent 122 7c36121e2dfe
child 149 d928d48d7aec
permissions -rw-r--r--
Finalized versioning and PI
Added QueryRunning() output to meta info/list.
dvander@7
     1
/* ======== SourceMM ========
dvander@9
     2
* Copyright (C) 2004-2005 Metamod:Source Development Team
dvander@7
     3
* No warranties of any kind
dvander@7
     4
*
dvander@7
     5
* License: zlib/libpng
dvander@7
     6
*
dvander@7
     7
* Author(s): David "BAILOPAN" Anderson
dvander@7
     8
* ============================
dvander@7
     9
*/
dvander@7
    10
dvander@7
    11
#ifndef _INCLUDE_SOURCEMM_H
dvander@7
    12
#define _INCLUDE_SOURCEMM_H
dvander@7
    13
dvander@7
    14
/**
dvander@7
    15
 * @brief SourceMM main functionality for GameDLL interception
dvander@7
    16
 * @file sourcemm.h
dvander@7
    17
 */
dvander@7
    18
dvander@7
    19
#include <string>
dvander@7
    20
#include <interface.h>
dvander@7
    21
#include <eiface.h>
dvander@7
    22
#include <sourcehook/sourcehook_impl.h>
dvander@7
    23
#include <sourcehook/sourcehook.h>
dvander@7
    24
#include "ISmmAPI.h"
dvander@7
    25
#include "CPlugin.h"
dvander@7
    26
#include "oslink.h"
dvander@7
    27
#include "util.h"
dvander@7
    28
dvander@124
    29
/**
dvander@124
    30
 * Versioning
dvander@124
    31
 *  First grouping is major release version (1)
dvander@124
    32
 *  Second grouping is minor release version.
dvander@124
    33
 *  Third grouping is release change version.
dvander@124
    34
 * For an entire code rehaul, we would change major.
dvander@124
    35
 * For a simple bug-fix release, we would change the third grouping.
dvander@124
    36
 * For an API change, we would increase the second grouping by one.
dvander@124
    37
 * For a breaking API change, we would increase the second group up to the next bracket.
dvander@124
    38
 *  (example: 1.45 -> 1.50.  1.12 -> 1.20.  1.19 -> 1.20)
dvander@124
    39
 *  minor changes can also roll over, but a big change should ALWAYS roll over.
dvander@124
    40
 * Increasing one grouping should make the lesser ones reset back to zero.
dvander@124
    41
 */
dvander@104
    42
#define		SOURCEMM_VERSION	"1.10"
dvander@7
    43
#define		SOURCEMM_DATE		__DATE__
dvander@124
    44
#define		SM_MAJOR_VERSION	1		//never need to increase this
dvander@124
    45
#define		SM_VERS_API_MAJOR	1		//increase this on a breaking change
dvander@124
    46
#define		SM_VERS_API_MINOR	0		//increase this on a non-breaking API change
dvander@124
    47
#define		SM_VERS_RELEASE		0		//increase this on a bug-fix release.
dvander@7
    48
dvander@124
    49
//We need a good CServerGameDLL version to work properly.  We support these inclusively.
dvander@122
    50
#define	MIN_GAMEDLL_VERSION	3
dvander@122
    51
#define	MAX_GAMEDLL_VERSION	4
dvander@122
    52
dvander@7
    53
/**
dvander@7
    54
 * @brief Entry point for HL2 Engine
dvander@7
    55
 */
dvander@7
    56
SMM_API void *CreateInterface(const char *name, int *code);
dvander@7
    57
dvander@7
    58
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    59
void *EngineFactory(const char *name, int *code);
dvander@7
    60
dvander@7
    61
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    62
void *PhysicsFactory(const char *name, int *code);
dvander@7
    63
dvander@7
    64
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    65
void *FileSystemFactory(const char *name, int *code);
dvander@7
    66
dvander@7
    67
/** @brief Loads all plugins found in a file */
dvander@7
    68
int LoadPluginsFromFile(const char *file);
dvander@7
    69
dvander@7
    70
/** @brief Logs a message to the standard log file */
dvander@7
    71
void LogMessage(const char *msg, ...);
dvander@7
    72
dvander@7
    73
/** @brief Stores information about the GameDLL */
dvander@7
    74
struct GameDllInfo
dvander@7
    75
{
dvander@7
    76
	bool loaded;
dvander@7
    77
	HINSTANCE lib;
dvander@7
    78
	CreateInterfaceFn factory;
dvander@122
    79
	IServerGameDLL *pGameDLL;
dvander@7
    80
};
dvander@7
    81
dvander@7
    82
/** @brief Stores information about the HL2 Engine pointers */
dvander@7
    83
struct EngineInfo
dvander@7
    84
{
dvander@122
    85
	EngineInfo() : loaded(false), 
dvander@122
    86
		engineFactory(NULL), physicsFactory(NULL), fileSystemFactory(NULL),
dvander@122
    87
		pGlobals(NULL), icvar(NULL), engine(NULL)
dvander@122
    88
	{ };
dvander@122
    89
	bool loaded;
dvander@7
    90
	CreateInterfaceFn engineFactory;
dvander@7
    91
	CreateInterfaceFn physicsFactory;
dvander@7
    92
	CreateInterfaceFn fileSystemFactory;
dvander@7
    93
	CGlobalVars *pGlobals;
dvander@7
    94
	ICvar *icvar;
dvander@7
    95
	IVEngineServer *engine;
dvander@7
    96
};
dvander@7
    97
dvander@7
    98
/** @brief Global variable for GameDLL info */
dvander@7
    99
extern GameDllInfo g_GameDll;
dvander@7
   100
dvander@7
   101
/** @brief Global variable for Engine info */
dvander@7
   102
extern EngineInfo g_Engine;
dvander@7
   103
dvander@7
   104
/** @brief Global singleton for SourceHook */
dvander@7
   105
extern SourceHook::CSourceHookImpl g_SourceHook;
dvander@7
   106
dvander@7
   107
/** @brief Mod path (important!)*/
dvander@98
   108
extern SourceHook::String g_ModPath;
dvander@7
   109
dvander@7
   110
/** @brief Path to server binary */
dvander@98
   111
extern SourceHook::String g_BinPath;
dvander@7
   112
dvander@12
   113
/** @brief Global variable for SourceHook macros */
dvander@12
   114
extern SourceHook::ISourceHook *g_SHPtr;
dvander@12
   115
dvander@12
   116
/** @brief We have our own internal plugin id... */
dvander@12
   117
extern PluginId g_PLID;
dvander@12
   118
dvander@7
   119
#endif //_INCLUDE_SOURCEMM_H