godot/editor/editor_help.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

282 lines
8.9 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/**************************************************************************/
/* 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. */
/**************************************************************************/
2014-02-10 01:10:30 +00:00
#ifndef EDITOR_HELP_H
#define EDITOR_HELP_H
#include "core/os/thread.h"
#include "editor/code_editor.h"
#include "editor/doc_tools.h"
#include "editor/editor_plugin.h"
#include "scene/gui/margin_container.h"
2014-02-10 01:10:30 +00:00
#include "scene/gui/menu_button.h"
#include "scene/gui/panel_container.h"
#include "scene/gui/rich_text_label.h"
#include "scene/gui/split_container.h"
#include "scene/gui/tab_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;
TextureButton *hide_button = nullptr;
String prev_search;
RichTextLabel *rich_text_label = nullptr;
int results_count = 0;
void _hide_bar();
void _search_text_changed(const String &p_text);
void _search_text_submitted(const String &p_text);
void _update_results_count();
void _update_matches_label();
protected:
void _notification(int p_what);
virtual void unhandled_input(const Ref<InputEvent> &p_event) override;
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();
};
2014-02-10 01:10:30 +00:00
class EditorHelp : public VBoxContainer {
GDCLASS(EditorHelp, VBoxContainer);
2014-02-10 01:10:30 +00:00
enum MethodType {
METHOD_TYPE_METHOD,
METHOD_TYPE_CONSTRUCTOR,
METHOD_TYPE_OPERATOR,
METHOD_TYPE_MAX
2014-02-10 01:10:30 +00:00
};
bool select_locked = false;
2014-02-10 01:10:30 +00:00
String prev_search;
String edited_class;
2014-02-10 01:10:30 +00:00
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;
2014-02-10 01:10:30 +00:00
RichTextLabel *class_desc = nullptr;
HSplitContainer *h_split = nullptr;
static DocTools *doc;
2014-02-10 01:10:30 +00:00
ConfirmationDialog *search_dialog = nullptr;
LineEdit *search = nullptr;
FindBar *find_bar = nullptr;
HBoxContainer *status_bar = nullptr;
Button *toggle_scripts_button = nullptr;
2014-02-10 01:10:30 +00:00
String base_path;
2014-02-10 01:10:30 +00:00
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;
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;
2022-05-30 07:04:07 +00:00
int scroll_to = -1;
void _help_callback(const String &p_topic);
2017-08-12 16:52:50 +00:00
void _add_text(const String &p_bbcode);
bool scroll_locked = false;
2014-02-10 01:10:30 +00:00
//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);
2014-02-10 01:10:30 +00:00
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();
2022-05-30 07:04:07 +00:00
void _class_desc_finished();
2014-02-10 01:10:30 +00:00
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);
2022-01-29 17:48:30 +00:00
void _class_desc_resized(bool p_force_update_theme);
int display_margin = 0;
2014-02-10 01:10:30 +00:00
Error _goto_desc(const String &p_class);
//void _update_history_buttons();
void _update_method_list(const Vector<DocData::MethodDoc> p_methods, MethodType p_method_type);
void _update_method_descriptions(const DocData::ClassDoc p_classdoc, const Vector<DocData::MethodDoc> p_methods, MethodType p_method_type);
2014-02-10 01:10:30 +00:00
void _update_doc();
void _request_help(const String &p_string);
void _search(bool p_search_previous = false);
2014-02-10 01:10:30 +00:00
2018-08-21 20:12:55 +00:00
String _fix_constant(const String &p_constant) const;
void _toggle_scripts_pressed();
2018-08-21 20:12:55 +00:00
static int doc_generation_count;
static String doc_version_hash;
static Thread worker_thread;
static void _wait_for_thread();
2023-02-07 20:14:00 +00:00
static void _load_doc_thread(void *p_udata);
static void _gen_doc_thread(void *p_udata);
static void _gen_extensions_docs();
static void _compute_doc_version_hash();
2014-02-10 01:10:30 +00:00
protected:
virtual void _update_theme_item_cache() override;
2014-02-10 01:10:30 +00:00
void _notification(int p_what);
static void _bind_methods();
public:
static void generate_doc(bool p_use_cache = true);
static DocTools *get_doc_data();
static void cleanup_doc();
2023-02-07 20:14:00 +00:00
static String get_cache_full_path();
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);
2014-02-10 01:10:30 +00:00
String get_class();
2014-02-10 01:10:30 +00:00
void set_focused() { class_desc->grab_focus(); }
2014-02-10 01:10:30 +00:00
int get_scroll() const;
void set_scroll(int p_scroll);
2014-02-10 01:10:30 +00:00
void update_toggle_scripts_button();
EditorHelp();
~EditorHelp();
};
2014-02-10 01:10:30 +00:00
class EditorHelpBit : public MarginContainer {
GDCLASS(EditorHelpBit, MarginContainer);
2023-09-21 02:54:51 +00:00
inline static HashMap<StringName, String> doc_class_cache;
inline static HashMap<StringName, HashMap<StringName, String>> doc_property_cache;
inline static HashMap<StringName, HashMap<StringName, String>> doc_method_cache;
inline static HashMap<StringName, HashMap<StringName, String>> doc_signal_cache;
inline static HashMap<StringName, HashMap<StringName, String>> doc_theme_item_cache;
RichTextLabel *rich_text = nullptr;
void _go_to_help(String p_what);
2017-08-12 16:52:50 +00:00
void _meta_clicked(String p_select);
String text;
protected:
static void _bind_methods();
void _notification(int p_what);
public:
2023-09-21 02:54:51 +00:00
String get_class_description(const StringName &p_class_name) const;
String get_property_description(const StringName &p_class_name, const StringName &p_property_name) const;
String get_method_description(const StringName &p_class_name, const StringName &p_method_name) const;
String get_signal_description(const StringName &p_class_name, const StringName &p_signal_name) const;
String get_theme_item_description(const StringName &p_class_name, const StringName &p_theme_item_name) const;
RichTextLabel *get_rich_text() { return rich_text; }
void set_text(const String &p_text);
2023-09-21 02:54:51 +00:00
EditorHelpBit();
};
2023-09-21 02:54:51 +00:00
class EditorHelpTooltip : public EditorHelpBit {
GDCLASS(EditorHelpTooltip, EditorHelpBit);
String tooltip_text;
protected:
void _notification(int p_what);
public:
void parse_tooltip(const String &p_text);
EditorHelpTooltip(const String &p_text = String());
};
2014-02-10 01:10:30 +00:00
#endif // EDITOR_HELP_H