/*************************************************************************/ /* editor_help_search.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2020 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 "editor_help_search.h" #include "core/os/keyboard.h" #include "editor_feature_profile.h" #include "editor_node.h" #include "editor_scale.h" void EditorHelpSearch::_update_icons() { search_box->set_right_icon(get_icon("Search", "EditorIcons")); search_box->set_clear_button_enabled(true); search_box->add_icon_override("right_icon", get_icon("Search", "EditorIcons")); case_sensitive_button->set_icon(get_icon("MatchCase", "EditorIcons")); hierarchy_button->set_icon(get_icon("ClassList", "EditorIcons")); if (is_visible_in_tree()) _update_results(); } void EditorHelpSearch::_update_results() { String term = search_box->get_text(); int search_flags = filter_combo->get_selected_id(); if (case_sensitive_button->is_pressed()) search_flags |= SEARCH_CASE_SENSITIVE; if (hierarchy_button->is_pressed()) search_flags |= SEARCH_SHOW_HIERARCHY; search = Ref<Runner>(memnew(Runner(this, results_tree, term, search_flags))); set_process(true); } void EditorHelpSearch::_search_box_gui_input(const Ref<InputEvent> &p_event) { // Redirect up and down navigational key events to the results list. Ref<InputEventKey> key = p_event; if (key.is_valid()) { switch (key->get_scancode()) { case KEY_UP: case KEY_DOWN: case KEY_PAGEUP: case KEY_PAGEDOWN: { results_tree->call("_gui_input", key); search_box->accept_event(); } break; } } } void EditorHelpSearch::_search_box_text_changed(const String &p_text) { _update_results(); } void EditorHelpSearch::_filter_combo_item_selected(int p_option) { _update_results(); } void EditorHelpSearch::_confirmed() { TreeItem *item = results_tree->get_selected(); if (!item) return; // Activate the script editor and emit the signal with the documentation link to display. EditorNode::get_singleton()->set_visible_editor(EditorNode::EDITOR_SCRIPT); emit_signal("go_to_help", item->get_metadata(0)); hide(); } void EditorHelpSearch::_notification(int p_what) { switch (p_what) { case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: { _update_icons(); } break; case NOTIFICATION_ENTER_TREE: { connect("confirmed", this, "_confirmed"); _update_icons(); } break; case NOTIFICATION_POPUP_HIDE: { results_tree->call_deferred("clear"); // Wait for the Tree's mouse event propagation. get_ok()->set_disabled(true); EditorSettings::get_singleton()->set_project_metadata("dialog_bounds", "search_help", get_rect()); } break; case NOTIFICATION_PROCESS: { // Update background search. if (search.is_valid()) { if (search->work()) { // Search done. // Only point to the perfect match if it's a new search, and not just reopening a old one. if (!old_search) results_tree->ensure_cursor_is_visible(); else old_search = false; get_ok()->set_disabled(!results_tree->get_selected()); search = Ref<Runner>(); set_process(false); } } else { set_process(false); } } break; } } void EditorHelpSearch::_bind_methods() { ClassDB::bind_method(D_METHOD("_update_results"), &EditorHelpSearch::_update_results); ClassDB::bind_method(D_METHOD("_search_box_gui_input"), &EditorHelpSearch::_search_box_gui_input); ClassDB::bind_method(D_METHOD("_search_box_text_changed"), &EditorHelpSearch::_search_box_text_changed); ClassDB::bind_method(D_METHOD("_filter_combo_item_selected"), &EditorHelpSearch::_filter_combo_item_selected); ClassDB::bind_method(D_METHOD("_confirmed"), &EditorHelpSearch::_confirmed); ADD_SIGNAL(MethodInfo("go_to_help")); } void EditorHelpSearch::popup_dialog() { popup_dialog(search_box->get_text()); } void EditorHelpSearch::popup_dialog(const String &p_term) { // Restore valid window bounds or pop up at default size. Rect2 saved_size = EditorSettings::get_singleton()->get_project_metadata("dialog_bounds", "search_help", Rect2()); if (saved_size != Rect2()) popup(saved_size); else popup_centered_ratio(0.5F); if (p_term == "") { search_box->clear(); } else { if (old_term == p_term) old_search = true; else old_term = p_term; search_box->set_text(p_term); search_box->select_all(); } search_box->grab_focus(); _update_results(); } EditorHelpSearch::EditorHelpSearch() { old_search = false; set_hide_on_ok(false); set_resizable(true); set_title(TTR("Search Help")); get_ok()->set_disabled(true); get_ok()->set_text(TTR("Open")); // Split search and results area. VBoxContainer *vbox = memnew(VBoxContainer); add_child(vbox); // Create the search box and filter controls (at the top). HBoxContainer *hbox = memnew(HBoxContainer); vbox->add_child(hbox); search_box = memnew(LineEdit); search_box->set_custom_minimum_size(Size2(200, 0) * EDSCALE); search_box->set_h_size_flags(SIZE_EXPAND_FILL); search_box->connect("gui_input", this, "_search_box_gui_input"); search_box->connect("text_changed", this, "_search_box_text_changed"); register_text_enter(search_box); hbox->add_child(search_box); case_sensitive_button = memnew(ToolButton); case_sensitive_button->set_tooltip(TTR("Case Sensitive")); case_sensitive_button->connect("pressed", this, "_update_results"); case_sensitive_button->set_toggle_mode(true); case_sensitive_button->set_focus_mode(FOCUS_NONE); hbox->add_child(case_sensitive_button); hierarchy_button = memnew(ToolButton); hierarchy_button->set_tooltip(TTR("Show Hierarchy")); hierarchy_button->connect("pressed", this, "_update_results"); hierarchy_button->set_toggle_mode(true); hierarchy_button->set_pressed(true); hierarchy_button->set_focus_mode(FOCUS_NONE); hbox->add_child(hierarchy_button); filter_combo = memnew(OptionButton); filter_combo->set_custom_minimum_size(Size2(200, 0) * EDSCALE); filter_combo->set_stretch_ratio(0); // Fixed width. filter_combo->add_item(TTR("Display All"), SEARCH_ALL); filter_combo->add_separator(); filter_combo->add_item(TTR("Classes Only"), SEARCH_CLASSES); filter_combo->add_item(TTR("Methods Only"), SEARCH_METHODS); filter_combo->add_item(TTR("Signals Only"), SEARCH_SIGNALS); filter_combo->add_item(TTR("Constants Only"), SEARCH_CONSTANTS); filter_combo->add_item(TTR("Properties Only"), SEARCH_PROPERTIES); filter_combo->add_item(TTR("Theme Properties Only"), SEARCH_THEME_ITEMS); filter_combo->connect("item_selected", this, "_filter_combo_item_selected"); hbox->add_child(filter_combo); // Create the results tree. results_tree = memnew(Tree); results_tree->set_v_size_flags(SIZE_EXPAND_FILL); results_tree->set_columns(2); results_tree->set_column_title(0, TTR("Name")); results_tree->set_column_title(1, TTR("Member Type")); results_tree->set_column_expand(1, false); results_tree->set_column_min_width(1, 150 * EDSCALE); results_tree->set_custom_minimum_size(Size2(0, 100) * EDSCALE); results_tree->set_hide_root(true); results_tree->set_select_mode(Tree::SELECT_ROW); results_tree->connect("item_activated", this, "_confirmed"); results_tree->connect("item_selected", get_ok(), "set_disabled", varray(false)); vbox->add_child(results_tree, true); } bool EditorHelpSearch::Runner::_is_class_disabled_by_feature_profile(const StringName &p_class) { Ref<EditorFeatureProfile> profile = EditorFeatureProfileManager::get_singleton()->get_current_profile(); if (profile.is_null()) { return false; } StringName class_name = p_class; while (class_name != StringName()) { if (!ClassDB::class_exists(class_name)) { return false; } if (profile->is_class_disabled(class_name)) { return true; } class_name = ClassDB::get_parent_class(class_name); } return false; } bool EditorHelpSearch::Runner::_slice() { bool phase_done = false; switch (phase) { case PHASE_MATCH_CLASSES_INIT: phase_done = _phase_match_classes_init(); break; case PHASE_MATCH_CLASSES: phase_done = _phase_match_classes(); break; case PHASE_CLASS_ITEMS_INIT: phase_done = _phase_class_items_init(); break; case PHASE_CLASS_ITEMS: phase_done = _phase_class_items(); break; case PHASE_MEMBER_ITEMS_INIT: phase_done = _phase_member_items_init(); break; case PHASE_MEMBER_ITEMS: phase_done = _phase_member_items(); break; case PHASE_SELECT_MATCH: phase_done = _phase_select_match(); break; case PHASE_MAX: return true; default: WARN_PRINT("Invalid or unhandled phase in EditorHelpSearch::Runner, aborting search."); return true; }; if (phase_done) phase++; return false; } bool EditorHelpSearch::Runner::_phase_match_classes_init() { iterator_doc = EditorHelp::get_doc_data()->class_list.front(); matches.clear(); matched_item = NULL; return true; } bool EditorHelpSearch::Runner::_phase_match_classes() { DocData::ClassDoc &class_doc = iterator_doc->value(); if (!_is_class_disabled_by_feature_profile(class_doc.name)) { matches[class_doc.name] = ClassMatch(); ClassMatch &match = matches[class_doc.name]; match.doc = &class_doc; // Match class name. if (search_flags & SEARCH_CLASSES) match.name = term == "" || _match_string(term, class_doc.name); // Match members if the term is long enough. if (term.length() > 1) { if (search_flags & SEARCH_METHODS) for (int i = 0; i < class_doc.methods.size(); i++) { String method_name = (search_flags & SEARCH_CASE_SENSITIVE) ? class_doc.methods[i].name : class_doc.methods[i].name.to_lower(); String aux_term = (search_flags & SEARCH_CASE_SENSITIVE) ? term : term.to_lower(); if (aux_term.begins_with(".")) aux_term = aux_term.right(1); if (aux_term.ends_with("(")) aux_term = aux_term.left(aux_term.length() - 1).strip_edges(); if (aux_term.is_subsequence_of(method_name)) match.methods.push_back(const_cast<DocData::MethodDoc *>(&class_doc.methods[i])); } if (search_flags & SEARCH_SIGNALS) for (int i = 0; i < class_doc.signals.size(); i++) if (_match_string(term, class_doc.signals[i].name)) match.signals.push_back(const_cast<DocData::MethodDoc *>(&class_doc.signals[i])); if (search_flags & SEARCH_CONSTANTS) for (int i = 0; i < class_doc.constants.size(); i++) if (_match_string(term, class_doc.constants[i].name)) match.constants.push_back(const_cast<DocData::ConstantDoc *>(&class_doc.constants[i])); if (search_flags & SEARCH_PROPERTIES) for (int i = 0; i < class_doc.properties.size(); i++) if (_match_string(term, class_doc.properties[i].name) || _match_string(term, class_doc.properties[i].getter) || _match_string(term, class_doc.properties[i].setter)) match.properties.push_back(const_cast<DocData::PropertyDoc *>(&class_doc.properties[i])); if (search_flags & SEARCH_THEME_ITEMS) for (int i = 0; i < class_doc.theme_properties.size(); i++) if (_match_string(term, class_doc.theme_properties[i].name)) match.theme_properties.push_back(const_cast<DocData::PropertyDoc *>(&class_doc.theme_properties[i])); } } iterator_doc = iterator_doc->next(); return !iterator_doc; } bool EditorHelpSearch::Runner::_phase_class_items_init() { iterator_match = matches.front(); results_tree->clear(); root_item = results_tree->create_item(); class_items.clear(); return true; } bool EditorHelpSearch::Runner::_phase_class_items() { ClassMatch &match = iterator_match->value(); if (search_flags & SEARCH_SHOW_HIERARCHY) { if (match.required()) _create_class_hierarchy(match); } else { if (match.name) _create_class_item(root_item, match.doc, false); } iterator_match = iterator_match->next(); return !iterator_match; } bool EditorHelpSearch::Runner::_phase_member_items_init() { iterator_match = matches.front(); return true; } bool EditorHelpSearch::Runner::_phase_member_items() { ClassMatch &match = iterator_match->value(); TreeItem *parent = (search_flags & SEARCH_SHOW_HIERARCHY) ? class_items[match.doc->name] : root_item; for (int i = 0; i < match.methods.size(); i++) _create_method_item(parent, match.doc, match.methods[i]); for (int i = 0; i < match.signals.size(); i++) _create_signal_item(parent, match.doc, match.signals[i]); for (int i = 0; i < match.constants.size(); i++) _create_constant_item(parent, match.doc, match.constants[i]); for (int i = 0; i < match.properties.size(); i++) _create_property_item(parent, match.doc, match.properties[i]); for (int i = 0; i < match.theme_properties.size(); i++) _create_theme_property_item(parent, match.doc, match.theme_properties[i]); iterator_match = iterator_match->next(); return !iterator_match; } bool EditorHelpSearch::Runner::_phase_select_match() { if (matched_item) matched_item->select(0); return true; } bool EditorHelpSearch::Runner::_match_string(const String &p_term, const String &p_string) const { if (search_flags & SEARCH_CASE_SENSITIVE) return p_term.is_subsequence_of(p_string); else return p_term.is_subsequence_ofi(p_string); } void EditorHelpSearch::Runner::_match_item(TreeItem *p_item, const String &p_text) { if (!matched_item) { if (search_flags & SEARCH_CASE_SENSITIVE) { if (p_text.casecmp_to(term) == 0) matched_item = p_item; } else { if (p_text.nocasecmp_to(term) == 0) matched_item = p_item; } } } TreeItem *EditorHelpSearch::Runner::_create_class_hierarchy(const ClassMatch &p_match) { if (class_items.has(p_match.doc->name)) return class_items[p_match.doc->name]; // Ensure parent nodes are created first. TreeItem *parent = root_item; if (p_match.doc->inherits != "") { if (class_items.has(p_match.doc->inherits)) { parent = class_items[p_match.doc->inherits]; } else { ClassMatch &base_match = matches[p_match.doc->inherits]; parent = _create_class_hierarchy(base_match); } } TreeItem *class_item = _create_class_item(parent, p_match.doc, !p_match.name); class_items[p_match.doc->name] = class_item; return class_item; } TreeItem *EditorHelpSearch::Runner::_create_class_item(TreeItem *p_parent, const DocData::ClassDoc *p_doc, bool p_gray) { Ref<Texture> icon = empty_icon; if (ui_service->has_icon(p_doc->name, "EditorIcons")) icon = ui_service->get_icon(p_doc->name, "EditorIcons"); else if (ClassDB::class_exists(p_doc->name) && ClassDB::is_parent_class(p_doc->name, "Object")) icon = ui_service->get_icon("Object", "EditorIcons"); String tooltip = p_doc->brief_description.strip_edges(); TreeItem *item = results_tree->create_item(p_parent); item->set_icon(0, icon); item->set_text(0, p_doc->name); item->set_text(1, TTR("Class")); item->set_tooltip(0, tooltip); item->set_tooltip(1, tooltip); item->set_metadata(0, "class_name:" + p_doc->name); if (p_gray) { item->set_custom_color(0, disabled_color); item->set_custom_color(1, disabled_color); } _match_item(item, p_doc->name); return item; } TreeItem *EditorHelpSearch::Runner::_create_method_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::MethodDoc *p_doc) { String tooltip = p_doc->return_type + " " + p_class_doc->name + "." + p_doc->name + "("; for (int i = 0; i < p_doc->arguments.size(); i++) { const DocData::ArgumentDoc &arg = p_doc->arguments[i]; tooltip += arg.type + " " + arg.name; if (arg.default_value != "") tooltip += " = " + arg.default_value; if (i < p_doc->arguments.size() - 1) tooltip += ", "; } tooltip += ")"; return _create_member_item(p_parent, p_class_doc->name, "MemberMethod", p_doc->name, TTRC("Method"), "method", tooltip); } TreeItem *EditorHelpSearch::Runner::_create_signal_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::MethodDoc *p_doc) { String tooltip = p_doc->return_type + " " + p_class_doc->name + "." + p_doc->name + "("; for (int i = 0; i < p_doc->arguments.size(); i++) { const DocData::ArgumentDoc &arg = p_doc->arguments[i]; tooltip += arg.type + " " + arg.name; if (arg.default_value != "") tooltip += " = " + arg.default_value; if (i < p_doc->arguments.size() - 1) tooltip += ", "; } tooltip += ")"; return _create_member_item(p_parent, p_class_doc->name, "MemberSignal", p_doc->name, TTRC("Signal"), "signal", tooltip); } TreeItem *EditorHelpSearch::Runner::_create_constant_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ConstantDoc *p_doc) { String tooltip = p_class_doc->name + "." + p_doc->name; return _create_member_item(p_parent, p_class_doc->name, "MemberConstant", p_doc->name, TTRC("Constant"), "constant", tooltip); } TreeItem *EditorHelpSearch::Runner::_create_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::PropertyDoc *p_doc) { String tooltip = p_doc->type + " " + p_class_doc->name + "." + p_doc->name; tooltip += "\n " + p_class_doc->name + "." + p_doc->setter + "(value) setter"; tooltip += "\n " + p_class_doc->name + "." + p_doc->getter + "() getter"; return _create_member_item(p_parent, p_class_doc->name, "MemberProperty", p_doc->name, TTRC("Property"), "property", tooltip); } TreeItem *EditorHelpSearch::Runner::_create_theme_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::PropertyDoc *p_doc) { String tooltip = p_doc->type + " " + p_class_doc->name + "." + p_doc->name; return _create_member_item(p_parent, p_class_doc->name, "MemberTheme", p_doc->name, TTRC("Theme Property"), "theme_item", tooltip); } TreeItem *EditorHelpSearch::Runner::_create_member_item(TreeItem *p_parent, const String &p_class_name, const String &p_icon, const String &p_name, const String &p_type, const String &p_metatype, const String &p_tooltip) { Ref<Texture> icon; String text; if (search_flags & SEARCH_SHOW_HIERARCHY) { icon = ui_service->get_icon(p_icon, "EditorIcons"); text = p_name; } else { icon = ui_service->get_icon(p_icon, "EditorIcons"); /*// In flat mode, show the class icon. if (ui_service->has_icon(p_class_name, "EditorIcons")) icon = ui_service->get_icon(p_class_name, "EditorIcons"); else if (ClassDB::is_parent_class(p_class_name, "Object")) icon = ui_service->get_icon("Object", "EditorIcons");*/ text = p_class_name + "." + p_name; } TreeItem *item = results_tree->create_item(p_parent); item->set_icon(0, icon); item->set_text(0, text); item->set_text(1, TTRGET(p_type)); item->set_tooltip(0, p_tooltip); item->set_tooltip(1, p_tooltip); item->set_metadata(0, "class_" + p_metatype + ":" + p_class_name + ":" + p_name); _match_item(item, p_name); return item; } bool EditorHelpSearch::Runner::work(uint64_t slot) { // Return true when the search has been completed, otherwise false. const uint64_t until = OS::get_singleton()->get_ticks_usec() + slot; while (!_slice()) if (OS::get_singleton()->get_ticks_usec() > until) return false; return true; } EditorHelpSearch::Runner::Runner(Control *p_icon_service, Tree *p_results_tree, const String &p_term, int p_search_flags) : phase(0), ui_service(p_icon_service), results_tree(p_results_tree), term((p_search_flags & SEARCH_CASE_SENSITIVE) == 0 ? p_term.strip_edges().to_lower() : p_term.strip_edges()), search_flags(p_search_flags), empty_icon(ui_service->get_icon("ArrowRight", "EditorIcons")), disabled_color(ui_service->get_color("disabled_font_color", "Editor")) { }