/**************************************************************************/ /* script_editor_plugin.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. */ /**************************************************************************/ #pragma once #include "core/error/error_list.h" #include "core/object/script_language.h" #include "editor/plugins/editor_plugin.h" #include "editor/script/script_editor_base.h" #include "scene/gui/panel_container.h" #include "scene/resources/text_file.h" class CodeTextEditor; class EditorFileDialog; class EditorHelpSearch; class FilterLineEdit; class HSplitContainer; class ItemList; class TabContainer; class Tree; class WindowWrapper; class ScriptEditorQuickOpen : public ConfirmationDialog { GDCLASS(ScriptEditorQuickOpen, ConfirmationDialog); FilterLineEdit *search_box = nullptr; Tree *search_options = nullptr; String function; void _update_search(); Vector functions; void _confirmed(); void _text_changed(const String &p_newtext); protected: void _notification(int p_what); static void _bind_methods(); public: void popup_dialog(const Vector &p_functions, bool p_dontclear = false); ScriptEditorQuickOpen(); }; class DocumentList : public VBoxContainer { GDCLASS(DocumentList, VBoxContainer); struct ItemData { String display_name; String tooltip; Ref icon; int index = 0; bool hidden = false; bool tool = false; bool used_in_scene = false; bool has_error = false; }; LocalVector items; ItemList *item_list = nullptr; LineEdit *filter = nullptr; PopupMenu *context_menu = nullptr; ScriptEditor *script_editor; bool script_temperature_enabled = false; int temperature_history_size = 0; void _document_selected(int p_index); void _document_clicked(int p_index, Vector2 p_local_mouse_pos, MouseButton p_mouse_button_index); void _show_context_menu(); void _update_item_list(); Variant get_drag_data_fw(const Point2 &p_point, Control *p_from); bool can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const; void drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from); protected: void _notification(int p_what); public: void update_list(); void ensure_current_is_visible(); void goto_next_document(bool p_previous = false); void update_editor_settings(); DocumentList(ScriptEditor *p_script_editor); }; class DocumentOutline : public VBoxContainer { GDCLASS(DocumentOutline, VBoxContainer); ScriptEditor *script_editor = nullptr; ItemList *item_list = nullptr; HBoxContainer *buttons_hbox = nullptr; FilterLineEdit *filter = nullptr; Button *sort_button = nullptr; bool members_overview_enabled = false; bool help_overview_enabled = false; void _toggle_sort(bool p_alphabetic_sort); void _item_list_selected(int p_idx); protected: void _notification(int p_what); public: void update_editor_settings(); void update_outline(); void update_visibility(); DocumentOutline(ScriptEditor *p_script_editor); }; class EditorScriptCodeCompletionCache; class FindInFiles; class TextFile; class ShaderCreateDialog; class ScriptEditor : public PanelContainer { GDCLASS(ScriptEditor, PanelContainer); enum MenuOptions { // File. FILE_MENU_NEW_SCRIPT, FILE_MENU_NEW_TEXTFILE, FILE_MENU_NEW_SHADER, FILE_MENU_NEW_INCLUDE, FILE_MENU_OPEN, FILE_MENU_OPEN_SHADER, FILE_MENU_OPEN_INCLUDE, FILE_MENU_REOPEN_CLOSED, FILE_MENU_OPEN_RECENT, FILE_MENU_SAVE, FILE_MENU_SAVE_AS, FILE_MENU_SAVE_ALL, FILE_MENU_INSPECT, FILE_MENU_INSPECT_NATIVE_SHADER_CODE, FILE_MENU_SOFT_RELOAD_TOOL, FILE_MENU_COPY_PATH, FILE_MENU_COPY_UID, FILE_MENU_SHOW_IN_FILE_SYSTEM, FILE_MENU_HISTORY_PREV, FILE_MENU_HISTORY_NEXT, FILE_MENU_THEME_SUBMENU, FILE_MENU_CLOSE, FILE_MENU_CLOSE_ALL, FILE_MENU_CLOSE_OTHER_TABS, FILE_MENU_CLOSE_TABS_BELOW, FILE_MENU_CLOSE_DOCS, FILE_MENU_RUN, FILE_MENU_TOGGLE_FILES_PANEL, FILE_MENU_MOVE_UP, FILE_MENU_MOVE_DOWN, FILE_MENU_SORT, // Search. HELP_SEARCH_FIND, HELP_SEARCH_FIND_NEXT, HELP_SEARCH_FIND_PREVIOUS, SEARCH_IN_FILES, REPLACE_IN_FILES, SEARCH_HELP, SEARCH_WEBSITE, // Theme. THEME_IMPORT, THEME_RELOAD, THEME_SAVE_AS, }; enum DocumentSortMode { SORT_BY_NAME, SORT_BY_PATH, SORT_BY_NONE, }; enum DocumentNameDisplayMode { DISPLAY_NAME, DISPLAY_DIR_AND_NAME, DISPLAY_FULL_PATH, }; HBoxContainer *menu_hb = nullptr; MenuButton *file_menu = nullptr; MenuButton *script_search_menu = nullptr; MenuButton *debug_menu = nullptr; Timer *autosave_timer = nullptr; LocalVector editor_menus; PopupMenu *recent_scripts = nullptr; PopupMenu *theme_submenu = nullptr; Button *help_search = nullptr; Button *site_search = nullptr; Button *make_floating = nullptr; bool is_floating = false; EditorHelpSearch *help_search_dialog = nullptr; friend class DocumentList; DocumentList *document_list = nullptr; HSplitContainer *script_split = nullptr; DocumentOutline *document_outline = nullptr; VSplitContainer *list_split = nullptr; TabContainer *tab_container = nullptr; AcceptDialog *error_dialog = nullptr; ConfirmationDialog *erase_tab_confirm = nullptr; FindReplaceBar *find_replace_bar = nullptr; EditorFileDialog *file_dialog = nullptr; ScriptCreateDialog *script_create_dialog = nullptr; ShaderCreateDialog *shader_create_dialog = nullptr; float zoom_factor = 1.0f; HBoxContainer *script_name_button_hbox = nullptr; Control *script_name_button_left_spacer = nullptr; Control *script_name_button_right_spacer = nullptr; Button *script_name_button = nullptr; int script_name_width = 0; bool list_update_queued = false; bool document_sort_group_help_pages = false; DocumentSortMode document_sort_by_mode = SORT_BY_NAME; DocumentNameDisplayMode document_display_name_mode = DISPLAY_NAME; bool highlight_scene_scripts = false; Button *script_back = nullptr; Button *script_forward = nullptr; FindInFiles *find_in_files = nullptr; WindowWrapper *window_wrapper = nullptr; #ifdef ANDROID_ENABLED Control *virtual_keyboard_spacer = nullptr; int last_kb_height = -1; #endif enum { SCRIPT_EDITOR_FUNC_MAX = 32, }; static int script_editor_func_count; static CreateScriptEditorFunc script_editor_funcs[SCRIPT_EDITOR_FUNC_MAX]; Vector> syntax_highlighters; struct ScriptHistory { Control *control = nullptr; Dictionary state; }; Vector history; int history_pos; List previous_scripts; List script_close_queue; bool restoring_layout = false; bool grab_focus_block = false; int edit_pass = 0; void _menu_option(int p_option); void _theme_option(int p_option); void _show_save_theme_as_dialog(); bool _has_docs_tab() const; bool _has_script_tab() const; Tree *disk_changed_list = nullptr; ConfirmationDialog *disk_changed = nullptr; void _resave_scripts(const String &p_str); bool _test_script_times_on_disk(Ref p_for_script = Ref()); bool _script_exists(const String &p_path) const; void _add_recent_script(const String &p_path); void _update_recent_scripts(); void _open_recent_script(int p_idx); void _show_error_dialog(const String &p_path); void _close_tab(int p_idx, bool p_save = true); void _update_find_replace_bar(); void _close_current_tab(bool p_save = true); void _close_discard_current_tab(const String &p_str); void _close_docs_tab(); void _close_other_tabs(); void _close_tabs_below(); void _close_all_tabs(); void _queue_close_tabs(); void _copy_script_path(); void _copy_script_uid(); void _ask_close_current_unsaved_tab(ScriptEditorBase *p_seb); bool pending_auto_reload; bool auto_reload_running_scripts; Vector script_paths_to_reload; void _live_auto_reload_running_scripts(); void _update_selected_editor_menu(); void _add_callback(Object *p_obj, const String &p_function, const PackedStringArray &p_args); void _res_saved_callback(const Ref &p_res); void _scene_saved_callback(const String &p_path); void _mark_built_in_scripts_as_saved(const String &p_parent_path); bool trim_trailing_whitespace_on_save; bool trim_final_newlines_on_save; bool convert_indent_on_save; bool external_editor_active; void _goto_script_line2(int p_line); void _goto_script_line(Ref p_script, int p_line); void _change_execution(Ref p_script, int p_line = -1, bool p_set = false); void _set_execution(Ref p_script, int p_line) { _change_execution(p_script, p_line, true); } void _clear_execution(Ref p_script) { _change_execution(p_script); } String _get_debug_tooltip(const String &p_text, Node *p_se); void _resource_created(Ref p_res); void _set_breakpoint(Ref p_script, int p_line, bool p_enabled); void _clear_breakpoints(); Array _get_cached_breakpoints_for_script(const String &p_path) const; ScriptEditorBase *_get_current_editor() const; TypedArray _get_open_script_editors() const; Ref script_editor_cache; String cache_path; void _save_editor_state(ScriptEditorBase *p_editor); void _save_layout(); void _apply_editor_settings(); void _update_filenames(); void _files_moved(const String &p_old_file, const String &p_new_file); void _file_removed(const String &p_file); void _autosave_scripts(); void _update_autosave_timer(); void _reload_scripts(bool p_refresh_only = false); void _auto_format_text(ScriptEditorBase *p_seb); void _connect_to_scene(); void _connect_to_scene_recursive(Node *p_current, Node *p_base); void _update_document_list(); void _queue_update_list(); void _update_online_doc(); void _split_dragged(float); virtual void input(const Ref &p_event) override; virtual void shortcut_input(const Ref &p_event) override; void _setup_popup_menu(PopupMenu *p_menu, bool p_is_context_menu = true); void _prepare_popup_menu(PopupMenu *p_menu, bool p_is_context_menu = true); void _prepare_file_menu(); void _file_menu_closed(); void _calculate_script_name_button_size(); void _calculate_script_name_button_ratio(); void _update_document_name_button(); void _help_search(const String &p_text); void _history_forward(); void _history_back(); void _roll_back_to_pre_tab(); void _help_class_open(const String &p_class); void _help_class_goto(const String &p_desc); void _update_history_arrows(); void _save_new_history(const Dictionary &p_state, Control *p_control); void _save_previous_state(const Dictionary &p_state, Control *p_control); void _compress_history_patterns(bool p_once); void _go_to_tab(int p_idx, bool p_save_history = false); void _update_history_pos(int p_new_pos); void _update_modified_scripts_for_external_editor(Ref