godot/editor/editor_help.h
Rémi Verschelde d95794ec8a
One Copyright Update to rule them all
As many open source projects have started doing it, we're removing the
current year from the copyright notice, so that we don't need to bump
it every year.

It seems like only the first year of publication is technically
relevant for copyright notices, and even that seems to be something
that many companies stopped listing altogether (in a version controlled
codebase, the commits are a much better source of date of publication
than a hardcoded copyright statement).

We also now list Godot Engine contributors first as we're collectively
the current maintainers of the project, and we clarify that the
"exclusive" copyright of the co-founders covers the timespan before
opensourcing (their further contributions are included as part of Godot
Engine contributors).

Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 13:25:55 +01:00

237 lines
7.1 KiB
C++

/**************************************************************************/
/* 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. */
/**************************************************************************/
#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"
#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);
static void _bind_methods();
public:
void set_rich_text_label(RichTextLabel *p_rich_text_label);
void popup_search();
bool search_prev();
bool search_next();
FindBar();
};
class EditorHelp : public VBoxContainer {
GDCLASS(EditorHelp, VBoxContainer);
enum Page {
PAGE_CLASS_LIST,
PAGE_CLASS_DESC,
PAGE_CLASS_PREV,
PAGE_CLASS_NEXT,
PAGE_SEARCH,
CLASS_SEARCH,
};
bool select_locked = 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;
static DocTools *doc;
ConfirmationDialog *search_dialog = nullptr;
LineEdit *search = nullptr;
FindBar *find_bar = nullptr;
HBoxContainer *status_bar = nullptr;
Button *toggle_scripts_button = nullptr;
String base_path;
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_title_font;
Ref<Font> doc_code_font;
int doc_title_font_size;
int scroll_to = -1;
void _update_theme();
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());
void _add_type_icon(const String &p_type, int p_size = 0);
void _add_method(const DocData::MethodDoc &p_method, bool p_overview = true);
void _add_bulletpoint();
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, int p_vscr = -1);
//void _update_history_buttons();
void _update_method_list(const Vector<DocData::MethodDoc> p_methods);
void _update_method_descriptions(const DocData::ClassDoc p_classdoc, const Vector<DocData::MethodDoc> p_methods, const String &p_method_type);
void _update_doc();
void _request_help(const String &p_string);
void _search(bool p_search_previous = false);
String _fix_constant(const String &p_constant) const;
void _toggle_scripts_pressed();
static Thread thread;
static void _wait_for_thread();
static void _gen_doc_thread(void *p_udata);
protected:
void _notification(int p_what);
static void _bind_methods();
public:
static void generate_doc();
static DocTools *get_doc_data();
static void cleanup_doc();
void go_to_help(const String &p_help);
void go_to_class(const String &p_class, int p_scroll = 0);
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_scripts_button();
EditorHelp();
~EditorHelp();
};
class EditorHelpBit : public MarginContainer {
GDCLASS(EditorHelpBit, MarginContainer);
RichTextLabel *rich_text = nullptr;
void _go_to_help(String p_what);
void _meta_clicked(String p_select);
String text;
protected:
static void _bind_methods();
void _notification(int p_what);
public:
RichTextLabel *get_rich_text() { return rich_text; }
void set_text(const String &p_text);
EditorHelpBit();
};
#endif // EDITOR_HELP_H