mpo/VVVVVV
1
0
Fork 0
mirror of https://github.com/TerryCavanagh/VVVVVV.git synced 2024-12-23 01:59:43 +01:00
Code Issues Releases Wiki Activity
VVVVVV/desktop_version/src/Vlogging.h

42 lines
771 B
C
Raw Normal View History

Add logging functions Named "vlogs" because they're logs for VVVVVV. Also it's a funny name.
2021-02-23 09:54:45 +01:00
#ifndef VLOGGING_H
#define VLOGGING_H
#ifdef __cplusplus
extern "C"
{
#endif
Mark all vlog functions with printf attributes This ensures that compiler warnings about format strings will apply to all calls of these functions as well.
2021-09-28 05:49:09 +02:00
#include <SDL_stdinc.h>
Add colors to logging This includes the bold as well. INFO is just default, WARN is yellow, ERROR is red. We try to automatically detect if the output is a TTY (and thus supports colors), and don't emit colors if so. Windows 10 supports ANSI color codes starting with a specific build, but we don't care to emit whatever garbage Microsoft invented for builds older than that.
2021-02-24 00:22:28 +01:00
void vlog_init(void);
Add `-console` option on Windows This adds the `-console` command-line option (for Win32 only) so the game can spawn an attached console window which will contain all console output. This is to make it easier for people to debug on Windows systems. Otherwise, the only way to get console output would be to either compile the application as a console app (i.e. switch the subsystem to console) - which is undesirable for regular users as this makes it so a console is always spawned even when unwanted - or launch the game with shell arguments that make it so output is redirected to a file. As a result, color checking support is factored out of vlog_init() into its own function, even though we don't support colors on Windows.
2022-11-15 04:34:48 +01:00
#ifdef _WIN32
void vlog_open_console(void);
#endif
Allow disabling output/fine-tuning output -nooutput disables output completely (both STDOUT and STDERR). -noinfo disables INFO lines. -nowarn disables WARN lines. -noerror disables ERROR lines.
2021-09-01 22:41:06 +02:00
void vlog_toggle_output(int enable_output);
Add command-line options to force-enable/disable color `-forcecolor` will force color to be on. `-nocolor` will force color to be off. And just because I'm a nice person, I've also added British versions of those flags. As a treat.
2021-09-01 22:28:51 +02:00
void vlog_toggle_color(int enable_color);
Add debug logs These are disabled by default, because they're noisy. To enable them, pass -debug.
2021-09-01 23:11:23 +02:00
void vlog_toggle_debug(int enable_debug);
Allow disabling output/fine-tuning output -nooutput disables output completely (both STDOUT and STDERR). -noinfo disables INFO lines. -nowarn disables WARN lines. -noerror disables ERROR lines.
2021-09-01 22:41:06 +02:00
void vlog_toggle_info(int enable_info);
void vlog_toggle_warn(int enable_warn);
void vlog_toggle_error(int enable_error);
Remove return values from `vlog_*` functions They weren't ever being used, and nobody really ever uses the return value from the printf family of functions anyway. They return how many bytes were actually printed, but if it's less than you expected then there's not much you can really do about them. Also the vlog_* functions were computing them inaccurately because I only set the return value to the return value of vprintf when there's other print functions being called, but regardless there's no reason to have a return value here anyway.
2022-08-29 19:48:21 +02:00
SDL_PRINTF_VARARG_FUNC(1) void vlog_debug(const char* text, ...);
Add debug logs These are disabled by default, because they're noisy. To enable them, pass -debug.
2021-09-01 23:11:23 +02:00
Remove return values from `vlog_*` functions They weren't ever being used, and nobody really ever uses the return value from the printf family of functions anyway. They return how many bytes were actually printed, but if it's less than you expected then there's not much you can really do about them. Also the vlog_* functions were computing them inaccurately because I only set the return value to the return value of vprintf when there's other print functions being called, but regardless there's no reason to have a return value here anyway.
2022-08-29 19:48:21 +02:00
SDL_PRINTF_VARARG_FUNC(1) void vlog_info(const char* text, ...);
Add logging functions Named "vlogs" because they're logs for VVVVVV. Also it's a funny name.
2021-02-23 09:54:45 +01:00
Remove return values from `vlog_*` functions They weren't ever being used, and nobody really ever uses the return value from the printf family of functions anyway. They return how many bytes were actually printed, but if it's less than you expected then there's not much you can really do about them. Also the vlog_* functions were computing them inaccurately because I only set the return value to the return value of vprintf when there's other print functions being called, but regardless there's no reason to have a return value here anyway.
2022-08-29 19:48:21 +02:00
SDL_PRINTF_VARARG_FUNC(1) void vlog_warn(const char* text, ...);
Add logging functions Named "vlogs" because they're logs for VVVVVV. Also it's a funny name.
2021-02-23 09:54:45 +01:00
Remove return values from `vlog_*` functions They weren't ever being used, and nobody really ever uses the return value from the printf family of functions anyway. They return how many bytes were actually printed, but if it's less than you expected then there's not much you can really do about them. Also the vlog_* functions were computing them inaccurately because I only set the return value to the return value of vprintf when there's other print functions being called, but regardless there's no reason to have a return value here anyway.
2022-08-29 19:48:21 +02:00
SDL_PRINTF_VARARG_FUNC(1) void vlog_error(const char* text, ...);
Add logging functions Named "vlogs" because they're logs for VVVVVV. Also it's a funny name.
2021-02-23 09:54:45 +01:00
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* VLOGGING_H */
Reference in a new issue Copy permalink