Skip to content

Commit

Permalink
Add line limit to Editor Output Log
Browse files Browse the repository at this point in the history
  • Loading branch information
TheSofox committed May 2, 2024
1 parent 06d105e commit b823724
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 7 deletions.
3 changes: 3 additions & 0 deletions doc/classes/EditorSettings.xml
Original file line number Diff line number Diff line change
Expand Up @@ -924,6 +924,9 @@
<member name="run/output/font_size" type="int" setter="" getter="">
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]).
</member>
<member name="run/output/max_lines" type="int" setter="" getter="">
Maximum number of lines to show at any one time in the Output panel.
</member>
<member name="run/platforms/linuxbsd/prefer_wayland" type="bool" setter="" getter="">
If [code]true[/code], on Linux/BSD, the editor will check for Wayland first instead of X11 (if available).
</member>
Expand Down
61 changes: 54 additions & 7 deletions editor/editor_log.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down Expand Up @@ -267,21 +275,57 @@ 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) {
// If collapsing, only log one instance of the message.
_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.
Expand All @@ -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;
}

Expand Down Expand Up @@ -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) {
Expand Down Expand Up @@ -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);
Expand Down
4 changes: 4 additions & 0 deletions editor/editor_log.h
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,8 @@ class EditorLog : public HBoxContainer {
}
};

int line_limit = 10000;

Vector<LogMessage> messages;
// Maps MessageTypes to LogFilters for convenient access and storage (don't need 1 member per filter).
HashMap<MessageType, LogFilter *> type_filter_map;
Expand Down Expand Up @@ -164,6 +166,7 @@ class EditorLog : public HBoxContainer {

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);
Expand All @@ -179,6 +182,7 @@ class EditorLog : public HBoxContainer {
void _load_state();

void _update_theme();
void _editor_settings_changed();

protected:
void _notification(int p_what);
Expand Down
2 changes: 2 additions & 0 deletions editor/editor_settings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -821,6 +821,8 @@ void EditorSettings::_load_defaults(Ref<ConfigFile> 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);
Expand Down

0 comments on commit b823724

Please sign in to comment.