console_func.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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef CONSOLE_FUNC_H
#define CONSOLE_FUNC_H
 
#include "console_type.h"
#include "core/format.hpp"
 
/* console modes */
extern IConsoleModes _iconsole_mode;
 
/* console functions */
void IConsoleInit();
void IConsoleFree();
void IConsoleClose();
 
/* console output */
void IConsolePrint(TextColour colour_code, const std::string &string);
 
template <typename A, typename ... Args>
inline void IConsolePrint(TextColour colour_code, fmt::format_string<A, Args...> format, A first_arg, Args&&... other_args)
{
  /* The separate first_arg argument is added to aid overloading.
   * Otherwise the calls that do no need formatting will still use this function. */
  IConsolePrint(colour_code, fmt::format(format, std::forward<A>(first_arg), std::forward<Args>(other_args)...));
}
 
/* Parser */
void IConsoleCmdExec(const std::string &command_string, const uint recurse_count = 0);
 
bool IsValidConsoleColour(TextColour c);
 
#endif /* CONSOLE_FUNC_H */