1

/* $Id$ */

     2

     3

/** @file console.h */

     4

     5

#ifndef CONSOLE_H

     6

#define CONSOLE_H

     7

     8

/* maximum length of a typed in command */

     9

#define ICON_CMDLN_SIZE 255

    10

/* maximum length of a totally expanded command */

    11

#define ICON_MAX_STREAMSIZE 1024

    12

    13

enum IConsoleVarTypes {

    14

	ICONSOLE_VAR_BOOLEAN,

    15

	ICONSOLE_VAR_BYTE,

    16

	ICONSOLE_VAR_UINT16,

    17

	ICONSOLE_VAR_UINT32,

    18

	ICONSOLE_VAR_INT16,

    19

	ICONSOLE_VAR_INT32,

    20

	ICONSOLE_VAR_STRING

    21

};

    22

    23

enum IConsoleModes {

    24

	ICONSOLE_FULL,

    25

	ICONSOLE_OPENED,

    26

	ICONSOLE_CLOSED

    27

};

    28

    29

enum IConsoleHookTypes {

    30

	ICONSOLE_HOOK_ACCESS,

    31

	ICONSOLE_HOOK_PRE_ACTION,

    32

	ICONSOLE_HOOK_POST_ACTION

    33

};

    34

    35

/** --Hooks--

    36

 * Hooks are certain triggers get get accessed/executed on either

    37

 * access, before execution/change or after execution/change. This allows

    38

 * for general flow of permissions or special action needed in some cases

    39

 */

    40

typedef bool IConsoleHook();

    41

struct IConsoleHooks{

    42

	IConsoleHook *access; ///< trigger when accessing the variable/command

    43

	IConsoleHook *pre;    ///< trigger before the variable/command is changed/executed

    44

	IConsoleHook *post;   ///< trigger after the variable/command is changed/executed

    45

};

    46

    47

/** --Commands--

    48

 * Commands are commands, or functions. They get executed once and any

    49

 * effect they produce are carried out. The arguments to the commands

    50

 * are given to them, each input word seperated by a double-quote (") is an argument

    51

 * If you want to handle multiple words as one, enclose them in double-quotes

    52

 * eg. 'say "hello sexy boy"'

    53

 */

    54

typedef bool (IConsoleCmdProc)(byte argc, char *argv[]);

    55

    56

struct IConsoleCmd {

    57

	char *name;               ///< name of command

    58

	IConsoleCmd *next;        ///< next command in list

    59

    60

	IConsoleCmdProc *proc;    ///< process executed when command is typed

    61

	IConsoleHooks hook;       ///< any special trigger action that needs executing

    62

};

    63

    64

/** --Variables--

    65

 * Variables are pointers to real ingame variables which allow for

    66

 * changing while ingame. After changing they keep their new value

    67

 * and can be used for debugging, gameplay, etc. It accepts:

    68

 * - no arguments; just print out current value

    69

 * - '= <new value>' to assign a new value to the variable

    70

 * - '++' to increase value by one

    71

 * - '--' to decrease value by one

    72

 */

    73

struct IConsoleVar {

    74

	char *name;               ///< name of the variable

    75

	IConsoleVar *next;        ///< next variable in list

    76

    77

	void *addr;               ///< the address where the variable is pointing at

    78

	uint32 size;              ///< size of the variable, used for strings

    79

	char *help;               ///< the optional help string shown when requesting information

    80

	IConsoleVarTypes type;    ///< type of variable (for correct assignment/output)

    81

	IConsoleCmdProc *proc;    ///< some variables need really special handling, use a callback function for that

    82

	IConsoleHooks hook;       ///< any special trigger action that needs executing

    83

};

    84

    85

/** --Aliases--

    86

 * Aliases are like shortcuts for complex functions, variable assignments,

    87

 * etc. You can use a simple alias to rename a longer command (eg 'lv' for

    88

 * 'list_vars' for example), or concatenate more commands into one

    89

 * (eg. 'ng' for 'load %A; unpause; debug_level 5'). Aliases can parse the arguments

    90

 * given to them in the command line.

    91

 * - "%A - %Z" substitute arguments 1 t/m 26

    92

 * - "%+" lists all parameters keeping them seperated

    93

 * - "%!" also lists all parameters but presenting them to the aliased command as one argument

    94

 * - ";" allows for combining commands (see example 'ng')

    95

 */

    96

struct IConsoleAlias {

    97

	char *name;                 ///< name of the alias

    98

	IConsoleAlias *next;        ///< next alias in list

    99

   100

	char *cmdline;              ///< command(s) that is/are being aliased

   101

};

   102

   103

/* console parser */

   104

VARDEF IConsoleCmd   *_iconsole_cmds;    ///< list of registred commands

   105

VARDEF IConsoleVar   *_iconsole_vars;    ///< list of registred vars

   106

VARDEF IConsoleAlias *_iconsole_aliases; ///< list of registred aliases

   107

   108

/* console colors/modes */

   109

VARDEF byte _icolour_def;

   110

VARDEF byte _icolour_err;

   111

VARDEF byte _icolour_warn;

   112

VARDEF byte _icolour_dbg;

   113

VARDEF byte _icolour_cmd;

   114

VARDEF IConsoleModes _iconsole_mode;

   115

   116

/* console functions */

   117

void IConsoleInit();

   118

void IConsoleFree();

   119

void IConsoleClearBuffer();

   120

void IConsoleResize(Window *w);

   121

void IConsoleSwitch();

   122

void IConsoleClose();

   123

void IConsoleOpen();

   124

   125

/* console output */

   126

void IConsolePrint(uint16 color_code, const char *string);

   127

void CDECL IConsolePrintF(uint16 color_code, const char *s, ...);

   128

void IConsoleDebug(const char *dbg, const char *string);

   129

void IConsoleWarning(const char *string);

   130

void IConsoleError(const char *string);

   131

   132

/* Commands */

   133

void IConsoleCmdRegister(const char *name, IConsoleCmdProc *proc);

   134

void IConsoleAliasRegister(const char *name, const char *cmd);

   135

IConsoleCmd *IConsoleCmdGet(const char *name);

   136

IConsoleAlias *IConsoleAliasGet(const char *name);

   137

   138

/* Variables */

   139

void IConsoleVarRegister(const char *name, void *addr, IConsoleVarTypes type, const char *help);

   140

void IConsoleVarStringRegister(const char *name, void *addr, uint32 size, const char *help);

   141

IConsoleVar* IConsoleVarGet(const char *name);

   142

void IConsoleVarPrintGetValue(const IConsoleVar *var);

   143

void IConsoleVarPrintSetValue(const IConsoleVar *var);

   144

   145

/* Parser */

   146

void IConsoleCmdExec(const char *cmdstr);

   147

void IConsoleVarExec(const IConsoleVar *var, byte tokencount, char *token[]);

   148

   149

/* console std lib (register ingame commands/aliases/variables) */

   150

void IConsoleStdLibRegister();

   151

   152

/* Hooking code */

   153

void IConsoleCmdHookAdd(const char *name, IConsoleHookTypes type, IConsoleHook *proc);

   154

void IConsoleVarHookAdd(const char *name, IConsoleHookTypes type, IConsoleHook *proc);

   155

void IConsoleVarProcAdd(const char *name, IConsoleCmdProc *proc);

   156

   157

/* Supporting functions */

   158

bool GetArgumentInteger(uint32 *value, const char *arg);

   159

#endif /* CONSOLE_H */