console_internal.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef CONSOLE_INTERNAL_H
#define CONSOLE_INTERNAL_H
 
#include "gfx_type.h"
 
static const uint ICON_CMDLN_SIZE     = 1024; 

enum ConsoleHookResult : uint8_t {
  CHR_ALLOW,    
  CHR_DISALLOW, 
  CHR_HIDE,     
};

using IConsoleCmdProc = bool(std::span<std::string_view> argv);

using IConsoleHook = ConsoleHookResult(bool echo);

struct IConsoleCmd {
  IConsoleCmd(const std::string &name, IConsoleCmdProc *proc, IConsoleHook *hook) : name(name), proc(proc), hook(hook) {}
 
  std::string name;         
  IConsoleCmdProc *proc;    
  IConsoleHook *hook;       
};

struct IConsoleAlias {
  IConsoleAlias(const std::string &name, std::string_view cmdline) : name(name), cmdline(cmdline) {}
 
  std::string name;           
  std::string cmdline;        
};
 
struct IConsole
{
  typedef std::map<std::string, IConsoleCmd> CommandList;
  typedef std::map<std::string, IConsoleAlias> AliasList;
 
  /* console parser */
  static CommandList &Commands();
  static AliasList &Aliases();
 
  /* Commands */
  static void CmdRegister(const std::string &name, IConsoleCmdProc *proc, IConsoleHook *hook = nullptr);
  static IConsoleCmd *CmdGet(const std::string &name);
  static void AliasRegister(const std::string &name, std::string_view cmd);
  static IConsoleAlias *AliasGet(const std::string &name);
};
 
/* console functions */
void IConsoleClearBuffer();
 
/* console std lib (register ingame commands/aliases) */
void IConsoleStdLibRegister();
 
void IConsoleGUIInit();
void IConsoleGUIFree();
void IConsoleGUIPrint(TextColour colour_code, const std::string &string);
 
#endif /* CONSOLE_INTERNAL_H */