1

/* $Id$ */

     2

     3

/** @file console.h */

     4

     5

#ifndef CONSOLE_H

     6

#define CONSOLE_H

     7

     8

#include "window_type.h"

     9

    10

/* maximum length of a typed in command */

    11

#define ICON_CMDLN_SIZE 255

    12

/* maximum length of a totally expanded command */

    13

#define ICON_MAX_STREAMSIZE 1024

    14

    15

enum IConsoleVarTypes {

    16

	ICONSOLE_VAR_BOOLEAN,

    17

	ICONSOLE_VAR_BYTE,

    18

	ICONSOLE_VAR_UINT16,

    19

	ICONSOLE_VAR_UINT32,

    20

	ICONSOLE_VAR_INT16,

    21

	ICONSOLE_VAR_INT32,

    22

	ICONSOLE_VAR_STRING

    23

};

    24

    25

enum IConsoleModes {

    26

	ICONSOLE_FULL,

    27

	ICONSOLE_OPENED,

    28

	ICONSOLE_CLOSED

    29

};

    30

    31

enum IConsoleHookTypes {

    32

	ICONSOLE_HOOK_ACCESS,

    33

	ICONSOLE_HOOK_PRE_ACTION,

    34

	ICONSOLE_HOOK_POST_ACTION

    35

};

    36

    37

/** --Hooks--

    38

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

    39

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

    40

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

    41

 */

    42

typedef bool IConsoleHook();

    43

struct IConsoleHooks{

    44

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

    45

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

    46

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

    47

};

    48

    49

/** --Commands--

    50

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

    51

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

    52

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

    53

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

    54

 * eg. 'say "hello sexy boy"'

    55

 */

    56

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

    57

    58

struct IConsoleCmd {

    59

	char *name;               ///< name of command

    60

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

    61

    62

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

    63

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

    64

};

    65

    66

/** --Variables--

    67

 * Variables are pointers to real ingame variables which allow for

    68

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

    69

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

    70

 * - no arguments; just print out current value

    71

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

    72

 * - '++' to increase value by one

    73

 * - '--' to decrease value by one

    74

 */

    75

struct IConsoleVar {

    76

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

    77

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

    78

    79

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

    80

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

    81

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

    82

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

    83

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

    84

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

    85

};

    86

    87

/** --Aliases--

    88

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

    89

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

    90

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

    91

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

    92

 * given to them in the command line.

    93

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

    94

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

    95

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

    96

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

    97

 */

    98

struct IConsoleAlias {

    99

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

   100

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

   101

   102

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

   103

};

   104

   105

/* console parser */

   106

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

   107

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

   108

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

   109

   110

/* console colors/modes */

   111

extern byte _icolour_def;

   112

extern byte _icolour_err;

   113

extern byte _icolour_warn;

   114

extern byte _icolour_dbg;

   115

extern byte _icolour_cmd;

   116

extern IConsoleModes _iconsole_mode;

   117

   118

/* console functions */

   119

void IConsoleInit();

   120

void IConsoleFree();

   121

void IConsoleClearBuffer();

   122

void IConsoleResize(Window *w);

   123

void IConsoleSwitch();

   124

void IConsoleClose();

   125

void IConsoleOpen();

   126

   127

/* console output */

   128

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

   129

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

   130

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

   131

void IConsoleWarning(const char *string);

   132

void IConsoleError(const char *string);

   133

   134

/* Commands */

   135

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

   136

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

   137

IConsoleCmd *IConsoleCmdGet(const char *name);

   138

IConsoleAlias *IConsoleAliasGet(const char *name);

   139

   140

/* Variables */

   141

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

   142

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

   143

IConsoleVar* IConsoleVarGet(const char *name);

   144

void IConsoleVarPrintGetValue(const IConsoleVar *var);

   145

void IConsoleVarPrintSetValue(const IConsoleVar *var);

   146

   147

/* Parser */

   148

void IConsoleCmdExec(const char *cmdstr);

   149

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

   150

   151

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

   152

void IConsoleStdLibRegister();

   153

   154

/* Hooking code */

   155

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

   156

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

   157

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

   158

   159

/* Supporting functions */

   160

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

   161

#endif /* CONSOLE_H */