- Generated by
1.9.8
|
OpenTTD Source 20241224-master-gf74b0cf984
|
Functions related to debugging. More...
Go to the source code of this file.
Data Structures | |
| struct | TicToc |
| TicToc profiling. More... | |
| struct | TicToc::State |
| Persistent state for TicToc profiling. More... | |
Macros | |
| #define | Debug(category, level, format_string, ...) do { if ((level) == 0 || _debug_ ## category ## _level >= (level)) DebugPrint(#category, level, fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__)); } while (false) |
| Ouptut a line of debugging information. | |
| #define | ShowInfo(format_string, ...) ShowInfoI(fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__)) |
Functions | |
| void | DebugPrint (const char *category, int level, const std::string &message) |
| Internal function for outputting the debug line. | |
| void | DumpDebugFacilityNames (std::back_insert_iterator< std::string > &output_iterator) |
| Dump the available debug facility names in the help text. | |
| void | SetDebugString (const char *s, void(*error_func)(const std::string &)) |
| Set debugging levels by parsing the text in s. | |
| std::string | GetDebugString () |
| Print out the current debug-level. | |
| void | ShowInfoI (const std::string &str) |
| std::string | GetLogPrefix (bool force=false) |
| Get the prefix for logs. | |
| void | DebugSendRemoteMessages () |
| Send the queued Debug messages to either NetworkAdminConsole or IConsolePrint from the GameLoop thread to prevent concurrent accesses to both the NetworkAdmin's packet queue as well as IConsolePrint's buffers. | |
| void | DebugReconsiderSendRemoteMessages () |
| Reconsider whether we need to send debug messages to either NetworkAdminConsole or IConsolePrint. | |
Variables | |
| int | _debug_driver_level |
| int | _debug_grf_level |
| int | _debug_map_level |
| int | _debug_misc_level |
| int | _debug_net_level |
| int | _debug_sprite_level |
| int | _debug_oldloader_level |
| int | _debug_yapf_level |
| int | _debug_fontcache_level |
| int | _debug_script_level |
| int | _debug_sl_level |
| int | _debug_gamelog_level |
| int | _debug_desync_level |
| int | _debug_console_level |
Functions related to debugging.
Definition in file debug.h.
| #define Debug | ( | category, | |
| level, | |||
| format_string, | |||
| ... | |||
| ) | do { if ((level) == 0 || _debug_ ## category ## _level >= (level)) DebugPrint(#category, level, fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__)); } while (false) |
Ouptut a line of debugging information.
| category | The category of debug information. |
| level | The maximum debug level this message should be shown at. When the debug level for this category is set lower, then the message will not be shown. |
| format_string | The formatting string of the message. |
| #define ShowInfo | ( | format_string, | |
| ... | |||
| ) | ShowInfoI(fmt::format(FMT_STRING(format_string) __VA_OPT__(,) __VA_ARGS__)) |
| void DebugPrint | ( | const char * | category, |
| int | level, | ||
| const std::string & | message | ||
| ) |
Internal function for outputting the debug line.
| level | Debug category. |
| message | The message to output. |
Definition at line 109 of file debug.cpp.
References _debug_remote_console, _debug_remote_console_mutex, _debug_remote_console_queue, AUTOSAVE_DIR, FioFOpenFile(), GetLogPrefix(), and lock.
| void DebugReconsiderSendRemoteMessages | ( | ) |
Reconsider whether we need to send debug messages to either NetworkAdminConsole or IConsolePrint.
The former is when they have enabled console handling whereas the latter depends on the gui.developer setting's value.
This is to be called from the GameLoop thread.
Definition at line 264 of file debug.cpp.
References _debug_remote_console, _settings_client, ADMIN_FREQUENCY_AUTOMATIC, ADMIN_UPDATE_CONSOLE, GUISettings::developer, ClientSettings::gui, and ServerNetworkAdminSocketHandler::IterateActive().
Referenced by LoadFromConfig(), ServerNetworkAdminSocketHandler::Receive_ADMIN_UPDATE_FREQUENCY(), and ServerNetworkAdminSocketHandler::~ServerNetworkAdminSocketHandler().
| void DebugSendRemoteMessages | ( | ) |
Send the queued Debug messages to either NetworkAdminConsole or IConsolePrint from the GameLoop thread to prevent concurrent accesses to both the NetworkAdmin's packet queue as well as IConsolePrint's buffers.
This is to be called from the GameLoop thread.
Definition at line 240 of file debug.cpp.
References _debug_remote_console, _debug_remote_console_mutex, _debug_remote_console_queue, _debug_remote_console_queue_spare, _settings_client, CC_DEBUG, GUISettings::developer, ClientSettings::gui, IConsolePrint(), lock, and NetworkAdminConsole().
| void DumpDebugFacilityNames | ( | std::back_insert_iterator< std::string > & | output_iterator | ) |
Dump the available debug facility names in the help text.
| output_iterator | The iterator to write the string to. |
Definition at line 87 of file debug.cpp.
Referenced by ShowHelp().
| std::string GetDebugString | ( | ) |
| std::string GetLogPrefix | ( | bool | force | ) |
Get the prefix for logs.
If show_date_in_logs or force is enabled it returns the date, otherwise it returns an empty string.
Definition at line 224 of file debug.cpp.
References _settings_client, ClientSettings::gui, and GUISettings::show_date_in_logs.
Referenced by DebugPrint(), and IConsolePrint().
| void SetDebugString | ( | const char * | s, |
| void(*)(const std::string &) | error_func | ||
| ) |
Set debugging levels by parsing the text in s.
For setting individual levels a string like "net=3,grf=6" should be used. If the string starts with a number, the number is used as global debugging level.
| s | Text describing the wanted debugging levels. |
| error_func | The function to call if a parse error occurs. |
Definition at line 143 of file debug.cpp.
Referenced by openttd_main().
1.9.8