OpenTTD Source: src/console_internal.h Source File

OpenTTD Source 15.0-beta1

console_internal.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10#ifndef CONSOLE_INTERNAL_H
11#define CONSOLE_INTERNAL_H
12
13#include "gfx_type.h"
14
15 static const uint ICON_CMDLN_SIZE = 1024;
16 static const uint ICON_MAX_STREAMSIZE = 2048;
17
19 enum ConsoleHookResult {
20 CHR_ALLOW,
21 CHR_DISALLOW,
22 CHR_HIDE,
23};
24
33 typedef bool IConsoleCmdProc(uint8_t argc, char *argv[]);
34typedef ConsoleHookResult IConsoleHook(bool echo);
35 struct IConsoleCmd {
36 IConsoleCmd(const std::string &name, IConsoleCmdProc *proc, IConsoleHook *hook) : name(name), proc(proc), hook(hook) {}
37
38 std::string name;
39 IConsoleCmdProc *proc;
40 IConsoleHook *hook;
41};
42
55 struct IConsoleAlias {
56 IConsoleAlias(const std::string &name, const std::string &cmdline) : name(name), cmdline(cmdline) {}
57
58 std::string name;
59 std::string cmdline;
60};
61
62 struct IConsole
63{
64 typedef std::map<std::string, IConsoleCmd> CommandList;
65 typedef std::map<std::string, IConsoleAlias> AliasList;
66
67 /* console parser */
68 static CommandList &Commands();
69 static AliasList &Aliases();
70
71 /* Commands */
72 static void CmdRegister(const std::string &name, IConsoleCmdProc *proc, IConsoleHook *hook = nullptr);
73 static IConsoleCmd *CmdGet(const std::string &name);
74 static void AliasRegister(const std::string &name, const std::string &cmd);
75 static IConsoleAlias *AliasGet(const std::string &name);
76};
77
78/* console functions */
79void IConsoleClearBuffer();
80
81/* console std lib (register ingame commands/aliases) */
82void IConsoleStdLibRegister();
83
84/* Supporting functions */
85bool GetArgumentInteger(uint32_t *value, const char *arg);
86
87void IConsoleGUIInit();
88void IConsoleGUIFree();
89void IConsoleGUIPrint(TextColour colour_code, const std::string &string);
90
91#endif /* CONSOLE_INTERNAL_H */
Commands
Commands
List of commands.
Definition command_type.h:187
GetArgumentInteger
bool GetArgumentInteger(uint32_t *value, const char *arg)
Change a string into its number representation.
Definition console.cpp:127
ICON_MAX_STREAMSIZE
static const uint ICON_MAX_STREAMSIZE
maximum length of a totally expanded command
Definition console_internal.h:16
ConsoleHookResult
ConsoleHookResult
Return values of console hooks (IConsoleHook).
Definition console_internal.h:19
CHR_HIDE
@ CHR_HIDE
Hide the existence of the command.
Definition console_internal.h:22
CHR_DISALLOW
@ CHR_DISALLOW
Disallow command execution.
Definition console_internal.h:21
CHR_ALLOW
@ CHR_ALLOW
Allow command execution.
Definition console_internal.h:20
IConsoleGUIPrint
void IConsoleGUIPrint(TextColour colour_code, const std::string &string)
Handle the printing of text entered into the console or redirected there by any other means.
Definition console_gui.cpp:501
ICON_CMDLN_SIZE
static const uint ICON_CMDLN_SIZE
maximum length of a typed in command
Definition console_internal.h:15
IConsoleCmdProc
bool IConsoleCmdProc(uint8_t argc, char *argv[])
–Commands– Commands are commands, or functions.
Definition console_internal.h:33
gfx_type.h
Types related to the graphics and/or input devices.
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:260
IConsoleAlias
–Aliases– Aliases are like shortcuts for complex functions, variable assignments, etc.
Definition console_internal.h:55
IConsoleAlias::cmdline
std::string cmdline
command(s) that is/are being aliased
Definition console_internal.h:59
IConsoleAlias::name
std::string name
name of the alias
Definition console_internal.h:58
IConsoleCmd
Definition console_internal.h:35
IConsoleCmd::proc
IConsoleCmdProc * proc
process executed when command is typed
Definition console_internal.h:39
IConsoleCmd::hook
IConsoleHook * hook
any special trigger action that needs executing
Definition console_internal.h:40
IConsoleCmd::name
std::string name
name of command
Definition console_internal.h:38
IConsole
Definition console_internal.h:63
IConsole::AliasGet
static IConsoleAlias * AliasGet(const std::string &name)
Find the alias pointed to by its string.
Definition console.cpp:193
IConsole::CmdRegister
static void CmdRegister(const std::string &name, IConsoleCmdProc *proc, IConsoleHook *hook=nullptr)
Register a new command to be used in the console.
Definition console.cpp:160
IConsole::CmdGet
static IConsoleCmd * CmdGet(const std::string &name)
Find the command pointed to by its string.
Definition console.cpp:170
IConsole::AliasRegister
static void AliasRegister(const std::string &name, const std::string &cmd)
Register a an alias for an already existing command in the console.
Definition console.cpp:182