gdscript_editor.cpp 162 KB

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