From b823724e007bc3f505369b7d768373bbb8f503e6 Mon Sep 17 00:00:00 2001 From: Sofox Date: Mon, 20 Nov 2023 12:06:54 +0000 Subject: [PATCH] Add line limit to Editor Output Log --- doc/classes/EditorSettings.xml | 3 ++ editor/editor_log.cpp | 61 ++++++++++++++++++++++++++++++---- editor/editor_log.h | 4 +++ editor/editor_settings.cpp | 2 ++ 4 files changed, 63 insertions(+), 7 deletions(-) diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 93a7b09fce1..dfc85576623 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -924,6 +924,9 @@ The size of the font in the [b]Output[/b] panel at the bottom of the editor. This setting does not impact the font size of the script editor (see [member interface/editor/code_font_size]). + + Maximum number of lines to show at any one time in the Output panel. + If [code]true[/code], on Linux/BSD, the editor will check for Wayland first instead of X11 (if available). diff --git a/editor/editor_log.cpp b/editor/editor_log.cpp index 667405ff10f..b8da550d8a7 100644 --- a/editor/editor_log.cpp +++ b/editor/editor_log.cpp @@ -127,6 +127,14 @@ void EditorLog::_update_theme() { theme_cache.message_color = get_theme_color(SNAME("font_color"), EditorStringName(Editor)) * Color(1, 1, 1, 0.6); } +void EditorLog::_editor_settings_changed() { + int new_line_limit = int(EDITOR_GET("run/output/max_lines")); + if (new_line_limit != line_limit) { + line_limit = new_line_limit; + _rebuild_log(); + } +} + void EditorLog::_notification(int p_what) { switch (p_what) { case NOTIFICATION_ENTER_TREE: { @@ -267,7 +275,35 @@ void EditorLog::_undo_redo_cbk(void *p_self, const String &p_name) { void EditorLog::_rebuild_log() { log->clear(); - for (int msg_idx = 0; msg_idx < messages.size(); msg_idx++) { + int line_count = 0; + int start_message_index = 0; + int initial_skip = 0; + + // Search backward for starting place. + for (start_message_index = messages.size() - 1; start_message_index >= 0; start_message_index--) { + LogMessage msg = messages[start_message_index]; + if (collapse) { + if (_check_display_message(msg)) { + line_count++; + } + } else { + // If not collapsing, log each instance on a line. + for (int i = 0; i < msg.count; i++) { + if (_check_display_message(msg)) { + line_count++; + } + } + } + if (line_count >= line_limit) { + initial_skip = line_count - line_limit; + break; + } + if (start_message_index == 0) { + break; + } + } + + for (int msg_idx = start_message_index; msg_idx < messages.size(); msg_idx++) { LogMessage msg = messages[msg_idx]; if (collapse) { @@ -275,13 +311,21 @@ void EditorLog::_rebuild_log() { _add_log_line(msg); } else { // If not collapsing, log each instance on a line. - for (int i = 0; i < msg.count; i++) { + for (int i = initial_skip; i < msg.count; i++) { + initial_skip = 0; _add_log_line(msg); } } } } +bool EditorLog::_check_display_message(LogMessage &p_message) { + bool filter_active = type_filter_map[p_message.type]->is_active(); + String search_text = search_box->get_text(); + bool search_match = search_text.is_empty() || p_message.text.findn(search_text) > -1; + return filter_active && search_match; +} + void EditorLog::_add_log_line(LogMessage &p_message, bool p_replace_previous) { if (!is_inside_tree()) { // The log will be built all at once when it enters the tree and has its theme items. @@ -294,11 +338,7 @@ void EditorLog::_add_log_line(LogMessage &p_message, bool p_replace_previous) { } // Only add the message to the log if it passes the filters. - bool filter_active = type_filter_map[p_message.type]->is_active(); - String search_text = search_box->get_text(); - bool search_match = search_text.is_empty() || p_message.text.findn(search_text) > -1; - - if (!filter_active || !search_match) { + if (!_check_display_message(p_message)) { return; } @@ -359,6 +399,10 @@ void EditorLog::_add_log_line(LogMessage &p_message, bool p_replace_previous) { } } } + + while (log->get_paragraph_count() > line_limit + 1) { + log->remove_paragraph(0, true); + } } void EditorLog::_set_filter_active(bool p_active, MessageType p_message_type) { @@ -392,6 +436,9 @@ EditorLog::EditorLog() { save_state_timer->connect("timeout", callable_mp(this, &EditorLog::_save_state)); add_child(save_state_timer); + line_limit = int(EDITOR_GET("run/output/max_lines")); + EditorSettings::get_singleton()->connect("settings_changed", callable_mp(this, &EditorLog::_editor_settings_changed)); + HBoxContainer *hb = this; VBoxContainer *vb_left = memnew(VBoxContainer); diff --git a/editor/editor_log.h b/editor/editor_log.h index 601e63b9fe9..7012a2a43cf 100644 --- a/editor/editor_log.h +++ b/editor/editor_log.h @@ -128,6 +128,8 @@ private: } }; + int line_limit = 10000; + Vector messages; // Maps MessageTypes to LogFilters for convenient access and storage (don't need 1 member per filter). HashMap type_filter_map; @@ -164,6 +166,7 @@ private: void _rebuild_log(); void _add_log_line(LogMessage &p_message, bool p_replace_previous = false); + bool _check_display_message(LogMessage &p_message); void _set_filter_active(bool p_active, MessageType p_message_type); void _set_search_visible(bool p_visible); @@ -179,6 +182,7 @@ private: void _load_state(); void _update_theme(); + void _editor_settings_changed(); protected: void _notification(int p_what); diff --git a/editor/editor_settings.cpp b/editor/editor_settings.cpp index 752b0605134..03745c10f7c 100644 --- a/editor/editor_settings.cpp +++ b/editor/editor_settings.cpp @@ -821,6 +821,8 @@ void EditorSettings::_load_defaults(Ref p_extra_config) { _initial_set("run/output/always_open_output_on_play", true); _initial_set("run/output/always_close_output_on_stop", false); + EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "run/output/max_lines", 10000, "100,100000,1") + // Platform _initial_set("run/platforms/linuxbsd/prefer_wayland", false); set_restart_if_changed("run/platforms/linuxbsd/prefer_wayland", true);