4

// maximum length of a typed in command

     5

#define ICON_CMDLN_SIZE 255

     6

// maximum length of a totally expanded command

     7

#define ICON_MAX_STREAMSIZE 1024

     9

typedef enum IConsoleVarTypes {

    16

	ICONSOLE_VAR_STRING

    17

} IConsoleVarTypes;

    19

typedef enum IConsoleModes {

    23

} IConsoleModes;

    25

typedef enum IConsoleHookTypes {

    26

	ICONSOLE_HOOK_ACCESS,

    27

	ICONSOLE_HOOK_PRE_ACTION,

    28

	ICONSOLE_HOOK_POST_ACTION

    29

} IConsoleHookTypes;

    31

/** --Hooks--

    32

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

    33

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

    34

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

    35

 */

    36

typedef bool IConsoleHook(void);

    37

typedef struct IConsoleHooks{

    38

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

    39

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

    40

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

    41

} IConsoleHooks;

    43

/** --Commands--

    44

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

    45

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

    46

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

    47

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

    48

 * eg. 'say "hello sexy boy"'

    49

 */

    50

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

    52

struct IConsoleCmd;

    53

typedef struct IConsoleCmd {

    54

	char *name;               // name of command

    55

	struct IConsoleCmd *next; // next command in list

    57

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

    58

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

    59

} IConsoleCmd;

    61

/** --Variables--

    62

 * Variables are pointers to real ingame variables which allow for

    63

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

    64

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

    65

 * - no arguments; just print out current value

    66

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

    67

 * - '++' to increase value by one

    68

 * - '--' to decrease value by one

    69

 */

    70

struct IConsoleVar;

    71

typedef struct IConsoleVar {

    72

	char *name;               // name of the variable

    73

	struct IConsoleVar *next; // next variable in list

    74

    75

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

    76

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

    77

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

    78

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

    79

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

    80

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

    81

} IConsoleVar;

    82

    83

/** --Aliases--

    84

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

    85

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

    86

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

    87

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

    88

 * given to them in the command line.

    89

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

    90

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

    91

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

    92

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

    93

 */

    94

struct IConsoleAlias;

    95

typedef struct IConsoleAlias {

    96

	char *name;                 // name of the alias

    97

	struct IConsoleAlias *next; // next alias in list

    98

    99

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

   100

} IConsoleAlias;

   103

IConsoleCmd   *_iconsole_cmds;    // list of registred commands

   104

IConsoleVar   *_iconsole_vars;    // list of registred vars

   105

IConsoleAlias *_iconsole_aliases; // list of registred aliases

   107

// ** console colors/modes ** //

   113

VARDEF IConsoleModes _iconsole_mode;

   125

void IConsoleHistoryAdd(const char *cmd);

   126

void IConsoleHistoryNavigate(signed char direction);

   129

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

   130

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

   131

void IConsoleDebug(const char *string);

   132

void IConsoleWarning(const char *string);

   133

void IConsoleError(const char *string);

   136

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

   137

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

   138

IConsoleCmd *IConsoleCmdGet(const char *name);

   139

IConsoleAlias *IConsoleAliasGet(const char *name);

   142

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

   143

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

   144

IConsoleVar* IConsoleVarGet(const char *name);

   145

void IConsoleVarPrintGetValue(const IConsoleVar *var);

   146

void IConsoleVarPrintSetValue(const IConsoleVar *var);

   149

void IConsoleCmdExec(const char *cmdstr);

   150

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

   151

void IConsoleAliasExec(const IConsoleAlias *alias, byte tokencount, char *tokens[]);

   153

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

   156

// ** Hooking code ** //

   157

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

   158

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

   159

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

   161

// ** Supporting functions **//

   162

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