1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402 | /**************************************************************************/
/* 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/plugins/editor_plugin.h"
#include "scene/gui/menu_button.h"
#include "scene/gui/panel_container.h"
#include "scene/gui/popup.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"
#include "modules/modules_enabled.gen.h" // For gdscript, mono.
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();
};
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;
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;
static DocTools *ext_doc;
ConfirmationDialog *search_dialog = nullptr;
LineEdit *search = nullptr;
FindBar *find_bar = nullptr;
HBoxContainer *status_bar = nullptr;
Button *toggle_scripts_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_scripts_pressed();
static int doc_generation_count;
static String doc_version_hash;
static Thread worker_thread;
static void _wait_for_thread();
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();
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);
static DocTools *get_doc_data();
static void cleanup_doc();
static String get_cache_full_path();
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_scripts_button();
static void init_gdext_pointers();
EditorHelp();
~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;
String qualifiers;
};
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 'EditorHelpBitTooltip' has a constructor with 1 argument that is not explicit. [+]Class 'EditorHelpBitTooltip' has a constructor with 1 argument that is not explicit. Such constructors should in general be explicit for type safety reasons. Using the explicit keyword in the constructor means some mistakes when using the class can be avoided.
};
#if defined(MODULE_GDSCRIPT_ENABLED) || defined(MODULE_MONO_ENABLED)
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();
};
#endif // defined(MODULE_GDSCRIPT_ENABLED) || defined(MODULE_MONO_ENABLED)
#endif // EDITOR_HELP_H
|