| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | /*************************************************************************/ | 
					
						
							|  |  |  | /*  editor_help_search.cpp                                               */ | 
					
						
							|  |  |  | /*************************************************************************/ | 
					
						
							|  |  |  | /*                       This file is part of:                           */ | 
					
						
							|  |  |  | /*                           GODOT ENGINE                                */ | 
					
						
							|  |  |  | /*                      https://godotengine.org                          */ | 
					
						
							|  |  |  | /*************************************************************************/ | 
					
						
							| 
									
										
										
										
											2021-01-01 20:13:46 +01:00
										 |  |  | /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur.                 */ | 
					
						
							|  |  |  | /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md).   */ | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | /*                                                                       */ | 
					
						
							|  |  |  | /* 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"
 | 
					
						
							| 
									
										
										
										
											2019-12-24 15:17:23 +08:00
										 |  |  | #include "editor_feature_profile.h"
 | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | #include "editor_node.h"
 | 
					
						
							| 
									
										
										
										
											2019-12-28 10:33:01 +08:00
										 |  |  | #include "editor_scale.h"
 | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | void EditorHelpSearch::_update_icons() { | 
					
						
							| 
									
										
										
										
											2020-03-12 09:37:40 -03:00
										 |  |  | 	search_box->set_right_icon(results_tree->get_theme_icon("Search", "EditorIcons")); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	search_box->set_clear_button_enabled(true); | 
					
						
							| 
									
										
										
										
											2020-03-12 09:37:40 -03:00
										 |  |  | 	search_box->add_theme_icon_override("right_icon", results_tree->get_theme_icon("Search", "EditorIcons")); | 
					
						
							|  |  |  | 	case_sensitive_button->set_icon(results_tree->get_theme_icon("MatchCase", "EditorIcons")); | 
					
						
							|  |  |  | 	hierarchy_button->set_icon(results_tree->get_theme_icon("ClassList", "EditorIcons")); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	if (is_visible()) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		_update_results(); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | void EditorHelpSearch::_update_results() { | 
					
						
							|  |  |  | 	String term = search_box->get_text(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	int search_flags = filter_combo->get_selected_id(); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	if (case_sensitive_button->is_pressed()) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		search_flags |= SEARCH_CASE_SENSITIVE; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							|  |  |  | 	if (hierarchy_button->is_pressed()) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		search_flags |= SEARCH_SHOW_HIERARCHY; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-03-06 14:00:16 -03:00
										 |  |  | 	search = Ref<Runner>(memnew(Runner(results_tree, results_tree, term, search_flags))); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	set_process(true); | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-11-22 21:20:57 -02:00
										 |  |  | void EditorHelpSearch::_search_box_gui_input(const Ref<InputEvent> &p_event) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	// Redirect up and down navigational key events to the results list.
 | 
					
						
							| 
									
										
										
										
											2018-11-22 21:20:57 -02:00
										 |  |  | 	Ref<InputEventKey> key = p_event; | 
					
						
							|  |  |  | 	if (key.is_valid()) { | 
					
						
							| 
									
										
										
										
											2018-04-05 20:59:35 +03:00
										 |  |  | 		switch (key->get_keycode()) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 			case KEY_UP: | 
					
						
							|  |  |  | 			case KEY_DOWN: | 
					
						
							|  |  |  | 			case KEY_PAGEUP: | 
					
						
							|  |  |  | 			case KEY_PAGEDOWN: { | 
					
						
							| 
									
										
										
										
											2018-11-22 21:20:57 -02:00
										 |  |  | 				results_tree->call("_gui_input", key); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 				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() { | 
					
						
							| 
									
										
										
										
											2018-11-22 15:11:09 -02:00
										 |  |  | 	TreeItem *item = results_tree->get_selected(); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	if (!item) { | 
					
						
							| 
									
										
										
										
											2018-11-22 15:11:09 -02:00
										 |  |  | 		return; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							| 
									
										
										
										
											2018-11-22 15:11:09 -02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	// 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) { | 
					
						
							| 
									
										
										
										
											2020-03-06 14:00:16 -03:00
										 |  |  | 		case NOTIFICATION_VISIBILITY_CHANGED: { | 
					
						
							|  |  |  | 			if (!is_visible()) { | 
					
						
							|  |  |  | 				results_tree->call_deferred("clear"); // Wait for the Tree's mouse event propagation.
 | 
					
						
							| 
									
										
										
										
											2020-12-14 18:37:30 +00:00
										 |  |  | 				get_ok_button()->set_disabled(true); | 
					
						
							| 
									
										
										
										
											2020-03-06 14:00:16 -03:00
										 |  |  | 				EditorSettings::get_singleton()->set_project_metadata("dialog_bounds", "search_help", Rect2(get_position(), get_size())); | 
					
						
							|  |  |  | 			} | 
					
						
							|  |  |  | 		} break; | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: { | 
					
						
							|  |  |  | 			_update_icons(); | 
					
						
							|  |  |  | 		} break; | 
					
						
							|  |  |  | 		case NOTIFICATION_ENTER_TREE: { | 
					
						
							| 
									
										
										
										
											2020-02-21 18:28:45 +01:00
										 |  |  | 			connect("confirmed", callable_mp(this, &EditorHelpSearch::_confirmed)); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 			_update_icons(); | 
					
						
							|  |  |  | 		} break; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 		case NOTIFICATION_PROCESS: { | 
					
						
							|  |  |  | 			// Update background search.
 | 
					
						
							|  |  |  | 			if (search.is_valid()) { | 
					
						
							|  |  |  | 				if (search->work()) { | 
					
						
							|  |  |  | 					// Search done.
 | 
					
						
							| 
									
										
										
										
											2018-11-26 13:38:39 -02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-03-19 18:49:21 -03:00
										 |  |  | 					// Only point to the match if it's a new search, and not just reopening a old one.
 | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 					if (!old_search) { | 
					
						
							| 
									
										
										
										
											2018-11-26 13:38:39 -02:00
										 |  |  | 						results_tree->ensure_cursor_is_visible(); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 					} else { | 
					
						
							| 
									
										
										
										
											2018-11-26 13:38:39 -02:00
										 |  |  | 						old_search = false; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 					} | 
					
						
							| 
									
										
										
										
											2018-11-26 13:38:39 -02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-14 18:37:30 +00:00
										 |  |  | 					get_ok_button()->set_disabled(!results_tree->get_selected()); | 
					
						
							| 
									
										
										
										
											2018-11-26 13:38:39 -02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 					search = Ref<Runner>(); | 
					
						
							|  |  |  | 					set_process(false); | 
					
						
							|  |  |  | 				} | 
					
						
							|  |  |  | 			} else { | 
					
						
							|  |  |  | 				set_process(false); | 
					
						
							|  |  |  | 			} | 
					
						
							|  |  |  | 		} break; | 
					
						
							|  |  |  | 	} | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | void EditorHelpSearch::_bind_methods() { | 
					
						
							|  |  |  | 	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.
 | 
					
						
							| 
									
										
										
										
											2018-12-04 13:52:56 -02:00
										 |  |  | 	Rect2 saved_size = EditorSettings::get_singleton()->get_project_metadata("dialog_bounds", "search_help", Rect2()); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	if (saved_size != Rect2()) { | 
					
						
							| 
									
										
										
										
											2018-12-04 13:52:56 -02:00
										 |  |  | 		popup(saved_size); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} else { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		popup_centered_ratio(0.5F); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | 	if (p_term == "") { | 
					
						
							|  |  |  | 		search_box->clear(); | 
					
						
							|  |  |  | 	} else { | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		if (old_term == p_term) { | 
					
						
							| 
									
										
										
										
											2019-11-25 16:23:35 +01:00
										 |  |  | 			old_search = true; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		} else { | 
					
						
							| 
									
										
										
										
											2019-11-25 16:23:35 +01:00
										 |  |  | 			old_term = p_term; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		} | 
					
						
							| 
									
										
										
										
											2019-11-25 16:23:35 +01:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		search_box->set_text(p_term); | 
					
						
							|  |  |  | 		search_box->select_all(); | 
					
						
							|  |  |  | 	} | 
					
						
							|  |  |  | 	search_box->grab_focus(); | 
					
						
							|  |  |  | 	_update_results(); | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | EditorHelpSearch::EditorHelpSearch() { | 
					
						
							| 
									
										
										
										
											2018-11-26 13:38:39 -02:00
										 |  |  | 	old_search = false; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	set_hide_on_ok(false); | 
					
						
							| 
									
										
										
										
											2020-03-06 14:00:16 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	set_title(TTR("Search Help")); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-14 18:37:30 +00:00
										 |  |  | 	get_ok_button()->set_disabled(true); | 
					
						
							|  |  |  | 	get_ok_button()->set_text(TTR("Open")); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | 	// 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); | 
					
						
							| 
									
										
										
										
											2019-12-28 10:33:01 +08:00
										 |  |  | 	search_box->set_custom_minimum_size(Size2(200, 0) * EDSCALE); | 
					
						
							| 
									
										
										
										
											2020-03-06 14:00:16 -03:00
										 |  |  | 	search_box->set_h_size_flags(Control::SIZE_EXPAND_FILL); | 
					
						
							| 
									
										
										
										
											2020-02-21 18:28:45 +01:00
										 |  |  | 	search_box->connect("gui_input", callable_mp(this, &EditorHelpSearch::_search_box_gui_input)); | 
					
						
							|  |  |  | 	search_box->connect("text_changed", callable_mp(this, &EditorHelpSearch::_search_box_text_changed)); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	register_text_enter(search_box); | 
					
						
							|  |  |  | 	hbox->add_child(search_box); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-06-19 20:49:04 +02:00
										 |  |  | 	case_sensitive_button = memnew(Button); | 
					
						
							|  |  |  | 	case_sensitive_button->set_flat(true); | 
					
						
							| 
									
										
										
										
											2019-12-28 10:33:01 +08:00
										 |  |  | 	case_sensitive_button->set_tooltip(TTR("Case Sensitive")); | 
					
						
							| 
									
										
										
										
											2020-02-21 18:28:45 +01:00
										 |  |  | 	case_sensitive_button->connect("pressed", callable_mp(this, &EditorHelpSearch::_update_results)); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	case_sensitive_button->set_toggle_mode(true); | 
					
						
							| 
									
										
										
										
											2020-03-06 14:00:16 -03:00
										 |  |  | 	case_sensitive_button->set_focus_mode(Control::FOCUS_NONE); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	hbox->add_child(case_sensitive_button); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-06-19 20:49:04 +02:00
										 |  |  | 	hierarchy_button = memnew(Button); | 
					
						
							|  |  |  | 	hierarchy_button->set_flat(true); | 
					
						
							| 
									
										
										
										
											2019-12-28 10:33:01 +08:00
										 |  |  | 	hierarchy_button->set_tooltip(TTR("Show Hierarchy")); | 
					
						
							| 
									
										
										
										
											2020-02-21 18:28:45 +01:00
										 |  |  | 	hierarchy_button->connect("pressed", callable_mp(this, &EditorHelpSearch::_update_results)); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	hierarchy_button->set_toggle_mode(true); | 
					
						
							|  |  |  | 	hierarchy_button->set_pressed(true); | 
					
						
							| 
									
										
										
										
											2020-03-06 14:00:16 -03:00
										 |  |  | 	hierarchy_button->set_focus_mode(Control::FOCUS_NONE); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	hbox->add_child(hierarchy_button); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	filter_combo = memnew(OptionButton); | 
					
						
							| 
									
										
										
										
											2019-12-28 10:33:01 +08:00
										 |  |  | 	filter_combo->set_custom_minimum_size(Size2(200, 0) * EDSCALE); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	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); | 
					
						
							| 
									
										
										
										
											2020-02-21 18:28:45 +01:00
										 |  |  | 	filter_combo->connect("item_selected", callable_mp(this, &EditorHelpSearch::_filter_combo_item_selected)); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	hbox->add_child(filter_combo); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	// Create the results tree.
 | 
					
						
							|  |  |  | 	results_tree = memnew(Tree); | 
					
						
							| 
									
										
										
										
											2020-03-06 14:00:16 -03:00
										 |  |  | 	results_tree->set_v_size_flags(Control::SIZE_EXPAND_FILL); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	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); | 
					
						
							| 
									
										
										
										
											2019-12-28 10:33:01 +08:00
										 |  |  | 	results_tree->set_column_min_width(1, 150 * EDSCALE); | 
					
						
							|  |  |  | 	results_tree->set_custom_minimum_size(Size2(0, 100) * EDSCALE); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	results_tree->set_hide_root(true); | 
					
						
							|  |  |  | 	results_tree->set_select_mode(Tree::SELECT_ROW); | 
					
						
							| 
									
										
										
										
											2020-02-21 18:28:45 +01:00
										 |  |  | 	results_tree->connect("item_activated", callable_mp(this, &EditorHelpSearch::_confirmed)); | 
					
						
							| 
									
										
										
										
											2020-12-14 18:37:30 +00:00
										 |  |  | 	results_tree->connect("item_selected", callable_mp((BaseButton *)get_ok_button(), &BaseButton::set_disabled), varray(false)); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	vbox->add_child(results_tree, true); | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 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()) { | 
					
						
							| 
									
										
										
										
											2019-06-25 20:36:26 -03:00
										 |  |  | 		if (!ClassDB::class_exists(class_name)) { | 
					
						
							|  |  |  | 			return false; | 
					
						
							|  |  |  | 		} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 		if (profile->is_class_disabled(class_name)) { | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 			return true; | 
					
						
							|  |  |  | 		} | 
					
						
							|  |  |  | 		class_name = ClassDB::get_parent_class(class_name); | 
					
						
							|  |  |  | 	} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	return false; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 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: | 
					
						
							| 
									
										
										
										
											2019-11-07 09:44:15 +01:00
										 |  |  | 			WARN_PRINT("Invalid or unhandled phase in EditorHelpSearch::Runner, aborting search."); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 			return true; | 
					
						
							|  |  |  | 	}; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	if (phase_done) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		phase++; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	return false; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | bool EditorHelpSearch::Runner::_phase_match_classes_init() { | 
					
						
							|  |  |  | 	iterator_doc = EditorHelp::get_doc_data()->class_list.front(); | 
					
						
							|  |  |  | 	matches.clear(); | 
					
						
							| 
									
										
										
										
											2020-04-02 01:20:12 +02:00
										 |  |  | 	matched_item = nullptr; | 
					
						
							| 
									
										
										
										
											2021-03-19 18:49:21 -03:00
										 |  |  | 	match_highest_score = 0; | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | 	return true; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | bool EditorHelpSearch::Runner::_phase_match_classes() { | 
					
						
							|  |  |  | 	DocData::ClassDoc &class_doc = iterator_doc->value(); | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 	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.
 | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		if (search_flags & SEARCH_CLASSES) { | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 			match.name = term == "" || _match_string(term, class_doc.name); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		} | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 
 | 
					
						
							|  |  |  | 		// Match members if the term is long enough.
 | 
					
						
							|  |  |  | 		if (term.length() > 1) { | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 			if (search_flags & SEARCH_METHODS) { | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 				for (int i = 0; i < class_doc.methods.size(); i++) { | 
					
						
							| 
									
										
										
										
											2019-07-07 23:08:51 +02:00
										 |  |  | 					String method_name = (search_flags & SEARCH_CASE_SENSITIVE) ? class_doc.methods[i].name : class_doc.methods[i].name.to_lower(); | 
					
						
							| 
									
										
										
										
											2020-07-01 03:19:24 +12:00
										 |  |  | 					if (method_name.find(term) > -1 || | 
					
						
							|  |  |  | 							(term.begins_with(".") && method_name.begins_with(term.right(1))) || | 
					
						
							|  |  |  | 							(term.ends_with("(") && method_name.ends_with(term.left(term.length() - 1).strip_edges())) || | 
					
						
							|  |  |  | 							(term.begins_with(".") && term.ends_with("(") && method_name == term.substr(1, term.length() - 2).strip_edges())) { | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 						match.methods.push_back(const_cast<DocData::MethodDoc *>(&class_doc.methods[i])); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 					} | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 				} | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 			} | 
					
						
							|  |  |  | 			if (search_flags & SEARCH_SIGNALS) { | 
					
						
							|  |  |  | 				for (int i = 0; i < class_doc.signals.size(); i++) { | 
					
						
							|  |  |  | 					if (_match_string(term, class_doc.signals[i].name)) { | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 						match.signals.push_back(const_cast<DocData::MethodDoc *>(&class_doc.signals[i])); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 					} | 
					
						
							|  |  |  | 				} | 
					
						
							|  |  |  | 			} | 
					
						
							|  |  |  | 			if (search_flags & SEARCH_CONSTANTS) { | 
					
						
							|  |  |  | 				for (int i = 0; i < class_doc.constants.size(); i++) { | 
					
						
							|  |  |  | 					if (_match_string(term, class_doc.constants[i].name)) { | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 						match.constants.push_back(const_cast<DocData::ConstantDoc *>(&class_doc.constants[i])); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 					} | 
					
						
							|  |  |  | 				} | 
					
						
							|  |  |  | 			} | 
					
						
							|  |  |  | 			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)) { | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 						match.properties.push_back(const_cast<DocData::PropertyDoc *>(&class_doc.properties[i])); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 					} | 
					
						
							|  |  |  | 				} | 
					
						
							|  |  |  | 			} | 
					
						
							|  |  |  | 			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)) { | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 						match.theme_properties.push_back(const_cast<DocData::PropertyDoc *>(&class_doc.theme_properties[i])); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 					} | 
					
						
							|  |  |  | 				} | 
					
						
							|  |  |  | 			} | 
					
						
							| 
									
										
										
										
											2019-06-06 22:04:25 -03:00
										 |  |  | 		} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	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) { | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		if (match.required()) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 			_create_class_hierarchy(match); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	} else { | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		if (match.name) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 			_create_class_item(root_item, match.doc, false); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	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(); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2019-07-07 23:08:51 +02:00
										 |  |  | 	TreeItem *parent = (search_flags & SEARCH_SHOW_HIERARCHY) ? class_items[match.doc->name] : root_item; | 
					
						
							| 
									
										
										
										
											2020-12-18 09:36:04 +03:00
										 |  |  | 	bool constructor_created = false; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	for (int i = 0; i < match.methods.size(); i++) { | 
					
						
							| 
									
										
										
										
											2020-12-18 09:36:04 +03:00
										 |  |  | 		String text = match.methods[i]->name; | 
					
						
							|  |  |  | 		if (!constructor_created) { | 
					
						
							|  |  |  | 			if (match.doc->name == match.methods[i]->name) { | 
					
						
							|  |  |  | 				text += " " + TTR("(constructors)"); | 
					
						
							|  |  |  | 				constructor_created = true; | 
					
						
							|  |  |  | 			} | 
					
						
							|  |  |  | 		} else { | 
					
						
							|  |  |  | 			if (match.doc->name == match.methods[i]->name) { | 
					
						
							|  |  |  | 				continue; | 
					
						
							|  |  |  | 			} | 
					
						
							|  |  |  | 		} | 
					
						
							|  |  |  | 		_create_method_item(parent, match.doc, text, match.methods[i]); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							|  |  |  | 	for (int i = 0; i < match.signals.size(); i++) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		_create_signal_item(parent, match.doc, match.signals[i]); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							|  |  |  | 	for (int i = 0; i < match.constants.size(); i++) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		_create_constant_item(parent, match.doc, match.constants[i]); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							|  |  |  | 	for (int i = 0; i < match.properties.size(); i++) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		_create_property_item(parent, match.doc, match.properties[i]); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							|  |  |  | 	for (int i = 0; i < match.theme_properties.size(); i++) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		_create_theme_property_item(parent, match.doc, match.theme_properties[i]); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | 	iterator_match = iterator_match->next(); | 
					
						
							|  |  |  | 	return !iterator_match; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | bool EditorHelpSearch::Runner::_phase_select_match() { | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	if (matched_item) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		matched_item->select(0); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	return true; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | bool EditorHelpSearch::Runner::_match_string(const String &p_term, const String &p_string) const { | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	if (search_flags & SEARCH_CASE_SENSITIVE) { | 
					
						
							| 
									
										
										
										
											2020-07-01 03:19:24 +12:00
										 |  |  | 		return p_string.find(p_term) > -1; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} else { | 
					
						
							| 
									
										
										
										
											2020-07-01 03:19:24 +12:00
										 |  |  | 		return p_string.findn(p_term) > -1; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | void EditorHelpSearch::Runner::_match_item(TreeItem *p_item, const String &p_text) { | 
					
						
							| 
									
										
										
										
											2021-03-19 18:49:21 -03:00
										 |  |  | 	float inverse_length = 1.f / float(p_text.length()); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	// Favor types where search term is a substring close to the start of the type.
 | 
					
						
							|  |  |  | 	float w = 0.5f; | 
					
						
							|  |  |  | 	int pos = p_text.findn(term); | 
					
						
							|  |  |  | 	float score = (pos > -1) ? 1.0f - w * MIN(1, 3 * pos * inverse_length) : MAX(0.f, .9f - w); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	// Favor shorter items: they resemble the search term more.
 | 
					
						
							|  |  |  | 	w = 0.1f; | 
					
						
							|  |  |  | 	score *= (1 - w) + w * (term.length() * inverse_length); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	if (match_highest_score == 0 || score > match_highest_score) { | 
					
						
							|  |  |  | 		matched_item = p_item; | 
					
						
							|  |  |  | 		match_highest_score = score; | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	} | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | TreeItem *EditorHelpSearch::Runner::_create_class_hierarchy(const ClassMatch &p_match) { | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	if (class_items.has(p_match.doc->name)) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		return class_items[p_match.doc->name]; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | 	// 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) { | 
					
						
							| 
									
										
										
										
											2019-06-11 15:43:37 -03:00
										 |  |  | 	Ref<Texture2D> icon = empty_icon; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	if (ui_service->has_theme_icon(p_doc->name, "EditorIcons")) { | 
					
						
							| 
									
										
										
										
											2020-03-12 09:37:40 -03:00
										 |  |  | 		icon = ui_service->get_theme_icon(p_doc->name, "EditorIcons"); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} else if (ClassDB::class_exists(p_doc->name) && ClassDB::is_parent_class(p_doc->name, "Object")) { | 
					
						
							| 
									
										
										
										
											2020-03-12 09:37:40 -03:00
										 |  |  | 		icon = ui_service->get_theme_icon("Object", "EditorIcons"); | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	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; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-18 09:36:04 +03:00
										 |  |  | TreeItem *EditorHelpSearch::Runner::_create_method_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const String &p_text, const DocData::MethodDoc *p_doc) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	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; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		if (arg.default_value != "") { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 			tooltip += " = " + arg.default_value; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		} | 
					
						
							|  |  |  | 		if (i < p_doc->arguments.size() - 1) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 			tooltip += ", "; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	} | 
					
						
							|  |  |  | 	tooltip += ")"; | 
					
						
							| 
									
										
										
										
											2020-12-18 09:36:04 +03:00
										 |  |  | 	return _create_member_item(p_parent, p_class_doc->name, "MemberMethod", p_doc->name, p_text, TTRC("Method"), "method", tooltip); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 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; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		if (arg.default_value != "") { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 			tooltip += " = " + arg.default_value; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		} | 
					
						
							|  |  |  | 		if (i < p_doc->arguments.size() - 1) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 			tooltip += ", "; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	} | 
					
						
							|  |  |  | 	tooltip += ")"; | 
					
						
							| 
									
										
										
										
											2020-12-18 09:36:04 +03:00
										 |  |  | 	return _create_member_item(p_parent, p_class_doc->name, "MemberSignal", p_doc->name, p_doc->name, TTRC("Signal"), "signal", tooltip); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 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; | 
					
						
							| 
									
										
										
										
											2020-12-18 09:36:04 +03:00
										 |  |  | 	return _create_member_item(p_parent, p_class_doc->name, "MemberConstant", p_doc->name, p_doc->name, TTRC("Constant"), "constant", tooltip); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 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"; | 
					
						
							| 
									
										
										
										
											2020-12-18 09:36:04 +03:00
										 |  |  | 	return _create_member_item(p_parent, p_class_doc->name, "MemberProperty", p_doc->name, p_doc->name, TTRC("Property"), "property", tooltip); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 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; | 
					
						
							| 
									
										
										
										
											2020-12-18 09:36:04 +03:00
										 |  |  | 	return _create_member_item(p_parent, p_class_doc->name, "MemberTheme", p_doc->name, p_doc->name, TTRC("Theme Property"), "theme_item", tooltip); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-18 09:36:04 +03:00
										 |  |  | 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_text, const String &p_type, const String &p_metatype, const String &p_tooltip) { | 
					
						
							| 
									
										
										
										
											2019-06-11 15:43:37 -03:00
										 |  |  | 	Ref<Texture2D> icon; | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	String text; | 
					
						
							|  |  |  | 	if (search_flags & SEARCH_SHOW_HIERARCHY) { | 
					
						
							| 
									
										
										
										
											2020-03-12 09:37:40 -03:00
										 |  |  | 		icon = ui_service->get_theme_icon(p_icon, "EditorIcons"); | 
					
						
							| 
									
										
										
										
											2020-12-18 09:36:04 +03:00
										 |  |  | 		text = p_text; | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	} else { | 
					
						
							| 
									
										
										
										
											2020-03-12 09:37:40 -03:00
										 |  |  | 		icon = ui_service->get_theme_icon(p_icon, "EditorIcons"); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 		/*// In flat mode, show the class icon.
 | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 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");*/ | 
					
						
							| 
									
										
										
										
											2020-12-18 09:36:04 +03:00
										 |  |  | 		text = p_class_name + "." + p_text; | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	TreeItem *item = results_tree->create_item(p_parent); | 
					
						
							|  |  |  | 	item->set_icon(0, icon); | 
					
						
							|  |  |  | 	item->set_text(0, text); | 
					
						
							| 
									
										
										
										
											2019-12-28 10:33:01 +08:00
										 |  |  | 	item->set_text(1, TTRGET(p_type)); | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	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; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 	while (!_slice()) { | 
					
						
							|  |  |  | 		if (OS::get_singleton()->get_ticks_usec() > until) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 			return false; | 
					
						
							| 
									
										
										
										
											2020-05-14 16:41:43 +02:00
										 |  |  | 		} | 
					
						
							|  |  |  | 	} | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | 	return true; | 
					
						
							|  |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-12-08 15:07:33 -05:00
										 |  |  | EditorHelpSearch::Runner::Runner(Control *p_icon_service, Tree *p_results_tree, const String &p_term, int p_search_flags) : | 
					
						
							|  |  |  | 		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), | 
					
						
							| 
									
										
										
										
											2020-03-12 09:37:40 -03:00
										 |  |  | 		empty_icon(ui_service->get_theme_icon("ArrowRight", "EditorIcons")), | 
					
						
							|  |  |  | 		disabled_color(ui_service->get_theme_color("disabled_font_color", "Editor")) { | 
					
						
							| 
									
										
										
										
											2017-12-11 00:56:49 +01:00
										 |  |  | } |