Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement error macros that come with an error message, replacing ERR_EXPLAIN. #30893

Merged
merged 1 commit into from
Aug 8, 2019
Merged

Implement error macros that come with an error message, replacing ERR_EXPLAIN. #30893

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
137 changes: 137 additions & 0 deletions core/error_macros.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,16 @@ extern bool _err_error_exists;
_err_error_exists = false; \
} while (0); // (*)

#define ERR_FAIL_INDEX_MSG(m_index, m_size, m_msg) \
do { \
if (unlikely((m_index) < 0 || (m_index) >= (m_size))) { \
ERR_EXPLAIN(m_msg); \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size)); \
return; \
} \
_err_error_exists = false; \
} while (0); // (*)

/** An index has failed if m_index<0 or m_index >=m_size, the function exits.
* This function returns an error value, if returning Error, please select the most
* appropriate error condition from error_macros.h
Expand All @@ -154,6 +164,16 @@ extern bool _err_error_exists;
_err_error_exists = false; \
} while (0); // (*)

#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_EXPLAIN(m_msg); \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size)); \
return m_retval; \
} \
_err_error_exists = false; \
} while (0); // (*)

/** An index has failed if m_index >=m_size, the function exits.
* This function returns an error value, if returning Error, please select the most
* appropriate error condition from error_macros.h
Expand All @@ -168,6 +188,16 @@ extern bool _err_error_exists;
_err_error_exists = false; \
} while (0); // (*)

#define ERR_FAIL_UNSIGNED_INDEX_V_MSG(m_index, m_size, m_retval, m_msg) \
do { \
if (unlikely((m_index) >= (m_size))) { \
ERR_EXPLAIN(m_msg); \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size)); \
return m_retval; \
} \
_err_error_exists = false; \
} while (0); // (*)

/** Use this one if there is no sensible fallback, that is, the error is unrecoverable.
* We'll return a null reference and try to keep running.
*/
Expand All @@ -179,6 +209,15 @@ extern bool _err_error_exists;
} \
} while (0); // (*)

#define CRASH_BAD_INDEX_MSG(m_index, m_size, m_msg) \
do { \
if (unlikely((m_index) < 0 || (m_index) >= (m_size))) { \
ERR_EXPLAIN(m_msg); \
_err_print_index_error(FUNCTION_STR, __FILE__, __LINE__, m_index, m_size, _STR(m_index), _STR(m_size), true); \
GENERATE_TRAP \
} \
} while (0); // (*)

/** An error condition happened (m_cond tested true) (WARNING this is the opposite as assert().
* the function will exit.
*/
Expand All @@ -192,6 +231,16 @@ extern bool _err_error_exists;
_err_error_exists = false; \
}

#define ERR_FAIL_NULL_MSG(m_param, m_msg) \
{ \
if (unlikely(!m_param)) { \
ERR_EXPLAIN(m_msg); \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter ' " _STR(m_param) " ' is null."); \
return; \
} \
_err_error_exists = false; \
}

#define ERR_FAIL_NULL_V(m_param, m_retval) \
{ \
if (unlikely(!m_param)) { \
Expand All @@ -201,6 +250,16 @@ extern bool _err_error_exists;
_err_error_exists = false; \
}

#define ERR_FAIL_NULL_V_MSG(m_param, m_retval, m_msg) \
{ \
if (unlikely(!m_param)) { \
ERR_EXPLAIN(m_msg); \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Parameter ' " _STR(m_param) " ' is null."); \
return m_retval; \
} \
_err_error_exists = false; \
}

/** An error condition happened (m_cond tested true) (WARNING this is the opposite as assert().
* the function will exit.
*/
Expand All @@ -214,6 +273,16 @@ extern bool _err_error_exists;
_err_error_exists = false; \
}

#define ERR_FAIL_COND_MSG(m_cond, m_msg) \
{ \
if (unlikely(m_cond)) { \
ERR_EXPLAIN(m_msg); \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition ' " _STR(m_cond) " ' is true."); \
return; \
} \
_err_error_exists = false; \
}

/** Use this one if there is no sensible fallback, that is, the error is unrecoverable.
*/

Expand All @@ -225,6 +294,15 @@ extern bool _err_error_exists;
} \
}

#define CRASH_COND_MSG(m_cond, m_msg) \
{ \
if (unlikely(m_cond)) { \
ERR_EXPLAIN(m_msg); \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "FATAL: Condition ' " _STR(m_cond) " ' is true."); \
GENERATE_TRAP \
} \
}

/** An error condition happened (m_cond tested true) (WARNING this is the opposite as assert().
* the function will exit.
* This function returns an error value, if returning Error, please select the most
Expand All @@ -240,6 +318,16 @@ extern bool _err_error_exists;
_err_error_exists = false; \
}

#define ERR_FAIL_COND_V_MSG(m_cond, m_retval, m_msg) \
{ \
if (unlikely(m_cond)) { \
ERR_EXPLAIN(m_msg); \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition ' " _STR(m_cond) " ' is true. returned: " _STR(m_retval)); \
return m_retval; \
} \
_err_error_exists = false; \
}

/** An error condition happened (m_cond tested true) (WARNING this is the opposite as assert().
* the loop will skip to the next iteration.
*/
Expand All @@ -253,6 +341,16 @@ extern bool _err_error_exists;
_err_error_exists = false; \
}

#define ERR_CONTINUE_MSG(m_cond, m_msg) \
{ \
if (unlikely(m_cond)) { \
ERR_EXPLAIN(m_msg); \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition ' " _STR(m_cond) " ' is true. Continuing..:"); \
continue; \
} \
_err_error_exists = false; \
}

/** An error condition happened (m_cond tested true) (WARNING this is the opposite as assert().
* the loop will break
*/
Expand All @@ -266,6 +364,16 @@ extern bool _err_error_exists;
_err_error_exists = false; \
}

#define ERR_BREAK_MSG(m_cond, m_msg) \
{ \
if (unlikely(m_cond)) { \
ERR_EXPLAIN(m_msg); \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition ' " _STR(m_cond) " ' is true. Breaking..:"); \
break; \
} \
_err_error_exists = false; \
}

/** Print an error string and return
*/

Expand All @@ -276,6 +384,12 @@ extern bool _err_error_exists;
return; \
}

#define ERR_FAIL_MSG(m_msg) \
{ \
ERR_EXPLAIN(m_msg); \
ERR_FAIL(); \
}

/** Print an error string and return with value
*/

Expand All @@ -286,6 +400,12 @@ extern bool _err_error_exists;
return m_value; \
}

#define ERR_FAIL_V_MSG(m_value, m_msg) \
{ \
ERR_EXPLAIN(m_msg); \
ERR_FAIL_V(m_value); \
}

/** Use this one if there is no sensible fallback, that is, the error is unrecoverable.
*/

Expand All @@ -295,6 +415,12 @@ extern bool _err_error_exists;
GENERATE_TRAP \
}

#define CRASH_NOW_MSG(m_msg) \
{ \
ERR_EXPLAIN(m_msg); \
CRASH_NOW(); \
}

/** Print an error string.
*/

Expand Down Expand Up @@ -355,4 +481,15 @@ extern bool _err_error_exists;
} \
}

#define WARN_DEPRECATED_MSG(m_msg) \
{ \
static volatile bool warning_shown = false; \
if (!warning_shown) { \
ERR_EXPLAIN(m_msg); \
_err_print_error(FUNCTION_STR, __FILE__, __LINE__, "This method has been deprecated and will be removed in the future", ERR_HANDLER_WARNING); \
_err_error_exists = false; \
warning_shown = true; \
} \
}

#endif