123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736 |
- /**************************************************************************/
- /* 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. */
- /**************************************************************************/
- #include "editor_help.h"
- #include "core/core_constants.h"
- #include "core/input/input.h"
- #include "core/object/script_language.h"
- #include "core/os/keyboard.h"
- #include "core/version.h"
- #include "doc_data_compressed.gen.h"
- #include "editor/editor_node.h"
- #include "editor/editor_paths.h"
- #include "editor/editor_scale.h"
- #include "editor/editor_settings.h"
- #include "editor/plugins/script_editor_plugin.h"
- #include "scene/gui/line_edit.h"
- #define CONTRIBUTE_URL vformat("%s/contributing/documentation/updating_the_class_reference.html", VERSION_DOCS_URL)
- // 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?
- DocTools *EditorHelp::doc = nullptr;
- class DocCache : public Resource {
- GDCLASS(DocCache, Resource);
- RES_BASE_EXTENSION("doc_cache");
- String version_hash;
- Array classes;
- protected:
- static void _bind_methods() {
- ClassDB::bind_method(D_METHOD("set_version_hash", "version_hash"), &DocCache::set_version_hash);
- ClassDB::bind_method(D_METHOD("get_version_hash"), &DocCache::get_version_hash);
- ClassDB::bind_method(D_METHOD("set_classes", "classes"), &DocCache::set_classes);
- ClassDB::bind_method(D_METHOD("get_classes"), &DocCache::get_classes);
- ADD_PROPERTY(PropertyInfo(Variant::STRING, "version_hash"), "set_version_hash", "get_version_hash");
- ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "classes"), "set_classes", "get_classes");
- }
- public:
- String get_version_hash() const { return version_hash; }
- void set_version_hash(const String &p_version_hash) { version_hash = p_version_hash; }
- Array get_classes() const { return classes; }
- void set_classes(const Array &p_classes) { classes = p_classes; }
- };
- 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);
- }
- // 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
- return p_class_specifier.substr(p_edited_class.length() + 1);
- }
- 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"));
- theme_cache.doc_font = get_theme_font(SNAME("doc"), SNAME("EditorFonts"));
- theme_cache.doc_bold_font = get_theme_font(SNAME("doc_bold"), SNAME("EditorFonts"));
- theme_cache.doc_italic_font = get_theme_font(SNAME("doc_italic"), SNAME("EditorFonts"));
- theme_cache.doc_title_font = get_theme_font(SNAME("doc_title"), SNAME("EditorFonts"));
- theme_cache.doc_code_font = get_theme_font(SNAME("doc_source"), SNAME("EditorFonts"));
- theme_cache.doc_kbd_font = get_theme_font(SNAME("doc_keyboard"), SNAME("EditorFonts"));
- theme_cache.doc_font_size = get_theme_font_size(SNAME("doc_size"), SNAME("EditorFonts"));
- theme_cache.doc_title_font_size = get_theme_font_size(SNAME("doc_title_size"), SNAME("EditorFonts"));
- theme_cache.doc_code_font_size = get_theme_font_size(SNAME("doc_source_size"), SNAME("EditorFonts"));
- theme_cache.doc_kbd_font_size = get_theme_font_size(SNAME("doc_keyboard_size"), SNAME("EditorFonts"));
- theme_cache.background_style = get_theme_stylebox(SNAME("background"), SNAME("EditorHelp"));
- 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);
- 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")));
- 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")));
- }
- void EditorHelp::_search(bool p_search_previous) {
- if (p_search_previous) {
- find_bar->search_prev();
- } else {
- find_bar->search_next();
- }
- }
- void EditorHelp::_class_desc_finished() {
- if (scroll_to >= 0) {
- class_desc->scroll_to_paragraph(scroll_to);
- }
- scroll_to = -1;
- }
- void EditorHelp::_class_list_select(const String &p_select) {
- _goto_desc(p_select);
- }
- void EditorHelp::_class_desc_select(const String &p_select) {
- if (p_select.begins_with("$")) { // enum
- String select = p_select.substr(1, p_select.length());
- String class_name;
- int rfind = select.rfind(".");
- if (rfind != -1) {
- class_name = select.substr(0, rfind);
- select = select.substr(rfind + 1);
- } else {
- class_name = "@GlobalScope";
- }
- emit_signal(SNAME("go_to_help"), "class_enum:" + class_name + ":" + select);
- return;
- } else if (p_select.begins_with("#")) {
- emit_signal(SNAME("go_to_help"), "class_name:" + p_select.substr(1, p_select.length()));
- return;
- } else if (p_select.begins_with("@")) {
- int tag_end = p_select.find(" ");
- String tag = p_select.substr(1, tag_end - 1);
- String link = p_select.substr(tag_end + 1, p_select.length()).lstrip(" ");
- String topic;
- HashMap<String, int> *table = nullptr;
- if (tag == "method") {
- topic = "class_method";
- table = &this->method_line;
- } else if (tag == "member") {
- topic = "class_property";
- table = &this->property_line;
- } else if (tag == "enum") {
- topic = "class_enum";
- table = &this->enum_line;
- } else if (tag == "signal") {
- topic = "class_signal";
- table = &this->signal_line;
- } else if (tag == "constant") {
- topic = "class_constant";
- table = &this->constant_line;
- } else if (tag == "annotation") {
- topic = "class_annotation";
- table = &this->annotation_line;
- } else if (tag == "theme_item") {
- topic = "theme_item";
- table = &this->theme_property_line;
- } else {
- return;
- }
- // Case order is important here to correctly handle edge cases like Variant.Type in @GlobalScope.
- if (table->has(link)) {
- // Found in the current page.
- if (class_desc->is_ready()) {
- class_desc->scroll_to_paragraph((*table)[link]);
- } else {
- scroll_to = (*table)[link];
- }
- } 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"];
- for (int i = 0; i < cd.constants.size(); i++) {
- if (cd.constants[i].enumeration == link) {
- // Found in @GlobalScope.
- emit_signal(SNAME("go_to_help"), topic + ":@GlobalScope:" + link);
- return;
- }
- }
- } else if (topic == "class_constant") {
- const DocData::ClassDoc &cd = doc->class_list["@GlobalScope"];
- for (int i = 0; i < cd.constants.size(); i++) {
- if (cd.constants[i].name == link) {
- // Found in @GlobalScope.
- emit_signal(SNAME("go_to_help"), topic + ":@GlobalScope:" + link);
- return;
- }
- }
- }
- if (link.contains(".")) {
- int class_end = link.find(".");
- emit_signal(SNAME("go_to_help"), topic + ":" + link.substr(0, class_end) + ":" + link.substr(class_end + 1, link.length()));
- }
- }
- } else if (p_select.begins_with("http")) {
- OS::get_singleton()->shell_open(p_select);
- }
- }
- void EditorHelp::_class_desc_input(const Ref<InputEvent> &p_input) {
- }
- void EditorHelp::_class_desc_resized(bool p_force_update_theme) {
- // Add extra horizontal margins for better readability.
- // The margins increase as the width of the editor help container increases.
- real_t char_width = theme_cache.doc_code_font->get_char_size('x', theme_cache.doc_code_font_size).width;
- const int new_display_margin = MAX(30 * EDSCALE, get_parent_anchorable_rect().size.width - char_width * 120 * EDSCALE) * 0.5;
- if (display_margin != new_display_margin || p_force_update_theme) {
- display_margin = new_display_margin;
- Ref<StyleBox> class_desc_stylebox = theme_cache.background_style->duplicate();
- class_desc_stylebox->set_content_margin(SIDE_LEFT, display_margin);
- class_desc_stylebox->set_content_margin(SIDE_RIGHT, display_margin);
- class_desc->add_theme_style_override("normal", class_desc_stylebox);
- class_desc->add_theme_style_override("focused", class_desc_stylebox);
- }
- }
- void EditorHelp::_add_type(const String &p_type, const String &p_enum, bool p_is_bitfield) {
- if (p_type.is_empty() || p_type == "void") {
- class_desc->push_color(Color(theme_cache.type_color, 0.5));
- class_desc->push_hint(TTR("No return value."));
- class_desc->add_text("void");
- class_desc->pop();
- class_desc->pop();
- return;
- }
- bool is_enum_type = !p_enum.is_empty();
- bool is_bitfield = p_is_bitfield && is_enum_type;
- bool can_ref = !p_type.contains("*") || is_enum_type;
- String link_t = p_type; // For links in metadata
- String display_t = link_t; // For display purposes
- if (is_enum_type) {
- 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);
- }
- class_desc->push_color(theme_cache.type_color);
- bool add_array = false;
- if (can_ref) {
- if (link_t.ends_with("[]")) {
- add_array = true;
- link_t = link_t.trim_suffix("[]");
- display_t = display_t.trim_suffix("[]");
- class_desc->push_meta("#Array"); // class
- class_desc->add_text("Array");
- class_desc->pop();
- class_desc->add_text("[");
- } 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");
- class_desc->pop();
- class_desc->add_text("[");
- class_desc->pop();
- }
- if (is_enum_type) {
- class_desc->push_meta("$" + link_t); // enum
- } else {
- class_desc->push_meta("#" + link_t); // class
- }
- }
- class_desc->add_text(display_t);
- if (can_ref) {
- class_desc->pop(); // Pushed meta above.
- if (add_array) {
- class_desc->add_text("]");
- } else if (is_bitfield) {
- class_desc->push_color(Color(theme_cache.type_color, 0.5));
- class_desc->add_text("]");
- class_desc->pop();
- }
- }
- class_desc->pop();
- }
- 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);
- Vector2i size = Vector2i(icon->get_width(), icon->get_height());
- if (p_size > 0) {
- // Ensures icon scales proportionally on both axis, based on icon height.
- float ratio = p_size / float(size.height);
- size.width *= ratio;
- size.height *= ratio;
- }
- class_desc->add_image(icon, size.width, size.height);
- }
- 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";
- }
- if (p_constant.strip_edges() == "1048575") {
- return "0xFFFFF";
- }
- return p_constant;
- }
- // Macros for assigning the deprecation/experimental information to class members
- #define DEPRECATED_DOC_TAG \
- class_desc->push_color(get_theme_color(SNAME("error_color"), SNAME("Editor"))); \
- Ref<Texture2D> error_icon = get_theme_icon(SNAME("StatusError"), SNAME("EditorIcons")); \
- class_desc->add_text(" "); \
- class_desc->add_image(error_icon, error_icon->get_width(), error_icon->get_height()); \
- class_desc->add_text(" (" + TTR("Deprecated") + ")"); \
- class_desc->pop();
- #define EXPERIMENTAL_DOC_TAG \
- class_desc->push_color(get_theme_color(SNAME("warning_color"), SNAME("Editor"))); \
- Ref<Texture2D> warning_icon = get_theme_icon(SNAME("NodeWarning"), SNAME("EditorIcons")); \
- class_desc->add_text(" "); \
- class_desc->add_image(warning_icon, warning_icon->get_width(), warning_icon->get_height()); \
- class_desc->add_text(" (" + TTR("Experimental") + ")"); \
- class_desc->pop();
- void EditorHelp::_add_method(const DocData::MethodDoc &p_method, bool p_overview) {
- method_line[p_method.name] = class_desc->get_paragraph_count() - 2; // Gets overridden if description
- const bool is_vararg = p_method.qualifiers.contains("vararg");
- if (p_overview) {
- class_desc->push_cell();
- class_desc->push_paragraph(HORIZONTAL_ALIGNMENT_RIGHT, Control::TEXT_DIRECTION_AUTO, "");
- } else {
- _add_bulletpoint();
- }
- _add_type(p_method.return_type, p_method.return_enum, p_method.return_is_bitfield);
- if (p_overview) {
- class_desc->pop(); // align
- class_desc->pop(); // cell
- class_desc->push_cell();
- } else {
- class_desc->add_text(" ");
- }
- if (p_overview && !p_method.description.strip_edges().is_empty()) {
- class_desc->push_meta("@method " + p_method.name);
- }
- class_desc->push_color(theme_cache.headline_color);
- _add_text(p_method.name);
- class_desc->pop();
- if (p_overview && !p_method.description.strip_edges().is_empty()) {
- class_desc->pop(); // meta
- }
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text("(");
- class_desc->pop();
- for (int j = 0; j < p_method.arguments.size(); j++) {
- class_desc->push_color(theme_cache.text_color);
- if (j > 0) {
- class_desc->add_text(", ");
- }
- _add_text(p_method.arguments[j].name);
- class_desc->add_text(": ");
- _add_type(p_method.arguments[j].type, p_method.arguments[j].enumeration, p_method.arguments[j].is_bitfield);
- if (!p_method.arguments[j].default_value.is_empty()) {
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(" = ");
- class_desc->pop();
- class_desc->push_color(theme_cache.value_color);
- _add_text(_fix_constant(p_method.arguments[j].default_value));
- class_desc->pop();
- }
- class_desc->pop();
- }
- if (is_vararg) {
- class_desc->push_color(theme_cache.text_color);
- if (p_method.arguments.size()) {
- class_desc->add_text(", ");
- }
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text("...");
- class_desc->pop();
- class_desc->pop();
- }
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(")");
- class_desc->pop();
- if (!p_method.qualifiers.is_empty()) {
- class_desc->push_color(theme_cache.qualifier_color);
- 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") {
- hint = TTR("This method is called by the engine.\nIt can be overridden to customize built-in behavior.");
- } else if (qualifier == "const") {
- hint = TTR("This method has no side effects.\nIt does not modify the object in any way.");
- } else if (qualifier == "static") {
- hint = TTR("This method does not need an instance to be called.\nIt 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);
- class_desc->pop();
- } else {
- class_desc->add_text(qualifier);
- }
- }
- class_desc->pop();
- }
- if (p_method.is_deprecated) {
- DEPRECATED_DOC_TAG;
- }
- if (p_method.is_experimental) {
- EXPERIMENTAL_DOC_TAG;
- }
- if (p_overview) {
- class_desc->pop(); // cell
- }
- }
- void EditorHelp::_add_bulletpoint() {
- static const char32_t prefix[3] = { 0x25CF /* filled circle */, ' ', 0 };
- class_desc->add_text(String(prefix));
- }
- 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() {
- class_desc->pop();
- class_desc->pop();
- }
- void EditorHelp::_push_title_font() {
- class_desc->push_color(theme_cache.title_color);
- class_desc->push_font(theme_cache.doc_title_font);
- class_desc->push_font_size(theme_cache.doc_title_font_size);
- }
- void EditorHelp::_pop_title_font() {
- class_desc->pop();
- class_desc->pop();
- class_desc->pop();
- }
- 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() {
- class_desc->pop();
- class_desc->pop();
- }
- 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)) {
- return ERR_DOES_NOT_EXIST;
- }
- select_locked = true;
- class_desc->show();
- description_line = 0;
- if (p_class == edited_class) {
- return OK; // Already there.
- }
- edited_class = p_class;
- _update_doc();
- return OK;
- }
- void EditorHelp::_update_method_list(const Vector<DocData::MethodDoc> p_methods) {
- class_desc->add_newline();
- _push_code_font();
- class_desc->push_indent(1);
- 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;
- for (int i = 0; i < p_methods.size(); i++) {
- const String &q = p_methods[i].qualifiers;
- if ((pass == 0 && q.contains("virtual")) || (pass == 1 && !q.contains("virtual"))) {
- m.push_back(p_methods[i]);
- }
- }
- if (any_previous && !m.is_empty()) {
- class_desc->push_cell();
- class_desc->pop(); // cell
- class_desc->push_cell();
- class_desc->pop(); // cell
- }
- 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;
- } else if (!group_prefix.is_empty() && new_prefix != group_prefix) {
- is_new_group = true;
- group_prefix = "";
- }
- if (is_new_group && pass == 1) {
- class_desc->push_cell();
- class_desc->pop(); // cell
- class_desc->push_cell();
- class_desc->pop(); // cell
- }
- _add_method(m[i], true);
- }
- any_previous = !m.is_empty();
- }
- class_desc->pop(); // table
- class_desc->pop();
- _pop_code_font();
- class_desc->add_newline();
- class_desc->add_newline();
- }
- void EditorHelp::_update_method_descriptions(const DocData::ClassDoc p_classdoc, const Vector<DocData::MethodDoc> p_methods, const String &p_method_type) {
- String link_color_text = theme_cache.title_color.to_html(false);
- class_desc->add_newline();
- class_desc->add_newline();
- 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;
- if ((pass == 0 && q.contains("virtual")) || (pass == 1 && !q.contains("virtual"))) {
- methods_filtered.push_back(p_methods[i]);
- }
- }
- for (int i = 0; i < methods_filtered.size(); i++) {
- _push_code_font();
- _add_method(methods_filtered[i], false);
- _pop_code_font();
- class_desc->add_newline();
- class_desc->add_newline();
- class_desc->push_color(theme_cache.text_color);
- _push_normal_font();
- class_desc->push_indent(1);
- if (methods_filtered[i].errors_returned.size()) {
- class_desc->append_text(TTR("Error codes returned:"));
- class_desc->add_newline();
- class_desc->push_list(0, RichTextLabel::LIST_DOTS, false);
- for (int j = 0; j < methods_filtered[i].errors_returned.size(); j++) {
- if (j > 0) {
- class_desc->add_newline();
- }
- int val = methods_filtered[i].errors_returned[j];
- 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;
- }
- }
- class_desc->push_bold();
- class_desc->append_text(text);
- class_desc->pop();
- }
- class_desc->pop();
- class_desc->add_newline();
- class_desc->add_newline();
- }
- if (!methods_filtered[i].description.strip_edges().is_empty()) {
- _add_text(DTR(methods_filtered[i].description));
- } else {
- class_desc->add_image(get_theme_icon(SNAME("Error"), SNAME("EditorIcons")));
- class_desc->add_text(" ");
- class_desc->push_color(theme_cache.comment_color);
- if (p_classdoc.is_script_doc) {
- class_desc->append_text(vformat(TTR("There is currently no description for this %s."), p_method_type));
- } else {
- class_desc->append_text(vformat(TTR("There is currently no description for this %s. Please help us by [color=$color][url=$url]contributing one[/url][/color]!"), p_method_type).replace("$url", CONTRIBUTE_URL).replace("$color", link_color_text));
- }
- class_desc->pop();
- }
- class_desc->pop();
- _pop_normal_font();
- class_desc->pop();
- class_desc->add_newline();
- class_desc->add_newline();
- class_desc->add_newline();
- }
- }
- }
- void EditorHelp::_update_doc() {
- if (!doc->class_list.has(edited_class)) {
- return;
- }
- scroll_locked = true;
- class_desc->clear();
- method_line.clear();
- section_line.clear();
- String link_color_text = theme_cache.title_color.to_html(false);
- DocData::ClassDoc cd = doc->class_list[edited_class]; // Make a copy, so we can sort without worrying.
- // Class name
- section_line.push_back(Pair<String, int>(TTR("Top"), 0));
- _push_title_font();
- class_desc->add_text(TTR("Class:") + " ");
- _add_type_icon(edited_class, theme_cache.doc_title_font_size, "Object");
- class_desc->add_text(" ");
- class_desc->push_color(theme_cache.headline_color);
- _add_text(edited_class);
- class_desc->pop(); // color
- _pop_title_font();
- if (cd.is_deprecated) {
- class_desc->add_text(" ");
- Ref<Texture2D> error_icon = get_theme_icon(SNAME("StatusError"), SNAME("EditorIcons"));
- class_desc->add_image(error_icon, error_icon->get_width(), error_icon->get_height());
- }
- if (cd.is_experimental) {
- class_desc->add_text(" ");
- Ref<Texture2D> warning_icon = get_theme_icon(SNAME("NodeWarning"), SNAME("EditorIcons"));
- class_desc->add_image(warning_icon, warning_icon->get_width(), warning_icon->get_height());
- }
- class_desc->add_newline();
- const String non_breaking_space = String::chr(160);
- // Inheritance tree
- // Ascendents
- if (!cd.inherits.is_empty()) {
- class_desc->push_color(theme_cache.title_color);
- _push_normal_font();
- class_desc->add_text(TTR("Inherits:") + " ");
- String inherits = cd.inherits;
- while (!inherits.is_empty()) {
- _add_type_icon(inherits, theme_cache.doc_font_size, "ArrowRight");
- class_desc->add_text(non_breaking_space); // Otherwise icon borrows hyperlink from _add_type().
- _add_type(inherits);
- inherits = doc->class_list[inherits].inherits;
- if (!inherits.is_empty()) {
- class_desc->add_text(" < ");
- }
- }
- _pop_normal_font();
- class_desc->pop();
- class_desc->add_newline();
- }
- // Descendents
- if (cd.is_script_doc || ClassDB::class_exists(cd.name)) {
- bool found = false;
- bool prev = false;
- _push_normal_font();
- for (const KeyValue<String, DocData::ClassDoc> &E : doc->class_list) {
- if (E.value.inherits == cd.name) {
- if (!found) {
- class_desc->push_color(theme_cache.title_color);
- class_desc->add_text(TTR("Inherited by:") + " ");
- found = true;
- }
- if (prev) {
- class_desc->add_text(" , ");
- }
- _add_type_icon(E.value.name, theme_cache.doc_font_size, "ArrowRight");
- class_desc->add_text(non_breaking_space); // Otherwise icon borrows hyperlink from _add_type().
- _add_type(E.value.name);
- prev = true;
- }
- }
- _pop_normal_font();
- if (found) {
- class_desc->pop();
- class_desc->add_newline();
- }
- }
- // Note if deprecated.
- if (cd.is_deprecated) {
- Ref<Texture2D> error_icon = get_theme_icon(SNAME("StatusError"), SNAME("EditorIcons"));
- class_desc->push_color(get_theme_color(SNAME("error_color"), SNAME("Editor")));
- class_desc->add_image(error_icon, error_icon->get_width(), error_icon->get_height());
- class_desc->add_text(String(" ") + TTR("This class is marked as deprecated. It will be removed in future versions."));
- class_desc->pop();
- class_desc->add_newline();
- }
- // Note if experimental.
- if (cd.is_experimental) {
- Ref<Texture2D> warning_icon = get_theme_icon(SNAME("NodeWarning"), SNAME("EditorIcons"));
- class_desc->push_color(get_theme_color(SNAME("warning_color"), SNAME("Editor")));
- class_desc->add_image(warning_icon, warning_icon->get_width(), warning_icon->get_height());
- class_desc->add_text(String(" ") + TTR("This class is marked as experimental. It is subject to likely change or possible removal in future versions. Use at your own discretion."));
- class_desc->pop();
- class_desc->add_newline();
- }
- bool has_description = false;
- class_desc->add_newline();
- class_desc->add_newline();
- // Brief description
- if (!cd.brief_description.strip_edges().is_empty()) {
- has_description = true;
- class_desc->push_color(theme_cache.text_color);
- class_desc->push_font(theme_cache.doc_bold_font);
- class_desc->push_indent(1);
- _add_text(DTR(cd.brief_description));
- class_desc->pop();
- class_desc->pop();
- class_desc->pop();
- class_desc->add_newline();
- class_desc->add_newline();
- class_desc->add_newline();
- }
- // Class description
- if (!cd.description.strip_edges().is_empty()) {
- has_description = true;
- section_line.push_back(Pair<String, int>(TTR("Description"), class_desc->get_paragraph_count() - 2));
- description_line = class_desc->get_paragraph_count() - 2;
- _push_title_font();
- class_desc->add_text(TTR("Description"));
- _pop_title_font();
- class_desc->add_newline();
- class_desc->add_newline();
- class_desc->push_color(theme_cache.text_color);
- _push_normal_font();
- class_desc->push_indent(1);
- _add_text(DTR(cd.description));
- class_desc->pop();
- _pop_normal_font();
- class_desc->pop();
- class_desc->add_newline();
- class_desc->add_newline();
- class_desc->add_newline();
- }
- if (!has_description) {
- class_desc->add_image(get_theme_icon(SNAME("Error"), SNAME("EditorIcons")));
- class_desc->add_text(" ");
- class_desc->push_color(theme_cache.comment_color);
- if (cd.is_script_doc) {
- class_desc->append_text(TTR("There is currently no description for this class."));
- } 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));
- }
- class_desc->pop();
- class_desc->add_newline();
- class_desc->add_newline();
- }
- // Online tutorials
- if (cd.tutorials.size()) {
- _push_title_font();
- class_desc->add_text(TTR("Online Tutorials"));
- _pop_title_font();
- class_desc->add_newline();
- class_desc->push_indent(1);
- _push_code_font();
- for (int i = 0; i < cd.tutorials.size(); i++) {
- const String link = DTR(cd.tutorials[i].link);
- String linktxt = (cd.tutorials[i].title.is_empty()) ? link : DTR(cd.tutorials[i].title);
- const int seppos = linktxt.find("//");
- if (seppos != -1) {
- linktxt = link.substr(seppos + 2);
- }
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->append_text("[url=" + link + "]" + linktxt + "[/url]");
- class_desc->pop();
- class_desc->add_newline();
- }
- _pop_code_font();
- class_desc->pop();
- class_desc->add_newline();
- class_desc->add_newline();
- }
- // Properties overview
- HashSet<String> skip_methods;
- bool has_properties = false;
- bool has_property_descriptions = false;
- for (const DocData::PropertyDoc &prop : cd.properties) {
- if (cd.is_script_doc && prop.name.begins_with("_") && prop.description.strip_edges().is_empty()) {
- continue;
- }
- has_properties = true;
- if (!prop.overridden) {
- has_property_descriptions = true;
- break;
- }
- }
- if (has_properties) {
- section_line.push_back(Pair<String, int>(TTR("Properties"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Properties"));
- _pop_title_font();
- class_desc->add_newline();
- _push_code_font();
- class_desc->push_indent(1);
- class_desc->push_table(4);
- class_desc->set_table_column_expand(1, true);
- for (int i = 0; i < cd.properties.size(); i++) {
- // Ignore undocumented private.
- if (cd.properties[i].name.begins_with("_") && cd.properties[i].description.strip_edges().is_empty()) {
- continue;
- }
- property_line[cd.properties[i].name] = class_desc->get_paragraph_count() - 2; //gets overridden if description
- // Property type.
- class_desc->push_cell();
- class_desc->push_paragraph(HORIZONTAL_ALIGNMENT_RIGHT, Control::TEXT_DIRECTION_AUTO, "");
- _push_code_font();
- _add_type(cd.properties[i].type, cd.properties[i].enumeration, cd.properties[i].is_bitfield);
- _pop_code_font();
- class_desc->pop();
- class_desc->pop(); // cell
- bool describe = false;
- if (!cd.properties[i].setter.is_empty()) {
- skip_methods.insert(cd.properties[i].setter);
- describe = true;
- }
- if (!cd.properties[i].getter.is_empty()) {
- skip_methods.insert(cd.properties[i].getter);
- describe = true;
- }
- if (!cd.properties[i].description.strip_edges().is_empty()) {
- describe = true;
- }
- if (cd.properties[i].overridden) {
- describe = false;
- }
- // Property name.
- class_desc->push_cell();
- _push_code_font();
- class_desc->push_color(theme_cache.headline_color);
- if (describe) {
- class_desc->push_meta("@member " + cd.properties[i].name);
- }
- _add_text(cd.properties[i].name);
- if (describe) {
- class_desc->pop();
- }
- class_desc->pop();
- _pop_code_font();
- class_desc->pop(); // cell
- // Property value.
- class_desc->push_cell();
- _push_code_font();
- if (!cd.properties[i].default_value.is_empty()) {
- class_desc->push_color(theme_cache.symbol_color);
- if (cd.properties[i].overridden) {
- class_desc->add_text(" [");
- class_desc->push_meta("@member " + cd.properties[i].overrides + "." + cd.properties[i].name);
- _add_text(vformat(TTR("overrides %s:"), cd.properties[i].overrides));
- class_desc->pop();
- class_desc->add_text(" ");
- } else {
- class_desc->add_text(" [" + TTR("default:") + " ");
- }
- class_desc->pop();
- class_desc->push_color(theme_cache.value_color);
- _add_text(_fix_constant(cd.properties[i].default_value));
- class_desc->pop();
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text("]");
- class_desc->pop();
- }
- if (cd.properties[i].is_deprecated) {
- DEPRECATED_DOC_TAG;
- }
- if (cd.properties[i].is_experimental) {
- EXPERIMENTAL_DOC_TAG;
- }
- _pop_code_font();
- class_desc->pop(); // cell
- // Property setters and getters.
- class_desc->push_cell();
- _push_code_font();
- if (cd.is_script_doc && (!cd.properties[i].setter.is_empty() || !cd.properties[i].getter.is_empty())) {
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(" [" + TTR("property:") + " ");
- class_desc->pop(); // color
- if (!cd.properties[i].setter.is_empty()) {
- class_desc->push_color(theme_cache.value_color);
- class_desc->add_text("setter");
- class_desc->pop(); // color
- }
- if (!cd.properties[i].getter.is_empty()) {
- if (!cd.properties[i].setter.is_empty()) {
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(", ");
- class_desc->pop(); // color
- }
- class_desc->push_color(theme_cache.value_color);
- class_desc->add_text("getter");
- class_desc->pop(); // color
- }
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text("]");
- class_desc->pop(); // color
- }
- _pop_code_font();
- class_desc->pop(); // cell
- }
- class_desc->pop(); // table
- class_desc->pop();
- _pop_code_font();
- class_desc->add_newline();
- class_desc->add_newline();
- }
- // Methods overview
- bool sort_methods = EDITOR_GET("text_editor/help/sort_functions_alphabetically");
- Vector<DocData::MethodDoc> methods;
- for (int i = 0; i < cd.methods.size(); i++) {
- if (skip_methods.has(cd.methods[i].name)) {
- if (cd.methods[i].arguments.size() == 0 /* getter */ || (cd.methods[i].arguments.size() == 1 && cd.methods[i].return_type == "void" /* setter */)) {
- continue;
- }
- }
- // Ignore undocumented non virtual private.
- if (cd.methods[i].name.begins_with("_") && cd.methods[i].description.strip_edges().is_empty() && !cd.methods[i].qualifiers.contains("virtual")) {
- continue;
- }
- methods.push_back(cd.methods[i]);
- }
- if (!cd.constructors.is_empty()) {
- if (sort_methods) {
- cd.constructors.sort();
- }
- section_line.push_back(Pair<String, int>(TTR("Constructors"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Constructors"));
- _pop_title_font();
- _update_method_list(cd.constructors);
- }
- if (!methods.is_empty()) {
- if (sort_methods) {
- methods.sort();
- }
- section_line.push_back(Pair<String, int>(TTR("Methods"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Methods"));
- _pop_title_font();
- _update_method_list(methods);
- }
- if (!cd.operators.is_empty()) {
- if (sort_methods) {
- cd.operators.sort();
- }
- section_line.push_back(Pair<String, int>(TTR("Operators"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Operators"));
- _pop_title_font();
- _update_method_list(cd.operators);
- }
- // Theme properties
- if (!cd.theme_properties.is_empty()) {
- section_line.push_back(Pair<String, int>(TTR("Theme Properties"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Theme Properties"));
- _pop_title_font();
- class_desc->add_newline();
- class_desc->add_newline();
- class_desc->push_indent(1);
- String theme_data_type;
- HashMap<String, String> data_type_names;
- 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");
- for (int i = 0; i < cd.theme_properties.size(); i++) {
- theme_property_line[cd.theme_properties[i].name] = class_desc->get_paragraph_count() - 2; // Gets overridden if description.
- if (theme_data_type != cd.theme_properties[i].data_type) {
- theme_data_type = cd.theme_properties[i].data_type;
- _push_title_font();
- if (data_type_names.has(theme_data_type)) {
- class_desc->add_text(data_type_names[theme_data_type]);
- } else {
- class_desc->add_text("");
- }
- _pop_title_font();
- class_desc->add_newline();
- class_desc->add_newline();
- }
- // Theme item header.
- _push_code_font();
- _add_bulletpoint();
- // Theme item object type.
- _add_type(cd.theme_properties[i].type);
- // Theme item name.
- class_desc->push_color(theme_cache.headline_color);
- class_desc->add_text(" ");
- _add_text(cd.theme_properties[i].name);
- class_desc->pop();
- // Theme item default value.
- if (!cd.theme_properties[i].default_value.is_empty()) {
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(" [" + TTR("default:") + " ");
- class_desc->pop();
- class_desc->push_color(theme_cache.value_color);
- _add_text(_fix_constant(cd.theme_properties[i].default_value));
- class_desc->pop();
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text("]");
- class_desc->pop();
- }
- _pop_code_font();
- // Theme item description.
- if (!cd.theme_properties[i].description.strip_edges().is_empty()) {
- class_desc->push_color(theme_cache.comment_color);
- _push_normal_font();
- class_desc->push_indent(1);
- _add_text(DTR(cd.theme_properties[i].description));
- class_desc->pop(); // indent
- _pop_normal_font();
- class_desc->pop(); // color
- }
- class_desc->add_newline();
- class_desc->add_newline();
- }
- class_desc->pop();
- class_desc->add_newline();
- }
- // Signals
- if (!cd.signals.is_empty()) {
- if (sort_methods) {
- cd.signals.sort();
- }
- section_line.push_back(Pair<String, int>(TTR("Signals"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Signals"));
- _pop_title_font();
- class_desc->add_newline();
- class_desc->add_newline();
- class_desc->push_indent(1);
- for (int i = 0; i < cd.signals.size(); i++) {
- signal_line[cd.signals[i].name] = class_desc->get_paragraph_count() - 2; // Gets overridden if description.
- _push_code_font();
- _add_bulletpoint();
- class_desc->push_color(theme_cache.headline_color);
- _add_text(cd.signals[i].name);
- class_desc->pop();
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text("(");
- class_desc->pop();
- for (int j = 0; j < cd.signals[i].arguments.size(); j++) {
- class_desc->push_color(theme_cache.text_color);
- if (j > 0) {
- class_desc->add_text(", ");
- }
- _add_text(cd.signals[i].arguments[j].name);
- class_desc->add_text(": ");
- _add_type(cd.signals[i].arguments[j].type, cd.signals[i].arguments[j].enumeration, cd.signals[i].arguments[j].is_bitfield);
- if (!cd.signals[i].arguments[j].default_value.is_empty()) {
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(" = ");
- class_desc->pop();
- _add_text(cd.signals[i].arguments[j].default_value);
- }
- class_desc->pop();
- }
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(")");
- if (cd.signals[i].is_deprecated) {
- DEPRECATED_DOC_TAG;
- }
- if (cd.signals[i].is_experimental) {
- EXPERIMENTAL_DOC_TAG;
- }
- class_desc->pop();
- _pop_code_font();
- if (!cd.signals[i].description.strip_edges().is_empty()) {
- class_desc->push_color(theme_cache.comment_color);
- _push_normal_font();
- class_desc->push_indent(1);
- _add_text(DTR(cd.signals[i].description));
- class_desc->pop(); // indent
- _pop_normal_font();
- class_desc->pop(); // color
- }
- class_desc->add_newline();
- class_desc->add_newline();
- }
- class_desc->pop();
- class_desc->add_newline();
- }
- // Constants and enums
- if (!cd.constants.is_empty()) {
- HashMap<String, Vector<DocData::ConstantDoc>> enums;
- Vector<DocData::ConstantDoc> constants;
- for (int i = 0; i < cd.constants.size(); i++) {
- if (!cd.constants[i].enumeration.is_empty()) {
- if (!enums.has(cd.constants[i].enumeration)) {
- enums[cd.constants[i].enumeration] = Vector<DocData::ConstantDoc>();
- }
- enums[cd.constants[i].enumeration].push_back(cd.constants[i]);
- } else {
- // Ignore undocumented private.
- if (cd.constants[i].name.begins_with("_") && cd.constants[i].description.strip_edges().is_empty()) {
- continue;
- }
- constants.push_back(cd.constants[i]);
- }
- }
- // Enums
- if (enums.size()) {
- section_line.push_back(Pair<String, int>(TTR("Enumerations"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Enumerations"));
- _pop_title_font();
- class_desc->push_indent(1);
- class_desc->add_newline();
- for (KeyValue<String, Vector<DocData::ConstantDoc>> &E : enums) {
- enum_line[E.key] = class_desc->get_paragraph_count() - 2;
- _push_code_font();
- class_desc->push_color(theme_cache.title_color);
- if (E.value.size() && E.value[0].is_bitfield) {
- class_desc->add_text("flags ");
- } else {
- class_desc->add_text("enum ");
- }
- class_desc->pop();
- String e = E.key;
- if ((e.get_slice_count(".") > 1) && (e.get_slice(".", 0) == edited_class)) {
- e = e.get_slice(".", 1);
- }
- class_desc->push_color(theme_cache.headline_color);
- class_desc->add_text(e);
- class_desc->pop();
- _pop_code_font();
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(":");
- class_desc->pop();
- class_desc->add_newline();
- class_desc->add_newline();
- // Enum description.
- if (e != "@unnamed_enums" && cd.enums.has(e) && !cd.enums[e].strip_edges().is_empty()) {
- class_desc->push_color(theme_cache.text_color);
- _push_normal_font();
- class_desc->push_indent(1);
- _add_text(cd.enums[e]);
- class_desc->pop();
- _pop_normal_font();
- class_desc->pop();
- class_desc->add_newline();
- class_desc->add_newline();
- }
- class_desc->push_indent(1);
- Vector<DocData::ConstantDoc> enum_list = E.value;
- HashMap<String, int> enumValuesContainer;
- int enumStartingLine = enum_line[E.key];
- for (int i = 0; i < enum_list.size(); i++) {
- if (cd.name == "@GlobalScope") {
- enumValuesContainer[enum_list[i].name] = enumStartingLine;
- }
- // Add the enum constant line to the constant_line map so we can locate it as a constant.
- constant_line[enum_list[i].name] = class_desc->get_paragraph_count() - 2;
- _push_code_font();
- _add_bulletpoint();
- class_desc->push_color(theme_cache.headline_color);
- _add_text(enum_list[i].name);
- class_desc->pop();
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(" = ");
- class_desc->pop();
- class_desc->push_color(theme_cache.value_color);
- _add_text(_fix_constant(enum_list[i].value));
- class_desc->pop();
- _pop_code_font();
- if (enum_list[i].is_deprecated) {
- DEPRECATED_DOC_TAG;
- }
- if (enum_list[i].is_experimental) {
- EXPERIMENTAL_DOC_TAG;
- }
- class_desc->add_newline();
- if (!enum_list[i].description.strip_edges().is_empty()) {
- class_desc->push_color(theme_cache.comment_color);
- _push_normal_font();
- _add_text(DTR(enum_list[i].description));
- _pop_normal_font();
- class_desc->pop();
- if (DTR(enum_list[i].description).find("\n") > 0) {
- class_desc->add_newline();
- }
- }
- class_desc->add_newline();
- }
- if (cd.name == "@GlobalScope") {
- enum_values_line[E.key] = enumValuesContainer;
- }
- class_desc->pop();
- class_desc->add_newline();
- }
- class_desc->pop();
- class_desc->add_newline();
- }
- // Constants
- if (constants.size()) {
- section_line.push_back(Pair<String, int>(TTR("Constants"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Constants"));
- _pop_title_font();
- class_desc->push_indent(1);
- class_desc->add_newline();
- for (int i = 0; i < constants.size(); i++) {
- constant_line[constants[i].name] = class_desc->get_paragraph_count() - 2;
- _push_code_font();
- if (constants[i].value.begins_with("Color(") && constants[i].value.ends_with(")")) {
- String stripped = constants[i].value.replace(" ", "").replace("Color(", "").replace(")", "");
- PackedFloat64Array color = stripped.split_floats(",");
- if (color.size() >= 3) {
- class_desc->push_color(Color(color[0], color[1], color[2]));
- _add_bulletpoint();
- class_desc->pop();
- }
- } else {
- _add_bulletpoint();
- }
- class_desc->push_color(theme_cache.headline_color);
- _add_text(constants[i].name);
- class_desc->pop();
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(" = ");
- class_desc->pop();
- class_desc->push_color(theme_cache.value_color);
- _add_text(_fix_constant(constants[i].value));
- class_desc->pop();
- _pop_code_font();
- if (constants[i].is_deprecated) {
- DEPRECATED_DOC_TAG;
- }
- if (constants[i].is_experimental) {
- EXPERIMENTAL_DOC_TAG;
- }
- class_desc->add_newline();
- if (!constants[i].description.strip_edges().is_empty()) {
- class_desc->push_color(theme_cache.comment_color);
- _push_normal_font();
- _add_text(DTR(constants[i].description));
- _pop_normal_font();
- class_desc->pop();
- if (DTR(constants[i].description).find("\n") > 0) {
- class_desc->add_newline();
- }
- }
- class_desc->add_newline();
- }
- class_desc->pop();
- class_desc->add_newline();
- }
- }
- // Annotations
- if (!cd.annotations.is_empty()) {
- if (sort_methods) {
- cd.annotations.sort();
- }
- section_line.push_back(Pair<String, int>(TTR("Annotations"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Annotations"));
- _pop_title_font();
- class_desc->add_newline();
- class_desc->add_newline();
- class_desc->push_indent(1);
- for (int i = 0; i < cd.annotations.size(); i++) {
- annotation_line[cd.annotations[i].name] = class_desc->get_paragraph_count() - 2; // Gets overridden if description.
- _push_code_font();
- _add_bulletpoint();
- class_desc->push_color(theme_cache.headline_color);
- _add_text(cd.annotations[i].name);
- class_desc->pop();
- if (cd.annotations[i].arguments.size() > 0) {
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text("(");
- class_desc->pop();
- for (int j = 0; j < cd.annotations[i].arguments.size(); j++) {
- class_desc->push_color(theme_cache.text_color);
- if (j > 0) {
- class_desc->add_text(", ");
- }
- _add_text(cd.annotations[i].arguments[j].name);
- class_desc->add_text(": ");
- _add_type(cd.annotations[i].arguments[j].type);
- if (!cd.annotations[i].arguments[j].default_value.is_empty()) {
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(" = ");
- class_desc->pop();
- _add_text(cd.annotations[i].arguments[j].default_value);
- }
- class_desc->pop();
- }
- if (cd.annotations[i].qualifiers.contains("vararg")) {
- class_desc->push_color(theme_cache.text_color);
- if (cd.annotations[i].arguments.size()) {
- class_desc->add_text(", ");
- }
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text("...");
- class_desc->pop();
- class_desc->pop();
- }
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(")");
- class_desc->pop();
- }
- if (!cd.annotations[i].qualifiers.is_empty()) {
- class_desc->push_color(theme_cache.qualifier_color);
- class_desc->add_text(" ");
- _add_text(cd.annotations[i].qualifiers);
- class_desc->pop();
- }
- _pop_code_font();
- if (!cd.annotations[i].description.strip_edges().is_empty()) {
- class_desc->push_color(theme_cache.comment_color);
- _push_normal_font();
- class_desc->push_indent(1);
- _add_text(DTR(cd.annotations[i].description));
- class_desc->pop(); // indent
- _pop_normal_font();
- class_desc->pop(); // color
- } else {
- class_desc->push_indent(1);
- class_desc->add_image(get_theme_icon(SNAME("Error"), SNAME("EditorIcons")));
- class_desc->add_text(" ");
- class_desc->push_color(theme_cache.comment_color);
- if (cd.is_script_doc) {
- class_desc->append_text(TTR("There is currently no description for this annotation."));
- } 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));
- }
- class_desc->pop();
- class_desc->pop(); // indent
- }
- class_desc->add_newline();
- class_desc->add_newline();
- }
- class_desc->pop();
- class_desc->add_newline();
- }
- // Property descriptions
- if (has_property_descriptions) {
- section_line.push_back(Pair<String, int>(TTR("Property Descriptions"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Property Descriptions"));
- _pop_title_font();
- class_desc->add_newline();
- class_desc->add_newline();
- for (int i = 0; i < cd.properties.size(); i++) {
- if (cd.properties[i].overridden) {
- continue;
- }
- // Ignore undocumented private.
- if (cd.properties[i].name.begins_with("_") && cd.properties[i].description.strip_edges().is_empty()) {
- continue;
- }
- property_line[cd.properties[i].name] = class_desc->get_paragraph_count() - 2;
- class_desc->push_table(2);
- class_desc->set_table_column_expand(1, true);
- class_desc->push_cell();
- _push_code_font();
- _add_bulletpoint();
- _add_type(cd.properties[i].type, cd.properties[i].enumeration, cd.properties[i].is_bitfield);
- class_desc->add_text(" ");
- _pop_code_font();
- class_desc->pop(); // cell
- class_desc->push_cell();
- _push_code_font();
- class_desc->push_color(theme_cache.headline_color);
- _add_text(cd.properties[i].name);
- class_desc->pop(); // color
- if (!cd.properties[i].default_value.is_empty()) {
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(" [" + TTR("default:") + " ");
- class_desc->pop(); // color
- class_desc->push_color(theme_cache.value_color);
- _add_text(_fix_constant(cd.properties[i].default_value));
- class_desc->pop(); // color
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text("]");
- class_desc->pop(); // color
- }
- if (cd.properties[i].is_deprecated) {
- DEPRECATED_DOC_TAG;
- }
- if (cd.properties[i].is_experimental) {
- EXPERIMENTAL_DOC_TAG;
- }
- if (cd.is_script_doc && (!cd.properties[i].setter.is_empty() || !cd.properties[i].getter.is_empty())) {
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(" [" + TTR("property:") + " ");
- class_desc->pop(); // color
- if (!cd.properties[i].setter.is_empty()) {
- class_desc->push_color(theme_cache.value_color);
- class_desc->add_text("setter");
- class_desc->pop(); // color
- }
- if (!cd.properties[i].getter.is_empty()) {
- if (!cd.properties[i].setter.is_empty()) {
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text(", ");
- class_desc->pop(); // color
- }
- class_desc->push_color(theme_cache.value_color);
- class_desc->add_text("getter");
- class_desc->pop(); // color
- }
- class_desc->push_color(theme_cache.symbol_color);
- class_desc->add_text("]");
- class_desc->pop(); // color
- }
- _pop_code_font();
- class_desc->pop(); // cell
- // Script doc doesn't have setter, getter.
- if (!cd.is_script_doc) {
- HashMap<String, DocData::MethodDoc> method_map;
- for (int j = 0; j < methods.size(); j++) {
- method_map[methods[j].name] = methods[j];
- }
- if (!cd.properties[i].setter.is_empty()) {
- class_desc->push_cell();
- class_desc->pop(); // cell
- class_desc->push_cell();
- _push_code_font();
- class_desc->push_color(theme_cache.text_color);
- if (method_map[cd.properties[i].setter].arguments.size() > 1) {
- // Setters with additional arguments are exposed in the method list, so we link them here for quick access.
- class_desc->push_meta("@method " + cd.properties[i].setter);
- class_desc->add_text(cd.properties[i].setter + TTR("(value)"));
- class_desc->pop();
- } else {
- class_desc->add_text(cd.properties[i].setter + TTR("(value)"));
- }
- class_desc->pop(); // color
- class_desc->push_color(theme_cache.comment_color);
- class_desc->add_text(" setter");
- class_desc->pop(); // color
- _pop_code_font();
- class_desc->pop(); // cell
- method_line[cd.properties[i].setter] = property_line[cd.properties[i].name];
- }
- if (!cd.properties[i].getter.is_empty()) {
- class_desc->push_cell();
- class_desc->pop(); // cell
- class_desc->push_cell();
- _push_code_font();
- class_desc->push_color(theme_cache.text_color);
- if (method_map[cd.properties[i].getter].arguments.size() > 0) {
- // Getters with additional arguments are exposed in the method list, so we link them here for quick access.
- class_desc->push_meta("@method " + cd.properties[i].getter);
- class_desc->add_text(cd.properties[i].getter + "()");
- class_desc->pop();
- } else {
- class_desc->add_text(cd.properties[i].getter + "()");
- }
- class_desc->pop(); // color
- class_desc->push_color(theme_cache.comment_color);
- class_desc->add_text(" getter");
- class_desc->pop(); // color
- _pop_code_font();
- class_desc->pop(); // cell
- method_line[cd.properties[i].getter] = property_line[cd.properties[i].name];
- }
- }
- class_desc->pop(); // table
- class_desc->add_newline();
- class_desc->add_newline();
- class_desc->push_color(theme_cache.text_color);
- _push_normal_font();
- class_desc->push_indent(1);
- if (!cd.properties[i].description.strip_edges().is_empty()) {
- _add_text(DTR(cd.properties[i].description));
- } else {
- class_desc->add_image(get_theme_icon(SNAME("Error"), SNAME("EditorIcons")));
- class_desc->add_text(" ");
- class_desc->push_color(theme_cache.comment_color);
- if (cd.is_script_doc) {
- class_desc->append_text(TTR("There is currently no description for this property."));
- } else {
- 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));
- }
- class_desc->pop();
- }
- class_desc->pop();
- _pop_normal_font();
- class_desc->pop();
- class_desc->add_newline();
- class_desc->add_newline();
- class_desc->add_newline();
- }
- }
- // Constructor descriptions
- if (!cd.constructors.is_empty()) {
- section_line.push_back(Pair<String, int>(TTR("Constructor Descriptions"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Constructor Descriptions"));
- _pop_title_font();
- _update_method_descriptions(cd, cd.constructors, "constructor");
- }
- // Method descriptions
- if (!methods.is_empty()) {
- section_line.push_back(Pair<String, int>(TTR("Method Descriptions"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Method Descriptions"));
- _pop_title_font();
- _update_method_descriptions(cd, methods, "method");
- }
- // Operator descriptions
- if (!cd.operators.is_empty()) {
- section_line.push_back(Pair<String, int>(TTR("Operator Descriptions"), class_desc->get_paragraph_count() - 2));
- _push_title_font();
- class_desc->add_text(TTR("Operator Descriptions"));
- _pop_title_font();
- _update_method_descriptions(cd, cd.operators, "operator");
- }
- // Free the scroll.
- scroll_locked = false;
- }
- void EditorHelp::_request_help(const String &p_string) {
- Error err = _goto_desc(p_string);
- if (err == OK) {
- EditorNode::get_singleton()->set_visible_editor(EditorNode::EDITOR_SCRIPT);
- }
- }
- void EditorHelp::_help_callback(const String &p_topic) {
- String what = p_topic.get_slice(":", 0);
- String clss = p_topic.get_slice(":", 1);
- String name;
- if (p_topic.get_slice_count(":") == 3) {
- name = p_topic.get_slice(":", 2);
- }
- _request_help(clss); // First go to class.
- int line = 0;
- if (what == "class_desc") {
- line = description_line;
- } else if (what == "class_signal") {
- if (signal_line.has(name)) {
- line = signal_line[name];
- }
- } else if (what == "class_method" || what == "class_method_desc") {
- if (method_line.has(name)) {
- line = method_line[name];
- }
- } else if (what == "class_property") {
- if (property_line.has(name)) {
- line = property_line[name];
- }
- } else if (what == "class_enum") {
- if (enum_line.has(name)) {
- line = enum_line[name];
- }
- } else if (what == "class_theme_item") {
- if (theme_property_line.has(name)) {
- line = theme_property_line[name];
- }
- } else if (what == "class_constant") {
- if (constant_line.has(name)) {
- line = constant_line[name];
- }
- } else if (what == "class_annotation") {
- if (annotation_line.has(name)) {
- line = annotation_line[name];
- }
- } else if (what == "class_global") {
- if (constant_line.has(name)) {
- line = constant_line[name];
- } else if (method_line.has(name)) {
- line = method_line[name];
- } else {
- HashMap<String, HashMap<String, int>>::Iterator iter = enum_values_line.begin();
- while (true) {
- if (iter->value.has(name)) {
- line = iter->value[name];
- break;
- } else if (iter == enum_values_line.last()) {
- break;
- } else {
- ++iter;
- }
- }
- }
- }
- if (class_desc->is_ready()) {
- class_desc->call_deferred(SNAME("scroll_to_paragraph"), line);
- } else {
- scroll_to = line;
- }
- }
- static void _add_text_to_rt(const String &p_bbcode, RichTextLabel *p_rt, Control *p_owner_node) {
- DocTools *doc = EditorHelp::get_doc_data();
- String base_path;
- Ref<Font> doc_font = p_owner_node->get_theme_font(SNAME("doc"), SNAME("EditorFonts"));
- Ref<Font> doc_bold_font = p_owner_node->get_theme_font(SNAME("doc_bold"), SNAME("EditorFonts"));
- Ref<Font> doc_italic_font = p_owner_node->get_theme_font(SNAME("doc_italic"), SNAME("EditorFonts"));
- Ref<Font> doc_code_font = p_owner_node->get_theme_font(SNAME("doc_source"), SNAME("EditorFonts"));
- Ref<Font> doc_kbd_font = p_owner_node->get_theme_font(SNAME("doc_keyboard"), SNAME("EditorFonts"));
- int doc_code_font_size = p_owner_node->get_theme_font_size(SNAME("doc_source_size"), SNAME("EditorFonts"));
- int doc_kbd_font_size = p_owner_node->get_theme_font_size(SNAME("doc_keyboard_size"), SNAME("EditorFonts"));
- 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"));
- const Color link_method_color = p_owner_node->get_theme_color(SNAME("accent_color"), SNAME("Editor"));
- const Color link_property_color = link_color.lerp(p_owner_node->get_theme_color(SNAME("accent_color"), SNAME("Editor")), 0.25);
- const Color link_annotation_color = link_color.lerp(p_owner_node->get_theme_color(SNAME("accent_color"), SNAME("Editor")), 0.5);
- 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"));
- String bbcode = p_bbcode.dedent().replace("\t", "").replace("\r", "").strip_edges();
- // Select the correct code examples.
- switch ((int)EDITOR_GET("text_editor/help/class_reference_examples")) {
- case 0: // GDScript
- bbcode = bbcode.replace("[gdscript]", "[codeblock]");
- bbcode = bbcode.replace("[/gdscript]", "[/codeblock]");
- for (int pos = bbcode.find("[csharp]"); pos != -1; pos = bbcode.find("[csharp]")) {
- int end_pos = bbcode.find("[/csharp]");
- if (end_pos == -1) {
- WARN_PRINT("Unclosed [csharp] block or parse fail in code (search for tag errors)");
- break;
- }
- bbcode = bbcode.left(pos) + bbcode.substr(end_pos + 9); // 9 is length of "[/csharp]".
- while (bbcode[pos] == '\n') {
- bbcode = bbcode.left(pos) + bbcode.substr(pos + 1);
- }
- }
- break;
- case 1: // C#
- bbcode = bbcode.replace("[csharp]", "[codeblock]");
- bbcode = bbcode.replace("[/csharp]", "[/codeblock]");
- for (int pos = bbcode.find("[gdscript]"); pos != -1; pos = bbcode.find("[gdscript]")) {
- int end_pos = bbcode.find("[/gdscript]");
- if (end_pos == -1) {
- WARN_PRINT("Unclosed [gdscript] block or parse fail in code (search for tag errors)");
- break;
- }
- bbcode = bbcode.left(pos) + bbcode.substr(end_pos + 11); // 11 is length of "[/gdscript]".
- while (bbcode[pos] == '\n') {
- bbcode = bbcode.left(pos) + bbcode.substr(pos + 1);
- }
- }
- break;
- case 2: // GDScript and C#
- bbcode = bbcode.replace("[csharp]", "[b]C#:[/b]\n[codeblock]");
- bbcode = bbcode.replace("[gdscript]", "[b]GDScript:[/b]\n[codeblock]");
- bbcode = bbcode.replace("[/csharp]", "[/codeblock]");
- bbcode = bbcode.replace("[/gdscript]", "[/codeblock]");
- break;
- }
- // Remove codeblocks (they would be printed otherwise).
- bbcode = bbcode.replace("[codeblocks]\n", "");
- bbcode = bbcode.replace("\n[/codeblocks]", "");
- bbcode = bbcode.replace("[codeblocks]", "");
- bbcode = bbcode.replace("[/codeblocks]", "");
- // Remove extra new lines around code blocks.
- bbcode = bbcode.replace("[codeblock]\n", "[codeblock]");
- bbcode = bbcode.replace("\n[/codeblock]", "[/codeblock]");
- List<String> tag_stack;
- bool code_tag = false;
- bool codeblock_tag = false;
- int pos = 0;
- while (pos < bbcode.length()) {
- int brk_pos = bbcode.find("[", pos);
- if (brk_pos < 0) {
- brk_pos = bbcode.length();
- }
- if (brk_pos > pos) {
- String text = bbcode.substr(pos, brk_pos - pos);
- if (!code_tag && !codeblock_tag) {
- text = text.replace("\n", "\n\n");
- }
- p_rt->add_text(text);
- }
- if (brk_pos == bbcode.length()) {
- break; // Nothing else to add.
- }
- int brk_end = bbcode.find("]", brk_pos + 1);
- if (brk_end == -1) {
- String text = bbcode.substr(brk_pos, bbcode.length() - brk_pos);
- if (!code_tag && !codeblock_tag) {
- text = text.replace("\n", "\n\n");
- }
- p_rt->add_text(text);
- break;
- }
- String tag = bbcode.substr(brk_pos + 1, brk_end - brk_pos - 1);
- if (tag.begins_with("/")) {
- bool tag_ok = tag_stack.size() && tag_stack.front()->get() == tag.substr(1, tag.length());
- if (!tag_ok) {
- p_rt->add_text("[");
- pos = brk_pos + 1;
- continue;
- }
- tag_stack.pop_front();
- pos = brk_end + 1;
- if (tag != "/img") {
- p_rt->pop();
- if (code_tag) {
- p_rt->pop(); // font size
- // Pop both color and background color.
- p_rt->pop();
- p_rt->pop();
- } else if (codeblock_tag) {
- p_rt->pop(); // font size
- // Pop color, cell and table.
- p_rt->pop();
- p_rt->pop();
- p_rt->pop();
- }
- }
- code_tag = false;
- codeblock_tag = false;
- } else if (code_tag || codeblock_tag) {
- p_rt->add_text("[");
- pos = brk_pos + 1;
- } else if (tag.begins_with("method ") || 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 ")) {
- const int tag_end = tag.find(" ");
- const String link_tag = tag.substr(0, tag_end);
- const String link_target = tag.substr(tag_end + 1, tag.length()).lstrip(" ");
- // Use monospace font to make clickable references
- // easier to distinguish from inline code and other text.
- p_rt->push_font(doc_code_font);
- p_rt->push_font_size(doc_code_font_size);
- Color target_color = link_color;
- if (link_tag == "method") {
- target_color = link_method_color;
- } else if (link_tag == "member" || link_tag == "signal" || link_tag == "theme property") {
- target_color = link_property_color;
- } else if (link_tag == "annotation") {
- target_color = link_annotation_color;
- }
- p_rt->push_color(target_color);
- p_rt->push_meta("@" + link_tag + " " + link_target);
- p_rt->add_text(link_target + (link_tag == "method" ? "()" : ""));
- p_rt->pop();
- p_rt->pop();
- p_rt->pop(); // font size
- p_rt->pop(); // font
- pos = brk_end + 1;
- } else if (tag.begins_with("param ")) {
- const int tag_end = tag.find(" ");
- 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);
- p_rt->push_font_size(doc_code_font_size);
- p_rt->push_bgcolor(param_bg_color);
- p_rt->push_color(code_color);
- p_rt->add_text(param_name);
- p_rt->pop();
- p_rt->pop();
- p_rt->pop(); // font size
- p_rt->pop(); // font
- pos = brk_end + 1;
- } else if (doc->class_list.has(tag)) {
- // Class reference tag such as [Node2D] or [SceneTree].
- // Use monospace font to make clickable references
- // easier to distinguish from inline code and other text.
- p_rt->push_font(doc_code_font);
- p_rt->push_font_size(doc_code_font_size);
- p_rt->push_color(type_color);
- p_rt->push_meta("#" + tag);
- p_rt->add_text(tag);
- p_rt->pop();
- p_rt->pop();
- p_rt->pop(); // font size
- p_rt->pop(); // font
- pos = brk_end + 1;
- } else if (tag == "b") {
- // Use bold font.
- p_rt->push_font(doc_bold_font);
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "i") {
- // Use italics font.
- p_rt->push_font(doc_italic_font);
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "code") {
- // Use monospace font with darkened background color to make code easier to distinguish from other text.
- p_rt->push_font(doc_code_font);
- p_rt->push_font_size(doc_code_font_size);
- p_rt->push_bgcolor(code_bg_color);
- p_rt->push_color(code_color.lerp(p_owner_node->get_theme_color(SNAME("error_color"), SNAME("Editor")), 0.6));
- code_tag = true;
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "codeblock") {
- // Use monospace font with darkened background color to make code easier to distinguish from other text.
- // 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);
- p_rt->push_font_size(doc_code_font_size);
- p_rt->push_table(1);
- 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(10 * EDSCALE, 10 * EDSCALE, 10 * EDSCALE, 10 * EDSCALE));
- p_rt->push_color(code_dark_color);
- codeblock_tag = true;
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "kbd") {
- // Use keyboard font with custom color and background color.
- p_rt->push_font(doc_kbd_font);
- p_rt->push_font_size(doc_kbd_font_size);
- p_rt->push_bgcolor(kbd_bg_color);
- p_rt->push_color(kbd_color);
- code_tag = true; // Though not strictly a code tag, logic is similar.
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "center") {
- // Align to center.
- p_rt->push_paragraph(HORIZONTAL_ALIGNMENT_CENTER, Control::TEXT_DIRECTION_AUTO, "");
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "br") {
- // Force a line break.
- p_rt->add_newline();
- pos = brk_end + 1;
- } else if (tag == "u") {
- // Use underline.
- p_rt->push_underline();
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "s") {
- // Use strikethrough.
- p_rt->push_strikethrough();
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "url") {
- int end = bbcode.find("[", brk_end);
- if (end == -1) {
- end = bbcode.length();
- }
- String url = bbcode.substr(brk_end + 1, end - brk_end - 1);
- p_rt->push_meta(url);
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag.begins_with("url=")) {
- String url = tag.substr(4, tag.length());
- p_rt->push_meta(url);
- pos = brk_end + 1;
- tag_stack.push_front("url");
- } else if (tag == "img") {
- int end = bbcode.find("[", brk_end);
- if (end == -1) {
- end = bbcode.length();
- }
- String image = bbcode.substr(brk_end + 1, end - brk_end - 1);
- Ref<Texture2D> texture = ResourceLoader::load(base_path.path_join(image), "Texture2D");
- if (texture.is_valid()) {
- p_rt->add_image(texture);
- }
- pos = end;
- tag_stack.push_front(tag);
- } else if (tag.begins_with("color=")) {
- String col = tag.substr(6, tag.length());
- Color color = Color::from_string(col, Color());
- p_rt->push_color(color);
- pos = brk_end + 1;
- tag_stack.push_front("color");
- } else if (tag.begins_with("font=")) {
- String fnt = tag.substr(5, tag.length());
- Ref<Font> font = ResourceLoader::load(base_path.path_join(fnt), "Font");
- if (font.is_valid()) {
- p_rt->push_font(font);
- } else {
- p_rt->push_font(doc_font);
- }
- pos = brk_end + 1;
- tag_stack.push_front("font");
- } else {
- p_rt->add_text("["); // ignore
- pos = brk_pos + 1;
- }
- }
- }
- void EditorHelp::_add_text(const String &p_bbcode) {
- _add_text_to_rt(p_bbcode, class_desc, this);
- }
- Thread EditorHelp::thread;
- void EditorHelp::_wait_for_thread() {
- if (thread.is_started()) {
- thread.wait_to_finish();
- }
- }
- String EditorHelp::get_cache_full_path() {
- return EditorPaths::get_singleton()->get_cache_dir().path_join("editor.doc_cache");
- }
- static bool first_attempt = true;
- static String _compute_doc_version_hash() {
- return vformat("%d/%d/%s", ClassDB::get_api_hash(ClassDB::API_CORE), ClassDB::get_api_hash(ClassDB::API_EDITOR), _doc_data_hash);
- }
- void EditorHelp::_load_doc_thread(void *p_udata) {
- DEV_ASSERT(first_attempt);
- Ref<DocCache> cache_res = ResourceLoader::load(get_cache_full_path());
- if (cache_res.is_valid() && cache_res->get_version_hash() == _compute_doc_version_hash()) {
- for (int i = 0; i < cache_res->get_classes().size(); i++) {
- doc->add_doc(DocData::ClassDoc::from_dict(cache_res->get_classes()[i]));
- }
- } else {
- // We have to go back to the main thread to start from scratch.
- first_attempt = false;
- callable_mp_static(&EditorHelp::generate_doc).bind(true).call_deferred();
- }
- }
- void EditorHelp::_gen_doc_thread(void *p_udata) {
- DocTools compdoc;
- compdoc.load_compressed(_doc_data_compressed, _doc_data_compressed_size, _doc_data_uncompressed_size);
- doc->merge_from(compdoc); // Ensure all is up to date.
- Ref<DocCache> cache_res;
- cache_res.instantiate();
- cache_res->set_version_hash(_compute_doc_version_hash());
- Array classes;
- for (const KeyValue<String, DocData::ClassDoc> &E : doc->class_list) {
- classes.push_back(DocData::ClassDoc::to_dict(E.value));
- }
- cache_res->set_classes(classes);
- 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() + ").");
- }
- }
- static bool doc_gen_use_threads = true;
- void EditorHelp::generate_doc(bool p_use_cache) {
- // Temporarily disable use of cache for pre-RC stabilization.
- p_use_cache = false;
- OS::get_singleton()->benchmark_begin_measure("EditorHelp::generate_doc");
- if (doc_gen_use_threads) {
- // In case not the first attempt.
- _wait_for_thread();
- }
- DEV_ASSERT(first_attempt == (doc == nullptr));
- if (!doc) {
- doc = memnew(DocTools);
- }
- if (p_use_cache && first_attempt && FileAccess::exists(get_cache_full_path())) {
- if (doc_gen_use_threads) {
- thread.start(_load_doc_thread, nullptr);
- } else {
- _load_doc_thread(nullptr);
- }
- } else {
- print_verbose("Regenerating editor help cache");
- // Not doable on threads unfortunately, since it instantiates all sorts of classes to get default values.
- doc->generate(true);
- if (doc_gen_use_threads) {
- thread.start(_gen_doc_thread, nullptr);
- } else {
- _gen_doc_thread(nullptr);
- }
- }
- OS::get_singleton()->benchmark_end_measure("EditorHelp::generate_doc");
- }
- void EditorHelp::_toggle_scripts_pressed() {
- ScriptEditor::get_singleton()->toggle_scripts_panel();
- update_toggle_scripts_button();
- }
- void EditorHelp::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_POSTINITIALIZE: {
- // Requires theme to be up to date.
- _class_desc_resized(false);
- } break;
- case NOTIFICATION_READY:
- case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
- _wait_for_thread();
- _update_doc();
- } break;
- case NOTIFICATION_THEME_CHANGED: {
- if (is_inside_tree()) {
- _class_desc_resized(true);
- }
- update_toggle_scripts_button();
- } break;
- case NOTIFICATION_VISIBILITY_CHANGED: {
- update_toggle_scripts_button();
- } break;
- }
- }
- void EditorHelp::go_to_help(const String &p_help) {
- _wait_for_thread();
- _help_callback(p_help);
- }
- void EditorHelp::go_to_class(const String &p_class) {
- _wait_for_thread();
- _goto_desc(p_class);
- }
- void EditorHelp::update_doc() {
- _wait_for_thread();
- ERR_FAIL_COND(!doc->class_list.has(edited_class));
- ERR_FAIL_COND(!doc->class_list[edited_class].is_script_doc);
- _update_doc();
- }
- void EditorHelp::cleanup_doc() {
- _wait_for_thread();
- memdelete(doc);
- }
- Vector<Pair<String, int>> EditorHelp::get_sections() {
- _wait_for_thread();
- Vector<Pair<String, int>> sections;
- 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) {
- _wait_for_thread();
- int line = section_line[p_section_index].second;
- if (class_desc->is_ready()) {
- class_desc->scroll_to_paragraph(line);
- } else {
- scroll_to = line;
- }
- }
- void EditorHelp::popup_search() {
- _wait_for_thread();
- find_bar->popup_search();
- }
- String EditorHelp::get_class() {
- return edited_class;
- }
- void EditorHelp::search_again(bool p_search_previous) {
- _search(p_search_previous);
- }
- int EditorHelp::get_scroll() const {
- return class_desc->get_v_scroll_bar()->get_value();
- }
- void EditorHelp::set_scroll(int p_scroll) {
- class_desc->get_v_scroll_bar()->set_value(p_scroll);
- }
- void EditorHelp::update_toggle_scripts_button() {
- if (is_layout_rtl()) {
- toggle_scripts_button->set_icon(get_theme_icon(ScriptEditor::get_singleton()->is_scripts_panel_toggled() ? SNAME("Forward") : SNAME("Back"), SNAME("EditorIcons")));
- } else {
- toggle_scripts_button->set_icon(get_theme_icon(ScriptEditor::get_singleton()->is_scripts_panel_toggled() ? SNAME("Back") : SNAME("Forward"), SNAME("EditorIcons")));
- }
- toggle_scripts_button->set_tooltip_text(vformat("%s (%s)", TTR("Toggle Scripts Panel"), ED_GET_SHORTCUT("script_editor/toggle_scripts_panel")->get_as_text()));
- }
- void EditorHelp::_bind_methods() {
- 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);
- ADD_SIGNAL(MethodInfo("go_to_help"));
- }
- EditorHelp::EditorHelp() {
- set_custom_minimum_size(Size2(150 * EDSCALE, 0));
- EDITOR_DEF("text_editor/help/sort_functions_alphabetically", true);
- class_desc = memnew(RichTextLabel);
- add_child(class_desc);
- class_desc->set_threaded(true);
- class_desc->set_v_size_flags(SIZE_EXPAND_FILL);
- class_desc->connect("finished", callable_mp(this, &EditorHelp::_class_desc_finished));
- class_desc->connect("meta_clicked", callable_mp(this, &EditorHelp::_class_desc_select));
- class_desc->connect("gui_input", callable_mp(this, &EditorHelp::_class_desc_input));
- class_desc->connect("resized", callable_mp(this, &EditorHelp::_class_desc_resized).bind(false));
- // Added second so it opens at the bottom so it won't offset the entire widget.
- find_bar = memnew(FindBar);
- add_child(find_bar);
- find_bar->hide();
- find_bar->set_rich_text_label(class_desc);
- 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);
- class_desc->set_selection_enabled(true);
- class_desc->set_context_menu_enabled(true);
- class_desc->hide();
- }
- EditorHelp::~EditorHelp() {
- }
- DocTools *EditorHelp::get_doc_data() {
- _wait_for_thread();
- return doc;
- }
- //// EditorHelpBit ///
- void EditorHelpBit::_go_to_help(String p_what) {
- EditorNode::get_singleton()->set_visible_editor(EditorNode::EDITOR_SCRIPT);
- ScriptEditor::get_singleton()->goto_help(p_what);
- emit_signal(SNAME("request_hide"));
- }
- void EditorHelpBit::_meta_clicked(String p_select) {
- if (p_select.begins_with("$")) { // enum
- String select = p_select.substr(1, p_select.length());
- String class_name;
- int rfind = select.rfind(".");
- if (rfind != -1) {
- class_name = select.substr(0, rfind);
- select = select.substr(rfind + 1);
- } else {
- class_name = "@GlobalScope";
- }
- _go_to_help("class_enum:" + class_name + ":" + select);
- return;
- } else if (p_select.begins_with("#")) {
- _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());
- if (m.contains(".")) {
- _go_to_help("class_method:" + m.get_slice(".", 0) + ":" + m.get_slice(".", 0)); // Must go somewhere else.
- }
- }
- }
- void EditorHelpBit::_bind_methods() {
- ClassDB::bind_method(D_METHOD("set_text", "text"), &EditorHelpBit::set_text);
- ADD_SIGNAL(MethodInfo("request_hide"));
- }
- void EditorHelpBit::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_THEME_CHANGED: {
- rich_text->add_theme_color_override("selection_color", get_theme_color(SNAME("selection_color"), SNAME("EditorHelp")));
- rich_text->clear();
- _add_text_to_rt(text, rich_text, this);
- rich_text->reset_size(); // Force recalculating size after parsing bbcode.
- } break;
- }
- }
- void EditorHelpBit::set_text(const String &p_text) {
- text = p_text;
- rich_text->clear();
- _add_text_to_rt(text, rich_text, this);
- }
- EditorHelpBit::EditorHelpBit() {
- rich_text = memnew(RichTextLabel);
- add_child(rich_text);
- rich_text->connect("meta_clicked", callable_mp(this, &EditorHelpBit::_meta_clicked));
- rich_text->set_fit_content(true);
- set_custom_minimum_size(Size2(0, 50 * EDSCALE));
- }
- //// FindBar ///
- FindBar::FindBar() {
- search_text = memnew(LineEdit);
- add_child(search_text);
- search_text->set_custom_minimum_size(Size2(100 * EDSCALE, 0));
- search_text->set_h_size_flags(SIZE_EXPAND_FILL);
- search_text->connect("text_changed", callable_mp(this, &FindBar::_search_text_changed));
- search_text->connect("text_submitted", callable_mp(this, &FindBar::_search_text_submitted));
- matches_label = memnew(Label);
- add_child(matches_label);
- matches_label->hide();
- find_prev = memnew(Button);
- find_prev->set_flat(true);
- add_child(find_prev);
- find_prev->set_focus_mode(FOCUS_NONE);
- find_prev->connect("pressed", callable_mp(this, &FindBar::search_prev));
- find_next = memnew(Button);
- find_next->set_flat(true);
- add_child(find_next);
- find_next->set_focus_mode(FOCUS_NONE);
- find_next->connect("pressed", callable_mp(this, &FindBar::search_next));
- Control *space = memnew(Control);
- add_child(space);
- space->set_custom_minimum_size(Size2(4, 0) * EDSCALE);
- hide_button = memnew(TextureButton);
- add_child(hide_button);
- hide_button->set_focus_mode(FOCUS_NONE);
- hide_button->set_ignore_texture_size(true);
- hide_button->set_stretch_mode(TextureButton::STRETCH_KEEP_CENTERED);
- hide_button->connect("pressed", callable_mp(this, &FindBar::_hide_bar));
- }
- void FindBar::popup_search() {
- show();
- bool grabbed_focus = false;
- if (!search_text->has_focus()) {
- search_text->grab_focus();
- grabbed_focus = true;
- }
- if (!search_text->get_text().is_empty()) {
- search_text->select_all();
- search_text->set_caret_column(search_text->get_text().length());
- if (grabbed_focus) {
- _search();
- }
- }
- }
- void FindBar::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_THEME_CHANGED: {
- find_prev->set_icon(get_theme_icon(SNAME("MoveUp"), SNAME("EditorIcons")));
- find_next->set_icon(get_theme_icon(SNAME("MoveDown"), SNAME("EditorIcons")));
- hide_button->set_texture_normal(get_theme_icon(SNAME("Close"), SNAME("EditorIcons")));
- hide_button->set_texture_hover(get_theme_icon(SNAME("Close"), SNAME("EditorIcons")));
- hide_button->set_texture_pressed(get_theme_icon(SNAME("Close"), SNAME("EditorIcons")));
- hide_button->set_custom_minimum_size(hide_button->get_texture_normal()->get_size());
- 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"), SNAME("Editor")));
- } break;
- case NOTIFICATION_VISIBILITY_CHANGED: {
- set_process_unhandled_input(is_visible_in_tree());
- } break;
- }
- }
- 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) {
- _update_results_count();
- } else {
- results_count = 0;
- }
- _update_matches_label();
- return ret;
- }
- void FindBar::_update_results_count() {
- results_count = 0;
- String searched = search_text->get_text();
- if (searched.is_empty()) {
- return;
- }
- String full_text = rich_text_label->get_parsed_text();
- int from_pos = 0;
- while (true) {
- int pos = full_text.findn(searched, from_pos);
- if (pos == -1) {
- break;
- }
- results_count++;
- from_pos = pos + searched.length();
- }
- }
- void FindBar::_update_matches_label() {
- if (search_text->get_text().is_empty() || results_count == -1) {
- matches_label->hide();
- } else {
- matches_label->show();
- 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"), SNAME("Editor")));
- matches_label->set_text(vformat(results_count == 1 ? TTR("%d match.") : TTR("%d matches."), results_count));
- }
- }
- void FindBar::_hide_bar() {
- if (search_text->has_focus()) {
- rich_text_label->grab_focus();
- }
- hide();
- }
- void FindBar::unhandled_input(const Ref<InputEvent> &p_event) {
- ERR_FAIL_COND(p_event.is_null());
- Ref<InputEventKey> k = p_event;
- 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();
- }
- }
- }
- void FindBar::_search_text_changed(const String &p_text) {
- search_next();
- }
- void FindBar::_search_text_submitted(const String &p_text) {
- if (Input::get_singleton()->is_key_pressed(Key::SHIFT)) {
- search_prev();
- } else {
- search_next();
- }
- }
|