/*************************************************************************/ /* code_editor.h */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2021 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. */ /*************************************************************************/ #ifndef CODE_EDITOR_H #define CODE_EDITOR_H #include "editor/editor_plugin.h" #include "scene/gui/check_box.h" #include "scene/gui/check_button.h" #include "scene/gui/code_edit.h" #include "scene/gui/dialogs.h" #include "scene/gui/line_edit.h" #include "scene/main/timer.h" class GotoLineDialog : public ConfirmationDialog { GDCLASS(GotoLineDialog, ConfirmationDialog); Label *line_label; LineEdit *line; CodeEdit *text_editor; virtual void ok_pressed() override; public: void popup_find_line(CodeEdit *p_edit); int get_line() const; void set_text_editor(CodeEdit *p_text_editor); GotoLineDialog(); }; class CodeTextEditor; class FindReplaceBar : public HBoxContainer { GDCLASS(FindReplaceBar, HBoxContainer); LineEdit *search_text; Label *matches_label; Button *find_prev; Button *find_next; CheckBox *case_sensitive; CheckBox *whole_words; TextureButton *hide_button; LineEdit *replace_text; Button *replace; Button *replace_all; CheckBox *selection_only; VBoxContainer *vbc_lineedit; HBoxContainer *hbc_button_replace; HBoxContainer *hbc_option_replace; CodeTextEditor *base_text_editor = nullptr; CodeEdit *text_editor; int result_line; int result_col; int results_count; bool replace_all_mode; bool preserve_cursor; void _get_search_from(int &r_line, int &r_col); void _update_results_count(); void _update_matches_label(); void _show_search(bool p_focus_replace = false, bool p_show_only = false); void _hide_bar(); void _editor_text_changed(); void _search_options_changed(bool p_pressed); void _search_text_changed(const String &p_text); void _search_text_submitted(const String &p_text); void _replace_text_submitted(const String &p_text); void _update_size(); protected: void _notification(int p_what); virtual void unhandled_input(const Ref<InputEvent> &p_event) override; bool _search(uint32_t p_flags, int p_from_line, int p_from_col); void _replace(); void _replace_all(); static void _bind_methods(); public: String get_search_text() const; String get_replace_text() const; bool is_case_sensitive() const; bool is_whole_words() const; bool is_selection_only() const; void set_error(const String &p_label); void set_text_edit(CodeTextEditor *p_text_editor); void popup_search(bool p_show_only = false); void popup_replace(); bool search_current(); bool search_prev(); bool search_next(); FindReplaceBar(); }; typedef void (*CodeTextEditorCodeCompleteFunc)(void *p_ud, const String &p_code, List<ScriptCodeCompletionOption> *r_options, bool &r_forced); class CodeTextEditor : public VBoxContainer { GDCLASS(CodeTextEditor, VBoxContainer); CodeEdit *text_editor; FindReplaceBar *find_replace_bar = nullptr; HBoxContainer *status_bar; Button *toggle_scripts_button; Button *error_button; Button *warning_button; Label *line_and_col_txt; Label *info; Timer *idle; Timer *code_complete_timer; Timer *font_resize_timer; int font_resize_val; real_t font_size; Label *error; int error_line; int error_column; bool settings_changed = false; void _on_settings_change(); void _apply_settings_change(); void _update_text_editor_theme(); void _complete_request(); Ref<Texture2D> _get_completion_icon(const ScriptCodeCompletionOption &p_option); void _font_resize_timeout(); bool _add_font_size(int p_delta); virtual void input(const Ref<InputEvent> &event) override; void _text_editor_gui_input(const Ref<InputEvent> &p_event); void _zoom_in(); void _zoom_out(); void _zoom_changed(); void _reset_zoom(); Color completion_font_color; Color completion_string_color; Color completion_comment_color; CodeTextEditorCodeCompleteFunc code_complete_func; void *code_complete_ud; void _error_button_pressed(); void _warning_button_pressed(); void _set_show_errors_panel(bool p_show); void _set_show_warnings_panel(bool p_show); void _error_pressed(const Ref<InputEvent> &p_event); void _delete_line(int p_line); void _toggle_scripts_pressed(); protected: virtual void _load_theme_settings() {} virtual void _validate_script() {} virtual void _code_complete_script(const String &p_code, List<ScriptCodeCompletionOption> *r_options) {} void _text_changed_idle_timeout(); void _code_complete_timer_timeout(); void _text_changed(); void _line_col_changed(); void _notification(int); static void _bind_methods(); bool is_warnings_panel_opened; bool is_errors_panel_opened; public: void trim_trailing_whitespace(); void insert_final_newline(); void convert_indent_to_spaces(); void convert_indent_to_tabs(); enum CaseStyle { UPPER, LOWER, CAPITALIZE, }; void convert_case(CaseStyle p_case); void move_lines_up(); void move_lines_down(); void delete_lines(); void duplicate_selection(); /// Toggle inline comment on currently selected lines, or on current line if nothing is selected, /// by adding or removing comment delimiter void toggle_inline_comment(const String &delimiter); void goto_line(int p_line); void goto_line_selection(int p_line, int p_begin, int p_end); void goto_line_centered(int p_line); void set_executing_line(int p_line); void clear_executing_line(); Variant get_edit_state(); void set_edit_state(const Variant &p_state); void set_error_count(int p_error_count); void set_warning_count(int p_warning_count); void update_editor_settings(); void set_error(const String &p_error); void set_error_pos(int p_line, int p_column); void update_line_and_column() { _line_col_changed(); } CodeEdit *get_text_editor() { return text_editor; } FindReplaceBar *get_find_replace_bar() { return find_replace_bar; } void set_find_replace_bar(FindReplaceBar *p_bar); void remove_find_replace_bar(); virtual void apply_code() {} void goto_error(); void toggle_bookmark(); void goto_next_bookmark(); void goto_prev_bookmark(); void remove_all_bookmarks(); void set_code_complete_func(CodeTextEditorCodeCompleteFunc p_code_complete_func, void *p_ud); void validate_script(); void show_toggle_scripts_button(); void update_toggle_scripts_button(); CodeTextEditor(); }; #endif // CODE_EDITOR_H