gdscript_editor.cpp 162 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501
  1. /**************************************************************************/
  2. /* gdscript_editor.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "gdscript.h"
  31. #include "gdscript_analyzer.h"
  32. #include "gdscript_parser.h"
  33. #include "gdscript_tokenizer.h"
  34. #include "gdscript_utility_functions.h"
  35. #ifdef TOOLS_ENABLED
  36. #include "editor/gdscript_docgen.h"
  37. #include "editor/script_templates/templates.gen.h"
  38. #endif
  39. #include "core/config/engine.h"
  40. #include "core/core_constants.h"
  41. #include "core/io/file_access.h"
  42. #include "core/math/expression.h"
  43. #ifdef TOOLS_ENABLED
  44. #include "core/config/project_settings.h"
  45. #include "editor/editor_file_system.h"
  46. #include "editor/editor_node.h"
  47. #include "editor/editor_settings.h"
  48. #include "editor/editor_string_names.h"
  49. #endif
  50. Vector<String> GDScriptLanguage::get_comment_delimiters() const {
  51. static const Vector<String> delimiters = { "#" };
  52. return delimiters;
  53. }
  54. Vector<String> GDScriptLanguage::get_doc_comment_delimiters() const {
  55. static const Vector<String> delimiters = { "##" };
  56. return delimiters;
  57. }
  58. Vector<String> GDScriptLanguage::get_string_delimiters() const {
  59. static const Vector<String> delimiters = {
  60. "\" \"",
  61. "' '",
  62. "\"\"\" \"\"\"",
  63. "''' '''",
  64. };
  65. // NOTE: StringName, NodePath and r-strings are not listed here.
  66. return delimiters;
  67. }
  68. bool GDScriptLanguage::is_using_templates() {
  69. return true;
  70. }
  71. Ref<Script> GDScriptLanguage::make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const {
  72. Ref<GDScript> scr;
  73. scr.instantiate();
  74. String processed_template = p_template;
  75. #ifdef TOOLS_ENABLED
  76. const bool type_hints = EditorSettings::get_singleton()->get_setting("text_editor/completion/add_type_hints");
  77. #else
  78. const bool type_hints = true;
  79. #endif
  80. if (!type_hints) {
  81. processed_template = processed_template.replace(": int", "")
  82. .replace(": Shader.Mode", "")
  83. .replace(": VisualShader.Type", "")
  84. .replace(": float", "")
  85. .replace(": String", "")
  86. .replace(": Array[String]", "")
  87. .replace(": Node", "")
  88. .replace(": CharFXTransform", "")
  89. .replace(":=", "=")
  90. .replace(" -> void", "")
  91. .replace(" -> bool", "")
  92. .replace(" -> int", "")
  93. .replace(" -> PortType", "")
  94. .replace(" -> String", "")
  95. .replace(" -> Object", "");
  96. }
  97. processed_template = processed_template.replace("_BASE_", p_base_class_name)
  98. .replace("_CLASS_SNAKE_CASE_", p_class_name.to_snake_case().validate_unicode_identifier())
  99. .replace("_CLASS_", p_class_name.to_pascal_case().validate_unicode_identifier())
  100. .replace("_TS_", _get_indentation());
  101. scr->set_source_code(processed_template);
  102. return scr;
  103. }
  104. Vector<ScriptLanguage::ScriptTemplate> GDScriptLanguage::get_built_in_templates(const StringName &p_object) {
  105. Vector<ScriptLanguage::ScriptTemplate> templates;
  106. #ifdef TOOLS_ENABLED
  107. for (int i = 0; i < TEMPLATES_ARRAY_SIZE; i++) {
  108. if (TEMPLATES[i].inherit == p_object) {
  109. templates.append(TEMPLATES[i]);
  110. }
  111. }
  112. #endif
  113. return templates;
  114. }
  115. static void get_function_names_recursively(const GDScriptParser::ClassNode *p_class, const String &p_prefix, HashMap<int, String> &r_funcs) {
  116. for (int i = 0; i < p_class->members.size(); i++) {
  117. if (p_class->members[i].type == GDScriptParser::ClassNode::Member::FUNCTION) {
  118. const GDScriptParser::FunctionNode *function = p_class->members[i].function;
  119. r_funcs[function->start_line] = p_prefix.is_empty() ? String(function->identifier->name) : p_prefix + "." + String(function->identifier->name);
  120. } else if (p_class->members[i].type == GDScriptParser::ClassNode::Member::CLASS) {
  121. String new_prefix = p_class->members[i].m_class->identifier->name;
  122. get_function_names_recursively(p_class->members[i].m_class, p_prefix.is_empty() ? new_prefix : p_prefix + "." + new_prefix, r_funcs);
  123. }
  124. }
  125. }
  126. bool GDScriptLanguage::validate(const String &p_script, const String &p_path, List<String> *r_functions, List<ScriptLanguage::ScriptError> *r_errors, List<ScriptLanguage::Warning> *r_warnings, HashSet<int> *r_safe_lines) const {
  127. GDScriptParser parser;
  128. GDScriptAnalyzer analyzer(&parser);
  129. Error err = parser.parse(p_script, p_path, false);
  130. if (err == OK) {
  131. err = analyzer.analyze();
  132. }
  133. #ifdef DEBUG_ENABLED
  134. if (r_warnings) {
  135. for (const GDScriptWarning &E : parser.get_warnings()) {
  136. const GDScriptWarning &warn = E;
  137. ScriptLanguage::Warning w;
  138. w.start_line = warn.start_line;
  139. w.end_line = warn.end_line;
  140. w.code = (int)warn.code;
  141. w.string_code = GDScriptWarning::get_name_from_code(warn.code);
  142. w.message = warn.get_message();
  143. r_warnings->push_back(w);
  144. }
  145. }
  146. #endif
  147. if (err) {
  148. if (r_errors) {
  149. for (const GDScriptParser::ParserError &pe : parser.get_errors()) {
  150. ScriptLanguage::ScriptError e;
  151. e.path = p_path;
  152. e.line = pe.line;
  153. e.column = pe.column;
  154. e.message = pe.message;
  155. r_errors->push_back(e);
  156. }
  157. for (KeyValue<String, Ref<GDScriptParserRef>> E : parser.get_depended_parsers()) {
  158. GDScriptParser *depended_parser = E.value->get_parser();
  159. for (const GDScriptParser::ParserError &pe : depended_parser->get_errors()) {
  160. ScriptLanguage::ScriptError e;
  161. e.path = E.key;
  162. e.line = pe.line;
  163. e.column = pe.column;
  164. e.message = pe.message;
  165. r_errors->push_back(e);
  166. }
  167. }
  168. }
  169. return false;
  170. } else if (r_functions) {
  171. const GDScriptParser::ClassNode *cl = parser.get_tree();
  172. HashMap<int, String> funcs;
  173. get_function_names_recursively(cl, "", funcs);
  174. for (const KeyValue<int, String> &E : funcs) {
  175. r_functions->push_back(E.value + ":" + itos(E.key));
  176. }
  177. }
  178. #ifdef DEBUG_ENABLED
  179. if (r_safe_lines) {
  180. const HashSet<int> &unsafe_lines = parser.get_unsafe_lines();
  181. for (int i = 1; i <= parser.get_last_line_number(); i++) {
  182. if (!unsafe_lines.has(i)) {
  183. r_safe_lines->insert(i);
  184. }
  185. }
  186. }
  187. #endif
  188. return true;
  189. }
  190. bool GDScriptLanguage::supports_builtin_mode() const {
  191. return true;
  192. }
  193. bool GDScriptLanguage::supports_documentation() const {
  194. return true;
  195. }
  196. int GDScriptLanguage::find_function(const String &p_function, const String &p_code) const {
  197. GDScriptTokenizerText tokenizer;
  198. tokenizer.set_source_code(p_code);
  199. int indent = 0;
  200. GDScriptTokenizer::Token current = tokenizer.scan();
  201. while (current.type != GDScriptTokenizer::Token::TK_EOF && current.type != GDScriptTokenizer::Token::ERROR) {
  202. if (current.type == GDScriptTokenizer::Token::INDENT) {
  203. indent++;
  204. } else if (current.type == GDScriptTokenizer::Token::DEDENT) {
  205. indent--;
  206. }
  207. if (indent == 0 && current.type == GDScriptTokenizer::Token::FUNC) {
  208. current = tokenizer.scan();
  209. if (current.is_identifier()) {
  210. String identifier = current.get_identifier();
  211. if (identifier == p_function) {
  212. return current.start_line;
  213. }
  214. }
  215. }
  216. current = tokenizer.scan();
  217. }
  218. return -1;
  219. }
  220. Script *GDScriptLanguage::create_script() const {
  221. return memnew(GDScript);
  222. }
  223. /* DEBUGGER FUNCTIONS */
  224. thread_local int GDScriptLanguage::_debug_parse_err_line = -1;
  225. thread_local String GDScriptLanguage::_debug_parse_err_file;
  226. thread_local String GDScriptLanguage::_debug_error;
  227. bool GDScriptLanguage::debug_break_parse(const String &p_file, int p_line, const String &p_error) {
  228. // break because of parse error
  229. if (EngineDebugger::is_active() && Thread::get_caller_id() == Thread::get_main_id()) {
  230. _debug_parse_err_line = p_line;
  231. _debug_parse_err_file = p_file;
  232. _debug_error = p_error;
  233. EngineDebugger::get_script_debugger()->debug(this, false, true);
  234. // Because this is thread local, clear the memory afterwards.
  235. _debug_parse_err_file = String();
  236. _debug_error = String();
  237. return true;
  238. } else {
  239. return false;
  240. }
  241. }
  242. bool GDScriptLanguage::debug_break(const String &p_error, bool p_allow_continue) {
  243. if (EngineDebugger::is_active()) {
  244. _debug_parse_err_line = -1;
  245. _debug_parse_err_file = "";
  246. _debug_error = p_error;
  247. bool is_error_breakpoint = p_error != "Breakpoint";
  248. EngineDebugger::get_script_debugger()->debug(this, p_allow_continue, is_error_breakpoint);
  249. // Because this is thread local, clear the memory afterwards.
  250. _debug_parse_err_file = String();
  251. _debug_error = String();
  252. return true;
  253. } else {
  254. return false;
  255. }
  256. }
  257. String GDScriptLanguage::debug_get_error() const {
  258. return _debug_error;
  259. }
  260. int GDScriptLanguage::debug_get_stack_level_count() const {
  261. if (_debug_parse_err_line >= 0) {
  262. return 1;
  263. }
  264. return _call_stack_size;
  265. }
  266. int GDScriptLanguage::debug_get_stack_level_line(int p_level) const {
  267. if (_debug_parse_err_line >= 0) {
  268. return _debug_parse_err_line;
  269. }
  270. ERR_FAIL_INDEX_V(p_level, (int)_call_stack_size, -1);
  271. return *(_get_stack_level(p_level)->line);
  272. }
  273. String GDScriptLanguage::debug_get_stack_level_function(int p_level) const {
  274. if (_debug_parse_err_line >= 0) {
  275. return "";
  276. }
  277. ERR_FAIL_INDEX_V(p_level, (int)_call_stack_size, "");
  278. GDScriptFunction *func = _get_stack_level(p_level)->function;
  279. return func ? func->get_name().operator String() : "";
  280. }
  281. String GDScriptLanguage::debug_get_stack_level_source(int p_level) const {
  282. if (_debug_parse_err_line >= 0) {
  283. return _debug_parse_err_file;
  284. }
  285. ERR_FAIL_INDEX_V(p_level, (int)_call_stack_size, "");
  286. return _get_stack_level(p_level)->function->get_source();
  287. }
  288. void GDScriptLanguage::debug_get_stack_level_locals(int p_level, List<String> *p_locals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  289. if (_debug_parse_err_line >= 0) {
  290. return;
  291. }
  292. ERR_FAIL_INDEX(p_level, (int)_call_stack_size);
  293. CallLevel *cl = _get_stack_level(p_level);
  294. GDScriptFunction *f = cl->function;
  295. List<Pair<StringName, int>> locals;
  296. f->debug_get_stack_member_state(*cl->line, &locals);
  297. for (const Pair<StringName, int> &E : locals) {
  298. p_locals->push_back(E.first);
  299. p_values->push_back(cl->stack[E.second]);
  300. }
  301. }
  302. void GDScriptLanguage::debug_get_stack_level_members(int p_level, List<String> *p_members, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  303. if (_debug_parse_err_line >= 0) {
  304. return;
  305. }
  306. ERR_FAIL_INDEX(p_level, (int)_call_stack_size);
  307. CallLevel *cl = _get_stack_level(p_level);
  308. GDScriptInstance *instance = cl->instance;
  309. if (!instance) {
  310. return;
  311. }
  312. Ref<GDScript> scr = instance->get_script();
  313. ERR_FAIL_COND(scr.is_null());
  314. const HashMap<StringName, GDScript::MemberInfo> &mi = scr->debug_get_member_indices();
  315. for (const KeyValue<StringName, GDScript::MemberInfo> &E : mi) {
  316. p_members->push_back(E.key);
  317. p_values->push_back(instance->debug_get_member_by_index(E.value.index));
  318. }
  319. }
  320. ScriptInstance *GDScriptLanguage::debug_get_stack_level_instance(int p_level) {
  321. if (_debug_parse_err_line >= 0) {
  322. return nullptr;
  323. }
  324. ERR_FAIL_INDEX_V(p_level, (int)_call_stack_size, nullptr);
  325. return _get_stack_level(p_level)->instance;
  326. }
  327. void GDScriptLanguage::debug_get_globals(List<String> *p_globals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  328. const HashMap<StringName, int> &name_idx = GDScriptLanguage::get_singleton()->get_global_map();
  329. const Variant *gl_array = GDScriptLanguage::get_singleton()->get_global_array();
  330. List<Pair<String, Variant>> cinfo;
  331. get_public_constants(&cinfo);
  332. for (const KeyValue<StringName, int> &E : name_idx) {
  333. if (ClassDB::class_exists(E.key) || Engine::get_singleton()->has_singleton(E.key)) {
  334. continue;
  335. }
  336. bool is_script_constant = false;
  337. for (List<Pair<String, Variant>>::Element *CE = cinfo.front(); CE; CE = CE->next()) {
  338. if (CE->get().first == E.key) {
  339. is_script_constant = true;
  340. break;
  341. }
  342. }
  343. if (is_script_constant) {
  344. continue;
  345. }
  346. const Variant &var = gl_array[E.value];
  347. bool freed = false;
  348. const Object *obj = var.get_validated_object_with_check(freed);
  349. if (obj && !freed) {
  350. if (Object::cast_to<GDScriptNativeClass>(obj)) {
  351. continue;
  352. }
  353. }
  354. bool skip = false;
  355. for (int i = 0; i < CoreConstants::get_global_constant_count(); i++) {
  356. if (E.key == CoreConstants::get_global_constant_name(i)) {
  357. skip = true;
  358. break;
  359. }
  360. }
  361. if (skip) {
  362. continue;
  363. }
  364. p_globals->push_back(E.key);
  365. p_values->push_back(var);
  366. }
  367. }
  368. String GDScriptLanguage::debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems, int p_max_depth) {
  369. List<String> names;
  370. List<Variant> values;
  371. debug_get_stack_level_locals(p_level, &names, &values, p_max_subitems, p_max_depth);
  372. Vector<String> name_vector;
  373. for (const String &name : names) {
  374. name_vector.push_back(name);
  375. }
  376. Array value_array;
  377. for (const Variant &value : values) {
  378. value_array.push_back(value);
  379. }
  380. Expression expression;
  381. if (expression.parse(p_expression, name_vector) == OK) {
  382. ScriptInstance *instance = debug_get_stack_level_instance(p_level);
  383. if (instance) {
  384. Variant return_val = expression.execute(value_array, instance->get_owner());
  385. return return_val.get_construct_string();
  386. }
  387. }
  388. return String();
  389. }
  390. void GDScriptLanguage::get_recognized_extensions(List<String> *p_extensions) const {
  391. p_extensions->push_back("gd");
  392. }
  393. void GDScriptLanguage::get_public_functions(List<MethodInfo> *p_functions) const {
  394. List<StringName> functions;
  395. GDScriptUtilityFunctions::get_function_list(&functions);
  396. for (const StringName &E : functions) {
  397. p_functions->push_back(GDScriptUtilityFunctions::get_function_info(E));
  398. }
  399. // Not really "functions", but show in documentation.
  400. {
  401. MethodInfo mi;
  402. mi.name = "preload";
  403. mi.arguments.push_back(PropertyInfo(Variant::STRING, "path"));
  404. mi.return_val = PropertyInfo(Variant::OBJECT, "", PROPERTY_HINT_RESOURCE_TYPE, "Resource");
  405. p_functions->push_back(mi);
  406. }
  407. {
  408. MethodInfo mi;
  409. mi.name = "assert";
  410. mi.return_val.type = Variant::NIL;
  411. mi.arguments.push_back(PropertyInfo(Variant::BOOL, "condition"));
  412. mi.arguments.push_back(PropertyInfo(Variant::STRING, "message"));
  413. mi.default_arguments.push_back(String());
  414. p_functions->push_back(mi);
  415. }
  416. }
  417. void GDScriptLanguage::get_public_constants(List<Pair<String, Variant>> *p_constants) const {
  418. Pair<String, Variant> pi;
  419. pi.first = "PI";
  420. pi.second = Math::PI;
  421. p_constants->push_back(pi);
  422. Pair<String, Variant> tau;
  423. tau.first = "TAU";
  424. tau.second = Math::TAU;
  425. p_constants->push_back(tau);
  426. Pair<String, Variant> infinity;
  427. infinity.first = "INF";
  428. infinity.second = Math::INF;
  429. p_constants->push_back(infinity);
  430. Pair<String, Variant> nan;
  431. nan.first = "NAN";
  432. nan.second = Math::NaN;
  433. p_constants->push_back(nan);
  434. }
  435. void GDScriptLanguage::get_public_annotations(List<MethodInfo> *p_annotations) const {
  436. GDScriptParser parser;
  437. List<MethodInfo> annotations;
  438. parser.get_annotation_list(&annotations);
  439. for (const MethodInfo &E : annotations) {
  440. p_annotations->push_back(E);
  441. }
  442. }
  443. String GDScriptLanguage::make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const {
  444. #ifdef TOOLS_ENABLED
  445. const bool type_hints = EditorSettings::get_singleton()->get_setting("text_editor/completion/add_type_hints");
  446. #else
  447. const bool type_hints = true;
  448. #endif
  449. String result = "func " + p_name + "(";
  450. if (p_args.size()) {
  451. for (int i = 0; i < p_args.size(); i++) {
  452. if (i > 0) {
  453. result += ", ";
  454. }
  455. const String name_unstripped = p_args[i].get_slicec(':', 0);
  456. result += name_unstripped.strip_edges();
  457. if (type_hints) {
  458. const String type_stripped = p_args[i].substr(name_unstripped.length() + 1).strip_edges();
  459. if (!type_stripped.is_empty()) {
  460. result += ": " + type_stripped;
  461. }
  462. }
  463. }
  464. }
  465. result += String(")") + (type_hints ? " -> void" : "") + ":\n" +
  466. _get_indentation() + "pass # Replace with function body.\n";
  467. return result;
  468. }
  469. //////// COMPLETION //////////
  470. #ifdef TOOLS_ENABLED
  471. #define COMPLETION_RECURSION_LIMIT 200
  472. struct GDScriptCompletionIdentifier {
  473. GDScriptParser::DataType type;
  474. String enumeration;
  475. Variant value;
  476. const GDScriptParser::ExpressionNode *assigned_expression = nullptr;
  477. };
  478. // LOCATION METHODS
  479. // These methods are used to populate the `CodeCompletionOption::location` integer.
  480. // For these methods, the location is based on the depth in the inheritance chain that the property
  481. // appears. For example, if you are completing code in a class that inherits Node2D, a property found on Node2D
  482. // will have a "better" (lower) location "score" than a property that is found on CanvasItem.
  483. static int _get_property_location(const StringName &p_class, const StringName &p_property) {
  484. if (!ClassDB::has_property(p_class, p_property)) {
  485. return ScriptLanguage::LOCATION_OTHER;
  486. }
  487. int depth = 0;
  488. StringName class_test = p_class;
  489. while (class_test && !ClassDB::has_property(class_test, p_property, true)) {
  490. class_test = ClassDB::get_parent_class(class_test);
  491. depth++;
  492. }
  493. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  494. }
  495. static int _get_property_location(Ref<Script> p_script, const StringName &p_property) {
  496. int depth = 0;
  497. Ref<Script> scr = p_script;
  498. while (scr.is_valid()) {
  499. if (scr->get_member_line(p_property) != -1) {
  500. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  501. }
  502. depth++;
  503. scr = scr->get_base_script();
  504. }
  505. return depth + _get_property_location(p_script->get_instance_base_type(), p_property);
  506. }
  507. static int _get_constant_location(const StringName &p_class, const StringName &p_constant) {
  508. if (!ClassDB::has_integer_constant(p_class, p_constant)) {
  509. return ScriptLanguage::LOCATION_OTHER;
  510. }
  511. int depth = 0;
  512. StringName class_test = p_class;
  513. while (class_test && !ClassDB::has_integer_constant(class_test, p_constant, true)) {
  514. class_test = ClassDB::get_parent_class(class_test);
  515. depth++;
  516. }
  517. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  518. }
  519. static int _get_constant_location(Ref<Script> p_script, const StringName &p_constant) {
  520. int depth = 0;
  521. Ref<Script> scr = p_script;
  522. while (scr.is_valid()) {
  523. if (scr->get_member_line(p_constant) != -1) {
  524. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  525. }
  526. depth++;
  527. scr = scr->get_base_script();
  528. }
  529. return depth + _get_constant_location(p_script->get_instance_base_type(), p_constant);
  530. }
  531. static int _get_signal_location(const StringName &p_class, const StringName &p_signal) {
  532. if (!ClassDB::has_signal(p_class, p_signal)) {
  533. return ScriptLanguage::LOCATION_OTHER;
  534. }
  535. int depth = 0;
  536. StringName class_test = p_class;
  537. while (class_test && !ClassDB::has_signal(class_test, p_signal, true)) {
  538. class_test = ClassDB::get_parent_class(class_test);
  539. depth++;
  540. }
  541. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  542. }
  543. static int _get_signal_location(Ref<Script> p_script, const StringName &p_signal) {
  544. int depth = 0;
  545. Ref<Script> scr = p_script;
  546. while (scr.is_valid()) {
  547. if (scr->get_member_line(p_signal) != -1) {
  548. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  549. }
  550. depth++;
  551. scr = scr->get_base_script();
  552. }
  553. return depth + _get_signal_location(p_script->get_instance_base_type(), p_signal);
  554. }
  555. static int _get_method_location(const StringName &p_class, const StringName &p_method) {
  556. if (!ClassDB::has_method(p_class, p_method)) {
  557. return ScriptLanguage::LOCATION_OTHER;
  558. }
  559. int depth = 0;
  560. StringName class_test = p_class;
  561. while (class_test && !ClassDB::has_method(class_test, p_method, true)) {
  562. class_test = ClassDB::get_parent_class(class_test);
  563. depth++;
  564. }
  565. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  566. }
  567. static int _get_enum_constant_location(const StringName &p_class, const StringName &p_enum_constant) {
  568. if (!ClassDB::get_integer_constant_enum(p_class, p_enum_constant)) {
  569. return ScriptLanguage::LOCATION_OTHER;
  570. }
  571. int depth = 0;
  572. StringName class_test = p_class;
  573. while (class_test && !ClassDB::get_integer_constant_enum(class_test, p_enum_constant, true)) {
  574. class_test = ClassDB::get_parent_class(class_test);
  575. depth++;
  576. }
  577. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  578. }
  579. static int _get_enum_location(const StringName &p_class, const StringName &p_enum) {
  580. if (!ClassDB::has_enum(p_class, p_enum)) {
  581. return ScriptLanguage::LOCATION_OTHER;
  582. }
  583. int depth = 0;
  584. StringName class_test = p_class;
  585. while (class_test && !ClassDB::has_enum(class_test, p_enum, true)) {
  586. class_test = ClassDB::get_parent_class(class_test);
  587. depth++;
  588. }
  589. return depth | ScriptLanguage::LOCATION_PARENT_MASK;
  590. }
  591. // END LOCATION METHODS
  592. static String _trim_parent_class(const String &p_class, const String &p_base_class) {
  593. if (p_base_class.is_empty()) {
  594. return p_class;
  595. }
  596. Vector<String> names = p_class.split(".", false, 1);
  597. if (names.size() == 2) {
  598. const String &first = names[0];
  599. if (ClassDB::class_exists(p_base_class) && ClassDB::class_exists(first) && ClassDB::is_parent_class(p_base_class, first)) {
  600. const String &rest = names[1];
  601. return rest;
  602. }
  603. }
  604. return p_class;
  605. }
  606. static String _get_visual_datatype(const PropertyInfo &p_info, bool p_is_arg, const String &p_base_class = "") {
  607. String class_name = p_info.class_name;
  608. bool is_enum = p_info.type == Variant::INT && p_info.usage & PROPERTY_USAGE_CLASS_IS_ENUM;
  609. // PROPERTY_USAGE_CLASS_IS_BITFIELD: BitField[T] isn't supported (yet?), use plain int.
  610. if ((p_info.type == Variant::OBJECT || is_enum) && !class_name.is_empty()) {
  611. if (is_enum && CoreConstants::is_global_enum(p_info.class_name)) {
  612. return class_name;
  613. }
  614. return _trim_parent_class(class_name, p_base_class);
  615. } else if (p_info.type == Variant::ARRAY && p_info.hint == PROPERTY_HINT_ARRAY_TYPE && !p_info.hint_string.is_empty()) {
  616. return "Array[" + _trim_parent_class(p_info.hint_string, p_base_class) + "]";
  617. } else if (p_info.type == Variant::DICTIONARY && p_info.hint == PROPERTY_HINT_DICTIONARY_TYPE && !p_info.hint_string.is_empty()) {
  618. const String key = p_info.hint_string.get_slicec(';', 0);
  619. const String value = p_info.hint_string.get_slicec(';', 1);
  620. return "Dictionary[" + _trim_parent_class(key, p_base_class) + ", " + _trim_parent_class(value, p_base_class) + "]";
  621. } else if (p_info.type == Variant::NIL) {
  622. if (p_is_arg || (p_info.usage & PROPERTY_USAGE_NIL_IS_VARIANT)) {
  623. return "Variant";
  624. } else {
  625. return "void";
  626. }
  627. }
  628. return Variant::get_type_name(p_info.type);
  629. }
  630. static String _make_arguments_hint(const MethodInfo &p_info, int p_arg_idx, bool p_is_annotation = false) {
  631. String arghint;
  632. if (!p_is_annotation) {
  633. arghint += _get_visual_datatype(p_info.return_val, false) + " ";
  634. }
  635. arghint += p_info.name + "(";
  636. int def_args = p_info.arguments.size() - p_info.default_arguments.size();
  637. int i = 0;
  638. for (const PropertyInfo &E : p_info.arguments) {
  639. if (i > 0) {
  640. arghint += ", ";
  641. }
  642. if (i == p_arg_idx) {
  643. arghint += String::chr(0xFFFF);
  644. }
  645. arghint += E.name + ": " + _get_visual_datatype(E, true);
  646. if (i - def_args >= 0) {
  647. arghint += String(" = ") + p_info.default_arguments[i - def_args].get_construct_string();
  648. }
  649. if (i == p_arg_idx) {
  650. arghint += String::chr(0xFFFF);
  651. }
  652. i++;
  653. }
  654. if (p_info.flags & METHOD_FLAG_VARARG) {
  655. if (p_info.arguments.size() > 0) {
  656. arghint += ", ";
  657. }
  658. if (p_arg_idx >= p_info.arguments.size()) {
  659. arghint += String::chr(0xFFFF);
  660. }
  661. arghint += "...args: Array"; // `MethodInfo` does not support the rest parameter name.
  662. if (p_arg_idx >= p_info.arguments.size()) {
  663. arghint += String::chr(0xFFFF);
  664. }
  665. }
  666. arghint += ")";
  667. return arghint;
  668. }
  669. static String _make_arguments_hint(const GDScriptParser::FunctionNode *p_function, int p_arg_idx, bool p_just_args = false) {
  670. String arghint;
  671. if (p_just_args) {
  672. arghint = "(";
  673. } else {
  674. if (p_function->get_datatype().builtin_type == Variant::NIL) {
  675. arghint = "void " + p_function->identifier->name + "(";
  676. } else {
  677. arghint = p_function->get_datatype().to_string() + " " + p_function->identifier->name + "(";
  678. }
  679. }
  680. for (int i = 0; i < p_function->parameters.size(); i++) {
  681. if (i > 0) {
  682. arghint += ", ";
  683. }
  684. if (i == p_arg_idx) {
  685. arghint += String::chr(0xFFFF);
  686. }
  687. const GDScriptParser::ParameterNode *par = p_function->parameters[i];
  688. if (!par->get_datatype().is_hard_type()) {
  689. arghint += par->identifier->name.operator String() + ": Variant";
  690. } else {
  691. arghint += par->identifier->name.operator String() + ": " + par->get_datatype().to_string();
  692. }
  693. if (par->initializer) {
  694. String def_val = "<unknown>";
  695. switch (par->initializer->type) {
  696. case GDScriptParser::Node::LITERAL: {
  697. const GDScriptParser::LiteralNode *literal = static_cast<const GDScriptParser::LiteralNode *>(par->initializer);
  698. def_val = literal->value.get_construct_string();
  699. } break;
  700. case GDScriptParser::Node::IDENTIFIER: {
  701. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(par->initializer);
  702. def_val = id->name.operator String();
  703. } break;
  704. case GDScriptParser::Node::CALL: {
  705. const GDScriptParser::CallNode *call = static_cast<const GDScriptParser::CallNode *>(par->initializer);
  706. if (call->is_constant && call->reduced) {
  707. def_val = call->reduced_value.get_construct_string();
  708. } else if (call->get_callee_type() == GDScriptParser::Node::IDENTIFIER) {
  709. def_val = call->function_name.operator String() + (call->arguments.is_empty() ? "()" : "(...)");
  710. }
  711. } break;
  712. case GDScriptParser::Node::ARRAY: {
  713. const GDScriptParser::ArrayNode *arr = static_cast<const GDScriptParser::ArrayNode *>(par->initializer);
  714. if (arr->is_constant && arr->reduced) {
  715. def_val = arr->reduced_value.get_construct_string();
  716. } else {
  717. def_val = arr->elements.is_empty() ? "[]" : "[...]";
  718. }
  719. } break;
  720. case GDScriptParser::Node::DICTIONARY: {
  721. const GDScriptParser::DictionaryNode *dict = static_cast<const GDScriptParser::DictionaryNode *>(par->initializer);
  722. if (dict->is_constant && dict->reduced) {
  723. def_val = dict->reduced_value.get_construct_string();
  724. } else {
  725. def_val = dict->elements.is_empty() ? "{}" : "{...}";
  726. }
  727. } break;
  728. case GDScriptParser::Node::SUBSCRIPT: {
  729. const GDScriptParser::SubscriptNode *sub = static_cast<const GDScriptParser::SubscriptNode *>(par->initializer);
  730. if (sub->is_attribute && sub->datatype.kind == GDScriptParser::DataType::ENUM && !sub->datatype.is_meta_type) {
  731. def_val = sub->get_datatype().to_string() + "." + sub->attribute->name;
  732. } else if (sub->is_constant && sub->reduced) {
  733. def_val = sub->reduced_value.get_construct_string();
  734. }
  735. } break;
  736. default:
  737. break;
  738. }
  739. arghint += " = " + def_val;
  740. }
  741. if (i == p_arg_idx) {
  742. arghint += String::chr(0xFFFF);
  743. }
  744. }
  745. if (p_function->is_vararg()) {
  746. if (!p_function->parameters.is_empty()) {
  747. arghint += ", ";
  748. }
  749. if (p_arg_idx >= p_function->parameters.size()) {
  750. arghint += String::chr(0xFFFF);
  751. }
  752. const GDScriptParser::ParameterNode *rest_param = p_function->rest_parameter;
  753. arghint += "..." + rest_param->identifier->name + ": " + rest_param->get_datatype().to_string();
  754. if (p_arg_idx >= p_function->parameters.size()) {
  755. arghint += String::chr(0xFFFF);
  756. }
  757. }
  758. arghint += ")";
  759. return arghint;
  760. }
  761. static void _get_directory_contents(EditorFileSystemDirectory *p_dir, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_list, const StringName &p_required_type = StringName()) {
  762. const String quote_style = EDITOR_GET("text_editor/completion/use_single_quotes") ? "'" : "\"";
  763. const bool requires_type = !p_required_type.is_empty();
  764. for (int i = 0; i < p_dir->get_file_count(); i++) {
  765. if (requires_type && !ClassDB::is_parent_class(p_dir->get_file_type(i), p_required_type)) {
  766. continue;
  767. }
  768. ScriptLanguage::CodeCompletionOption option(p_dir->get_file_path(i).quote(quote_style), ScriptLanguage::CODE_COMPLETION_KIND_FILE_PATH);
  769. r_list.insert(option.display, option);
  770. }
  771. for (int i = 0; i < p_dir->get_subdir_count(); i++) {
  772. _get_directory_contents(p_dir->get_subdir(i), r_list, p_required_type);
  773. }
  774. }
  775. static void _find_annotation_arguments(const GDScriptParser::AnnotationNode *p_annotation, int p_argument, const String p_quote_style, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, String &r_arghint) {
  776. ERR_FAIL_NULL(p_annotation);
  777. if (p_annotation->info != nullptr) {
  778. r_arghint = _make_arguments_hint(p_annotation->info->info, p_argument, true);
  779. }
  780. if (p_annotation->name == SNAME("@export_range")) {
  781. if (p_argument == 3 || p_argument == 4 || p_argument == 5) {
  782. // Slider hint.
  783. ScriptLanguage::CodeCompletionOption slider1("or_greater", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  784. slider1.insert_text = slider1.display.quote(p_quote_style);
  785. r_result.insert(slider1.display, slider1);
  786. ScriptLanguage::CodeCompletionOption slider2("or_less", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  787. slider2.insert_text = slider2.display.quote(p_quote_style);
  788. r_result.insert(slider2.display, slider2);
  789. ScriptLanguage::CodeCompletionOption slider3("hide_slider", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  790. slider3.insert_text = slider3.display.quote(p_quote_style);
  791. r_result.insert(slider3.display, slider3);
  792. }
  793. } else if (p_annotation->name == SNAME("@export_exp_easing")) {
  794. if (p_argument == 0 || p_argument == 1) {
  795. // Easing hint.
  796. ScriptLanguage::CodeCompletionOption hint1("attenuation", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  797. hint1.insert_text = hint1.display.quote(p_quote_style);
  798. r_result.insert(hint1.display, hint1);
  799. ScriptLanguage::CodeCompletionOption hint2("inout", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  800. hint2.insert_text = hint2.display.quote(p_quote_style);
  801. r_result.insert(hint2.display, hint2);
  802. }
  803. } else if (p_annotation->name == SNAME("@export_node_path")) {
  804. ScriptLanguage::CodeCompletionOption node("Node", ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  805. node.insert_text = node.display.quote(p_quote_style);
  806. r_result.insert(node.display, node);
  807. LocalVector<StringName> native_classes;
  808. ClassDB::get_inheriters_from_class("Node", native_classes);
  809. for (const StringName &E : native_classes) {
  810. if (!ClassDB::is_class_exposed(E)) {
  811. continue;
  812. }
  813. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  814. option.insert_text = option.display.quote(p_quote_style);
  815. r_result.insert(option.display, option);
  816. }
  817. List<StringName> global_script_classes;
  818. ScriptServer::get_global_class_list(&global_script_classes);
  819. for (const StringName &E : global_script_classes) {
  820. if (!ClassDB::is_parent_class(ScriptServer::get_global_class_native_base(E), "Node")) {
  821. continue;
  822. }
  823. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  824. option.insert_text = option.display.quote(p_quote_style);
  825. r_result.insert(option.display, option);
  826. }
  827. } else if (p_annotation->name == SNAME("@export_tool_button")) {
  828. if (p_argument == 1) {
  829. const Ref<Theme> theme = EditorNode::get_singleton()->get_editor_theme();
  830. if (theme.is_valid()) {
  831. List<StringName> icon_list;
  832. theme->get_icon_list(EditorStringName(EditorIcons), &icon_list);
  833. for (const StringName &E : icon_list) {
  834. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  835. option.insert_text = option.display.quote(p_quote_style);
  836. r_result.insert(option.display, option);
  837. }
  838. }
  839. }
  840. } else if (p_annotation->name == SNAME("@export_custom")) {
  841. switch (p_argument) {
  842. case 0: {
  843. static HashMap<StringName, int64_t> items;
  844. if (unlikely(items.is_empty())) {
  845. CoreConstants::get_enum_values(SNAME("PropertyHint"), &items);
  846. }
  847. for (const KeyValue<StringName, int64_t> &item : items) {
  848. ScriptLanguage::CodeCompletionOption option(item.key, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  849. r_result.insert(option.display, option);
  850. }
  851. } break;
  852. case 2: {
  853. static HashMap<StringName, int64_t> items;
  854. if (unlikely(items.is_empty())) {
  855. CoreConstants::get_enum_values(SNAME("PropertyUsageFlags"), &items);
  856. }
  857. for (const KeyValue<StringName, int64_t> &item : items) {
  858. ScriptLanguage::CodeCompletionOption option(item.key, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  859. r_result.insert(option.display, option);
  860. }
  861. } break;
  862. }
  863. } else if (p_annotation->name == SNAME("@warning_ignore") || p_annotation->name == SNAME("@warning_ignore_start") || p_annotation->name == SNAME("@warning_ignore_restore")) {
  864. for (int warning_code = 0; warning_code < GDScriptWarning::WARNING_MAX; warning_code++) {
  865. #ifndef DISABLE_DEPRECATED
  866. if (warning_code >= GDScriptWarning::FIRST_DEPRECATED_WARNING) {
  867. break; // Don't suggest deprecated warnings as they are never produced.
  868. }
  869. #endif
  870. ScriptLanguage::CodeCompletionOption warning(GDScriptWarning::get_name_from_code((GDScriptWarning::Code)warning_code).to_lower(), ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  871. warning.insert_text = warning.display.quote(p_quote_style);
  872. r_result.insert(warning.display, warning);
  873. }
  874. } else if (p_annotation->name == SNAME("@rpc")) {
  875. if (p_argument == 0 || p_argument == 1 || p_argument == 2) {
  876. static const char *options[7] = { "call_local", "call_remote", "any_peer", "authority", "reliable", "unreliable", "unreliable_ordered" };
  877. for (int i = 0; i < 7; i++) {
  878. ScriptLanguage::CodeCompletionOption option(options[i], ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  879. option.insert_text = option.display.quote(p_quote_style);
  880. r_result.insert(option.display, option);
  881. }
  882. }
  883. }
  884. }
  885. static void _find_built_in_variants(HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, bool exclude_nil = false) {
  886. for (int i = 0; i < Variant::VARIANT_MAX; i++) {
  887. if (!exclude_nil && Variant::Type(i) == Variant::Type::NIL) {
  888. ScriptLanguage::CodeCompletionOption option("null", ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  889. r_result.insert(option.display, option);
  890. } else {
  891. ScriptLanguage::CodeCompletionOption option(Variant::get_type_name(Variant::Type(i)), ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  892. r_result.insert(option.display, option);
  893. }
  894. }
  895. }
  896. static void _list_available_types(bool p_inherit_only, GDScriptParser::CompletionContext &p_context, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result) {
  897. // Built-in Variant Types
  898. _find_built_in_variants(r_result, true);
  899. List<StringName> native_types;
  900. ClassDB::get_class_list(&native_types);
  901. for (const StringName &E : native_types) {
  902. if (ClassDB::is_class_exposed(E) && !Engine::get_singleton()->has_singleton(E)) {
  903. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  904. r_result.insert(option.display, option);
  905. }
  906. }
  907. if (p_context.current_class) {
  908. if (!p_inherit_only && p_context.current_class->base_type.is_set()) {
  909. // Native enums from base class
  910. List<StringName> enums;
  911. ClassDB::get_enum_list(p_context.current_class->base_type.native_type, &enums);
  912. for (const StringName &E : enums) {
  913. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_ENUM);
  914. r_result.insert(option.display, option);
  915. }
  916. }
  917. // Check current class for potential types
  918. const GDScriptParser::ClassNode *current = p_context.current_class;
  919. while (current) {
  920. for (int i = 0; i < current->members.size(); i++) {
  921. const GDScriptParser::ClassNode::Member &member = current->members[i];
  922. switch (member.type) {
  923. case GDScriptParser::ClassNode::Member::CLASS: {
  924. ScriptLanguage::CodeCompletionOption option(member.m_class->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_LOCAL);
  925. r_result.insert(option.display, option);
  926. } break;
  927. case GDScriptParser::ClassNode::Member::ENUM: {
  928. if (!p_inherit_only) {
  929. ScriptLanguage::CodeCompletionOption option(member.m_enum->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, ScriptLanguage::LOCATION_LOCAL);
  930. r_result.insert(option.display, option);
  931. }
  932. } break;
  933. case GDScriptParser::ClassNode::Member::CONSTANT: {
  934. if (member.constant->get_datatype().is_meta_type && p_context.current_class->outer != nullptr) {
  935. ScriptLanguage::CodeCompletionOption option(member.constant->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_LOCAL);
  936. r_result.insert(option.display, option);
  937. }
  938. } break;
  939. default:
  940. break;
  941. }
  942. }
  943. current = current->outer;
  944. }
  945. }
  946. // Global scripts
  947. List<StringName> global_classes;
  948. ScriptServer::get_global_class_list(&global_classes);
  949. for (const StringName &E : global_classes) {
  950. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_OTHER_USER_CODE);
  951. r_result.insert(option.display, option);
  952. }
  953. // Autoload singletons
  954. HashMap<StringName, ProjectSettings::AutoloadInfo> autoloads = ProjectSettings::get_singleton()->get_autoload_list();
  955. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : autoloads) {
  956. const ProjectSettings::AutoloadInfo &info = E.value;
  957. if (!info.is_singleton || info.path.get_extension().to_lower() != "gd") {
  958. continue;
  959. }
  960. ScriptLanguage::CodeCompletionOption option(info.name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_OTHER_USER_CODE);
  961. r_result.insert(option.display, option);
  962. }
  963. }
  964. static void _find_identifiers_in_suite(const GDScriptParser::SuiteNode *p_suite, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth = 0) {
  965. for (int i = 0; i < p_suite->locals.size(); i++) {
  966. ScriptLanguage::CodeCompletionOption option;
  967. int location = p_recursion_depth == 0 ? ScriptLanguage::LOCATION_LOCAL : (p_recursion_depth | ScriptLanguage::LOCATION_PARENT_MASK);
  968. if (p_suite->locals[i].type == GDScriptParser::SuiteNode::Local::CONSTANT) {
  969. option = ScriptLanguage::CodeCompletionOption(p_suite->locals[i].name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  970. option.default_value = p_suite->locals[i].constant->initializer->reduced_value;
  971. } else {
  972. option = ScriptLanguage::CodeCompletionOption(p_suite->locals[i].name, ScriptLanguage::CODE_COMPLETION_KIND_VARIABLE, location);
  973. }
  974. r_result.insert(option.display, option);
  975. }
  976. if (p_suite->parent_block) {
  977. _find_identifiers_in_suite(p_suite->parent_block, r_result, p_recursion_depth + 1);
  978. }
  979. }
  980. static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base, bool p_only_functions, bool p_types_only, bool p_add_braces, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth);
  981. static void _find_identifiers_in_class(const GDScriptParser::ClassNode *p_class, bool p_only_functions, bool p_types_only, bool p_static, bool p_parent_only, bool p_add_braces, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth) {
  982. ERR_FAIL_COND(p_recursion_depth > COMPLETION_RECURSION_LIMIT);
  983. if (!p_parent_only) {
  984. bool outer = false;
  985. const GDScriptParser::ClassNode *clss = p_class;
  986. int classes_processed = 0;
  987. while (clss) {
  988. for (int i = 0; i < clss->members.size(); i++) {
  989. const int location = p_recursion_depth == 0 ? classes_processed : (p_recursion_depth | ScriptLanguage::LOCATION_PARENT_MASK);
  990. const GDScriptParser::ClassNode::Member &member = clss->members[i];
  991. ScriptLanguage::CodeCompletionOption option;
  992. switch (member.type) {
  993. case GDScriptParser::ClassNode::Member::VARIABLE:
  994. if (p_types_only || p_only_functions || outer || (p_static && !member.variable->is_static)) {
  995. continue;
  996. }
  997. option = ScriptLanguage::CodeCompletionOption(member.variable->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, location);
  998. break;
  999. case GDScriptParser::ClassNode::Member::CONSTANT:
  1000. if (p_types_only || p_only_functions) {
  1001. continue;
  1002. }
  1003. if (r_result.has(member.constant->identifier->name)) {
  1004. continue;
  1005. }
  1006. option = ScriptLanguage::CodeCompletionOption(member.constant->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  1007. if (member.constant->initializer) {
  1008. option.default_value = member.constant->initializer->reduced_value;
  1009. }
  1010. break;
  1011. case GDScriptParser::ClassNode::Member::CLASS:
  1012. if (p_only_functions) {
  1013. continue;
  1014. }
  1015. option = ScriptLanguage::CodeCompletionOption(member.m_class->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, location);
  1016. break;
  1017. case GDScriptParser::ClassNode::Member::ENUM_VALUE:
  1018. if (p_types_only || p_only_functions) {
  1019. continue;
  1020. }
  1021. option = ScriptLanguage::CodeCompletionOption(member.enum_value.identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  1022. break;
  1023. case GDScriptParser::ClassNode::Member::ENUM:
  1024. if (p_only_functions) {
  1025. continue;
  1026. }
  1027. option = ScriptLanguage::CodeCompletionOption(member.m_enum->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, location);
  1028. break;
  1029. case GDScriptParser::ClassNode::Member::FUNCTION:
  1030. if (p_types_only || outer || (p_static && !member.function->is_static) || member.function->identifier->name.operator String().begins_with("@")) {
  1031. continue;
  1032. }
  1033. option = ScriptLanguage::CodeCompletionOption(member.function->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
  1034. if (p_add_braces) {
  1035. if (member.function->parameters.size() > 0 || (member.function->info.flags & METHOD_FLAG_VARARG)) {
  1036. option.insert_text += "(";
  1037. option.display += U"(\u2026)";
  1038. } else {
  1039. option.insert_text += "()";
  1040. option.display += "()";
  1041. }
  1042. }
  1043. break;
  1044. case GDScriptParser::ClassNode::Member::SIGNAL:
  1045. if (p_types_only || p_only_functions || outer || p_static) {
  1046. continue;
  1047. }
  1048. option = ScriptLanguage::CodeCompletionOption(member.signal->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL, location);
  1049. break;
  1050. case GDScriptParser::ClassNode::Member::GROUP:
  1051. break; // No-op, but silences warnings.
  1052. case GDScriptParser::ClassNode::Member::UNDEFINED:
  1053. break;
  1054. }
  1055. r_result.insert(option.display, option);
  1056. }
  1057. if (p_types_only) {
  1058. break; // Otherwise, it will fill the results with types from the outer class (which is undesired for that case).
  1059. }
  1060. outer = true;
  1061. clss = clss->outer;
  1062. classes_processed++;
  1063. }
  1064. }
  1065. // Parents.
  1066. GDScriptCompletionIdentifier base_type;
  1067. base_type.type = p_class->base_type;
  1068. base_type.type.is_meta_type = p_static;
  1069. _find_identifiers_in_base(base_type, p_only_functions, p_types_only, p_add_braces, r_result, p_recursion_depth + 1);
  1070. }
  1071. static void _find_identifiers_in_base(const GDScriptCompletionIdentifier &p_base, bool p_only_functions, bool p_types_only, bool p_add_braces, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth) {
  1072. ERR_FAIL_COND(p_recursion_depth > COMPLETION_RECURSION_LIMIT);
  1073. GDScriptParser::DataType base_type = p_base.type;
  1074. if (!p_types_only && base_type.is_meta_type && base_type.kind != GDScriptParser::DataType::BUILTIN && base_type.kind != GDScriptParser::DataType::ENUM) {
  1075. ScriptLanguage::CodeCompletionOption option("new", ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, ScriptLanguage::LOCATION_LOCAL);
  1076. if (p_add_braces) {
  1077. option.insert_text += "(";
  1078. option.display += U"(\u2026)";
  1079. }
  1080. r_result.insert(option.display, option);
  1081. }
  1082. while (!base_type.has_no_type()) {
  1083. switch (base_type.kind) {
  1084. case GDScriptParser::DataType::CLASS: {
  1085. _find_identifiers_in_class(base_type.class_type, p_only_functions, p_types_only, base_type.is_meta_type, false, p_add_braces, r_result, p_recursion_depth);
  1086. // This already finds all parent identifiers, so we are done.
  1087. base_type = GDScriptParser::DataType();
  1088. } break;
  1089. case GDScriptParser::DataType::SCRIPT: {
  1090. Ref<Script> scr = base_type.script_type;
  1091. if (scr.is_valid()) {
  1092. if (p_types_only) {
  1093. // TODO: Need to implement Script::get_script_enum_list and retrieve the enum list from a script.
  1094. } else if (!p_only_functions) {
  1095. if (!base_type.is_meta_type) {
  1096. List<PropertyInfo> members;
  1097. scr->get_script_property_list(&members);
  1098. for (const PropertyInfo &E : members) {
  1099. if (E.usage & (PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_INTERNAL)) {
  1100. continue;
  1101. }
  1102. if (E.name.contains_char('/')) {
  1103. continue;
  1104. }
  1105. int location = p_recursion_depth + _get_property_location(scr, E.name);
  1106. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, location);
  1107. r_result.insert(option.display, option);
  1108. }
  1109. List<MethodInfo> signals;
  1110. scr->get_script_signal_list(&signals);
  1111. for (const MethodInfo &E : signals) {
  1112. int location = p_recursion_depth + _get_signal_location(scr, E.name);
  1113. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL, location);
  1114. r_result.insert(option.display, option);
  1115. }
  1116. }
  1117. HashMap<StringName, Variant> constants;
  1118. scr->get_constants(&constants);
  1119. for (const KeyValue<StringName, Variant> &E : constants) {
  1120. int location = p_recursion_depth + _get_constant_location(scr, E.key);
  1121. ScriptLanguage::CodeCompletionOption option(E.key.operator String(), ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  1122. r_result.insert(option.display, option);
  1123. }
  1124. }
  1125. if (!p_types_only) {
  1126. List<MethodInfo> methods;
  1127. scr->get_script_method_list(&methods);
  1128. for (const MethodInfo &E : methods) {
  1129. if (E.name.begins_with("@")) {
  1130. continue;
  1131. }
  1132. int location = p_recursion_depth + _get_method_location(scr->get_class_name(), E.name);
  1133. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
  1134. if (p_add_braces) {
  1135. if (E.arguments.size() || (E.flags & METHOD_FLAG_VARARG)) {
  1136. option.insert_text += "(";
  1137. option.display += U"(\u2026)";
  1138. } else {
  1139. option.insert_text += "()";
  1140. option.display += "()";
  1141. }
  1142. }
  1143. r_result.insert(option.display, option);
  1144. }
  1145. }
  1146. Ref<Script> base_script = scr->get_base_script();
  1147. if (base_script.is_valid()) {
  1148. base_type.script_type = base_script;
  1149. } else {
  1150. base_type.kind = GDScriptParser::DataType::NATIVE;
  1151. base_type.builtin_type = Variant::OBJECT;
  1152. base_type.native_type = scr->get_instance_base_type();
  1153. }
  1154. } else {
  1155. return;
  1156. }
  1157. } break;
  1158. case GDScriptParser::DataType::NATIVE: {
  1159. StringName type = base_type.native_type;
  1160. if (!ClassDB::class_exists(type)) {
  1161. return;
  1162. }
  1163. List<StringName> enums;
  1164. ClassDB::get_enum_list(type, &enums);
  1165. for (const StringName &E : enums) {
  1166. int location = p_recursion_depth + _get_enum_location(type, E);
  1167. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, location);
  1168. r_result.insert(option.display, option);
  1169. }
  1170. if (p_types_only) {
  1171. return;
  1172. }
  1173. if (!p_only_functions) {
  1174. List<String> constants;
  1175. ClassDB::get_integer_constant_list(type, &constants);
  1176. for (const String &E : constants) {
  1177. int location = p_recursion_depth + _get_constant_location(type, StringName(E));
  1178. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  1179. r_result.insert(option.display, option);
  1180. }
  1181. if (!base_type.is_meta_type || Engine::get_singleton()->has_singleton(type)) {
  1182. List<PropertyInfo> pinfo;
  1183. ClassDB::get_property_list(type, &pinfo);
  1184. for (const PropertyInfo &E : pinfo) {
  1185. if (E.usage & (PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_INTERNAL)) {
  1186. continue;
  1187. }
  1188. if (E.name.contains_char('/')) {
  1189. continue;
  1190. }
  1191. int location = p_recursion_depth + _get_property_location(type, E.name);
  1192. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, location);
  1193. r_result.insert(option.display, option);
  1194. }
  1195. List<MethodInfo> signals;
  1196. ClassDB::get_signal_list(type, &signals);
  1197. for (const MethodInfo &E : signals) {
  1198. int location = p_recursion_depth + _get_signal_location(type, StringName(E.name));
  1199. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_SIGNAL, location);
  1200. r_result.insert(option.display, option);
  1201. }
  1202. }
  1203. }
  1204. bool only_static = base_type.is_meta_type && !Engine::get_singleton()->has_singleton(type);
  1205. List<MethodInfo> methods;
  1206. ClassDB::get_method_list(type, &methods, false, true);
  1207. for (const MethodInfo &E : methods) {
  1208. if (only_static && (E.flags & METHOD_FLAG_STATIC) == 0) {
  1209. continue;
  1210. }
  1211. if (E.name.begins_with("_")) {
  1212. continue;
  1213. }
  1214. int location = p_recursion_depth + _get_method_location(type, E.name);
  1215. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
  1216. if (p_add_braces) {
  1217. if (E.arguments.size() || (E.flags & METHOD_FLAG_VARARG)) {
  1218. option.insert_text += "(";
  1219. option.display += U"(\u2026)";
  1220. } else {
  1221. option.insert_text += "()";
  1222. option.display += "()";
  1223. }
  1224. }
  1225. r_result.insert(option.display, option);
  1226. }
  1227. return;
  1228. } break;
  1229. case GDScriptParser::DataType::ENUM: {
  1230. String type_str = base_type.native_type;
  1231. StringName type = type_str.get_slicec('.', 0);
  1232. StringName type_enum = base_type.enum_type;
  1233. List<StringName> enum_values;
  1234. ClassDB::get_enum_constants(type, type_enum, &enum_values);
  1235. for (const StringName &E : enum_values) {
  1236. int location = p_recursion_depth + _get_enum_constant_location(type, E);
  1237. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT, location);
  1238. r_result.insert(option.display, option);
  1239. }
  1240. }
  1241. [[fallthrough]];
  1242. case GDScriptParser::DataType::BUILTIN: {
  1243. if (p_types_only) {
  1244. return;
  1245. }
  1246. Callable::CallError err;
  1247. Variant tmp;
  1248. Variant::construct(base_type.builtin_type, tmp, nullptr, 0, err);
  1249. if (err.error != Callable::CallError::CALL_OK) {
  1250. return;
  1251. }
  1252. int location = ScriptLanguage::LOCATION_OTHER;
  1253. if (!p_only_functions) {
  1254. List<PropertyInfo> members;
  1255. if (p_base.value.get_type() != Variant::NIL) {
  1256. p_base.value.get_property_list(&members);
  1257. } else {
  1258. tmp.get_property_list(&members);
  1259. }
  1260. for (const PropertyInfo &E : members) {
  1261. if (E.usage & (PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_INTERNAL)) {
  1262. continue;
  1263. }
  1264. if (!String(E.name).contains_char('/')) {
  1265. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, location);
  1266. if (base_type.kind == GDScriptParser::DataType::ENUM) {
  1267. // Sort enum members in their declaration order.
  1268. location += 1;
  1269. }
  1270. if (GDScriptParser::theme_color_names.has(E.name)) {
  1271. option.theme_color_name = GDScriptParser::theme_color_names[E.name];
  1272. }
  1273. r_result.insert(option.display, option);
  1274. }
  1275. }
  1276. }
  1277. List<MethodInfo> methods;
  1278. tmp.get_method_list(&methods);
  1279. for (const MethodInfo &E : methods) {
  1280. if (base_type.kind == GDScriptParser::DataType::ENUM && base_type.is_meta_type && !(E.flags & METHOD_FLAG_CONST)) {
  1281. // Enum types are static and cannot change, therefore we skip non-const dictionary methods.
  1282. continue;
  1283. }
  1284. ScriptLanguage::CodeCompletionOption option(E.name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION, location);
  1285. if (p_add_braces) {
  1286. if (E.arguments.size() || (E.flags & METHOD_FLAG_VARARG)) {
  1287. option.insert_text += "(";
  1288. option.display += U"(\u2026)";
  1289. } else {
  1290. option.insert_text += "()";
  1291. option.display += "()";
  1292. }
  1293. }
  1294. r_result.insert(option.display, option);
  1295. }
  1296. return;
  1297. } break;
  1298. default: {
  1299. return;
  1300. } break;
  1301. }
  1302. }
  1303. }
  1304. static void _find_identifiers(const GDScriptParser::CompletionContext &p_context, bool p_only_functions, bool p_add_braces, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, int p_recursion_depth) {
  1305. if (!p_only_functions && p_context.current_suite) {
  1306. // This includes function parameters, since they are also locals.
  1307. _find_identifiers_in_suite(p_context.current_suite, r_result);
  1308. }
  1309. if (p_context.current_class) {
  1310. _find_identifiers_in_class(p_context.current_class, p_only_functions, false, (!p_context.current_function || p_context.current_function->is_static), false, p_add_braces, r_result, p_recursion_depth);
  1311. }
  1312. List<StringName> functions;
  1313. GDScriptUtilityFunctions::get_function_list(&functions);
  1314. for (const StringName &E : functions) {
  1315. MethodInfo function = GDScriptUtilityFunctions::get_function_info(E);
  1316. ScriptLanguage::CodeCompletionOption option(String(E), ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  1317. if (p_add_braces) {
  1318. if (function.arguments.size() || (function.flags & METHOD_FLAG_VARARG)) {
  1319. option.insert_text += "(";
  1320. option.display += U"(\u2026)";
  1321. } else {
  1322. option.insert_text += "()";
  1323. option.display += "()";
  1324. }
  1325. }
  1326. r_result.insert(option.display, option);
  1327. }
  1328. if (p_only_functions) {
  1329. return;
  1330. }
  1331. _find_built_in_variants(r_result);
  1332. static const char *_keywords[] = {
  1333. "true", "false", "PI", "TAU", "INF", "NAN", "null", "self", "super",
  1334. "break", "breakpoint", "continue", "pass", "return",
  1335. nullptr
  1336. };
  1337. const char **kw = _keywords;
  1338. while (*kw) {
  1339. ScriptLanguage::CodeCompletionOption option(*kw, ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  1340. r_result.insert(option.display, option);
  1341. kw++;
  1342. }
  1343. static const char *_keywords_with_space[] = {
  1344. "and", "not", "or", "in", "as", "class", "class_name", "extends", "is", "func", "signal", "await",
  1345. "const", "enum", "static", "var", "if", "elif", "else", "for", "match", "when", "while",
  1346. nullptr
  1347. };
  1348. const char **kws = _keywords_with_space;
  1349. while (*kws) {
  1350. ScriptLanguage::CodeCompletionOption option(*kws, ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  1351. option.insert_text += " ";
  1352. r_result.insert(option.display, option);
  1353. kws++;
  1354. }
  1355. static const char *_keywords_with_args[] = {
  1356. "assert", "preload",
  1357. nullptr
  1358. };
  1359. const char **kwa = _keywords_with_args;
  1360. while (*kwa) {
  1361. ScriptLanguage::CodeCompletionOption option(*kwa, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  1362. if (p_add_braces) {
  1363. option.insert_text += "(";
  1364. option.display += U"(\u2026)";
  1365. }
  1366. r_result.insert(option.display, option);
  1367. kwa++;
  1368. }
  1369. List<StringName> utility_func_names;
  1370. Variant::get_utility_function_list(&utility_func_names);
  1371. for (const StringName &util_func_name : utility_func_names) {
  1372. ScriptLanguage::CodeCompletionOption option(util_func_name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  1373. if (p_add_braces) {
  1374. option.insert_text += "(";
  1375. option.display += U"(\u2026)"; // As all utility functions contain an argument or more, this is hardcoded here.
  1376. }
  1377. r_result.insert(option.display, option);
  1378. }
  1379. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : ProjectSettings::get_singleton()->get_autoload_list()) {
  1380. if (!E.value.is_singleton) {
  1381. continue;
  1382. }
  1383. ScriptLanguage::CodeCompletionOption option(E.key, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  1384. r_result.insert(option.display, option);
  1385. }
  1386. // Native classes and global constants.
  1387. for (const KeyValue<StringName, int> &E : GDScriptLanguage::get_singleton()->get_global_map()) {
  1388. ScriptLanguage::CodeCompletionOption option;
  1389. if (ClassDB::class_exists(E.key) || Engine::get_singleton()->has_singleton(E.key)) {
  1390. option = ScriptLanguage::CodeCompletionOption(E.key.operator String(), ScriptLanguage::CODE_COMPLETION_KIND_CLASS);
  1391. } else {
  1392. option = ScriptLanguage::CodeCompletionOption(E.key.operator String(), ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  1393. }
  1394. r_result.insert(option.display, option);
  1395. }
  1396. // Global classes
  1397. List<StringName> global_classes;
  1398. ScriptServer::get_global_class_list(&global_classes);
  1399. for (const StringName &E : global_classes) {
  1400. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CLASS, ScriptLanguage::LOCATION_OTHER_USER_CODE);
  1401. r_result.insert(option.display, option);
  1402. }
  1403. }
  1404. static GDScriptCompletionIdentifier _type_from_variant(const Variant &p_value, GDScriptParser::CompletionContext &p_context) {
  1405. GDScriptCompletionIdentifier ci;
  1406. ci.value = p_value;
  1407. ci.type.is_constant = true;
  1408. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1409. ci.type.kind = GDScriptParser::DataType::BUILTIN;
  1410. ci.type.builtin_type = p_value.get_type();
  1411. if (ci.type.builtin_type == Variant::OBJECT) {
  1412. Object *obj = p_value.operator Object *();
  1413. if (!obj) {
  1414. return ci;
  1415. }
  1416. ci.type.native_type = obj->get_class_name();
  1417. Ref<Script> scr = p_value;
  1418. if (scr.is_valid()) {
  1419. ci.type.is_meta_type = true;
  1420. } else {
  1421. ci.type.is_meta_type = false;
  1422. scr = obj->get_script();
  1423. }
  1424. if (scr.is_valid()) {
  1425. ci.type.script_path = scr->get_path();
  1426. ci.type.script_type = scr;
  1427. ci.type.native_type = scr->get_instance_base_type();
  1428. ci.type.kind = GDScriptParser::DataType::SCRIPT;
  1429. if (scr->get_path().ends_with(".gd")) {
  1430. Ref<GDScriptParserRef> parser = p_context.parser->get_depended_parser_for(scr->get_path());
  1431. if (parser.is_valid() && parser->raise_status(GDScriptParserRef::INTERFACE_SOLVED) == OK) {
  1432. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1433. ci.type.class_type = parser->get_parser()->get_tree();
  1434. ci.type.kind = GDScriptParser::DataType::CLASS;
  1435. return ci;
  1436. }
  1437. }
  1438. } else {
  1439. ci.type.kind = GDScriptParser::DataType::NATIVE;
  1440. }
  1441. }
  1442. return ci;
  1443. }
  1444. static GDScriptCompletionIdentifier _type_from_property(const PropertyInfo &p_property) {
  1445. GDScriptCompletionIdentifier ci;
  1446. if (p_property.type == Variant::NIL) {
  1447. // Variant
  1448. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1449. ci.type.kind = GDScriptParser::DataType::VARIANT;
  1450. return ci;
  1451. }
  1452. if (p_property.usage & (PROPERTY_USAGE_CLASS_IS_ENUM | PROPERTY_USAGE_CLASS_IS_BITFIELD)) {
  1453. ci.enumeration = p_property.class_name;
  1454. }
  1455. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1456. ci.type.builtin_type = p_property.type;
  1457. if (p_property.type == Variant::OBJECT) {
  1458. if (ScriptServer::is_global_class(p_property.class_name)) {
  1459. ci.type.kind = GDScriptParser::DataType::SCRIPT;
  1460. ci.type.script_path = ScriptServer::get_global_class_path(p_property.class_name);
  1461. ci.type.native_type = ScriptServer::get_global_class_native_base(p_property.class_name);
  1462. Ref<Script> scr = ResourceLoader::load(ScriptServer::get_global_class_path(p_property.class_name));
  1463. if (scr.is_valid()) {
  1464. ci.type.script_type = scr;
  1465. }
  1466. } else {
  1467. ci.type.kind = GDScriptParser::DataType::NATIVE;
  1468. ci.type.native_type = p_property.class_name == StringName() ? "Object" : p_property.class_name;
  1469. }
  1470. } else {
  1471. ci.type.kind = GDScriptParser::DataType::BUILTIN;
  1472. }
  1473. return ci;
  1474. }
  1475. static GDScriptCompletionIdentifier _callable_type_from_method_info(const MethodInfo &p_method) {
  1476. GDScriptCompletionIdentifier ci;
  1477. ci.type.kind = GDScriptParser::DataType::BUILTIN;
  1478. ci.type.builtin_type = Variant::CALLABLE;
  1479. ci.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1480. ci.type.is_constant = true;
  1481. ci.type.method_info = p_method;
  1482. return ci;
  1483. }
  1484. #define MAX_COMPLETION_RECURSION 100
  1485. struct RecursionCheck {
  1486. int *counter;
  1487. _FORCE_INLINE_ bool check() {
  1488. return (*counter) > MAX_COMPLETION_RECURSION;
  1489. }
  1490. RecursionCheck(int *p_counter) :
  1491. counter(p_counter) {
  1492. (*counter)++;
  1493. }
  1494. ~RecursionCheck() {
  1495. (*counter)--;
  1496. }
  1497. };
  1498. static bool _guess_identifier_type(GDScriptParser::CompletionContext &p_context, const GDScriptParser::IdentifierNode *p_identifier, GDScriptCompletionIdentifier &r_type);
  1499. static bool _guess_identifier_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_identifier, GDScriptCompletionIdentifier &r_type);
  1500. static bool _guess_method_return_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_method, GDScriptCompletionIdentifier &r_type);
  1501. static bool _is_expression_named_identifier(const GDScriptParser::ExpressionNode *p_expression, const StringName &p_name) {
  1502. if (p_expression) {
  1503. switch (p_expression->type) {
  1504. case GDScriptParser::Node::IDENTIFIER: {
  1505. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(p_expression);
  1506. if (id->name == p_name) {
  1507. return true;
  1508. }
  1509. } break;
  1510. case GDScriptParser::Node::CAST: {
  1511. const GDScriptParser::CastNode *cn = static_cast<const GDScriptParser::CastNode *>(p_expression);
  1512. return _is_expression_named_identifier(cn->operand, p_name);
  1513. } break;
  1514. default:
  1515. break;
  1516. }
  1517. }
  1518. return false;
  1519. }
  1520. static bool _guess_expression_type(GDScriptParser::CompletionContext &p_context, const GDScriptParser::ExpressionNode *p_expression, GDScriptCompletionIdentifier &r_type) {
  1521. bool found = false;
  1522. if (p_expression == nullptr) {
  1523. return false;
  1524. }
  1525. static int recursion_depth = 0;
  1526. RecursionCheck recursion(&recursion_depth);
  1527. if (unlikely(recursion.check())) {
  1528. ERR_FAIL_V_MSG(false, "Reached recursion limit while trying to guess type.");
  1529. }
  1530. if (p_expression->is_constant) {
  1531. // Already has a value, so just use that.
  1532. r_type = _type_from_variant(p_expression->reduced_value, p_context);
  1533. switch (p_expression->get_datatype().kind) {
  1534. case GDScriptParser::DataType::ENUM:
  1535. case GDScriptParser::DataType::CLASS:
  1536. r_type.type = p_expression->get_datatype();
  1537. break;
  1538. default:
  1539. break;
  1540. }
  1541. found = true;
  1542. } else {
  1543. switch (p_expression->type) {
  1544. case GDScriptParser::Node::LITERAL: {
  1545. const GDScriptParser::LiteralNode *literal = static_cast<const GDScriptParser::LiteralNode *>(p_expression);
  1546. r_type = _type_from_variant(literal->value, p_context);
  1547. found = true;
  1548. } break;
  1549. case GDScriptParser::Node::SELF: {
  1550. if (p_context.current_class) {
  1551. r_type.type = p_context.current_class->get_datatype();
  1552. r_type.type.is_meta_type = false;
  1553. found = true;
  1554. }
  1555. } break;
  1556. case GDScriptParser::Node::IDENTIFIER: {
  1557. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(p_expression);
  1558. found = _guess_identifier_type(p_context, id, r_type);
  1559. } break;
  1560. case GDScriptParser::Node::DICTIONARY: {
  1561. // Try to recreate the dictionary.
  1562. const GDScriptParser::DictionaryNode *dn = static_cast<const GDScriptParser::DictionaryNode *>(p_expression);
  1563. Dictionary d;
  1564. bool full = true;
  1565. for (int i = 0; i < dn->elements.size(); i++) {
  1566. GDScriptCompletionIdentifier key;
  1567. if (_guess_expression_type(p_context, dn->elements[i].key, key)) {
  1568. if (!key.type.is_constant) {
  1569. full = false;
  1570. break;
  1571. }
  1572. GDScriptCompletionIdentifier value;
  1573. if (_guess_expression_type(p_context, dn->elements[i].value, value)) {
  1574. if (!value.type.is_constant) {
  1575. full = false;
  1576. break;
  1577. }
  1578. d[key.value] = value.value;
  1579. } else {
  1580. full = false;
  1581. break;
  1582. }
  1583. } else {
  1584. full = false;
  1585. break;
  1586. }
  1587. }
  1588. if (full) {
  1589. r_type.value = d;
  1590. r_type.type.is_constant = true;
  1591. }
  1592. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1593. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  1594. r_type.type.builtin_type = Variant::DICTIONARY;
  1595. found = true;
  1596. } break;
  1597. case GDScriptParser::Node::ARRAY: {
  1598. // Try to recreate the array
  1599. const GDScriptParser::ArrayNode *an = static_cast<const GDScriptParser::ArrayNode *>(p_expression);
  1600. Array a;
  1601. bool full = true;
  1602. a.resize(an->elements.size());
  1603. for (int i = 0; i < an->elements.size(); i++) {
  1604. GDScriptCompletionIdentifier value;
  1605. if (_guess_expression_type(p_context, an->elements[i], value)) {
  1606. if (value.type.is_constant) {
  1607. a[i] = value.value;
  1608. } else {
  1609. full = false;
  1610. break;
  1611. }
  1612. } else {
  1613. full = false;
  1614. break;
  1615. }
  1616. }
  1617. if (full) {
  1618. // If not fully constant, setting this value is detrimental to the inference.
  1619. r_type.value = a;
  1620. r_type.type.is_constant = true;
  1621. }
  1622. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1623. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  1624. r_type.type.builtin_type = Variant::ARRAY;
  1625. found = true;
  1626. } break;
  1627. case GDScriptParser::Node::CAST: {
  1628. const GDScriptParser::CastNode *cn = static_cast<const GDScriptParser::CastNode *>(p_expression);
  1629. GDScriptCompletionIdentifier value;
  1630. if (_guess_expression_type(p_context, cn->operand, r_type)) {
  1631. r_type.type = cn->get_datatype();
  1632. found = true;
  1633. }
  1634. } break;
  1635. case GDScriptParser::Node::CALL: {
  1636. const GDScriptParser::CallNode *call = static_cast<const GDScriptParser::CallNode *>(p_expression);
  1637. if (GDScriptParser::get_builtin_type(call->function_name) < Variant::VARIANT_MAX) {
  1638. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1639. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  1640. r_type.type.builtin_type = GDScriptParser::get_builtin_type(call->function_name);
  1641. found = true;
  1642. break;
  1643. } else if (GDScriptUtilityFunctions::function_exists(call->function_name)) {
  1644. MethodInfo mi = GDScriptUtilityFunctions::get_function_info(call->function_name);
  1645. r_type = _type_from_property(mi.return_val);
  1646. found = true;
  1647. break;
  1648. } else {
  1649. GDScriptParser::CompletionContext c = p_context;
  1650. c.current_line = call->start_line;
  1651. GDScriptParser::Node::Type callee_type = call->get_callee_type();
  1652. GDScriptCompletionIdentifier base;
  1653. if (callee_type == GDScriptParser::Node::IDENTIFIER || call->is_super) {
  1654. // Simple call, so base is 'self'.
  1655. if (p_context.current_class) {
  1656. if (call->is_super) {
  1657. base.type = p_context.current_class->base_type;
  1658. base.value = p_context.base;
  1659. } else {
  1660. base.type.kind = GDScriptParser::DataType::CLASS;
  1661. base.type.type_source = GDScriptParser::DataType::INFERRED;
  1662. base.type.is_constant = true;
  1663. base.type.class_type = p_context.current_class;
  1664. base.value = p_context.base;
  1665. }
  1666. } else {
  1667. break;
  1668. }
  1669. } else if (callee_type == GDScriptParser::Node::SUBSCRIPT && static_cast<const GDScriptParser::SubscriptNode *>(call->callee)->is_attribute) {
  1670. if (!_guess_expression_type(c, static_cast<const GDScriptParser::SubscriptNode *>(call->callee)->base, base)) {
  1671. found = false;
  1672. break;
  1673. }
  1674. } else {
  1675. break;
  1676. }
  1677. // Try call if constant methods with constant arguments
  1678. if (base.type.is_constant && base.value.get_type() == Variant::OBJECT) {
  1679. GDScriptParser::DataType native_type = base.type;
  1680. while (native_type.kind == GDScriptParser::DataType::CLASS) {
  1681. native_type = native_type.class_type->base_type;
  1682. }
  1683. while (native_type.kind == GDScriptParser::DataType::SCRIPT) {
  1684. if (native_type.script_type.is_valid()) {
  1685. Ref<Script> parent = native_type.script_type->get_base_script();
  1686. if (parent.is_valid()) {
  1687. native_type.script_type = parent;
  1688. } else {
  1689. native_type.kind = GDScriptParser::DataType::NATIVE;
  1690. native_type.builtin_type = Variant::OBJECT;
  1691. native_type.native_type = native_type.script_type->get_instance_base_type();
  1692. if (!ClassDB::class_exists(native_type.native_type)) {
  1693. native_type.kind = GDScriptParser::DataType::UNRESOLVED;
  1694. }
  1695. }
  1696. }
  1697. }
  1698. if (native_type.kind == GDScriptParser::DataType::NATIVE) {
  1699. MethodBind *mb = ClassDB::get_method(native_type.native_type, call->function_name);
  1700. if (mb && mb->is_const()) {
  1701. bool all_is_const = true;
  1702. Vector<Variant> args;
  1703. for (int i = 0; all_is_const && i < call->arguments.size(); i++) {
  1704. GDScriptCompletionIdentifier arg;
  1705. if (!call->arguments[i]->is_constant) {
  1706. all_is_const = false;
  1707. }
  1708. }
  1709. Object *baseptr = base.value;
  1710. if (all_is_const && call->function_name == SNAME("get_node") && ClassDB::is_parent_class(native_type.native_type, SNAME("Node")) && args.size()) {
  1711. String arg1 = args[0];
  1712. if (arg1.begins_with("/root/")) {
  1713. String which = arg1.get_slicec('/', 2);
  1714. if (!which.is_empty()) {
  1715. // Try singletons first
  1716. if (GDScriptLanguage::get_singleton()->get_named_globals_map().has(which)) {
  1717. r_type = _type_from_variant(GDScriptLanguage::get_singleton()->get_named_globals_map()[which], p_context);
  1718. found = true;
  1719. } else {
  1720. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : ProjectSettings::get_singleton()->get_autoload_list()) {
  1721. String name = E.key;
  1722. if (name == which) {
  1723. String script = E.value.path;
  1724. if (!script.begins_with("res://")) {
  1725. script = "res://" + script;
  1726. }
  1727. if (!script.ends_with(".gd")) {
  1728. // not a script, try find the script anyway,
  1729. // may have some success
  1730. script = script.get_basename() + ".gd";
  1731. }
  1732. if (FileAccess::exists(script)) {
  1733. Ref<GDScriptParserRef> parser = p_context.parser->get_depended_parser_for(script);
  1734. if (parser.is_valid() && parser->raise_status(GDScriptParserRef::INTERFACE_SOLVED) == OK) {
  1735. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1736. r_type.type.script_path = script;
  1737. r_type.type.class_type = parser->get_parser()->get_tree();
  1738. r_type.type.is_constant = false;
  1739. r_type.type.kind = GDScriptParser::DataType::CLASS;
  1740. r_type.value = Variant();
  1741. found = true;
  1742. }
  1743. }
  1744. break;
  1745. }
  1746. }
  1747. }
  1748. }
  1749. }
  1750. }
  1751. if (!found && all_is_const && baseptr) {
  1752. Vector<const Variant *> argptr;
  1753. for (int i = 0; i < args.size(); i++) {
  1754. argptr.push_back(&args[i]);
  1755. }
  1756. Callable::CallError ce;
  1757. Variant ret = mb->call(baseptr, (const Variant **)argptr.ptr(), argptr.size(), ce);
  1758. if (ce.error == Callable::CallError::CALL_OK && ret.get_type() != Variant::NIL) {
  1759. if (ret.get_type() != Variant::OBJECT || ret.operator Object *() != nullptr) {
  1760. r_type = _type_from_variant(ret, p_context);
  1761. found = true;
  1762. }
  1763. }
  1764. }
  1765. }
  1766. }
  1767. }
  1768. if (!found) {
  1769. found = _guess_method_return_type_from_base(c, base, call->function_name, r_type);
  1770. }
  1771. }
  1772. } break;
  1773. case GDScriptParser::Node::SUBSCRIPT: {
  1774. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(p_expression);
  1775. if (subscript->is_attribute) {
  1776. GDScriptParser::CompletionContext c = p_context;
  1777. c.current_line = subscript->start_line;
  1778. GDScriptCompletionIdentifier base;
  1779. if (!_guess_expression_type(c, subscript->base, base)) {
  1780. found = false;
  1781. break;
  1782. }
  1783. if (base.value.get_type() == Variant::DICTIONARY && base.value.operator Dictionary().has(String(subscript->attribute->name))) {
  1784. Variant value = base.value.operator Dictionary()[String(subscript->attribute->name)];
  1785. r_type = _type_from_variant(value, p_context);
  1786. found = true;
  1787. break;
  1788. }
  1789. const GDScriptParser::DictionaryNode *dn = nullptr;
  1790. if (subscript->base->type == GDScriptParser::Node::DICTIONARY) {
  1791. dn = static_cast<const GDScriptParser::DictionaryNode *>(subscript->base);
  1792. } else if (base.assigned_expression && base.assigned_expression->type == GDScriptParser::Node::DICTIONARY) {
  1793. dn = static_cast<const GDScriptParser::DictionaryNode *>(base.assigned_expression);
  1794. }
  1795. if (dn) {
  1796. for (int i = 0; i < dn->elements.size(); i++) {
  1797. GDScriptCompletionIdentifier key;
  1798. if (!_guess_expression_type(c, dn->elements[i].key, key)) {
  1799. continue;
  1800. }
  1801. if (key.value == String(subscript->attribute->name)) {
  1802. r_type.assigned_expression = dn->elements[i].value;
  1803. found = _guess_expression_type(c, dn->elements[i].value, r_type);
  1804. break;
  1805. }
  1806. }
  1807. }
  1808. if (!found) {
  1809. found = _guess_identifier_type_from_base(c, base, subscript->attribute->name, r_type);
  1810. }
  1811. } else {
  1812. if (subscript->index == nullptr) {
  1813. found = false;
  1814. break;
  1815. }
  1816. GDScriptParser::CompletionContext c = p_context;
  1817. c.current_line = subscript->start_line;
  1818. GDScriptCompletionIdentifier base;
  1819. if (!_guess_expression_type(c, subscript->base, base)) {
  1820. found = false;
  1821. break;
  1822. }
  1823. GDScriptCompletionIdentifier index;
  1824. if (!_guess_expression_type(c, subscript->index, index)) {
  1825. found = false;
  1826. break;
  1827. }
  1828. {
  1829. bool valid;
  1830. Variant value = base.value.get(index.value, &valid);
  1831. if (valid) {
  1832. r_type = _type_from_variant(value, p_context);
  1833. found = true;
  1834. break;
  1835. }
  1836. }
  1837. // Look if it is a dictionary node.
  1838. const GDScriptParser::DictionaryNode *dn = nullptr;
  1839. if (subscript->base->type == GDScriptParser::Node::DICTIONARY) {
  1840. dn = static_cast<const GDScriptParser::DictionaryNode *>(subscript->base);
  1841. } else if (base.assigned_expression && base.assigned_expression->type == GDScriptParser::Node::DICTIONARY) {
  1842. dn = static_cast<const GDScriptParser::DictionaryNode *>(base.assigned_expression);
  1843. }
  1844. if (dn) {
  1845. for (int i = 0; i < dn->elements.size(); i++) {
  1846. GDScriptCompletionIdentifier key;
  1847. if (!_guess_expression_type(c, dn->elements[i].key, key)) {
  1848. continue;
  1849. }
  1850. if (key.value == index.value) {
  1851. r_type.assigned_expression = dn->elements[i].value;
  1852. found = _guess_expression_type(p_context, dn->elements[i].value, r_type);
  1853. break;
  1854. }
  1855. }
  1856. }
  1857. // Look if it is an array node.
  1858. if (!found && index.value.is_num()) {
  1859. int idx = index.value;
  1860. const GDScriptParser::ArrayNode *an = nullptr;
  1861. if (subscript->base->type == GDScriptParser::Node::ARRAY) {
  1862. an = static_cast<const GDScriptParser::ArrayNode *>(subscript->base);
  1863. } else if (base.assigned_expression && base.assigned_expression->type == GDScriptParser::Node::ARRAY) {
  1864. an = static_cast<const GDScriptParser::ArrayNode *>(base.assigned_expression);
  1865. }
  1866. if (an && idx >= 0 && an->elements.size() > idx) {
  1867. r_type.assigned_expression = an->elements[idx];
  1868. found = _guess_expression_type(c, an->elements[idx], r_type);
  1869. break;
  1870. }
  1871. }
  1872. // Look for valid indexing in other types
  1873. if (!found && (index.value.is_string() || index.value.get_type() == Variant::NODE_PATH)) {
  1874. StringName id = index.value;
  1875. found = _guess_identifier_type_from_base(c, base, id, r_type);
  1876. } else if (!found && index.type.kind == GDScriptParser::DataType::BUILTIN) {
  1877. Callable::CallError err;
  1878. Variant base_val;
  1879. Variant::construct(base.type.builtin_type, base_val, nullptr, 0, err);
  1880. bool valid = false;
  1881. Variant res = base_val.get(index.value, &valid);
  1882. if (valid) {
  1883. r_type = _type_from_variant(res, p_context);
  1884. r_type.value = Variant();
  1885. r_type.type.is_constant = false;
  1886. found = true;
  1887. }
  1888. }
  1889. }
  1890. } break;
  1891. case GDScriptParser::Node::BINARY_OPERATOR: {
  1892. const GDScriptParser::BinaryOpNode *op = static_cast<const GDScriptParser::BinaryOpNode *>(p_expression);
  1893. if (op->variant_op == Variant::OP_MAX) {
  1894. break;
  1895. }
  1896. GDScriptParser::CompletionContext context = p_context;
  1897. context.current_line = op->start_line;
  1898. GDScriptCompletionIdentifier p1;
  1899. GDScriptCompletionIdentifier p2;
  1900. if (!_guess_expression_type(context, op->left_operand, p1)) {
  1901. found = false;
  1902. break;
  1903. }
  1904. if (!_guess_expression_type(context, op->right_operand, p2)) {
  1905. found = false;
  1906. break;
  1907. }
  1908. Callable::CallError ce;
  1909. bool v1_use_value = p1.value.get_type() != Variant::NIL && p1.value.get_type() != Variant::OBJECT;
  1910. Variant d1;
  1911. Variant::construct(p1.type.builtin_type, d1, nullptr, 0, ce);
  1912. Variant d2;
  1913. Variant::construct(p2.type.builtin_type, d2, nullptr, 0, ce);
  1914. Variant v1 = (v1_use_value) ? p1.value : d1;
  1915. bool v2_use_value = p2.value.get_type() != Variant::NIL && p2.value.get_type() != Variant::OBJECT;
  1916. Variant v2 = (v2_use_value) ? p2.value : d2;
  1917. // avoid potential invalid ops
  1918. if ((op->variant_op == Variant::OP_DIVIDE || op->variant_op == Variant::OP_MODULE) && v2.get_type() == Variant::INT) {
  1919. v2 = 1;
  1920. v2_use_value = false;
  1921. }
  1922. if (op->variant_op == Variant::OP_DIVIDE && v2.get_type() == Variant::FLOAT) {
  1923. v2 = 1.0;
  1924. v2_use_value = false;
  1925. }
  1926. Variant res;
  1927. bool valid;
  1928. Variant::evaluate(op->variant_op, v1, v2, res, valid);
  1929. if (!valid) {
  1930. found = false;
  1931. break;
  1932. }
  1933. r_type = _type_from_variant(res, p_context);
  1934. if (!v1_use_value || !v2_use_value) {
  1935. r_type.value = Variant();
  1936. r_type.type.is_constant = false;
  1937. }
  1938. found = true;
  1939. } break;
  1940. default:
  1941. break;
  1942. }
  1943. }
  1944. // It may have found a null, but that's never useful
  1945. if (found && r_type.type.kind == GDScriptParser::DataType::BUILTIN && r_type.type.builtin_type == Variant::NIL) {
  1946. found = false;
  1947. }
  1948. // If the found type was not fully analyzed we analyze it now.
  1949. if (found && r_type.type.kind == GDScriptParser::DataType::CLASS && !r_type.type.class_type->resolved_body) {
  1950. Error err;
  1951. Ref<GDScriptParserRef> r = GDScriptCache::get_parser(r_type.type.script_path, GDScriptParserRef::FULLY_SOLVED, err);
  1952. }
  1953. // Check type hint last. For collections we want chance to get the actual value first
  1954. // This way we can detect types from the content of dictionaries and arrays
  1955. if (!found && p_expression->get_datatype().is_hard_type()) {
  1956. r_type.type = p_expression->get_datatype();
  1957. if (!r_type.assigned_expression) {
  1958. r_type.assigned_expression = p_expression;
  1959. }
  1960. found = true;
  1961. }
  1962. return found;
  1963. }
  1964. static bool _guess_identifier_type(GDScriptParser::CompletionContext &p_context, const GDScriptParser::IdentifierNode *p_identifier, GDScriptCompletionIdentifier &r_type) {
  1965. static int recursion_depth = 0;
  1966. RecursionCheck recursion(&recursion_depth);
  1967. if (unlikely(recursion.check())) {
  1968. ERR_FAIL_V_MSG(false, "Reached recursion limit while trying to guess type.");
  1969. }
  1970. // Look in blocks first.
  1971. int last_assign_line = -1;
  1972. const GDScriptParser::ExpressionNode *last_assigned_expression = nullptr;
  1973. GDScriptCompletionIdentifier id_type;
  1974. GDScriptParser::SuiteNode *suite = p_context.current_suite;
  1975. bool is_function_parameter = false;
  1976. bool can_be_local = true;
  1977. switch (p_identifier->source) {
  1978. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE:
  1979. case GDScriptParser::IdentifierNode::MEMBER_CONSTANT:
  1980. case GDScriptParser::IdentifierNode::MEMBER_FUNCTION:
  1981. case GDScriptParser::IdentifierNode::MEMBER_SIGNAL:
  1982. case GDScriptParser::IdentifierNode::MEMBER_CLASS:
  1983. case GDScriptParser::IdentifierNode::INHERITED_VARIABLE:
  1984. case GDScriptParser::IdentifierNode::STATIC_VARIABLE:
  1985. can_be_local = false;
  1986. break;
  1987. default:
  1988. break;
  1989. }
  1990. if (can_be_local && suite && suite->has_local(p_identifier->name)) {
  1991. const GDScriptParser::SuiteNode::Local &local = suite->get_local(p_identifier->name);
  1992. id_type.type = local.get_datatype();
  1993. // Check initializer as the first assignment.
  1994. switch (local.type) {
  1995. case GDScriptParser::SuiteNode::Local::VARIABLE:
  1996. if (local.variable->initializer) {
  1997. last_assign_line = local.variable->initializer->end_line;
  1998. last_assigned_expression = local.variable->initializer;
  1999. }
  2000. break;
  2001. case GDScriptParser::SuiteNode::Local::CONSTANT:
  2002. if (local.constant->initializer) {
  2003. last_assign_line = local.constant->initializer->end_line;
  2004. last_assigned_expression = local.constant->initializer;
  2005. }
  2006. break;
  2007. case GDScriptParser::SuiteNode::Local::PARAMETER:
  2008. if (local.parameter->initializer) {
  2009. last_assign_line = local.parameter->initializer->end_line;
  2010. last_assigned_expression = local.parameter->initializer;
  2011. }
  2012. is_function_parameter = true;
  2013. break;
  2014. default:
  2015. break;
  2016. }
  2017. } else {
  2018. if (p_context.current_class) {
  2019. GDScriptCompletionIdentifier base_identifier;
  2020. GDScriptCompletionIdentifier base;
  2021. base.value = p_context.base;
  2022. base.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2023. base.type.kind = GDScriptParser::DataType::CLASS;
  2024. base.type.class_type = p_context.current_class;
  2025. base.type.is_meta_type = p_context.current_function && p_context.current_function->is_static;
  2026. if (_guess_identifier_type_from_base(p_context, base, p_identifier->name, base_identifier)) {
  2027. id_type = base_identifier;
  2028. }
  2029. }
  2030. }
  2031. while (suite) {
  2032. for (int i = 0; i < suite->statements.size(); i++) {
  2033. if (suite->statements[i]->end_line >= p_context.current_line) {
  2034. break;
  2035. }
  2036. switch (suite->statements[i]->type) {
  2037. case GDScriptParser::Node::ASSIGNMENT: {
  2038. const GDScriptParser::AssignmentNode *assign = static_cast<const GDScriptParser::AssignmentNode *>(suite->statements[i]);
  2039. if (assign->end_line > last_assign_line && assign->assignee && assign->assigned_value && assign->assignee->type == GDScriptParser::Node::IDENTIFIER) {
  2040. const GDScriptParser::IdentifierNode *id = static_cast<const GDScriptParser::IdentifierNode *>(assign->assignee);
  2041. if (id->name == p_identifier->name && id->source == p_identifier->source) {
  2042. last_assign_line = assign->assigned_value->end_line;
  2043. last_assigned_expression = assign->assigned_value;
  2044. }
  2045. }
  2046. } break;
  2047. default:
  2048. // TODO: Check sub blocks (control flow statements) as they might also reassign stuff.
  2049. break;
  2050. }
  2051. }
  2052. if (suite->parent_if && suite->parent_if->condition && suite->parent_if->condition->type == GDScriptParser::Node::TYPE_TEST) {
  2053. // Operator `is` used, check if identifier is in there! this helps resolve in blocks that are (if (identifier is value)): which are very common..
  2054. // Super dirty hack, but very useful.
  2055. // Credit: Zylann.
  2056. // TODO: this could be hacked to detect AND-ed conditions too...
  2057. const GDScriptParser::TypeTestNode *type_test = static_cast<const GDScriptParser::TypeTestNode *>(suite->parent_if->condition);
  2058. if (type_test->operand && type_test->test_type && type_test->operand->type == GDScriptParser::Node::IDENTIFIER && static_cast<const GDScriptParser::IdentifierNode *>(type_test->operand)->name == p_identifier->name && static_cast<const GDScriptParser::IdentifierNode *>(type_test->operand)->source == p_identifier->source) {
  2059. // Bingo.
  2060. GDScriptParser::CompletionContext c = p_context;
  2061. c.current_line = type_test->operand->start_line;
  2062. c.current_suite = suite;
  2063. if (type_test->test_datatype.is_hard_type()) {
  2064. id_type.type = type_test->test_datatype;
  2065. if (last_assign_line < c.current_line) {
  2066. // Override last assignment.
  2067. last_assign_line = c.current_line;
  2068. last_assigned_expression = nullptr;
  2069. }
  2070. }
  2071. }
  2072. }
  2073. suite = suite->parent_block;
  2074. }
  2075. if (last_assigned_expression && last_assign_line < p_context.current_line) {
  2076. GDScriptParser::CompletionContext c = p_context;
  2077. c.current_line = last_assign_line;
  2078. GDScriptCompletionIdentifier assigned_type;
  2079. if (_guess_expression_type(c, last_assigned_expression, assigned_type)) {
  2080. if (id_type.type.is_set() && (assigned_type.type.kind == GDScriptParser::DataType::VARIANT || (assigned_type.type.is_set() && !GDScriptAnalyzer::check_type_compatibility(id_type.type, assigned_type.type)))) {
  2081. // The assigned type is incompatible. The annotated type takes priority.
  2082. r_type = id_type;
  2083. r_type.assigned_expression = last_assigned_expression;
  2084. } else {
  2085. r_type = assigned_type;
  2086. }
  2087. return true;
  2088. }
  2089. }
  2090. if (is_function_parameter && p_context.current_function && p_context.current_function->source_lambda == nullptr && p_context.current_class) {
  2091. // Check if it's override of native function, then we can assume the type from the signature.
  2092. GDScriptParser::DataType base_type = p_context.current_class->base_type;
  2093. while (base_type.is_set()) {
  2094. switch (base_type.kind) {
  2095. case GDScriptParser::DataType::CLASS:
  2096. if (base_type.class_type->has_function(p_context.current_function->identifier->name)) {
  2097. GDScriptParser::FunctionNode *parent_function = base_type.class_type->get_member(p_context.current_function->identifier->name).function;
  2098. if (parent_function->parameters_indices.has(p_identifier->name)) {
  2099. const GDScriptParser::ParameterNode *parameter = parent_function->parameters[parent_function->parameters_indices[p_identifier->name]];
  2100. if ((!id_type.type.is_set() || id_type.type.is_variant()) && parameter->get_datatype().is_hard_type()) {
  2101. id_type.type = parameter->get_datatype();
  2102. }
  2103. if (parameter->initializer) {
  2104. GDScriptParser::CompletionContext c = p_context;
  2105. c.current_function = parent_function;
  2106. c.current_class = base_type.class_type;
  2107. c.base = nullptr;
  2108. if (_guess_expression_type(c, parameter->initializer, r_type)) {
  2109. return true;
  2110. }
  2111. }
  2112. }
  2113. }
  2114. base_type = base_type.class_type->base_type;
  2115. break;
  2116. case GDScriptParser::DataType::NATIVE: {
  2117. if (id_type.type.is_set() && !id_type.type.is_variant()) {
  2118. base_type = GDScriptParser::DataType();
  2119. break;
  2120. }
  2121. MethodInfo info;
  2122. if (ClassDB::get_method_info(base_type.native_type, p_context.current_function->identifier->name, &info)) {
  2123. for (const PropertyInfo &E : info.arguments) {
  2124. if (E.name == p_identifier->name) {
  2125. r_type = _type_from_property(E);
  2126. return true;
  2127. }
  2128. }
  2129. }
  2130. base_type = GDScriptParser::DataType();
  2131. } break;
  2132. default:
  2133. break;
  2134. }
  2135. }
  2136. }
  2137. if (id_type.type.is_set() && !id_type.type.is_variant()) {
  2138. r_type = id_type;
  2139. return true;
  2140. }
  2141. // Check global scripts.
  2142. if (ScriptServer::is_global_class(p_identifier->name)) {
  2143. String script = ScriptServer::get_global_class_path(p_identifier->name);
  2144. if (script.to_lower().ends_with(".gd")) {
  2145. Ref<GDScriptParserRef> parser = p_context.parser->get_depended_parser_for(script);
  2146. if (parser.is_valid() && parser->raise_status(GDScriptParserRef::INTERFACE_SOLVED) == OK) {
  2147. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2148. r_type.type.script_path = script;
  2149. r_type.type.class_type = parser->get_parser()->get_tree();
  2150. r_type.type.is_meta_type = true;
  2151. r_type.type.is_constant = false;
  2152. r_type.type.kind = GDScriptParser::DataType::CLASS;
  2153. r_type.value = Variant();
  2154. return true;
  2155. }
  2156. } else {
  2157. Ref<Script> scr = ResourceLoader::load(ScriptServer::get_global_class_path(p_identifier->name));
  2158. if (scr.is_valid()) {
  2159. r_type = _type_from_variant(scr, p_context);
  2160. r_type.type.is_meta_type = true;
  2161. return true;
  2162. }
  2163. }
  2164. return false;
  2165. }
  2166. // Check global variables (including autoloads).
  2167. if (GDScriptLanguage::get_singleton()->get_named_globals_map().has(p_identifier->name)) {
  2168. r_type = _type_from_variant(GDScriptLanguage::get_singleton()->get_named_globals_map()[p_identifier->name], p_context);
  2169. return true;
  2170. }
  2171. // Check ClassDB.
  2172. if (ClassDB::class_exists(p_identifier->name) && ClassDB::is_class_exposed(p_identifier->name)) {
  2173. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2174. r_type.type.kind = GDScriptParser::DataType::NATIVE;
  2175. r_type.type.builtin_type = Variant::OBJECT;
  2176. r_type.type.native_type = p_identifier->name;
  2177. r_type.type.is_constant = true;
  2178. if (Engine::get_singleton()->has_singleton(p_identifier->name)) {
  2179. r_type.type.is_meta_type = false;
  2180. r_type.value = Engine::get_singleton()->get_singleton_object(p_identifier->name);
  2181. } else {
  2182. r_type.type.is_meta_type = true;
  2183. r_type.value = Variant();
  2184. }
  2185. }
  2186. return false;
  2187. }
  2188. static bool _guess_identifier_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_identifier, GDScriptCompletionIdentifier &r_type) {
  2189. static int recursion_depth = 0;
  2190. RecursionCheck recursion(&recursion_depth);
  2191. if (unlikely(recursion.check())) {
  2192. ERR_FAIL_V_MSG(false, "Reached recursion limit while trying to guess type.");
  2193. }
  2194. GDScriptParser::DataType base_type = p_base.type;
  2195. bool is_static = base_type.is_meta_type;
  2196. while (base_type.is_set()) {
  2197. switch (base_type.kind) {
  2198. case GDScriptParser::DataType::CLASS:
  2199. if (base_type.class_type->has_member(p_identifier)) {
  2200. const GDScriptParser::ClassNode::Member &member = base_type.class_type->get_member(p_identifier);
  2201. switch (member.type) {
  2202. case GDScriptParser::ClassNode::Member::CONSTANT:
  2203. r_type.type = member.constant->get_datatype();
  2204. if (member.constant->initializer && member.constant->initializer->is_constant) {
  2205. r_type.value = member.constant->initializer->reduced_value;
  2206. }
  2207. return true;
  2208. case GDScriptParser::ClassNode::Member::VARIABLE:
  2209. if (!is_static || member.variable->is_static) {
  2210. if (member.variable->get_datatype().is_set() && !member.variable->get_datatype().is_variant()) {
  2211. r_type.type = member.variable->get_datatype();
  2212. return true;
  2213. } else if (member.variable->initializer) {
  2214. const GDScriptParser::ExpressionNode *init = member.variable->initializer;
  2215. if (init->is_constant) {
  2216. r_type.value = init->reduced_value;
  2217. r_type = _type_from_variant(init->reduced_value, p_context);
  2218. return true;
  2219. } else if (init->start_line == p_context.current_line) {
  2220. return false;
  2221. // Detects if variable is assigned to itself
  2222. } else if (_is_expression_named_identifier(init, member.variable->identifier->name)) {
  2223. if (member.variable->initializer->get_datatype().is_set()) {
  2224. r_type.type = member.variable->initializer->get_datatype();
  2225. } else if (member.variable->get_datatype().is_set() && !member.variable->get_datatype().is_variant()) {
  2226. r_type.type = member.variable->get_datatype();
  2227. }
  2228. return true;
  2229. } else if (_guess_expression_type(p_context, init, r_type)) {
  2230. return true;
  2231. } else if (init->get_datatype().is_set() && !init->get_datatype().is_variant()) {
  2232. r_type.type = init->get_datatype();
  2233. return true;
  2234. }
  2235. }
  2236. }
  2237. // TODO: Check assignments in constructor.
  2238. return false;
  2239. case GDScriptParser::ClassNode::Member::ENUM:
  2240. r_type.type = member.m_enum->get_datatype();
  2241. r_type.enumeration = member.m_enum->identifier->name;
  2242. return true;
  2243. case GDScriptParser::ClassNode::Member::ENUM_VALUE:
  2244. r_type = _type_from_variant(member.enum_value.value, p_context);
  2245. return true;
  2246. case GDScriptParser::ClassNode::Member::SIGNAL:
  2247. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2248. r_type.type.kind = GDScriptParser::DataType::BUILTIN;
  2249. r_type.type.builtin_type = Variant::SIGNAL;
  2250. r_type.type.method_info = member.signal->method_info;
  2251. return true;
  2252. case GDScriptParser::ClassNode::Member::FUNCTION:
  2253. if (is_static && !member.function->is_static) {
  2254. return false;
  2255. }
  2256. r_type = _callable_type_from_method_info(member.function->info);
  2257. return true;
  2258. case GDScriptParser::ClassNode::Member::CLASS:
  2259. r_type.type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2260. r_type.type.kind = GDScriptParser::DataType::CLASS;
  2261. r_type.type.class_type = member.m_class;
  2262. r_type.type.is_meta_type = true;
  2263. return true;
  2264. case GDScriptParser::ClassNode::Member::GROUP:
  2265. return false; // No-op, but silences warnings.
  2266. case GDScriptParser::ClassNode::Member::UNDEFINED:
  2267. return false; // Unreachable.
  2268. }
  2269. return false;
  2270. }
  2271. base_type = base_type.class_type->base_type;
  2272. break;
  2273. case GDScriptParser::DataType::SCRIPT: {
  2274. Ref<Script> scr = base_type.script_type;
  2275. if (scr.is_valid()) {
  2276. HashMap<StringName, Variant> constants;
  2277. scr->get_constants(&constants);
  2278. if (constants.has(p_identifier)) {
  2279. r_type = _type_from_variant(constants[p_identifier], p_context);
  2280. return true;
  2281. }
  2282. List<PropertyInfo> members;
  2283. if (is_static) {
  2284. scr->get_property_list(&members);
  2285. } else {
  2286. scr->get_script_property_list(&members);
  2287. }
  2288. for (const PropertyInfo &prop : members) {
  2289. if (prop.name == p_identifier) {
  2290. r_type = _type_from_property(prop);
  2291. return true;
  2292. }
  2293. }
  2294. if (scr->has_method(p_identifier)) {
  2295. MethodInfo mi = scr->get_method_info(p_identifier);
  2296. r_type = _callable_type_from_method_info(mi);
  2297. return true;
  2298. }
  2299. Ref<Script> parent = scr->get_base_script();
  2300. if (parent.is_valid()) {
  2301. base_type.script_type = parent;
  2302. } else {
  2303. base_type.kind = GDScriptParser::DataType::NATIVE;
  2304. base_type.builtin_type = Variant::OBJECT;
  2305. base_type.native_type = scr->get_instance_base_type();
  2306. }
  2307. } else {
  2308. return false;
  2309. }
  2310. } break;
  2311. case GDScriptParser::DataType::NATIVE: {
  2312. StringName class_name = base_type.native_type;
  2313. if (!ClassDB::class_exists(class_name)) {
  2314. return false;
  2315. }
  2316. // Skip constants since they're all integers. Type does not matter because int has no members.
  2317. PropertyInfo prop;
  2318. if (ClassDB::get_property_info(class_name, p_identifier, &prop)) {
  2319. StringName getter = ClassDB::get_property_getter(class_name, p_identifier);
  2320. if (getter != StringName()) {
  2321. MethodBind *g = ClassDB::get_method(class_name, getter);
  2322. if (g) {
  2323. r_type = _type_from_property(g->get_return_info());
  2324. return true;
  2325. }
  2326. } else {
  2327. r_type = _type_from_property(prop);
  2328. return true;
  2329. }
  2330. }
  2331. MethodInfo method;
  2332. if (ClassDB::get_method_info(class_name, p_identifier, &method)) {
  2333. r_type = _callable_type_from_method_info(method);
  2334. return true;
  2335. }
  2336. return false;
  2337. } break;
  2338. case GDScriptParser::DataType::BUILTIN: {
  2339. if (Variant::has_builtin_method(base_type.builtin_type, p_identifier)) {
  2340. r_type = _callable_type_from_method_info(Variant::get_builtin_method_info(base_type.builtin_type, p_identifier));
  2341. return true;
  2342. } else {
  2343. Callable::CallError err;
  2344. Variant tmp;
  2345. Variant::construct(base_type.builtin_type, tmp, nullptr, 0, err);
  2346. if (err.error != Callable::CallError::CALL_OK) {
  2347. return false;
  2348. }
  2349. bool valid = false;
  2350. Variant res = tmp.get(p_identifier, &valid);
  2351. if (valid) {
  2352. r_type = _type_from_variant(res, p_context);
  2353. r_type.value = Variant();
  2354. r_type.type.is_constant = false;
  2355. return true;
  2356. }
  2357. }
  2358. return false;
  2359. } break;
  2360. default: {
  2361. return false;
  2362. } break;
  2363. }
  2364. }
  2365. return false;
  2366. }
  2367. static void _find_last_return_in_block(GDScriptParser::CompletionContext &p_context, int &r_last_return_line, const GDScriptParser::ExpressionNode **r_last_returned_value) {
  2368. if (!p_context.current_suite) {
  2369. return;
  2370. }
  2371. for (int i = 0; i < p_context.current_suite->statements.size(); i++) {
  2372. if (p_context.current_suite->statements[i]->start_line < r_last_return_line) {
  2373. break;
  2374. }
  2375. GDScriptParser::CompletionContext c = p_context;
  2376. switch (p_context.current_suite->statements[i]->type) {
  2377. case GDScriptParser::Node::FOR:
  2378. c.current_suite = static_cast<const GDScriptParser::ForNode *>(p_context.current_suite->statements[i])->loop;
  2379. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  2380. break;
  2381. case GDScriptParser::Node::WHILE:
  2382. c.current_suite = static_cast<const GDScriptParser::WhileNode *>(p_context.current_suite->statements[i])->loop;
  2383. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  2384. break;
  2385. case GDScriptParser::Node::IF: {
  2386. const GDScriptParser::IfNode *_if = static_cast<const GDScriptParser::IfNode *>(p_context.current_suite->statements[i]);
  2387. c.current_suite = _if->true_block;
  2388. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  2389. if (_if->false_block) {
  2390. c.current_suite = _if->false_block;
  2391. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  2392. }
  2393. } break;
  2394. case GDScriptParser::Node::MATCH: {
  2395. const GDScriptParser::MatchNode *match = static_cast<const GDScriptParser::MatchNode *>(p_context.current_suite->statements[i]);
  2396. for (int j = 0; j < match->branches.size(); j++) {
  2397. c.current_suite = match->branches[j]->block;
  2398. _find_last_return_in_block(c, r_last_return_line, r_last_returned_value);
  2399. }
  2400. } break;
  2401. case GDScriptParser::Node::RETURN: {
  2402. const GDScriptParser::ReturnNode *ret = static_cast<const GDScriptParser::ReturnNode *>(p_context.current_suite->statements[i]);
  2403. if (ret->return_value) {
  2404. if (ret->start_line > r_last_return_line) {
  2405. r_last_return_line = ret->start_line;
  2406. *r_last_returned_value = ret->return_value;
  2407. }
  2408. }
  2409. } break;
  2410. default:
  2411. break;
  2412. }
  2413. }
  2414. }
  2415. static bool _guess_method_return_type_from_base(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_method, GDScriptCompletionIdentifier &r_type) {
  2416. static int recursion_depth = 0;
  2417. RecursionCheck recursion(&recursion_depth);
  2418. if (unlikely(recursion.check())) {
  2419. ERR_FAIL_V_MSG(false, "Reached recursion limit while trying to guess type.");
  2420. }
  2421. GDScriptParser::DataType base_type = p_base.type;
  2422. bool is_static = base_type.is_meta_type;
  2423. if (is_static && p_method == SNAME("new")) {
  2424. r_type.type = base_type;
  2425. r_type.type.is_meta_type = false;
  2426. r_type.type.is_constant = false;
  2427. return true;
  2428. }
  2429. while (base_type.is_set() && !base_type.is_variant()) {
  2430. switch (base_type.kind) {
  2431. case GDScriptParser::DataType::CLASS:
  2432. if (base_type.class_type->has_function(p_method)) {
  2433. GDScriptParser::FunctionNode *method = base_type.class_type->get_member(p_method).function;
  2434. if (!is_static || method->is_static) {
  2435. if (method->get_datatype().is_set() && !method->get_datatype().is_variant()) {
  2436. r_type.type = method->get_datatype();
  2437. return true;
  2438. }
  2439. int last_return_line = -1;
  2440. const GDScriptParser::ExpressionNode *last_returned_value = nullptr;
  2441. GDScriptParser::CompletionContext c = p_context;
  2442. c.current_class = base_type.class_type;
  2443. c.current_function = method;
  2444. c.current_suite = method->body;
  2445. _find_last_return_in_block(c, last_return_line, &last_returned_value);
  2446. if (last_returned_value) {
  2447. c.current_line = c.current_suite->end_line;
  2448. if (_guess_expression_type(c, last_returned_value, r_type)) {
  2449. return true;
  2450. }
  2451. }
  2452. }
  2453. }
  2454. base_type = base_type.class_type->base_type;
  2455. break;
  2456. case GDScriptParser::DataType::SCRIPT: {
  2457. Ref<Script> scr = base_type.script_type;
  2458. if (scr.is_valid()) {
  2459. List<MethodInfo> methods;
  2460. scr->get_script_method_list(&methods);
  2461. for (const MethodInfo &mi : methods) {
  2462. if (mi.name == p_method) {
  2463. r_type = _type_from_property(mi.return_val);
  2464. return true;
  2465. }
  2466. }
  2467. Ref<Script> base_script = scr->get_base_script();
  2468. if (base_script.is_valid()) {
  2469. base_type.script_type = base_script;
  2470. } else {
  2471. base_type.kind = GDScriptParser::DataType::NATIVE;
  2472. base_type.builtin_type = Variant::OBJECT;
  2473. base_type.native_type = scr->get_instance_base_type();
  2474. }
  2475. } else {
  2476. return false;
  2477. }
  2478. } break;
  2479. case GDScriptParser::DataType::NATIVE: {
  2480. if (!ClassDB::class_exists(base_type.native_type)) {
  2481. return false;
  2482. }
  2483. MethodBind *mb = ClassDB::get_method(base_type.native_type, p_method);
  2484. if (mb) {
  2485. r_type = _type_from_property(mb->get_return_info());
  2486. return true;
  2487. }
  2488. return false;
  2489. } break;
  2490. case GDScriptParser::DataType::BUILTIN: {
  2491. Callable::CallError err;
  2492. Variant tmp;
  2493. Variant::construct(base_type.builtin_type, tmp, nullptr, 0, err);
  2494. if (err.error != Callable::CallError::CALL_OK) {
  2495. return false;
  2496. }
  2497. List<MethodInfo> methods;
  2498. tmp.get_method_list(&methods);
  2499. for (const MethodInfo &mi : methods) {
  2500. if (mi.name == p_method) {
  2501. r_type = _type_from_property(mi.return_val);
  2502. return true;
  2503. }
  2504. }
  2505. return false;
  2506. } break;
  2507. default: {
  2508. return false;
  2509. }
  2510. }
  2511. }
  2512. return false;
  2513. }
  2514. static bool _guess_expecting_callable(GDScriptParser::CompletionContext &p_context) {
  2515. if (p_context.call.call != nullptr && p_context.call.call->type == GDScriptParser::Node::CALL) {
  2516. GDScriptParser::CallNode *call_node = static_cast<GDScriptParser::CallNode *>(p_context.call.call);
  2517. GDScriptCompletionIdentifier ci;
  2518. if (_guess_expression_type(p_context, call_node->callee, ci)) {
  2519. if (ci.type.kind == GDScriptParser::DataType::BUILTIN && ci.type.builtin_type == Variant::CALLABLE) {
  2520. if (p_context.call.argument >= 0 && p_context.call.argument < ci.type.method_info.arguments.size()) {
  2521. return ci.type.method_info.arguments.get(p_context.call.argument).type == Variant::CALLABLE;
  2522. }
  2523. }
  2524. }
  2525. }
  2526. return false;
  2527. }
  2528. static void _find_enumeration_candidates(GDScriptParser::CompletionContext &p_context, const String &p_enum_hint, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result) {
  2529. if (!p_enum_hint.contains_char('.')) {
  2530. // Global constant or in the current class.
  2531. StringName current_enum = p_enum_hint;
  2532. if (p_context.current_class && p_context.current_class->has_member(current_enum) && p_context.current_class->get_member(current_enum).type == GDScriptParser::ClassNode::Member::ENUM) {
  2533. const GDScriptParser::EnumNode *_enum = p_context.current_class->get_member(current_enum).m_enum;
  2534. for (int i = 0; i < _enum->values.size(); i++) {
  2535. ScriptLanguage::CodeCompletionOption option(_enum->values[i].identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_ENUM);
  2536. r_result.insert(option.display, option);
  2537. }
  2538. } else {
  2539. for (int i = 0; i < CoreConstants::get_global_constant_count(); i++) {
  2540. if (CoreConstants::get_global_constant_enum(i) == current_enum) {
  2541. ScriptLanguage::CodeCompletionOption option(CoreConstants::get_global_constant_name(i), ScriptLanguage::CODE_COMPLETION_KIND_ENUM);
  2542. r_result.insert(option.display, option);
  2543. }
  2544. }
  2545. }
  2546. } else {
  2547. String class_name = p_enum_hint.get_slicec('.', 0);
  2548. String enum_name = p_enum_hint.get_slicec('.', 1);
  2549. if (!ClassDB::class_exists(class_name)) {
  2550. return;
  2551. }
  2552. List<StringName> enum_constants;
  2553. ClassDB::get_enum_constants(class_name, enum_name, &enum_constants);
  2554. for (const StringName &E : enum_constants) {
  2555. String candidate = class_name + "." + E;
  2556. int location = _get_enum_constant_location(class_name, E);
  2557. ScriptLanguage::CodeCompletionOption option(candidate, ScriptLanguage::CODE_COMPLETION_KIND_ENUM, location);
  2558. r_result.insert(option.display, option);
  2559. }
  2560. }
  2561. }
  2562. static void _find_call_arguments(GDScriptParser::CompletionContext &p_context, const GDScriptCompletionIdentifier &p_base, const StringName &p_method, int p_argidx, bool p_static, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, String &r_arghint) {
  2563. Variant base = p_base.value;
  2564. GDScriptParser::DataType base_type = p_base.type;
  2565. const String quote_style = EDITOR_GET("text_editor/completion/use_single_quotes") ? "'" : "\"";
  2566. const bool use_string_names = EDITOR_GET("text_editor/completion/add_string_name_literals");
  2567. const bool use_node_paths = EDITOR_GET("text_editor/completion/add_node_path_literals");
  2568. while (base_type.is_set() && !base_type.is_variant()) {
  2569. switch (base_type.kind) {
  2570. case GDScriptParser::DataType::CLASS: {
  2571. if (base_type.is_meta_type && p_method == SNAME("new")) {
  2572. const GDScriptParser::ClassNode *current = base_type.class_type;
  2573. do {
  2574. if (current->has_member("_init")) {
  2575. const GDScriptParser::ClassNode::Member &member = current->get_member("_init");
  2576. if (member.type == GDScriptParser::ClassNode::Member::FUNCTION) {
  2577. r_arghint = base_type.class_type->get_datatype().to_string() + " new" + _make_arguments_hint(member.function, p_argidx, true);
  2578. return;
  2579. }
  2580. }
  2581. current = current->base_type.class_type;
  2582. } while (current != nullptr);
  2583. r_arghint = base_type.class_type->get_datatype().to_string() + " new()";
  2584. return;
  2585. }
  2586. if (base_type.class_type->has_member(p_method)) {
  2587. const GDScriptParser::ClassNode::Member &member = base_type.class_type->get_member(p_method);
  2588. if (member.type == GDScriptParser::ClassNode::Member::FUNCTION) {
  2589. r_arghint = _make_arguments_hint(member.function, p_argidx);
  2590. return;
  2591. }
  2592. }
  2593. base_type = base_type.class_type->base_type;
  2594. } break;
  2595. case GDScriptParser::DataType::SCRIPT: {
  2596. if (base_type.script_type->is_valid() && base_type.script_type->has_method(p_method)) {
  2597. r_arghint = _make_arguments_hint(base_type.script_type->get_method_info(p_method), p_argidx);
  2598. return;
  2599. }
  2600. Ref<Script> base_script = base_type.script_type->get_base_script();
  2601. if (base_script.is_valid()) {
  2602. base_type.script_type = base_script;
  2603. } else {
  2604. base_type.kind = GDScriptParser::DataType::NATIVE;
  2605. base_type.builtin_type = Variant::OBJECT;
  2606. base_type.native_type = base_type.script_type->get_instance_base_type();
  2607. }
  2608. } break;
  2609. case GDScriptParser::DataType::NATIVE: {
  2610. StringName class_name = base_type.native_type;
  2611. if (!ClassDB::class_exists(class_name)) {
  2612. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2613. break;
  2614. }
  2615. MethodInfo info;
  2616. int method_args = 0;
  2617. if (ClassDB::get_method_info(class_name, p_method, &info)) {
  2618. method_args = info.arguments.size();
  2619. if (base.get_type() == Variant::OBJECT) {
  2620. Object *obj = base.operator Object *();
  2621. if (obj) {
  2622. List<String> options;
  2623. obj->get_argument_options(p_method, p_argidx, &options);
  2624. for (String &opt : options) {
  2625. // Handle user preference.
  2626. if (opt.is_quoted()) {
  2627. opt = opt.unquote().quote(quote_style);
  2628. if (use_string_names && info.arguments[p_argidx].type == Variant::STRING_NAME) {
  2629. opt = "&" + opt;
  2630. } else if (use_node_paths && info.arguments[p_argidx].type == Variant::NODE_PATH) {
  2631. opt = "^" + opt;
  2632. }
  2633. }
  2634. ScriptLanguage::CodeCompletionOption option(opt, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  2635. r_result.insert(option.display, option);
  2636. }
  2637. }
  2638. }
  2639. if (p_argidx < method_args) {
  2640. const PropertyInfo &arg_info = info.arguments[p_argidx];
  2641. if (arg_info.usage & (PROPERTY_USAGE_CLASS_IS_ENUM | PROPERTY_USAGE_CLASS_IS_BITFIELD)) {
  2642. _find_enumeration_candidates(p_context, arg_info.class_name, r_result);
  2643. }
  2644. }
  2645. r_arghint = _make_arguments_hint(info, p_argidx);
  2646. }
  2647. if (p_argidx == 1 && p_context.node && p_context.node->type == GDScriptParser::Node::CALL && ClassDB::is_parent_class(class_name, SNAME("Tween")) && p_method == SNAME("tween_property")) {
  2648. // Get tweened objects properties.
  2649. if (static_cast<GDScriptParser::CallNode *>(p_context.node)->arguments.is_empty()) {
  2650. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2651. break;
  2652. }
  2653. GDScriptParser::ExpressionNode *tweened_object = static_cast<GDScriptParser::CallNode *>(p_context.node)->arguments[0];
  2654. if (!tweened_object) {
  2655. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2656. break;
  2657. }
  2658. StringName native_type = tweened_object->datatype.native_type;
  2659. switch (tweened_object->datatype.kind) {
  2660. case GDScriptParser::DataType::SCRIPT: {
  2661. Ref<Script> script = tweened_object->datatype.script_type;
  2662. native_type = script->get_instance_base_type();
  2663. int n = 0;
  2664. while (script.is_valid()) {
  2665. List<PropertyInfo> properties;
  2666. script->get_script_property_list(&properties);
  2667. for (const PropertyInfo &E : properties) {
  2668. if (E.usage & (PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_GROUP | PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_INTERNAL)) {
  2669. continue;
  2670. }
  2671. String name = E.name.quote(quote_style);
  2672. if (use_node_paths) {
  2673. name = "^" + name;
  2674. }
  2675. ScriptLanguage::CodeCompletionOption option(name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, ScriptLanguage::CodeCompletionLocation::LOCATION_LOCAL + n);
  2676. r_result.insert(option.display, option);
  2677. }
  2678. script = script->get_base_script();
  2679. n++;
  2680. }
  2681. } break;
  2682. case GDScriptParser::DataType::CLASS: {
  2683. GDScriptParser::ClassNode *clss = tweened_object->datatype.class_type;
  2684. native_type = clss->base_type.native_type;
  2685. int n = 0;
  2686. while (clss) {
  2687. for (GDScriptParser::ClassNode::Member member : clss->members) {
  2688. if (member.type == GDScriptParser::ClassNode::Member::VARIABLE) {
  2689. String name = member.get_name().quote(quote_style);
  2690. if (use_node_paths) {
  2691. name = "^" + name;
  2692. }
  2693. ScriptLanguage::CodeCompletionOption option(name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, ScriptLanguage::CodeCompletionLocation::LOCATION_LOCAL + n);
  2694. r_result.insert(option.display, option);
  2695. }
  2696. }
  2697. if (clss->base_type.kind == GDScriptParser::DataType::Kind::CLASS) {
  2698. clss = clss->base_type.class_type;
  2699. n++;
  2700. } else {
  2701. native_type = clss->base_type.native_type;
  2702. clss = nullptr;
  2703. }
  2704. }
  2705. } break;
  2706. default:
  2707. break;
  2708. }
  2709. List<PropertyInfo> properties;
  2710. ClassDB::get_property_list(native_type, &properties);
  2711. for (const PropertyInfo &E : properties) {
  2712. if (E.usage & (PROPERTY_USAGE_SUBGROUP | PROPERTY_USAGE_GROUP | PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_INTERNAL)) {
  2713. continue;
  2714. }
  2715. String name = E.name.quote(quote_style);
  2716. if (use_node_paths) {
  2717. name = "^" + name;
  2718. }
  2719. ScriptLanguage::CodeCompletionOption option(name, ScriptLanguage::CODE_COMPLETION_KIND_MEMBER);
  2720. r_result.insert(option.display, option);
  2721. }
  2722. }
  2723. if (p_argidx == 0 && ClassDB::is_parent_class(class_name, SNAME("Node")) && (p_method == SNAME("get_node") || p_method == SNAME("has_node"))) {
  2724. // Get autoloads
  2725. List<PropertyInfo> props;
  2726. ProjectSettings::get_singleton()->get_property_list(&props);
  2727. for (const PropertyInfo &E : props) {
  2728. String s = E.name;
  2729. if (!s.begins_with("autoload/")) {
  2730. continue;
  2731. }
  2732. String name = s.get_slicec('/', 1);
  2733. String path = ("/root/" + name).quote(quote_style);
  2734. if (use_node_paths) {
  2735. path = "^" + path;
  2736. }
  2737. ScriptLanguage::CodeCompletionOption option(path, ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH);
  2738. r_result.insert(option.display, option);
  2739. }
  2740. }
  2741. if (p_argidx == 0 && method_args > 0 && ClassDB::is_parent_class(class_name, SNAME("InputEvent")) && p_method.operator String().contains("action")) {
  2742. // Get input actions
  2743. List<PropertyInfo> props;
  2744. ProjectSettings::get_singleton()->get_property_list(&props);
  2745. for (const PropertyInfo &E : props) {
  2746. String s = E.name;
  2747. if (!s.begins_with("input/")) {
  2748. continue;
  2749. }
  2750. String name = s.get_slicec('/', 1).quote(quote_style);
  2751. if (use_string_names) {
  2752. name = "&" + name;
  2753. }
  2754. ScriptLanguage::CodeCompletionOption option(name, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  2755. r_result.insert(option.display, option);
  2756. }
  2757. }
  2758. if (EDITOR_GET("text_editor/completion/complete_file_paths")) {
  2759. if (p_argidx == 0 && p_method == SNAME("change_scene_to_file") && ClassDB::is_parent_class(class_name, SNAME("SceneTree"))) {
  2760. HashMap<String, ScriptLanguage::CodeCompletionOption> list;
  2761. _get_directory_contents(EditorFileSystem::get_singleton()->get_filesystem(), list, SNAME("PackedScene"));
  2762. for (const KeyValue<String, ScriptLanguage::CodeCompletionOption> &key_value_pair : list) {
  2763. ScriptLanguage::CodeCompletionOption option = key_value_pair.value;
  2764. r_result.insert(option.display, option);
  2765. }
  2766. }
  2767. }
  2768. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2769. } break;
  2770. case GDScriptParser::DataType::BUILTIN: {
  2771. if (base.get_type() == Variant::NIL) {
  2772. Callable::CallError err;
  2773. Variant::construct(base_type.builtin_type, base, nullptr, 0, err);
  2774. if (err.error != Callable::CallError::CALL_OK) {
  2775. return;
  2776. }
  2777. }
  2778. List<MethodInfo> methods;
  2779. base.get_method_list(&methods);
  2780. for (const MethodInfo &E : methods) {
  2781. if (E.name == p_method) {
  2782. r_arghint = _make_arguments_hint(E, p_argidx);
  2783. return;
  2784. }
  2785. }
  2786. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2787. } break;
  2788. default: {
  2789. base_type.kind = GDScriptParser::DataType::UNRESOLVED;
  2790. } break;
  2791. }
  2792. }
  2793. }
  2794. static bool _get_subscript_type(GDScriptParser::CompletionContext &p_context, const GDScriptParser::SubscriptNode *p_subscript, GDScriptParser::DataType &r_base_type, Variant *r_base = nullptr) {
  2795. if (p_context.base == nullptr) {
  2796. return false;
  2797. }
  2798. const GDScriptParser::GetNodeNode *get_node = nullptr;
  2799. switch (p_subscript->base->type) {
  2800. case GDScriptParser::Node::GET_NODE: {
  2801. get_node = static_cast<GDScriptParser::GetNodeNode *>(p_subscript->base);
  2802. } break;
  2803. case GDScriptParser::Node::IDENTIFIER: {
  2804. const GDScriptParser::IdentifierNode *identifier_node = static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base);
  2805. switch (identifier_node->source) {
  2806. case GDScriptParser::IdentifierNode::Source::MEMBER_VARIABLE: {
  2807. if (p_context.current_class != nullptr) {
  2808. const StringName &member_name = identifier_node->name;
  2809. const GDScriptParser::ClassNode *current_class = p_context.current_class;
  2810. if (current_class->has_member(member_name)) {
  2811. const GDScriptParser::ClassNode::Member &member = current_class->get_member(member_name);
  2812. if (member.type == GDScriptParser::ClassNode::Member::VARIABLE) {
  2813. const GDScriptParser::VariableNode *variable = static_cast<GDScriptParser::VariableNode *>(member.variable);
  2814. if (variable->initializer && variable->initializer->type == GDScriptParser::Node::GET_NODE) {
  2815. get_node = static_cast<GDScriptParser::GetNodeNode *>(variable->initializer);
  2816. }
  2817. }
  2818. }
  2819. }
  2820. } break;
  2821. case GDScriptParser::IdentifierNode::Source::LOCAL_VARIABLE: {
  2822. if (identifier_node->next != nullptr && identifier_node->next->type == GDScriptParser::ClassNode::Node::GET_NODE) {
  2823. get_node = static_cast<GDScriptParser::GetNodeNode *>(identifier_node->next);
  2824. }
  2825. } break;
  2826. default: {
  2827. } break;
  2828. }
  2829. } break;
  2830. default: {
  2831. } break;
  2832. }
  2833. if (get_node != nullptr) {
  2834. const Object *node = p_context.base->call("get_node_or_null", NodePath(get_node->full_path));
  2835. if (node != nullptr) {
  2836. GDScriptParser::DataType assigned_type = _type_from_variant(node, p_context).type;
  2837. GDScriptParser::DataType base_type = p_subscript->base->datatype;
  2838. if (p_subscript->base->type == GDScriptParser::Node::IDENTIFIER && base_type.type_source == GDScriptParser::DataType::ANNOTATED_EXPLICIT && (assigned_type.kind != base_type.kind || assigned_type.script_path != base_type.script_path || assigned_type.native_type != base_type.native_type)) {
  2839. // Annotated type takes precedence.
  2840. return false;
  2841. }
  2842. if (r_base != nullptr) {
  2843. *r_base = node;
  2844. }
  2845. r_base_type.type_source = GDScriptParser::DataType::INFERRED;
  2846. r_base_type.builtin_type = Variant::OBJECT;
  2847. r_base_type.native_type = node->get_class_name();
  2848. Ref<Script> scr = node->get_script();
  2849. if (scr.is_null()) {
  2850. r_base_type.kind = GDScriptParser::DataType::NATIVE;
  2851. } else {
  2852. r_base_type.kind = GDScriptParser::DataType::SCRIPT;
  2853. r_base_type.script_type = scr;
  2854. }
  2855. return true;
  2856. }
  2857. }
  2858. return false;
  2859. }
  2860. static void _find_call_arguments(GDScriptParser::CompletionContext &p_context, const GDScriptParser::Node *p_call, int p_argidx, HashMap<String, ScriptLanguage::CodeCompletionOption> &r_result, bool &r_forced, String &r_arghint) {
  2861. if (p_call->type == GDScriptParser::Node::PRELOAD) {
  2862. if (p_argidx == 0 && bool(EDITOR_GET("text_editor/completion/complete_file_paths"))) {
  2863. _get_directory_contents(EditorFileSystem::get_singleton()->get_filesystem(), r_result);
  2864. }
  2865. MethodInfo mi(PropertyInfo(Variant::OBJECT, "resource", PROPERTY_HINT_RESOURCE_TYPE, "Resource"), "preload", PropertyInfo(Variant::STRING, "path"));
  2866. r_arghint = _make_arguments_hint(mi, p_argidx);
  2867. return;
  2868. } else if (p_call->type != GDScriptParser::Node::CALL) {
  2869. return;
  2870. }
  2871. Variant base;
  2872. GDScriptParser::DataType base_type;
  2873. bool _static = false;
  2874. const GDScriptParser::CallNode *call = static_cast<const GDScriptParser::CallNode *>(p_call);
  2875. GDScriptParser::Node::Type callee_type = call->get_callee_type();
  2876. if (callee_type == GDScriptParser::Node::SUBSCRIPT) {
  2877. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(call->callee);
  2878. if (subscript->base != nullptr && subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  2879. const GDScriptParser::IdentifierNode *base_identifier = static_cast<const GDScriptParser::IdentifierNode *>(subscript->base);
  2880. Variant::Type method_type = GDScriptParser::get_builtin_type(base_identifier->name);
  2881. if (method_type < Variant::VARIANT_MAX) {
  2882. Variant v;
  2883. Callable::CallError err;
  2884. Variant::construct(method_type, v, nullptr, 0, err);
  2885. if (err.error != Callable::CallError::CALL_OK) {
  2886. return;
  2887. }
  2888. List<MethodInfo> methods;
  2889. v.get_method_list(&methods);
  2890. for (MethodInfo &E : methods) {
  2891. if (p_argidx >= E.arguments.size()) {
  2892. continue;
  2893. }
  2894. if (E.name == call->function_name) {
  2895. r_arghint += _make_arguments_hint(E, p_argidx);
  2896. return;
  2897. }
  2898. }
  2899. }
  2900. }
  2901. if (subscript->is_attribute) {
  2902. bool found_type = _get_subscript_type(p_context, subscript, base_type, &base);
  2903. if (!found_type) {
  2904. GDScriptCompletionIdentifier ci;
  2905. if (_guess_expression_type(p_context, subscript->base, ci)) {
  2906. base_type = ci.type;
  2907. base = ci.value;
  2908. } else {
  2909. return;
  2910. }
  2911. }
  2912. _static = base_type.is_meta_type;
  2913. }
  2914. } else if (Variant::has_utility_function(call->function_name)) {
  2915. MethodInfo info = Variant::get_utility_function_info(call->function_name);
  2916. r_arghint = _make_arguments_hint(info, p_argidx);
  2917. return;
  2918. } else if (GDScriptUtilityFunctions::function_exists(call->function_name)) {
  2919. MethodInfo info = GDScriptUtilityFunctions::get_function_info(call->function_name);
  2920. r_arghint = _make_arguments_hint(info, p_argidx);
  2921. return;
  2922. } else if (GDScriptParser::get_builtin_type(call->function_name) < Variant::VARIANT_MAX) {
  2923. // Complete constructor.
  2924. List<MethodInfo> constructors;
  2925. Variant::get_constructor_list(GDScriptParser::get_builtin_type(call->function_name), &constructors);
  2926. int i = 0;
  2927. for (const MethodInfo &E : constructors) {
  2928. if (p_argidx >= E.arguments.size()) {
  2929. continue;
  2930. }
  2931. if (i > 0) {
  2932. r_arghint += "\n";
  2933. }
  2934. r_arghint += _make_arguments_hint(E, p_argidx);
  2935. i++;
  2936. }
  2937. return;
  2938. } else if (call->is_super || callee_type == GDScriptParser::Node::IDENTIFIER) {
  2939. base = p_context.base;
  2940. if (p_context.current_class) {
  2941. base_type = p_context.current_class->get_datatype();
  2942. _static = !p_context.current_function || p_context.current_function->is_static;
  2943. }
  2944. } else {
  2945. return;
  2946. }
  2947. GDScriptCompletionIdentifier ci;
  2948. ci.type = base_type;
  2949. ci.value = base;
  2950. _find_call_arguments(p_context, ci, call->function_name, p_argidx, _static, r_result, r_arghint);
  2951. r_forced = r_result.size() > 0;
  2952. }
  2953. ::Error GDScriptLanguage::complete_code(const String &p_code, const String &p_path, Object *p_owner, List<ScriptLanguage::CodeCompletionOption> *r_options, bool &r_forced, String &r_call_hint) {
  2954. const String quote_style = EDITOR_GET("text_editor/completion/use_single_quotes") ? "'" : "\"";
  2955. GDScriptParser parser;
  2956. GDScriptAnalyzer analyzer(&parser);
  2957. parser.parse(p_code, p_path, true);
  2958. analyzer.analyze();
  2959. r_forced = false;
  2960. HashMap<String, ScriptLanguage::CodeCompletionOption> options;
  2961. GDScriptParser::CompletionContext completion_context = parser.get_completion_context();
  2962. if (completion_context.current_class != nullptr && completion_context.current_class->outer == nullptr) {
  2963. completion_context.base = p_owner;
  2964. }
  2965. bool is_function = false;
  2966. switch (completion_context.type) {
  2967. case GDScriptParser::COMPLETION_NONE:
  2968. break;
  2969. case GDScriptParser::COMPLETION_ANNOTATION: {
  2970. List<MethodInfo> annotations;
  2971. parser.get_annotation_list(&annotations);
  2972. for (const MethodInfo &E : annotations) {
  2973. ScriptLanguage::CodeCompletionOption option(E.name.substr(1), ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  2974. if (E.arguments.size() > 0) {
  2975. option.insert_text += "(";
  2976. }
  2977. options.insert(option.display, option);
  2978. }
  2979. r_forced = true;
  2980. } break;
  2981. case GDScriptParser::COMPLETION_ANNOTATION_ARGUMENTS: {
  2982. if (completion_context.node == nullptr || completion_context.node->type != GDScriptParser::Node::ANNOTATION) {
  2983. break;
  2984. }
  2985. const GDScriptParser::AnnotationNode *annotation = static_cast<const GDScriptParser::AnnotationNode *>(completion_context.node);
  2986. _find_annotation_arguments(annotation, completion_context.current_argument, quote_style, options, r_call_hint);
  2987. r_forced = true;
  2988. } break;
  2989. case GDScriptParser::COMPLETION_BUILT_IN_TYPE_CONSTANT_OR_STATIC_METHOD: {
  2990. // Constants.
  2991. {
  2992. List<StringName> constants;
  2993. Variant::get_constants_for_type(completion_context.builtin_type, &constants);
  2994. for (const StringName &E : constants) {
  2995. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_CONSTANT);
  2996. bool valid = false;
  2997. Variant default_value = Variant::get_constant_value(completion_context.builtin_type, E, &valid);
  2998. if (valid) {
  2999. option.default_value = default_value;
  3000. }
  3001. options.insert(option.display, option);
  3002. }
  3003. }
  3004. // Methods.
  3005. {
  3006. List<StringName> methods;
  3007. Variant::get_builtin_method_list(completion_context.builtin_type, &methods);
  3008. for (const StringName &E : methods) {
  3009. if (Variant::is_builtin_method_static(completion_context.builtin_type, E)) {
  3010. ScriptLanguage::CodeCompletionOption option(E, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  3011. if (!_guess_expecting_callable(completion_context)) {
  3012. if (Variant::get_builtin_method_argument_count(completion_context.builtin_type, E) > 0 || Variant::is_builtin_method_vararg(completion_context.builtin_type, E)) {
  3013. option.insert_text += "(";
  3014. } else {
  3015. option.insert_text += "()";
  3016. }
  3017. }
  3018. options.insert(option.display, option);
  3019. }
  3020. }
  3021. }
  3022. } break;
  3023. case GDScriptParser::COMPLETION_INHERIT_TYPE: {
  3024. _list_available_types(true, completion_context, options);
  3025. r_forced = true;
  3026. } break;
  3027. case GDScriptParser::COMPLETION_TYPE_NAME_OR_VOID: {
  3028. ScriptLanguage::CodeCompletionOption option("void", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  3029. options.insert(option.display, option);
  3030. }
  3031. [[fallthrough]];
  3032. case GDScriptParser::COMPLETION_TYPE_NAME: {
  3033. _list_available_types(false, completion_context, options);
  3034. r_forced = true;
  3035. } break;
  3036. case GDScriptParser::COMPLETION_PROPERTY_DECLARATION_OR_TYPE: {
  3037. _list_available_types(false, completion_context, options);
  3038. ScriptLanguage::CodeCompletionOption get("get", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  3039. options.insert(get.display, get);
  3040. ScriptLanguage::CodeCompletionOption set("set", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  3041. options.insert(set.display, set);
  3042. r_forced = true;
  3043. } break;
  3044. case GDScriptParser::COMPLETION_PROPERTY_DECLARATION: {
  3045. ScriptLanguage::CodeCompletionOption get("get", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  3046. options.insert(get.display, get);
  3047. ScriptLanguage::CodeCompletionOption set("set", ScriptLanguage::CODE_COMPLETION_KIND_PLAIN_TEXT);
  3048. options.insert(set.display, set);
  3049. r_forced = true;
  3050. } break;
  3051. case GDScriptParser::COMPLETION_PROPERTY_METHOD: {
  3052. if (!completion_context.current_class) {
  3053. break;
  3054. }
  3055. for (int i = 0; i < completion_context.current_class->members.size(); i++) {
  3056. const GDScriptParser::ClassNode::Member &member = completion_context.current_class->members[i];
  3057. if (member.type != GDScriptParser::ClassNode::Member::FUNCTION) {
  3058. continue;
  3059. }
  3060. if (member.function->is_static) {
  3061. continue;
  3062. }
  3063. ScriptLanguage::CodeCompletionOption option(member.function->identifier->name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  3064. options.insert(option.display, option);
  3065. }
  3066. r_forced = true;
  3067. } break;
  3068. case GDScriptParser::COMPLETION_ASSIGN: {
  3069. GDScriptCompletionIdentifier type;
  3070. if (!completion_context.node || completion_context.node->type != GDScriptParser::Node::ASSIGNMENT) {
  3071. break;
  3072. }
  3073. if (!_guess_expression_type(completion_context, static_cast<const GDScriptParser::AssignmentNode *>(completion_context.node)->assignee, type)) {
  3074. _find_identifiers(completion_context, false, true, options, 0);
  3075. r_forced = true;
  3076. break;
  3077. }
  3078. if (!type.enumeration.is_empty()) {
  3079. _find_enumeration_candidates(completion_context, type.enumeration, options);
  3080. r_forced = options.size() > 0;
  3081. } else {
  3082. _find_identifiers(completion_context, false, true, options, 0);
  3083. r_forced = true;
  3084. }
  3085. } break;
  3086. case GDScriptParser::COMPLETION_METHOD:
  3087. is_function = true;
  3088. [[fallthrough]];
  3089. case GDScriptParser::COMPLETION_IDENTIFIER: {
  3090. _find_identifiers(completion_context, is_function, !_guess_expecting_callable(completion_context), options, 0);
  3091. } break;
  3092. case GDScriptParser::COMPLETION_ATTRIBUTE_METHOD:
  3093. is_function = true;
  3094. [[fallthrough]];
  3095. case GDScriptParser::COMPLETION_ATTRIBUTE: {
  3096. r_forced = true;
  3097. const GDScriptParser::SubscriptNode *attr = static_cast<const GDScriptParser::SubscriptNode *>(completion_context.node);
  3098. if (attr->base) {
  3099. GDScriptCompletionIdentifier base;
  3100. bool found_type = _get_subscript_type(completion_context, attr, base.type);
  3101. if (!found_type && !_guess_expression_type(completion_context, attr->base, base)) {
  3102. break;
  3103. }
  3104. _find_identifiers_in_base(base, is_function, false, !_guess_expecting_callable(completion_context), options, 0);
  3105. }
  3106. } break;
  3107. case GDScriptParser::COMPLETION_SUBSCRIPT: {
  3108. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(completion_context.node);
  3109. GDScriptCompletionIdentifier base;
  3110. const bool res = _guess_expression_type(completion_context, subscript->base, base);
  3111. // If the type is not known, we assume it is BUILTIN, since indices on arrays is the most common use case.
  3112. if (!subscript->is_attribute && (!res || base.type.kind == GDScriptParser::DataType::BUILTIN || base.type.is_variant())) {
  3113. if (base.value.get_type() == Variant::DICTIONARY) {
  3114. List<PropertyInfo> members;
  3115. base.value.get_property_list(&members);
  3116. for (const PropertyInfo &E : members) {
  3117. ScriptLanguage::CodeCompletionOption option(E.name.quote(quote_style), ScriptLanguage::CODE_COMPLETION_KIND_MEMBER, ScriptLanguage::LOCATION_LOCAL);
  3118. options.insert(option.display, option);
  3119. }
  3120. }
  3121. if (!subscript->index || subscript->index->type != GDScriptParser::Node::LITERAL) {
  3122. _find_identifiers(completion_context, false, !_guess_expecting_callable(completion_context), options, 0);
  3123. }
  3124. } else if (res) {
  3125. if (!subscript->is_attribute) {
  3126. // Quote the options if they are not accessed as attribute.
  3127. HashMap<String, ScriptLanguage::CodeCompletionOption> opt;
  3128. _find_identifiers_in_base(base, false, false, false, opt, 0);
  3129. for (const KeyValue<String, CodeCompletionOption> &E : opt) {
  3130. ScriptLanguage::CodeCompletionOption option(E.value.insert_text.quote(quote_style), E.value.kind, E.value.location);
  3131. options.insert(option.display, option);
  3132. }
  3133. } else {
  3134. _find_identifiers_in_base(base, false, false, !_guess_expecting_callable(completion_context), options, 0);
  3135. }
  3136. }
  3137. } break;
  3138. case GDScriptParser::COMPLETION_TYPE_ATTRIBUTE: {
  3139. if (!completion_context.current_class) {
  3140. break;
  3141. }
  3142. const GDScriptParser::TypeNode *type = static_cast<const GDScriptParser::TypeNode *>(completion_context.node);
  3143. bool found = true;
  3144. GDScriptCompletionIdentifier base;
  3145. base.type.kind = GDScriptParser::DataType::CLASS;
  3146. base.type.type_source = GDScriptParser::DataType::INFERRED;
  3147. base.type.is_constant = true;
  3148. if (completion_context.current_argument == 1) {
  3149. StringName type_name = type->type_chain[0]->name;
  3150. if (ClassDB::class_exists(type_name)) {
  3151. base.type.kind = GDScriptParser::DataType::NATIVE;
  3152. base.type.native_type = type_name;
  3153. } else if (ScriptServer::is_global_class(type_name)) {
  3154. base.type.kind = GDScriptParser::DataType::SCRIPT;
  3155. String scr_path = ScriptServer::get_global_class_path(type_name);
  3156. base.type.script_type = ResourceLoader::load(scr_path);
  3157. }
  3158. }
  3159. if (base.type.kind == GDScriptParser::DataType::CLASS) {
  3160. base.type.class_type = completion_context.current_class;
  3161. base.value = completion_context.base;
  3162. for (int i = 0; i < completion_context.current_argument; i++) {
  3163. GDScriptCompletionIdentifier ci;
  3164. if (!_guess_identifier_type_from_base(completion_context, base, type->type_chain[i]->name, ci)) {
  3165. found = false;
  3166. break;
  3167. }
  3168. base = ci;
  3169. }
  3170. }
  3171. if (found) {
  3172. _find_identifiers_in_base(base, false, true, true, options, 0);
  3173. }
  3174. r_forced = true;
  3175. } break;
  3176. case GDScriptParser::COMPLETION_RESOURCE_PATH: {
  3177. if (EDITOR_GET("text_editor/completion/complete_file_paths")) {
  3178. _get_directory_contents(EditorFileSystem::get_singleton()->get_filesystem(), options);
  3179. r_forced = true;
  3180. }
  3181. } break;
  3182. case GDScriptParser::COMPLETION_CALL_ARGUMENTS: {
  3183. if (!completion_context.node) {
  3184. break;
  3185. }
  3186. _find_call_arguments(completion_context, completion_context.node, completion_context.current_argument, options, r_forced, r_call_hint);
  3187. } break;
  3188. case GDScriptParser::COMPLETION_OVERRIDE_METHOD: {
  3189. GDScriptParser::DataType native_type = completion_context.current_class->base_type;
  3190. GDScriptParser::FunctionNode *function_node = static_cast<GDScriptParser::FunctionNode *>(completion_context.node);
  3191. bool is_static = function_node != nullptr && function_node->is_static;
  3192. while (native_type.is_set() && native_type.kind != GDScriptParser::DataType::NATIVE) {
  3193. switch (native_type.kind) {
  3194. case GDScriptParser::DataType::CLASS: {
  3195. for (const GDScriptParser::ClassNode::Member &member : native_type.class_type->members) {
  3196. if (member.type != GDScriptParser::ClassNode::Member::FUNCTION) {
  3197. continue;
  3198. }
  3199. if (options.has(member.function->identifier->name)) {
  3200. continue;
  3201. }
  3202. if (completion_context.current_class->has_function(member.get_name()) && completion_context.current_class->get_member(member.get_name()).function != function_node) {
  3203. continue;
  3204. }
  3205. if (is_static != member.function->is_static) {
  3206. continue;
  3207. }
  3208. String display_name = member.function->identifier->name;
  3209. display_name += member.function->signature + ":";
  3210. ScriptLanguage::CodeCompletionOption option(display_name, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  3211. options.insert(member.function->identifier->name, option); // Insert name instead of display to track duplicates.
  3212. }
  3213. native_type = native_type.class_type->base_type;
  3214. } break;
  3215. default: {
  3216. native_type.kind = GDScriptParser::DataType::UNRESOLVED;
  3217. } break;
  3218. }
  3219. }
  3220. if (!native_type.is_set()) {
  3221. break;
  3222. }
  3223. StringName class_name = native_type.native_type;
  3224. if (!ClassDB::class_exists(class_name)) {
  3225. break;
  3226. }
  3227. const bool type_hints = EditorSettings::get_singleton()->get_setting("text_editor/completion/add_type_hints");
  3228. List<MethodInfo> virtual_methods;
  3229. if (is_static) {
  3230. // Not truly a virtual method, but can also be "overridden".
  3231. MethodInfo static_init("_static_init");
  3232. static_init.return_val.type = Variant::NIL;
  3233. static_init.flags |= METHOD_FLAG_STATIC | METHOD_FLAG_VIRTUAL;
  3234. virtual_methods.push_back(static_init);
  3235. } else {
  3236. ClassDB::get_virtual_methods(class_name, &virtual_methods);
  3237. }
  3238. for (const MethodInfo &mi : virtual_methods) {
  3239. if (options.has(mi.name)) {
  3240. continue;
  3241. }
  3242. if (completion_context.current_class->has_function(mi.name) && completion_context.current_class->get_member(mi.name).function != function_node) {
  3243. continue;
  3244. }
  3245. String method_hint = mi.name;
  3246. if (method_hint.contains_char(':')) {
  3247. method_hint = method_hint.get_slicec(':', 0);
  3248. }
  3249. method_hint += "(";
  3250. for (int64_t i = 0; i < mi.arguments.size(); ++i) {
  3251. if (i > 0) {
  3252. method_hint += ", ";
  3253. }
  3254. String arg = mi.arguments[i].name;
  3255. if (arg.contains_char(':')) {
  3256. arg = arg.substr(0, arg.find_char(':'));
  3257. }
  3258. method_hint += arg;
  3259. if (type_hints) {
  3260. method_hint += ": " + _get_visual_datatype(mi.arguments[i], true, class_name);
  3261. }
  3262. }
  3263. if (mi.flags & METHOD_FLAG_VARARG) {
  3264. if (!mi.arguments.is_empty()) {
  3265. method_hint += ", ";
  3266. }
  3267. method_hint += "...args"; // `MethodInfo` does not support the rest parameter name.
  3268. if (type_hints) {
  3269. method_hint += ": Array";
  3270. }
  3271. }
  3272. method_hint += ")";
  3273. if (type_hints) {
  3274. method_hint += " -> " + _get_visual_datatype(mi.return_val, false, class_name);
  3275. }
  3276. method_hint += ":";
  3277. ScriptLanguage::CodeCompletionOption option(method_hint, ScriptLanguage::CODE_COMPLETION_KIND_FUNCTION);
  3278. options.insert(option.display, option);
  3279. }
  3280. } break;
  3281. case GDScriptParser::COMPLETION_GET_NODE: {
  3282. // Handles the `$Node/Path` or `$"Some NodePath"` syntax specifically.
  3283. if (p_owner) {
  3284. List<String> opts;
  3285. p_owner->get_argument_options("get_node", 0, &opts);
  3286. bool for_unique_name = false;
  3287. if (completion_context.node != nullptr && completion_context.node->type == GDScriptParser::Node::GET_NODE && !static_cast<GDScriptParser::GetNodeNode *>(completion_context.node)->use_dollar) {
  3288. for_unique_name = true;
  3289. }
  3290. for (const String &E : opts) {
  3291. r_forced = true;
  3292. String opt = E.strip_edges();
  3293. if (opt.is_quoted()) {
  3294. // Remove quotes so that we can handle user preferred quote style,
  3295. // or handle NodePaths which are valid identifiers and don't need quotes.
  3296. opt = opt.unquote();
  3297. }
  3298. if (for_unique_name) {
  3299. if (!opt.begins_with("%")) {
  3300. continue;
  3301. }
  3302. opt = opt.substr(1);
  3303. }
  3304. // The path needs quotes if at least one of its components (excluding `%` prefix and `/` separations)
  3305. // is not a valid identifier.
  3306. bool path_needs_quote = false;
  3307. for (const String &part : opt.trim_prefix("%").split("/")) {
  3308. if (!part.is_valid_ascii_identifier()) {
  3309. path_needs_quote = true;
  3310. break;
  3311. }
  3312. }
  3313. if (path_needs_quote) {
  3314. // Ignore quote_style and just use double quotes for paths with apostrophes.
  3315. // Double quotes don't need to be checked because they're not valid in node and property names.
  3316. opt = opt.quote(opt.contains_char('\'') ? "\"" : quote_style); // Handle user preference.
  3317. }
  3318. ScriptLanguage::CodeCompletionOption option(opt, ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH);
  3319. options.insert(option.display, option);
  3320. }
  3321. if (!for_unique_name) {
  3322. // Get autoloads.
  3323. for (const KeyValue<StringName, ProjectSettings::AutoloadInfo> &E : ProjectSettings::get_singleton()->get_autoload_list()) {
  3324. String path = "/root/" + E.key;
  3325. ScriptLanguage::CodeCompletionOption option(path.quote(quote_style), ScriptLanguage::CODE_COMPLETION_KIND_NODE_PATH);
  3326. options.insert(option.display, option);
  3327. }
  3328. }
  3329. }
  3330. } break;
  3331. case GDScriptParser::COMPLETION_SUPER_METHOD: {
  3332. if (!completion_context.current_class) {
  3333. break;
  3334. }
  3335. _find_identifiers_in_class(completion_context.current_class, true, false, false, true, !_guess_expecting_callable(completion_context), options, 0);
  3336. } break;
  3337. }
  3338. for (const KeyValue<String, ScriptLanguage::CodeCompletionOption> &E : options) {
  3339. r_options->push_back(E.value);
  3340. }
  3341. return OK;
  3342. }
  3343. #else // !TOOLS_ENABLED
  3344. Error GDScriptLanguage::complete_code(const String &p_code, const String &p_path, Object *p_owner, List<ScriptLanguage::CodeCompletionOption> *r_options, bool &r_forced, String &r_call_hint) {
  3345. return OK;
  3346. }
  3347. #endif // TOOLS_ENABLED
  3348. //////// END COMPLETION //////////
  3349. String GDScriptLanguage::_get_indentation() const {
  3350. #ifdef TOOLS_ENABLED
  3351. if (Engine::get_singleton()->is_editor_hint()) {
  3352. bool use_space_indentation = EDITOR_GET("text_editor/behavior/indent/type");
  3353. if (use_space_indentation) {
  3354. int indent_size = EDITOR_GET("text_editor/behavior/indent/size");
  3355. return String(" ").repeat(indent_size);
  3356. }
  3357. }
  3358. #endif
  3359. return "\t";
  3360. }
  3361. void GDScriptLanguage::auto_indent_code(String &p_code, int p_from_line, int p_to_line) const {
  3362. String indent = _get_indentation();
  3363. Vector<String> lines = p_code.split("\n");
  3364. List<int> indent_stack;
  3365. for (int i = 0; i < lines.size(); i++) {
  3366. String l = lines[i];
  3367. int tc = 0;
  3368. for (int j = 0; j < l.length(); j++) {
  3369. if (l[j] == ' ' || l[j] == '\t') {
  3370. tc++;
  3371. } else {
  3372. break;
  3373. }
  3374. }
  3375. String st = l.substr(tc).strip_edges();
  3376. if (st.is_empty() || st.begins_with("#")) {
  3377. continue; //ignore!
  3378. }
  3379. int ilevel = 0;
  3380. if (indent_stack.size()) {
  3381. ilevel = indent_stack.back()->get();
  3382. }
  3383. if (tc > ilevel) {
  3384. indent_stack.push_back(tc);
  3385. } else if (tc < ilevel) {
  3386. while (indent_stack.size() && indent_stack.back()->get() > tc) {
  3387. indent_stack.pop_back();
  3388. }
  3389. if (indent_stack.size() && indent_stack.back()->get() != tc) {
  3390. indent_stack.push_back(tc); // this is not right but gets the job done
  3391. }
  3392. }
  3393. if (i >= p_from_line) {
  3394. l = indent.repeat(indent_stack.size()) + st;
  3395. } else if (i > p_to_line) {
  3396. break;
  3397. }
  3398. lines.write[i] = l;
  3399. }
  3400. p_code = "";
  3401. for (int i = 0; i < lines.size(); i++) {
  3402. if (i > 0) {
  3403. p_code += "\n";
  3404. }
  3405. p_code += lines[i];
  3406. }
  3407. }
  3408. #ifdef TOOLS_ENABLED
  3409. static Error _lookup_symbol_from_base(const GDScriptParser::DataType &p_base, const String &p_symbol, GDScriptLanguage::LookupResult &r_result) {
  3410. GDScriptParser::DataType base_type = p_base;
  3411. while (true) {
  3412. switch (base_type.kind) {
  3413. case GDScriptParser::DataType::CLASS: {
  3414. ERR_FAIL_NULL_V(base_type.class_type, ERR_BUG);
  3415. String name = p_symbol;
  3416. if (name == "new") {
  3417. name = "_init";
  3418. }
  3419. if (!base_type.class_type->has_member(name)) {
  3420. base_type = base_type.class_type->base_type;
  3421. break;
  3422. }
  3423. const GDScriptParser::ClassNode::Member &member = base_type.class_type->get_member(name);
  3424. switch (member.type) {
  3425. case GDScriptParser::ClassNode::Member::UNDEFINED:
  3426. case GDScriptParser::ClassNode::Member::GROUP:
  3427. return ERR_BUG;
  3428. case GDScriptParser::ClassNode::Member::CLASS: {
  3429. String doc_type_name;
  3430. String doc_enum_name;
  3431. GDScriptDocGen::doctype_from_gdtype(GDScriptAnalyzer::type_from_metatype(member.get_datatype()), doc_type_name, doc_enum_name);
  3432. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3433. r_result.class_name = doc_type_name;
  3434. } break;
  3435. case GDScriptParser::ClassNode::Member::CONSTANT:
  3436. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3437. break;
  3438. case GDScriptParser::ClassNode::Member::FUNCTION:
  3439. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3440. break;
  3441. case GDScriptParser::ClassNode::Member::SIGNAL:
  3442. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_SIGNAL;
  3443. break;
  3444. case GDScriptParser::ClassNode::Member::VARIABLE:
  3445. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_PROPERTY;
  3446. break;
  3447. case GDScriptParser::ClassNode::Member::ENUM:
  3448. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3449. break;
  3450. case GDScriptParser::ClassNode::Member::ENUM_VALUE:
  3451. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3452. break;
  3453. }
  3454. if (member.type != GDScriptParser::ClassNode::Member::CLASS) {
  3455. String doc_type_name;
  3456. String doc_enum_name;
  3457. GDScriptDocGen::doctype_from_gdtype(GDScriptAnalyzer::type_from_metatype(base_type), doc_type_name, doc_enum_name);
  3458. r_result.class_name = doc_type_name;
  3459. r_result.class_member = name;
  3460. }
  3461. Error err = OK;
  3462. r_result.script = GDScriptCache::get_shallow_script(base_type.script_path, err);
  3463. r_result.script_path = base_type.script_path;
  3464. r_result.location = member.get_line();
  3465. return err;
  3466. } break;
  3467. case GDScriptParser::DataType::SCRIPT: {
  3468. const Ref<Script> scr = base_type.script_type;
  3469. if (scr.is_null()) {
  3470. return ERR_CANT_RESOLVE;
  3471. }
  3472. String name = p_symbol;
  3473. if (name == "new") {
  3474. name = "_init";
  3475. }
  3476. const int line = scr->get_member_line(name);
  3477. if (line >= 0) {
  3478. bool found_type = false;
  3479. r_result.type = ScriptLanguage::LOOKUP_RESULT_SCRIPT_LOCATION;
  3480. {
  3481. List<PropertyInfo> properties;
  3482. scr->get_script_property_list(&properties);
  3483. for (const PropertyInfo &property : properties) {
  3484. if (property.name == name && (property.usage & PROPERTY_USAGE_SCRIPT_VARIABLE)) {
  3485. found_type = true;
  3486. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_PROPERTY;
  3487. r_result.class_name = scr->get_doc_class_name();
  3488. r_result.class_member = name;
  3489. break;
  3490. }
  3491. }
  3492. }
  3493. if (!found_type) {
  3494. List<MethodInfo> methods;
  3495. scr->get_script_method_list(&methods);
  3496. for (const MethodInfo &method : methods) {
  3497. if (method.name == name) {
  3498. found_type = true;
  3499. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3500. r_result.class_name = scr->get_doc_class_name();
  3501. r_result.class_member = name;
  3502. break;
  3503. }
  3504. }
  3505. }
  3506. if (!found_type) {
  3507. List<MethodInfo> signals;
  3508. scr->get_script_method_list(&signals);
  3509. for (const MethodInfo &signal : signals) {
  3510. if (signal.name == name) {
  3511. found_type = true;
  3512. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_SIGNAL;
  3513. r_result.class_name = scr->get_doc_class_name();
  3514. r_result.class_member = name;
  3515. break;
  3516. }
  3517. }
  3518. }
  3519. if (!found_type) {
  3520. const Ref<GDScript> gds = scr;
  3521. if (gds.is_valid()) {
  3522. const Ref<GDScript> *subclass = gds->get_subclasses().getptr(name);
  3523. if (subclass != nullptr) {
  3524. found_type = true;
  3525. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3526. r_result.class_name = subclass->ptr()->get_doc_class_name();
  3527. }
  3528. // TODO: enums.
  3529. }
  3530. }
  3531. if (!found_type) {
  3532. HashMap<StringName, Variant> constants;
  3533. scr->get_constants(&constants);
  3534. if (constants.has(name)) {
  3535. found_type = true;
  3536. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3537. r_result.class_name = scr->get_doc_class_name();
  3538. r_result.class_member = name;
  3539. }
  3540. }
  3541. r_result.script = scr;
  3542. r_result.script_path = base_type.script_path;
  3543. r_result.location = line;
  3544. return OK;
  3545. }
  3546. const Ref<Script> base_script = scr->get_base_script();
  3547. if (base_script.is_valid()) {
  3548. base_type.script_type = base_script;
  3549. } else {
  3550. base_type.kind = GDScriptParser::DataType::NATIVE;
  3551. base_type.builtin_type = Variant::OBJECT;
  3552. base_type.native_type = scr->get_instance_base_type();
  3553. }
  3554. } break;
  3555. case GDScriptParser::DataType::NATIVE: {
  3556. const StringName &class_name = base_type.native_type;
  3557. ERR_FAIL_COND_V(!ClassDB::class_exists(class_name), ERR_BUG);
  3558. if (ClassDB::has_method(class_name, p_symbol, true)) {
  3559. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3560. r_result.class_name = class_name;
  3561. r_result.class_member = p_symbol;
  3562. return OK;
  3563. }
  3564. List<MethodInfo> virtual_methods;
  3565. ClassDB::get_virtual_methods(class_name, &virtual_methods, true);
  3566. for (const MethodInfo &E : virtual_methods) {
  3567. if (E.name == p_symbol) {
  3568. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3569. r_result.class_name = class_name;
  3570. r_result.class_member = p_symbol;
  3571. return OK;
  3572. }
  3573. }
  3574. if (ClassDB::has_signal(class_name, p_symbol, true)) {
  3575. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_SIGNAL;
  3576. r_result.class_name = class_name;
  3577. r_result.class_member = p_symbol;
  3578. return OK;
  3579. }
  3580. List<StringName> enums;
  3581. ClassDB::get_enum_list(class_name, &enums);
  3582. for (const StringName &E : enums) {
  3583. if (E == p_symbol) {
  3584. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3585. r_result.class_name = class_name;
  3586. r_result.class_member = p_symbol;
  3587. return OK;
  3588. }
  3589. }
  3590. if (!String(ClassDB::get_integer_constant_enum(class_name, p_symbol, true)).is_empty()) {
  3591. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3592. r_result.class_name = class_name;
  3593. r_result.class_member = p_symbol;
  3594. return OK;
  3595. }
  3596. List<String> constants;
  3597. ClassDB::get_integer_constant_list(class_name, &constants, true);
  3598. for (const String &E : constants) {
  3599. if (E == p_symbol) {
  3600. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3601. r_result.class_name = class_name;
  3602. r_result.class_member = p_symbol;
  3603. return OK;
  3604. }
  3605. }
  3606. if (ClassDB::has_property(class_name, p_symbol, true)) {
  3607. PropertyInfo prop_info;
  3608. ClassDB::get_property_info(class_name, p_symbol, &prop_info, true);
  3609. if (prop_info.usage & PROPERTY_USAGE_INTERNAL) {
  3610. return ERR_CANT_RESOLVE;
  3611. }
  3612. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_PROPERTY;
  3613. r_result.class_name = class_name;
  3614. r_result.class_member = p_symbol;
  3615. return OK;
  3616. }
  3617. const StringName parent_class = ClassDB::get_parent_class(class_name);
  3618. if (parent_class != StringName()) {
  3619. base_type.native_type = parent_class;
  3620. } else {
  3621. return ERR_CANT_RESOLVE;
  3622. }
  3623. } break;
  3624. case GDScriptParser::DataType::BUILTIN: {
  3625. if (base_type.is_meta_type) {
  3626. if (Variant::has_enum(base_type.builtin_type, p_symbol)) {
  3627. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3628. r_result.class_name = Variant::get_type_name(base_type.builtin_type);
  3629. r_result.class_member = p_symbol;
  3630. return OK;
  3631. }
  3632. if (Variant::has_constant(base_type.builtin_type, p_symbol)) {
  3633. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3634. r_result.class_name = Variant::get_type_name(base_type.builtin_type);
  3635. r_result.class_member = p_symbol;
  3636. return OK;
  3637. }
  3638. } else {
  3639. if (Variant::has_member(base_type.builtin_type, p_symbol)) {
  3640. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_PROPERTY;
  3641. r_result.class_name = Variant::get_type_name(base_type.builtin_type);
  3642. r_result.class_member = p_symbol;
  3643. return OK;
  3644. }
  3645. }
  3646. if (Variant::has_builtin_method(base_type.builtin_type, p_symbol)) {
  3647. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3648. r_result.class_name = Variant::get_type_name(base_type.builtin_type);
  3649. r_result.class_member = p_symbol;
  3650. return OK;
  3651. }
  3652. return ERR_CANT_RESOLVE;
  3653. } break;
  3654. case GDScriptParser::DataType::ENUM: {
  3655. if (base_type.is_meta_type) {
  3656. if (base_type.enum_values.has(p_symbol)) {
  3657. String doc_type_name;
  3658. String doc_enum_name;
  3659. GDScriptDocGen::doctype_from_gdtype(GDScriptAnalyzer::type_from_metatype(base_type), doc_type_name, doc_enum_name);
  3660. if (CoreConstants::is_global_enum(doc_enum_name)) {
  3661. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3662. r_result.class_name = "@GlobalScope";
  3663. r_result.class_member = p_symbol;
  3664. return OK;
  3665. } else {
  3666. const int dot_pos = doc_enum_name.rfind_char('.');
  3667. if (dot_pos >= 0) {
  3668. Error err = OK;
  3669. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3670. if (base_type.class_type != nullptr) {
  3671. // For script enums the value isn't accessible as class constant so we need the full enum name.
  3672. r_result.class_name = doc_enum_name;
  3673. r_result.class_member = p_symbol;
  3674. r_result.script = GDScriptCache::get_shallow_script(base_type.script_path, err);
  3675. r_result.script_path = base_type.script_path;
  3676. const String enum_name = doc_enum_name.substr(dot_pos + 1);
  3677. if (base_type.class_type->has_member(enum_name)) {
  3678. const GDScriptParser::ClassNode::Member member = base_type.class_type->get_member(enum_name);
  3679. if (member.type == GDScriptParser::ClassNode::Member::ENUM) {
  3680. for (const GDScriptParser::EnumNode::Value &value : member.m_enum->values) {
  3681. if (value.identifier->name == p_symbol) {
  3682. r_result.location = value.line;
  3683. break;
  3684. }
  3685. }
  3686. }
  3687. }
  3688. } else if (base_type.script_type.is_valid()) {
  3689. // For script enums the value isn't accessible as class constant so we need the full enum name.
  3690. r_result.class_name = doc_enum_name;
  3691. r_result.class_member = p_symbol;
  3692. r_result.script = base_type.script_type;
  3693. r_result.script_path = base_type.script_path;
  3694. // TODO: Find a way to obtain enum value location for a script
  3695. r_result.location = base_type.script_type->get_member_line(doc_enum_name.substr(dot_pos + 1));
  3696. } else {
  3697. r_result.class_name = doc_enum_name.left(dot_pos);
  3698. r_result.class_member = p_symbol;
  3699. }
  3700. return err;
  3701. }
  3702. }
  3703. } else if (Variant::has_builtin_method(Variant::DICTIONARY, p_symbol)) {
  3704. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3705. r_result.class_name = "Dictionary";
  3706. r_result.class_member = p_symbol;
  3707. return OK;
  3708. }
  3709. }
  3710. return ERR_CANT_RESOLVE;
  3711. } break;
  3712. case GDScriptParser::DataType::VARIANT: {
  3713. if (base_type.is_meta_type) {
  3714. const String enum_name = "Variant." + p_symbol;
  3715. if (CoreConstants::is_global_enum(enum_name)) {
  3716. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3717. r_result.class_name = "@GlobalScope";
  3718. r_result.class_member = enum_name;
  3719. return OK;
  3720. }
  3721. }
  3722. return ERR_CANT_RESOLVE;
  3723. } break;
  3724. case GDScriptParser::DataType::RESOLVING:
  3725. case GDScriptParser::DataType::UNRESOLVED: {
  3726. return ERR_CANT_RESOLVE;
  3727. } break;
  3728. }
  3729. }
  3730. return ERR_CANT_RESOLVE;
  3731. }
  3732. ::Error GDScriptLanguage::lookup_code(const String &p_code, const String &p_symbol, const String &p_path, Object *p_owner, LookupResult &r_result) {
  3733. // Before parsing, try the usual stuff.
  3734. if (ClassDB::class_exists(p_symbol)) {
  3735. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3736. r_result.class_name = p_symbol;
  3737. return OK;
  3738. }
  3739. if (Variant::get_type_by_name(p_symbol) < Variant::VARIANT_MAX) {
  3740. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3741. r_result.class_name = p_symbol;
  3742. return OK;
  3743. }
  3744. if (p_symbol == "Variant") {
  3745. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3746. r_result.class_name = "Variant";
  3747. return OK;
  3748. }
  3749. if (p_symbol == "PI" || p_symbol == "TAU" || p_symbol == "INF" || p_symbol == "NAN") {
  3750. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3751. r_result.class_name = "@GDScript";
  3752. r_result.class_member = p_symbol;
  3753. return OK;
  3754. }
  3755. GDScriptParser parser;
  3756. parser.parse(p_code, p_path, true);
  3757. GDScriptParser::CompletionContext context = parser.get_completion_context();
  3758. context.base = p_owner;
  3759. // Allows class functions with the names like built-ins to be handled properly.
  3760. if (context.type != GDScriptParser::COMPLETION_ATTRIBUTE) {
  3761. // Need special checks for `assert` and `preload` as they are technically
  3762. // keywords, so are not registered in `GDScriptUtilityFunctions`.
  3763. if (GDScriptUtilityFunctions::function_exists(p_symbol) || p_symbol == "assert" || p_symbol == "preload") {
  3764. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3765. r_result.class_name = "@GDScript";
  3766. r_result.class_member = p_symbol;
  3767. return OK;
  3768. }
  3769. }
  3770. GDScriptAnalyzer analyzer(&parser);
  3771. analyzer.analyze();
  3772. if (context.current_class && context.current_class->extends.size() > 0) {
  3773. StringName class_name = context.current_class->extends[0]->name;
  3774. bool success = false;
  3775. ClassDB::get_integer_constant(class_name, p_symbol, &success);
  3776. if (success) {
  3777. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3778. r_result.class_name = class_name;
  3779. r_result.class_member = p_symbol;
  3780. return OK;
  3781. }
  3782. do {
  3783. List<StringName> enums;
  3784. ClassDB::get_enum_list(class_name, &enums, true);
  3785. for (const StringName &enum_name : enums) {
  3786. if (enum_name == p_symbol) {
  3787. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3788. r_result.class_name = class_name;
  3789. r_result.class_member = p_symbol;
  3790. return OK;
  3791. }
  3792. }
  3793. class_name = ClassDB::get_parent_class_nocheck(class_name);
  3794. } while (class_name != StringName());
  3795. }
  3796. const GDScriptParser::TypeNode *type_node = dynamic_cast<const GDScriptParser::TypeNode *>(context.node);
  3797. if (type_node != nullptr && !type_node->type_chain.is_empty()) {
  3798. StringName class_name = type_node->type_chain[0]->name;
  3799. if (ScriptServer::is_global_class(class_name)) {
  3800. class_name = ScriptServer::get_global_class_native_base(class_name);
  3801. }
  3802. do {
  3803. List<StringName> enums;
  3804. ClassDB::get_enum_list(class_name, &enums, true);
  3805. for (const StringName &enum_name : enums) {
  3806. if (enum_name == p_symbol) {
  3807. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3808. r_result.class_name = class_name;
  3809. r_result.class_member = p_symbol;
  3810. return OK;
  3811. }
  3812. }
  3813. class_name = ClassDB::get_parent_class_nocheck(class_name);
  3814. } while (class_name != StringName());
  3815. }
  3816. bool is_function = false;
  3817. switch (context.type) {
  3818. case GDScriptParser::COMPLETION_BUILT_IN_TYPE_CONSTANT_OR_STATIC_METHOD: {
  3819. GDScriptParser::DataType base_type;
  3820. base_type.kind = GDScriptParser::DataType::BUILTIN;
  3821. base_type.builtin_type = context.builtin_type;
  3822. base_type.is_meta_type = true;
  3823. if (_lookup_symbol_from_base(base_type, p_symbol, r_result) == OK) {
  3824. return OK;
  3825. }
  3826. } break;
  3827. case GDScriptParser::COMPLETION_SUPER_METHOD:
  3828. case GDScriptParser::COMPLETION_METHOD:
  3829. case GDScriptParser::COMPLETION_ASSIGN:
  3830. case GDScriptParser::COMPLETION_CALL_ARGUMENTS:
  3831. case GDScriptParser::COMPLETION_IDENTIFIER:
  3832. case GDScriptParser::COMPLETION_PROPERTY_METHOD:
  3833. case GDScriptParser::COMPLETION_SUBSCRIPT: {
  3834. GDScriptParser::DataType base_type;
  3835. if (context.current_class) {
  3836. if (context.type != GDScriptParser::COMPLETION_SUPER_METHOD) {
  3837. base_type = context.current_class->get_datatype();
  3838. } else {
  3839. base_type = context.current_class->base_type;
  3840. }
  3841. } else {
  3842. break;
  3843. }
  3844. if (!is_function && context.current_suite) {
  3845. // Lookup local variables.
  3846. const GDScriptParser::SuiteNode *suite = context.current_suite;
  3847. while (suite) {
  3848. if (suite->has_local(p_symbol)) {
  3849. const GDScriptParser::SuiteNode::Local &local = suite->get_local(p_symbol);
  3850. switch (local.type) {
  3851. case GDScriptParser::SuiteNode::Local::UNDEFINED:
  3852. return ERR_BUG;
  3853. case GDScriptParser::SuiteNode::Local::CONSTANT:
  3854. r_result.type = ScriptLanguage::LOOKUP_RESULT_LOCAL_CONSTANT;
  3855. r_result.description = local.constant->doc_data.description;
  3856. r_result.is_deprecated = local.constant->doc_data.is_deprecated;
  3857. r_result.deprecated_message = local.constant->doc_data.deprecated_message;
  3858. r_result.is_experimental = local.constant->doc_data.is_experimental;
  3859. r_result.experimental_message = local.constant->doc_data.experimental_message;
  3860. if (local.constant->initializer != nullptr) {
  3861. r_result.value = GDScriptDocGen::docvalue_from_expression(local.constant->initializer);
  3862. }
  3863. break;
  3864. case GDScriptParser::SuiteNode::Local::VARIABLE:
  3865. r_result.type = ScriptLanguage::LOOKUP_RESULT_LOCAL_VARIABLE;
  3866. r_result.description = local.variable->doc_data.description;
  3867. r_result.is_deprecated = local.variable->doc_data.is_deprecated;
  3868. r_result.deprecated_message = local.variable->doc_data.deprecated_message;
  3869. r_result.is_experimental = local.variable->doc_data.is_experimental;
  3870. r_result.experimental_message = local.variable->doc_data.experimental_message;
  3871. if (local.variable->initializer != nullptr) {
  3872. r_result.value = GDScriptDocGen::docvalue_from_expression(local.variable->initializer);
  3873. }
  3874. break;
  3875. case GDScriptParser::SuiteNode::Local::PARAMETER:
  3876. case GDScriptParser::SuiteNode::Local::FOR_VARIABLE:
  3877. case GDScriptParser::SuiteNode::Local::PATTERN_BIND:
  3878. r_result.type = ScriptLanguage::LOOKUP_RESULT_LOCAL_VARIABLE;
  3879. break;
  3880. }
  3881. GDScriptDocGen::doctype_from_gdtype(local.get_datatype(), r_result.doc_type, r_result.enumeration);
  3882. Error err = OK;
  3883. r_result.script = GDScriptCache::get_shallow_script(base_type.script_path, err);
  3884. r_result.script_path = base_type.script_path;
  3885. r_result.location = local.start_line;
  3886. return err;
  3887. }
  3888. suite = suite->parent_block;
  3889. }
  3890. }
  3891. if (_lookup_symbol_from_base(base_type, p_symbol, r_result) == OK) {
  3892. return OK;
  3893. }
  3894. if (!is_function) {
  3895. if (ProjectSettings::get_singleton()->has_autoload(p_symbol)) {
  3896. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(p_symbol);
  3897. if (autoload.is_singleton) {
  3898. String scr_path = autoload.path;
  3899. if (!scr_path.ends_with(".gd")) {
  3900. // Not a script, try find the script anyway, may have some success.
  3901. scr_path = scr_path.get_basename() + ".gd";
  3902. }
  3903. if (FileAccess::exists(scr_path)) {
  3904. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3905. r_result.class_name = p_symbol;
  3906. r_result.script = ResourceLoader::load(scr_path);
  3907. r_result.script_path = scr_path;
  3908. r_result.location = 0;
  3909. return OK;
  3910. }
  3911. }
  3912. }
  3913. if (ScriptServer::is_global_class(p_symbol)) {
  3914. const String scr_path = ScriptServer::get_global_class_path(p_symbol);
  3915. const Ref<Script> scr = ResourceLoader::load(scr_path);
  3916. if (scr.is_null()) {
  3917. return ERR_BUG;
  3918. }
  3919. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3920. r_result.class_name = scr->get_doc_class_name();
  3921. r_result.script = scr;
  3922. r_result.script_path = scr_path;
  3923. r_result.location = 0;
  3924. return OK;
  3925. }
  3926. const HashMap<StringName, int> &global_map = GDScriptLanguage::get_singleton()->get_global_map();
  3927. if (global_map.has(p_symbol)) {
  3928. Variant value = GDScriptLanguage::get_singleton()->get_global_array()[global_map[p_symbol]];
  3929. if (value.get_type() == Variant::OBJECT) {
  3930. const Object *obj = value;
  3931. if (obj) {
  3932. if (Object::cast_to<GDScriptNativeClass>(obj)) {
  3933. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3934. r_result.class_name = Object::cast_to<GDScriptNativeClass>(obj)->get_name();
  3935. } else {
  3936. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS;
  3937. r_result.class_name = obj->get_class();
  3938. }
  3939. return OK;
  3940. }
  3941. }
  3942. }
  3943. if (CoreConstants::is_global_enum(p_symbol)) {
  3944. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ENUM;
  3945. r_result.class_name = "@GlobalScope";
  3946. r_result.class_member = p_symbol;
  3947. return OK;
  3948. }
  3949. if (CoreConstants::is_global_constant(p_symbol)) {
  3950. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_CONSTANT;
  3951. r_result.class_name = "@GlobalScope";
  3952. r_result.class_member = p_symbol;
  3953. return OK;
  3954. }
  3955. if (Variant::has_utility_function(p_symbol)) {
  3956. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_METHOD;
  3957. r_result.class_name = "@GlobalScope";
  3958. r_result.class_member = p_symbol;
  3959. return OK;
  3960. }
  3961. }
  3962. } break;
  3963. case GDScriptParser::COMPLETION_ATTRIBUTE_METHOD:
  3964. case GDScriptParser::COMPLETION_ATTRIBUTE: {
  3965. if (context.node->type != GDScriptParser::Node::SUBSCRIPT) {
  3966. break;
  3967. }
  3968. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(context.node);
  3969. if (!subscript->is_attribute) {
  3970. break;
  3971. }
  3972. GDScriptCompletionIdentifier base;
  3973. bool found_type = _get_subscript_type(context, subscript, base.type);
  3974. if (!found_type && !_guess_expression_type(context, subscript->base, base)) {
  3975. break;
  3976. }
  3977. if (_lookup_symbol_from_base(base.type, p_symbol, r_result) == OK) {
  3978. return OK;
  3979. }
  3980. } break;
  3981. case GDScriptParser::COMPLETION_TYPE_ATTRIBUTE: {
  3982. if (context.node == nullptr || context.node->type != GDScriptParser::Node::TYPE) {
  3983. break;
  3984. }
  3985. const GDScriptParser::TypeNode *type = static_cast<const GDScriptParser::TypeNode *>(context.node);
  3986. GDScriptParser::DataType base_type;
  3987. const GDScriptParser::IdentifierNode *prev = nullptr;
  3988. for (const GDScriptParser::IdentifierNode *E : type->type_chain) {
  3989. if (E->name == p_symbol && prev != nullptr) {
  3990. base_type = prev->get_datatype();
  3991. break;
  3992. }
  3993. prev = E;
  3994. }
  3995. if (base_type.kind != GDScriptParser::DataType::CLASS) {
  3996. GDScriptCompletionIdentifier base;
  3997. if (!_guess_expression_type(context, prev, base)) {
  3998. break;
  3999. }
  4000. base_type = base.type;
  4001. }
  4002. if (_lookup_symbol_from_base(base_type, p_symbol, r_result) == OK) {
  4003. return OK;
  4004. }
  4005. } break;
  4006. case GDScriptParser::COMPLETION_OVERRIDE_METHOD: {
  4007. GDScriptParser::DataType base_type = context.current_class->base_type;
  4008. if (_lookup_symbol_from_base(base_type, p_symbol, r_result) == OK) {
  4009. return OK;
  4010. }
  4011. } break;
  4012. case GDScriptParser::COMPLETION_PROPERTY_DECLARATION_OR_TYPE:
  4013. case GDScriptParser::COMPLETION_TYPE_NAME_OR_VOID:
  4014. case GDScriptParser::COMPLETION_TYPE_NAME: {
  4015. GDScriptParser::DataType base_type = context.current_class->get_datatype();
  4016. if (_lookup_symbol_from_base(base_type, p_symbol, r_result) == OK) {
  4017. return OK;
  4018. }
  4019. } break;
  4020. case GDScriptParser::COMPLETION_ANNOTATION: {
  4021. const String annotation_symbol = "@" + p_symbol;
  4022. if (parser.annotation_exists(annotation_symbol)) {
  4023. r_result.type = ScriptLanguage::LOOKUP_RESULT_CLASS_ANNOTATION;
  4024. r_result.class_name = "@GDScript";
  4025. r_result.class_member = annotation_symbol;
  4026. return OK;
  4027. }
  4028. } break;
  4029. default: {
  4030. }
  4031. }
  4032. return ERR_CANT_RESOLVE;
  4033. }
  4034. #endif // TOOLS_ENABLED