2014-02-10 02:10:30 +01:00
/**************************************************************************/
/* editor_help.cpp */
/**************************************************************************/
/* 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. */
/**************************************************************************/
2018-01-05 00:50:27 +01:00
2014-02-10 02:10:30 +01:00
# include "editor_help.h"
2017-01-16 08:04:19 +01:00
2021-08-24 20:16:25 +02:00
# include "core/core_constants.h"
2023-10-19 00:50:30 +02:00
# include "core/extension/gdextension.h"
2020-04-28 15:19:37 +02:00
# include "core/input/input.h"
2023-04-21 15:32:26 +02:00
# include "core/object/script_language.h"
2018-09-11 18:13:45 +02:00
# include "core/os/keyboard.h"
2024-01-17 15:22:43 +01:00
# include "core/string/string_builder.h"
2023-02-07 21:14:00 +01:00
# include "core/version.h"
2024-01-15 13:14:55 +01:00
# include "editor/doc_data_compressed.gen.h"
2022-02-12 02:46:22 +01:00
# include "editor/editor_node.h"
2023-02-07 21:14:00 +01:00
# include "editor/editor_paths.h"
2023-09-21 04:54:51 +02:00
# include "editor/editor_property_name_processor.h"
2022-02-12 02:46:22 +01:00
# include "editor/editor_settings.h"
2023-08-13 02:33:39 +02:00
# include "editor/editor_string_names.h"
2017-03-05 14:21:25 +01:00
# include "editor/plugins/script_editor_plugin.h"
2024-01-15 13:14:55 +01:00
# include "editor/themes/editor_scale.h"
2022-11-19 12:45:49 +01:00
# include "scene/gui/line_edit.h"
2014-02-21 03:01:44 +01:00
2023-01-14 17:38:00 +01:00
# define CONTRIBUTE_URL vformat("%s / contributing / documentation / updating_the_class_reference.html", VERSION_DOCS_URL)
2017-09-13 00:16:18 +02:00
2023-07-08 13:17:41 +02:00
# ifdef MODULE_MONO_ENABLED
// Sync with the types mentioned in https://docs.godotengine.org/en/stable/tutorials/scripting/c_sharp/c_sharp_differences.html
const Vector < String > classes_with_csharp_differences = {
" @GlobalScope " ,
" String " ,
" NodePath " ,
" Signal " ,
" Callable " ,
" RID " ,
" Basis " ,
" Transform2D " ,
" Transform3D " ,
" Rect2 " ,
" Rect2i " ,
" AABB " ,
" Quaternion " ,
" Projection " ,
" Color " ,
" Array " ,
" Dictionary " ,
" PackedByteArray " ,
" PackedColorArray " ,
" PackedFloat32Array " ,
" PackedFloat64Array " ,
" PackedInt32Array " ,
" PackedInt64Array " ,
" PackedStringArray " ,
" PackedVector2Array " ,
" PackedVector3Array " ,
" Variant " ,
} ;
# endif
2023-04-21 15:32:26 +02:00
// TODO: this is sometimes used directly as doc->something, other times as EditorHelp::get_doc_data(), which is thread-safe.
// Might this be a problem?
2020-11-29 04:42:06 +01:00
DocTools * EditorHelp : : doc = nullptr ;
2023-10-19 00:50:30 +02:00
DocTools * EditorHelp : : ext_doc = nullptr ;
2014-02-16 01:16:33 +01:00
2023-04-21 15:32:26 +02:00
static bool _attempt_doc_load ( const String & p_class ) {
// Docgen always happens in the outer-most class: it also generates docs for inner classes.
String outer_class = p_class . get_slice ( " . " , 0 ) ;
if ( ! ScriptServer : : is_global_class ( outer_class ) ) {
return false ;
}
// ResourceLoader is used in order to have a script-agnostic way to load scripts.
// This forces GDScript to compile the code, which is unnecessary for docgen, but it's a good compromise right now.
Ref < Script > script = ResourceLoader : : load ( ScriptServer : : get_global_class_path ( outer_class ) , outer_class ) ;
if ( script . is_valid ( ) ) {
Vector < DocData : : ClassDoc > docs = script - > get_documentation ( ) ;
for ( int j = 0 ; j < docs . size ( ) ; j + + ) {
const DocData : : ClassDoc & doc = docs . get ( j ) ;
EditorHelp : : get_doc_data ( ) - > add_doc ( doc ) ;
}
return true ;
}
return false ;
}
// Removes unnecessary prefix from p_class_specifier when within the p_edited_class context
static String _contextualize_class_specifier ( const String & p_class_specifier , const String & p_edited_class ) {
// If this is a completely different context than the current class, then keep full path
if ( ! p_class_specifier . begins_with ( p_edited_class ) ) {
return p_class_specifier ;
}
// Here equal length + begins_with from above implies p_class_specifier == p_edited_class :)
if ( p_class_specifier . length ( ) = = p_edited_class . length ( ) ) {
int rfind = p_class_specifier . rfind ( " . " ) ;
if ( rfind = = - 1 ) { // Single identifier
return p_class_specifier ;
}
// Multiple specifiers: keep last one only
return p_class_specifier . substr ( rfind + 1 ) ;
}
2023-04-28 12:49:24 +02:00
// They share a _name_ prefix but not a _class specifier_ prefix, e.g. Tree & TreeItem
// begins_with + lengths being different implies p_class_specifier.length() > p_edited_class.length() so this is safe
if ( p_class_specifier [ p_edited_class . length ( ) ] ! = ' . ' ) {
return p_class_specifier ;
}
// Remove class specifier prefix
2023-04-21 15:32:26 +02:00
return p_class_specifier . substr ( p_edited_class . length ( ) + 1 ) ;
}
2023-02-11 16:29:44 +01:00
void EditorHelp : : _update_theme_item_cache ( ) {
VBoxContainer : : _update_theme_item_cache ( ) ;
theme_cache . text_color = get_theme_color ( SNAME ( " text_color " ) , SNAME ( " EditorHelp " ) ) ;
theme_cache . title_color = get_theme_color ( SNAME ( " title_color " ) , SNAME ( " EditorHelp " ) ) ;
theme_cache . headline_color = get_theme_color ( SNAME ( " headline_color " ) , SNAME ( " EditorHelp " ) ) ;
theme_cache . comment_color = get_theme_color ( SNAME ( " comment_color " ) , SNAME ( " EditorHelp " ) ) ;
theme_cache . symbol_color = get_theme_color ( SNAME ( " symbol_color " ) , SNAME ( " EditorHelp " ) ) ;
theme_cache . value_color = get_theme_color ( SNAME ( " value_color " ) , SNAME ( " EditorHelp " ) ) ;
theme_cache . qualifier_color = get_theme_color ( SNAME ( " qualifier_color " ) , SNAME ( " EditorHelp " ) ) ;
theme_cache . type_color = get_theme_color ( SNAME ( " type_color " ) , SNAME ( " EditorHelp " ) ) ;
2024-01-16 16:54:45 +01:00
theme_cache . override_color = get_theme_color ( SNAME ( " override_color " ) , SNAME ( " EditorHelp " ) ) ;
2023-02-11 16:29:44 +01:00
2023-08-13 02:33:39 +02:00
theme_cache . doc_font = get_theme_font ( SNAME ( " doc " ) , EditorStringName ( EditorFonts ) ) ;
theme_cache . doc_bold_font = get_theme_font ( SNAME ( " doc_bold " ) , EditorStringName ( EditorFonts ) ) ;
theme_cache . doc_italic_font = get_theme_font ( SNAME ( " doc_italic " ) , EditorStringName ( EditorFonts ) ) ;
theme_cache . doc_title_font = get_theme_font ( SNAME ( " doc_title " ) , EditorStringName ( EditorFonts ) ) ;
theme_cache . doc_code_font = get_theme_font ( SNAME ( " doc_source " ) , EditorStringName ( EditorFonts ) ) ;
theme_cache . doc_kbd_font = get_theme_font ( SNAME ( " doc_keyboard " ) , EditorStringName ( EditorFonts ) ) ;
2023-02-11 16:29:44 +01:00
2023-08-13 02:33:39 +02:00
theme_cache . doc_font_size = get_theme_font_size ( SNAME ( " doc_size " ) , EditorStringName ( EditorFonts ) ) ;
theme_cache . doc_title_font_size = get_theme_font_size ( SNAME ( " doc_title_size " ) , EditorStringName ( EditorFonts ) ) ;
theme_cache . doc_code_font_size = get_theme_font_size ( SNAME ( " doc_source_size " ) , EditorStringName ( EditorFonts ) ) ;
theme_cache . doc_kbd_font_size = get_theme_font_size ( SNAME ( " doc_keyboard_size " ) , EditorStringName ( EditorFonts ) ) ;
2023-02-11 16:29:44 +01:00
theme_cache . background_style = get_theme_stylebox ( SNAME ( " background " ) , SNAME ( " EditorHelp " ) ) ;
2022-08-29 11:04:31 +02:00
2023-10-19 18:05:19 +02:00
class_desc - > begin_bulk_theme_override ( ) ;
2023-02-11 17:33:38 +01:00
class_desc - > add_theme_font_override ( " normal_font " , theme_cache . doc_font ) ;
class_desc - > add_theme_font_size_override ( " normal_font_size " , theme_cache . doc_font_size ) ;
2022-08-29 11:04:31 +02:00
class_desc - > add_theme_color_override ( " selection_color " , get_theme_color ( SNAME ( " selection_color " ) , SNAME ( " EditorHelp " ) ) ) ;
class_desc - > add_theme_constant_override ( " line_separation " , get_theme_constant ( SNAME ( " line_separation " ) , SNAME ( " EditorHelp " ) ) ) ;
class_desc - > add_theme_constant_override ( " table_h_separation " , get_theme_constant ( SNAME ( " table_h_separation " ) , SNAME ( " EditorHelp " ) ) ) ;
class_desc - > add_theme_constant_override ( " table_v_separation " , get_theme_constant ( SNAME ( " table_v_separation " ) , SNAME ( " EditorHelp " ) ) ) ;
2022-10-31 19:51:48 +01:00
class_desc - > add_theme_constant_override ( " text_highlight_h_padding " , get_theme_constant ( SNAME ( " text_highlight_h_padding " ) , SNAME ( " EditorHelp " ) ) ) ;
class_desc - > add_theme_constant_override ( " text_highlight_v_padding " , get_theme_constant ( SNAME ( " text_highlight_v_padding " ) , SNAME ( " EditorHelp " ) ) ) ;
2023-10-19 18:05:19 +02:00
class_desc - > end_bulk_theme_override ( ) ;
2022-08-29 11:04:31 +02:00
}
2019-10-09 17:41:49 +02:00
void EditorHelp : : _search ( bool p_search_previous ) {
2020-05-14 16:41:43 +02:00
if ( p_search_previous ) {
2019-10-09 17:41:49 +02:00
find_bar - > search_prev ( ) ;
2020-05-14 16:41:43 +02:00
} else {
2019-10-09 17:41:49 +02:00
find_bar - > search_next ( ) ;
2020-05-14 16:41:43 +02:00
}
2014-02-10 02:10:30 +01:00
}
2022-05-30 09:04:07 +02:00
void EditorHelp : : _class_desc_finished ( ) {
if ( scroll_to > = 0 ) {
class_desc - > scroll_to_paragraph ( scroll_to ) ;
}
scroll_to = - 1 ;
}
2014-02-10 02:10:30 +01:00
void EditorHelp : : _class_list_select ( const String & p_select ) {
_goto_desc ( p_select ) ;
}
void EditorHelp : : _class_desc_select ( const String & p_select ) {
2023-04-21 15:32:26 +02:00
if ( p_select . begins_with ( " $ " ) ) { // enum
2017-08-24 00:10:32 +02:00
String select = p_select . substr ( 1 , p_select . length ( ) ) ;
String class_name ;
2023-04-21 15:32:26 +02:00
int rfind = select . rfind ( " . " ) ;
if ( rfind ! = - 1 ) {
class_name = select . substr ( 0 , rfind ) ;
select = select . substr ( rfind + 1 ) ;
2017-08-24 00:10:32 +02:00
} else {
2017-11-15 18:45:34 +01:00
class_name = " @GlobalScope " ;
2017-08-24 00:10:32 +02:00
}
2021-07-17 23:22:52 +02:00
emit_signal ( SNAME ( " go_to_help " ) , " class_enum: " + class_name + " : " + select ) ;
2017-08-24 00:10:32 +02:00
return ;
} else if ( p_select . begins_with ( " # " ) ) {
2021-07-17 23:22:52 +02:00
emit_signal ( SNAME ( " go_to_help " ) , " class_name: " + p_select . substr ( 1 , p_select . length ( ) ) ) ;
2014-02-10 02:10:30 +01:00
return ;
} else if ( p_select . begins_with ( " @ " ) ) {
2024-02-12 14:55:02 +01:00
int tag_end = p_select . find_char ( ' ' ) ;
2019-04-27 21:15:07 +02:00
String tag = p_select . substr ( 1 , tag_end - 1 ) ;
String link = p_select . substr ( tag_end + 1 , p_select . length ( ) ) . lstrip ( " " ) ;
2017-11-21 00:30:46 +01:00
String topic ;
2022-05-13 15:04:37 +02:00
HashMap < String , int > * table = nullptr ;
2017-11-21 00:30:46 +01:00
if ( tag = = " method " ) {
topic = " class_method " ;
2024-01-28 21:51:39 +01:00
table = & method_line ;
2023-10-02 20:11:43 +02:00
} else if ( tag = = " constructor " ) {
topic = " class_method " ;
2024-01-28 21:51:39 +01:00
table = & method_line ;
2023-10-02 20:11:43 +02:00
} else if ( tag = = " operator " ) {
topic = " class_method " ;
2024-01-28 21:51:39 +01:00
table = & method_line ;
2017-11-21 00:30:46 +01:00
} else if ( tag = = " member " ) {
topic = " class_property " ;
2024-01-28 21:51:39 +01:00
table = & property_line ;
2019-03-27 20:01:16 +01:00
} else if ( tag = = " enum " ) {
2017-11-21 00:30:46 +01:00
topic = " class_enum " ;
2024-01-28 21:51:39 +01:00
table = & enum_line ;
2017-11-21 00:30:46 +01:00
} else if ( tag = = " signal " ) {
topic = " class_signal " ;
2024-01-28 21:51:39 +01:00
table = & signal_line ;
2019-03-27 20:01:16 +01:00
} else if ( tag = = " constant " ) {
topic = " class_constant " ;
2024-01-28 21:51:39 +01:00
table = & constant_line ;
2022-07-04 17:56:34 +02:00
} else if ( tag = = " annotation " ) {
topic = " class_annotation " ;
2024-01-28 21:51:39 +01:00
table = & annotation_line ;
2021-11-18 15:03:03 +01:00
} else if ( tag = = " theme_item " ) {
2024-02-12 14:55:02 +01:00
topic = " class_theme_item " ;
2024-01-28 21:51:39 +01:00
table = & theme_property_line ;
2017-11-21 00:30:46 +01:00
} else {
return ;
}
2014-02-10 02:10:30 +01:00
2022-04-26 18:57:36 +02:00
// Case order is important here to correctly handle edge cases like Variant.Type in @GlobalScope.
if ( table - > has ( link ) ) {
// Found in the current page.
2022-05-30 09:04:07 +02:00
if ( class_desc - > is_ready ( ) ) {
class_desc - > scroll_to_paragraph ( ( * table ) [ link ] ) ;
} else {
scroll_to = ( * table ) [ link ] ;
}
2022-05-21 00:11:48 +02:00
} else {
// Look for link in @GlobalScope.
// Note that a link like @GlobalScope.enum_name will not be found in this section, only enum_name will be.
if ( topic = = " class_enum " ) {
const DocData : : ClassDoc & cd = doc - > class_list [ " @GlobalScope " ] ;
2024-02-16 14:28:05 +01:00
for ( const DocData : : ConstantDoc & constant : cd . constants ) {
if ( constant . enumeration = = link ) {
2022-05-21 00:11:48 +02:00
// Found in @GlobalScope.
emit_signal ( SNAME ( " go_to_help " ) , topic + " :@GlobalScope: " + link ) ;
return ;
}
2019-03-27 20:01:16 +01:00
}
2022-05-21 00:11:48 +02:00
} else if ( topic = = " class_constant " ) {
const DocData : : ClassDoc & cd = doc - > class_list [ " @GlobalScope " ] ;
2024-02-16 14:28:05 +01:00
for ( const DocData : : ConstantDoc & constant : cd . constants ) {
if ( constant . name = = link ) {
2022-05-21 00:11:48 +02:00
// Found in @GlobalScope.
emit_signal ( SNAME ( " go_to_help " ) , topic + " :@GlobalScope: " + link ) ;
return ;
}
2022-04-26 18:57:36 +02:00
}
}
2022-05-21 00:11:48 +02:00
if ( link . contains ( " . " ) ) {
2024-02-12 14:55:02 +01:00
int class_end = link . find_char ( ' . ' ) ;
2022-05-21 00:11:48 +02:00
emit_signal ( SNAME ( " go_to_help " ) , topic + " : " + link . substr ( 0 , class_end ) + " : " + link . substr ( class_end + 1 , link . length ( ) ) ) ;
}
2015-11-17 13:46:08 +01:00
}
2017-09-13 00:16:18 +02:00
} else if ( p_select . begins_with ( " http " ) ) {
OS : : get_singleton ( ) - > shell_open ( p_select ) ;
2024-01-19 09:56:42 +01:00
} else if ( p_select . begins_with ( " ^ " ) ) {
DisplayServer : : get_singleton ( ) - > clipboard_set ( p_select . trim_prefix ( " ^ " ) ) ;
2014-02-10 02:10:30 +01:00
}
}
2017-05-20 17:38:03 +02:00
void EditorHelp : : _class_desc_input ( const Ref < InputEvent > & p_input ) {
2016-06-03 20:11:34 +02:00
}
2022-01-29 18:48:30 +01:00
void EditorHelp : : _class_desc_resized ( bool p_force_update_theme ) {
2019-06-05 20:47:34 +02:00
// Add extra horizontal margins for better readability.
// The margins increase as the width of the editor help container increases.
2023-02-11 16:29:44 +01:00
real_t char_width = theme_cache . doc_code_font - > get_char_size ( ' x ' , theme_cache . doc_code_font_size ) . width ;
2022-01-24 08:51:35 +01:00
const int new_display_margin = MAX ( 30 * EDSCALE , get_parent_anchorable_rect ( ) . size . width - char_width * 120 * EDSCALE ) * 0.5 ;
2022-01-29 18:48:30 +01:00
if ( display_margin ! = new_display_margin | | p_force_update_theme ) {
2022-01-24 08:51:35 +01:00
display_margin = new_display_margin ;
2023-02-11 16:29:44 +01:00
Ref < StyleBox > class_desc_stylebox = theme_cache . background_style - > duplicate ( ) ;
2023-01-19 17:14:09 +01:00
class_desc_stylebox - > set_content_margin ( SIDE_LEFT , display_margin ) ;
class_desc_stylebox - > set_content_margin ( SIDE_RIGHT , display_margin ) ;
2022-02-08 10:14:58 +01:00
class_desc - > add_theme_style_override ( " normal " , class_desc_stylebox ) ;
2022-12-09 18:54:52 +01:00
class_desc - > add_theme_style_override ( " focused " , class_desc_stylebox ) ;
2022-01-24 08:51:35 +01:00
}
2019-06-05 20:47:34 +02:00
}
2023-06-15 16:06:22 +02:00
void EditorHelp : : _add_type ( const String & p_type , const String & p_enum , bool p_is_bitfield ) {
2022-11-01 23:45:40 +01:00
if ( p_type . is_empty ( ) | | p_type = = " void " ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( Color ( theme_cache . type_color , 0.5 ) ) ;
2022-11-01 23:45:40 +01:00
class_desc - > push_hint ( TTR ( " No return value. " ) ) ;
class_desc - > add_text ( " void " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // hint
class_desc - > pop ( ) ; // color
2022-11-01 23:45:40 +01:00
return ;
2020-05-14 16:41:43 +02:00
}
2014-02-10 02:10:30 +01:00
2022-11-01 23:45:40 +01:00
bool is_enum_type = ! p_enum . is_empty ( ) ;
2023-06-15 16:06:22 +02:00
bool is_bitfield = p_is_bitfield & & is_enum_type ;
2022-11-01 23:45:40 +01:00
bool can_ref = ! p_type . contains ( " * " ) | | is_enum_type ;
2023-04-21 15:32:26 +02:00
String link_t = p_type ; // For links in metadata
2023-06-09 17:00:50 +02:00
String display_t ; // For display purposes.
2022-11-01 23:45:40 +01:00
if ( is_enum_type ) {
2023-04-21 15:32:26 +02:00
link_t = p_enum ; // The link for enums is always the full enum description
display_t = _contextualize_class_specifier ( p_enum , edited_class ) ;
} else {
display_t = _contextualize_class_specifier ( p_type , edited_class ) ;
2017-08-24 00:10:32 +02:00
}
2022-01-18 21:01:30 +01:00
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . type_color ) ;
2020-04-21 00:06:00 +02:00
bool add_array = false ;
2017-08-24 00:10:32 +02:00
if ( can_ref ) {
2023-04-21 15:32:26 +02:00
if ( link_t . ends_with ( " [] " ) ) {
2020-04-21 00:06:00 +02:00
add_array = true ;
2023-05-13 15:09:35 +02:00
link_t = link_t . trim_suffix ( " [] " ) ;
display_t = display_t . trim_suffix ( " [] " ) ;
2022-11-01 23:45:40 +01:00
2023-04-21 15:32:26 +02:00
class_desc - > push_meta ( " #Array " ) ; // class
2022-11-01 23:45:40 +01:00
class_desc - > add_text ( " Array " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // meta
2022-11-01 23:45:40 +01:00
class_desc - > add_text ( " [ " ) ;
2023-06-15 16:06:22 +02:00
} else if ( is_bitfield ) {
class_desc - > push_color ( Color ( theme_cache . type_color , 0.5 ) ) ;
class_desc - > push_hint ( TTR ( " This value is an integer composed as a bitmask of the following flags. " ) ) ;
class_desc - > add_text ( " BitField " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // hint
2023-06-15 16:06:22 +02:00
class_desc - > add_text ( " [ " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2020-04-21 00:06:00 +02:00
}
2022-11-01 23:45:40 +01:00
if ( is_enum_type ) {
2023-04-21 15:32:26 +02:00
class_desc - > push_meta ( " $ " + link_t ) ; // enum
2022-11-01 23:45:40 +01:00
} else {
2023-04-21 15:32:26 +02:00
class_desc - > push_meta ( " # " + link_t ) ; // class
2017-08-24 00:10:32 +02:00
}
}
2023-04-21 15:32:26 +02:00
class_desc - > add_text ( display_t ) ;
2020-04-21 00:06:00 +02:00
if ( can_ref ) {
2022-11-01 23:45:40 +01:00
class_desc - > pop ( ) ; // Pushed meta above.
2020-04-21 00:06:00 +02:00
if ( add_array ) {
2022-11-01 23:45:40 +01:00
class_desc - > add_text ( " ] " ) ;
2023-06-15 16:06:22 +02:00
} else if ( is_bitfield ) {
class_desc - > push_color ( Color ( theme_cache . type_color , 0.5 ) ) ;
class_desc - > add_text ( " ] " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2020-04-21 00:06:00 +02:00
}
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2014-02-10 02:10:30 +01:00
}
2023-03-31 21:17:59 +02:00
void EditorHelp : : _add_type_icon ( const String & p_type , int p_size , const String & p_fallback ) {
Ref < Texture2D > icon = EditorNode : : get_singleton ( ) - > get_class_icon ( p_type , p_fallback ) ;
2022-08-24 20:41:31 +02:00
Vector2i size = Vector2i ( icon - > get_width ( ) , icon - > get_height ( ) ) ;
if ( p_size > 0 ) {
2023-08-01 19:04:28 +02:00
// Ensures icon scales proportionally on both axes, based on icon height.
2022-08-24 20:41:31 +02:00
float ratio = p_size / float ( size . height ) ;
size . width * = ratio ;
size . height * = ratio ;
}
class_desc - > add_image ( icon , size . width , size . height ) ;
}
2018-08-21 22:12:55 +02:00
String EditorHelp : : _fix_constant ( const String & p_constant ) const {
if ( p_constant . strip_edges ( ) = = " 4294967295 " ) {
return " 0xFFFFFFFF " ;
}
if ( p_constant . strip_edges ( ) = = " 2147483647 " ) {
return " 0x7FFFFFFF " ;
}
2019-06-05 16:44:20 +02:00
2018-08-21 22:12:55 +02:00
if ( p_constant . strip_edges ( ) = = " 1048575 " ) {
2019-06-05 16:44:20 +02:00
return " 0xFFFFF " ;
2018-08-21 22:12:55 +02:00
}
return p_constant ;
}
2024-02-12 14:55:02 +01:00
// Macros for assigning the deprecated/experimental marks to class members in overview.
2023-08-13 02:33:39 +02:00
# define DEPRECATED_DOC_TAG \
2024-02-12 14:55:02 +01:00
class_desc - > push_font ( theme_cache . doc_bold_font ) ; \
2023-08-13 02:33:39 +02:00
class_desc - > push_color ( get_theme_color ( SNAME ( " error_color " ) , EditorStringName ( Editor ) ) ) ; \
Ref < Texture2D > error_icon = get_editor_theme_icon ( SNAME ( " StatusError " ) ) ; \
class_desc - > add_image ( error_icon , error_icon - > get_width ( ) , error_icon - > get_height ( ) ) ; \
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( String : : chr ( 160 ) + TTR ( " Deprecated " ) ) ; \
class_desc - > pop ( ) ; \
2022-08-28 08:17:25 +02:00
class_desc - > pop ( ) ;
# define EXPERIMENTAL_DOC_TAG \
2024-02-12 14:55:02 +01:00
class_desc - > push_font ( theme_cache . doc_bold_font ) ; \
2023-08-13 02:33:39 +02:00
class_desc - > push_color ( get_theme_color ( SNAME ( " warning_color " ) , EditorStringName ( Editor ) ) ) ; \
Ref < Texture2D > warning_icon = get_editor_theme_icon ( SNAME ( " NodeWarning " ) ) ; \
2022-08-28 08:17:25 +02:00
class_desc - > add_image ( warning_icon , warning_icon - > get_width ( ) , warning_icon - > get_height ( ) ) ; \
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( String : : chr ( 160 ) + TTR ( " Experimental " ) ) ; \
class_desc - > pop ( ) ; \
2022-08-28 08:17:25 +02:00
class_desc - > pop ( ) ;
2024-02-12 14:55:02 +01:00
// Macros for displaying the deprecated/experimental info in class member descriptions.
# define DEPRECATED_DOC_MSG(m_message, m_default_message) \
Ref < Texture2D > error_icon = get_editor_theme_icon ( SNAME ( " StatusError " ) ) ; \
class_desc - > add_image ( error_icon , error_icon - > get_width ( ) , error_icon - > get_height ( ) ) ; \
class_desc - > add_text ( " " ) ; \
class_desc - > push_color ( get_theme_color ( SNAME ( " error_color " ) , EditorStringName ( Editor ) ) ) ; \
class_desc - > push_font ( theme_cache . doc_bold_font ) ; \
class_desc - > add_text ( TTR ( " Deprecated: " ) ) ; \
class_desc - > pop ( ) ; \
class_desc - > pop ( ) ; \
class_desc - > add_text ( " " ) ; \
if ( ( m_message ) . is_empty ( ) ) { \
class_desc - > add_text ( m_default_message ) ; \
} else { \
_add_text ( m_message ) ; \
}
# define EXPERIMENTAL_DOC_MSG(m_message, m_default_message) \
Ref < Texture2D > warning_icon = get_editor_theme_icon ( SNAME ( " NodeWarning " ) ) ; \
class_desc - > add_image ( warning_icon , warning_icon - > get_width ( ) , warning_icon - > get_height ( ) ) ; \
class_desc - > add_text ( " " ) ; \
class_desc - > push_color ( get_theme_color ( SNAME ( " warning_color " ) , EditorStringName ( Editor ) ) ) ; \
class_desc - > push_font ( theme_cache . doc_bold_font ) ; \
class_desc - > add_text ( TTR ( " Experimental: " ) ) ; \
class_desc - > pop ( ) ; \
class_desc - > pop ( ) ; \
class_desc - > add_text ( " " ) ; \
if ( ( m_message ) . is_empty ( ) ) { \
class_desc - > add_text ( m_default_message ) ; \
} else { \
_add_text ( m_message ) ; \
}
2023-10-02 20:11:43 +02:00
void EditorHelp : : _add_method ( const DocData : : MethodDoc & p_method , bool p_overview , bool p_override ) {
if ( p_override ) {
method_line [ p_method . name ] = class_desc - > get_paragraph_count ( ) - 2 ; // Gets overridden if description.
}
2017-12-15 09:45:23 +01:00
2022-02-03 17:03:38 +01:00
const bool is_vararg = p_method . qualifiers . contains ( " vararg " ) ;
2017-12-15 09:45:23 +01:00
if ( p_overview ) {
class_desc - > push_cell ( ) ;
2021-11-25 03:58:47 +01:00
class_desc - > push_paragraph ( HORIZONTAL_ALIGNMENT_RIGHT , Control : : TEXT_DIRECTION_AUTO , " " ) ;
2020-05-21 11:01:31 +02:00
} else {
2021-12-01 19:02:20 +01:00
_add_bulletpoint ( ) ;
2017-12-15 09:45:23 +01:00
}
2023-06-15 16:06:22 +02:00
_add_type ( p_method . return_type , p_method . return_enum , p_method . return_is_bitfield ) ;
2017-12-15 09:45:23 +01:00
if ( p_overview ) {
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // paragraph
2023-04-21 15:32:26 +02:00
class_desc - > pop ( ) ; // cell
2017-12-15 09:45:23 +01:00
class_desc - > push_cell ( ) ;
} else {
class_desc - > add_text ( " " ) ;
}
2024-02-16 14:28:05 +01:00
const bool is_documented = p_method . is_deprecated | | p_method . is_experimental | | ! p_method . description . strip_edges ( ) . is_empty ( ) ;
if ( p_overview & & is_documented ) {
2019-04-27 21:15:07 +02:00
class_desc - > push_meta ( " @method " + p_method . name ) ;
2017-12-15 09:45:23 +01:00
}
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . headline_color ) ;
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( p_method . name ) ;
class_desc - > pop ( ) ; // color
2017-12-15 09:45:23 +01:00
2024-02-16 14:28:05 +01:00
if ( p_overview & & is_documented ) {
2023-04-21 15:32:26 +02:00
class_desc - > pop ( ) ; // meta
2017-12-15 09:45:23 +01:00
}
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( " ( " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2017-12-15 09:45:23 +01:00
for ( int j = 0 ; j < p_method . arguments . size ( ) ; j + + ) {
2024-02-16 14:28:05 +01:00
const DocData : : ArgumentDoc & argument = p_method . arguments [ j ] ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . text_color ) ;
2024-02-16 14:28:05 +01:00
2020-05-14 16:41:43 +02:00
if ( j > 0 ) {
2017-12-15 09:45:23 +01:00
class_desc - > add_text ( " , " ) ;
2020-05-14 16:41:43 +02:00
}
2019-09-20 22:40:22 +02:00
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( argument . name ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( " : " ) ;
2024-02-16 14:28:05 +01:00
_add_type ( argument . type , argument . enumeration , argument . is_bitfield ) ;
2024-02-12 14:55:02 +01:00
2024-02-16 14:28:05 +01:00
if ( ! argument . default_value . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2019-06-01 15:42:22 +02:00
class_desc - > add_text ( " = " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . value_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( _fix_constant ( argument . default_value ) ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2017-12-15 09:45:23 +01:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2017-12-15 09:45:23 +01:00
}
if ( is_vararg ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . text_color ) ;
2024-02-12 14:55:02 +01:00
if ( ! p_method . arguments . is_empty ( ) ) {
2017-12-15 09:45:23 +01:00
class_desc - > add_text ( " , " ) ;
2020-05-14 16:41:43 +02:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2017-12-15 09:45:23 +01:00
class_desc - > add_text ( " ... " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2017-12-15 09:45:23 +01:00
}
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( " ) " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2021-12-09 10:42:46 +01:00
if ( ! p_method . qualifiers . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . qualifier_color ) ;
2022-10-31 11:27:10 +01:00
PackedStringArray qualifiers = p_method . qualifiers . split_spaces ( ) ;
for ( const String & qualifier : qualifiers ) {
String hint ;
if ( qualifier = = " vararg " ) {
hint = TTR ( " This method supports a variable number of arguments. " ) ;
} else if ( qualifier = = " virtual " ) {
2022-11-01 15:29:38 +01:00
hint = TTR ( " This method is called by the engine. \n It can be overridden to customize built-in behavior. " ) ;
2022-10-31 11:27:10 +01:00
} else if ( qualifier = = " const " ) {
hint = TTR ( " This method has no side effects. \n It does not modify the object in any way. " ) ;
} else if ( qualifier = = " static " ) {
hint = TTR ( " This method does not need an instance to be called. \n It can be called directly using the class name. " ) ;
}
class_desc - > add_text ( " " ) ;
if ( ! hint . is_empty ( ) ) {
class_desc - > push_hint ( hint ) ;
class_desc - > add_text ( qualifier ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // hint
2022-10-31 11:27:10 +01:00
} else {
class_desc - > add_text ( qualifier ) ;
}
}
2017-12-15 09:45:23 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2022-08-28 08:17:25 +02:00
}
2020-05-14 16:41:43 +02:00
if ( p_overview ) {
2024-02-12 14:55:02 +01:00
if ( p_method . is_deprecated ) {
class_desc - > add_text ( " " ) ;
DEPRECATED_DOC_TAG ;
}
if ( p_method . is_experimental ) {
class_desc - > add_text ( " " ) ;
EXPERIMENTAL_DOC_TAG ;
}
2023-04-21 15:32:26 +02:00
class_desc - > pop ( ) ; // cell
2020-05-14 16:41:43 +02:00
}
2017-12-15 09:45:23 +01:00
}
2021-12-01 19:02:20 +01:00
void EditorHelp : : _add_bulletpoint ( ) {
static const char32_t prefix [ 3 ] = { 0x25CF /* filled circle */ , ' ' , 0 } ;
class_desc - > add_text ( String ( prefix ) ) ;
}
2023-02-11 17:33:38 +01:00
void EditorHelp : : _push_normal_font ( ) {
class_desc - > push_font ( theme_cache . doc_font ) ;
class_desc - > push_font_size ( theme_cache . doc_font_size ) ;
}
void EditorHelp : : _pop_normal_font ( ) {
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // font_size
class_desc - > pop ( ) ; // font
2023-02-11 17:33:38 +01:00
}
void EditorHelp : : _push_title_font ( ) {
class_desc - > push_font ( theme_cache . doc_title_font ) ;
class_desc - > push_font_size ( theme_cache . doc_title_font_size ) ;
2024-02-12 14:55:02 +01:00
class_desc - > push_color ( theme_cache . title_color ) ;
2023-02-11 17:33:38 +01:00
}
void EditorHelp : : _pop_title_font ( ) {
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
class_desc - > pop ( ) ; // font_size
class_desc - > pop ( ) ; // font
2023-02-11 17:33:38 +01:00
}
void EditorHelp : : _push_code_font ( ) {
class_desc - > push_font ( theme_cache . doc_code_font ) ;
class_desc - > push_font_size ( theme_cache . doc_code_font_size ) ;
}
void EditorHelp : : _pop_code_font ( ) {
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // font_size
class_desc - > pop ( ) ; // font
2023-02-11 17:33:38 +01:00
}
2023-04-21 15:32:26 +02:00
Error EditorHelp : : _goto_desc ( const String & p_class ) {
// If class doesn't have docs listed, attempt on-demand docgen
if ( ! doc - > class_list . has ( p_class ) & & ! _attempt_doc_load ( p_class ) ) {
2014-05-06 11:41:19 +02:00
return ERR_DOES_NOT_EXIST ;
2020-05-14 16:41:43 +02:00
}
2014-02-10 02:10:30 +01:00
2014-06-23 17:43:37 +02:00
select_locked = true ;
2014-02-10 02:10:30 +01:00
class_desc - > show ( ) ;
2017-12-18 18:46:17 +01:00
2014-02-21 03:01:44 +01:00
description_line = 0 ;
2014-02-10 02:10:30 +01:00
2020-05-14 16:41:43 +02:00
if ( p_class = = edited_class ) {
2022-04-26 18:57:36 +02:00
return OK ; // Already there.
2020-05-14 16:41:43 +02:00
}
2014-02-10 02:10:30 +01:00
2018-08-13 02:40:06 +02:00
edited_class = p_class ;
_update_doc ( ) ;
return OK ;
}
2024-02-12 14:55:02 +01:00
void EditorHelp : : _update_method_list ( MethodType p_method_type , const Vector < DocData : : MethodDoc > & p_methods ) {
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
static const char * titles_by_type [ METHOD_TYPE_MAX ] = {
TTRC ( " Methods " ) ,
TTRC ( " Constructors " ) ,
TTRC ( " Operators " ) ,
} ;
const String title = TTRGET ( titles_by_type [ p_method_type ] ) ;
section_line . push_back ( Pair < String , int > ( title , class_desc - > get_paragraph_count ( ) - 2 ) ) ;
_push_title_font ( ) ;
class_desc - > add_text ( title ) ;
_pop_title_font ( ) ;
class_desc - > add_newline ( ) ;
2021-09-21 04:49:02 +02:00
class_desc - > add_newline ( ) ;
2023-02-11 17:33:38 +01:00
2021-09-21 04:49:02 +02:00
class_desc - > push_indent ( 1 ) ;
2024-02-12 14:55:02 +01:00
_push_code_font ( ) ;
2021-09-21 04:49:02 +02:00
class_desc - > push_table ( 2 ) ;
class_desc - > set_table_column_expand ( 1 , true ) ;
bool any_previous = false ;
for ( int pass = 0 ; pass < 2 ; pass + + ) {
Vector < DocData : : MethodDoc > m ;
2024-02-16 14:28:05 +01:00
for ( const DocData : : MethodDoc & method : p_methods ) {
const String & q = method . qualifiers ;
2022-02-03 17:03:38 +01:00
if ( ( pass = = 0 & & q . contains ( " virtual " ) ) | | ( pass = = 1 & & ! q . contains ( " virtual " ) ) ) {
2024-02-16 14:28:05 +01:00
m . push_back ( method ) ;
2021-09-21 04:49:02 +02:00
}
}
if ( any_previous & & ! m . is_empty ( ) ) {
class_desc - > push_cell ( ) ;
2023-04-21 15:32:26 +02:00
class_desc - > pop ( ) ; // cell
2021-09-21 04:49:02 +02:00
class_desc - > push_cell ( ) ;
2023-04-21 15:32:26 +02:00
class_desc - > pop ( ) ; // cell
2021-09-21 04:49:02 +02:00
}
String group_prefix ;
for ( int i = 0 ; i < m . size ( ) ; i + + ) {
const String new_prefix = m [ i ] . name . substr ( 0 , 3 ) ;
bool is_new_group = false ;
if ( i < m . size ( ) - 1 & & new_prefix = = m [ i + 1 ] . name . substr ( 0 , 3 ) & & new_prefix ! = group_prefix ) {
is_new_group = i > 0 ;
group_prefix = new_prefix ;
2021-12-09 10:42:46 +01:00
} else if ( ! group_prefix . is_empty ( ) & & new_prefix ! = group_prefix ) {
2021-09-21 04:49:02 +02:00
is_new_group = true ;
group_prefix = " " ;
}
if ( is_new_group & & pass = = 1 ) {
class_desc - > push_cell ( ) ;
2023-04-21 15:32:26 +02:00
class_desc - > pop ( ) ; // cell
2021-09-21 04:49:02 +02:00
class_desc - > push_cell ( ) ;
2023-04-21 15:32:26 +02:00
class_desc - > pop ( ) ; // cell
2021-09-21 04:49:02 +02:00
}
2023-10-02 20:11:43 +02:00
// For constructors always point to the first one.
_add_method ( m [ i ] , true , ( p_method_type ! = METHOD_TYPE_CONSTRUCTOR | | i = = 0 ) ) ;
2021-09-21 04:49:02 +02:00
}
any_previous = ! m . is_empty ( ) ;
}
2023-04-21 15:32:26 +02:00
class_desc - > pop ( ) ; // table
2023-02-11 17:33:38 +01:00
_pop_code_font ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // indent
2021-09-21 04:49:02 +02:00
}
2024-02-12 14:55:02 +01:00
void EditorHelp : : _update_method_descriptions ( const DocData : : ClassDoc & p_classdoc , MethodType p_method_type , const Vector < DocData : : MethodDoc > & p_methods ) {
# define DTR_DOC(m_string) (p_classdoc.is_script_doc ? (m_string) : DTR(m_string))
2021-09-21 04:49:02 +02:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
static const char * titles_by_type [ METHOD_TYPE_MAX ] = {
TTRC ( " Method Descriptions " ) ,
TTRC ( " Constructor Descriptions " ) ,
TTRC ( " Operator Descriptions " ) ,
} ;
const String title = TTRGET ( titles_by_type [ p_method_type ] ) ;
section_line . push_back ( Pair < String , int > ( title , class_desc - > get_paragraph_count ( ) - 2 ) ) ;
_push_title_font ( ) ;
class_desc - > add_text ( title ) ;
_pop_title_font ( ) ;
String link_color_text = theme_cache . title_color . to_html ( false ) ;
2021-09-21 04:49:02 +02:00
for ( int pass = 0 ; pass < 2 ; pass + + ) {
Vector < DocData : : MethodDoc > methods_filtered ;
for ( int i = 0 ; i < p_methods . size ( ) ; i + + ) {
const String & q = p_methods [ i ] . qualifiers ;
2022-02-03 17:03:38 +01:00
if ( ( pass = = 0 & & q . contains ( " virtual " ) ) | | ( pass = = 1 & & ! q . contains ( " virtual " ) ) ) {
2021-09-21 04:49:02 +02:00
methods_filtered . push_back ( p_methods [ i ] ) ;
}
}
for ( int i = 0 ; i < methods_filtered . size ( ) ; i + + ) {
2024-02-16 14:28:05 +01:00
const DocData : : MethodDoc & method = methods_filtered [ i ] ;
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2023-02-11 17:33:38 +01:00
_push_code_font ( ) ;
2023-10-02 20:11:43 +02:00
// For constructors always point to the first one.
2024-02-16 14:28:05 +01:00
_add_method ( method , false , ( p_method_type ! = METHOD_TYPE_CONSTRUCTOR | | i = = 0 ) ) ;
2023-02-11 17:33:38 +01:00
_pop_code_font ( ) ;
2021-09-21 04:49:02 +02:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
class_desc - > push_indent ( 1 ) ;
2024-02-12 14:55:02 +01:00
_push_normal_font ( ) ;
class_desc - > push_color ( theme_cache . text_color ) ;
2024-02-16 14:28:05 +01:00
bool has_prev_text = false ;
if ( method . is_deprecated ) {
has_prev_text = true ;
2024-02-12 14:55:02 +01:00
static const char * messages_by_type [ METHOD_TYPE_MAX ] = {
TTRC ( " This method may be changed or removed in future versions. " ) ,
TTRC ( " This constructor may be changed or removed in future versions. " ) ,
TTRC ( " This operator may be changed or removed in future versions. " ) ,
} ;
2024-02-16 14:28:05 +01:00
DEPRECATED_DOC_MSG ( DTR_DOC ( method . deprecated_message ) , TTRGET ( messages_by_type [ p_method_type ] ) ) ;
2024-02-12 14:55:02 +01:00
}
2024-02-16 14:28:05 +01:00
if ( method . is_experimental ) {
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
}
has_prev_text = true ;
2024-02-12 14:55:02 +01:00
static const char * messages_by_type [ METHOD_TYPE_MAX ] = {
TTRC ( " This method may be changed or removed in future versions. " ) ,
TTRC ( " This constructor may be changed or removed in future versions. " ) ,
TTRC ( " This operator may be changed or removed in future versions. " ) ,
} ;
2024-02-16 14:28:05 +01:00
EXPERIMENTAL_DOC_MSG ( DTR_DOC ( method . experimental_message ) , TTRGET ( messages_by_type [ p_method_type ] ) ) ;
2024-02-12 14:55:02 +01:00
}
2024-02-16 14:28:05 +01:00
if ( ! method . errors_returned . is_empty ( ) ) {
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
}
has_prev_text = true ;
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( TTR ( " Error codes returned: " ) ) ;
2021-09-21 04:49:02 +02:00
class_desc - > add_newline ( ) ;
class_desc - > push_list ( 0 , RichTextLabel : : LIST_DOTS , false ) ;
2024-02-16 14:28:05 +01:00
for ( int j = 0 ; j < method . errors_returned . size ( ) ; j + + ) {
2021-09-21 04:49:02 +02:00
if ( j > 0 ) {
class_desc - > add_newline ( ) ;
}
2024-02-12 14:55:02 +01:00
2024-02-16 14:28:05 +01:00
int val = method . errors_returned [ j ] ;
2021-09-21 04:49:02 +02:00
String text = itos ( val ) ;
for ( int k = 0 ; k < CoreConstants : : get_global_constant_count ( ) ; k + + ) {
if ( CoreConstants : : get_global_constant_value ( k ) = = val & & CoreConstants : : get_global_constant_enum ( k ) = = SNAME ( " Error " ) ) {
text = CoreConstants : : get_global_constant_name ( k ) ;
break ;
}
}
2024-02-12 14:55:02 +01:00
class_desc - > push_font ( theme_cache . doc_bold_font ) ;
class_desc - > add_text ( text ) ;
class_desc - > pop ( ) ; // font
2021-09-21 04:49:02 +02:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // list
2021-09-21 04:49:02 +02:00
}
2023-09-05 17:15:34 +02:00
2024-02-16 14:28:05 +01:00
const String descr = DTR_DOC ( method . description ) . strip_edges ( ) ;
const bool is_documented = method . is_deprecated | | method . is_experimental | | ! descr . is_empty ( ) ;
2024-02-12 14:55:02 +01:00
if ( ! descr . is_empty ( ) ) {
2024-02-16 14:28:05 +01:00
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
}
has_prev_text = true ;
2024-02-12 14:55:02 +01:00
_add_text ( descr ) ;
2024-02-16 14:28:05 +01:00
} else if ( ! is_documented ) {
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
}
has_prev_text = true ;
2023-09-05 17:15:34 +02:00
String message ;
2021-09-21 04:49:02 +02:00
if ( p_classdoc . is_script_doc ) {
2023-09-05 17:15:34 +02:00
static const char * messages_by_type [ METHOD_TYPE_MAX ] = {
TTRC ( " There is currently no description for this method. " ) ,
TTRC ( " There is currently no description for this constructor. " ) ,
TTRC ( " There is currently no description for this operator. " ) ,
} ;
message = TTRGET ( messages_by_type [ p_method_type ] ) ;
2021-09-21 04:49:02 +02:00
} else {
2023-09-05 17:15:34 +02:00
static const char * messages_by_type [ METHOD_TYPE_MAX ] = {
TTRC ( " There is currently no description for this method. Please help us by [color=$color][url=$url]contributing one[/url][/color]! " ) ,
TTRC ( " There is currently no description for this constructor. Please help us by [color=$color][url=$url]contributing one[/url][/color]! " ) ,
TTRC ( " There is currently no description for this operator. Please help us by [color=$color][url=$url]contributing one[/url][/color]! " ) ,
} ;
message = TTRGET ( messages_by_type [ p_method_type ] ) . replace ( " $url " , CONTRIBUTE_URL ) . replace ( " $color " , link_color_text ) ;
2021-09-21 04:49:02 +02:00
}
2024-02-12 14:55:02 +01:00
class_desc - > add_image ( get_editor_theme_icon ( SNAME ( " Error " ) ) ) ;
class_desc - > add_text ( " " ) ;
class_desc - > push_color ( theme_cache . comment_color ) ;
2023-09-05 17:15:34 +02:00
class_desc - > append_text ( message ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2021-09-21 04:49:02 +02:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 17:33:38 +01:00
_pop_normal_font ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // indent
2021-09-21 04:49:02 +02:00
}
}
2024-02-12 14:55:02 +01:00
# undef DTR_DOC
2021-09-21 04:49:02 +02:00
}
2018-08-13 02:40:06 +02:00
void EditorHelp : : _update_doc ( ) {
2020-05-14 16:41:43 +02:00
if ( ! doc - > class_list . has ( edited_class ) ) {
2018-09-17 00:17:07 +02:00
return ;
2020-05-14 16:41:43 +02:00
}
2018-08-13 02:40:06 +02:00
2014-02-10 02:10:30 +01:00
scroll_locked = true ;
class_desc - > clear ( ) ;
method_line . clear ( ) ;
2017-09-14 02:56:37 +02:00
section_line . clear ( ) ;
2024-02-12 14:55:02 +01:00
section_line . push_back ( Pair < String , int > ( TTR ( " Top " ) , 0 ) ) ;
2014-02-10 02:10:30 +01:00
2023-02-11 16:29:44 +01:00
String link_color_text = theme_cache . title_color . to_html ( false ) ;
2014-02-10 02:10:30 +01:00
2022-01-18 21:01:30 +01:00
DocData : : ClassDoc cd = doc - > class_list [ edited_class ] ; // Make a copy, so we can sort without worrying.
2024-02-12 14:55:02 +01:00
# define DTR_DOC(m_string) (cd.is_script_doc ? (m_string) : DTR(m_string))
2018-09-12 17:12:23 +02:00
// Class name
2024-02-12 14:55:02 +01:00
2023-02-11 17:33:38 +01:00
_push_title_font ( ) ;
2024-02-12 14:55:02 +01:00
2016-05-19 00:08:12 +02:00
class_desc - > add_text ( TTR ( " Class: " ) + " " ) ;
2023-03-31 21:17:59 +02:00
_add_type_icon ( edited_class , theme_cache . doc_title_font_size , " Object " ) ;
2022-04-24 18:55:51 +02:00
class_desc - > add_text ( " " ) ;
2024-02-12 14:55:02 +01:00
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . headline_color ) ;
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( edited_class ) ;
2022-06-29 06:57:16 +02:00
class_desc - > pop ( ) ; // color
2024-02-12 14:55:02 +01:00
2023-02-11 17:33:38 +01:00
_pop_title_font ( ) ;
2022-08-28 08:17:25 +02:00
if ( cd . is_deprecated ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
DEPRECATED_DOC_MSG ( DTR_DOC ( cd . deprecated_message ) , TTR ( " This class may be changed or removed in future versions. " ) ) ;
2022-08-28 08:17:25 +02:00
}
2024-02-12 14:55:02 +01:00
2022-08-28 08:17:25 +02:00
if ( cd . is_experimental ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
EXPERIMENTAL_DOC_MSG ( DTR_DOC ( cd . experimental_message ) , TTR ( " This class may be changed or removed in future versions. " ) ) ;
2022-08-28 08:17:25 +02:00
}
2022-09-02 15:56:28 +02:00
2018-09-12 17:12:23 +02:00
// Inheritance tree
2024-02-12 14:55:02 +01:00
const String non_breaking_space = String : : chr ( 160 ) ;
2018-09-12 17:12:23 +02:00
// Ascendents
2021-12-09 10:42:46 +01:00
if ( ! cd . inherits . is_empty ( ) ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
2023-02-11 17:33:38 +01:00
_push_normal_font ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > push_color ( theme_cache . title_color ) ;
2016-05-19 00:08:12 +02:00
class_desc - > add_text ( TTR ( " Inherits: " ) + " " ) ;
2016-03-05 16:28:25 +01:00
String inherits = cd . inherits ;
2021-12-09 10:42:46 +01:00
while ( ! inherits . is_empty ( ) ) {
2023-03-31 21:17:59 +02:00
_add_type_icon ( inherits , theme_cache . doc_font_size , " ArrowRight " ) ;
2022-09-02 15:56:28 +02:00
class_desc - > add_text ( non_breaking_space ) ; // Otherwise icon borrows hyperlink from _add_type().
2016-03-05 16:28:25 +01:00
_add_type ( inherits ) ;
inherits = doc - > class_list [ inherits ] . inherits ;
2021-12-09 10:42:46 +01:00
if ( ! inherits . is_empty ( ) ) {
2017-10-09 18:59:53 +02:00
class_desc - > add_text ( " < " ) ;
2016-03-05 16:28:25 +01:00
}
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 17:33:38 +01:00
_pop_normal_font ( ) ;
2016-03-05 16:28:25 +01:00
}
2023-08-16 14:00:59 +02:00
// Descendants
if ( ( cd . is_script_doc | | ClassDB : : class_exists ( cd . name ) ) & & doc - > inheriting . has ( cd . name ) ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
2023-02-11 17:33:38 +01:00
_push_normal_font ( ) ;
2023-08-16 14:00:59 +02:00
class_desc - > push_color ( theme_cache . title_color ) ;
class_desc - > add_text ( TTR ( " Inherited by: " ) + " " ) ;
2016-03-05 16:28:25 +01:00
2023-08-16 14:00:59 +02:00
for ( RBSet < String , NaturalNoCaseComparator > : : Element * itr = doc - > inheriting [ cd . name ] . front ( ) ; itr ; itr = itr - > next ( ) ) {
if ( itr - > prev ( ) ) {
class_desc - > add_text ( " , " ) ;
2016-03-05 16:28:25 +01:00
}
2023-08-16 14:00:59 +02:00
_add_type_icon ( itr - > get ( ) , theme_cache . doc_font_size , " ArrowRight " ) ;
class_desc - > add_text ( non_breaking_space ) ; // Otherwise icon borrows hyperlink from _add_type().
_add_type ( itr - > get ( ) ) ;
2016-03-05 16:28:25 +01:00
}
2014-02-10 02:10:30 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
_pop_normal_font ( ) ;
2022-08-28 08:17:25 +02:00
}
2022-07-19 17:17:04 +02:00
bool has_description = false ;
2018-09-12 17:12:23 +02:00
// Brief description
2024-02-12 14:55:02 +01:00
const String brief_class_descr = DTR_DOC ( cd . brief_description ) . strip_edges ( ) ;
if ( ! brief_class_descr . is_empty ( ) ) {
2022-07-19 17:17:04 +02:00
has_description = true ;
2020-01-14 21:38:54 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > push_indent ( 1 ) ;
class_desc - > push_font ( theme_cache . doc_bold_font ) ;
class_desc - > push_color ( theme_cache . text_color ) ;
_add_text ( brief_class_descr ) ;
class_desc - > pop ( ) ; // color
class_desc - > pop ( ) ; // font
class_desc - > pop ( ) ; // indent
2020-01-14 21:38:54 +01:00
}
// Class description
2024-02-12 14:55:02 +01:00
const String class_descr = DTR_DOC ( cd . description ) . strip_edges ( ) ;
if ( ! class_descr . is_empty ( ) ) {
2022-07-19 17:17:04 +02:00
has_description = true ;
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2022-05-18 09:17:55 +02:00
section_line . push_back ( Pair < String , int > ( TTR ( " Description " ) , class_desc - > get_paragraph_count ( ) - 2 ) ) ;
description_line = class_desc - > get_paragraph_count ( ) - 2 ;
2023-02-11 17:33:38 +01:00
_push_title_font ( ) ;
2020-01-14 21:38:54 +01:00
class_desc - > add_text ( TTR ( " Description " ) ) ;
2023-02-11 17:33:38 +01:00
_pop_title_font ( ) ;
2014-02-10 02:10:30 +01:00
2019-06-20 12:42:25 +02:00
class_desc - > add_newline ( ) ;
2014-02-10 02:10:30 +01:00
class_desc - > add_newline ( ) ;
2024-02-12 14:55:02 +01:00
2015-10-20 17:41:27 +02:00
class_desc - > push_indent ( 1 ) ;
2024-02-12 14:55:02 +01:00
_push_normal_font ( ) ;
class_desc - > push_color ( theme_cache . text_color ) ;
_add_text ( class_descr ) ;
class_desc - > pop ( ) ; // color
2023-02-11 17:33:38 +01:00
_pop_normal_font ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // indent
}
2023-02-11 17:33:38 +01:00
2024-02-12 14:55:02 +01:00
if ( ! has_description ) {
2020-01-14 21:38:54 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > push_indent ( 1 ) ;
_push_normal_font ( ) ;
2023-08-13 02:33:39 +02:00
class_desc - > add_image ( get_editor_theme_icon ( SNAME ( " Error " ) ) ) ;
2022-07-19 17:17:04 +02:00
class_desc - > add_text ( " " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > push_color ( theme_cache . comment_color ) ;
2022-07-19 17:17:04 +02:00
if ( cd . is_script_doc ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( TTR ( " There is currently no description for this class. " ) ) ;
2022-07-19 17:17:04 +02:00
} else {
class_desc - > append_text ( TTR ( " There is currently no description for this class. Please help us by [color=$color][url=$url]contributing one[/url][/color]! " ) . replace ( " $url " , CONTRIBUTE_URL ) . replace ( " $color " , link_color_text ) ) ;
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2022-07-19 17:17:04 +02:00
2024-02-12 14:55:02 +01:00
_pop_normal_font ( ) ;
class_desc - > pop ( ) ; // indent
2023-07-08 13:17:41 +02:00
}
# ifdef MODULE_MONO_ENABLED
if ( classes_with_csharp_differences . has ( cd . name ) ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2023-07-08 13:17:41 +02:00
const String & csharp_differences_url = vformat ( " %s/tutorials/scripting/c_sharp/c_sharp_differences.html " , VERSION_DOCS_URL ) ;
class_desc - > push_indent ( 1 ) ;
2024-02-12 14:55:02 +01:00
_push_normal_font ( ) ;
class_desc - > push_color ( theme_cache . text_color ) ;
2023-07-08 13:17:41 +02:00
2024-02-12 14:55:02 +01:00
class_desc - > append_text ( " [b] " + TTR ( " Note: " ) + " [/b] " + vformat ( TTR ( " There are notable differences when using this API with C#. See [url=%s]C# API differences to GDScript[/url] for more information. " ) , csharp_differences_url ) ) ;
class_desc - > pop ( ) ; // color
_pop_normal_font ( ) ;
class_desc - > pop ( ) ; // indent
2022-07-19 17:17:04 +02:00
}
2023-07-08 13:17:41 +02:00
# endif
2022-07-19 17:17:04 +02:00
2020-01-14 21:38:54 +01:00
// Online tutorials
2024-02-12 14:55:02 +01:00
if ( ! cd . tutorials . is_empty ( ) ) {
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2023-02-11 17:33:38 +01:00
_push_title_font ( ) ;
2020-01-14 21:38:54 +01:00
class_desc - > add_text ( TTR ( " Online Tutorials " ) ) ;
2023-02-11 17:33:38 +01:00
_pop_title_font ( ) ;
2020-01-14 21:38:54 +01:00
2014-02-10 02:10:30 +01:00
class_desc - > add_newline ( ) ;
2020-01-14 21:38:54 +01:00
2023-02-11 17:33:38 +01:00
class_desc - > push_indent ( 1 ) ;
_push_code_font ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2023-02-11 17:33:38 +01:00
2024-02-16 14:28:05 +01:00
for ( const DocData : : TutorialDoc & tutorial : cd . tutorials ) {
const String link = DTR_DOC ( tutorial . link ) . strip_edges ( ) ;
2024-02-12 14:55:02 +01:00
2024-02-16 14:28:05 +01:00
String link_text = DTR_DOC ( tutorial . title ) . strip_edges ( ) ;
2024-02-12 14:55:02 +01:00
if ( link_text . is_empty ( ) ) {
const int sep_pos = link . find ( " // " ) ;
if ( sep_pos > = 0 ) {
link_text = link . substr ( sep_pos + 2 ) ;
} else {
link_text = link ;
}
2020-01-14 21:38:54 +01:00
}
2020-01-27 00:58:53 +01:00
class_desc - > add_newline ( ) ;
2024-02-12 14:55:02 +01:00
_add_bulletpoint ( ) ;
class_desc - > append_text ( " [url= " + link + " ] " + link_text + " [/url] " ) ;
2020-01-14 21:38:54 +01:00
}
2020-01-27 00:58:53 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 17:33:38 +01:00
_pop_code_font ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // indent
2014-02-10 02:10:30 +01:00
}
2018-09-12 17:12:23 +02:00
// Properties overview
2022-05-19 17:00:06 +02:00
HashSet < String > skip_methods ;
2017-01-04 05:16:14 +01:00
2023-05-13 11:57:44 +02:00
bool has_properties = false ;
bool has_property_descriptions = false ;
for ( const DocData : : PropertyDoc & prop : cd . properties ) {
2024-02-16 14:28:05 +01:00
const bool is_documented = prop . is_deprecated | | prop . is_experimental | | ! prop . description . strip_edges ( ) . is_empty ( ) ;
if ( ! is_documented & & prop . name . begins_with ( " _ " ) ) {
2023-05-13 11:57:44 +02:00
continue ;
}
has_properties = true ;
if ( ! prop . overridden ) {
has_property_descriptions = true ;
2020-11-29 03:37:57 +01:00
break ;
}
}
if ( has_properties ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2022-05-18 09:17:55 +02:00
section_line . push_back ( Pair < String , int > ( TTR ( " Properties " ) , class_desc - > get_paragraph_count ( ) - 2 ) ) ;
2023-02-11 17:33:38 +01:00
_push_title_font ( ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( TTR ( " Properties " ) ) ;
2023-02-11 17:33:38 +01:00
_pop_title_font ( ) ;
2017-01-04 05:16:14 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
2019-06-20 12:42:25 +02:00
class_desc - > add_newline ( ) ;
2023-02-11 17:33:38 +01:00
2017-01-04 05:16:14 +01:00
class_desc - > push_indent ( 1 ) ;
2024-02-12 14:55:02 +01:00
_push_code_font ( ) ;
2021-12-02 20:38:49 +01:00
class_desc - > push_table ( 4 ) ;
2020-05-14 11:00:19 +02:00
class_desc - > set_table_column_expand ( 1 , true ) ;
2017-01-04 05:16:14 +01:00
2024-01-16 16:54:45 +01:00
cd . properties . sort_custom < PropertyCompare > ( ) ;
bool is_generating_overridden_properties = true ; // Set to false as soon as we encounter a non-overridden property.
bool overridden_property_exists = false ;
2024-02-16 14:28:05 +01:00
for ( const DocData : : PropertyDoc & prop : cd . properties ) {
2020-11-29 03:37:57 +01:00
// Ignore undocumented private.
2024-02-16 14:28:05 +01:00
const bool is_documented = prop . is_deprecated | | prop . is_experimental | | ! prop . description . strip_edges ( ) . is_empty ( ) ;
if ( ! is_documented & & prop . name . begins_with ( " _ " ) ) {
2020-11-29 03:37:57 +01:00
continue ;
}
2024-02-12 14:55:02 +01:00
2024-02-16 14:28:05 +01:00
if ( is_generating_overridden_properties & & ! prop . overridden ) {
2024-01-16 16:54:45 +01:00
is_generating_overridden_properties = false ;
// No need for the extra spacing when there's no overridden property.
if ( overridden_property_exists ) {
class_desc - > push_cell ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // cell
2024-01-16 16:54:45 +01:00
class_desc - > push_cell ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // cell
2024-01-16 16:54:45 +01:00
class_desc - > push_cell ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // cell
2024-01-16 16:54:45 +01:00
class_desc - > push_cell ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // cell
2024-01-16 16:54:45 +01:00
}
}
2024-02-12 14:55:02 +01:00
2024-02-16 14:28:05 +01:00
property_line [ prop . name ] = class_desc - > get_paragraph_count ( ) - 2 ; // Gets overridden if description.
2017-01-04 05:16:14 +01:00
2021-12-02 20:38:49 +01:00
// Property type.
2017-01-04 05:16:14 +01:00
class_desc - > push_cell ( ) ;
2021-11-25 03:58:47 +01:00
class_desc - > push_paragraph ( HORIZONTAL_ALIGNMENT_RIGHT , Control : : TEXT_DIRECTION_AUTO , " " ) ;
2024-02-16 14:28:05 +01:00
_add_type ( prop . type , prop . enumeration , prop . is_bitfield ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // paragraph
2021-12-02 20:38:49 +01:00
class_desc - > pop ( ) ; // cell
2017-01-04 05:16:14 +01:00
bool describe = false ;
2024-02-16 14:28:05 +01:00
if ( ! prop . setter . is_empty ( ) ) {
skip_methods . insert ( prop . setter ) ;
2017-01-04 05:16:14 +01:00
describe = true ;
}
2024-02-16 14:28:05 +01:00
if ( ! prop . getter . is_empty ( ) ) {
skip_methods . insert ( prop . getter ) ;
2017-01-04 05:16:14 +01:00
describe = true ;
}
2024-02-16 14:28:05 +01:00
if ( is_documented ) {
2017-01-04 05:16:14 +01:00
describe = true ;
}
2019-06-01 15:42:22 +02:00
2024-02-16 14:28:05 +01:00
if ( prop . overridden ) {
2019-09-03 12:42:34 +02:00
describe = false ;
}
2021-12-02 20:38:49 +01:00
// Property name.
2017-01-04 05:16:14 +01:00
class_desc - > push_cell ( ) ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . headline_color ) ;
2019-06-01 15:42:22 +02:00
2017-01-04 05:16:14 +01:00
if ( describe ) {
2024-02-16 14:28:05 +01:00
class_desc - > push_meta ( " @member " + prop . name ) ;
2017-01-04 05:16:14 +01:00
}
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( prop . name ) ;
2017-01-04 05:16:14 +01:00
if ( describe ) {
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // meta
2017-01-04 05:16:14 +01:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2021-12-02 20:38:49 +01:00
class_desc - > pop ( ) ; // cell
// Property value.
class_desc - > push_cell ( ) ;
2024-02-16 14:28:05 +01:00
if ( ! prop . default_value . is_empty ( ) ) {
if ( prop . overridden ) {
2024-01-16 16:54:45 +01:00
class_desc - > push_color ( theme_cache . override_color ) ;
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( " [ " ) ;
2024-02-16 14:28:05 +01:00
const String link = vformat ( " [url=@member %s.%s]%s[/url] " , prop . overrides , prop . name , prop . overrides ) ;
2024-02-12 14:55:02 +01:00
class_desc - > append_text ( vformat ( TTR ( " overrides %s: " ) , link ) ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( " " + _fix_constant ( prop . default_value ) + " ] " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2024-01-16 16:54:45 +01:00
overridden_property_exists = true ;
2021-12-02 20:38:49 +01:00
} else {
2024-01-16 16:54:45 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( " [ " + TTR ( " default: " ) + " " ) ;
class_desc - > pop ( ) ; // color
2021-12-02 20:38:49 +01:00
2024-01-16 16:54:45 +01:00
class_desc - > push_color ( theme_cache . value_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( _fix_constant ( prop . default_value ) ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2021-12-02 20:38:49 +01:00
2024-01-16 16:54:45 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
class_desc - > add_text ( " ] " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2024-01-16 16:54:45 +01:00
}
2022-08-28 08:17:25 +02:00
}
2023-07-02 12:13:38 +02:00
2021-12-02 20:38:49 +01:00
class_desc - > pop ( ) ; // cell
2024-02-12 14:55:02 +01:00
// Property setter/getter and deprecated/experimental marks.
2021-12-02 20:38:49 +01:00
class_desc - > push_cell ( ) ;
2024-02-12 14:55:02 +01:00
bool has_prev_text = false ;
2021-12-02 20:38:49 +01:00
2024-02-16 14:28:05 +01:00
if ( cd . is_script_doc & & ( ! prop . setter . is_empty ( ) | | ! prop . getter . is_empty ( ) ) ) {
2024-02-12 14:55:02 +01:00
has_prev_text = true ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( " [ " + TTR ( " property: " ) + " " ) ;
2020-11-29 03:37:57 +01:00
class_desc - > pop ( ) ; // color
2024-02-16 14:28:05 +01:00
if ( ! prop . setter . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . value_color ) ;
2020-11-29 03:37:57 +01:00
class_desc - > add_text ( " setter " ) ;
class_desc - > pop ( ) ; // color
}
2024-02-16 14:28:05 +01:00
if ( ! prop . getter . is_empty ( ) ) {
if ( ! prop . setter . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2020-11-29 03:37:57 +01:00
class_desc - > add_text ( " , " ) ;
class_desc - > pop ( ) ; // color
}
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . value_color ) ;
2020-11-29 03:37:57 +01:00
class_desc - > add_text ( " getter " ) ;
class_desc - > pop ( ) ; // color
}
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2020-11-29 03:37:57 +01:00
class_desc - > add_text ( " ] " ) ;
class_desc - > pop ( ) ; // color
}
2024-02-16 14:28:05 +01:00
if ( prop . is_deprecated ) {
2024-02-12 14:55:02 +01:00
if ( has_prev_text ) {
class_desc - > add_text ( " " ) ;
}
has_prev_text = true ;
DEPRECATED_DOC_TAG ;
}
2024-02-16 14:28:05 +01:00
if ( prop . is_experimental ) {
2024-02-12 14:55:02 +01:00
if ( has_prev_text ) {
class_desc - > add_text ( " " ) ;
}
has_prev_text = true ;
EXPERIMENTAL_DOC_TAG ;
}
2021-12-02 20:38:49 +01:00
class_desc - > pop ( ) ; // cell
2017-01-04 05:16:14 +01:00
}
2021-12-02 20:38:49 +01:00
class_desc - > pop ( ) ; // table
2023-02-11 17:33:38 +01:00
_pop_code_font ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // indent
2017-01-04 05:16:14 +01:00
}
2018-09-12 17:12:23 +02:00
// Methods overview
2022-10-18 16:43:37 +02:00
bool sort_methods = EDITOR_GET ( " text_editor/help/sort_functions_alphabetically " ) ;
2016-05-29 16:37:26 +02:00
2017-01-04 05:16:14 +01:00
Vector < DocData : : MethodDoc > methods ;
2014-02-10 02:10:30 +01:00
2024-02-16 14:28:05 +01:00
for ( const DocData : : MethodDoc & method : cd . methods ) {
if ( skip_methods . has ( method . name ) ) {
if ( method . arguments . is_empty ( ) /* getter */ | | ( method . arguments . size ( ) = = 1 & & method . return_type = = " void " /* setter */ ) ) {
2020-01-17 10:40:59 +01:00
continue ;
}
}
2021-08-23 19:53:27 +02:00
// Ignore undocumented non virtual private.
2024-02-16 14:28:05 +01:00
const bool is_documented = method . is_deprecated | | method . is_experimental | | ! method . description . strip_edges ( ) . is_empty ( ) ;
if ( ! is_documented & & method . name . begins_with ( " _ " ) & & ! method . qualifiers . contains ( " virtual " ) ) {
2020-11-29 03:37:57 +01:00
continue ;
}
2024-02-16 14:28:05 +01:00
methods . push_back ( method ) ;
2017-01-04 05:16:14 +01:00
}
2021-09-21 04:49:02 +02:00
if ( ! cd . constructors . is_empty ( ) ) {
2020-05-14 16:41:43 +02:00
if ( sort_methods ) {
2021-09-21 04:49:02 +02:00
cd . constructors . sort ( ) ;
2020-05-14 16:41:43 +02:00
}
2024-02-12 14:55:02 +01:00
_update_method_list ( METHOD_TYPE_CONSTRUCTOR , cd . constructors ) ;
2021-09-21 04:49:02 +02:00
}
if ( ! methods . is_empty ( ) ) {
if ( sort_methods ) {
methods . sort ( ) ;
}
2024-02-12 14:55:02 +01:00
_update_method_list ( METHOD_TYPE_METHOD , methods ) ;
2021-09-21 04:49:02 +02:00
}
2016-09-08 00:39:02 +02:00
2021-09-21 04:49:02 +02:00
if ( ! cd . operators . is_empty ( ) ) {
if ( sort_methods ) {
cd . operators . sort ( ) ;
2014-02-10 02:10:30 +01:00
}
2024-02-12 14:55:02 +01:00
_update_method_list ( METHOD_TYPE_OPERATOR , cd . operators ) ;
2014-02-10 02:10:30 +01:00
}
2018-09-12 17:12:23 +02:00
// Theme properties
2021-09-21 04:49:02 +02:00
if ( ! cd . theme_properties . is_empty ( ) ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2022-05-18 09:17:55 +02:00
section_line . push_back ( Pair < String , int > ( TTR ( " Theme Properties " ) , class_desc - > get_paragraph_count ( ) - 2 ) ) ;
2023-02-11 17:33:38 +01:00
_push_title_font ( ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( TTR ( " Theme Properties " ) ) ;
2023-02-11 17:33:38 +01:00
_pop_title_font ( ) ;
2014-06-30 03:41:02 +02:00
2021-12-01 19:02:20 +01:00
String theme_data_type ;
2022-05-13 15:04:37 +02:00
HashMap < String , String > data_type_names ;
2021-12-01 19:02:20 +01:00
data_type_names [ " color " ] = TTR ( " Colors " ) ;
data_type_names [ " constant " ] = TTR ( " Constants " ) ;
data_type_names [ " font " ] = TTR ( " Fonts " ) ;
data_type_names [ " font_size " ] = TTR ( " Font Sizes " ) ;
data_type_names [ " icon " ] = TTR ( " Icons " ) ;
data_type_names [ " style " ] = TTR ( " Styles " ) ;
2014-06-30 03:41:02 +02:00
2024-02-16 14:28:05 +01:00
for ( const DocData : : ThemeItemDoc & theme_item : cd . theme_properties ) {
if ( theme_data_type ! = theme_item . data_type ) {
theme_data_type = theme_item . data_type ;
2021-12-01 19:02:20 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
class_desc - > push_indent ( 1 ) ;
2023-02-11 17:33:38 +01:00
_push_title_font ( ) ;
2024-02-12 14:55:02 +01:00
2021-12-01 19:02:20 +01:00
if ( data_type_names . has ( theme_data_type ) ) {
class_desc - > add_text ( data_type_names [ theme_data_type ] ) ;
} else {
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( theme_data_type ) ;
2021-12-01 19:02:20 +01:00
}
2024-02-12 14:55:02 +01:00
_pop_title_font ( ) ;
class_desc - > pop ( ) ; // indent
2021-12-01 19:02:20 +01:00
}
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2024-02-16 14:28:05 +01:00
theme_property_line [ theme_item . name ] = class_desc - > get_paragraph_count ( ) - 2 ; // Gets overridden if description.
2024-02-12 14:55:02 +01:00
class_desc - > push_indent ( 1 ) ;
2021-12-01 19:02:20 +01:00
// Theme item header.
2023-02-11 17:33:38 +01:00
_push_code_font ( ) ;
2021-12-01 19:02:20 +01:00
_add_bulletpoint ( ) ;
// Theme item object type.
2024-02-16 14:28:05 +01:00
_add_type ( theme_item . type ) ;
2017-09-14 02:56:37 +02:00
2021-12-01 19:02:20 +01:00
// Theme item name.
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . headline_color ) ;
2021-12-01 19:02:20 +01:00
class_desc - > add_text ( " " ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( theme_item . name ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2019-06-01 15:42:22 +02:00
2021-12-01 19:02:20 +01:00
// Theme item default value.
2024-02-16 14:28:05 +01:00
if ( ! theme_item . default_value . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2020-01-16 23:47:18 +01:00
class_desc - > add_text ( " [ " + TTR ( " default: " ) + " " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . value_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( _fix_constant ( theme_item . default_value ) ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2019-06-01 15:42:22 +02:00
class_desc - > add_text ( " ] " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2019-06-01 15:42:22 +02:00
}
2023-02-11 17:33:38 +01:00
_pop_code_font ( ) ;
2014-02-10 02:10:30 +01:00
2021-12-01 19:02:20 +01:00
// Theme item description.
2024-02-12 14:55:02 +01:00
class_desc - > push_indent ( 1 ) ;
_push_normal_font ( ) ;
class_desc - > push_color ( theme_cache . comment_color ) ;
2024-02-16 14:28:05 +01:00
const String descr = DTR_DOC ( theme_item . description ) . strip_edges ( ) ;
2024-02-12 14:55:02 +01:00
if ( ! descr . is_empty ( ) ) {
_add_text ( descr ) ;
} else {
class_desc - > add_image ( get_editor_theme_icon ( SNAME ( " Error " ) ) ) ;
class_desc - > add_text ( " " ) ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . comment_color ) ;
2024-02-12 14:55:02 +01:00
if ( cd . is_script_doc ) {
class_desc - > add_text ( TTR ( " There is currently no description for this theme property. " ) ) ;
} else {
class_desc - > append_text ( TTR ( " There is currently no description for this theme property. Please help us by [color=$color][url=$url]contributing one[/url][/color]! " ) . replace ( " $url " , CONTRIBUTE_URL ) . replace ( " $color " , link_color_text ) ) ;
}
2021-12-01 19:02:20 +01:00
class_desc - > pop ( ) ; // color
2014-06-30 03:41:02 +02:00
}
2021-12-01 19:02:20 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
_pop_normal_font ( ) ;
class_desc - > pop ( ) ; // indent
2014-06-30 03:41:02 +02:00
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // indent
}
2014-06-30 03:41:02 +02:00
}
2016-08-01 10:30:09 +02:00
2018-09-12 17:12:23 +02:00
// Signals
2021-09-21 04:49:02 +02:00
if ( ! cd . signals . is_empty ( ) ) {
2016-05-29 16:37:26 +02:00
if ( sort_methods ) {
cd . signals . sort ( ) ;
}
2017-09-14 02:56:37 +02:00
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2022-05-18 09:17:55 +02:00
section_line . push_back ( Pair < String , int > ( TTR ( " Signals " ) , class_desc - > get_paragraph_count ( ) - 2 ) ) ;
2023-02-11 17:33:38 +01:00
_push_title_font ( ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( TTR ( " Signals " ) ) ;
2023-02-11 17:33:38 +01:00
_pop_title_font ( ) ;
2014-02-10 02:10:30 +01:00
2024-02-16 14:28:05 +01:00
for ( const DocData : : MethodDoc & signal : cd . signals ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2024-02-16 14:28:05 +01:00
signal_line [ signal . name ] = class_desc - > get_paragraph_count ( ) - 2 ; // Gets overridden if description.
2021-12-01 19:02:20 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > push_indent ( 1 ) ;
// Signal header.
2023-02-11 17:33:38 +01:00
_push_code_font ( ) ;
2021-12-01 19:02:20 +01:00
_add_bulletpoint ( ) ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . headline_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( signal . name ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( " ( " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2024-02-16 14:28:05 +01:00
for ( int j = 0 ; j < signal . arguments . size ( ) ; j + + ) {
const DocData : : ArgumentDoc & argument = signal . arguments [ j ] ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . text_color ) ;
2024-02-12 14:55:02 +01:00
2020-05-14 16:41:43 +02:00
if ( j > 0 ) {
2014-02-10 02:10:30 +01:00
class_desc - > add_text ( " , " ) ;
2020-05-14 16:41:43 +02:00
}
2019-09-20 22:40:22 +02:00
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( argument . name ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( " : " ) ;
2024-02-16 14:28:05 +01:00
_add_type ( argument . type , argument . enumeration , argument . is_bitfield ) ;
2024-02-12 14:55:02 +01:00
// Signals currently do not support default argument values, neither the core nor GDScript.
// This code is just for completeness.
2024-02-16 14:28:05 +01:00
if ( ! argument . default_value . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2019-06-01 15:42:22 +02:00
class_desc - > add_text ( " = " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
class_desc - > push_color ( theme_cache . value_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( _fix_constant ( argument . default_value ) ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2014-02-10 02:10:30 +01:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2014-02-10 02:10:30 +01:00
}
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( " ) " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
_pop_code_font ( ) ;
class_desc - > add_newline ( ) ;
// Signal description.
class_desc - > push_indent ( 1 ) ;
_push_normal_font ( ) ;
class_desc - > push_color ( theme_cache . comment_color ) ;
2024-02-16 14:28:05 +01:00
const String descr = DTR_DOC ( signal . description ) . strip_edges ( ) ;
2024-02-12 14:55:02 +01:00
const bool is_multiline = descr . find_char ( ' \n ' ) > 0 ;
2024-02-16 14:28:05 +01:00
bool has_prev_text = false ;
2022-08-28 08:17:25 +02:00
2024-02-16 14:28:05 +01:00
if ( signal . is_deprecated ) {
has_prev_text = true ;
DEPRECATED_DOC_MSG ( DTR_DOC ( signal . deprecated_message ) , TTR ( " This signal may be changed or removed in future versions. " ) ) ;
2022-08-28 08:17:25 +02:00
}
2023-07-02 12:13:38 +02:00
2024-02-16 14:28:05 +01:00
if ( signal . is_experimental ) {
if ( has_prev_text ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
2024-02-16 14:28:05 +01:00
if ( is_multiline ) {
class_desc - > add_newline ( ) ;
}
2024-02-12 14:55:02 +01:00
}
2024-02-16 14:28:05 +01:00
has_prev_text = true ;
EXPERIMENTAL_DOC_MSG ( DTR_DOC ( signal . experimental_message ) , TTR ( " This signal may be changed or removed in future versions. " ) ) ;
2022-08-28 08:17:25 +02:00
}
2024-02-12 14:55:02 +01:00
if ( ! descr . is_empty ( ) ) {
2024-02-16 14:28:05 +01:00
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
if ( is_multiline ) {
class_desc - > add_newline ( ) ;
}
}
has_prev_text = true ;
2024-02-12 14:55:02 +01:00
_add_text ( descr ) ;
2024-02-16 14:28:05 +01:00
} else if ( ! has_prev_text ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_image ( get_editor_theme_icon ( SNAME ( " Error " ) ) ) ;
class_desc - > add_text ( " " ) ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . comment_color ) ;
2024-02-12 14:55:02 +01:00
if ( cd . is_script_doc ) {
class_desc - > add_text ( TTR ( " There is currently no description for this signal. " ) ) ;
} else {
class_desc - > append_text ( TTR ( " There is currently no description for this signal. Please help us by [color=$color][url=$url]contributing one[/url][/color]! " ) . replace ( " $url " , CONTRIBUTE_URL ) . replace ( " $color " , link_color_text ) ) ;
}
2023-02-11 17:33:38 +01:00
class_desc - > pop ( ) ; // color
2014-02-10 02:10:30 +01:00
}
2023-02-11 17:33:38 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
_pop_normal_font ( ) ;
class_desc - > pop ( ) ; // indent
2014-02-10 02:10:30 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // indent
}
2014-02-10 02:10:30 +01:00
}
2018-09-12 17:12:23 +02:00
// Constants and enums
2021-09-21 04:49:02 +02:00
if ( ! cd . constants . is_empty ( ) ) {
2022-05-13 15:04:37 +02:00
HashMap < String , Vector < DocData : : ConstantDoc > > enums ;
2017-08-24 00:10:32 +02:00
Vector < DocData : : ConstantDoc > constants ;
2014-02-10 02:10:30 +01:00
2024-02-16 14:28:05 +01:00
for ( const DocData : : ConstantDoc & constant : cd . constants ) {
if ( ! constant . enumeration . is_empty ( ) ) {
if ( ! enums . has ( constant . enumeration ) ) {
enums [ constant . enumeration ] = Vector < DocData : : ConstantDoc > ( ) ;
2017-08-24 00:10:32 +02:00
}
2024-02-16 14:28:05 +01:00
enums [ constant . enumeration ] . push_back ( constant ) ;
2017-08-24 00:10:32 +02:00
} else {
2020-11-29 03:37:57 +01:00
// Ignore undocumented private.
2024-02-16 14:28:05 +01:00
const bool is_documented = constant . is_deprecated | | constant . is_experimental | | ! constant . description . strip_edges ( ) . is_empty ( ) ;
if ( ! is_documented & & constant . name . begins_with ( " _ " ) ) {
2020-11-29 03:37:57 +01:00
continue ;
}
2024-02-16 14:28:05 +01:00
constants . push_back ( constant ) ;
2017-08-24 00:10:32 +02:00
}
}
2018-09-12 17:12:23 +02:00
// Enums
2023-11-03 04:36:04 +01:00
bool has_enums = enums . size ( ) & & ! cd . is_script_doc ;
if ( enums . size ( ) & & ! has_enums ) {
for ( KeyValue < String , DocData : : EnumDoc > & E : cd . enums ) {
2024-02-16 14:28:05 +01:00
const bool is_documented = E . value . is_deprecated | | E . value . is_experimental | | ! E . value . description . strip_edges ( ) . is_empty ( ) ;
if ( ! is_documented & & E . key . begins_with ( " _ " ) ) {
2023-11-03 04:36:04 +01:00
continue ;
}
has_enums = true ;
break ;
}
}
if ( has_enums ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2022-05-18 09:17:55 +02:00
section_line . push_back ( Pair < String , int > ( TTR ( " Enumerations " ) , class_desc - > get_paragraph_count ( ) - 2 ) ) ;
2023-02-11 17:33:38 +01:00
_push_title_font ( ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( TTR ( " Enumerations " ) ) ;
2023-02-11 17:33:38 +01:00
_pop_title_font ( ) ;
2017-08-24 00:10:32 +02:00
2021-08-09 22:13:42 +02:00
for ( KeyValue < String , Vector < DocData : : ConstantDoc > > & E : enums ) {
2023-11-03 04:36:04 +01:00
String key = E . key ;
if ( ( key . get_slice_count ( " . " ) > 1 ) & & ( key . get_slice ( " . " , 0 ) = = edited_class ) ) {
key = key . get_slice ( " . " , 1 ) ;
}
if ( cd . enums . has ( key ) ) {
2024-02-16 14:28:05 +01:00
const bool is_documented = cd . enums [ key ] . is_deprecated | | cd . enums [ key ] . is_experimental | | ! cd . enums [ key ] . description . strip_edges ( ) . is_empty ( ) ;
if ( ! is_documented & & cd . is_script_doc & & E . key . begins_with ( " _ " ) ) {
2023-11-03 04:36:04 +01:00
continue ;
}
}
2017-08-24 00:10:32 +02:00
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
// Enum header.
2023-02-11 17:33:38 +01:00
_push_code_font ( ) ;
2023-07-02 12:13:38 +02:00
2024-02-12 14:55:02 +01:00
enum_line [ E . key ] = class_desc - > get_paragraph_count ( ) - 2 ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . title_color ) ;
2022-06-24 11:16:37 +02:00
if ( E . value . size ( ) & & E . value [ 0 ] . is_bitfield ) {
2024-02-27 15:09:55 +01:00
class_desc - > add_text ( " flags " ) ;
2022-06-24 11:16:37 +02:00
} else {
2024-02-27 15:09:55 +01:00
class_desc - > add_text ( " enum " ) ;
2022-06-24 11:16:37 +02:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 17:33:38 +01:00
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . headline_color ) ;
2023-11-03 04:36:04 +01:00
class_desc - > add_text ( key ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 17:33:38 +01:00
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2017-08-24 00:10:32 +02:00
class_desc - > add_text ( " : " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-07-02 12:13:38 +02:00
_pop_code_font ( ) ;
2020-11-29 03:37:57 +01:00
// Enum description.
2024-02-12 14:55:02 +01:00
if ( key ! = " @unnamed_enums " & & cd . enums . has ( key ) ) {
const String descr = DTR_DOC ( cd . enums [ key ] . description ) . strip_edges ( ) ;
const bool is_multiline = descr . find_char ( ' \n ' ) > 0 ;
if ( cd . enums [ key ] . is_deprecated | | cd . enums [ key ] . is_experimental | | ! descr . is_empty ( ) ) {
class_desc - > add_newline ( ) ;
2023-02-11 17:33:38 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > push_indent ( 1 ) ;
_push_normal_font ( ) ;
class_desc - > push_color ( theme_cache . text_color ) ;
bool has_prev_text = false ;
if ( cd . enums [ key ] . is_deprecated ) {
has_prev_text = true ;
DEPRECATED_DOC_MSG ( DTR_DOC ( cd . enums [ key ] . deprecated_message ) , TTR ( " This enumeration may be changed or removed in future versions. " ) ) ;
}
if ( cd . enums [ key ] . is_experimental ) {
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
if ( is_multiline ) {
class_desc - > add_newline ( ) ;
}
}
has_prev_text = true ;
EXPERIMENTAL_DOC_MSG ( DTR_DOC ( cd . enums [ key ] . experimental_message ) , TTR ( " This enumeration may be changed or removed in future versions. " ) ) ;
}
if ( ! descr . is_empty ( ) ) {
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
if ( is_multiline ) {
class_desc - > add_newline ( ) ;
}
}
has_prev_text = true ;
_add_text ( descr ) ;
}
class_desc - > pop ( ) ; // color
_pop_normal_font ( ) ;
class_desc - > pop ( ) ; // indent
}
2020-11-29 03:37:57 +01:00
}
2024-02-12 14:55:02 +01:00
HashMap < String , int > enum_values ;
const int enum_start_line = enum_line [ E . key ] ;
2017-08-24 00:10:32 +02:00
2024-02-12 14:55:02 +01:00
bool prev_is_multiline = true ; // Use a large margin for the first item.
2024-02-16 14:28:05 +01:00
for ( const DocData : : ConstantDoc & enum_value : E . value ) {
const String descr = DTR_DOC ( enum_value . description ) . strip_edges ( ) ;
2024-02-12 14:55:02 +01:00
const bool is_multiline = descr . find_char ( ' \n ' ) > 0 ;
class_desc - > add_newline ( ) ;
if ( prev_is_multiline | | is_multiline ) {
class_desc - > add_newline ( ) ;
}
prev_is_multiline = is_multiline ;
2020-05-14 16:41:43 +02:00
if ( cd . name = = " @GlobalScope " ) {
2024-02-16 14:28:05 +01:00
enum_values [ enum_value . name ] = enum_start_line ;
2020-05-14 16:41:43 +02:00
}
2017-08-24 00:10:32 +02:00
2022-04-26 18:57:36 +02:00
// Add the enum constant line to the constant_line map so we can locate it as a constant.
2024-02-16 14:28:05 +01:00
constant_line [ enum_value . name ] = class_desc - > get_paragraph_count ( ) - 2 ;
2019-03-27 20:01:16 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > push_indent ( 1 ) ;
2023-07-02 12:13:38 +02:00
2024-02-12 14:55:02 +01:00
// Enum value header.
_push_code_font ( ) ;
2021-12-01 19:02:20 +01:00
_add_bulletpoint ( ) ;
2024-02-12 14:55:02 +01:00
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . headline_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( enum_value . name ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2017-08-24 00:10:32 +02:00
class_desc - > add_text ( " = " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . value_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( _fix_constant ( enum_value . value ) ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2022-08-28 08:17:25 +02:00
2023-07-02 12:13:38 +02:00
_pop_code_font ( ) ;
2024-02-12 14:55:02 +01:00
// Enum value description.
2024-02-16 14:28:05 +01:00
if ( enum_value . is_deprecated | | enum_value . is_experimental | | ! descr . is_empty ( ) ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
2021-12-01 19:02:20 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > push_indent ( 1 ) ;
2023-02-11 17:33:38 +01:00
_push_normal_font ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > push_color ( theme_cache . comment_color ) ;
bool has_prev_text = false ;
2024-02-16 14:28:05 +01:00
if ( enum_value . is_deprecated ) {
2024-02-12 14:55:02 +01:00
has_prev_text = true ;
2024-02-16 14:28:05 +01:00
DEPRECATED_DOC_MSG ( DTR_DOC ( enum_value . deprecated_message ) , TTR ( " This constant may be changed or removed in future versions. " ) ) ;
2024-02-12 14:55:02 +01:00
}
2024-02-16 14:28:05 +01:00
if ( enum_value . is_experimental ) {
2024-02-12 14:55:02 +01:00
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
if ( is_multiline ) {
class_desc - > add_newline ( ) ;
}
}
has_prev_text = true ;
2024-02-16 14:28:05 +01:00
EXPERIMENTAL_DOC_MSG ( DTR_DOC ( enum_value . experimental_message ) , TTR ( " This constant may be changed or removed in future versions. " ) ) ;
2024-02-12 14:55:02 +01:00
}
if ( ! descr . is_empty ( ) ) {
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
if ( is_multiline ) {
class_desc - > add_newline ( ) ;
}
}
has_prev_text = true ;
_add_text ( descr ) ;
2020-05-21 11:01:31 +02:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
_pop_normal_font ( ) ;
class_desc - > pop ( ) ; // indent
2017-08-24 00:10:32 +02:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // indent
2017-08-24 00:10:32 +02:00
}
2020-05-14 16:41:43 +02:00
if ( cd . name = = " @GlobalScope " ) {
2024-02-12 14:55:02 +01:00
enum_values_line [ E . key ] = enum_values ;
2020-05-14 16:41:43 +02:00
}
2017-08-24 00:10:32 +02:00
}
}
2018-09-12 17:12:23 +02:00
// Constants
2024-02-12 14:55:02 +01:00
if ( ! constants . is_empty ( ) ) {
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2022-05-18 09:17:55 +02:00
section_line . push_back ( Pair < String , int > ( TTR ( " Constants " ) , class_desc - > get_paragraph_count ( ) - 2 ) ) ;
2023-02-11 17:33:38 +01:00
_push_title_font ( ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( TTR ( " Constants " ) ) ;
2023-02-11 17:33:38 +01:00
_pop_title_font ( ) ;
2017-08-24 00:10:32 +02:00
2024-02-12 14:55:02 +01:00
bool prev_is_multiline = true ; // Use a large margin for the first item.
2024-02-16 14:28:05 +01:00
for ( const DocData : : ConstantDoc & constant : constants ) {
const String descr = DTR_DOC ( constant . description ) . strip_edges ( ) ;
2024-02-12 14:55:02 +01:00
const bool is_multiline = descr . find_char ( ' \n ' ) > 0 ;
class_desc - > add_newline ( ) ;
if ( prev_is_multiline | | is_multiline ) {
class_desc - > add_newline ( ) ;
}
prev_is_multiline = is_multiline ;
2024-02-16 14:28:05 +01:00
constant_line [ constant . name ] = class_desc - > get_paragraph_count ( ) - 2 ;
2023-02-11 17:33:38 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > push_indent ( 1 ) ;
// Constant header.
2023-02-11 17:33:38 +01:00
_push_code_font ( ) ;
2017-12-15 16:43:27 +01:00
2024-02-16 14:28:05 +01:00
if ( constant . value . begins_with ( " Color( " ) & & constant . value . ends_with ( " ) " ) ) {
String stripped = constant . value . replace ( " " , " " ) . replace ( " Color( " , " " ) . replace ( " ) " , " " ) ;
2022-11-20 12:29:50 +01:00
PackedFloat64Array color = stripped . split_floats ( " , " ) ;
2017-12-15 16:43:27 +01:00
if ( color . size ( ) > = 3 ) {
class_desc - > push_color ( Color ( color [ 0 ] , color [ 1 ] , color [ 2 ] ) ) ;
2021-12-01 19:02:20 +01:00
_add_bulletpoint ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2017-12-15 16:43:27 +01:00
}
2020-05-21 11:01:31 +02:00
} else {
2021-12-01 19:02:20 +01:00
_add_bulletpoint ( ) ;
2017-12-15 16:43:27 +01:00
}
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . headline_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( constant . name ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2017-08-24 00:10:32 +02:00
class_desc - > add_text ( " = " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . value_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( _fix_constant ( constant . value ) ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2022-08-28 08:17:25 +02:00
2023-07-02 12:13:38 +02:00
_pop_code_font ( ) ;
2024-02-12 14:55:02 +01:00
// Constant description.
2024-02-16 14:28:05 +01:00
if ( constant . is_deprecated | | constant . is_experimental | | ! descr . is_empty ( ) ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
2021-12-01 19:02:20 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > push_indent ( 1 ) ;
2023-02-11 17:33:38 +01:00
_push_normal_font ( ) ;
2024-02-12 14:55:02 +01:00
class_desc - > push_color ( theme_cache . comment_color ) ;
bool has_prev_text = false ;
2024-02-16 14:28:05 +01:00
if ( constant . is_deprecated ) {
2024-02-12 14:55:02 +01:00
has_prev_text = true ;
2024-02-16 14:28:05 +01:00
DEPRECATED_DOC_MSG ( DTR_DOC ( constant . deprecated_message ) , TTR ( " This constant may be changed or removed in future versions. " ) ) ;
2024-02-12 14:55:02 +01:00
}
2024-02-16 14:28:05 +01:00
if ( constant . is_experimental ) {
2024-02-12 14:55:02 +01:00
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
if ( is_multiline ) {
class_desc - > add_newline ( ) ;
}
}
has_prev_text = true ;
2024-02-16 14:28:05 +01:00
EXPERIMENTAL_DOC_MSG ( DTR_DOC ( constant . experimental_message ) , TTR ( " This constant may be changed or removed in future versions. " ) ) ;
2024-02-12 14:55:02 +01:00
}
if ( ! descr . is_empty ( ) ) {
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
if ( is_multiline ) {
class_desc - > add_newline ( ) ;
}
}
has_prev_text = true ;
_add_text ( descr ) ;
2020-05-21 11:01:31 +02:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
_pop_normal_font ( ) ;
class_desc - > pop ( ) ; // indent
2017-08-24 00:10:32 +02:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // indent
2014-02-10 02:10:30 +01:00
}
}
}
2022-07-04 17:56:34 +02:00
// Annotations
if ( ! cd . annotations . is_empty ( ) ) {
if ( sort_methods ) {
cd . annotations . sort ( ) ;
}
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2022-07-04 17:56:34 +02:00
section_line . push_back ( Pair < String , int > ( TTR ( " Annotations " ) , class_desc - > get_paragraph_count ( ) - 2 ) ) ;
2023-02-11 17:33:38 +01:00
_push_title_font ( ) ;
2022-07-04 17:56:34 +02:00
class_desc - > add_text ( TTR ( " Annotations " ) ) ;
2023-02-11 17:33:38 +01:00
_pop_title_font ( ) ;
2022-07-04 17:56:34 +02:00
2024-02-16 14:28:05 +01:00
for ( const DocData : : MethodDoc & annotation : cd . annotations ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2024-02-16 14:28:05 +01:00
annotation_line [ annotation . name ] = class_desc - > get_paragraph_count ( ) - 2 ; // Gets overridden if description.
2022-07-04 17:56:34 +02:00
2024-02-12 14:55:02 +01:00
class_desc - > push_indent ( 1 ) ;
// Annotation header.
2023-02-11 17:33:38 +01:00
_push_code_font ( ) ;
2022-07-04 17:56:34 +02:00
_add_bulletpoint ( ) ;
2024-02-12 14:55:02 +01:00
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . headline_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( annotation . name ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2022-07-04 17:56:34 +02:00
2024-02-16 14:28:05 +01:00
if ( ! annotation . arguments . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2022-07-04 17:56:34 +02:00
class_desc - > add_text ( " ( " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2024-02-16 14:28:05 +01:00
for ( int j = 0 ; j < annotation . arguments . size ( ) ; j + + ) {
const DocData : : ArgumentDoc & argument = annotation . arguments [ j ] ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . text_color ) ;
2024-02-12 14:55:02 +01:00
2022-07-04 17:56:34 +02:00
if ( j > 0 ) {
class_desc - > add_text ( " , " ) ;
}
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( argument . name ) ;
2022-07-04 17:56:34 +02:00
class_desc - > add_text ( " : " ) ;
2024-02-16 14:28:05 +01:00
_add_type ( argument . type ) ;
2024-02-12 14:55:02 +01:00
2024-02-16 14:28:05 +01:00
if ( ! argument . default_value . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2022-07-04 17:56:34 +02:00
class_desc - > add_text ( " = " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
class_desc - > push_color ( theme_cache . value_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( _fix_constant ( argument . default_value ) ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2022-07-04 17:56:34 +02:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2022-07-04 17:56:34 +02:00
}
2024-02-16 14:28:05 +01:00
if ( annotation . qualifiers . contains ( " vararg " ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . text_color ) ;
2024-02-16 14:28:05 +01:00
if ( ! annotation . arguments . is_empty ( ) ) {
2022-07-04 17:56:34 +02:00
class_desc - > add_text ( " , " ) ;
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2022-07-04 17:56:34 +02:00
class_desc - > add_text ( " ... " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2022-07-04 17:56:34 +02:00
}
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2022-07-04 17:56:34 +02:00
class_desc - > add_text ( " ) " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2022-07-04 17:56:34 +02:00
}
2024-02-16 14:28:05 +01:00
if ( ! annotation . qualifiers . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . qualifier_color ) ;
2022-07-04 17:56:34 +02:00
class_desc - > add_text ( " " ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( annotation . qualifiers ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2022-07-04 17:56:34 +02:00
}
2023-02-11 17:33:38 +01:00
_pop_code_font ( ) ;
2022-07-04 17:56:34 +02:00
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
// Annotation description.
class_desc - > push_indent ( 1 ) ;
_push_normal_font ( ) ;
class_desc - > push_color ( theme_cache . comment_color ) ;
2024-02-16 14:28:05 +01:00
const String descr = DTR_DOC ( annotation . description ) . strip_edges ( ) ;
2024-02-12 14:55:02 +01:00
if ( ! descr . is_empty ( ) ) {
_add_text ( descr ) ;
2022-07-04 17:56:34 +02:00
} else {
2023-08-13 02:33:39 +02:00
class_desc - > add_image ( get_editor_theme_icon ( SNAME ( " Error " ) ) ) ;
2022-07-04 17:56:34 +02:00
class_desc - > add_text ( " " ) ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . comment_color ) ;
2022-07-04 17:56:34 +02:00
if ( cd . is_script_doc ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( TTR ( " There is currently no description for this annotation. " ) ) ;
2022-07-04 17:56:34 +02:00
} else {
class_desc - > append_text ( TTR ( " There is currently no description for this annotation. Please help us by [color=$color][url=$url]contributing one[/url][/color]! " ) . replace ( " $url " , CONTRIBUTE_URL ) . replace ( " $color " , link_color_text ) ) ;
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2022-07-04 17:56:34 +02:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
_pop_normal_font ( ) ;
class_desc - > pop ( ) ; // indent
class_desc - > pop ( ) ; // indent
}
2022-07-04 17:56:34 +02:00
}
2018-09-12 17:12:23 +02:00
// Property descriptions
2023-05-13 11:57:44 +02:00
if ( has_property_descriptions ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2022-05-18 09:17:55 +02:00
section_line . push_back ( Pair < String , int > ( TTR ( " Property Descriptions " ) , class_desc - > get_paragraph_count ( ) - 2 ) ) ;
2023-02-11 17:33:38 +01:00
_push_title_font ( ) ;
2019-09-20 22:40:22 +02:00
class_desc - > add_text ( TTR ( " Property Descriptions " ) ) ;
2023-02-11 17:33:38 +01:00
_pop_title_font ( ) ;
2017-01-04 05:16:14 +01:00
2024-02-16 14:28:05 +01:00
for ( const DocData : : PropertyDoc & prop : cd . properties ) {
if ( prop . overridden ) {
2019-09-03 12:42:34 +02:00
continue ;
2020-05-14 16:41:43 +02:00
}
2022-10-21 13:06:53 +02:00
// Ignore undocumented private.
2024-02-16 14:28:05 +01:00
const bool is_documented = prop . is_deprecated | | prop . is_experimental | | ! prop . description . strip_edges ( ) . is_empty ( ) ;
if ( ! is_documented & & prop . name . begins_with ( " _ " ) ) {
2022-10-21 13:06:53 +02:00
continue ;
}
2019-09-03 12:42:34 +02:00
2024-02-12 14:55:02 +01:00
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2024-02-16 14:28:05 +01:00
property_line [ prop . name ] = class_desc - > get_paragraph_count ( ) - 2 ;
2017-01-04 05:16:14 +01:00
2017-11-04 14:09:45 +01:00
class_desc - > push_table ( 2 ) ;
2020-05-14 11:00:19 +02:00
class_desc - > set_table_column_expand ( 1 , true ) ;
2017-11-04 14:09:45 +01:00
class_desc - > push_cell ( ) ;
2023-02-11 17:33:38 +01:00
_push_code_font ( ) ;
2021-12-01 19:02:20 +01:00
_add_bulletpoint ( ) ;
2024-02-16 14:28:05 +01:00
_add_type ( prop . type , prop . enumeration , prop . is_bitfield ) ;
2023-02-11 17:33:38 +01:00
_pop_code_font ( ) ;
2017-11-04 14:09:45 +01:00
class_desc - > pop ( ) ; // cell
class_desc - > push_cell ( ) ;
2023-02-11 17:33:38 +01:00
_push_code_font ( ) ;
2024-02-12 14:55:02 +01:00
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . headline_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( prop . name ) ;
2017-11-04 14:09:45 +01:00
class_desc - > pop ( ) ; // color
2019-06-01 15:42:22 +02:00
2024-02-16 14:28:05 +01:00
if ( ! prop . default_value . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2020-01-16 23:47:18 +01:00
class_desc - > add_text ( " [ " + TTR ( " default: " ) + " " ) ;
2019-06-01 15:42:22 +02:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . value_color ) ;
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( _fix_constant ( prop . default_value ) ) ;
2019-06-01 15:42:22 +02:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2019-06-01 15:42:22 +02:00
class_desc - > add_text ( " ] " ) ;
class_desc - > pop ( ) ; // color
2022-08-28 08:17:25 +02:00
}
2024-02-16 14:28:05 +01:00
if ( cd . is_script_doc & & ( ! prop . setter . is_empty ( ) | | ! prop . getter . is_empty ( ) ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2020-11-29 03:37:57 +01:00
class_desc - > add_text ( " [ " + TTR ( " property: " ) + " " ) ;
class_desc - > pop ( ) ; // color
2024-02-16 14:28:05 +01:00
if ( ! prop . setter . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . value_color ) ;
2020-11-29 03:37:57 +01:00
class_desc - > add_text ( " setter " ) ;
class_desc - > pop ( ) ; // color
}
2024-02-16 14:28:05 +01:00
if ( ! prop . getter . is_empty ( ) ) {
if ( ! prop . setter . is_empty ( ) ) {
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2020-11-29 03:37:57 +01:00
class_desc - > add_text ( " , " ) ;
class_desc - > pop ( ) ; // color
}
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . value_color ) ;
2020-11-29 03:37:57 +01:00
class_desc - > add_text ( " getter " ) ;
class_desc - > pop ( ) ; // color
}
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . symbol_color ) ;
2020-11-29 03:37:57 +01:00
class_desc - > add_text ( " ] " ) ;
class_desc - > pop ( ) ; // color
}
2023-02-11 17:33:38 +01:00
_pop_code_font ( ) ;
2017-11-04 14:09:45 +01:00
class_desc - > pop ( ) ; // cell
2017-01-04 05:16:14 +01:00
2020-11-29 03:37:57 +01:00
// Script doc doesn't have setter, getter.
if ( ! cd . is_script_doc ) {
2022-05-13 15:04:37 +02:00
HashMap < String , DocData : : MethodDoc > method_map ;
2020-11-29 03:37:57 +01:00
for ( int j = 0 ; j < methods . size ( ) ; j + + ) {
method_map [ methods [ j ] . name ] = methods [ j ] ;
}
2020-05-21 21:07:44 +02:00
2024-02-16 14:28:05 +01:00
if ( ! prop . setter . is_empty ( ) ) {
2020-11-29 03:37:57 +01:00
class_desc - > push_cell ( ) ;
class_desc - > pop ( ) ; // cell
2017-01-04 05:16:14 +01:00
2020-11-29 03:37:57 +01:00
class_desc - > push_cell ( ) ;
2023-02-11 17:33:38 +01:00
_push_code_font ( ) ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . text_color ) ;
2023-02-11 17:33:38 +01:00
2024-02-16 14:28:05 +01:00
if ( method_map [ prop . setter ] . arguments . size ( ) > 1 ) {
2020-11-29 03:37:57 +01:00
// Setters with additional arguments are exposed in the method list, so we link them here for quick access.
2024-02-16 14:28:05 +01:00
class_desc - > push_meta ( " @method " + prop . setter ) ;
class_desc - > add_text ( prop . setter + TTR ( " (value) " ) ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // meta
2020-11-29 03:37:57 +01:00
} else {
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( prop . setter + TTR ( " (value) " ) ) ;
2020-11-29 03:37:57 +01:00
}
2023-02-11 17:33:38 +01:00
2020-11-29 03:37:57 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . comment_color ) ;
2020-11-29 03:37:57 +01:00
class_desc - > add_text ( " setter " ) ;
class_desc - > pop ( ) ; // color
2023-02-11 17:33:38 +01:00
_pop_code_font ( ) ;
2020-11-29 03:37:57 +01:00
class_desc - > pop ( ) ; // cell
2023-02-11 17:33:38 +01:00
2024-02-16 14:28:05 +01:00
method_line [ prop . setter ] = property_line [ prop . name ] ;
2020-05-21 21:07:44 +02:00
}
2017-01-04 05:16:14 +01:00
2024-02-16 14:28:05 +01:00
if ( ! prop . getter . is_empty ( ) ) {
2020-11-29 03:37:57 +01:00
class_desc - > push_cell ( ) ;
class_desc - > pop ( ) ; // cell
2017-01-04 05:16:14 +01:00
2020-11-29 03:37:57 +01:00
class_desc - > push_cell ( ) ;
2023-02-11 17:33:38 +01:00
_push_code_font ( ) ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . text_color ) ;
2023-02-11 17:33:38 +01:00
2024-02-16 14:28:05 +01:00
if ( ! method_map [ prop . getter ] . arguments . is_empty ( ) ) {
2020-11-29 03:37:57 +01:00
// Getters with additional arguments are exposed in the method list, so we link them here for quick access.
2024-02-16 14:28:05 +01:00
class_desc - > push_meta ( " @method " + prop . getter ) ;
class_desc - > add_text ( prop . getter + " () " ) ;
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // meta
2020-11-29 03:37:57 +01:00
} else {
2024-02-16 14:28:05 +01:00
class_desc - > add_text ( prop . getter + " () " ) ;
2020-11-29 03:37:57 +01:00
}
2023-02-11 17:33:38 +01:00
class_desc - > pop ( ) ; // color
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . comment_color ) ;
2020-11-29 03:37:57 +01:00
class_desc - > add_text ( " getter " ) ;
2023-02-11 17:33:38 +01:00
class_desc - > pop ( ) ; // color
_pop_code_font ( ) ;
class_desc - > pop ( ) ; // cell
2024-02-16 14:28:05 +01:00
method_line [ prop . getter ] = property_line [ prop . name ] ;
2020-05-21 21:07:44 +02:00
}
2017-01-04 05:16:14 +01:00
}
2017-11-04 14:09:45 +01:00
class_desc - > pop ( ) ; // table
2019-06-20 12:42:25 +02:00
class_desc - > add_newline ( ) ;
2017-01-04 05:16:14 +01:00
class_desc - > add_newline ( ) ;
class_desc - > push_indent ( 1 ) ;
2024-02-12 14:55:02 +01:00
_push_normal_font ( ) ;
class_desc - > push_color ( theme_cache . text_color ) ;
2024-02-16 14:28:05 +01:00
bool has_prev_text = false ;
if ( prop . is_deprecated ) {
has_prev_text = true ;
DEPRECATED_DOC_MSG ( DTR_DOC ( prop . deprecated_message ) , TTR ( " This property may be changed or removed in future versions. " ) ) ;
2024-02-12 14:55:02 +01:00
}
2024-02-16 14:28:05 +01:00
if ( prop . is_experimental ) {
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
}
has_prev_text = true ;
EXPERIMENTAL_DOC_MSG ( DTR_DOC ( prop . experimental_message ) , TTR ( " This property may be changed or removed in future versions. " ) ) ;
2024-02-12 14:55:02 +01:00
}
2024-02-16 14:28:05 +01:00
const String descr = DTR_DOC ( prop . description ) . strip_edges ( ) ;
2024-02-12 14:55:02 +01:00
if ( ! descr . is_empty ( ) ) {
2024-02-16 14:28:05 +01:00
if ( has_prev_text ) {
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
}
has_prev_text = true ;
2024-02-12 14:55:02 +01:00
_add_text ( descr ) ;
2024-02-16 14:28:05 +01:00
} else if ( ! has_prev_text ) {
2023-08-13 02:33:39 +02:00
class_desc - > add_image ( get_editor_theme_icon ( SNAME ( " Error " ) ) ) ;
2017-09-13 00:16:18 +02:00
class_desc - > add_text ( " " ) ;
2023-02-11 16:29:44 +01:00
class_desc - > push_color ( theme_cache . comment_color ) ;
2020-11-29 03:37:57 +01:00
if ( cd . is_script_doc ) {
2024-02-12 14:55:02 +01:00
class_desc - > add_text ( TTR ( " There is currently no description for this property. " ) ) ;
2020-11-29 03:37:57 +01:00
} else {
2020-05-29 16:25:12 +02:00
class_desc - > append_text ( TTR ( " There is currently no description for this property. Please help us by [color=$color][url=$url]contributing one[/url][/color]! " ) . replace ( " $url " , CONTRIBUTE_URL ) . replace ( " $color " , link_color_text ) ) ;
2020-11-29 03:37:57 +01:00
}
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
2017-09-13 00:16:18 +02:00
}
2023-02-11 17:33:38 +01:00
2024-02-12 14:55:02 +01:00
class_desc - > pop ( ) ; // color
_pop_normal_font ( ) ;
class_desc - > pop ( ) ; // indent
2017-01-04 05:16:14 +01:00
}
}
2021-09-21 04:49:02 +02:00
// Constructor descriptions
2022-07-19 17:17:04 +02:00
if ( ! cd . constructors . is_empty ( ) ) {
2024-02-12 14:55:02 +01:00
_update_method_descriptions ( cd , METHOD_TYPE_CONSTRUCTOR , cd . constructors ) ;
2021-09-21 04:49:02 +02:00
}
2018-09-12 17:12:23 +02:00
// Method descriptions
2022-07-19 17:17:04 +02:00
if ( ! methods . is_empty ( ) ) {
2024-02-12 14:55:02 +01:00
_update_method_descriptions ( cd , METHOD_TYPE_METHOD , methods ) ;
2021-09-21 04:49:02 +02:00
}
2019-10-03 18:31:41 +02:00
2021-09-21 04:49:02 +02:00
// Operator descriptions
2022-07-19 17:17:04 +02:00
if ( ! cd . operators . is_empty ( ) ) {
2024-02-12 14:55:02 +01:00
_update_method_descriptions ( cd , METHOD_TYPE_OPERATOR , cd . operators ) ;
2014-02-10 02:10:30 +01:00
}
2022-07-19 17:17:04 +02:00
2024-02-12 14:55:02 +01:00
// Allow the document to be scrolled slightly below the end.
class_desc - > add_newline ( ) ;
class_desc - > add_newline ( ) ;
2022-07-19 17:17:04 +02:00
// Free the scroll.
2014-02-10 02:10:30 +01:00
scroll_locked = false ;
2024-02-12 14:55:02 +01:00
# undef DTR_DOC
2014-02-10 02:10:30 +01:00
}
2014-06-23 17:43:37 +02:00
void EditorHelp : : _request_help ( const String & p_string ) {
2014-05-06 11:41:19 +02:00
Error err = _goto_desc ( p_string ) ;
if ( err = = OK ) {
2017-06-06 17:23:48 +02:00
EditorNode : : get_singleton ( ) - > set_visible_editor ( EditorNode : : EDITOR_SCRIPT ) ;
2014-05-06 11:41:19 +02:00
}
2014-02-10 02:10:30 +01:00
}
2014-02-21 03:01:44 +01:00
void EditorHelp : : _help_callback ( const String & p_topic ) {
String what = p_topic . get_slice ( " : " , 0 ) ;
String clss = p_topic . get_slice ( " : " , 1 ) ;
String name ;
2020-05-14 16:41:43 +02:00
if ( p_topic . get_slice_count ( " : " ) = = 3 ) {
2014-02-21 03:01:44 +01:00
name = p_topic . get_slice ( " : " , 2 ) ;
2020-05-14 16:41:43 +02:00
}
2014-02-21 03:01:44 +01:00
2022-04-26 18:57:36 +02:00
_request_help ( clss ) ; // First go to class.
2014-02-21 03:01:44 +01:00
int line = 0 ;
if ( what = = " class_desc " ) {
line = description_line ;
} else if ( what = = " class_signal " ) {
2020-05-14 16:41:43 +02:00
if ( signal_line . has ( name ) ) {
2014-02-21 03:01:44 +01:00
line = signal_line [ name ] ;
2020-05-14 16:41:43 +02:00
}
2014-02-21 03:01:44 +01:00
} else if ( what = = " class_method " | | what = = " class_method_desc " ) {
2020-05-14 16:41:43 +02:00
if ( method_line . has ( name ) ) {
2014-02-21 03:01:44 +01:00
line = method_line [ name ] ;
2020-05-14 16:41:43 +02:00
}
2014-02-21 03:01:44 +01:00
} else if ( what = = " class_property " ) {
2020-05-14 16:41:43 +02:00
if ( property_line . has ( name ) ) {
2014-02-21 03:01:44 +01:00
line = property_line [ name ] ;
2020-05-14 16:41:43 +02:00
}
2017-08-24 00:10:32 +02:00
} else if ( what = = " class_enum " ) {
2020-05-14 16:41:43 +02:00
if ( enum_line . has ( name ) ) {
2017-08-24 00:10:32 +02:00
line = enum_line [ name ] ;
2020-05-14 16:41:43 +02:00
}
2014-06-30 03:41:02 +02:00
} else if ( what = = " class_theme_item " ) {
2020-05-14 16:41:43 +02:00
if ( theme_property_line . has ( name ) ) {
2014-06-30 03:41:02 +02:00
line = theme_property_line [ name ] ;
2020-05-14 16:41:43 +02:00
}
2014-02-21 03:01:44 +01:00
} else if ( what = = " class_constant " ) {
2020-05-14 16:41:43 +02:00
if ( constant_line . has ( name ) ) {
2014-02-21 03:01:44 +01:00
line = constant_line [ name ] ;
2020-05-14 16:41:43 +02:00
}
2022-07-04 17:56:34 +02:00
} else if ( what = = " class_annotation " ) {
if ( annotation_line . has ( name ) ) {
line = annotation_line [ name ] ;
}
2018-03-30 16:20:24 +02:00
} else if ( what = = " class_global " ) {
2020-05-14 16:41:43 +02:00
if ( constant_line . has ( name ) ) {
2018-03-30 16:20:24 +02:00
line = constant_line [ name ] ;
2021-08-30 21:51:56 +02:00
} else if ( method_line . has ( name ) ) {
line = method_line [ name ] ;
2020-05-14 16:41:43 +02:00
} else {
2022-05-13 15:04:37 +02:00
HashMap < String , HashMap < String , int > > : : Iterator iter = enum_values_line . begin ( ) ;
2018-03-30 16:20:24 +02:00
while ( true ) {
2022-05-13 15:04:37 +02:00
if ( iter - > value . has ( name ) ) {
line = iter - > value [ name ] ;
2018-03-30 16:20:24 +02:00
break ;
2022-05-13 15:04:37 +02:00
} else if ( iter = = enum_values_line . last ( ) ) {
2018-03-30 16:20:24 +02:00
break ;
2020-05-14 16:41:43 +02:00
} else {
2022-05-13 15:04:37 +02:00
+ + iter ;
2020-05-14 16:41:43 +02:00
}
2018-03-30 16:20:24 +02:00
}
}
2014-02-21 03:01:44 +01:00
}
2022-05-30 09:04:07 +02:00
if ( class_desc - > is_ready ( ) ) {
2023-12-18 15:46:56 +01:00
callable_mp ( class_desc , & RichTextLabel : : scroll_to_paragraph ) . call_deferred ( line ) ;
2022-05-30 09:04:07 +02:00
} else {
scroll_to = line ;
}
2014-02-21 03:01:44 +01:00
}
2014-02-10 02:10:30 +01:00
2023-06-24 18:09:31 +02:00
static void _add_text_to_rt ( const String & p_bbcode , RichTextLabel * p_rt , Control * p_owner_node , const String & p_class = " " ) {
2020-11-29 04:42:06 +01:00
DocTools * doc = EditorHelp : : get_doc_data ( ) ;
2016-08-24 04:15:16 +02:00
String base_path ;
2023-08-13 02:33:39 +02:00
Ref < Font > doc_font = p_owner_node - > get_theme_font ( SNAME ( " doc " ) , EditorStringName ( EditorFonts ) ) ;
Ref < Font > doc_bold_font = p_owner_node - > get_theme_font ( SNAME ( " doc_bold " ) , EditorStringName ( EditorFonts ) ) ;
Ref < Font > doc_italic_font = p_owner_node - > get_theme_font ( SNAME ( " doc_italic " ) , EditorStringName ( EditorFonts ) ) ;
Ref < Font > doc_code_font = p_owner_node - > get_theme_font ( SNAME ( " doc_source " ) , EditorStringName ( EditorFonts ) ) ;
Ref < Font > doc_kbd_font = p_owner_node - > get_theme_font ( SNAME ( " doc_keyboard " ) , EditorStringName ( EditorFonts ) ) ;
2019-10-31 18:47:12 +01:00
2023-08-13 02:33:39 +02:00
int doc_code_font_size = p_owner_node - > get_theme_font_size ( SNAME ( " doc_source_size " ) , EditorStringName ( EditorFonts ) ) ;
int doc_kbd_font_size = p_owner_node - > get_theme_font_size ( SNAME ( " doc_keyboard_size " ) , EditorStringName ( EditorFonts ) ) ;
2023-02-11 17:33:38 +01:00
2022-10-31 19:51:48 +01:00
const Color type_color = p_owner_node - > get_theme_color ( SNAME ( " type_color " ) , SNAME ( " EditorHelp " ) ) ;
const Color code_color = p_owner_node - > get_theme_color ( SNAME ( " code_color " ) , SNAME ( " EditorHelp " ) ) ;
const Color kbd_color = p_owner_node - > get_theme_color ( SNAME ( " kbd_color " ) , SNAME ( " EditorHelp " ) ) ;
const Color code_dark_color = Color ( code_color , 0.8 ) ;
const Color link_color = p_owner_node - > get_theme_color ( SNAME ( " link_color " ) , SNAME ( " EditorHelp " ) ) ;
2023-08-13 02:33:39 +02:00
const Color link_method_color = p_owner_node - > get_theme_color ( SNAME ( " accent_color " ) , EditorStringName ( Editor ) ) ;
const Color link_property_color = link_color . lerp ( p_owner_node - > get_theme_color ( SNAME ( " accent_color " ) , EditorStringName ( Editor ) ) , 0.25 ) ;
const Color link_annotation_color = link_color . lerp ( p_owner_node - > get_theme_color ( SNAME ( " accent_color " ) , EditorStringName ( Editor ) ) , 0.5 ) ;
2022-10-31 19:51:48 +01:00
const Color code_bg_color = p_owner_node - > get_theme_color ( SNAME ( " code_bg_color " ) , SNAME ( " EditorHelp " ) ) ;
const Color kbd_bg_color = p_owner_node - > get_theme_color ( SNAME ( " kbd_bg_color " ) , SNAME ( " EditorHelp " ) ) ;
const Color param_bg_color = p_owner_node - > get_theme_color ( SNAME ( " param_bg_color " ) , SNAME ( " EditorHelp " ) ) ;
2016-05-29 16:37:26 +02:00
2017-11-11 02:11:24 +01:00
String bbcode = p_bbcode . dedent ( ) . replace ( " \t " , " " ) . replace ( " \r " , " " ) . strip_edges ( ) ;
2016-02-28 03:10:44 +01:00
2022-04-26 18:57:36 +02:00
// Select the correct code examples.
2020-07-22 22:41:10 +02:00
switch ( ( int ) EDITOR_GET ( " text_editor/help/class_reference_examples " ) ) {
case 0 : // GDScript
2023-10-02 20:11:43 +02:00
bbcode = bbcode . replace ( " [gdscript " , " [codeblock " ) ; // Tag can have extra arguments.
2020-07-22 22:41:10 +02:00
bbcode = bbcode . replace ( " [/gdscript] " , " [/codeblock] " ) ;
2023-10-02 20:11:43 +02:00
for ( int pos = bbcode . find ( " [csharp " ) ; pos ! = - 1 ; pos = bbcode . find ( " [csharp " ) ) {
2021-11-11 09:08:08 +01:00
int end_pos = bbcode . find ( " [/csharp] " ) ;
if ( end_pos = = - 1 ) {
2020-07-22 22:41:10 +02:00
WARN_PRINT ( " Unclosed [csharp] block or parse fail in code (search for tag errors) " ) ;
break ;
}
2021-11-11 09:08:08 +01:00
bbcode = bbcode . left ( pos ) + bbcode . substr ( end_pos + 9 ) ; // 9 is length of "[/csharp]".
2020-07-22 22:41:10 +02:00
while ( bbcode [ pos ] = = ' \n ' ) {
2021-11-11 09:08:08 +01:00
bbcode = bbcode . left ( pos ) + bbcode . substr ( pos + 1 ) ;
2020-07-22 22:41:10 +02:00
}
}
break ;
case 1 : // C#
2023-10-02 20:11:43 +02:00
bbcode = bbcode . replace ( " [csharp " , " [codeblock " ) ; // Tag can have extra arguments.
2020-07-22 22:41:10 +02:00
bbcode = bbcode . replace ( " [/csharp] " , " [/codeblock] " ) ;
2023-10-02 20:11:43 +02:00
for ( int pos = bbcode . find ( " [gdscript " ) ; pos ! = - 1 ; pos = bbcode . find ( " [gdscript " ) ) {
2021-11-11 09:08:08 +01:00
int end_pos = bbcode . find ( " [/gdscript] " ) ;
if ( end_pos = = - 1 ) {
2020-07-22 22:41:10 +02:00
WARN_PRINT ( " Unclosed [gdscript] block or parse fail in code (search for tag errors) " ) ;
break ;
}
2021-11-11 09:08:08 +01:00
bbcode = bbcode . left ( pos ) + bbcode . substr ( end_pos + 11 ) ; // 11 is length of "[/gdscript]".
2020-07-22 22:41:10 +02:00
while ( bbcode [ pos ] = = ' \n ' ) {
2021-11-11 09:08:08 +01:00
bbcode = bbcode . left ( pos ) + bbcode . substr ( pos + 1 ) ;
2020-07-22 22:41:10 +02:00
}
}
break ;
case 2 : // GDScript and C#
2023-10-02 20:11:43 +02:00
bbcode = bbcode . replace ( " [csharp " , " [b]C#:[/b] \n [codeblock " ) ; // Tag can have extra arguments.
bbcode = bbcode . replace ( " [gdscript " , " [b]GDScript:[/b] \n [codeblock " ) ; // Tag can have extra arguments.
2020-07-22 22:41:10 +02:00
bbcode = bbcode . replace ( " [/csharp] " , " [/codeblock] " ) ;
bbcode = bbcode . replace ( " [/gdscript] " , " [/codeblock] " ) ;
break ;
}
2022-04-26 18:57:36 +02:00
// Remove codeblocks (they would be printed otherwise).
2020-07-22 22:41:10 +02:00
bbcode = bbcode . replace ( " [codeblocks] \n " , " " ) ;
bbcode = bbcode . replace ( " \n [/codeblocks] " , " " ) ;
bbcode = bbcode . replace ( " [codeblocks] " , " " ) ;
bbcode = bbcode . replace ( " [/codeblocks] " , " " ) ;
2022-04-26 18:57:36 +02:00
// Remove extra new lines around code blocks.
2019-10-31 18:47:12 +01:00
bbcode = bbcode . replace ( " [codeblock] \n " , " [codeblock] " ) ;
2023-10-02 20:11:43 +02:00
bbcode = bbcode . replace ( " [codeblock skip-lint] \n " , " [codeblock skip-lint] " ) ; // Extra argument to silence validation warnings.
2019-10-31 18:47:12 +01:00
bbcode = bbcode . replace ( " \n [/codeblock] " , " [/codeblock] " ) ;
2024-02-12 14:55:02 +01:00
bbcode = bbcode . replace ( " [/codeblock] \n " , " [/codeblock] " ) ;
2019-10-31 18:47:12 +01:00
2014-02-10 02:10:30 +01:00
List < String > tag_stack ;
2017-11-11 02:11:24 +01:00
bool code_tag = false ;
2022-07-04 17:14:50 +02:00
bool codeblock_tag = false ;
2024-01-17 15:22:43 +01:00
const bool using_tab_indent = int ( EDITOR_GET ( " text_editor/behavior/indent/type " ) ) = = 0 ;
2024-01-19 09:56:42 +01:00
StringBuilder codeblock_text ;
2014-02-10 02:10:30 +01:00
2017-09-14 02:56:37 +02:00
int pos = 0 ;
2016-02-28 03:10:44 +01:00
while ( pos < bbcode . length ( ) ) {
2024-02-12 14:55:02 +01:00
int brk_pos = bbcode . find_char ( ' [ ' , pos ) ;
2014-02-10 02:10:30 +01:00
2020-05-14 16:41:43 +02:00
if ( brk_pos < 0 ) {
2016-02-28 03:10:44 +01:00
brk_pos = bbcode . length ( ) ;
2020-05-14 16:41:43 +02:00
}
2014-02-10 02:10:30 +01:00
if ( brk_pos > pos ) {
2017-11-11 02:11:24 +01:00
String text = bbcode . substr ( pos , brk_pos - pos ) ;
2024-01-17 15:22:43 +01:00
if ( codeblock_tag & & using_tab_indent ) {
// Replace the code block's space indentation with tabs.
StringBuilder builder ;
PackedStringArray text_lines = text . split ( " \n " ) ;
for ( const String & line : text_lines ) {
String stripped_line = line . dedent ( ) ;
int space_count = line . length ( ) - stripped_line . length ( ) ;
if ( builder . num_strings_appended ( ) > 0 ) {
builder . append ( " \n " ) ;
}
if ( space_count > 0 ) {
builder . append ( String ( " \t " ) . repeat ( MAX ( space_count / 4 , 1 ) ) + stripped_line ) ;
} else {
builder . append ( line ) ;
}
}
text = builder . as_string ( ) ;
}
2022-07-04 17:14:50 +02:00
if ( ! code_tag & & ! codeblock_tag ) {
2017-11-11 02:11:24 +01:00
text = text . replace ( " \n " , " \n \n " ) ;
2020-05-14 16:41:43 +02:00
}
2024-01-19 09:56:42 +01:00
if ( codeblock_tag ) {
codeblock_text . append ( text ) ;
}
2017-11-11 02:11:24 +01:00
p_rt - > add_text ( text ) ;
2014-02-10 02:10:30 +01:00
}
2020-05-14 16:41:43 +02:00
if ( brk_pos = = bbcode . length ( ) ) {
2022-04-26 18:57:36 +02:00
break ; // Nothing else to add.
2020-05-14 16:41:43 +02:00
}
2014-02-10 02:10:30 +01:00
2024-02-12 14:55:02 +01:00
int brk_end = bbcode . find_char ( ' ] ' , brk_pos + 1 ) ;
2014-02-10 02:10:30 +01:00
if ( brk_end = = - 1 ) {
2017-11-11 02:11:24 +01:00
String text = bbcode . substr ( brk_pos , bbcode . length ( ) - brk_pos ) ;
2022-07-04 17:14:50 +02:00
if ( ! code_tag & & ! codeblock_tag ) {
2017-11-11 02:11:24 +01:00
text = text . replace ( " \n " , " \n \n " ) ;
2020-05-14 16:41:43 +02:00
}
2017-11-11 02:11:24 +01:00
p_rt - > add_text ( text ) ;
2014-02-10 02:10:30 +01:00
break ;
}
2016-02-28 03:10:44 +01:00
String tag = bbcode . substr ( brk_pos + 1 , brk_end - brk_pos - 1 ) ;
2014-02-10 02:10:30 +01:00
if ( tag . begins_with ( " / " ) ) {
bool tag_ok = tag_stack . size ( ) & & tag_stack . front ( ) - > get ( ) = = tag . substr ( 1 , tag . length ( ) ) ;
2017-09-14 02:56:37 +02:00
2014-02-10 02:10:30 +01:00
if ( ! tag_ok ) {
2016-08-24 04:15:16 +02:00
p_rt - > add_text ( " [ " ) ;
2017-11-11 02:11:24 +01:00
pos = brk_pos + 1 ;
2014-02-10 02:10:30 +01:00
continue ;
}
tag_stack . pop_front ( ) ;
pos = brk_end + 1 ;
2019-10-31 18:47:12 +01:00
if ( tag ! = " /img " ) {
if ( code_tag ) {
2024-01-19 09:56:42 +01:00
p_rt - > pop ( ) ; // color
p_rt - > pop ( ) ; // background color
2023-02-11 17:33:38 +01:00
p_rt - > pop ( ) ; // font size
2022-07-04 17:14:50 +02:00
} else if ( codeblock_tag ) {
2024-01-19 09:56:42 +01:00
p_rt - > pop ( ) ; // color
p_rt - > pop ( ) ; // cell
// Copy codeblock button.
p_rt - > push_cell ( ) ;
p_rt - > set_cell_row_background_color ( code_bg_color , Color ( code_bg_color , 0.99 ) ) ;
p_rt - > set_cell_padding ( Rect2 ( 0 , 10 * EDSCALE , 0 , 10 * EDSCALE ) ) ;
p_rt - > set_cell_size_override ( Vector2 ( 1 , 1 ) , Vector2 ( 10 , 10 ) * EDSCALE ) ;
p_rt - > push_meta ( " ^ " + codeblock_text . as_string ( ) , RichTextLabel : : META_UNDERLINE_ON_HOVER ) ;
codeblock_text = StringBuilder ( ) ;
p_rt - > add_image ( p_owner_node - > get_editor_theme_icon ( SNAME ( " ActionCopy " ) ) , 24 * EDSCALE , 24 * EDSCALE , Color ( link_property_color , 0.3 ) , INLINE_ALIGNMENT_BOTTOM_TO , Rect2 ( ) , Variant ( ) , false , TTR ( " Click to copy. " ) ) ;
p_rt - > pop ( ) ; // meta
p_rt - > pop ( ) ; // cell
p_rt - > pop ( ) ; // table
2023-02-11 17:33:38 +01:00
p_rt - > pop ( ) ; // font size
2024-01-19 09:56:42 +01:00
2024-02-12 14:55:02 +01:00
if ( pos < bbcode . length ( ) ) {
p_rt - > add_newline ( ) ;
}
2019-10-31 18:47:12 +01:00
}
2024-01-19 09:56:42 +01:00
p_rt - > pop ( ) ; // Pops font for codetags & codeblocks, anything else for other tags.
2019-10-31 18:47:12 +01:00
}
code_tag = false ;
2022-07-04 17:14:50 +02:00
codeblock_tag = false ;
2019-10-31 18:47:12 +01:00
2022-07-04 17:14:50 +02:00
} else if ( code_tag | | codeblock_tag ) {
2017-11-11 02:11:24 +01:00
p_rt - > add_text ( " [ " ) ;
pos = brk_pos + 1 ;
2024-01-19 09:56:42 +01:00
if ( codeblock_tag ) {
codeblock_text . append ( " [ " ) ;
}
2023-10-02 20:11:43 +02:00
} else if ( tag . begins_with ( " method " ) | | tag . begins_with ( " constructor " ) | | tag . begins_with ( " operator " ) | | tag . begins_with ( " member " ) | | tag . begins_with ( " signal " ) | | tag . begins_with ( " enum " ) | | tag . begins_with ( " constant " ) | | tag . begins_with ( " annotation " ) | | tag . begins_with ( " theme_item " ) ) {
2024-02-12 14:55:02 +01:00
const int tag_end = tag . find_char ( ' ' ) ;
2020-01-24 13:29:19 +01:00
const String link_tag = tag . substr ( 0 , tag_end ) ;
const String link_target = tag . substr ( tag_end + 1 , tag . length ( ) ) . lstrip ( " " ) ;
2019-04-27 21:15:07 +02:00
2022-10-31 19:51:48 +01:00
// Use monospace font to make clickable references
2022-07-04 17:14:50 +02:00
// easier to distinguish from inline code and other text.
2020-01-24 13:29:19 +01:00
p_rt - > push_font ( doc_code_font ) ;
2023-02-11 17:33:38 +01:00
p_rt - > push_font_size ( doc_code_font_size ) ;
2022-10-31 19:51:48 +01:00
Color target_color = link_color ;
2023-10-02 20:11:43 +02:00
if ( link_tag = = " method " | | link_tag = = " constructor " | | link_tag = = " operator " ) {
2022-10-31 19:51:48 +01:00
target_color = link_method_color ;
2024-02-12 14:55:02 +01:00
} else if ( link_tag = = " member " | | link_tag = = " signal " | | link_tag = = " theme_item " ) {
2022-10-31 19:51:48 +01:00
target_color = link_property_color ;
} else if ( link_tag = = " annotation " ) {
target_color = link_annotation_color ;
}
p_rt - > push_color ( target_color ) ;
2019-04-27 21:15:07 +02:00
p_rt - > push_meta ( " @ " + link_tag + " " + link_target ) ;
2022-10-31 19:51:48 +01:00
p_rt - > add_text ( link_target + ( link_tag = = " method " ? " () " : " " ) ) ;
2016-08-24 04:15:16 +02:00
p_rt - > pop ( ) ;
2020-01-24 13:29:19 +01:00
p_rt - > pop ( ) ;
2023-02-11 17:33:38 +01:00
p_rt - > pop ( ) ; // font size
p_rt - > pop ( ) ; // font
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
2022-08-06 19:48:54 +02:00
} else if ( tag . begins_with ( " param " ) ) {
2024-02-12 14:55:02 +01:00
const int tag_end = tag . find_char ( ' ' ) ;
2022-08-06 19:48:54 +02:00
const String param_name = tag . substr ( tag_end + 1 , tag . length ( ) ) . lstrip ( " " ) ;
// Use monospace font with translucent background color to make code easier to distinguish from other text.
p_rt - > push_font ( doc_code_font ) ;
2023-02-11 17:33:38 +01:00
p_rt - > push_font_size ( doc_code_font_size ) ;
2022-10-31 19:51:48 +01:00
p_rt - > push_bgcolor ( param_bg_color ) ;
2022-08-06 19:48:54 +02:00
p_rt - > push_color ( code_color ) ;
p_rt - > add_text ( param_name ) ;
p_rt - > pop ( ) ;
p_rt - > pop ( ) ;
2023-02-11 17:33:38 +01:00
p_rt - > pop ( ) ; // font size
p_rt - > pop ( ) ; // font
2022-08-06 19:48:54 +02:00
pos = brk_end + 1 ;
2023-06-24 18:09:31 +02:00
} else if ( tag = = p_class ) {
// Use a bold font when class reference tags are in their own page.
p_rt - > push_font ( doc_bold_font ) ;
p_rt - > add_text ( tag ) ;
p_rt - > pop ( ) ;
pos = brk_end + 1 ;
2014-02-16 01:16:33 +01:00
} else if ( doc - > class_list . has ( tag ) ) {
2023-06-24 18:09:31 +02:00
// Use a monospace font for class reference tags such as [Node2D] or [SceneTree].
2020-01-24 13:29:19 +01:00
p_rt - > push_font ( doc_code_font ) ;
2023-02-11 17:33:38 +01:00
p_rt - > push_font_size ( doc_code_font_size ) ;
2022-10-31 19:51:48 +01:00
p_rt - > push_color ( type_color ) ;
2016-08-24 04:15:16 +02:00
p_rt - > push_meta ( " # " + tag ) ;
p_rt - > add_text ( tag ) ;
2023-06-24 18:09:31 +02:00
2016-08-24 04:15:16 +02:00
p_rt - > pop ( ) ;
p_rt - > pop ( ) ;
2023-06-24 18:09:31 +02:00
p_rt - > pop ( ) ; // Font size
p_rt - > pop ( ) ; // Font
2023-02-11 17:33:38 +01:00
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
} else if ( tag = = " b " ) {
2022-04-26 18:57:36 +02:00
// Use bold font.
2019-06-15 18:18:32 +02:00
p_rt - > push_font ( doc_bold_font ) ;
2023-02-11 17:33:38 +01:00
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
tag_stack . push_front ( tag ) ;
} else if ( tag = = " i " ) {
2022-04-26 18:57:36 +02:00
// Use italics font.
2022-03-11 15:22:04 +01:00
p_rt - > push_font ( doc_italic_font ) ;
2023-02-11 17:33:38 +01:00
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
tag_stack . push_front ( tag ) ;
2023-10-02 20:11:43 +02:00
} else if ( tag = = " code " | | tag . begins_with ( " code " ) ) {
2022-10-31 19:51:48 +01:00
// Use monospace font with darkened background color to make code easier to distinguish from other text.
2016-08-24 04:15:16 +02:00
p_rt - > push_font ( doc_code_font ) ;
2023-02-11 17:33:38 +01:00
p_rt - > push_font_size ( doc_code_font_size ) ;
2022-10-31 19:51:48 +01:00
p_rt - > push_bgcolor ( code_bg_color ) ;
2023-08-13 02:33:39 +02:00
p_rt - > push_color ( code_color . lerp ( p_owner_node - > get_theme_color ( SNAME ( " error_color " ) , EditorStringName ( Editor ) ) , 0.6 ) ) ;
2023-02-11 17:33:38 +01:00
2017-11-11 02:11:24 +01:00
code_tag = true ;
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
2023-10-02 20:11:43 +02:00
tag_stack . push_front ( " code " ) ;
} else if ( tag = = " codeblock " | | tag . begins_with ( " codeblock " ) ) {
2022-10-31 19:51:48 +01:00
// Use monospace font with darkened background color to make code easier to distinguish from other text.
2022-07-04 17:14:50 +02:00
// Use a single-column table with cell row background color instead of `[bgcolor]`.
// This makes the background color highlight cover the entire block, rather than individual lines.
p_rt - > push_font ( doc_code_font ) ;
2023-02-11 17:33:38 +01:00
p_rt - > push_font_size ( doc_code_font_size ) ;
2024-01-19 09:56:42 +01:00
p_rt - > push_table ( 2 ) ;
2022-07-04 17:14:50 +02:00
p_rt - > push_cell ( ) ;
2022-10-31 19:51:48 +01:00
p_rt - > set_cell_row_background_color ( code_bg_color , Color ( code_bg_color , 0.99 ) ) ;
2022-07-17 22:55:20 +02:00
p_rt - > set_cell_padding ( Rect2 ( 10 * EDSCALE , 10 * EDSCALE , 10 * EDSCALE , 10 * EDSCALE ) ) ;
2022-10-31 19:51:48 +01:00
p_rt - > push_color ( code_dark_color ) ;
2023-02-11 17:33:38 +01:00
2022-07-04 17:14:50 +02:00
codeblock_tag = true ;
pos = brk_end + 1 ;
2023-10-02 20:11:43 +02:00
tag_stack . push_front ( " codeblock " ) ;
2020-03-10 11:41:36 +01:00
} else if ( tag = = " kbd " ) {
2022-07-04 17:14:50 +02:00
// Use keyboard font with custom color and background color.
2020-03-10 11:41:36 +01:00
p_rt - > push_font ( doc_kbd_font ) ;
2023-02-11 17:33:38 +01:00
p_rt - > push_font_size ( doc_kbd_font_size ) ;
2022-10-31 19:51:48 +01:00
p_rt - > push_bgcolor ( kbd_bg_color ) ;
2020-03-10 11:41:36 +01:00
p_rt - > push_color ( kbd_color ) ;
2023-02-11 17:33:38 +01:00
2022-04-26 18:57:36 +02:00
code_tag = true ; // Though not strictly a code tag, logic is similar.
2020-03-10 11:41:36 +01:00
pos = brk_end + 1 ;
tag_stack . push_front ( tag ) ;
2023-02-11 17:33:38 +01:00
2014-02-10 02:10:30 +01:00
} else if ( tag = = " center " ) {
2022-04-26 18:57:36 +02:00
// Align to center.
2021-11-25 03:58:47 +01:00
p_rt - > push_paragraph ( HORIZONTAL_ALIGNMENT_CENTER , Control : : TEXT_DIRECTION_AUTO , " " ) ;
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
tag_stack . push_front ( tag ) ;
} else if ( tag = = " br " ) {
2022-04-26 18:57:36 +02:00
// Force a line break.
2016-08-24 04:15:16 +02:00
p_rt - > add_newline ( ) ;
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
} else if ( tag = = " u " ) {
2022-04-26 18:57:36 +02:00
// Use underline.
2016-08-24 04:15:16 +02:00
p_rt - > push_underline ( ) ;
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
tag_stack . push_front ( tag ) ;
} else if ( tag = = " s " ) {
2022-04-26 18:57:36 +02:00
// Use strikethrough.
2019-06-15 18:18:32 +02:00
p_rt - > push_strikethrough ( ) ;
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
tag_stack . push_front ( tag ) ;
2023-10-10 10:30:36 +02:00
} else if ( tag = = " lb " ) {
p_rt - > add_text ( " [ " ) ;
pos = brk_end + 1 ;
} else if ( tag = = " rb " ) {
p_rt - > add_text ( " ] " ) ;
pos = brk_end + 1 ;
2014-02-10 02:10:30 +01:00
} else if ( tag = = " url " ) {
2024-02-12 14:55:02 +01:00
int end = bbcode . find_char ( ' [ ' , brk_end ) ;
2020-05-14 16:41:43 +02:00
if ( end = = - 1 ) {
2016-02-28 03:10:44 +01:00
end = bbcode . length ( ) ;
2020-05-14 16:41:43 +02:00
}
2016-02-28 03:10:44 +01:00
String url = bbcode . substr ( brk_end + 1 , end - brk_end - 1 ) ;
2016-08-24 04:15:16 +02:00
p_rt - > push_meta ( url ) ;
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
tag_stack . push_front ( tag ) ;
} else if ( tag . begins_with ( " url= " ) ) {
String url = tag . substr ( 4 , tag . length ( ) ) ;
2016-08-24 04:15:16 +02:00
p_rt - > push_meta ( url ) ;
2023-02-11 17:33:38 +01:00
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
tag_stack . push_front ( " url " ) ;
2022-12-07 21:40:03 +01:00
} else if ( tag . begins_with ( " img " ) ) {
int width = 0 ;
int height = 0 ;
bool size_in_percent = false ;
if ( tag . length ( ) > 4 ) {
Vector < String > subtags = tag . substr ( 4 , tag . length ( ) ) . split ( " " ) ;
HashMap < String , String > bbcode_options ;
for ( int i = 0 ; i < subtags . size ( ) ; i + + ) {
const String & expr = subtags [ i ] ;
2024-02-12 14:55:02 +01:00
int value_pos = expr . find_char ( ' = ' ) ;
2022-12-07 21:40:03 +01:00
if ( value_pos > - 1 ) {
bbcode_options [ expr . substr ( 0 , value_pos ) ] = expr . substr ( value_pos + 1 ) . unquote ( ) ;
}
}
HashMap < String , String > : : Iterator width_option = bbcode_options . find ( " width " ) ;
if ( width_option ) {
width = width_option - > value . to_int ( ) ;
if ( width_option - > value . ends_with ( " % " ) ) {
size_in_percent = true ;
}
}
HashMap < String , String > : : Iterator height_option = bbcode_options . find ( " height " ) ;
if ( height_option ) {
height = height_option - > value . to_int ( ) ;
if ( height_option - > value . ends_with ( " % " ) ) {
size_in_percent = true ;
}
}
}
2024-02-12 14:55:02 +01:00
int end = bbcode . find_char ( ' [ ' , brk_end ) ;
2020-05-14 16:41:43 +02:00
if ( end = = - 1 ) {
2016-02-28 03:10:44 +01:00
end = bbcode . length ( ) ;
2020-05-14 16:41:43 +02:00
}
2016-02-28 03:10:44 +01:00
String image = bbcode . substr ( brk_end + 1 , end - brk_end - 1 ) ;
2014-02-10 02:10:30 +01:00
2022-12-07 21:40:03 +01:00
p_rt - > add_image ( ResourceLoader : : load ( base_path . path_join ( image ) , " Texture2D " ) , width , height , Color ( 1 , 1 , 1 ) , INLINE_ALIGNMENT_CENTER , Rect2 ( ) , Variant ( ) , false , String ( ) , size_in_percent ) ;
2014-02-10 02:10:30 +01:00
pos = end ;
2022-12-07 21:40:03 +01:00
tag_stack . push_front ( " img " ) ;
2014-02-10 02:10:30 +01:00
} else if ( tag . begins_with ( " color= " ) ) {
String col = tag . substr ( 6 , tag . length ( ) ) ;
2020-11-16 14:31:58 +01:00
Color color = Color : : from_string ( col , Color ( ) ) ;
2016-08-24 04:15:16 +02:00
p_rt - > push_color ( color ) ;
2023-02-11 17:33:38 +01:00
2014-02-10 02:10:30 +01:00
pos = brk_end + 1 ;
tag_stack . push_front ( " color " ) ;
} else if ( tag . begins_with ( " font= " ) ) {
String fnt = tag . substr ( 5 , tag . length ( ) ) ;
2022-08-30 02:34:01 +02:00
Ref < Font > font = ResourceLoader : : load ( base_path . path_join ( fnt ) , " Font " ) ;
2020-05-14 16:41:43 +02:00
if ( font . is_valid ( ) ) {
2016-08-24 04:15:16 +02:00
p_rt - > push_font ( font ) ;
2020-05-14 16:41:43 +02:00
} else {
2016-08-24 04:15:16 +02:00
p_rt - > push_font ( doc_font ) ;
2014-02-10 02:10:30 +01:00
}
pos = brk_end + 1 ;
tag_stack . push_front ( " font " ) ;
} else {
2023-04-21 15:32:26 +02:00
p_rt - > add_text ( " [ " ) ; // ignore
2014-02-10 02:10:30 +01:00
pos = brk_pos + 1 ;
}
}
2016-08-24 04:15:16 +02:00
}
void EditorHelp : : _add_text ( const String & p_bbcode ) {
2023-06-24 18:09:31 +02:00
_add_text_to_rt ( p_bbcode , class_desc , this , edited_class ) ;
2014-02-10 02:10:30 +01:00
}
2023-12-08 12:52:49 +01:00
int EditorHelp : : doc_generation_count = 0 ;
2023-10-20 22:14:04 +02:00
String EditorHelp : : doc_version_hash ;
2023-10-31 18:27:17 +01:00
Thread EditorHelp : : worker_thread ;
2021-07-25 19:44:03 +02:00
void EditorHelp : : _wait_for_thread ( ) {
2023-10-31 18:27:17 +01:00
if ( worker_thread . is_started ( ) ) {
worker_thread . wait_to_finish ( ) ;
2021-07-25 19:44:03 +02:00
}
}
2023-10-20 22:14:04 +02:00
void EditorHelp : : _compute_doc_version_hash ( ) {
uint32_t version_hash = Engine : : get_singleton ( ) - > get_version_info ( ) . hash ( ) ;
doc_version_hash = vformat ( " %d/%d/%d/%s " , version_hash , ClassDB : : get_api_hash ( ClassDB : : API_CORE ) , ClassDB : : get_api_hash ( ClassDB : : API_EDITOR ) , _doc_data_hash ) ;
2023-02-07 21:14:00 +01:00
}
2023-10-20 22:14:04 +02:00
String EditorHelp : : get_cache_full_path ( ) {
return EditorPaths : : get_singleton ( ) - > get_cache_dir ( ) . path_join ( " editor_doc_cache.res " ) ;
2023-04-25 11:40:56 +02:00
}
2023-02-07 21:14:00 +01:00
2023-10-19 00:50:30 +02:00
void EditorHelp : : load_xml_buffer ( const uint8_t * p_buffer , int p_size ) {
if ( ! ext_doc ) {
ext_doc = memnew ( DocTools ) ;
}
ext_doc - > load_xml ( p_buffer , p_size ) ;
if ( doc ) {
doc - > load_xml ( p_buffer , p_size ) ;
}
}
void EditorHelp : : remove_class ( const String & p_class ) {
if ( ext_doc & & ext_doc - > has_doc ( p_class ) ) {
ext_doc - > remove_doc ( p_class ) ;
}
if ( doc & & doc - > has_doc ( p_class ) ) {
doc - > remove_doc ( p_class ) ;
}
}
2023-02-07 21:14:00 +01:00
void EditorHelp : : _load_doc_thread ( void * p_udata ) {
2023-06-23 16:39:51 +02:00
Ref < Resource > cache_res = ResourceLoader : : load ( get_cache_full_path ( ) ) ;
2023-10-20 22:14:04 +02:00
if ( cache_res . is_valid ( ) & & cache_res - > get_meta ( " version_hash " , " " ) = = doc_version_hash ) {
2023-06-23 16:39:51 +02:00
Array classes = cache_res - > get_meta ( " classes " , Array ( ) ) ;
for ( int i = 0 ; i < classes . size ( ) ; i + + ) {
doc - > add_doc ( DocData : : ClassDoc : : from_dict ( classes [ i ] ) ) ;
2023-02-07 21:14:00 +01:00
}
2023-10-31 18:27:17 +01:00
// Extensions' docs are not cached. Generate them now (on the main thread).
callable_mp_static ( & EditorHelp : : _gen_extensions_docs ) . call_deferred ( ) ;
2023-02-07 21:14:00 +01:00
} else {
2023-10-31 18:27:17 +01:00
// We have to go back to the main thread to start from scratch, bypassing any possibly existing cache.
callable_mp_static ( & EditorHelp : : generate_doc ) . bind ( false ) . call_deferred ( ) ;
2023-02-07 21:14:00 +01:00
}
2023-12-08 12:52:49 +01:00
OS : : get_singleton ( ) - > benchmark_end_measure ( " EditorHelp " , vformat ( " Generate Documentation (Run %d) " , doc_generation_count ) ) ;
2023-02-07 21:14:00 +01:00
}
2021-07-25 19:44:03 +02:00
void EditorHelp : : _gen_doc_thread ( void * p_udata ) {
2020-11-29 04:42:06 +01:00
DocTools compdoc ;
2015-11-17 13:46:08 +01:00
compdoc . load_compressed ( _doc_data_compressed , _doc_data_compressed_size , _doc_data_uncompressed_size ) ;
2022-04-26 18:57:36 +02:00
doc - > merge_from ( compdoc ) ; // Ensure all is up to date.
2023-02-07 21:14:00 +01:00
2023-06-23 16:39:51 +02:00
Ref < Resource > cache_res ;
2023-02-07 21:14:00 +01:00
cache_res . instantiate ( ) ;
2023-10-20 22:14:04 +02:00
cache_res - > set_meta ( " version_hash " , doc_version_hash ) ;
2023-02-07 21:14:00 +01:00
Array classes ;
for ( const KeyValue < String , DocData : : ClassDoc > & E : doc - > class_list ) {
2023-10-31 18:27:17 +01:00
if ( ClassDB : : class_exists ( E . value . name ) ) {
ClassDB : : APIType api = ClassDB : : get_api_type ( E . value . name ) ;
if ( api = = ClassDB : : API_EXTENSION | | api = = ClassDB : : API_EDITOR_EXTENSION ) {
continue ;
}
}
2023-02-07 21:14:00 +01:00
classes . push_back ( DocData : : ClassDoc : : to_dict ( E . value ) ) ;
}
2023-06-23 16:39:51 +02:00
cache_res - > set_meta ( " classes " , classes ) ;
2023-02-07 21:14:00 +01:00
Error err = ResourceSaver : : save ( cache_res , get_cache_full_path ( ) , ResourceSaver : : FLAG_COMPRESS ) ;
if ( err ) {
ERR_PRINT ( " Cannot save editor help cache ( " + get_cache_full_path ( ) + " ). " ) ;
}
2023-12-08 12:52:49 +01:00
OS : : get_singleton ( ) - > benchmark_end_measure ( " EditorHelp " , vformat ( " Generate Documentation (Run %d) " , doc_generation_count ) ) ;
2014-02-10 02:10:30 +01:00
}
2023-10-31 18:27:17 +01:00
void EditorHelp : : _gen_extensions_docs ( ) {
doc - > generate ( ( DocTools : : GENERATE_FLAG_SKIP_BASIC_TYPES | DocTools : : GENERATE_FLAG_EXTENSION_CLASSES_ONLY ) ) ;
2023-10-19 00:50:30 +02:00
// Append extra doc data, as it gets overridden by the generation step.
if ( ext_doc ) {
doc - > merge_from ( * ext_doc ) ;
}
2023-10-31 18:27:17 +01:00
}
2023-04-20 14:02:47 +02:00
void EditorHelp : : generate_doc ( bool p_use_cache ) {
2023-12-08 12:52:49 +01:00
doc_generation_count + + ;
OS : : get_singleton ( ) - > benchmark_begin_measure ( " EditorHelp " , vformat ( " Generate Documentation (Run %d) " , doc_generation_count ) ) ;
2023-02-07 21:14:00 +01:00
2023-10-31 18:27:17 +01:00
// In case not the first attempt.
_wait_for_thread ( ) ;
2023-02-07 21:14:00 +01:00
if ( ! doc ) {
doc = memnew ( DocTools ) ;
}
2023-10-20 22:14:04 +02:00
if ( doc_version_hash . is_empty ( ) ) {
_compute_doc_version_hash ( ) ;
}
2023-10-31 18:27:17 +01:00
if ( p_use_cache & & FileAccess : : exists ( get_cache_full_path ( ) ) ) {
worker_thread . start ( _load_doc_thread , nullptr ) ;
2021-07-25 19:44:03 +02:00
} else {
2023-02-07 21:14:00 +01:00
print_verbose ( " Regenerating editor help cache " ) ;
2023-10-31 18:27:17 +01:00
doc - > generate ( ) ;
worker_thread . start ( _gen_doc_thread , nullptr ) ;
2021-07-25 19:44:03 +02:00
}
}
2021-09-14 11:17:47 +02:00
void EditorHelp : : _toggle_scripts_pressed ( ) {
ScriptEditor : : get_singleton ( ) - > toggle_scripts_panel ( ) ;
update_toggle_scripts_button ( ) ;
}
2015-11-17 13:46:08 +01:00
void EditorHelp : : _notification ( int p_what ) {
switch ( p_what ) {
2023-02-11 16:29:44 +01:00
case NOTIFICATION_POSTINITIALIZE : {
// Requires theme to be up to date.
_class_desc_resized ( false ) ;
} break ;
2017-09-02 19:16:31 +02:00
case EditorSettings : : NOTIFICATION_EDITOR_SETTINGS_CHANGED : {
2022-11-23 00:14:08 +01:00
if ( ! EditorSettings : : get_singleton ( ) - > check_changed_settings_in_group ( " text_editor/help " ) ) {
break ;
}
[[fallthrough]] ;
}
case NOTIFICATION_READY : {
2021-07-25 19:44:03 +02:00
_wait_for_thread ( ) ;
2019-08-09 06:00:44 +02:00
_update_doc ( ) ;
2017-09-02 19:16:31 +02:00
} break ;
2022-02-16 00:52:32 +01:00
2019-10-15 08:54:28 +02:00
case NOTIFICATION_THEME_CHANGED : {
2022-08-29 11:04:31 +02:00
if ( is_inside_tree ( ) ) {
_class_desc_resized ( true ) ;
}
2021-09-14 11:17:47 +02:00
update_toggle_scripts_button ( ) ;
2019-10-15 08:54:28 +02:00
} break ;
2022-02-16 00:52:32 +01:00
case NOTIFICATION_VISIBILITY_CHANGED : {
2021-09-14 11:17:47 +02:00
update_toggle_scripts_button ( ) ;
2022-02-16 00:52:32 +01:00
} break ;
2014-02-10 02:10:30 +01:00
}
2015-11-17 13:46:08 +01:00
}
2014-02-10 02:10:30 +01:00
2015-11-17 13:46:08 +01:00
void EditorHelp : : go_to_help ( const String & p_help ) {
2021-07-25 19:44:03 +02:00
_wait_for_thread ( ) ;
2015-11-17 13:46:08 +01:00
_help_callback ( p_help ) ;
2014-02-10 02:10:30 +01:00
}
2023-04-21 15:32:26 +02:00
void EditorHelp : : go_to_class ( const String & p_class ) {
2021-07-25 19:44:03 +02:00
_wait_for_thread ( ) ;
2023-04-21 15:32:26 +02:00
_goto_desc ( p_class ) ;
2015-11-17 13:46:08 +01:00
}
2014-02-16 01:16:33 +01:00
2020-11-29 03:37:57 +01:00
void EditorHelp : : update_doc ( ) {
2021-07-25 19:44:03 +02:00
_wait_for_thread ( ) ;
2020-11-29 03:37:57 +01:00
ERR_FAIL_COND ( ! doc - > class_list . has ( edited_class ) ) ;
ERR_FAIL_COND ( ! doc - > class_list [ edited_class ] . is_script_doc ) ;
_update_doc ( ) ;
}
2021-07-25 19:44:03 +02:00
void EditorHelp : : cleanup_doc ( ) {
_wait_for_thread ( ) ;
memdelete ( doc ) ;
}
2020-03-17 07:33:00 +01:00
Vector < Pair < String , int > > EditorHelp : : get_sections ( ) {
2021-07-25 19:44:03 +02:00
_wait_for_thread ( ) ;
2020-03-17 07:33:00 +01:00
Vector < Pair < String , int > > sections ;
2017-09-14 02:56:37 +02:00
for ( int i = 0 ; i < section_line . size ( ) ; i + + ) {
sections . push_back ( Pair < String , int > ( section_line [ i ] . first , i ) ) ;
}
return sections ;
}
void EditorHelp : : scroll_to_section ( int p_section_index ) {
2021-07-25 19:44:03 +02:00
_wait_for_thread ( ) ;
2017-09-14 02:56:37 +02:00
int line = section_line [ p_section_index ] . second ;
2022-05-30 09:04:07 +02:00
if ( class_desc - > is_ready ( ) ) {
class_desc - > scroll_to_paragraph ( line ) ;
} else {
scroll_to = line ;
}
2017-09-14 02:56:37 +02:00
}
2015-11-17 13:46:08 +01:00
void EditorHelp : : popup_search ( ) {
2021-07-25 19:44:03 +02:00
_wait_for_thread ( ) ;
2017-12-22 19:09:31 +01:00
find_bar - > popup_search ( ) ;
2015-11-17 13:46:08 +01:00
}
2014-02-10 02:10:30 +01:00
2017-01-03 03:03:46 +01:00
String EditorHelp : : get_class ( ) {
2015-11-17 13:46:08 +01:00
return edited_class ;
}
2014-02-10 02:10:30 +01:00
2019-10-09 17:41:49 +02:00
void EditorHelp : : search_again ( bool p_search_previous ) {
_search ( p_search_previous ) ;
2015-11-17 13:46:08 +01:00
}
2014-02-10 02:10:30 +01:00
2015-11-17 13:46:08 +01:00
int EditorHelp : : get_scroll ( ) const {
2021-11-30 17:46:36 +01:00
return class_desc - > get_v_scroll_bar ( ) - > get_value ( ) ;
2014-02-10 02:10:30 +01:00
}
2020-05-14 14:29:06 +02:00
2015-11-17 13:46:08 +01:00
void EditorHelp : : set_scroll ( int p_scroll ) {
2021-11-30 17:46:36 +01:00
class_desc - > get_v_scroll_bar ( ) - > set_value ( p_scroll ) ;
2014-02-10 02:10:30 +01:00
}
2021-09-14 11:17:47 +02:00
void EditorHelp : : update_toggle_scripts_button ( ) {
if ( is_layout_rtl ( ) ) {
2023-08-13 02:33:39 +02:00
toggle_scripts_button - > set_icon ( get_editor_theme_icon ( ScriptEditor : : get_singleton ( ) - > is_scripts_panel_toggled ( ) ? SNAME ( " Forward " ) : SNAME ( " Back " ) ) ) ;
2021-09-14 11:17:47 +02:00
} else {
2023-08-13 02:33:39 +02:00
toggle_scripts_button - > set_icon ( get_editor_theme_icon ( ScriptEditor : : get_singleton ( ) - > is_scripts_panel_toggled ( ) ? SNAME ( " Back " ) : SNAME ( " Forward " ) ) ) ;
2021-09-14 11:17:47 +02:00
}
2022-08-25 12:42:17 +02:00
toggle_scripts_button - > set_tooltip_text ( vformat ( " %s (%s) " , TTR ( " Toggle Scripts Panel " ) , ED_GET_SHORTCUT ( " script_editor/toggle_scripts_panel " ) - > get_as_text ( ) ) ) ;
2021-09-14 11:17:47 +02:00
}
2014-02-10 02:10:30 +01:00
void EditorHelp : : _bind_methods ( ) {
2017-01-03 03:03:46 +01:00
ClassDB : : bind_method ( " _class_list_select " , & EditorHelp : : _class_list_select ) ;
ClassDB : : bind_method ( " _request_help " , & EditorHelp : : _request_help ) ;
ClassDB : : bind_method ( " _search " , & EditorHelp : : _search ) ;
ClassDB : : bind_method ( " _help_callback " , & EditorHelp : : _help_callback ) ;
2014-02-10 02:10:30 +01:00
2015-11-17 13:46:08 +01:00
ADD_SIGNAL ( MethodInfo ( " go_to_help " ) ) ;
2014-02-10 02:10:30 +01:00
}
2023-10-19 00:50:30 +02:00
void EditorHelp : : init_gdext_pointers ( ) {
GDExtensionEditorHelp : : editor_help_load_xml_buffer = & EditorHelp : : load_xml_buffer ;
GDExtensionEditorHelp : : editor_help_remove_class = & EditorHelp : : remove_class ;
}
2015-11-17 13:46:08 +01:00
EditorHelp : : EditorHelp ( ) {
2017-12-18 18:46:17 +01:00
set_custom_minimum_size ( Size2 ( 150 * EDSCALE , 0 ) ) ;
2014-02-10 02:10:30 +01:00
2017-01-05 23:41:36 +01:00
EDITOR_DEF ( " text_editor/help/sort_functions_alphabetically " , true ) ;
2014-02-10 02:10:30 +01:00
2017-12-18 18:46:17 +01:00
class_desc = memnew ( RichTextLabel ) ;
2024-01-17 15:22:43 +01:00
class_desc - > set_tab_size ( 8 ) ;
2017-12-18 18:46:17 +01:00
add_child ( class_desc ) ;
2022-05-18 09:17:55 +02:00
class_desc - > set_threaded ( true ) ;
2017-12-18 18:46:17 +01:00
class_desc - > set_v_size_flags ( SIZE_EXPAND_FILL ) ;
2019-06-05 20:47:34 +02:00
2022-05-30 09:04:07 +02:00
class_desc - > connect ( " finished " , callable_mp ( this , & EditorHelp : : _class_desc_finished ) ) ;
2020-02-21 18:28:45 +01:00
class_desc - > connect ( " meta_clicked " , callable_mp ( this , & EditorHelp : : _class_desc_select ) ) ;
class_desc - > connect ( " gui_input " , callable_mp ( this , & EditorHelp : : _class_desc_input ) ) ;
2022-07-28 22:56:41 +02:00
class_desc - > connect ( " resized " , callable_mp ( this , & EditorHelp : : _class_desc_resized ) . bind ( false ) ) ;
2014-02-10 02:10:30 +01:00
2019-02-10 17:17:29 +01:00
// Added second so it opens at the bottom so it won't offset the entire widget.
2019-01-31 15:24:33 +01:00
find_bar = memnew ( FindBar ) ;
add_child ( find_bar ) ;
find_bar - > hide ( ) ;
2017-12-22 19:09:31 +01:00
find_bar - > set_rich_text_label ( class_desc ) ;
2021-09-14 11:17:47 +02:00
status_bar = memnew ( HBoxContainer ) ;
add_child ( status_bar ) ;
status_bar - > set_h_size_flags ( SIZE_EXPAND_FILL ) ;
status_bar - > set_custom_minimum_size ( Size2 ( 0 , 24 * EDSCALE ) ) ;
toggle_scripts_button = memnew ( Button ) ;
toggle_scripts_button - > set_flat ( true ) ;
toggle_scripts_button - > connect ( " pressed " , callable_mp ( this , & EditorHelp : : _toggle_scripts_pressed ) ) ;
status_bar - > add_child ( toggle_scripts_button ) ;
2014-02-10 02:10:30 +01:00
class_desc - > set_selection_enabled ( true ) ;
2023-02-28 14:19:48 +01:00
class_desc - > set_context_menu_enabled ( true ) ;
2015-11-17 13:46:08 +01:00
2014-02-10 02:10:30 +01:00
class_desc - > hide ( ) ;
}
2015-11-17 13:46:08 +01:00
EditorHelp : : ~ EditorHelp ( ) {
2014-02-10 02:10:30 +01:00
}
2021-07-25 19:44:03 +02:00
DocTools * EditorHelp : : get_doc_data ( ) {
_wait_for_thread ( ) ;
return doc ;
}
2023-09-21 04:54:51 +02:00
/// EditorHelpBit ///
2022-02-02 14:10:15 +01:00
2024-02-12 14:55:02 +01:00
void EditorHelpBit : : _go_to_help ( const String & p_what ) {
2016-08-24 04:15:16 +02:00
EditorNode : : get_singleton ( ) - > set_visible_editor ( EditorNode : : EDITOR_SCRIPT ) ;
ScriptEditor : : get_singleton ( ) - > goto_help ( p_what ) ;
2021-07-17 23:22:52 +02:00
emit_signal ( SNAME ( " request_hide " ) ) ;
2016-08-24 04:15:16 +02:00
}
2024-02-12 14:55:02 +01:00
void EditorHelpBit : : _meta_clicked ( const String & p_select ) {
2023-04-21 15:32:26 +02:00
if ( p_select . begins_with ( " $ " ) ) { // enum
2017-08-24 00:10:32 +02:00
String select = p_select . substr ( 1 , p_select . length ( ) ) ;
String class_name ;
2023-04-21 15:32:26 +02:00
int rfind = select . rfind ( " . " ) ;
if ( rfind ! = - 1 ) {
class_name = select . substr ( 0 , rfind ) ;
select = select . substr ( rfind + 1 ) ;
2017-08-24 00:10:32 +02:00
} else {
2023-04-21 15:32:26 +02:00
class_name = " @GlobalScope " ;
2017-08-24 00:10:32 +02:00
}
_go_to_help ( " class_enum: " + class_name + " : " + select ) ;
return ;
} else if ( p_select . begins_with ( " # " ) ) {
2016-08-24 04:15:16 +02:00
_go_to_help ( " class_name: " + p_select . substr ( 1 , p_select . length ( ) ) ) ;
return ;
} else if ( p_select . begins_with ( " @ " ) ) {
String m = p_select . substr ( 1 , p_select . length ( ) ) ;
2022-02-03 17:03:38 +01:00
if ( m . contains ( " . " ) ) {
2022-04-26 18:57:36 +02:00
_go_to_help ( " class_method: " + m . get_slice ( " . " , 0 ) + " : " + m . get_slice ( " . " , 0 ) ) ; // Must go somewhere else.
2020-05-14 16:41:43 +02:00
}
2016-08-24 04:15:16 +02:00
}
}
2023-09-21 04:54:51 +02:00
String EditorHelpBit : : get_class_description ( const StringName & p_class_name ) const {
if ( doc_class_cache . has ( p_class_name ) ) {
return doc_class_cache [ p_class_name ] ;
}
String description ;
HashMap < String , DocData : : ClassDoc > : : ConstIterator E = EditorHelp : : get_doc_data ( ) - > class_list . find ( p_class_name ) ;
if ( E ) {
// Non-native class shouldn't be cached, nor translated.
bool is_native = ClassDB : : class_exists ( p_class_name ) ;
description = is_native ? DTR ( E - > value . brief_description ) : E - > value . brief_description ;
if ( is_native ) {
doc_class_cache [ p_class_name ] = description ;
}
}
return description ;
}
String EditorHelpBit : : get_property_description ( const StringName & p_class_name , const StringName & p_property_name ) const {
2023-12-06 23:10:32 +01:00
if ( ! custom_description . is_empty ( ) ) {
return custom_description ;
}
2023-09-21 04:54:51 +02:00
if ( doc_property_cache . has ( p_class_name ) & & doc_property_cache [ p_class_name ] . has ( p_property_name ) ) {
return doc_property_cache [ p_class_name ] [ p_property_name ] ;
}
String description ;
// Non-native properties shouldn't be cached, nor translated.
bool is_native = ClassDB : : class_exists ( p_class_name ) ;
DocTools * dd = EditorHelp : : get_doc_data ( ) ;
HashMap < String , DocData : : ClassDoc > : : ConstIterator E = dd - > class_list . find ( p_class_name ) ;
if ( E ) {
2024-02-16 14:28:05 +01:00
for ( const DocData : : PropertyDoc & property : E - > value . properties ) {
String description_current = is_native ? DTR ( property . description ) : property . description ;
2023-09-21 04:54:51 +02:00
2024-02-16 14:28:05 +01:00
const Vector < String > class_enum = property . enumeration . split ( " . " ) ;
2023-09-21 04:54:51 +02:00
const String enum_name = class_enum . size ( ) > = 2 ? class_enum [ 1 ] : " " ;
if ( ! enum_name . is_empty ( ) ) {
// Classes can use enums from other classes, so check from which it came.
HashMap < String , DocData : : ClassDoc > : : ConstIterator enum_class = dd - > class_list . find ( class_enum [ 0 ] ) ;
if ( enum_class ) {
for ( DocData : : ConstantDoc val : enum_class - > value . constants ) {
// Don't display `_MAX` enum value descriptions, as these are never exposed in the inspector.
if ( val . enumeration = = enum_name & & ! val . name . ends_with ( " _MAX " ) ) {
const String enum_value = EditorPropertyNameProcessor : : get_singleton ( ) - > process_name ( val . name , EditorPropertyNameProcessor : : STYLE_CAPITALIZED ) ;
const String enum_prefix = EditorPropertyNameProcessor : : get_singleton ( ) - > process_name ( enum_name , EditorPropertyNameProcessor : : STYLE_CAPITALIZED ) + " " ;
const String enum_description = is_native ? DTR ( val . description ) : val . description ;
// Prettify the enum value display, so that "<ENUM NAME>_<VALUE>" becomes "Value".
description_current = description_current . trim_prefix ( " \n " ) + vformat ( " \n [b]%s:[/b] %s " , enum_value . trim_prefix ( enum_prefix ) , enum_description . is_empty ( ) ? ( " [i] " + DTR ( " No description available. " ) + " [/i] " ) : enum_description ) ;
}
}
}
}
2024-02-16 14:28:05 +01:00
if ( property . name = = p_property_name ) {
2023-09-21 04:54:51 +02:00
description = description_current ;
if ( ! is_native ) {
break ;
}
}
if ( is_native ) {
2024-02-16 14:28:05 +01:00
doc_property_cache [ p_class_name ] [ property . name ] = description_current ;
2023-09-21 04:54:51 +02:00
}
}
}
return description ;
}
String EditorHelpBit : : get_method_description ( const StringName & p_class_name , const StringName & p_method_name ) const {
if ( doc_method_cache . has ( p_class_name ) & & doc_method_cache [ p_class_name ] . has ( p_method_name ) ) {
return doc_method_cache [ p_class_name ] [ p_method_name ] ;
}
String description ;
HashMap < String , DocData : : ClassDoc > : : ConstIterator E = EditorHelp : : get_doc_data ( ) - > class_list . find ( p_class_name ) ;
if ( E ) {
// Non-native methods shouldn't be cached, nor translated.
bool is_native = ClassDB : : class_exists ( p_class_name ) ;
2024-02-16 14:28:05 +01:00
for ( const DocData : : MethodDoc & method : E - > value . methods ) {
String description_current = is_native ? DTR ( method . description ) : method . description ;
2023-09-21 04:54:51 +02:00
2024-02-16 14:28:05 +01:00
if ( method . name = = p_method_name ) {
2023-09-21 04:54:51 +02:00
description = description_current ;
if ( ! is_native ) {
break ;
}
}
if ( is_native ) {
2024-02-16 14:28:05 +01:00
doc_method_cache [ p_class_name ] [ method . name ] = description_current ;
2023-09-21 04:54:51 +02:00
}
}
}
return description ;
}
String EditorHelpBit : : get_signal_description ( const StringName & p_class_name , const StringName & p_signal_name ) const {
if ( doc_signal_cache . has ( p_class_name ) & & doc_signal_cache [ p_class_name ] . has ( p_signal_name ) ) {
return doc_signal_cache [ p_class_name ] [ p_signal_name ] ;
}
String description ;
HashMap < String , DocData : : ClassDoc > : : ConstIterator E = EditorHelp : : get_doc_data ( ) - > class_list . find ( p_class_name ) ;
if ( E ) {
// Non-native signals shouldn't be cached, nor translated.
bool is_native = ClassDB : : class_exists ( p_class_name ) ;
2024-02-16 14:28:05 +01:00
for ( const DocData : : MethodDoc & signal : E - > value . signals ) {
String description_current = is_native ? DTR ( signal . description ) : signal . description ;
2023-09-21 04:54:51 +02:00
2024-02-16 14:28:05 +01:00
if ( signal . name = = p_signal_name ) {
2023-09-21 04:54:51 +02:00
description = description_current ;
if ( ! is_native ) {
break ;
}
}
if ( is_native ) {
2024-02-16 14:28:05 +01:00
doc_signal_cache [ p_class_name ] [ signal . name ] = description_current ;
2023-09-21 04:54:51 +02:00
}
}
}
return description ;
}
String EditorHelpBit : : get_theme_item_description ( const StringName & p_class_name , const StringName & p_theme_item_name ) const {
if ( doc_theme_item_cache . has ( p_class_name ) & & doc_theme_item_cache [ p_class_name ] . has ( p_theme_item_name ) ) {
return doc_theme_item_cache [ p_class_name ] [ p_theme_item_name ] ;
}
String description ;
bool found = false ;
DocTools * dd = EditorHelp : : get_doc_data ( ) ;
HashMap < String , DocData : : ClassDoc > : : ConstIterator E = dd - > class_list . find ( p_class_name ) ;
while ( E ) {
// Non-native theme items shouldn't be cached, nor translated.
bool is_native = ClassDB : : class_exists ( p_class_name ) ;
2024-02-16 14:28:05 +01:00
for ( const DocData : : ThemeItemDoc & theme_item : E - > value . theme_properties ) {
String description_current = is_native ? DTR ( theme_item . description ) : theme_item . description ;
2023-09-21 04:54:51 +02:00
2024-02-16 14:28:05 +01:00
if ( theme_item . name = = p_theme_item_name ) {
2023-09-21 04:54:51 +02:00
description = description_current ;
found = true ;
if ( ! is_native ) {
break ;
}
}
if ( is_native ) {
2024-02-16 14:28:05 +01:00
doc_theme_item_cache [ p_class_name ] [ theme_item . name ] = description_current ;
2023-09-21 04:54:51 +02:00
}
}
if ( found | | E - > value . inherits . is_empty ( ) ) {
break ;
}
// Check for inherited theme items.
E = dd - > class_list . find ( E - > value . inherits ) ;
}
return description ;
}
2016-08-24 04:15:16 +02:00
void EditorHelpBit : : _bind_methods ( ) {
2018-07-20 23:14:33 +02:00
ClassDB : : bind_method ( D_METHOD ( " set_text " , " text " ) , & EditorHelpBit : : set_text ) ;
2016-08-24 04:15:16 +02:00
ADD_SIGNAL ( MethodInfo ( " request_hide " ) ) ;
}
void EditorHelpBit : : _notification ( int p_what ) {
2017-09-02 19:16:31 +02:00
switch ( p_what ) {
2022-01-18 21:01:30 +01:00
case NOTIFICATION_THEME_CHANGED : {
2022-02-08 10:14:58 +01:00
rich_text - > add_theme_color_override ( " selection_color " , get_theme_color ( SNAME ( " selection_color " ) , SNAME ( " EditorHelp " ) ) ) ;
2020-03-20 21:51:53 +01:00
rich_text - > clear ( ) ;
2022-09-06 15:08:40 +02:00
_add_text_to_rt ( text , rich_text , this ) ;
2022-02-02 14:10:15 +01:00
rich_text - > reset_size ( ) ; // Force recalculating size after parsing bbcode.
2020-03-20 21:51:53 +01:00
} break ;
2017-09-02 19:16:31 +02:00
}
2016-08-24 04:15:16 +02:00
}
void EditorHelpBit : : set_text ( const String & p_text ) {
2020-03-20 21:51:53 +01:00
text = p_text ;
2016-08-24 04:15:16 +02:00
rich_text - > clear ( ) ;
2022-09-06 15:08:40 +02:00
_add_text_to_rt ( text , rich_text , this ) ;
2016-08-24 04:15:16 +02:00
}
EditorHelpBit : : EditorHelpBit ( ) {
rich_text = memnew ( RichTextLabel ) ;
add_child ( rich_text ) ;
2020-02-21 18:28:45 +01:00
rich_text - > connect ( " meta_clicked " , callable_mp ( this , & EditorHelpBit : : _meta_clicked ) ) ;
2023-01-13 15:17:26 +01:00
rich_text - > set_fit_content ( true ) ;
2022-02-02 14:10:15 +01:00
set_custom_minimum_size ( Size2 ( 0 , 50 * EDSCALE ) ) ;
2016-08-24 04:15:16 +02:00
}
2017-12-22 19:09:31 +01:00
2023-09-21 04:54:51 +02:00
/// EditorHelpTooltip ///
void EditorHelpTooltip : : _notification ( int p_what ) {
switch ( p_what ) {
case NOTIFICATION_POSTINITIALIZE : {
if ( ! tooltip_text . is_empty ( ) ) {
parse_tooltip ( tooltip_text ) ;
}
} break ;
}
}
// `p_text` is expected to be something like these:
// - `class|Control||`;
// - `property|Control|size|`;
2023-10-10 10:30:36 +02:00
// - `signal|Control|gui_input|(event: InputEvent)`.
2023-09-21 04:54:51 +02:00
void EditorHelpTooltip : : parse_tooltip ( const String & p_text ) {
tooltip_text = p_text ;
PackedStringArray slices = p_text . split ( " | " , true , 3 ) ;
ERR_FAIL_COND_MSG ( slices . size ( ) < 4 , " Invalid tooltip formatting. The expect string should be formatted as 'type|class|property|args'. " ) ;
2023-11-18 23:40:56 +01:00
const String & type = slices [ 0 ] ;
const String & class_name = slices [ 1 ] ;
const String & property_name = slices [ 2 ] ;
const String & property_args = slices [ 3 ] ;
2023-09-21 04:54:51 +02:00
2024-01-26 20:42:20 +01:00
String formatted_text ;
// Exclude internal properties, they are not documented.
if ( type = = " internal_property " ) {
formatted_text = " [i] " + TTR ( " This property can only be set in the Inspector. " ) + " [/i] " ;
set_text ( formatted_text ) ;
return ;
}
2023-09-21 04:54:51 +02:00
String title ;
String description ;
if ( type = = " class " ) {
title = class_name ;
description = get_class_description ( class_name ) ;
formatted_text = TTR ( " Class: " ) ;
} else {
title = property_name ;
if ( type = = " property " ) {
description = get_property_description ( class_name , property_name ) ;
2023-10-07 03:08:16 +02:00
if ( property_name . begins_with ( " metadata/ " ) ) {
formatted_text = TTR ( " Metadata: " ) ;
} else {
formatted_text = TTR ( " Property: " ) ;
}
2023-09-21 04:54:51 +02:00
} else if ( type = = " method " ) {
description = get_method_description ( class_name , property_name ) ;
formatted_text = TTR ( " Method: " ) ;
} else if ( type = = " signal " ) {
description = get_signal_description ( class_name , property_name ) ;
formatted_text = TTR ( " Signal: " ) ;
} else if ( type = = " theme_item " ) {
description = get_theme_item_description ( class_name , property_name ) ;
2024-02-12 14:55:02 +01:00
formatted_text = TTR ( " Theme Property: " ) ;
2023-09-21 04:54:51 +02:00
} else {
ERR_FAIL_MSG ( " Invalid tooltip type ' " + type + " '. Valid types are 'class', 'property', 'method', 'signal', and 'theme_item'. " ) ;
}
}
2023-10-07 03:08:16 +02:00
// Metadata special handling replaces "Property:" with "Metadata": above.
2023-10-10 10:30:36 +02:00
formatted_text + = " [u][b] " + title . trim_prefix ( " metadata/ " ) + " [/b][/u] " + property_args . replace ( " [ " , " [lb] " ) + " \n " ;
2023-09-21 04:54:51 +02:00
formatted_text + = description . is_empty ( ) ? " [i] " + TTR ( " No description available. " ) + " [/i] " : description ;
set_text ( formatted_text ) ;
}
2023-12-06 23:10:32 +01:00
EditorHelpTooltip : : EditorHelpTooltip ( const String & p_text , const String & p_custom_description ) {
2023-09-21 04:54:51 +02:00
tooltip_text = p_text ;
2023-12-06 23:10:32 +01:00
custom_description = p_custom_description ;
2023-09-21 04:54:51 +02:00
get_rich_text ( ) - > set_custom_minimum_size ( Size2 ( 360 * EDSCALE , 0 ) ) ;
}
/// FindBar ///
2022-02-02 14:10:15 +01:00
2017-12-22 19:09:31 +01:00
FindBar : : FindBar ( ) {
search_text = memnew ( LineEdit ) ;
2019-02-10 17:17:29 +01:00
add_child ( search_text ) ;
2017-12-22 19:09:31 +01:00
search_text - > set_custom_minimum_size ( Size2 ( 100 * EDSCALE , 0 ) ) ;
2019-02-10 17:17:29 +01:00
search_text - > set_h_size_flags ( SIZE_EXPAND_FILL ) ;
2020-02-21 18:28:45 +01:00
search_text - > connect ( " text_changed " , callable_mp ( this , & FindBar : : _search_text_changed ) ) ;
2021-06-16 18:43:34 +02:00
search_text - > connect ( " text_submitted " , callable_mp ( this , & FindBar : : _search_text_submitted ) ) ;
2017-12-22 19:09:31 +01:00
2019-08-09 06:00:44 +02:00
matches_label = memnew ( Label ) ;
add_child ( matches_label ) ;
matches_label - > hide ( ) ;
2020-06-19 20:49:04 +02:00
find_prev = memnew ( Button ) ;
find_prev - > set_flat ( true ) ;
2019-02-10 17:17:29 +01:00
add_child ( find_prev ) ;
2017-12-22 19:09:31 +01:00
find_prev - > set_focus_mode ( FOCUS_NONE ) ;
2020-02-21 18:28:45 +01:00
find_prev - > connect ( " pressed " , callable_mp ( this , & FindBar : : search_prev ) ) ;
2017-12-22 19:09:31 +01:00
2020-06-19 20:49:04 +02:00
find_next = memnew ( Button ) ;
find_next - > set_flat ( true ) ;
2019-02-10 17:17:29 +01:00
add_child ( find_next ) ;
2017-12-22 19:09:31 +01:00
find_next - > set_focus_mode ( FOCUS_NONE ) ;
2020-02-21 18:28:45 +01:00
find_next - > connect ( " pressed " , callable_mp ( this , & FindBar : : search_next ) ) ;
2017-12-22 19:09:31 +01:00
2019-08-09 06:00:44 +02:00
Control * space = memnew ( Control ) ;
add_child ( space ) ;
space - > set_custom_minimum_size ( Size2 ( 4 , 0 ) * EDSCALE ) ;
2017-12-22 19:09:31 +01:00
hide_button = memnew ( TextureButton ) ;
add_child ( hide_button ) ;
hide_button - > set_focus_mode ( FOCUS_NONE ) ;
2022-02-05 02:11:32 +01:00
hide_button - > set_ignore_texture_size ( true ) ;
2017-12-22 19:09:31 +01:00
hide_button - > set_stretch_mode ( TextureButton : : STRETCH_KEEP_CENTERED ) ;
2020-02-21 18:28:45 +01:00
hide_button - > connect ( " pressed " , callable_mp ( this , & FindBar : : _hide_bar ) ) ;
2017-12-22 19:09:31 +01:00
}
void FindBar : : popup_search ( ) {
show ( ) ;
2018-05-16 16:43:00 +02:00
bool grabbed_focus = false ;
if ( ! search_text - > has_focus ( ) ) {
search_text - > grab_focus ( ) ;
grabbed_focus = true ;
}
2020-12-15 13:04:21 +01:00
if ( ! search_text - > get_text ( ) . is_empty ( ) ) {
2018-05-16 16:43:00 +02:00
search_text - > select_all ( ) ;
2021-03-28 20:31:25 +02:00
search_text - > set_caret_column ( search_text - > get_text ( ) . length ( ) ) ;
2018-05-16 16:43:00 +02:00
if ( grabbed_focus ) {
_search ( ) ;
}
}
2017-12-22 19:09:31 +01:00
}
void FindBar : : _notification ( int p_what ) {
2019-08-09 06:00:44 +02:00
switch ( p_what ) {
case NOTIFICATION_THEME_CHANGED : {
2023-08-13 02:33:39 +02:00
find_prev - > set_icon ( get_editor_theme_icon ( SNAME ( " MoveUp " ) ) ) ;
find_next - > set_icon ( get_editor_theme_icon ( SNAME ( " MoveDown " ) ) ) ;
hide_button - > set_texture_normal ( get_editor_theme_icon ( SNAME ( " Close " ) ) ) ;
hide_button - > set_texture_hover ( get_editor_theme_icon ( SNAME ( " Close " ) ) ) ;
hide_button - > set_texture_pressed ( get_editor_theme_icon ( SNAME ( " Close " ) ) ) ;
2022-11-07 09:09:13 +01:00
hide_button - > set_custom_minimum_size ( hide_button - > get_texture_normal ( ) - > get_size ( ) ) ;
2023-08-13 02:33:39 +02:00
matches_label - > add_theme_color_override ( " font_color " , results_count > 0 ? get_theme_color ( SNAME ( " font_color " ) , SNAME ( " Label " ) ) : get_theme_color ( SNAME ( " error_color " ) , EditorStringName ( Editor ) ) ) ;
2019-08-09 06:00:44 +02:00
} break ;
2022-02-16 00:52:32 +01:00
2019-08-09 06:00:44 +02:00
case NOTIFICATION_VISIBILITY_CHANGED : {
set_process_unhandled_input ( is_visible_in_tree ( ) ) ;
} break ;
2017-12-22 19:09:31 +01:00
}
}
void FindBar : : set_rich_text_label ( RichTextLabel * p_rich_text_label ) {
rich_text_label = p_rich_text_label ;
}
bool FindBar : : search_next ( ) {
return _search ( ) ;
}
bool FindBar : : search_prev ( ) {
return _search ( true ) ;
}
bool FindBar : : _search ( bool p_search_previous ) {
String stext = search_text - > get_text ( ) ;
bool keep = prev_search = = stext ;
bool ret = rich_text_label - > search ( stext , keep , p_search_previous ) ;
prev_search = stext ;
if ( ret ) {
2019-08-09 06:00:44 +02:00
_update_results_count ( ) ;
2017-12-22 19:09:31 +01:00
} else {
2019-08-09 06:00:44 +02:00
results_count = 0 ;
2017-12-22 19:09:31 +01:00
}
2019-08-09 06:00:44 +02:00
_update_matches_label ( ) ;
2017-12-22 19:09:31 +01:00
return ret ;
}
2019-08-09 06:00:44 +02:00
void FindBar : : _update_results_count ( ) {
results_count = 0 ;
String searched = search_text - > get_text ( ) ;
2020-12-15 13:04:21 +01:00
if ( searched . is_empty ( ) ) {
2019-08-09 06:00:44 +02:00
return ;
2020-05-14 16:41:43 +02:00
}
2019-08-09 06:00:44 +02:00
2021-10-01 17:36:37 +02:00
String full_text = rich_text_label - > get_parsed_text ( ) ;
2019-08-09 06:00:44 +02:00
int from_pos = 0 ;
while ( true ) {
2021-06-16 18:43:34 +02:00
int pos = full_text . findn ( searched , from_pos ) ;
2020-05-14 16:41:43 +02:00
if ( pos = = - 1 ) {
2019-08-09 06:00:44 +02:00
break ;
2020-05-14 16:41:43 +02:00
}
2019-08-09 06:00:44 +02:00
results_count + + ;
from_pos = pos + searched . length ( ) ;
}
}
void FindBar : : _update_matches_label ( ) {
2020-12-15 13:04:21 +01:00
if ( search_text - > get_text ( ) . is_empty ( ) | | results_count = = - 1 ) {
2019-08-09 06:00:44 +02:00
matches_label - > hide ( ) ;
} else {
matches_label - > show ( ) ;
2023-08-13 02:33:39 +02:00
matches_label - > add_theme_color_override ( " font_color " , results_count > 0 ? get_theme_color ( SNAME ( " font_color " ) , SNAME ( " Label " ) ) : get_theme_color ( SNAME ( " error_color " ) , EditorStringName ( Editor ) ) ) ;
2019-08-09 08:47:09 +02:00
matches_label - > set_text ( vformat ( results_count = = 1 ? TTR ( " %d match. " ) : TTR ( " %d matches. " ) , results_count ) ) ;
2019-08-09 06:00:44 +02:00
}
2017-12-22 19:09:31 +01:00
}
void FindBar : : _hide_bar ( ) {
2020-05-14 16:41:43 +02:00
if ( search_text - > has_focus ( ) ) {
2017-12-22 19:09:31 +01:00
rich_text_label - > grab_focus ( ) ;
2020-05-14 16:41:43 +02:00
}
2017-12-22 19:09:31 +01:00
hide ( ) ;
}
2021-08-22 17:37:22 +02:00
void FindBar : : unhandled_input ( const Ref < InputEvent > & p_event ) {
2021-04-05 08:52:21 +02:00
ERR_FAIL_COND ( p_event . is_null ( ) ) ;
2017-12-22 19:09:31 +01:00
Ref < InputEventKey > k = p_event ;
2023-05-21 02:26:13 +02:00
if ( k . is_valid ( ) & & k - > is_action_pressed ( SNAME ( " ui_cancel " ) , false , true ) ) {
if ( rich_text_label - > has_focus ( ) | | is_ancestor_of ( get_viewport ( ) - > gui_get_focus_owner ( ) ) ) {
_hide_bar ( ) ;
accept_event ( ) ;
2017-12-22 19:09:31 +01:00
}
}
}
void FindBar : : _search_text_changed ( const String & p_text ) {
search_next ( ) ;
}
2021-06-16 18:43:34 +02:00
void FindBar : : _search_text_submitted ( const String & p_text ) {
2021-08-13 23:31:57 +02:00
if ( Input : : get_singleton ( ) - > is_key_pressed ( Key : : SHIFT ) ) {
2019-09-08 15:09:52 +02:00
search_prev ( ) ;
} else {
search_next ( ) ;
}
2017-12-22 19:09:31 +01:00
}