OpenTTD Source: src/error_func.h File Reference

OpenTTD Source 15.0-beta1

Macros | Functions
error_func.h File Reference

Error reporting related functions. More...

`#include "3rdparty/fmt/format.h"`

Go to the source code of this file.

## Macros
#define | UserError(format_string, ...) UserErrorI(fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__))
#define | FatalError(format_string, ...) FatalErrorI(fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__))

## Functions
void | UserErrorI (const std::string &str)
| Error handling for fatal user errors.
void | FatalErrorI (const std::string &str)
| Error handling for fatal non-user errors.

## Detailed Description

Error reporting related functions.

Definition in file error_func.h.

## Macro Definition Documentation

## ◆ FatalError

#define FatalError | ( |  | format_string,
|  |  | ...
| ) |  | FatalErrorI(fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__))

Definition at line 18 of file error_func.h.

## ◆ UserError

#define UserError | ( |  | format_string,
|  |  | ...
| ) |  | UserErrorI(fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__))

Definition at line 17 of file error_func.h.

## Function Documentation

## ◆ FatalErrorI()

void FatalErrorI | ( | const std::string & | msg | ) |

Error handling for fatal non-user errors.

Parameters

  str | the string to print.

Note
  Does NEVER return.

Error handling for fatal non-user errors.

Parameters

  s | Format string.

Note
  Function does not return.

Definition at line 133 of file openttd.cpp.

References _cur_line, _file, VideoDriver::GetInstance(), and CrashLog::SetErrorMessage().

## ◆ UserErrorI()

void UserErrorI | ( | const std::string & | str | ) |

Error handling for fatal user errors.

Parameters

  str | the string to print.

Note
  Does NEVER return.

Definition at line 112 of file openttd.cpp.

References VideoDriver::GetInstance(), and Driver::Stop().