/*************************************************************************/ /* code_editor.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2022 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 "code_editor.h" #include "core/containers/vector.h" #include "core/input/input.h" #include "core/input/input_event.h" #include "core/input/shortcut.h" #include "core/math/math_funcs.h" #include "core/math/vector2.h" #include "core/object/class_db.h" #include "core/object/resource.h" #include "core/object/script_language.h" #include "core/os/keyboard.h" #include "core/os/memory.h" #include "core/string/string_builder.h" #include "core/typedefs.h" #include "core/variant/array.h" #include "core/variant/dictionary.h" #include "editor/editor_node.h" #include "editor/editor_scale.h" #include "editor/editor_settings.h" #include "scene/2d/canvas_item.h" #include "scene/gui/button.h" #include "scene/gui/check_box.h" #include "scene/gui/control.h" #include "scene/gui/label.h" #include "scene/gui/line_edit.h" #include "scene/gui/scroll_container.h" #include "scene/gui/text_edit.h" #include "scene/gui/texture_button.h" #include "scene/gui/tool_button.h" #include "scene/main/node.h" #include "scene/main/timer.h" #include "scene/resources/dynamic_font.h" #include "scene/resources/font.h" #include "scene/resources/texture.h" #include "script_editor_plugin.h" #include "find_replace_bar.h" #include "goto_line_dialog.h" #include "script_editor.h" /*** CODE EDITOR ****/ // This function should be used to handle shortcuts that could otherwise // be handled too late if they weren't handled here. void CodeTextEditor::_input(const Ref &event) { const Ref key_event = event; if (!key_event.is_valid() || !key_event->is_pressed()) { return; } if (ED_IS_SHORTCUT("script_text_editor/move_up", key_event)) { move_lines_up(); accept_event(); return; } if (ED_IS_SHORTCUT("script_text_editor/move_down", key_event)) { move_lines_down(); accept_event(); return; } if (ED_IS_SHORTCUT("script_text_editor/delete_line", key_event)) { delete_lines(); accept_event(); return; } if (ED_IS_SHORTCUT("script_text_editor/duplicate_selection", key_event)) { duplicate_selection(); accept_event(); return; } } void CodeTextEditor::_text_editor_gui_input(const Ref &p_event) { Ref mb = p_event; if (mb.is_valid()) { if (mb->is_pressed() && mb->get_command()) { if (mb->get_button_index() == BUTTON_WHEEL_UP) { _zoom_in(); } else if (mb->get_button_index() == BUTTON_WHEEL_DOWN) { _zoom_out(); } } } Ref magnify_gesture = p_event; if (magnify_gesture.is_valid()) { Ref font = text_editor->get_theme_font("font"); if (font.is_valid()) { if (font->get_size() != (int)font_size) { font_size = font->get_size(); } font_size *= powf(magnify_gesture->get_factor(), 0.25); _add_font_size((int)font_size - font->get_size()); } return; } Ref k = p_event; if (k.is_valid()) { if (k->is_pressed()) { if (ED_IS_SHORTCUT("script_editor/zoom_in", p_event)) { _zoom_in(); } if (ED_IS_SHORTCUT("script_editor/zoom_out", p_event)) { _zoom_out(); } if (ED_IS_SHORTCUT("script_editor/reset_zoom", p_event)) { _reset_zoom(); } } } } void CodeTextEditor::_zoom_in() { font_resize_val += MAX(EDSCALE, 1.0f); _zoom_changed(); } void CodeTextEditor::_zoom_out() { font_resize_val -= MAX(EDSCALE, 1.0f); _zoom_changed(); } void CodeTextEditor::_zoom_changed() { if (font_resize_timer->get_time_left() == 0) { font_resize_timer->start(); } } void CodeTextEditor::_reset_zoom() { Ref font = text_editor->get_theme_font("font"); // Reset source font size to default. if (font.is_valid()) { EditorSettings::get_singleton()->set("interface/editor/code_font_size", 14); font->set_size(14); } } void CodeTextEditor::_line_col_changed() { String line = text_editor->get_line(text_editor->cursor_get_line()); int positional_column = 0; for (int i = 0; i < text_editor->cursor_get_column(); i++) { if (line[i] == '\t') { positional_column += text_editor->get_indent_size(); //tab size } else { positional_column += 1; } } StringBuilder sb; sb.append(itos(text_editor->cursor_get_line() + 1).lpad(4)); sb.append(" : "); sb.append(itos(positional_column + 1).lpad(3)); line_and_col_txt->set_text(sb.as_string()); } void CodeTextEditor::_text_changed() { if (text_editor->is_insert_text_operation()) { code_complete_timer->start(); } idle->start(); } void CodeTextEditor::_code_complete_timer_timeout() { if (!is_visible_in_tree()) { return; } text_editor->query_code_comple(); } void CodeTextEditor::_complete_request() { List entries; String ctext = text_editor->get_text_for_completion(); _code_complete_script(ctext, &entries); bool forced = false; if (code_complete_func) { code_complete_func(code_complete_ud, ctext, &entries, forced); } if (entries.size() == 0) { return; } for (List::Element *E = entries.front(); E; E = E->next()) { E->get().icon = _get_completion_icon(E->get()); } text_editor->code_complete(entries, forced); } Ref CodeTextEditor::_get_completion_icon(const ScriptCodeCompletionOption &p_option) { Ref tex; switch (p_option.kind) { case ScriptCodeCompletionOption::KIND_CLASS: { if (has_theme_icon(p_option.display, "EditorIcons")) { tex = get_theme_icon(p_option.display, "EditorIcons"); } else { tex = get_theme_icon("Object", "EditorIcons"); } } break; case ScriptCodeCompletionOption::KIND_ENUM: tex = get_theme_icon("Enum", "EditorIcons"); break; case ScriptCodeCompletionOption::KIND_FILE_PATH: tex = get_theme_icon("File", "EditorIcons"); break; case ScriptCodeCompletionOption::KIND_NODE_PATH: tex = get_theme_icon("NodePath", "EditorIcons"); break; case ScriptCodeCompletionOption::KIND_VARIABLE: tex = get_theme_icon("Variant", "EditorIcons"); break; case ScriptCodeCompletionOption::KIND_CONSTANT: tex = get_theme_icon("MemberConstant", "EditorIcons"); break; case ScriptCodeCompletionOption::KIND_MEMBER: tex = get_theme_icon("MemberProperty", "EditorIcons"); break; case ScriptCodeCompletionOption::KIND_SIGNAL: tex = get_theme_icon("MemberSignal", "EditorIcons"); break; case ScriptCodeCompletionOption::KIND_FUNCTION: tex = get_theme_icon("MemberMethod", "EditorIcons"); break; case ScriptCodeCompletionOption::KIND_PLAIN_TEXT: tex = get_theme_icon("CubeMesh", "EditorIcons"); break; default: tex = get_theme_icon("String", "EditorIcons"); break; } return tex; } void CodeTextEditor::_font_resize_timeout() { if (_add_font_size(font_resize_val)) { font_resize_val = 0; } } bool CodeTextEditor::_add_font_size(int p_delta) { Ref font = text_editor->get_theme_font("font"); if (font.is_valid()) { int new_size = CLAMP(font->get_size() + p_delta, 8 * EDSCALE, 96 * EDSCALE); if (new_size != font->get_size()) { EditorSettings::get_singleton()->set("interface/editor/code_font_size", new_size / EDSCALE); font->set_size(new_size); } return true; } else { return false; } } void CodeTextEditor::update_editor_settings() { text_editor->set_syntax_coloring(EditorSettings::get_singleton()->get("text_editor/highlighting/syntax_highlighting")); text_editor->set_highlight_all_occurrences(EditorSettings::get_singleton()->get("text_editor/highlighting/highlight_all_occurrences")); text_editor->set_highlight_current_line(EditorSettings::get_singleton()->get("text_editor/highlighting/highlight_current_line")); text_editor->set_indent_using_spaces(EditorSettings::get_singleton()->get("text_editor/indent/type")); text_editor->set_indent_size(EditorSettings::get_singleton()->get("text_editor/indent/size")); text_editor->set_auto_indent(EditorSettings::get_singleton()->get("text_editor/indent/auto_indent")); text_editor->set_draw_tabs(EditorSettings::get_singleton()->get("text_editor/indent/draw_tabs")); text_editor->set_draw_spaces(EditorSettings::get_singleton()->get("text_editor/indent/draw_spaces")); text_editor->set_smooth_scroll_enabled(EditorSettings::get_singleton()->get("text_editor/navigation/smooth_scrolling")); text_editor->set_v_scroll_speed(EditorSettings::get_singleton()->get("text_editor/navigation/v_scroll_speed")); text_editor->set_draw_minimap(EditorSettings::get_singleton()->get("text_editor/navigation/show_minimap")); text_editor->set_minimap_width((int)EditorSettings::get_singleton()->get("text_editor/navigation/minimap_width") * EDSCALE); text_editor->set_drag_and_drop_selection_enabled(EditorSettings::get_singleton()->get("text_editor/navigation/drag_and_drop_selection")); text_editor->set_show_line_numbers(EditorSettings::get_singleton()->get("text_editor/appearance/show_line_numbers")); text_editor->set_line_numbers_zero_padded(EditorSettings::get_singleton()->get("text_editor/appearance/line_numbers_zero_padded")); text_editor->set_bookmark_gutter_enabled(EditorSettings::get_singleton()->get("text_editor/appearance/show_bookmark_gutter")); text_editor->set_breakpoint_gutter_enabled(EditorSettings::get_singleton()->get("text_editor/appearance/show_breakpoint_gutter")); text_editor->set_draw_info_gutter(EditorSettings::get_singleton()->get("text_editor/appearance/show_info_gutter")); text_editor->set_hiding_enabled(EditorSettings::get_singleton()->get("text_editor/appearance/code_folding")); text_editor->set_draw_fold_gutter(EditorSettings::get_singleton()->get("text_editor/appearance/code_folding")); text_editor->set_wrap_enabled(EditorSettings::get_singleton()->get("text_editor/appearance/word_wrap")); text_editor->set_show_line_length_guidelines(EditorSettings::get_singleton()->get("text_editor/appearance/show_line_length_guidelines")); text_editor->set_line_length_guideline_soft_column(EditorSettings::get_singleton()->get("text_editor/appearance/line_length_guideline_soft_column")); text_editor->set_line_length_guideline_hard_column(EditorSettings::get_singleton()->get("text_editor/appearance/line_length_guideline_hard_column")); text_editor->set_scroll_pass_end_of_file(EditorSettings::get_singleton()->get("text_editor/cursor/scroll_past_end_of_file")); text_editor->cursor_set_block_mode(EditorSettings::get_singleton()->get("text_editor/cursor/block_caret")); text_editor->cursor_set_blink_enabled(EditorSettings::get_singleton()->is_caret_blink_active()); text_editor->cursor_set_blink_speed(EditorSettings::get_singleton()->get("text_editor/cursor/caret_blink_speed")); text_editor->set_auto_brace_completion(EditorSettings::get_singleton()->get("text_editor/completion/auto_brace_complete")); } void CodeTextEditor::trim_trailing_whitespace() { bool trimed_whitespace = false; for (int i = 0; i < text_editor->get_line_count(); i++) { String line = text_editor->get_line(i); if (line.ends_with(" ") || line.ends_with("\t")) { if (!trimed_whitespace) { text_editor->begin_complex_operation(); trimed_whitespace = true; } int end = 0; for (int j = line.length() - 1; j > -1; j--) { if (line[j] != ' ' && line[j] != '\t') { end = j + 1; break; } } text_editor->set_line(i, line.substr(0, end)); } } if (trimed_whitespace) { text_editor->end_complex_operation(); text_editor->update(); } } void CodeTextEditor::insert_final_newline() { int final_line = text_editor->get_line_count() - 1; String line = text_editor->get_line(final_line); //length 0 means it's already an empty line, //no need to add a newline if (line.length() > 0 && !line.ends_with("\n")) { text_editor->begin_complex_operation(); line += "\n"; text_editor->set_line(final_line, line); text_editor->end_complex_operation(); text_editor->update(); } } void CodeTextEditor::convert_indent_to_spaces() { int indent_size = EditorSettings::get_singleton()->get("text_editor/indent/size"); String indent = ""; for (int i = 0; i < indent_size; i++) { indent += " "; } int cursor_line = text_editor->cursor_get_line(); int cursor_column = text_editor->cursor_get_column(); bool changed_indentation = false; for (int i = 0; i < text_editor->get_line_count(); i++) { String line = text_editor->get_line(i); if (line.length() <= 0) { continue; } int j = 0; while (j < line.length() && (line[j] == ' ' || line[j] == '\t')) { if (line[j] == '\t') { if (!changed_indentation) { text_editor->begin_complex_operation(); changed_indentation = true; } if (cursor_line == i && cursor_column > j) { cursor_column += indent_size - 1; } line = line.left(j) + indent + line.right(j + 1); } j++; } if (changed_indentation) { text_editor->set_line(i, line); } } if (changed_indentation) { text_editor->cursor_set_column(cursor_column); text_editor->end_complex_operation(); text_editor->update(); } } void CodeTextEditor::convert_indent_to_tabs() { int indent_size = EditorSettings::get_singleton()->get("text_editor/indent/size"); indent_size -= 1; int cursor_line = text_editor->cursor_get_line(); int cursor_column = text_editor->cursor_get_column(); bool changed_indentation = false; for (int i = 0; i < text_editor->get_line_count(); i++) { String line = text_editor->get_line(i); if (line.length() <= 0) { continue; } int j = 0; int space_count = -1; while (j < line.length() && (line[j] == ' ' || line[j] == '\t')) { if (line[j] != '\t') { space_count++; if (space_count == indent_size) { if (!changed_indentation) { text_editor->begin_complex_operation(); changed_indentation = true; } if (cursor_line == i && cursor_column > j) { cursor_column -= indent_size; } line = line.left(j - indent_size) + "\t" + line.right(j + 1); j = 0; space_count = -1; } } else { space_count = -1; } j++; } if (changed_indentation) { text_editor->set_line(i, line); } } if (changed_indentation) { text_editor->cursor_set_column(cursor_column); text_editor->end_complex_operation(); text_editor->update(); } } void CodeTextEditor::convert_case(CaseStyle p_case) { if (!text_editor->is_selection_active()) { return; } text_editor->begin_complex_operation(); int begin = text_editor->get_selection_from_line(); int end = text_editor->get_selection_to_line(); int begin_col = text_editor->get_selection_from_column(); int end_col = text_editor->get_selection_to_column(); for (int i = begin; i <= end; i++) { int len = text_editor->get_line(i).length(); if (i == end) { len = end_col; } if (i == begin) { len -= begin_col; } String new_line = text_editor->get_line(i).substr(i == begin ? begin_col : 0, len); switch (p_case) { case UPPER: { new_line = new_line.to_upper(); } break; case LOWER: { new_line = new_line.to_lower(); } break; case CAPITALIZE: { new_line = new_line.capitalize(); } break; } if (i == begin) { new_line = text_editor->get_line(i).left(begin_col) + new_line; } if (i == end) { new_line = new_line + text_editor->get_line(i).right(end_col); } text_editor->set_line(i, new_line); } text_editor->end_complex_operation(); } void CodeTextEditor::move_lines_up() { text_editor->begin_complex_operation(); if (text_editor->is_selection_active()) { int from_line = text_editor->get_selection_from_line(); int from_col = text_editor->get_selection_from_column(); int to_line = text_editor->get_selection_to_line(); int to_column = text_editor->get_selection_to_column(); int cursor_line = text_editor->cursor_get_line(); for (int i = from_line; i <= to_line; i++) { int line_id = i; int next_id = i - 1; if (line_id == 0 || next_id < 0) { return; } text_editor->unfold_line(line_id); text_editor->unfold_line(next_id); text_editor->swap_lines(line_id, next_id); text_editor->cursor_set_line(next_id); } int from_line_up = from_line > 0 ? from_line - 1 : from_line; int to_line_up = to_line > 0 ? to_line - 1 : to_line; int cursor_line_up = cursor_line > 0 ? cursor_line - 1 : cursor_line; text_editor->select(from_line_up, from_col, to_line_up, to_column); text_editor->cursor_set_line(cursor_line_up); } else { int line_id = text_editor->cursor_get_line(); int next_id = line_id - 1; if (line_id == 0 || next_id < 0) { return; } text_editor->unfold_line(line_id); text_editor->unfold_line(next_id); text_editor->swap_lines(line_id, next_id); text_editor->cursor_set_line(next_id); } text_editor->end_complex_operation(); text_editor->update(); } void CodeTextEditor::move_lines_down() { text_editor->begin_complex_operation(); if (text_editor->is_selection_active()) { int from_line = text_editor->get_selection_from_line(); int from_col = text_editor->get_selection_from_column(); int to_line = text_editor->get_selection_to_line(); int to_column = text_editor->get_selection_to_column(); int cursor_line = text_editor->cursor_get_line(); for (int i = to_line; i >= from_line; i--) { int line_id = i; int next_id = i + 1; if (line_id == text_editor->get_line_count() - 1 || next_id > text_editor->get_line_count()) { return; } text_editor->unfold_line(line_id); text_editor->unfold_line(next_id); text_editor->swap_lines(line_id, next_id); text_editor->cursor_set_line(next_id); } int from_line_down = from_line < text_editor->get_line_count() ? from_line + 1 : from_line; int to_line_down = to_line < text_editor->get_line_count() ? to_line + 1 : to_line; int cursor_line_down = cursor_line < text_editor->get_line_count() ? cursor_line + 1 : cursor_line; text_editor->select(from_line_down, from_col, to_line_down, to_column); text_editor->cursor_set_line(cursor_line_down); } else { int line_id = text_editor->cursor_get_line(); int next_id = line_id + 1; if (line_id == text_editor->get_line_count() - 1 || next_id > text_editor->get_line_count()) { return; } text_editor->unfold_line(line_id); text_editor->unfold_line(next_id); text_editor->swap_lines(line_id, next_id); text_editor->cursor_set_line(next_id); } text_editor->end_complex_operation(); text_editor->update(); } void CodeTextEditor::_delete_line(int p_line) { // this is currently intended to be called within delete_lines() // so `begin_complex_operation` is omitted here text_editor->set_line(p_line, ""); if (p_line == 0 && text_editor->get_line_count() > 1) { text_editor->cursor_set_line(1); text_editor->cursor_set_column(0); } text_editor->backspace_at_cursor(); if (p_line < text_editor->get_line_count()) { text_editor->unfold_line(p_line); } text_editor->cursor_set_line(p_line); } void CodeTextEditor::delete_lines() { text_editor->begin_complex_operation(); if (text_editor->is_selection_active()) { int to_line = text_editor->get_selection_to_line(); int from_line = text_editor->get_selection_from_line(); int count = Math::abs(to_line - from_line) + 1; text_editor->cursor_set_line(from_line, false); for (int i = 0; i < count; i++) { _delete_line(from_line); } text_editor->deselect(); } else { _delete_line(text_editor->cursor_get_line()); } text_editor->end_complex_operation(); } void CodeTextEditor::duplicate_selection() { const int cursor_column = text_editor->cursor_get_column(); int from_line = text_editor->cursor_get_line(); int to_line = text_editor->cursor_get_line(); int from_column = 0; int to_column = 0; int cursor_new_line = to_line + 1; int cursor_new_column = text_editor->cursor_get_column(); String new_text = "\n" + text_editor->get_line(from_line); bool selection_active = false; text_editor->cursor_set_column(text_editor->get_line(from_line).length()); if (text_editor->is_selection_active()) { from_column = text_editor->get_selection_from_column(); to_column = text_editor->get_selection_to_column(); from_line = text_editor->get_selection_from_line(); to_line = text_editor->get_selection_to_line(); cursor_new_line = to_line + text_editor->cursor_get_line() - from_line; cursor_new_column = to_column == cursor_column ? 2 * to_column - from_column : to_column; new_text = text_editor->get_selection_text(); selection_active = true; text_editor->cursor_set_line(to_line); text_editor->cursor_set_column(to_column); } text_editor->begin_complex_operation(); for (int i = from_line; i <= to_line; i++) { text_editor->unfold_line(i); } text_editor->deselect(); text_editor->insert_text_at_cursor(new_text); text_editor->cursor_set_line(cursor_new_line); text_editor->cursor_set_column(cursor_new_column); if (selection_active) { text_editor->select(to_line, to_column, 2 * to_line - from_line, to_line == from_line ? 2 * to_column - from_column : to_column); } text_editor->end_complex_operation(); text_editor->update(); } void CodeTextEditor::toggle_inline_comment(const String &delimiter) { text_editor->begin_complex_operation(); if (text_editor->is_selection_active()) { int begin = text_editor->get_selection_from_line(); int end = text_editor->get_selection_to_line(); // End of selection ends on the first column of the last line, ignore it. if (text_editor->get_selection_to_column() == 0) { end -= 1; } int col_to = text_editor->get_selection_to_column(); int cursor_pos = text_editor->cursor_get_column(); // Check if all lines in the selected block are commented. bool is_commented = true; for (int i = begin; i <= end; i++) { if (!text_editor->get_line(i).begins_with(delimiter)) { is_commented = false; break; } } for (int i = begin; i <= end; i++) { String line_text = text_editor->get_line(i); if (line_text.strip_edges().empty()) { line_text = delimiter; } else { if (is_commented) { line_text = line_text.substr(delimiter.length(), line_text.length()); } else { line_text = delimiter + line_text; } } text_editor->set_line(i, line_text); } // Adjust selection & cursor position. int offset = (is_commented ? -1 : 1) * delimiter.length(); int col_from = text_editor->get_selection_from_column() > 0 ? text_editor->get_selection_from_column() + offset : 0; if (is_commented && text_editor->cursor_get_column() == text_editor->get_line(text_editor->cursor_get_line()).length() + 1) { cursor_pos += 1; } if (text_editor->get_selection_to_column() != 0 && col_to != text_editor->get_line(text_editor->get_selection_to_line()).length() + 1) { col_to += offset; } if (text_editor->cursor_get_column() != 0) { cursor_pos += offset; } text_editor->select(begin, col_from, text_editor->get_selection_to_line(), col_to); text_editor->cursor_set_column(cursor_pos); } else { int begin = text_editor->cursor_get_line(); String line_text = text_editor->get_line(begin); int delimiter_length = delimiter.length(); int col = text_editor->cursor_get_column(); if (line_text.begins_with(delimiter)) { line_text = line_text.substr(delimiter_length, line_text.length()); col -= delimiter_length; } else { line_text = delimiter + line_text; col += delimiter_length; } text_editor->set_line(begin, line_text); text_editor->cursor_set_column(col); } text_editor->end_complex_operation(); text_editor->update(); } void CodeTextEditor::goto_line(int p_line) { text_editor->deselect(); text_editor->unfold_line(p_line); text_editor->call_deferred("cursor_set_line", p_line); } void CodeTextEditor::goto_line_selection(int p_line, int p_begin, int p_end) { text_editor->unfold_line(p_line); text_editor->call_deferred("cursor_set_line", p_line); text_editor->call_deferred("cursor_set_column", p_begin); text_editor->select(p_line, p_begin, p_line, p_end); } void CodeTextEditor::goto_line_centered(int p_line) { goto_line(p_line); text_editor->call_deferred("center_viewport_to_cursor"); } void CodeTextEditor::set_executing_line(int p_line) { text_editor->set_executing_line(p_line); } void CodeTextEditor::clear_executing_line() { text_editor->clear_executing_line(); } Variant CodeTextEditor::get_edit_state() { Dictionary state; state["scroll_position"] = text_editor->get_v_scroll(); state["h_scroll_position"] = text_editor->get_h_scroll(); state["column"] = text_editor->cursor_get_column(); state["row"] = text_editor->cursor_get_line(); state["selection"] = get_text_edit()->is_selection_active(); if (get_text_edit()->is_selection_active()) { state["selection_from_line"] = text_editor->get_selection_from_line(); state["selection_from_column"] = text_editor->get_selection_from_column(); state["selection_to_line"] = text_editor->get_selection_to_line(); state["selection_to_column"] = text_editor->get_selection_to_column(); } state["folded_lines"] = text_editor->get_folded_lines(); state["breakpoints"] = text_editor->get_breakpoints_array(); state["bookmarks"] = text_editor->get_bookmarks_array(); state["syntax_highlighter"] = TTR("Standard"); SyntaxHighlighter *syntax_highlighter = text_editor->_get_syntax_highlighting(); if (syntax_highlighter) { state["syntax_highlighter"] = syntax_highlighter->get_name(); } return state; } void CodeTextEditor::set_edit_state(const Variant &p_state) { Dictionary state = p_state; /* update the row first as it sets the column to 0 */ text_editor->cursor_set_line(state["row"]); text_editor->cursor_set_column(state["column"]); text_editor->set_v_scroll(state["scroll_position"]); text_editor->set_h_scroll(state["h_scroll_position"]); if (state.has("selection")) { text_editor->select(state["selection_from_line"], state["selection_from_column"], state["selection_to_line"], state["selection_to_column"]); } if (state.has("folded_lines")) { Vector folded_lines = state["folded_lines"]; for (int i = 0; i < folded_lines.size(); i++) { text_editor->fold_line(folded_lines[i]); } } if (state.has("breakpoints")) { Array breakpoints = state["breakpoints"]; for (int i = 0; i < breakpoints.size(); i++) { text_editor->set_line_as_breakpoint(breakpoints[i], true); } } if (state.has("bookmarks")) { Array bookmarks = state["bookmarks"]; for (int i = 0; i < bookmarks.size(); i++) { text_editor->set_line_as_bookmark(bookmarks[i], true); } } } void CodeTextEditor::set_error(const String &p_error) { error->set_text(p_error); if (p_error != "") { error->set_default_cursor_shape(CURSOR_POINTING_HAND); } else { error->set_default_cursor_shape(CURSOR_ARROW); } } void CodeTextEditor::set_error_pos(int p_line, int p_column) { error_line = p_line; error_column = p_column; } void CodeTextEditor::goto_error() { if (error->get_text() != "") { text_editor->cursor_set_line(error_line); text_editor->cursor_set_column(error_column); text_editor->center_viewport_to_cursor(); } } void CodeTextEditor::_update_font() { text_editor->add_theme_font_override("font", get_theme_font("source", "EditorFonts")); error->add_theme_font_override("font", get_theme_font("status_source", "EditorFonts")); error->add_theme_color_override("font_color", get_theme_color("error_color", "Editor")); Ref status_bar_font = get_theme_font("status_source", "EditorFonts"); error->add_theme_font_override("font", status_bar_font); int count = status_bar->get_child_count(); for (int i = 0; i < count; i++) { Control *n = Object::cast_to(status_bar->get_child(i)); if (n) { n->add_theme_font_override("font", status_bar_font); } } } void CodeTextEditor::_on_settings_change() { _update_font(); font_size = EditorSettings::get_singleton()->get("interface/editor/code_font_size"); // Auto brace completion. text_editor->set_auto_brace_completion( EDITOR_GET("text_editor/completion/auto_brace_complete")); code_complete_timer->set_wait_time( EDITOR_GET("text_editor/completion/code_complete_delay")); // Call hint settings. text_editor->set_callhint_settings( EDITOR_GET("text_editor/completion/put_callhint_tooltip_below_current_line"), EDITOR_GET("text_editor/completion/callhint_tooltip_offset")); idle->set_wait_time(EDITOR_GET("text_editor/completion/idle_parse_delay")); } void CodeTextEditor::_text_changed_idle_timeout() { _validate_script(); emit_signal("validate_script"); } void CodeTextEditor::validate_script() { idle->start(); } void CodeTextEditor::_warning_label_gui_input(const Ref &p_event) { Ref mb = p_event; if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == BUTTON_LEFT) { _warning_button_pressed(); } } void CodeTextEditor::_warning_button_pressed() { _set_show_warnings_panel(!is_warnings_panel_opened); } void CodeTextEditor::_set_show_warnings_panel(bool p_show) { is_warnings_panel_opened = p_show; emit_signal("show_warnings_panel", p_show); } void CodeTextEditor::_toggle_scripts_pressed() { toggle_scripts_button->set_icon(ScriptEditor::get_singleton()->toggle_scripts_panel() ? get_theme_icon("Back", "EditorIcons") : get_theme_icon("Forward", "EditorIcons")); } void CodeTextEditor::_error_pressed(const Ref &p_event) { Ref mb = p_event; if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == BUTTON_LEFT) { goto_error(); } } void CodeTextEditor::_notification(int p_what) { switch (p_what) { case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: { _load_theme_settings(); emit_signal("load_theme_settings"); } break; case NOTIFICATION_THEME_CHANGED: { if (toggle_scripts_button->is_visible()) { update_toggle_scripts_button(); } _update_font(); } break; case NOTIFICATION_ENTER_TREE: { warning_button->set_icon(get_theme_icon("NodeWarning", "EditorIcons")); add_theme_constant_override("separation", 4 * EDSCALE); } break; case NOTIFICATION_VISIBILITY_CHANGED: { if (toggle_scripts_button->is_visible()) { update_toggle_scripts_button(); } set_process_input(is_visible_in_tree()); } break; default: break; } } void CodeTextEditor::set_warning_nb(int p_warning_nb) { warning_count_label->set_text(itos(p_warning_nb)); warning_count_label->set_visible(p_warning_nb > 0); warning_button->set_visible(p_warning_nb > 0); if (!p_warning_nb) { _set_show_warnings_panel(false); } } void CodeTextEditor::toggle_bookmark() { int line = text_editor->cursor_get_line(); text_editor->set_line_as_bookmark(line, !text_editor->is_line_set_as_bookmark(line)); } void CodeTextEditor::goto_next_bookmark() { List bmarks; text_editor->get_bookmarks(&bmarks); if (bmarks.size() <= 0) { return; } int line = text_editor->cursor_get_line(); if (line >= bmarks[bmarks.size() - 1]) { text_editor->unfold_line(bmarks[0]); text_editor->cursor_set_line(bmarks[0]); text_editor->center_viewport_to_cursor(); } else { for (List::Element *E = bmarks.front(); E; E = E->next()) { int bline = E->get(); if (bline > line) { text_editor->unfold_line(bline); text_editor->cursor_set_line(bline); text_editor->center_viewport_to_cursor(); return; } } } } void CodeTextEditor::goto_prev_bookmark() { List bmarks; text_editor->get_bookmarks(&bmarks); if (bmarks.size() <= 0) { return; } int line = text_editor->cursor_get_line(); if (line <= bmarks[0]) { text_editor->unfold_line(bmarks[bmarks.size() - 1]); text_editor->cursor_set_line(bmarks[bmarks.size() - 1]); text_editor->center_viewport_to_cursor(); } else { for (List::Element *E = bmarks.back(); E; E = E->prev()) { int bline = E->get(); if (bline < line) { text_editor->unfold_line(bline); text_editor->cursor_set_line(bline); text_editor->center_viewport_to_cursor(); return; } } } } void CodeTextEditor::remove_all_bookmarks() { List bmarks; text_editor->get_bookmarks(&bmarks); for (List::Element *E = bmarks.front(); E; E = E->next()) { text_editor->set_line_as_bookmark(E->get(), false); } } void CodeTextEditor::_bind_methods() { ClassDB::bind_method(D_METHOD("_input"), &CodeTextEditor::_input); ClassDB::bind_method("_text_editor_gui_input", &CodeTextEditor::_text_editor_gui_input); ClassDB::bind_method("_line_col_changed", &CodeTextEditor::_line_col_changed); ClassDB::bind_method("_text_changed", &CodeTextEditor::_text_changed); ClassDB::bind_method("_on_settings_change", &CodeTextEditor::_on_settings_change); ClassDB::bind_method("_text_changed_idle_timeout", &CodeTextEditor::_text_changed_idle_timeout); ClassDB::bind_method("_code_complete_timer_timeout", &CodeTextEditor::_code_complete_timer_timeout); ClassDB::bind_method("_complete_request", &CodeTextEditor::_complete_request); ClassDB::bind_method("_font_resize_timeout", &CodeTextEditor::_font_resize_timeout); ClassDB::bind_method("_error_pressed", &CodeTextEditor::_error_pressed); ClassDB::bind_method("_toggle_scripts_pressed", &CodeTextEditor::_toggle_scripts_pressed); ClassDB::bind_method("_warning_button_pressed", &CodeTextEditor::_warning_button_pressed); ClassDB::bind_method("_warning_label_gui_input", &CodeTextEditor::_warning_label_gui_input); ADD_SIGNAL(MethodInfo("validate_script")); ADD_SIGNAL(MethodInfo("load_theme_settings")); ADD_SIGNAL(MethodInfo("show_warnings_panel")); } void CodeTextEditor::set_code_complete_func(CodeTextEditorCodeCompleteFunc p_code_complete_func, void *p_ud) { code_complete_func = p_code_complete_func; code_complete_ud = p_ud; } void CodeTextEditor::show_toggle_scripts_button() { toggle_scripts_button->show(); } void CodeTextEditor::update_toggle_scripts_button() { toggle_scripts_button->set_icon(ScriptEditor::get_singleton()->is_scripts_panel_toggled() ? get_theme_icon("Back", "EditorIcons") : get_theme_icon("Forward", "EditorIcons")); toggle_scripts_button->set_tooltip(TTR("Toggle Scripts Panel") + " (" + ED_GET_SHORTCUT("script_editor/toggle_scripts_panel")->get_as_text() + ")"); } CodeTextEditor::CodeTextEditor() { code_complete_func = nullptr; ED_SHORTCUT("script_editor/zoom_in", TTR("Zoom In"), KEY_MASK_CMD | KEY_EQUAL); ED_SHORTCUT("script_editor/zoom_out", TTR("Zoom Out"), KEY_MASK_CMD | KEY_MINUS); ED_SHORTCUT("script_editor/reset_zoom", TTR("Reset Zoom"), KEY_MASK_CMD | KEY_0); text_editor = memnew(TextEdit); add_child(text_editor); text_editor->set_v_size_flags(SIZE_EXPAND_FILL); // Added second so it opens at the bottom, so it won't shift the entire text editor when opening. find_replace_bar = memnew(FindReplaceBar); add_child(find_replace_bar); find_replace_bar->set_h_size_flags(SIZE_EXPAND_FILL); find_replace_bar->hide(); find_replace_bar->set_text_edit(text_editor); text_editor->set_show_line_numbers(true); text_editor->set_brace_matching(true); text_editor->set_auto_indent(true); text_editor->set_deselect_on_focus_loss_enabled(false); status_bar = memnew(HBoxContainer); add_child(status_bar); status_bar->set_h_size_flags(SIZE_EXPAND_FILL); status_bar->set_custom_minimum_size(Size2(0, 24 * EDSCALE)); // Adjust for the height of the warning icon. idle = memnew(Timer); add_child(idle); idle->set_one_shot(true); idle->set_wait_time(EDITOR_GET("text_editor/completion/idle_parse_delay")); code_complete_timer = memnew(Timer); add_child(code_complete_timer); code_complete_timer->set_one_shot(true); code_complete_timer->set_wait_time(EDITOR_GET("text_editor/completion/code_complete_delay")); error_line = 0; error_column = 0; toggle_scripts_button = memnew(ToolButton); toggle_scripts_button->connect("pressed", this, "_toggle_scripts_pressed"); status_bar->add_child(toggle_scripts_button); toggle_scripts_button->hide(); // Error ScrollContainer *scroll = memnew(ScrollContainer); scroll->set_h_size_flags(SIZE_EXPAND_FILL); scroll->set_v_size_flags(SIZE_EXPAND_FILL); scroll->set_enable_v_scroll(false); status_bar->add_child(scroll); error = memnew(Label); scroll->add_child(error); error->set_v_size_flags(SIZE_EXPAND | SIZE_SHRINK_CENTER); error->set_mouse_filter(MOUSE_FILTER_STOP); error->connect("gui_input", this, "_error_pressed"); find_replace_bar->connect("error", error, "set_text"); // Warnings warning_button = memnew(ToolButton); status_bar->add_child(warning_button); warning_button->set_v_size_flags(SIZE_EXPAND | SIZE_SHRINK_CENTER); warning_button->set_default_cursor_shape(CURSOR_POINTING_HAND); warning_button->connect("pressed", this, "_warning_button_pressed"); warning_button->set_tooltip(TTR("Warnings")); warning_count_label = memnew(Label); status_bar->add_child(warning_count_label); warning_count_label->set_v_size_flags(SIZE_EXPAND | SIZE_SHRINK_CENTER); warning_count_label->set_align(Label::ALIGN_RIGHT); warning_count_label->set_default_cursor_shape(CURSOR_POINTING_HAND); warning_count_label->set_mouse_filter(MOUSE_FILTER_STOP); warning_count_label->set_tooltip(TTR("Warnings")); warning_count_label->add_theme_color_override("font_color", EditorNode::get_singleton()->get_gui_base()->get_theme_color("warning_color", "Editor")); warning_count_label->add_theme_font_override("font", EditorNode::get_singleton()->get_gui_base()->get_theme_font("status_source", "EditorFonts")); warning_count_label->connect("gui_input", this, "_warning_label_gui_input"); is_warnings_panel_opened = false; set_warning_nb(0); // Line and column line_and_col_txt = memnew(Label); status_bar->add_child(line_and_col_txt); line_and_col_txt->set_v_size_flags(SIZE_EXPAND | SIZE_SHRINK_CENTER); line_and_col_txt->add_theme_font_override("font", EditorNode::get_singleton()->get_gui_base()->get_theme_font("status_source", "EditorFonts")); line_and_col_txt->set_tooltip(TTR("Line and column numbers.")); line_and_col_txt->set_mouse_filter(MOUSE_FILTER_STOP); text_editor->connect("gui_input", this, "_text_editor_gui_input"); text_editor->connect("cursor_changed", this, "_line_col_changed"); text_editor->connect("text_changed", this, "_text_changed"); text_editor->connect("request_completion", this, "_complete_request"); Vector cs; cs.push_back("."); cs.push_back(","); cs.push_back("("); cs.push_back("="); cs.push_back("$"); text_editor->set_completion(true, cs); idle->connect("timeout", this, "_text_changed_idle_timeout"); code_complete_timer->connect("timeout", this, "_code_complete_timer_timeout"); font_resize_val = 0; font_size = EditorSettings::get_singleton()->get("interface/editor/code_font_size"); font_resize_timer = memnew(Timer); add_child(font_resize_timer); font_resize_timer->set_one_shot(true); font_resize_timer->set_wait_time(0.07); font_resize_timer->connect("timeout", this, "_font_resize_timeout"); EditorSettings::get_singleton()->connect("settings_changed", this, "_on_settings_change"); }