initial commit, 4.5 stable
Some checks failed
🔗 GHA / 📊 Static checks (push) Has been cancelled
🔗 GHA / 🤖 Android (push) Has been cancelled
🔗 GHA / 🍏 iOS (push) Has been cancelled
🔗 GHA / 🐧 Linux (push) Has been cancelled
🔗 GHA / 🍎 macOS (push) Has been cancelled
🔗 GHA / 🏁 Windows (push) Has been cancelled
🔗 GHA / 🌐 Web (push) Has been cancelled
Some checks failed
🔗 GHA / 📊 Static checks (push) Has been cancelled
🔗 GHA / 🤖 Android (push) Has been cancelled
🔗 GHA / 🍏 iOS (push) Has been cancelled
🔗 GHA / 🐧 Linux (push) Has been cancelled
🔗 GHA / 🍎 macOS (push) Has been cancelled
🔗 GHA / 🏁 Windows (push) Has been cancelled
🔗 GHA / 🌐 Web (push) Has been cancelled
This commit is contained in:
6
editor/doc/SCsub
Normal file
6
editor/doc/SCsub
Normal file
@@ -0,0 +1,6 @@
|
||||
#!/usr/bin/env python
|
||||
from misc.utility.scons_hints import *
|
||||
|
||||
Import("env")
|
||||
|
||||
env.add_source_files(env.editor_sources, "*.cpp")
|
1829
editor/doc/doc_tools.cpp
Normal file
1829
editor/doc/doc_tools.cpp
Normal file
File diff suppressed because it is too large
Load Diff
60
editor/doc/doc_tools.h
Normal file
60
editor/doc/doc_tools.h
Normal file
@@ -0,0 +1,60 @@
|
||||
/**************************************************************************/
|
||||
/* doc_tools.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/doc_data.h"
|
||||
#include "core/templates/rb_set.h"
|
||||
|
||||
class DocTools {
|
||||
public:
|
||||
String version;
|
||||
HashMap<String, DocData::ClassDoc> class_list;
|
||||
HashMap<String, RBSet<String, NaturalNoCaseComparator>> inheriting;
|
||||
|
||||
static Error erase_classes(const String &p_dir);
|
||||
|
||||
void merge_from(const DocTools &p_data);
|
||||
void add_doc(const DocData::ClassDoc &p_class_doc);
|
||||
void remove_doc(const String &p_class_name);
|
||||
void remove_script_doc_by_path(const String &p_path);
|
||||
bool has_doc(const String &p_class_name);
|
||||
enum GenerateFlags {
|
||||
GENERATE_FLAG_SKIP_BASIC_TYPES = (1 << 0),
|
||||
GENERATE_FLAG_EXTENSION_CLASSES_ONLY = (1 << 1),
|
||||
};
|
||||
void generate(BitField<GenerateFlags> p_flags = {});
|
||||
Error load_classes(const String &p_dir);
|
||||
Error save_classes(const String &p_default_path, const HashMap<String, String> &p_class_path, bool p_use_relative_schema = true);
|
||||
|
||||
Error _load(Ref<XMLParser> parser);
|
||||
Error load_compressed(const uint8_t *p_data, int64_t p_compressed_size, int64_t p_uncompressed_size);
|
||||
Error load_xml(const uint8_t *p_data, int64_t p_size);
|
||||
};
|
5067
editor/doc/editor_help.cpp
Normal file
5067
editor/doc/editor_help.cpp
Normal file
File diff suppressed because it is too large
Load Diff
423
editor/doc/editor_help.h
Normal file
423
editor/doc/editor_help.h
Normal file
@@ -0,0 +1,423 @@
|
||||
/**************************************************************************/
|
||||
/* editor_help.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/os/thread.h"
|
||||
#include "editor/doc/doc_tools.h"
|
||||
#include "editor/plugins/editor_plugin.h"
|
||||
#include "scene/gui/dialogs.h"
|
||||
#include "scene/gui/popup.h"
|
||||
#include "scene/gui/rich_text_label.h"
|
||||
#include "scene/gui/split_container.h"
|
||||
#include "scene/gui/text_edit.h"
|
||||
#include "scene/main/timer.h"
|
||||
|
||||
class FindBar : public HBoxContainer {
|
||||
GDCLASS(FindBar, HBoxContainer);
|
||||
|
||||
LineEdit *search_text = nullptr;
|
||||
Button *find_prev = nullptr;
|
||||
Button *find_next = nullptr;
|
||||
Label *matches_label = nullptr;
|
||||
Button *hide_button = nullptr;
|
||||
|
||||
RichTextLabel *rich_text_label = nullptr;
|
||||
|
||||
String prev_search;
|
||||
int results_count = 0;
|
||||
int results_count_to_current = 0;
|
||||
|
||||
virtual void input(const Ref<InputEvent> &p_event) override;
|
||||
|
||||
void _hide_bar();
|
||||
|
||||
void _search_text_changed(const String &p_text);
|
||||
void _search_text_submitted(const String &p_text);
|
||||
|
||||
void _update_results_count(bool p_search_previous);
|
||||
void _update_matches_label();
|
||||
|
||||
protected:
|
||||
void _notification(int p_what);
|
||||
|
||||
bool _search(bool p_search_previous = false);
|
||||
|
||||
public:
|
||||
void set_rich_text_label(RichTextLabel *p_rich_text_label);
|
||||
|
||||
void popup_search();
|
||||
|
||||
bool search_prev();
|
||||
bool search_next();
|
||||
|
||||
FindBar();
|
||||
};
|
||||
|
||||
class EditorFileSystemDirectory;
|
||||
|
||||
class EditorHelp : public VBoxContainer {
|
||||
GDCLASS(EditorHelp, VBoxContainer);
|
||||
|
||||
enum MethodType {
|
||||
METHOD_TYPE_METHOD,
|
||||
METHOD_TYPE_CONSTRUCTOR,
|
||||
METHOD_TYPE_OPERATOR,
|
||||
METHOD_TYPE_MAX
|
||||
};
|
||||
|
||||
bool select_locked = false;
|
||||
bool update_pending = false;
|
||||
|
||||
String prev_search;
|
||||
|
||||
String edited_class;
|
||||
|
||||
Vector<Pair<String, int>> section_line;
|
||||
HashMap<String, int> method_line;
|
||||
HashMap<String, int> signal_line;
|
||||
HashMap<String, int> property_line;
|
||||
HashMap<String, int> theme_property_line;
|
||||
HashMap<String, int> constant_line;
|
||||
HashMap<String, int> annotation_line;
|
||||
HashMap<String, int> enum_line;
|
||||
HashMap<String, HashMap<String, int>> enum_values_line;
|
||||
int description_line = 0;
|
||||
|
||||
RichTextLabel *class_desc = nullptr;
|
||||
HSplitContainer *h_split = nullptr;
|
||||
inline static DocTools *doc = nullptr;
|
||||
inline static DocTools *ext_doc = nullptr;
|
||||
|
||||
ConfirmationDialog *search_dialog = nullptr;
|
||||
LineEdit *search = nullptr;
|
||||
FindBar *find_bar = nullptr;
|
||||
HBoxContainer *status_bar = nullptr;
|
||||
Button *toggle_files_button = nullptr;
|
||||
|
||||
String base_path;
|
||||
|
||||
struct ThemeCache {
|
||||
Ref<StyleBox> background_style;
|
||||
|
||||
Color text_color;
|
||||
Color title_color;
|
||||
Color headline_color;
|
||||
Color comment_color;
|
||||
Color symbol_color;
|
||||
Color value_color;
|
||||
Color qualifier_color;
|
||||
Color type_color;
|
||||
Color override_color;
|
||||
|
||||
Ref<Font> doc_font;
|
||||
Ref<Font> doc_bold_font;
|
||||
Ref<Font> doc_italic_font;
|
||||
Ref<Font> doc_title_font;
|
||||
Ref<Font> doc_code_font;
|
||||
Ref<Font> doc_kbd_font;
|
||||
|
||||
int doc_font_size = 0;
|
||||
int doc_title_font_size = 0;
|
||||
int doc_code_font_size = 0;
|
||||
int doc_kbd_font_size = 0;
|
||||
} theme_cache;
|
||||
|
||||
int scroll_to = -1;
|
||||
|
||||
void _help_callback(const String &p_topic);
|
||||
|
||||
void _add_text(const String &p_bbcode);
|
||||
bool scroll_locked = false;
|
||||
|
||||
//void _button_pressed(int p_idx);
|
||||
void _add_type(const String &p_type, const String &p_enum = String(), bool p_is_bitfield = false);
|
||||
void _add_type_icon(const String &p_type, int p_size = 0, const String &p_fallback = "");
|
||||
void _add_method(const DocData::MethodDoc &p_method, bool p_overview, bool p_override = true);
|
||||
|
||||
void _add_bulletpoint();
|
||||
|
||||
void _push_normal_font();
|
||||
void _pop_normal_font();
|
||||
void _push_title_font();
|
||||
void _pop_title_font();
|
||||
void _push_code_font();
|
||||
void _pop_code_font();
|
||||
|
||||
void _class_desc_finished();
|
||||
void _class_list_select(const String &p_select);
|
||||
void _class_desc_select(const String &p_select);
|
||||
void _class_desc_input(const Ref<InputEvent> &p_input);
|
||||
void _class_desc_resized(bool p_force_update_theme);
|
||||
int display_margin = 0;
|
||||
|
||||
Error _goto_desc(const String &p_class);
|
||||
//void _update_history_buttons();
|
||||
void _update_method_list(MethodType p_method_type, const Vector<DocData::MethodDoc> &p_methods);
|
||||
void _update_method_descriptions(const DocData::ClassDoc &p_classdoc, MethodType p_method_type, const Vector<DocData::MethodDoc> &p_methods);
|
||||
void _update_doc();
|
||||
|
||||
void _request_help(const String &p_string);
|
||||
void _search(bool p_search_previous = false);
|
||||
|
||||
void _toggle_files_pressed();
|
||||
|
||||
inline static int doc_generation_count = 0;
|
||||
inline static String doc_version_hash;
|
||||
inline static Thread worker_thread;
|
||||
inline static Thread loader_thread; // Only load scripts here to avoid deadlocking with main thread.
|
||||
|
||||
inline static SafeFlag _script_docs_loaded = SafeFlag(false);
|
||||
inline static LocalVector<DocData::ClassDoc> _docs_to_add;
|
||||
inline static LocalVector<String> _docs_to_remove;
|
||||
inline static LocalVector<String> _docs_to_remove_by_path;
|
||||
|
||||
static void _wait_for_thread(Thread &p_thread = worker_thread);
|
||||
static void _load_doc_thread(void *p_udata);
|
||||
static void _gen_doc_thread(void *p_udata);
|
||||
static void _gen_extensions_docs();
|
||||
static void _process_postponed_docs();
|
||||
static void _load_script_doc_cache_thread(void *p_udata);
|
||||
static void _regen_script_doc_thread(void *p_udata);
|
||||
static void _finish_regen_script_doc_thread(void *p_udata);
|
||||
static void _reload_scripts_documentation(EditorFileSystemDirectory *p_dir);
|
||||
static void _delete_script_doc_cache();
|
||||
static void _compute_doc_version_hash();
|
||||
|
||||
struct PropertyCompare {
|
||||
_FORCE_INLINE_ bool operator()(const DocData::PropertyDoc &p_l, const DocData::PropertyDoc &p_r) const {
|
||||
// Sort overridden properties above all else.
|
||||
if (p_l.overridden == p_r.overridden) {
|
||||
return p_l.name.naturalcasecmp_to(p_r.name) < 0;
|
||||
}
|
||||
return p_l.overridden;
|
||||
}
|
||||
};
|
||||
|
||||
protected:
|
||||
virtual void _update_theme_item_cache() override;
|
||||
|
||||
void _notification(int p_what);
|
||||
static void _bind_methods();
|
||||
|
||||
public:
|
||||
static void generate_doc(bool p_use_cache = true, bool p_use_script_cache = true);
|
||||
static void cleanup_doc();
|
||||
static void load_script_doc_cache();
|
||||
static void regenerate_script_doc_cache();
|
||||
static void save_script_doc_cache();
|
||||
static String get_cache_full_path();
|
||||
static String get_script_doc_cache_full_path();
|
||||
|
||||
// Adding scripts to DocData directly may make script doc cache inconsistent. Use methods below when adding script docs.
|
||||
// Usage during startup can also cause deadlocks.
|
||||
static DocTools *get_doc_data();
|
||||
// Method forwarding to underlying DocTools to keep script doc cache consistent.
|
||||
static DocData::ClassDoc *get_doc(const String &p_class_name);
|
||||
static void add_doc(const DocData::ClassDoc &p_class_doc);
|
||||
static void remove_doc(const String &p_class_name);
|
||||
static void remove_script_doc_by_path(const String &p_path);
|
||||
static bool has_doc(const String &p_class_name);
|
||||
|
||||
static void load_xml_buffer(const uint8_t *p_buffer, int p_size);
|
||||
static void remove_class(const String &p_class);
|
||||
|
||||
void go_to_help(const String &p_help);
|
||||
void go_to_class(const String &p_class);
|
||||
void update_doc();
|
||||
|
||||
Vector<Pair<String, int>> get_sections();
|
||||
void scroll_to_section(int p_section_index);
|
||||
|
||||
void popup_search();
|
||||
void search_again(bool p_search_previous = false);
|
||||
|
||||
String get_class();
|
||||
|
||||
void set_focused() { class_desc->grab_focus(); }
|
||||
|
||||
int get_scroll() const;
|
||||
void set_scroll(int p_scroll);
|
||||
|
||||
void update_toggle_files_button();
|
||||
|
||||
static void init_gdext_pointers();
|
||||
|
||||
EditorHelp();
|
||||
};
|
||||
|
||||
class EditorHelpBit : public VBoxContainer {
|
||||
GDCLASS(EditorHelpBit, VBoxContainer);
|
||||
|
||||
enum SymbolHint {
|
||||
SYMBOL_HINT_NONE,
|
||||
SYMBOL_HINT_INHERITANCE, // [ < ParentClass[ < ...]]
|
||||
SYMBOL_HINT_ASSIGNABLE, // [: Type][ = value]
|
||||
SYMBOL_HINT_SIGNATURE, // (arguments)[ -> Type][ qualifiers]
|
||||
};
|
||||
|
||||
struct DocType {
|
||||
String type;
|
||||
String enumeration;
|
||||
bool is_bitfield = false;
|
||||
};
|
||||
|
||||
struct ArgumentData {
|
||||
String name;
|
||||
DocType doc_type;
|
||||
String default_value;
|
||||
};
|
||||
|
||||
struct HelpData {
|
||||
String description;
|
||||
String deprecated_message;
|
||||
String experimental_message;
|
||||
DocType doc_type;
|
||||
String value;
|
||||
Vector<ArgumentData> arguments;
|
||||
ArgumentData rest_argument;
|
||||
String qualifiers;
|
||||
String resource_path;
|
||||
};
|
||||
|
||||
inline static HashMap<StringName, HelpData> doc_class_cache;
|
||||
inline static HashMap<StringName, HashMap<StringName, HelpData>> doc_enum_cache;
|
||||
inline static HashMap<StringName, HashMap<StringName, HelpData>> doc_constant_cache;
|
||||
inline static HashMap<StringName, HashMap<StringName, HelpData>> doc_property_cache;
|
||||
inline static HashMap<StringName, HashMap<StringName, HelpData>> doc_theme_item_cache;
|
||||
inline static HashMap<StringName, HashMap<StringName, HelpData>> doc_method_cache;
|
||||
inline static HashMap<StringName, HashMap<StringName, HelpData>> doc_signal_cache;
|
||||
inline static HashMap<StringName, HashMap<StringName, HelpData>> doc_annotation_cache;
|
||||
|
||||
RichTextLabel *title = nullptr;
|
||||
RichTextLabel *content = nullptr;
|
||||
|
||||
bool use_class_prefix = false;
|
||||
|
||||
String symbol_doc_link;
|
||||
String symbol_class_name;
|
||||
String symbol_type;
|
||||
String symbol_name;
|
||||
SymbolHint symbol_hint = SYMBOL_HINT_NONE;
|
||||
|
||||
HelpData help_data;
|
||||
|
||||
float content_min_height = 0.0;
|
||||
float content_max_height = 0.0;
|
||||
|
||||
static HelpData _get_class_help_data(const StringName &p_class_name);
|
||||
static HelpData _get_enum_help_data(const StringName &p_class_name, const StringName &p_enum_name);
|
||||
static HelpData _get_constant_help_data(const StringName &p_class_name, const StringName &p_constant_name);
|
||||
static HelpData _get_property_help_data(const StringName &p_class_name, const StringName &p_property_name);
|
||||
static HelpData _get_theme_item_help_data(const StringName &p_class_name, const StringName &p_theme_item_name);
|
||||
static HelpData _get_method_help_data(const StringName &p_class_name, const StringName &p_method_name);
|
||||
static HelpData _get_signal_help_data(const StringName &p_class_name, const StringName &p_signal_name);
|
||||
static HelpData _get_annotation_help_data(const StringName &p_class_name, const StringName &p_annotation_name);
|
||||
|
||||
void _add_type_to_title(const DocType &p_doc_type);
|
||||
void _update_labels();
|
||||
void _go_to_help(const String &p_what);
|
||||
void _meta_clicked(const String &p_select);
|
||||
|
||||
protected:
|
||||
static void _bind_methods();
|
||||
void _notification(int p_what);
|
||||
|
||||
public:
|
||||
void parse_symbol(const String &p_symbol, const String &p_prologue = String());
|
||||
void set_custom_text(const String &p_type, const String &p_name, const String &p_description);
|
||||
|
||||
void set_content_height_limits(float p_min, float p_max);
|
||||
void update_content_height();
|
||||
|
||||
EditorHelpBit(const String &p_symbol = String(), const String &p_prologue = String(), bool p_use_class_prefix = false, bool p_allow_selection = true);
|
||||
};
|
||||
|
||||
// Standard tooltips do not allow you to hover over them.
|
||||
// This class is intended as a temporary workaround.
|
||||
class EditorHelpBitTooltip : public PopupPanel {
|
||||
GDCLASS(EditorHelpBitTooltip, PopupPanel);
|
||||
|
||||
static bool _is_tooltip_visible;
|
||||
|
||||
Timer *timer = nullptr;
|
||||
uint64_t _enter_tree_time = 0;
|
||||
bool _is_mouse_inside_tooltip = false;
|
||||
|
||||
static Control *_make_invisible_control();
|
||||
|
||||
void _start_timer();
|
||||
void _target_gui_input(const Ref<InputEvent> &p_event);
|
||||
|
||||
protected:
|
||||
void _notification(int p_what);
|
||||
|
||||
public:
|
||||
static Control *show_tooltip(Control *p_target, const String &p_symbol, const String &p_prologue = String(), bool p_use_class_prefix = false);
|
||||
|
||||
void popup_under_cursor();
|
||||
|
||||
EditorHelpBitTooltip(Control *p_target);
|
||||
};
|
||||
|
||||
class EditorSyntaxHighlighter;
|
||||
|
||||
class EditorHelpHighlighter {
|
||||
public:
|
||||
enum Language {
|
||||
LANGUAGE_GDSCRIPT,
|
||||
LANGUAGE_CSHARP,
|
||||
LANGUAGE_MAX,
|
||||
};
|
||||
|
||||
private:
|
||||
using HighlightData = Vector<Pair<int, Color>>;
|
||||
|
||||
static EditorHelpHighlighter *singleton;
|
||||
|
||||
HashMap<String, HighlightData> highlight_data_caches[LANGUAGE_MAX];
|
||||
|
||||
TextEdit *text_edits[LANGUAGE_MAX];
|
||||
Ref<Script> scripts[LANGUAGE_MAX];
|
||||
Ref<EditorSyntaxHighlighter> highlighters[LANGUAGE_MAX];
|
||||
|
||||
HighlightData _get_highlight_data(Language p_language, const String &p_source, bool p_use_cache);
|
||||
|
||||
public:
|
||||
static void create_singleton();
|
||||
static void free_singleton();
|
||||
static EditorHelpHighlighter *get_singleton();
|
||||
|
||||
void highlight(RichTextLabel *p_rich_text_label, Language p_language, const String &p_source, bool p_use_cache);
|
||||
void reset_cache();
|
||||
|
||||
EditorHelpHighlighter();
|
||||
virtual ~EditorHelpHighlighter();
|
||||
};
|
1320
editor/doc/editor_help_search.cpp
Normal file
1320
editor/doc/editor_help_search.cpp
Normal file
File diff suppressed because it is too large
Load Diff
213
editor/doc/editor_help_search.h
Normal file
213
editor/doc/editor_help_search.h
Normal file
@@ -0,0 +1,213 @@
|
||||
/**************************************************************************/
|
||||
/* editor_help_search.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 "editor/plugins/editor_plugin.h"
|
||||
#include "scene/gui/dialogs.h"
|
||||
#include "scene/gui/option_button.h"
|
||||
#include "scene/gui/tree.h"
|
||||
|
||||
class EditorHelpSearch : public ConfirmationDialog {
|
||||
GDCLASS(EditorHelpSearch, ConfirmationDialog);
|
||||
|
||||
enum SearchFlags {
|
||||
SEARCH_CLASSES = 1 << 0,
|
||||
SEARCH_CONSTRUCTORS = 1 << 1,
|
||||
SEARCH_METHODS = 1 << 2,
|
||||
SEARCH_OPERATORS = 1 << 3,
|
||||
SEARCH_SIGNALS = 1 << 4,
|
||||
SEARCH_CONSTANTS = 1 << 5,
|
||||
SEARCH_PROPERTIES = 1 << 6,
|
||||
SEARCH_THEME_ITEMS = 1 << 7,
|
||||
SEARCH_ANNOTATIONS = 1 << 8,
|
||||
SEARCH_ALL = SEARCH_CLASSES | SEARCH_CONSTRUCTORS | SEARCH_METHODS | SEARCH_OPERATORS | SEARCH_SIGNALS | SEARCH_CONSTANTS | SEARCH_PROPERTIES | SEARCH_THEME_ITEMS | SEARCH_ANNOTATIONS,
|
||||
SEARCH_CASE_SENSITIVE = 1 << 29,
|
||||
SEARCH_SHOW_HIERARCHY = 1 << 30
|
||||
};
|
||||
|
||||
LineEdit *search_box = nullptr;
|
||||
Button *case_sensitive_button = nullptr;
|
||||
Button *hierarchy_button = nullptr;
|
||||
OptionButton *filter_combo = nullptr;
|
||||
Tree *results_tree = nullptr;
|
||||
bool old_search = false;
|
||||
String old_term;
|
||||
int old_search_flags = 0;
|
||||
|
||||
class Runner;
|
||||
Ref<Runner> search;
|
||||
|
||||
struct TreeCache {
|
||||
HashMap<String, TreeItem *> item_cache;
|
||||
|
||||
void clear();
|
||||
|
||||
~TreeCache() {
|
||||
clear();
|
||||
}
|
||||
} tree_cache;
|
||||
|
||||
void _update_results();
|
||||
|
||||
void _search_box_gui_input(const Ref<InputEvent> &p_event);
|
||||
void _search_box_text_changed(const String &p_text);
|
||||
void _filter_combo_item_selected(int p_option);
|
||||
void _confirmed();
|
||||
|
||||
bool _all_terms_in_name(const Vector<String> &p_terms, const String &p_name) const;
|
||||
void _match_method_name_and_push_back(const String &p_term, const Vector<String> &p_terms, Vector<DocData::MethodDoc> &p_methods, const String &p_type, const String &p_metatype, const String &p_class_name, Dictionary &r_result) const;
|
||||
void _match_const_name_and_push_back(const String &p_term, const Vector<String> &p_terms, Vector<DocData::ConstantDoc> &p_constants, const String &p_type, const String &p_metatype, const String &p_class_name, Dictionary &r_result) const;
|
||||
void _match_property_name_and_push_back(const String &p_term, const Vector<String> &p_terms, Vector<DocData::PropertyDoc> &p_properties, const String &p_type, const String &p_metatype, const String &p_class_name, Dictionary &r_result) const;
|
||||
void _match_theme_property_name_and_push_back(const String &p_term, const Vector<String> &p_terms, Vector<DocData::ThemeItemDoc> &p_properties, const String &p_type, const String &p_metatype, const String &p_class_name, Dictionary &r_result) const;
|
||||
|
||||
Dictionary _native_search_cb(const String &p_search_string, int p_result_limit);
|
||||
void _native_action_cb(const String &p_item_string);
|
||||
|
||||
protected:
|
||||
void _notification(int p_what);
|
||||
static void _bind_methods();
|
||||
|
||||
public:
|
||||
void popup_dialog();
|
||||
void popup_dialog(const String &p_term);
|
||||
|
||||
EditorHelpSearch();
|
||||
};
|
||||
|
||||
class EditorHelpSearch::Runner : public RefCounted {
|
||||
enum Phase {
|
||||
PHASE_MATCH_CLASSES_INIT,
|
||||
PHASE_MATCH_CLASSES,
|
||||
PHASE_CLASS_ITEMS_INIT,
|
||||
PHASE_CLASS_ITEMS,
|
||||
PHASE_MEMBER_ITEMS_INIT,
|
||||
PHASE_MEMBER_ITEMS,
|
||||
PHASE_SELECT_MATCH,
|
||||
PHASE_MAX
|
||||
};
|
||||
int phase = 0;
|
||||
|
||||
template <typename T>
|
||||
struct MemberMatch {
|
||||
const T *doc = nullptr;
|
||||
bool name = false;
|
||||
String keyword;
|
||||
|
||||
MemberMatch() {}
|
||||
MemberMatch(const T *p_doc) :
|
||||
doc(p_doc) {}
|
||||
};
|
||||
|
||||
struct ClassMatch {
|
||||
const DocData::ClassDoc *doc = nullptr;
|
||||
bool name = false;
|
||||
String keyword;
|
||||
LocalVector<MemberMatch<DocData::MethodDoc>> constructors;
|
||||
LocalVector<MemberMatch<DocData::MethodDoc>> methods;
|
||||
LocalVector<MemberMatch<DocData::MethodDoc>> operators;
|
||||
LocalVector<MemberMatch<DocData::MethodDoc>> signals;
|
||||
LocalVector<MemberMatch<DocData::ConstantDoc>> constants;
|
||||
LocalVector<MemberMatch<DocData::PropertyDoc>> properties;
|
||||
LocalVector<MemberMatch<DocData::ThemeItemDoc>> theme_properties;
|
||||
LocalVector<MemberMatch<DocData::MethodDoc>> annotations;
|
||||
|
||||
bool required() {
|
||||
return name || !keyword.is_empty() || !constructors.is_empty() || !methods.is_empty() || !operators.is_empty() || !signals.is_empty() || !constants.is_empty() || !properties.is_empty() || !theme_properties.is_empty() || !annotations.is_empty();
|
||||
}
|
||||
};
|
||||
|
||||
Control *ui_service = nullptr;
|
||||
Tree *results_tree = nullptr;
|
||||
TreeCache *tree_cache = nullptr;
|
||||
String term;
|
||||
Vector<String> terms;
|
||||
int search_flags;
|
||||
|
||||
Color disabled_color;
|
||||
|
||||
HashMap<String, DocData::ClassDoc>::Iterator iterator_doc;
|
||||
LocalVector<RBSet<String, NaturalNoCaseComparator>::Element *> iterator_stack;
|
||||
HashMap<String, ClassMatch> matches;
|
||||
HashMap<String, ClassMatch>::Iterator iterator_match;
|
||||
LocalVector<Pair<DocData::ClassDoc *, String>> matched_classes;
|
||||
TreeItem *root_item = nullptr;
|
||||
HashMap<String, TreeItem *> class_items;
|
||||
TreeItem *matched_item = nullptr;
|
||||
float match_highest_score = 0;
|
||||
|
||||
bool _is_class_disabled_by_feature_profile(const StringName &p_class);
|
||||
|
||||
void _populate_cache();
|
||||
bool _find_or_create_item(TreeItem *p_parent, const String &p_item_meta, TreeItem *&r_item);
|
||||
|
||||
bool _fill();
|
||||
bool _phase_fill_classes_init();
|
||||
bool _phase_fill_classes();
|
||||
bool _phase_fill_member_items_init();
|
||||
bool _phase_fill_member_items();
|
||||
|
||||
bool _slice();
|
||||
bool _phase_match_classes_init();
|
||||
bool _phase_match_classes();
|
||||
bool _phase_class_items_init();
|
||||
bool _phase_class_items();
|
||||
bool _phase_member_items_init();
|
||||
bool _phase_member_items();
|
||||
bool _phase_select_match();
|
||||
|
||||
String _build_method_tooltip(const DocData::ClassDoc *p_class_doc, const DocData::MethodDoc *p_doc) const;
|
||||
String _build_keywords_tooltip(const String &p_keywords) const;
|
||||
|
||||
void _match_method_name_and_push_back(Vector<DocData::MethodDoc> &p_methods, LocalVector<MemberMatch<DocData::MethodDoc>> *r_match_methods);
|
||||
bool _all_terms_in_name(const String &p_name) const;
|
||||
String _match_keywords_in_all_terms(const String &p_keywords) const;
|
||||
bool _match_string(const String &p_term, const String &p_string) const;
|
||||
String _match_keywords(const String &p_term, const String &p_keywords) const;
|
||||
void _match_item(TreeItem *p_item, const String &p_text, bool p_is_keywords = false);
|
||||
TreeItem *_create_class_hierarchy(const ClassMatch &p_match);
|
||||
TreeItem *_create_class_hierarchy(const DocData::ClassDoc *p_class_doc, const String &p_matching_keyword, bool p_gray);
|
||||
TreeItem *_create_class_item(TreeItem *p_parent, const DocData::ClassDoc *p_doc, bool p_gray, const String &p_matching_keyword);
|
||||
TreeItem *_create_category_item(TreeItem *p_parent, const String &p_class, const StringName &p_icon, const String &p_text, const String &p_metatype);
|
||||
TreeItem *_create_method_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const MemberMatch<DocData::MethodDoc> &p_match);
|
||||
TreeItem *_create_constructor_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const MemberMatch<DocData::MethodDoc> &p_match);
|
||||
TreeItem *_create_operator_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const MemberMatch<DocData::MethodDoc> &p_match);
|
||||
TreeItem *_create_signal_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const MemberMatch<DocData::MethodDoc> &p_match);
|
||||
TreeItem *_create_annotation_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const MemberMatch<DocData::MethodDoc> &p_match);
|
||||
TreeItem *_create_constant_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const MemberMatch<DocData::ConstantDoc> &p_match);
|
||||
TreeItem *_create_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const MemberMatch<DocData::PropertyDoc> &p_match);
|
||||
TreeItem *_create_theme_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const MemberMatch<DocData::ThemeItemDoc> &p_match);
|
||||
TreeItem *_create_member_item(TreeItem *p_parent, const String &p_class_name, const StringName &p_icon, const String &p_name, const String &p_text, const String &p_type, const String &p_metatype, const String &p_tooltip, const String &p_keywords, bool p_is_deprecated, bool p_is_experimental, const String &p_matching_keyword);
|
||||
|
||||
public:
|
||||
bool work(uint64_t slot = 100000);
|
||||
|
||||
Runner(Control *p_icon_service, Tree *p_results_tree, TreeCache *p_tree_cache, const String &p_term, int p_search_flags);
|
||||
};
|
Reference in New Issue
Block a user