37d55ff153
Documentation can be visible in many IDEs by hovering the macro anywhere it's used. Error message styling was also tweaked for consistency.
115 lines
5.2 KiB
C++
115 lines
5.2 KiB
C++
/*************************************************************************/
|
|
/* error_macros.cpp */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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. */
|
|
/*************************************************************************/
|
|
|
|
#include "error_macros.h"
|
|
|
|
#include "core/io/logger.h"
|
|
#include "core/ustring.h"
|
|
#include "os/os.h"
|
|
|
|
static ErrorHandlerList *error_handler_list = NULL;
|
|
|
|
void add_error_handler(ErrorHandlerList *p_handler) {
|
|
|
|
_global_lock();
|
|
p_handler->next = error_handler_list;
|
|
error_handler_list = p_handler;
|
|
_global_unlock();
|
|
}
|
|
|
|
void remove_error_handler(ErrorHandlerList *p_handler) {
|
|
|
|
_global_lock();
|
|
|
|
ErrorHandlerList *prev = NULL;
|
|
ErrorHandlerList *l = error_handler_list;
|
|
|
|
while (l) {
|
|
|
|
if (l == p_handler) {
|
|
|
|
if (prev)
|
|
prev->next = l->next;
|
|
else
|
|
error_handler_list = l->next;
|
|
break;
|
|
}
|
|
prev = l;
|
|
l = l->next;
|
|
}
|
|
|
|
_global_unlock();
|
|
}
|
|
|
|
void _err_print_error(const char *p_function, const char *p_file, int p_line, const char *p_error, ErrorHandlerType p_type) {
|
|
_err_print_error(p_function, p_file, p_line, p_error, "", p_type);
|
|
}
|
|
|
|
void _err_print_error(const char *p_function, const char *p_file, int p_line, const String &p_error, ErrorHandlerType p_type) {
|
|
_err_print_error(p_function, p_file, p_line, p_error.utf8().get_data(), "", p_type);
|
|
}
|
|
|
|
void _err_print_error(const char *p_function, const char *p_file, int p_line, const char *p_error, const char *p_message, ErrorHandlerType p_type) {
|
|
|
|
OS::get_singleton()->print_error(p_function, p_file, p_line, p_error, p_message, (Logger::ErrorType)p_type);
|
|
|
|
_global_lock();
|
|
ErrorHandlerList *l = error_handler_list;
|
|
while (l) {
|
|
|
|
l->errfunc(l->userdata, p_function, p_file, p_line, p_error, p_message, p_type);
|
|
l = l->next;
|
|
}
|
|
|
|
_global_unlock();
|
|
}
|
|
|
|
void _err_print_error(const char *p_function, const char *p_file, int p_line, const String &p_error, const char *p_message, ErrorHandlerType p_type) {
|
|
_err_print_error(p_function, p_file, p_line, p_error.utf8().get_data(), p_message, p_type);
|
|
}
|
|
|
|
void _err_print_error(const char *p_function, const char *p_file, int p_line, const char *p_error, const String &p_message, ErrorHandlerType p_type) {
|
|
_err_print_error(p_function, p_file, p_line, p_error, p_message.utf8().get_data(), p_type);
|
|
}
|
|
|
|
void _err_print_error(const char *p_function, const char *p_file, int p_line, const String &p_error, const String &p_message, ErrorHandlerType p_type) {
|
|
_err_print_error(p_function, p_file, p_line, p_error.utf8().get_data(), p_message.utf8().get_data(), p_type);
|
|
}
|
|
|
|
void _err_print_index_error(const char *p_function, const char *p_file, int p_line, int64_t p_index, int64_t p_size, const char *p_index_str, const char *p_size_str, const char *p_message, bool fatal) {
|
|
|
|
String fstr(fatal ? "FATAL: " : "");
|
|
String err(fstr + "Index " + p_index_str + " = " + itos(p_index) + " is out of bounds (" + p_size_str + " = " + itos(p_size) + ").");
|
|
_err_print_error(p_function, p_file, p_line, err.utf8().get_data(), p_message);
|
|
}
|
|
|
|
void _err_print_index_error(const char *p_function, const char *p_file, int p_line, int64_t p_index, int64_t p_size, const char *p_index_str, const char *p_size_str, const String &p_message, bool fatal) {
|
|
_err_print_index_error(p_function, p_file, p_line, p_index, p_size, p_index_str, p_size_str, p_message.utf8().get_data(), fatal);
|
|
}
|