godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/core/error/error_macros.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

805 lines
48 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* error_macros.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* 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-04 23:50:27 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifndef ERROR_MACROS_H
#define ERROR_MACROS_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 16:13:45 +00:00
#include "core/typedefs.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Prevent misuse of SafeRefCount
2023-01-09 09:15:35 +00:00
#include <atomic> // We'd normally use safe_refcount.h, but that would cause circular includes.
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 bool` by the new `SafeFlag` - Platform-specific implementations no longer needed Co-authored-by: Hein-Pieter van Braam-Stewart <hp@tmm.cx>
2021-02-10 18:22:13 +00:00
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
class String;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
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 21:31:01 +00:00
ERR_HANDLER_SCRIPT,
ERR_HANDLER_SHADER,
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
// Pointer to the error handler printing function. Reassign to any function to have errors printed.
// Parameters: userdata, function, file, line, error, explanation, type.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
typedef void (*ErrorHandlerFunc)(void *, const char *, const char *, int p_line, const char *, const char *, bool p_editor_notify, ErrorHandlerType p_type);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
struct ErrorHandlerList {
Port member initialization from constructor to declaration (C++11) Using `clang-tidy`'s `modernize-use-default-member-init` check and manual review of the changes, and some extra manual changes that `clang-tidy` failed to do. Also went manually through all of `core` to find occurrences that `clang-tidy` couldn't handle, especially all initializations done in a constructor without using initializer lists.
2020-05-12 15:01:17 +00:00
ErrorHandlerFunc errfunc = nullptr;
void *userdata = nullptr;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Port member initialization from constructor to declaration (C++11) Using `clang-tidy`'s `modernize-use-default-member-init` check and manual review of the changes, and some extra manual changes that `clang-tidy` failed to do. Also went manually through all of `core` to find occurrences that `clang-tidy` couldn't handle, especially all initializations done in a constructor without using initializer lists.
2020-05-12 15:01:17 +00:00
ErrorHandlerList *next = nullptr;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Port member initialization from constructor to declaration (C++11) Using `clang-tidy`'s `modernize-use-default-member-init` check and manual review of the changes, and some extra manual changes that `clang-tidy` failed to do. Also went manually through all of `core` to find occurrences that `clang-tidy` couldn't handle, especially all initializations done in a constructor without using initializer lists.
2020-05-12 15:01:17 +00:00
ErrorHandlerList() {}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
void add_error_handler(ErrorHandlerList *p_handler);
Fix some issues found by cppcheck.
2022-04-05 10:40:26 +00:00
void remove_error_handler(const ErrorHandlerList *p_handler);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
// Functions used by the error macros.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
void _err_print_error(const char *p_function, const char *p_file, int p_line, const char *p_error, bool p_editor_notify = false, 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, bool p_editor_notify = false, 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 char *p_message, bool p_editor_notify = false, 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, bool p_editor_notify = false, 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, bool p_editor_notify = false, 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, bool p_editor_notify = false, 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 p_editor_notify = false, 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 p_editor_notify = false, bool fatal = false);
Add fflush to error macros CRASH_NOW macros would previously crash before outputting any error messages. This PR ensures calling fflush for stdout before terminating.
2022-02-05 12:31:54 +00:00
void _err_flush_stdout();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00: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 19:11:16 +00:00
#ifdef _MSC_VER
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Don't use GENERATE_TRAP() directly, should only be used be the macros below.
*/
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
#define GENERATE_TRAP() __debugbreak()
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 19:11:16 +00:00
#else
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Don't use GENERATE_TRAP() directly, should only be used be the macros below.
*/
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
#define GENERATE_TRAP() __builtin_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 19:11:16 +00:00
#endif
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 15:53:52 +00:00
/**
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
* Error macros.
* WARNING: These macros work in the opposite way to assert().
*
* Unlike exceptions and asserts, these macros try to maintain consistency and stability.
* In most cases, bugs and/or invalid data are not fatal. They should never allow a perfectly
* running application to fail or crash.
* Always try to return processable data, so the engine can keep running well.
* Use the _MSG versions to print a meaningful message to help with debugging.
Error macros: Improve style of error messages Document why the `if (1) {} else ((void)0)` construct is used.
2020-05-15 15:48:09 +00:00
*
* The `((void)0)` no-op statement is used as a trick to force us to put a semicolon after
* those macros, making them look like proper statements.
* The if wrappers are used to ensure that the macro replacement does not trigger unexpected
* issues when expanded e.g. after an `if (cond) ERR_FAIL();` without braces.
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 15:53:52 +00:00
*/
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
// Index out of bounds error macros.
// These macros should be used instead of `ERR_FAIL_COND` for bounds checking.
// Integer index out of bounds error macros.
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_INDEX_MSG`.
* Only use this macro if there is no sensible error message.
*
* Ensures an integer index `m_index` is less than `m_size` and greater than or equal to 0.
* If not, the current function returns.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
#define ERR_FAIL_INDEX(m_index, m_size) \
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; \
} else \
((void)0)
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Ensures an integer index `m_index` is less than `m_size` and greater than or equal to 0.
* If not, prints `m_msg` and the current function returns.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define ERR_FAIL_INDEX_MSG(m_index, m_size, m_msg) \
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); \
return; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_FAIL_INDEX_MSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_FAIL_INDEX_EDMSG(m_index, m_size, m_msg) \
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); \
return; \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_INDEX_V_MSG`.
* Only use this macro if there is no sensible error message.
*
* Ensures an integer index `m_index` is less than `m_size` and greater than or equal to 0.
* If not, the current function returns `m_retval`.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
#define ERR_FAIL_INDEX_V(m_index, m_size, m_retval) \
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; \
} else \
((void)0)
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 19:11:16 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Ensures an integer index `m_index` is less than `m_size` and greater than or equal to 0.
* If not, prints `m_msg` and the current function returns `m_retval`.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define ERR_FAIL_INDEX_V_MSG(m_index, m_size, m_retval, m_msg) \
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); \
return m_retval; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_FAIL_INDEX_V_MSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_FAIL_INDEX_V_EDMSG(m_index, m_size, m_retval, m_msg) \
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); \
return m_retval; \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_INDEX_MSG` or `ERR_FAIL_INDEX_V_MSG`.
* Only use this macro if there is no sensible fallback i.e. the error is unrecoverable, and
* there is no sensible error message.
*
* Ensures an integer index `m_index` is less than `m_size` and greater than or equal to 0.
* If not, the application crashes.
*/
Fix incorrect index error macros
2023-01-22 11:23:56 +00:00
#define CRASH_BAD_INDEX(m_index, m_size) \
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), "", false, true); \
_err_flush_stdout(); \
GENERATE_TRAP(); \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_INDEX_MSG` or `ERR_FAIL_INDEX_V_MSG`.
* Only use this macro if there is no sensible fallback i.e. the error is unrecoverable.
*
* Ensures an integer index `m_index` is less than `m_size` and greater than or equal to 0.
* If not, prints `m_msg` and the application crashes.
*/
Fix incorrect index error macros
2023-01-22 11:23:56 +00:00
#define CRASH_BAD_INDEX_MSG(m_index, m_size, m_msg) \
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, false, true); \
_err_flush_stdout(); \
GENERATE_TRAP(); \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
// Unsigned integer index out of bounds error macros.
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_UNSIGNED_INDEX_MSG`.
* Only use this macro if there is no sensible error message.
*
* Ensures an unsigned integer index `m_index` is less than `m_size`.
* If not, the current function returns.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
#define ERR_FAIL_UNSIGNED_INDEX(m_index, m_size) \
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; \
} else \
((void)0)
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Ensures an unsigned integer index `m_index` is less than `m_size`.
* If not, prints `m_msg` and the current function returns.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define ERR_FAIL_UNSIGNED_INDEX_MSG(m_index, m_size, m_msg) \
if (unlikely((m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size), m_msg); \
return; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_FAIL_UNSIGNED_INDEX_MSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_FAIL_UNSIGNED_INDEX_EDMSG(m_index, m_size, m_msg) \
if (unlikely((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); \
return; \
} else \
((void)0)
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_UNSIGNED_INDEX_V_MSG`.
* Only use this macro if there is no sensible error message.
*
* Ensures an unsigned integer index `m_index` is less than `m_size`.
* If not, the current function returns `m_retval`.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
#define ERR_FAIL_UNSIGNED_INDEX_V(m_index, m_size, m_retval) \
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; \
} else \
((void)0)
Fix all -Wtype-limits warnings.
2019-02-20 20:59:03 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Ensures an unsigned integer index `m_index` is less than `m_size`.
* If not, prints `m_msg` and the current function returns `m_retval`.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define ERR_FAIL_UNSIGNED_INDEX_V_MSG(m_index, m_size, m_retval, m_msg) \
if (unlikely((m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size), m_msg); \
return m_retval; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 15:00:50 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_FAIL_UNSIGNED_INDEX_V_EDMSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_FAIL_UNSIGNED_INDEX_V_EDMSG(m_index, m_size, m_retval, m_msg) \
if (unlikely((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); \
return m_retval; \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_UNSIGNED_INDEX_MSG` or `ERR_FAIL_UNSIGNED_INDEX_V_MSG`.
* Only use this macro if there is no sensible fallback i.e. the error is unrecoverable, and
* there is no sensible error message.
*
* Ensures an unsigned integer index `m_index` is less than `m_size`.
* If not, the application crashes.
*/
Fix incorrect index error macros
2023-01-22 11:23:56 +00:00
#define CRASH_BAD_UNSIGNED_INDEX(m_index, m_size) \
if (unlikely((m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size), "", false, true); \
_err_flush_stdout(); \
GENERATE_TRAP(); \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_UNSIGNED_INDEX_MSG` or `ERR_FAIL_UNSIGNED_INDEX_V_MSG`.
* Only use this macro if there is no sensible fallback i.e. the error is unrecoverable.
*
* Ensures an unsigned integer index `m_index` is less than `m_size`.
* If not, prints `m_msg` and the application crashes.
*/
Fix incorrect index error macros
2023-01-22 11:23:56 +00:00
#define CRASH_BAD_UNSIGNED_INDEX_MSG(m_index, m_size, m_msg) \
if (unlikely((m_index) >= (m_size))) { \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size), m_msg, false, true); \
_err_flush_stdout(); \
GENERATE_TRAP(); \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
// Null reference error macros.
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 15:00:50 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_NULL_MSG`.
* Only use this macro if there is no sensible error message.
*
* Ensures a pointer `m_param` is not null.
* If it is null, the current function returns.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
#define ERR_FAIL_NULL(m_param) \
Check pointers against nullptr.
2020-06-12 18:37:47 +00:00
if (unlikely(m_param == nullptr)) { \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter \"" _STR(m_param) "\" is null."); \
return; \
} else \
((void)0)
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 15:44:50 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Ensures a pointer `m_param` is not null.
* If it is null, prints `m_msg` and the current function returns.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define ERR_FAIL_NULL_MSG(m_param, m_msg) \
if (unlikely(m_param == nullptr)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter \"" _STR(m_param) "\" is null.", m_msg); \
return; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 15:00:50 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_FAIL_NULL_MSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_FAIL_NULL_EDMSG(m_param, m_msg) \
if (unlikely(m_param == nullptr)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter \"" _STR(m_param) "\" is null.", m_msg, true); \
return; \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_NULL_V_MSG`.
* Only use this macro if there is no sensible error message.
*
* Ensures a pointer `m_param` is not null.
* If it is null, the current function returns `m_retval`.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
#define ERR_FAIL_NULL_V(m_param, m_retval) \
Check pointers against nullptr.
2020-06-12 18:37:47 +00:00
if (unlikely(m_param == nullptr)) { \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter \"" _STR(m_param) "\" is null."); \
return m_retval; \
} else \
((void)0)
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Ensures a pointer `m_param` is not null.
* If it is null, prints `m_msg` and the current function returns `m_retval`.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define ERR_FAIL_NULL_V_MSG(m_param, m_retval, m_msg) \
if (unlikely(m_param == nullptr)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter \"" _STR(m_param) "\" is null.", m_msg); \
return m_retval; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 15:00:50 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_FAIL_NULL_V_MSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_FAIL_NULL_V_EDMSG(m_param, m_retval, m_msg) \
if (unlikely(m_param == nullptr)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter \"" _STR(m_param) "\" is null.", m_msg, true); \
return m_retval; \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_COND_MSG`.
* Only use this macro if there is no sensible error message.
* If checking for null use ERR_FAIL_NULL_MSG instead.
* If checking index bounds use ERR_FAIL_INDEX_MSG instead.
*
* Ensures `m_cond` is false.
* If `m_cond` is true, the current function returns.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
#define ERR_FAIL_COND(m_cond) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true."); \
return; \
} else \
((void)0)
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Ensures `m_cond` is false.
* If `m_cond` is true, prints `m_msg` and the current function returns.
*
* If checking for null use ERR_FAIL_NULL_MSG instead.
* If checking index bounds use ERR_FAIL_INDEX_MSG instead.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define ERR_FAIL_COND_MSG(m_cond, m_msg) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true.", m_msg); \
return; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 15:00:50 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_FAIL_COND_MSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_FAIL_COND_EDMSG(m_cond, m_msg) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true.", m_msg, true); \
return; \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_COND_V_MSG`.
* Only use this macro if there is no sensible error message.
* If checking for null use ERR_FAIL_NULL_V_MSG instead.
* If checking index bounds use ERR_FAIL_INDEX_V_MSG instead.
*
* Ensures `m_cond` is false.
* If `m_cond` is true, the current function returns `m_retval`.
*/
Error macros: Improve style of error messages Document why the `if (1) {} else ((void)0)` construct is used.
2020-05-15 15:48:09 +00:00
#define ERR_FAIL_COND_V(m_cond, m_retval) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Returning: " _STR(m_retval)); \
return m_retval; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Ensures `m_cond` is false.
* If `m_cond` is true, prints `m_msg` and the current function returns `m_retval`.
*
* If checking for null use ERR_FAIL_NULL_V_MSG instead.
* If checking index bounds use ERR_FAIL_INDEX_V_MSG instead.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define ERR_FAIL_COND_V_MSG(m_cond, m_retval, m_msg) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Returning: " _STR(m_retval), m_msg); \
return m_retval; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 15:00:50 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_FAIL_COND_V_MSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_FAIL_COND_V_EDMSG(m_cond, m_retval, m_msg) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Returning: " _STR(m_retval), m_msg, true); \
return m_retval; \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_CONTINUE_MSG`.
* Only use this macro if there is no sensible error message.
*
* Ensures `m_cond` is false.
* If `m_cond` is true, the current loop continues.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
#define ERR_CONTINUE(m_cond) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Continuing."); \
continue; \
} else \
((void)0)
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Ensures `m_cond` is false.
* If `m_cond` is true, prints `m_msg` and the current loop continues.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define ERR_CONTINUE_MSG(m_cond, m_msg) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Continuing.", m_msg); \
continue; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 15:00:50 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_CONTINUE_MSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_CONTINUE_EDMSG(m_cond, m_msg) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Continuing.", m_msg, true); \
continue; \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_BREAK_MSG`.
* Only use this macro if there is no sensible error message.
*
* Ensures `m_cond` is false.
* If `m_cond` is true, the current loop breaks.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00: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; \
} else \
((void)0)
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Ensures `m_cond` is false.
* If `m_cond` is true, prints `m_msg` and the current loop breaks.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#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.", m_msg); \
break; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 15:00:50 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_BREAK_MSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_BREAK_EDMSG(m_cond, m_msg) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition \"" _STR(m_cond) "\" is true. Breaking.", m_msg, true); \
break; \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_COND_MSG` or `ERR_FAIL_COND_V_MSG`.
* Only use this macro if there is no sensible fallback i.e. the error is unrecoverable, and
* there is no sensible error message.
*
* Ensures `m_cond` is false.
* If `m_cond` is true, the application crashes.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
#define CRASH_COND(m_cond) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "FATAL: Condition \"" _STR(m_cond) "\" is true."); \
Protection for array operator for Vector2 / 3 in DEV builds A previous PR had changed the array operator to give unbounded access. This could cause crashes where old code depended on this previous safe behaviour. This PR adds DEV_ASSERT macros for out of bound access to DEV builds, allowing us to quickly identify bugs in calling code, without affecting performance in release or release_debug editor builds.
2022-03-07 11:15:45 +00:00
_err_flush_stdout(); \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
GENERATE_TRAP(); \
} else \
((void)0)
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_COND_MSG` or `ERR_FAIL_COND_V_MSG`.
* Only use this macro if there is no sensible fallback i.e. the error is unrecoverable.
*
* Ensures `m_cond` is false.
* If `m_cond` is true, prints `m_msg` and the application crashes.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define CRASH_COND_MSG(m_cond, m_msg) \
if (unlikely(m_cond)) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "FATAL: Condition \"" _STR(m_cond) "\" is true.", m_msg); \
Protection for array operator for Vector2 / 3 in DEV builds A previous PR had changed the array operator to give unbounded access. This could cause crashes where old code depended on this previous safe behaviour. This PR adds DEV_ASSERT macros for out of bound access to DEV builds, allowing us to quickly identify bugs in calling code, without affecting performance in release or release_debug editor builds.
2022-03-07 11:15:45 +00:00
_err_flush_stdout(); \
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
GENERATE_TRAP(); \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 15:00:50 +00:00
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
// Generic error macros.
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_COND_MSG` or `ERR_FAIL_MSG`.
* Only use this macro if more complex error detection or recovery is required, and
* there is no sensible error message.
*
* The current function returns.
*/
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
#define ERR_FAIL() \
Fix 'modernize-use-bool-literals' clang-tidy warnings in error macros
2020-07-05 17:22:23 +00:00
if (true) { \
Error macros: Improve style of error messages Document why the `if (1) {} else ((void)0)` construct is used.
2020-05-15 15:48:09 +00:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Method/function failed."); \
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
return; \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
} else \
((void)0)
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 19:11:16 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_COND_MSG`.
* Only use this macro if more complex error detection or recovery is required.
*
* Prints `m_msg`, and the current function returns.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define ERR_FAIL_MSG(m_msg) \
if (true) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Method/function failed.", m_msg); \
return; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
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 19:11:16 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_FAIL_MSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_FAIL_EDMSG(m_msg) \
if (true) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Method/function failed.", m_msg, true); \
return; \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_COND_V_MSG` or `ERR_FAIL_V_MSG`.
* Only use this macro if more complex error detection or recovery is required, and
* there is no sensible error message.
*
* The current function returns `m_retval`.
*/
typedefs: Cleanup unused macros and unnecessary checks We now require a compiler with C++17 support, so we don't need to check for features added to GCC 5 or Clang 3.2. Clang builtin availability checks were unused anyway as Clang defines `__GNUC__` as it's also a GNU C implementation. Fixes #36986.
2020-03-11 20:01:02 +00:00
#define ERR_FAIL_V(m_retval) \
Fix 'modernize-use-bool-literals' clang-tidy warnings in error macros
2020-07-05 17:22:23 +00:00
if (true) { \
Error macros: Improve style of error messages Document why the `if (1) {} else ((void)0)` construct is used.
2020-05-15 15:48:09 +00:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Method/function failed. Returning: " _STR(m_retval)); \
typedefs: Cleanup unused macros and unnecessary checks We now require a compiler with C++17 support, so we don't need to check for features added to GCC 5 or Clang 3.2. Clang builtin availability checks were unused anyway as Clang defines `__GNUC__` as it's also a GNU C implementation. Fixes #36986.
2020-03-11 20:01:02 +00:00
return m_retval; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 15:00:50 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Try using `ERR_FAIL_COND_V_MSG`.
* Only use this macro if more complex error detection or recovery is required.
*
* Prints `m_msg`, and the current function returns `m_retval`.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define ERR_FAIL_V_MSG(m_retval, m_msg) \
if (true) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Method/function failed. Returning: " _STR(m_retval), m_msg); \
return m_retval; \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_FAIL_V_MSG` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_FAIL_V_EDMSG(m_retval, m_msg) \
if (true) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Method/function failed. Returning: " _STR(m_retval), m_msg, true); \
return m_retval; \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Try using `ERR_FAIL_COND_MSG`, `ERR_FAIL_COND_V_MSG`, `ERR_CONTINUE_MSG` or `ERR_BREAK_MSG`.
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
* Only use this macro at the start of a function that has not been implemented yet, or
* if more complex error detection or recovery is required.
*
* Prints `m_msg`.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
#define ERR_PRINT(m_msg) \
New lightmapper -Added LocalVector (needed it) -Added stb_rect_pack (It's pretty cool, we could probably use it for other stuff too) -Fixes and changes all around the place -Added library for 128 bits fixed point (required for Delaunay3D)
2020-05-01 12:34:23 +00:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_msg)
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_PRINT` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_PRINT_ED(m_msg) \
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_msg, true)
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Prints `m_msg` once during the application lifetime.
*/
New lightmapper -Added LocalVector (needed it) -Added stb_rect_pack (It's pretty cool, we could probably use it for other stuff too) -Fixes and changes all around the place -Added library for 128 bits fixed point (required for Delaunay3D)
2020-05-01 12:34:23 +00:00
#define ERR_PRINT_ONCE(m_msg) \
Fix 'modernize-use-bool-literals' clang-tidy warnings in error macros
2020-07-05 17:22:23 +00:00
if (true) { \
New lightmapper -Added LocalVector (needed it) -Added stb_rect_pack (It's pretty cool, we could probably use it for other stuff too) -Fixes and changes all around the place -Added library for 128 bits fixed point (required for Delaunay3D)
2020-05-01 12:34:23 +00:00
static bool first_print = true; \
if (first_print) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_msg); \
first_print = false; \
} \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
Clean up blend shape support in GLES2 and GLES3.
2019-03-01 19:01:21 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `ERR_PRINT_ONCE` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define ERR_PRINT_ONCE_ED(m_msg) \
if (true) { \
static bool first_print = true; \
if (first_print) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_msg, true); \
first_print = false; \
} \
} else \
((void)0)
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
// Print warning message macros.
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Prints `m_msg`.
*
* If warning about deprecated usage, use `WARN_DEPRECATED` or `WARN_DEPRECATED_MSG` instead.
*/
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
#define WARN_PRINT(m_msg) \
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_msg, false, ERR_HANDLER_WARNING)
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `WARN_PRINT` but also notifies the editor.
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
*/
#define WARN_PRINT_ED(m_msg) \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_msg, true, ERR_HANDLER_WARNING)
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Prints `m_msg` once during the application lifetime.
*
* If warning about deprecated usage, use `WARN_DEPRECATED` or `WARN_DEPRECATED_MSG` instead.
*/
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
#define WARN_PRINT_ONCE(m_msg) \
if (true) { \
static bool first_print = true; \
if (first_print) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_msg, false, ERR_HANDLER_WARNING); \
first_print = false; \
} \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
Clean up blend shape support in GLES2 and GLES3.
2019-03-01 19:01:21 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
Logger: Don't print error twice on `ERR_PRINT` Also fix broken `ERR_PRINT_ED` macro and simplify comments. For the record these macros aren't used yet, they're intended to be used where needed to surface messages in the toaster when useful to end users, but we haven't done that codebase review yet.
2022-10-04 14:33:49 +00:00
* Same as `WARN_PRINT_ONCE` but also notifies the editor.
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
*/
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
#define WARN_PRINT_ONCE_ED(m_msg) \
if (true) { \
static bool first_print = true; \
if (first_print) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, m_msg, true, ERR_HANDLER_WARNING); \
first_print = false; \
} \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
Add do..while(0) wrappers to macros without one. - Add do..while(0) wrapper to ERR_FAIL_NULL macros. - Add do..while(0) wrapper to ERR_FAIL_COND macros. - Add do..while(0) wrapper to ERR_CONTINUE macros. - Add do..while(0) wrapper to ERR_BREAK macros. - Add do..while(0) wrapper to CRASH_COND macros. - Add do..while(0) wrapper to ERR_FAIL macros. - Add do..while(0) wrapper to ERR_PRINT macros. - Add do..while(0) wrapper to WARN_PRINT macros. - Add do..while(0) wrapper to WARN_DEPRECATED macros. - Add do..while(0) wrapper to CRASH_NOW macros.
2019-11-07 09:37:44 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
// Print deprecated warning message macros.
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
* Warns that the current function is deprecated.
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
*/
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
#define WARN_DEPRECATED \
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
if (true) { \
Prevent misuse of SafeRefCount
2023-01-09 09:15:35 +00:00
static std::atomic<bool> warning_shown; \
if (!warning_shown.load()) { \
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "This method has been deprecated and will be removed in the future.", false, ERR_HANDLER_WARNING); \
Prevent misuse of SafeRefCount
2023-01-09 09:15:35 +00:00
warning_shown.store(true); \
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
} \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
/**
* Warns that the current function is deprecated and prints `m_msg`.
*/
#define WARN_DEPRECATED_MSG(m_msg) \
if (true) { \
Prevent misuse of SafeRefCount
2023-01-09 09:15:35 +00:00
static std::atomic<bool> warning_shown; \
if (!warning_shown.load()) { \
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "This method has been deprecated and will be removed in the future.", m_msg, false, ERR_HANDLER_WARNING); \
Prevent misuse of SafeRefCount
2023-01-09 09:15:35 +00:00
warning_shown.store(true); \
Implement toast notifications in the editor
2021-09-22 15:36:40 +00:00
} \
} else \
((void)0)
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Do not use.
* If the application should never reach this point use CRASH_NOW_MSG(m_msg) to explain why.
*
* The application crashes.
*/
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
#define CRASH_NOW() \
Fix 'modernize-use-bool-literals' clang-tidy warnings in error macros
2020-07-05 17:22:23 +00:00
if (true) { \
Error macros: Improve style of error messages Document why the `if (1) {} else ((void)0)` construct is used.
2020-05-15 15:48:09 +00:00
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "FATAL: Method/function failed."); \
Add fflush to error macros CRASH_NOW macros would previously crash before outputting any error messages. This PR ensures calling fflush for stdout before terminating.
2022-02-05 12:31:54 +00:00
_err_flush_stdout(); \
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
GENERATE_TRAP(); \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
} else \
((void)0)
Clean up error_macros.h
2019-11-06 07:38:23 +00:00
Apply macro documentation from #35521.
2020-02-05 13:39:12 +00:00
/**
* Only use if the application should never reach this point.
*
* Prints `m_msg`, and then the application crashes.
*/
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
#define CRASH_NOW_MSG(m_msg) \
if (true) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "FATAL: Method/function failed.", m_msg); \
Add fflush to error macros CRASH_NOW macros would previously crash before outputting any error messages. This PR ensures calling fflush for stdout before terminating.
2022-02-05 12:31:54 +00:00
_err_flush_stdout(); \
revert 0d7409a so additional error information prints in release builds
2021-10-04 17:45:56 +00:00
GENERATE_TRAP(); \
} else \
Remove do{ } while(0) wrapper around error macros. As pointed out by Faless, a do{ } while(0) wrapper around a continue or break just ends the do{ } while(0) loop. The do{ } while(0) loop exists to enable the macro to be used as a function which requires a semicolon. The alternative approach is to use an if(1) { } else ((void)0) wrapper. Since the macro already has an if(unlikely(m_cond)) { } this patch simply adds the else ((void)0) to this if statement instead. For consistency all the macros have been updated in the same way, and trailing else warnings corrected. However, the wrappers around ERR_PRINT and WARN_PRINT were removed, because they generated too many ambiguous trailing else warnings. They are also single line macros so a wrapper is not needed.
2020-02-08 07:35:52 +00:00
((void)0)
implement accompanying error macros that come with an error message, to replace ERR_EXPLAIN usage.
2019-07-28 15:00:50 +00:00
Protection for array operator for Vector2 / 3 in DEV builds A previous PR had changed the array operator to give unbounded access. This could cause crashes where old code depended on this previous safe behaviour. This PR adds DEV_ASSERT macros for out of bound access to DEV builds, allowing us to quickly identify bugs in calling code, without affecting performance in release or release_debug editor builds.
2022-03-07 11:15:45 +00:00
/**
* This should be a 'free' assert for program flow and should not be needed in any releases,
* only used in dev builds.
*/
#ifdef DEV_ENABLED
#define DEV_ASSERT(m_cond) \
if (unlikely(!(m_cond))) { \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "FATAL: DEV_ASSERT failed \"" _STR(m_cond) "\" is false."); \
_err_flush_stdout(); \
GENERATE_TRAP(); \
} else \
((void)0)
#else
#define DEV_ASSERT(m_cond)
#endif
Style: Harmonize header guards to style guide [Core]
2020-03-25 10:10:34 +00:00
#endif // ERROR_MACROS_H