mirrors
/
OpenRCT2
mirror of https://github.com/OpenRCT2/OpenRCT2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
OpenRCT2/src/openrct2/Diagnostic.h

89 lines
3.1 KiB
C
Raw Normal View History

add log level check so that --verbose option works
2014-11-21 19:39:56 +01:00
/*****************************************************************************
Ready copyright notice for clang-format Clang-format sees the text behind `#pragma region` as code and formats it. Instead of stating the copyright and date there, it's now in the comment block right below it. The text "Copyright" is left in the `#pragma region` line, as clang-format sees it as a single identifier. I took the opportunity to normalize the dates, and add the copyright notice to the source files where it was missing them (except for third-party and the generated resources.h file).
2018-06-15 14:07:34 +02:00
* Copyright (c) 2014-2018 OpenRCT2 developers
Add and correct licence headers to all sources (#3108)
2016-05-04 19:24:41 +02:00
*
Ready copyright notice for clang-format Clang-format sees the text behind `#pragma region` as code and formats it. Instead of stating the copyright and date there, it's now in the comment block right below it. The text "Copyright" is left in the `#pragma region` line, as clang-format sees it as a single identifier. I took the opportunity to normalize the dates, and add the copyright notice to the source files where it was missing them (except for third-party and the generated resources.h file).
2018-06-15 14:07:34 +02:00
* For a complete list of all authors, please refer to contributors.md
* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
Add and correct licence headers to all sources (#3108)
2016-05-04 19:24:41 +02:00
*
Ready copyright notice for clang-format Clang-format sees the text behind `#pragma region` as code and formats it. Instead of stating the copyright and date there, it's now in the comment block right below it. The text "Copyright" is left in the `#pragma region` line, as clang-format sees it as a single identifier. I took the opportunity to normalize the dates, and add the copyright notice to the source files where it was missing them (except for third-party and the generated resources.h file).
2018-06-15 14:07:34 +02:00
* OpenRCT2 is licensed under the GNU General Public License version 3.
Add and correct licence headers to all sources (#3108)
2016-05-04 19:24:41 +02:00
*****************************************************************************/
add log level check so that --verbose option works
2014-11-21 19:39:56 +01:00
#ifndef _DIAGNOSTIC_H_
#define _DIAGNOSTIC_H_
Fix #7670 Include header for types instead of common.h
2018-06-21 01:07:44 +02:00
#include <cstdint>
Use typedef for diagnostic levels, small refactor
2017-01-04 23:51:50 +01:00
Remove and replace C typedefs `typedef struct/union/enum name { ... } name_again;` is not needed whe compiling C++, moving the name at the back to be in front of the object and removing `typedef` makes it usable the very same way. This also replaces typedefs with the using keyword. They have better readability, especially for function pointer types, and would allow more flexibility when used with templates.
2018-02-14 09:42:26 +01:00
enum DIAGNOSTIC_LEVEL {
Expand tabs to spaces This commit expands tabs to spaces (ts=4) in all the files under src/ and test/. Until now we had two wildly different code styles with C using tabs and new C++ using spaces. It is painful to maintain as none of the commonly used tools support this kind of setup and in reality is needless, as we can simply convert all the sources to spaces and have opened PRs do the same, where needed. Additionally, trailing whitespace has been removed.
2017-06-06 23:24:18 +02:00
DIAGNOSTIC_LEVEL_FATAL,
DIAGNOSTIC_LEVEL_ERROR,
DIAGNOSTIC_LEVEL_WARNING,
DIAGNOSTIC_LEVEL_VERBOSE,
DIAGNOSTIC_LEVEL_INFORMATION,
DIAGNOSTIC_LEVEL_COUNT
Remove and replace C typedefs `typedef struct/union/enum name { ... } name_again;` is not needed whe compiling C++, moving the name at the back to be in front of the object and removing `typedef` makes it usable the very same way. This also replaces typedefs with the using keyword. They have better readability, especially for function pointer types, and would allow more flexibility when used with templates.
2018-02-14 09:42:26 +01:00
};
add log level check so that --verbose option works
2014-11-21 19:39:56 +01:00
Clean up the comments a litte • Make comment heads be /** • Make rct2 addresses be double spaced indented • Make there be a space afte rct2: and the address • Make single-line rct2 addresses be full block comments • Move description of method to top of comment
2015-12-11 16:38:37 +01:00
/**
Add get_current_rotation function and DEBUG_LEVEL macros
2015-10-30 11:00:35 +01:00
* Compile-time debug levels.
*
* When compiling, just add -DDEBUG={0,1,2,3} (where 0 means disabled)
* Regardless of DEBUG value, a set of defines will be created:
* - DEBUG_LEVEL_1
* - DEBUG_LEVEL_2
* - DEBUG_LEVEL_3
* which you would use like so:
*
* #if DEBUG_LEVEL_1
* (... some debug code ...)
* #if DEBUG_LEVEL_2
* (... more debug code ...)
* #endif // DEBUG_LEVEL_2
* #endif // DEBUG_LEVEL_1
*
* The defines will be either 0 or 1 so compiler will complain about undefined
* macro if you forget to include the file, which would not happen if we were
* only checking whether the define is present or not.
*/
#if defined(DEBUG)
Expand tabs to spaces This commit expands tabs to spaces (ts=4) in all the files under src/ and test/. Until now we had two wildly different code styles with C using tabs and new C++ using spaces. It is painful to maintain as none of the commonly used tools support this kind of setup and in reality is needless, as we can simply convert all the sources to spaces and have opened PRs do the same, where needed. Additionally, trailing whitespace has been removed.
2017-06-06 23:24:18 +02:00
#if DEBUG > 0
#define DEBUG_LEVEL_1 1
#if DEBUG > 1
#define DEBUG_LEVEL_2 1
#if DEBUG > 2
#define DEBUG_LEVEL_3 1
#else
#define DEBUG_LEVEL_3 0
#endif // DEBUG > 2
#else
#define DEBUG_LEVEL_3 0
#define DEBUG_LEVEL_2 0
#endif // DEBUG > 1
#else
#define DEBUG_LEVEL_1 0
#define DEBUG_LEVEL_2 0
#define DEBUG_LEVEL_3 0
#endif // DEBUG > 0
Add get_current_rotation function and DEBUG_LEVEL macros
2015-10-30 11:00:35 +01:00
#else
Expand tabs to spaces This commit expands tabs to spaces (ts=4) in all the files under src/ and test/. Until now we had two wildly different code styles with C using tabs and new C++ using spaces. It is painful to maintain as none of the commonly used tools support this kind of setup and in reality is needless, as we can simply convert all the sources to spaces and have opened PRs do the same, where needed. Additionally, trailing whitespace has been removed.
2017-06-06 23:24:18 +02:00
#define DEBUG_LEVEL_3 0
#define DEBUG_LEVEL_2 0
#define DEBUG_LEVEL_1 0
Add get_current_rotation function and DEBUG_LEVEL macros
2015-10-30 11:00:35 +01:00
#endif // defined(DEBUG)
Move extern "C" {} blocks to headers (#6282)
2017-09-18 17:05:28 +02:00
extern bool _log_levels[DIAGNOSTIC_LEVEL_COUNT];
Remove and replace C typedefs `typedef struct/union/enum name { ... } name_again;` is not needed whe compiling C++, moving the name at the back to be in front of the object and removing `typedef` makes it usable the very same way. This also replaces typedefs with the using keyword. They have better readability, especially for function pointer types, and would allow more flexibility when used with templates.
2018-02-14 09:42:26 +01:00
void diagnostic_log(DIAGNOSTIC_LEVEL diagnosticLevel, const char *format, ...);
Replace our own integer types with standard ones
2018-06-20 17:28:51 +02:00
void diagnostic_log_with_location(DIAGNOSTIC_LEVEL diagnosticLevel, const char *file, const char *function, int32_t line, const char *format, ...);
add log level check so that --verbose option works
2014-11-21 19:39:56 +01:00
#ifdef _MSC_VER
Expand tabs to spaces This commit expands tabs to spaces (ts=4) in all the files under src/ and test/. Until now we had two wildly different code styles with C using tabs and new C++ using spaces. It is painful to maintain as none of the commonly used tools support this kind of setup and in reality is needless, as we can simply convert all the sources to spaces and have opened PRs do the same, where needed. Additionally, trailing whitespace has been removed.
2017-06-06 23:24:18 +02:00
#define diagnostic_log_macro(level, format, ...) diagnostic_log_with_location(level, __FILE__, __FUNCTION__, __LINE__, format, ## __VA_ARGS__)
add log level check so that --verbose option works
2014-11-21 19:39:56 +01:00
#else
Expand tabs to spaces This commit expands tabs to spaces (ts=4) in all the files under src/ and test/. Until now we had two wildly different code styles with C using tabs and new C++ using spaces. It is painful to maintain as none of the commonly used tools support this kind of setup and in reality is needless, as we can simply convert all the sources to spaces and have opened PRs do the same, where needed. Additionally, trailing whitespace has been removed.
2017-06-06 23:24:18 +02:00
#define diagnostic_log_macro(level, format, ...) diagnostic_log_with_location(level, __FILE__, __func__, __LINE__, format, ## __VA_ARGS__)
Use typedef for diagnostic levels, small refactor
2017-01-04 23:51:50 +01:00
#endif // _MSC_VER
fix GCC errors with diagnostic errors
2014-11-21 20:32:13 +01:00
Expand tabs to spaces This commit expands tabs to spaces (ts=4) in all the files under src/ and test/. Until now we had two wildly different code styles with C using tabs and new C++ using spaces. It is painful to maintain as none of the commonly used tools support this kind of setup and in reality is needless, as we can simply convert all the sources to spaces and have opened PRs do the same, where needed. Additionally, trailing whitespace has been removed.
2017-06-06 23:24:18 +02:00
#define log_fatal(format, ...) diagnostic_log_macro(DIAGNOSTIC_LEVEL_FATAL, format, ## __VA_ARGS__)
#define log_error(format, ...) diagnostic_log_macro(DIAGNOSTIC_LEVEL_ERROR, format, ## __VA_ARGS__)
#define log_warning(format, ...) diagnostic_log_macro(DIAGNOSTIC_LEVEL_WARNING, format, ## __VA_ARGS__)
#define log_verbose(format, ...) diagnostic_log(DIAGNOSTIC_LEVEL_VERBOSE, format, ## __VA_ARGS__)
#define log_info(format, ...) diagnostic_log_macro(DIAGNOSTIC_LEVEL_INFORMATION, format, ## __VA_ARGS__)
fix GCC errors with diagnostic errors
2014-11-21 20:32:13 +01:00
add log level check so that --verbose option works
2014-11-21 19:39:56 +01:00
#endif