-
-
Notifications
You must be signed in to change notification settings - Fork 21.4k
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.
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
Add console logger for web to log warnings to console #99256
Draft
girdenis-p
wants to merge
1
commit into
godotengine:master
Choose a base branch
from
girdenis-p:console-logger
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+222
−15
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| /**************************************************************************/ | ||
| /* console_logger_web.cpp */ | ||
| /**************************************************************************/ | ||
| /* 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. */ | ||
| /**************************************************************************/ | ||
|
|
||
| #include "console_logger_web.h" | ||
|
|
||
| #include "godot_js.h" | ||
|
|
||
| void ConsoleLoggerWeb::log_error(const char *p_function, const char *p_file, int p_line, const char *p_code, const char *p_rationale, bool p_editor_notify, ErrorType p_type) { | ||
| if (!should_log(true)) { | ||
| return; | ||
| } | ||
|
|
||
| const char *err_details; | ||
| if (p_rationale && *p_rationale) { | ||
| err_details = p_rationale; | ||
| } else { | ||
| err_details = p_code; | ||
| } | ||
|
|
||
| const char *err_type = "ERROR"; | ||
| switch (p_type) { | ||
| case ERR_ERROR: | ||
| err_type = "ERROR"; | ||
| break; | ||
| case ERR_WARNING: | ||
| logf_warn("WARNING: %s\n at: %s (%s:%i)\n", err_details, p_function, p_file, p_line); | ||
| return; | ||
| case ERR_SCRIPT: | ||
| err_type = "SCRIPT ERROR"; | ||
| break; | ||
| case ERR_SHADER: | ||
| err_type = "SHADER ERROR"; | ||
| break; | ||
| default: | ||
| ERR_PRINT("Unknown error type"); | ||
| break; | ||
| } | ||
|
|
||
| logf_error("%s: %s\n at: %s (%s:%i)\n", err_type, err_details, p_function, p_file, p_line); | ||
| } | ||
|
|
||
| void ConsoleLoggerWeb::logf_warn(const char *p_format, ...) { | ||
| if (!should_log(false)) { | ||
| return; | ||
| } | ||
|
|
||
| va_list argp; | ||
| va_start(argp, p_format); | ||
|
|
||
| logv(p_format, argp, PrintType::WARN); | ||
|
|
||
| va_end(argp); | ||
| } | ||
|
|
||
| void ConsoleLoggerWeb::logv(const char *p_format, va_list p_list, bool p_err) { | ||
| logv(p_format, p_list, p_err ? PrintType::ERROR : PrintType::LOG); | ||
| } | ||
|
|
||
| void ConsoleLoggerWeb::logv(const char *p_format, va_list p_list, PrintType p_type) { | ||
| if (!should_log(p_type == PrintType::ERROR || p_type == PrintType::WARN)) { | ||
| return; | ||
| } | ||
|
|
||
| int str_size = vsnprintf(nullptr, 0, p_format, p_list) + 1; | ||
| char *str = new char[str_size]; | ||
| vsnprintf(str, str_size, p_format, p_list); | ||
|
|
||
| switch (p_type) { | ||
| case PrintType::ERROR: | ||
| godot_js_os_print_error(str); | ||
| break; | ||
| case PrintType::LOG: | ||
| godot_js_os_print(str); | ||
| break; | ||
| case PrintType::WARN: | ||
| godot_js_os_print_warning(str); | ||
| break; | ||
| } | ||
|
|
||
| delete[] str; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /**************************************************************************/ | ||
| /* console_logger_web.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. */ | ||
| /**************************************************************************/ | ||
|
|
||
| #ifndef CONSOLE_LOGGER_WEB_H | ||
| #define CONSOLE_LOGGER_WEB_H | ||
|
|
||
| #include "core/io/logger.h" | ||
|
|
||
| class ConsoleLoggerWeb : public Logger { | ||
| enum class PrintType { LOG, | ||
| ERROR, | ||
| WARN }; | ||
| virtual void logv(const char *p_format, va_list p_list, PrintType p_type); | ||
|
|
||
| public: | ||
| virtual void logv(const char *p_format, va_list p_list, bool p_err) override; | ||
| virtual void log_error(const char *p_function, const char *p_file, int p_line, const char *p_code, const char *p_rationale, bool p_editor_notify = false, ErrorType p_type = ERR_ERROR) override; | ||
| virtual ~ConsoleLoggerWeb() {} | ||
|
|
||
| void logf_warn(const char *p_format, ...) _PRINTF_FORMAT_ATTRIBUTE_2_3; | ||
| }; | ||
|
|
||
| #endif // CONSOLE_LOGGER_WEB_H |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The previous docstring said that this callback takes a variadic number of arguments to be printed. However, this callback has only ever took one argument to it because
Module.printonly takes one argument.Variadic arguments are handled differently in JS than in C++ so any implementation of this function utilizing the variadic arguments through the spread operator
...would still work as intended even after this change.