asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/core/error_macros.h

539 lines
34 KiB
C++
Raw Normal View History

GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
/*************************************************************************/
/* error_macros.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
Use HTTPS URL for Godot's website in the headers
2017-08-27 14:16:55 +02:00
/* https://godotengine.org */
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
/*************************************************************************/
Update copyright statements to 2021 Happy new year to the wonderful Godot community! 2020 has been a tough year for most of us personally, but a good year for Godot development nonetheless with a huge amount of work done towards Godot 4.0 and great improvements backported to the long-lived 3.2 branch. We've had close to 400 contributors to engine code this year, authoring near 7,000 commit! (And that's only for the `master` branch and for the engine code, there's a lot more when counting docs, demos and other first-party repos.) Here's to a great year 2021 for all Godot users 🎆 (cherry picked from commit b5334d14f7a471f94bcbd64d5bae2ad853d0b7f1)
2021-01-01 20:13:46 +01:00
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-05 00:50:27 +01:00
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
#ifndef ERROR_MACROS_H
#define ERROR_MACROS_H
Modernize atomics - Based on C++11's `atomic` - Reworked `SafeRefCount` (based on the rewrite by @hpvb) - Replaced free atomic functions by the new `SafeNumeric<T>` - Replaced wrong cases of `volatile` by the new `SafeFlag` - Platform-specific implementations no longer needed Co-authored-by: Hein-Pieter van Braam-Stewart <hp@tmm.cx>
2021-01-31 13:34:42 +01:00
#include "core/safe_refcount.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 18:13:45 +02:00
#include "core/typedefs.h"
Modernize atomics - Based on C++11's `atomic` - Reworked `SafeRefCount` (based on the rewrite by @hpvb) - Replaced free atomic functions by the new `SafeNumeric<T>` - Replaced wrong cases of `volatile` by the new `SafeFlag` - Platform-specific implementations no longer needed Co-authored-by: Hein-Pieter van Braam-Stewart <hp@tmm.cx>
2021-01-31 13:34:42 +01:00
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
/**
Fix typos with codespell Found via `codespell -q 3 --skip="./thirdparty,./editor/translations" -I ../godot-word-whitelist.txt` Whitelist consists of: ``` ang doubleclick lod nd que te unselect ```
2018-02-21 17:30:55 +01:00
* Error macros. Unlike exceptions and asserts, these macros try to maintain consistency and stability
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
* inside the code. It is recommended to always return processable data, so in case of an error,
* the engine can keep working well.
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
* In most cases, bugs and/or invalid data are not fatal and should never allow a perfectly running application
* to fail or crash.
*/
remove trailing whitespace
2016-03-09 00:00:52 +01:00
/**
Fix typos with codespell Using codespell 1.15.0. Method: ``` $ cat > ../godot-word-whitelist.txt << EOF ang curvelinear doubleclick leapyear lod merchantibility nd numer ois ony que seeked synching te uint unselect webp EOF $ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po" $ git diff // undo unwanted changes ```
2019-05-19 12:34:40 +02:00
* Pointer to the error macro printing function. Reassign to any function to have errors printed
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
*/
/** Function used by the error macros */
// function, file, line, error, explanation
enum ErrorHandlerType {
ERR_HANDLER_ERROR,
ERR_HANDLER_WARNING,
2D Shaders are working again using the new syntax, though all is buggy in general
2016-10-10 23:31:01 +02:00
ERR_HANDLER_SCRIPT,
ERR_HANDLER_SHADER,
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
};
Remove implicit dependency on String from error_macros.h.
2019-11-06 08:38:23 +01:00
class String;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
typedef void (*ErrorHandlerFunc)(void *, const char *, const char *, int p_line, const char *, const char *, ErrorHandlerType p_type);
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
struct ErrorHandlerList {
ErrorHandlerFunc errfunc;
void *userdata;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
ErrorHandlerList *next;
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
ErrorHandlerList() {
Style: Replaces uses of 0/NULL by nullptr (C++11) Using clang-tidy's `modernize-use-nullptr`. https://clang.llvm.org/extra/clang-tidy/checks/modernize-use-nullptr.html
2021-05-04 16:00:45 +02:00
errfunc = nullptr;
next = nullptr;
userdata = nullptr;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
}
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
};
void add_error_handler(ErrorHandlerList *p_handler);
void remove_error_handler(ErrorHandlerList *p_handler);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
void _err_print_error(const char *p_function, const char *p_file, int p_line, const char *p_error, ErrorHandlerType p_type = ERR_HANDLER_ERROR);
Remove implicit dependency on String from error_macros.h.
2019-11-06 08:38:23 +01:00
void _err_print_error(const char *p_function, const char *p_file, int p_line, const String &p_error, ErrorHandlerType p_type = ERR_HANDLER_ERROR);
Send m_msg directly to _err_print_error().
2019-11-10 07:44:31 +01:00
void _err_print_error(const char *p_function, const char *p_file, int p_line, const char *p_error, const char *p_message, ErrorHandlerType p_type = ERR_HANDLER_ERROR);
void _err_print_error(const char *p_function, const char *p_file, int p_line, const String &p_error, const char *p_message, ErrorHandlerType p_type = ERR_HANDLER_ERROR);
void _err_print_error(const char *p_function, const char *p_file, int p_line, const char *p_error, const String &p_message, ErrorHandlerType p_type = ERR_HANDLER_ERROR);
void _err_print_error(const char *p_function, const char *p_file, int p_line, const String &p_error, const String &p_message, ErrorHandlerType p_type = ERR_HANDLER_ERROR);
void _err_print_index_error(const char *p_function, const char *p_file, int p_line, int64_t p_index, int64_t p_size, const char *p_index_str, const char *p_size_str, const char *p_message = "", bool fatal = false);
void _err_print_index_error(const char *p_function, const char *p_file, int p_line, int64_t p_index, int64_t p_size, const char *p_index_str, const char *p_size_str, const String &p_message, bool fatal = false);
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
#ifndef _STR
#define _STR(m_x) #m_x
#define _MKSTR(m_x) _STR(m_x)
#endif
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
#define _FNL __FILE__ ":"
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Typo fix: "the function exists" -> "the function exits" As far as I can tell, the intended word here is "exits" rather than "exists" but it's not 100% clear. I'm assuming the intention is to express something along the lines of "An index has failed if m_index >=m_size; [if this happens then] the function exits."
2019-03-24 16:02:04 +01:00
/** An index has failed if m_index<0 or m_index >=m_size, the function exits */
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
#ifdef __GNUC__
//#define FUNCTION_STR __PRETTY_FUNCTION__ - too annoying
#define FUNCTION_STR __FUNCTION__
#else
#define FUNCTION_STR __FUNCTION__
#endif
Implement well-defined handling of unrecoverable errors Plus the addition of some convenience CRASH_* error macros. Plus transient avoidance of the flood of warnings emitted by Clang when checking 'this' for NULL. Plus explanation about the do-while(0) loop in some error macros.
2017-05-26 21:11:16 +02:00
// Don't use this directly; instead, use any of the CRASH_* macros
#ifdef _MSC_VER
#define GENERATE_TRAP \
__debugbreak(); \
/* Avoid warning about control paths */ \
for (;;) { \
}
#else
#define GENERATE_TRAP __builtin_trap();
#endif
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
// Used to strip debug messages in release mode
#ifdef DEBUG_ENABLED
#define DEBUG_STR(m_msg) m_msg
#else
#define DEBUG_STR(m_msg) ""
#endif
Implement well-defined handling of unrecoverable errors Plus the addition of some convenience CRASH_* error macros. Plus transient avoidance of the flood of warnings emitted by Clang when checking 'this' for NULL. Plus explanation about the do-while(0) loop in some error macros.
2017-05-26 21:11:16 +02:00
// (*): See https://stackoverflow.com/questions/257418/do-while-0-what-is-it-good-for
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_index` is less than 0 or greater than or equal to `m_size`, prints a generic
* error message and returns from the function. This macro should be preferred to
* `ERR_FAIL_COND` for bounds checking.
*/
Improved *_FAIL_INDEX error macros to print the index/size
2017-10-17 16:37:40 +02:00
#define ERR_FAIL_INDEX(m_index, m_size) \
do { \
if (unlikely((m_index) < 0 || (m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size)); \
return; \
Some code changed with Clang-Tidy
2019-06-26 15:08:25 +02:00
} \
Implement well-defined handling of unrecoverable errors Plus the addition of some convenience CRASH_* error macros. Plus transient avoidance of the flood of warnings emitted by Clang when checking 'this' for NULL. Plus explanation about the do-while(0) loop in some error macros.
2017-05-26 21:11:16 +02:00
} while (0); // (*)
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_index` is less than 0 or greater than or equal to `m_size`, prints a custom
* error message and returns from the function. This macro should be preferred to
* `ERR_FAIL_COND_MSG` for bounds checking.
*/
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
#define ERR_FAIL_INDEX_MSG(m_index, m_size, m_msg) \
do { \
if (unlikely((m_index) < 0 || (m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size), DEBUG_STR(m_msg)); \
return; \
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
} while (0); // (*)
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_index` is less than 0 or greater than or equal to `m_size`,
* prints a generic error message and returns the value specified in `m_retval`.
* This macro should be preferred to `ERR_FAIL_COND_V` for bounds checking.
*/
Improved *_FAIL_INDEX error macros to print the index/size
2017-10-17 16:37:40 +02:00
#define ERR_FAIL_INDEX_V(m_index, m_size, m_retval) \
do { \
if (unlikely((m_index) < 0 || (m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size)); \
return m_retval; \
Some code changed with Clang-Tidy
2019-06-26 15:08:25 +02:00
} \
Implement well-defined handling of unrecoverable errors Plus the addition of some convenience CRASH_* error macros. Plus transient avoidance of the flood of warnings emitted by Clang when checking 'this' for NULL. Plus explanation about the do-while(0) loop in some error macros.
2017-05-26 21:11:16 +02:00
} while (0); // (*)
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_index` is less than 0 or greater than or equal to `m_size`,
* prints a custom error message and returns the value specified in `m_retval`.
* This macro should be preferred to `ERR_FAIL_COND_V_MSG` for bounds checking.
*/
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
#define ERR_FAIL_INDEX_V_MSG(m_index, m_size, m_retval, m_msg) \
do { \
if (unlikely((m_index) < 0 || (m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size), DEBUG_STR(m_msg)); \
return m_retval; \
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
} while (0); // (*)
Fix issues related to delay when processing events on Linux 3.2 backport of PR #41910: Fix general keyboard input lag on X11 display server Fix delay to process clipboard content from Godot in other programs
2020-09-25 18:16:39 +02:00
/**
* If `m_index` is greater than or equal to `m_size`,
* prints a generic error message and returns the value specified in `m_retval`.
* This macro should be preferred to `ERR_FAIL_COND_V` for unsigned bounds checking.
*/
#define ERR_FAIL_UNSIGNED_INDEX(m_index, m_size) \
do { \
if (unlikely((m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size)); \
return; \
} \
} while (0); // (*)
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_index` is greater than or equal to `m_size`,
* prints a generic error message and returns the value specified in `m_retval`.
* This macro should be preferred to `ERR_FAIL_COND_V` for unsigned bounds checking.
*/
Fix all -Wtype-limits warnings.
2019-02-20 21:59:03 +01:00
#define ERR_FAIL_UNSIGNED_INDEX_V(m_index, m_size, m_retval) \
do { \
if (unlikely((m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size)); \
return m_retval; \
Some code changed with Clang-Tidy
2019-06-26 15:08:25 +02:00
} \
Fix all -Wtype-limits warnings.
2019-02-20 21:59:03 +01:00
} while (0); // (*)
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_index` is greater than or equal to `m_size`,
* prints a custom error message and returns the value specified in `m_retval`.
* This macro should be preferred to `ERR_FAIL_COND_V_MSG` for unsigned bounds checking.
*/
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
#define ERR_FAIL_UNSIGNED_INDEX_V_MSG(m_index, m_size, m_retval, m_msg) \
do { \
if (unlikely((m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size), DEBUG_STR(m_msg)); \
return m_retval; \
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
} while (0); // (*)
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_index` is less than 0 or greater than or equal to `m_size`,
* crashes the engine immediately with a generic error message.
* Only use this if there's no sensible fallback (i.e. the error is unrecoverable).
* This macro should be preferred to `CRASH_COND` for bounds checking.
*/
Send m_msg directly to _err_print_error().
2019-11-10 07:44:31 +01:00
#define CRASH_BAD_INDEX(m_index, m_size) \
do { \
if (unlikely((m_index) < 0 || (m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size), "", true); \
GENERATE_TRAP \
} \
Implement well-defined handling of unrecoverable errors Plus the addition of some convenience CRASH_* error macros. Plus transient avoidance of the flood of warnings emitted by Clang when checking 'this' for NULL. Plus explanation about the do-while(0) loop in some error macros.
2017-05-26 21:11:16 +02:00
} while (0); // (*)
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_index` is less than 0 or greater than or equal to `m_size`,
* crashes the engine immediately with a custom error message.
* Only use this if there's no sensible fallback (i.e. the error is unrecoverable).
* This macro should be preferred to `CRASH_COND` for bounds checking.
*/
Send m_msg directly to _err_print_error().
2019-11-10 07:44:31 +01:00
#define CRASH_BAD_INDEX_MSG(m_index, m_size, m_msg) \
do { \
if (unlikely((m_index) < 0 || (m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size), m_msg, true); \
GENERATE_TRAP \
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
} while (0); // (*)
Fix issues related to delay when processing events on Linux 3.2 backport of PR #41910: Fix general keyboard input lag on X11 display server Fix delay to process clipboard content from Godot in other programs
2020-09-25 18:16:39 +02:00
/**
* If `m_index` is greater than or equal to `m_size`,
* crashes the engine immediately with a generic error message.
* Only use this if there's no sensible fallback (i.e. the error is unrecoverable).
* This macro should be preferred to `CRASH_COND` for bounds checking.
*/
#define CRASH_BAD_UNSIGNED_INDEX(m_index, m_size) \
do { \
if (unlikely((m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size), "", true); \
GENERATE_TRAP \
} \
} while (0); // (*)
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_param` is `null`, prints a generic error message and returns from the function.
*/
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
#define ERR_FAIL_NULL(m_param) \
{ \
Implement Linux-style likely()/unlikely() macros This implement branch prediction macros likely() and unlikely() like in Linux. When using these macros please ensure that when you use them the condition in the branch really is very, very likely or unlikely. Think 90+% of the time. Primarily useful for error checking. (And I implement these macros for all our error checking macros now) See this article for more information: https://kernelnewbies.org/FAQ/LikelyUnlikely There are more places where these macros may make sense in renderer and physics engine. Placing them will come in another commit down the line.
2017-09-20 11:04:50 +02:00
if (unlikely(!m_param)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter \"" _STR(m_param) "\" is null."); \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
return; \
Some code changed with Clang-Tidy
2019-06-26 15:08:25 +02:00
} \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_param` is `null`, prints a custom error message and returns from the function.
*/
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
#define ERR_FAIL_NULL_MSG(m_param, m_msg) \
{ \
if (unlikely(!m_param)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter \"" _STR(m_param) "\" is null.", DEBUG_STR(m_msg)); \
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
return; \
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_param` is `null`, prints a generic error message and returns the value specified in `m_retval`.
*/
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
#define ERR_FAIL_NULL_V(m_param, m_retval) \
{ \
Implement Linux-style likely()/unlikely() macros This implement branch prediction macros likely() and unlikely() like in Linux. When using these macros please ensure that when you use them the condition in the branch really is very, very likely or unlikely. Think 90+% of the time. Primarily useful for error checking. (And I implement these macros for all our error checking macros now) See this article for more information: https://kernelnewbies.org/FAQ/LikelyUnlikely There are more places where these macros may make sense in renderer and physics engine. Placing them will come in another commit down the line.
2017-09-20 11:04:50 +02:00
if (unlikely(!m_param)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter \"" _STR(m_param) "\" is null."); \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
return m_retval; \
Some code changed with Clang-Tidy
2019-06-26 15:08:25 +02:00
} \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
}
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_param` is `null`, prints a custom error message and returns the value specified in `m_retval`.
*/
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
#define ERR_FAIL_NULL_V_MSG(m_param, m_retval, m_msg) \
{ \
if (unlikely(!m_param)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter \"" _STR(m_param) "\" is null.", DEBUG_STR(m_msg)); \
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
return m_retval; \
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_cond` evaluates to `true`, prints a generic error message and returns from the function.
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
*/
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
#define ERR_FAIL_COND(m_cond) \
{ \
Implement Linux-style likely()/unlikely() macros This implement branch prediction macros likely() and unlikely() like in Linux. When using these macros please ensure that when you use them the condition in the branch really is very, very likely or unlikely. Think 90+% of the time. Primarily useful for error checking. (And I implement these macros for all our error checking macros now) See this article for more information: https://kernelnewbies.org/FAQ/LikelyUnlikely There are more places where these macros may make sense in renderer and physics engine. Placing them will come in another commit down the line.
2017-09-20 11:04:50 +02:00
if (unlikely(m_cond)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true."); \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
return; \
Some code changed with Clang-Tidy
2019-06-26 15:08:25 +02:00
} \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
}
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_cond` evaluates to `true`, prints a custom error message and returns from the function.
*/
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
#define ERR_FAIL_COND_MSG(m_cond, m_msg) \
{ \
if (unlikely(m_cond)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true.", DEBUG_STR(m_msg)); \
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
return; \
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_cond` evaluates to `true`, crashes the engine immediately with a generic error message.
* Only use this if there's no sensible fallback (i.e. the error is unrecoverable).
Implement well-defined handling of unrecoverable errors Plus the addition of some convenience CRASH_* error macros. Plus transient avoidance of the flood of warnings emitted by Clang when checking 'this' for NULL. Plus explanation about the do-while(0) loop in some error macros.
2017-05-26 21:11:16 +02:00
*/
#define CRASH_COND(m_cond) \
{ \
Implement Linux-style likely()/unlikely() macros This implement branch prediction macros likely() and unlikely() like in Linux. When using these macros please ensure that when you use them the condition in the branch really is very, very likely or unlikely. Think 90+% of the time. Primarily useful for error checking. (And I implement these macros for all our error checking macros now) See this article for more information: https://kernelnewbies.org/FAQ/LikelyUnlikely There are more places where these macros may make sense in renderer and physics engine. Placing them will come in another commit down the line.
2017-09-20 11:04:50 +02:00
if (unlikely(m_cond)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "FATAL: Condition \"" _STR(m_cond) "\" is true."); \
Implement well-defined handling of unrecoverable errors Plus the addition of some convenience CRASH_* error macros. Plus transient avoidance of the flood of warnings emitted by Clang when checking 'this' for NULL. Plus explanation about the do-while(0) loop in some error macros.
2017-05-26 21:11:16 +02:00
GENERATE_TRAP \
} \
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_cond` evaluates to `true`, crashes the engine immediately with a custom error message.
* Only use this if there's no sensible fallback (i.e. the error is unrecoverable).
*/
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
#define CRASH_COND_MSG(m_cond, m_msg) \
{ \
if (unlikely(m_cond)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "FATAL: Condition \"" _STR(m_cond) "\" is true.", DEBUG_STR(m_msg)); \
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
GENERATE_TRAP \
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_cond` evaluates to `true`, prints a generic error message and returns the value specified in `m_retval`.
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
*/
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
#define ERR_FAIL_COND_V(m_cond, m_retval) \
{ \
Implement Linux-style likely()/unlikely() macros This implement branch prediction macros likely() and unlikely() like in Linux. When using these macros please ensure that when you use them the condition in the branch really is very, very likely or unlikely. Think 90+% of the time. Primarily useful for error checking. (And I implement these macros for all our error checking macros now) See this article for more information: https://kernelnewbies.org/FAQ/LikelyUnlikely There are more places where these macros may make sense in renderer and physics engine. Placing them will come in another commit down the line.
2017-09-20 11:04:50 +02:00
if (unlikely(m_cond)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Returned: " _STR(m_retval)); \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
return m_retval; \
Some code changed with Clang-Tidy
2019-06-26 15:08:25 +02:00
} \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
}
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_cond` evaluates to `true`, prints a custom error message and returns the value specified in `m_retval`.
*/
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
#define ERR_FAIL_COND_V_MSG(m_cond, m_retval, m_msg) \
{ \
if (unlikely(m_cond)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Returned: " _STR(m_retval), DEBUG_STR(m_msg)); \
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
return m_retval; \
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_cond` evaluates to `true`, prints a custom error message and continues the loop the macro is located in.
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
*/
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
#define ERR_CONTINUE(m_cond) \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
{ \
Implement Linux-style likely()/unlikely() macros This implement branch prediction macros likely() and unlikely() like in Linux. When using these macros please ensure that when you use them the condition in the branch really is very, very likely or unlikely. Think 90+% of the time. Primarily useful for error checking. (And I implement these macros for all our error checking macros now) See this article for more information: https://kernelnewbies.org/FAQ/LikelyUnlikely There are more places where these macros may make sense in renderer and physics engine. Placing them will come in another commit down the line.
2017-09-20 11:04:50 +02:00
if (unlikely(m_cond)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Continuing."); \
continue; \
Some code changed with Clang-Tidy
2019-06-26 15:08:25 +02:00
} \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
}
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_cond` evaluates to `true`, prints a custom error message and continues the loop the macro is located in.
*/
#define ERR_CONTINUE_MSG(m_cond, m_msg) \
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
{ \
if (unlikely(m_cond)) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Continuing.", DEBUG_STR(m_msg)); \
continue; \
Fix explain message not being stripped in release. Messages coming from ERR_EXPLAIN / ERR_*_MSG macros used to strip the error explanation in release builds and was changed in a recent refactoring. This commit restores the old behaviour (fixing release builds).
2019-11-13 14:07:54 +01:00
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_cond` evaluates to `true`, prints a generic error message and breaks from the loop the macro is located in.
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
*/
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
#define ERR_BREAK(m_cond) \
{ \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Breaking."); \
break; \
} \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
}
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* If `m_cond` evaluates to `true`, prints a custom error message and breaks from the loop the macro is located in.
*/
#define ERR_BREAK_MSG(m_cond, m_msg) \
{ \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Breaking.", DEBUG_STR(m_msg)); \
break; \
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Prints a generic error message and returns from the function.
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
*/
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
#define ERR_FAIL() \
{ \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Method failed."); \
return; \
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
}
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Prints a custom error message and returns from the function.
*/
#define ERR_FAIL_MSG(m_msg) \
{ \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Method failed.", DEBUG_STR(m_msg)); \
return; \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Prints a generic error message and returns the value specified in `m_retval`.
Implement well-defined handling of unrecoverable errors Plus the addition of some convenience CRASH_* error macros. Plus transient avoidance of the flood of warnings emitted by Clang when checking 'this' for NULL. Plus explanation about the do-while(0) loop in some error macros.
2017-05-26 21:11:16 +02:00
*/
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
#define ERR_FAIL_V(m_retval) \
{ \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Method failed. Returning: " __STR(m_retval)); \
return m_retval; \
}
Implement well-defined handling of unrecoverable errors Plus the addition of some convenience CRASH_* error macros. Plus transient avoidance of the flood of warnings emitted by Clang when checking 'this' for NULL. Plus explanation about the do-while(0) loop in some error macros.
2017-05-26 21:11:16 +02:00
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Prints a custom error message and returns the value specified in `m_retval`.
*/
#define ERR_FAIL_V_MSG(m_retval, m_msg) \
{ \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Method failed. Returning: " __STR(m_retval), DEBUG_STR(m_msg)); \
return m_retval; \
Implement well-defined handling of unrecoverable errors Plus the addition of some convenience CRASH_* error macros. Plus transient avoidance of the flood of warnings emitted by Clang when checking 'this' for NULL. Plus explanation about the do-while(0) loop in some error macros.
2017-05-26 21:11:16 +02:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Crashes the engine immediately with a generic error message.
* Only use this if there's no sensible fallback (i.e. the error is unrecoverable).
*/
#define CRASH_NOW() \
{ \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "FATAL: Method failed."); \
GENERATE_TRAP \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Crashes the engine immediately with a custom error message.
* Only use this if there's no sensible fallback (i.e. the error is unrecoverable).
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
*/
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
#define CRASH_NOW_MSG(m_msg) \
{ \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "FATAL: Method failed.", DEBUG_STR(m_msg)); \
GENERATE_TRAP \
}
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Prints an error message without returning.
*/
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
#define ERR_PRINT(m_string) \
{ \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_string); \
}
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Prints an error message without returning, but only do so once in the application lifecycle.
* This can be used to avoid spamming the console with error messages.
*/
Clean up blend shape support in GLES2 and GLES3.
2019-03-01 20:01:21 +01:00
#define ERR_PRINT_ONCE(m_string) \
{ \
static bool first_print = true; \
if (first_print) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_string); \
first_print = false; \
} \
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Prints a warning message without returning. To warn about deprecated usage,
* use `WARN_DEPRECATED` or `WARN_DEPRECATED_MSG` instead.
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
*/
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
#define WARN_PRINT(m_string) \
{ \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_string, ERR_HANDLER_WARNING); \
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Prints a warning message without returning, but only do so once in the application lifecycle.
* This can be used to avoid spamming the console with warning messages.
*/
Clean up blend shape support in GLES2 and GLES3.
2019-03-01 20:01:21 +01:00
#define WARN_PRINT_ONCE(m_string) \
{ \
static bool first_print = true; \
if (first_print) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_string, ERR_HANDLER_WARNING); \
first_print = false; \
} \
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Prints a generic deprecation warning message without returning.
* This should be preferred to `WARN_PRINT` for deprecation warnings.
*/
#define WARN_DEPRECATED \
{ \
Modernize atomics - Based on C++11's `atomic` - Reworked `SafeRefCount` (based on the rewrite by @hpvb) - Replaced free atomic functions by the new `SafeNumeric<T>` - Replaced wrong cases of `volatile` by the new `SafeFlag` - Platform-specific implementations no longer needed Co-authored-by: Hein-Pieter van Braam-Stewart <hp@tmm.cx>
2021-01-31 13:34:42 +01:00
static SafeFlag warning_shown; \
if (!warning_shown.is_set()) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "This method has been deprecated and will be removed in the future.", ERR_HANDLER_WARNING); \
Modernize atomics - Based on C++11's `atomic` - Reworked `SafeRefCount` (based on the rewrite by @hpvb) - Replaced free atomic functions by the new `SafeNumeric<T>` - Replaced wrong cases of `volatile` by the new `SafeFlag` - Platform-specific implementations no longer needed Co-authored-by: Hein-Pieter van Braam-Stewart <hp@tmm.cx>
2021-01-31 13:34:42 +01:00
warning_shown.set(); \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
} \
Add a macro to deprecate methods
2018-04-18 14:10:25 +02:00
}
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
/**
* Prints a custom deprecation warning message without returning.
* This should be preferred to `WARN_PRINT` for deprecation warnings.
*/
#define WARN_DEPRECATED_MSG(m_msg) \
{ \
Modernize atomics - Based on C++11's `atomic` - Reworked `SafeRefCount` (based on the rewrite by @hpvb) - Replaced free atomic functions by the new `SafeNumeric<T>` - Replaced wrong cases of `volatile` by the new `SafeFlag` - Platform-specific implementations no longer needed Co-authored-by: Hein-Pieter van Braam-Stewart <hp@tmm.cx>
2021-01-31 13:34:42 +01:00
static SafeFlag warning_shown; \
if (!warning_shown.is_set()) { \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "This method has been deprecated and will be removed in the future.", m_msg, ERR_HANDLER_WARNING); \
Modernize atomics - Based on C++11's `atomic` - Reworked `SafeRefCount` (based on the rewrite by @hpvb) - Replaced free atomic functions by the new `SafeNumeric<T>` - Replaced wrong cases of `volatile` by the new `SafeFlag` - Platform-specific implementations no longer needed Co-authored-by: Hein-Pieter van Braam-Stewart <hp@tmm.cx>
2021-01-31 13:34:42 +01:00
warning_shown.set(); \
Improve and document error macros Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
2020-01-24 16:53:52 +01:00
} \
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 17:00:50 +02:00
}
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
#endif
Reference in a new issue Copy permalink