gdscript_analyzer.cpp 196 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056
  1. /**************************************************************************/
  2. /* gdscript_analyzer.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_analyzer.h"
  31. #include "core/config/engine.h"
  32. #include "core/config/project_settings.h"
  33. #include "core/core_string_names.h"
  34. #include "core/io/file_access.h"
  35. #include "core/io/resource_loader.h"
  36. #include "core/object/class_db.h"
  37. #include "core/object/script_language.h"
  38. #include "core/templates/hash_map.h"
  39. #include "gdscript.h"
  40. #include "gdscript_utility_functions.h"
  41. #include "scene/resources/packed_scene.h"
  42. #if defined(TOOLS_ENABLED) && !defined(DISABLE_DEPRECATED)
  43. #define SUGGEST_GODOT4_RENAMES
  44. #include "editor/renames_map_3_to_4.h"
  45. #endif
  46. #define UNNAMED_ENUM "<anonymous enum>"
  47. #define ENUM_SEPARATOR "::"
  48. static MethodInfo info_from_utility_func(const StringName &p_function) {
  49. ERR_FAIL_COND_V(!Variant::has_utility_function(p_function), MethodInfo());
  50. MethodInfo info(p_function);
  51. if (Variant::has_utility_function_return_value(p_function)) {
  52. info.return_val.type = Variant::get_utility_function_return_type(p_function);
  53. if (info.return_val.type == Variant::NIL) {
  54. info.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  55. }
  56. }
  57. if (Variant::is_utility_function_vararg(p_function)) {
  58. info.flags |= METHOD_FLAG_VARARG;
  59. } else {
  60. for (int i = 0; i < Variant::get_utility_function_argument_count(p_function); i++) {
  61. PropertyInfo pi;
  62. #ifdef DEBUG_METHODS_ENABLED
  63. pi.name = Variant::get_utility_function_argument_name(p_function, i);
  64. #else
  65. pi.name = "arg" + itos(i + 1);
  66. #endif
  67. pi.type = Variant::get_utility_function_argument_type(p_function, i);
  68. info.arguments.push_back(pi);
  69. }
  70. }
  71. return info;
  72. }
  73. static GDScriptParser::DataType make_callable_type(const MethodInfo &p_info) {
  74. GDScriptParser::DataType type;
  75. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  76. type.kind = GDScriptParser::DataType::BUILTIN;
  77. type.builtin_type = Variant::CALLABLE;
  78. type.is_constant = true;
  79. type.method_info = p_info;
  80. return type;
  81. }
  82. static GDScriptParser::DataType make_signal_type(const MethodInfo &p_info) {
  83. GDScriptParser::DataType type;
  84. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  85. type.kind = GDScriptParser::DataType::BUILTIN;
  86. type.builtin_type = Variant::SIGNAL;
  87. type.is_constant = true;
  88. type.method_info = p_info;
  89. return type;
  90. }
  91. static GDScriptParser::DataType make_native_meta_type(const StringName &p_class_name) {
  92. GDScriptParser::DataType type;
  93. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  94. type.kind = GDScriptParser::DataType::NATIVE;
  95. type.builtin_type = Variant::OBJECT;
  96. type.native_type = p_class_name;
  97. type.is_constant = true;
  98. type.is_meta_type = true;
  99. return type;
  100. }
  101. static GDScriptParser::DataType make_script_meta_type(const Ref<Script> &p_script) {
  102. GDScriptParser::DataType type;
  103. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  104. type.kind = GDScriptParser::DataType::SCRIPT;
  105. type.builtin_type = Variant::OBJECT;
  106. type.native_type = p_script->get_instance_base_type();
  107. type.script_type = p_script;
  108. type.script_path = p_script->get_path();
  109. type.is_constant = true;
  110. type.is_meta_type = true;
  111. return type;
  112. }
  113. // In enum types, native_type is used to store the class (native or otherwise) that the enum belongs to.
  114. // This disambiguates between similarly named enums in base classes or outer classes
  115. static GDScriptParser::DataType make_enum_type(const StringName &p_enum_name, const String &p_base_name, const bool p_meta = false) {
  116. GDScriptParser::DataType type;
  117. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  118. type.kind = GDScriptParser::DataType::ENUM;
  119. type.builtin_type = p_meta ? Variant::DICTIONARY : Variant::INT;
  120. type.enum_type = p_enum_name;
  121. type.is_constant = true;
  122. type.is_meta_type = p_meta;
  123. // For enums, native_type is only used to check compatibility in is_type_compatible()
  124. // We can set anything readable here for error messages, as long as it uniquely identifies the type of the enum
  125. type.native_type = p_base_name + ENUM_SEPARATOR + p_enum_name;
  126. return type;
  127. }
  128. static GDScriptParser::DataType make_native_enum_type(const StringName &p_enum_name, const StringName &p_native_class, const bool p_meta = true) {
  129. // Find out which base class declared the enum, so the name is always the same even when coming from other contexts.
  130. StringName native_base = p_native_class;
  131. while (true && native_base != StringName()) {
  132. if (ClassDB::has_enum(native_base, p_enum_name, true)) {
  133. break;
  134. }
  135. native_base = ClassDB::get_parent_class_nocheck(native_base);
  136. }
  137. GDScriptParser::DataType type = make_enum_type(p_enum_name, native_base, p_meta);
  138. if (p_meta) {
  139. type.builtin_type = Variant::NIL; // Native enum types are not Dictionaries
  140. }
  141. List<StringName> enum_values;
  142. ClassDB::get_enum_constants(native_base, p_enum_name, &enum_values, true);
  143. for (const StringName &E : enum_values) {
  144. type.enum_values[E] = ClassDB::get_integer_constant(native_base, E);
  145. }
  146. return type;
  147. }
  148. static GDScriptParser::DataType make_builtin_meta_type(Variant::Type p_type) {
  149. GDScriptParser::DataType type;
  150. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  151. type.kind = GDScriptParser::DataType::BUILTIN;
  152. type.builtin_type = p_type;
  153. type.is_constant = true;
  154. type.is_meta_type = true;
  155. return type;
  156. }
  157. bool GDScriptAnalyzer::has_member_name_conflict_in_script_class(const StringName &p_member_name, const GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_member) {
  158. if (p_class->members_indices.has(p_member_name)) {
  159. int index = p_class->members_indices[p_member_name];
  160. const GDScriptParser::ClassNode::Member *member = &p_class->members[index];
  161. if (member->type == GDScriptParser::ClassNode::Member::VARIABLE ||
  162. member->type == GDScriptParser::ClassNode::Member::CONSTANT ||
  163. member->type == GDScriptParser::ClassNode::Member::ENUM ||
  164. member->type == GDScriptParser::ClassNode::Member::ENUM_VALUE ||
  165. member->type == GDScriptParser::ClassNode::Member::CLASS ||
  166. member->type == GDScriptParser::ClassNode::Member::SIGNAL) {
  167. return true;
  168. }
  169. if (p_member->type != GDScriptParser::Node::FUNCTION && member->type == GDScriptParser::ClassNode::Member::FUNCTION) {
  170. return true;
  171. }
  172. }
  173. return false;
  174. }
  175. bool GDScriptAnalyzer::has_member_name_conflict_in_native_type(const StringName &p_member_name, const StringName &p_native_type_string) {
  176. if (ClassDB::has_signal(p_native_type_string, p_member_name)) {
  177. return true;
  178. }
  179. if (ClassDB::has_property(p_native_type_string, p_member_name)) {
  180. return true;
  181. }
  182. if (ClassDB::has_integer_constant(p_native_type_string, p_member_name)) {
  183. return true;
  184. }
  185. if (p_member_name == CoreStringNames::get_singleton()->_script) {
  186. return true;
  187. }
  188. return false;
  189. }
  190. Error GDScriptAnalyzer::check_native_member_name_conflict(const StringName &p_member_name, const GDScriptParser::Node *p_member_node, const StringName &p_native_type_string) {
  191. if (has_member_name_conflict_in_native_type(p_member_name, p_native_type_string)) {
  192. push_error(vformat(R"(Member "%s" redefined (original in native class '%s'))", p_member_name, p_native_type_string), p_member_node);
  193. return ERR_PARSE_ERROR;
  194. }
  195. if (class_exists(p_member_name)) {
  196. push_error(vformat(R"(The member "%s" shadows a native class.)", p_member_name), p_member_node);
  197. return ERR_PARSE_ERROR;
  198. }
  199. if (GDScriptParser::get_builtin_type(p_member_name) != Variant::VARIANT_MAX) {
  200. push_error(vformat(R"(The member "%s" cannot have the same name as a builtin type.)", p_member_name), p_member_node);
  201. return ERR_PARSE_ERROR;
  202. }
  203. return OK;
  204. }
  205. Error GDScriptAnalyzer::check_class_member_name_conflict(const GDScriptParser::ClassNode *p_class_node, const StringName &p_member_name, const GDScriptParser::Node *p_member_node) {
  206. // TODO check outer classes for static members only
  207. const GDScriptParser::DataType *current_data_type = &p_class_node->base_type;
  208. while (current_data_type && current_data_type->kind == GDScriptParser::DataType::Kind::CLASS) {
  209. GDScriptParser::ClassNode *current_class_node = current_data_type->class_type;
  210. if (has_member_name_conflict_in_script_class(p_member_name, current_class_node, p_member_node)) {
  211. String parent_class_name = current_class_node->fqcn;
  212. if (current_class_node->identifier != nullptr) {
  213. parent_class_name = current_class_node->identifier->name;
  214. }
  215. push_error(vformat(R"(The member "%s" already exists in parent class %s.)", p_member_name, parent_class_name), p_member_node);
  216. return ERR_PARSE_ERROR;
  217. }
  218. current_data_type = &current_class_node->base_type;
  219. }
  220. // No need for native class recursion because Node exposes all Object's properties.
  221. if (current_data_type && current_data_type->kind == GDScriptParser::DataType::Kind::NATIVE) {
  222. if (current_data_type->native_type != StringName()) {
  223. return check_native_member_name_conflict(
  224. p_member_name,
  225. p_member_node,
  226. current_data_type->native_type);
  227. }
  228. }
  229. return OK;
  230. }
  231. void GDScriptAnalyzer::get_class_node_current_scope_classes(GDScriptParser::ClassNode *p_node, List<GDScriptParser::ClassNode *> *p_list) {
  232. ERR_FAIL_NULL(p_node);
  233. ERR_FAIL_NULL(p_list);
  234. if (p_list->find(p_node) != nullptr) {
  235. return;
  236. }
  237. p_list->push_back(p_node);
  238. // TODO: Try to solve class inheritance if not yet resolving.
  239. // Prioritize node base type over its outer class
  240. if (p_node->base_type.class_type != nullptr) {
  241. get_class_node_current_scope_classes(p_node->base_type.class_type, p_list);
  242. }
  243. if (p_node->outer != nullptr) {
  244. get_class_node_current_scope_classes(p_node->outer, p_list);
  245. }
  246. }
  247. Error GDScriptAnalyzer::resolve_class_inheritance(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source) {
  248. if (p_source == nullptr && parser->has_class(p_class)) {
  249. p_source = p_class;
  250. }
  251. if (p_class->base_type.is_resolving()) {
  252. push_error(vformat(R"(Could not resolve class "%s": Cyclic reference.)", type_from_metatype(p_class->get_datatype()).to_string()), p_source);
  253. return ERR_PARSE_ERROR;
  254. }
  255. if (!p_class->base_type.has_no_type()) {
  256. // Already resolved.
  257. return OK;
  258. }
  259. if (!parser->has_class(p_class)) {
  260. String script_path = p_class->get_datatype().script_path;
  261. Ref<GDScriptParserRef> parser_ref = get_parser_for(script_path);
  262. if (parser_ref.is_null()) {
  263. push_error(vformat(R"(Could not find script "%s".)", script_path), p_source);
  264. return ERR_PARSE_ERROR;
  265. }
  266. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  267. if (err) {
  268. push_error(vformat(R"(Could not parse script "%s": %s.)", script_path, error_names[err]), p_source);
  269. return ERR_PARSE_ERROR;
  270. }
  271. ERR_FAIL_COND_V_MSG(!parser_ref->get_parser()->has_class(p_class), ERR_PARSE_ERROR, R"(Parser bug: Mismatched external parser.)");
  272. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  273. GDScriptParser *other_parser = parser_ref->get_parser();
  274. int error_count = other_parser->errors.size();
  275. other_analyzer->resolve_class_inheritance(p_class);
  276. if (other_parser->errors.size() > error_count) {
  277. push_error(vformat(R"(Could not resolve inheritance for class "%s".)", p_class->fqcn), p_source);
  278. return ERR_PARSE_ERROR;
  279. }
  280. return OK;
  281. }
  282. GDScriptParser::ClassNode *previous_class = parser->current_class;
  283. parser->current_class = p_class;
  284. if (p_class->identifier) {
  285. StringName class_name = p_class->identifier->name;
  286. if (GDScriptParser::get_builtin_type(class_name) < Variant::VARIANT_MAX) {
  287. push_error(vformat(R"(Class "%s" hides a built-in type.)", class_name), p_class->identifier);
  288. } else if (class_exists(class_name)) {
  289. push_error(vformat(R"(Class "%s" hides a native class.)", class_name), p_class->identifier);
  290. } else if (ScriptServer::is_global_class(class_name) && (ScriptServer::get_global_class_path(class_name) != parser->script_path || p_class != parser->head)) {
  291. push_error(vformat(R"(Class "%s" hides a global script class.)", class_name), p_class->identifier);
  292. } else if (ProjectSettings::get_singleton()->has_autoload(class_name) && ProjectSettings::get_singleton()->get_autoload(class_name).is_singleton) {
  293. push_error(vformat(R"(Class "%s" hides an autoload singleton.)", class_name), p_class->identifier);
  294. }
  295. }
  296. GDScriptParser::DataType resolving_datatype;
  297. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  298. p_class->base_type = resolving_datatype;
  299. // Set datatype for class.
  300. GDScriptParser::DataType class_type;
  301. class_type.is_constant = true;
  302. class_type.is_meta_type = true;
  303. class_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  304. class_type.kind = GDScriptParser::DataType::CLASS;
  305. class_type.class_type = p_class;
  306. class_type.script_path = parser->script_path;
  307. class_type.builtin_type = Variant::OBJECT;
  308. p_class->set_datatype(class_type);
  309. GDScriptParser::DataType result;
  310. if (!p_class->extends_used) {
  311. result.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  312. result.kind = GDScriptParser::DataType::NATIVE;
  313. result.native_type = SNAME("RefCounted");
  314. } else {
  315. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  316. GDScriptParser::DataType base;
  317. int extends_index = 0;
  318. if (!p_class->extends_path.is_empty()) {
  319. if (p_class->extends_path.is_relative_path()) {
  320. p_class->extends_path = class_type.script_path.get_base_dir().path_join(p_class->extends_path).simplify_path();
  321. }
  322. Ref<GDScriptParserRef> ext_parser = get_parser_for(p_class->extends_path);
  323. if (ext_parser.is_null()) {
  324. push_error(vformat(R"(Could not resolve super class path "%s".)", p_class->extends_path), p_class);
  325. return ERR_PARSE_ERROR;
  326. }
  327. Error err = ext_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  328. if (err != OK) {
  329. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", p_class->extends_path), p_class);
  330. return err;
  331. }
  332. base = ext_parser->get_parser()->head->get_datatype();
  333. } else {
  334. if (p_class->extends.is_empty()) {
  335. push_error("Could not resolve an empty super class path.", p_class);
  336. return ERR_PARSE_ERROR;
  337. }
  338. const StringName &name = p_class->extends[extends_index++];
  339. base.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  340. if (ScriptServer::is_global_class(name)) {
  341. String base_path = ScriptServer::get_global_class_path(name);
  342. if (base_path == parser->script_path) {
  343. base = parser->head->get_datatype();
  344. } else {
  345. Ref<GDScriptParserRef> base_parser = get_parser_for(base_path);
  346. if (base_parser.is_null()) {
  347. push_error(vformat(R"(Could not resolve super class "%s".)", name), p_class);
  348. return ERR_PARSE_ERROR;
  349. }
  350. Error err = base_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  351. if (err != OK) {
  352. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", name), p_class);
  353. return err;
  354. }
  355. base = base_parser->get_parser()->head->get_datatype();
  356. }
  357. } else if (ProjectSettings::get_singleton()->has_autoload(name) && ProjectSettings::get_singleton()->get_autoload(name).is_singleton) {
  358. const ProjectSettings::AutoloadInfo &info = ProjectSettings::get_singleton()->get_autoload(name);
  359. if (info.path.get_extension().to_lower() != GDScriptLanguage::get_singleton()->get_extension()) {
  360. push_error(vformat(R"(Singleton %s is not a GDScript.)", info.name), p_class);
  361. return ERR_PARSE_ERROR;
  362. }
  363. Ref<GDScriptParserRef> info_parser = get_parser_for(info.path);
  364. if (info_parser.is_null()) {
  365. push_error(vformat(R"(Could not parse singleton from "%s".)", info.path), p_class);
  366. return ERR_PARSE_ERROR;
  367. }
  368. Error err = info_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  369. if (err != OK) {
  370. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", name), p_class);
  371. return err;
  372. }
  373. base = info_parser->get_parser()->head->get_datatype();
  374. } else if (class_exists(name)) {
  375. base.kind = GDScriptParser::DataType::NATIVE;
  376. base.native_type = name;
  377. } else {
  378. // Look for other classes in script.
  379. bool found = false;
  380. List<GDScriptParser::ClassNode *> script_classes;
  381. get_class_node_current_scope_classes(p_class, &script_classes);
  382. for (GDScriptParser::ClassNode *look_class : script_classes) {
  383. if (look_class->identifier && look_class->identifier->name == name) {
  384. if (!look_class->get_datatype().is_set()) {
  385. Error err = resolve_class_inheritance(look_class, p_class);
  386. if (err) {
  387. return err;
  388. }
  389. }
  390. base = look_class->get_datatype();
  391. found = true;
  392. break;
  393. }
  394. if (look_class->has_member(name)) {
  395. resolve_class_member(look_class, name, p_class);
  396. base = look_class->get_member(name).get_datatype();
  397. found = true;
  398. break;
  399. }
  400. }
  401. if (!found) {
  402. push_error(vformat(R"(Could not find base class "%s".)", name), p_class);
  403. return ERR_PARSE_ERROR;
  404. }
  405. }
  406. }
  407. for (int index = extends_index; index < p_class->extends.size(); index++) {
  408. if (base.kind != GDScriptParser::DataType::CLASS) {
  409. push_error(R"(Super type "%s" is not a GDScript. Cannot get nested types.)", p_class);
  410. return ERR_PARSE_ERROR;
  411. }
  412. // TODO: Extends could use identifier nodes. That way errors can be pointed out properly and it can be used here.
  413. GDScriptParser::IdentifierNode *id = parser->alloc_node<GDScriptParser::IdentifierNode>();
  414. id->name = p_class->extends[index];
  415. reduce_identifier_from_base(id, &base);
  416. GDScriptParser::DataType id_type = id->get_datatype();
  417. if (!id_type.is_set()) {
  418. push_error(vformat(R"(Could not find type "%s" under base "%s".)", id->name, base.to_string()), p_class);
  419. }
  420. base = id_type;
  421. }
  422. result = base;
  423. }
  424. if (!result.is_set() || result.has_no_type()) {
  425. // TODO: More specific error messages.
  426. push_error(vformat(R"(Could not resolve inheritance for class "%s".)", p_class->identifier == nullptr ? "<main>" : p_class->identifier->name), p_class);
  427. return ERR_PARSE_ERROR;
  428. }
  429. // Check for cyclic inheritance.
  430. const GDScriptParser::ClassNode *base_class = result.class_type;
  431. while (base_class) {
  432. if (base_class->fqcn == p_class->fqcn) {
  433. push_error("Cyclic inheritance.", p_class);
  434. return ERR_PARSE_ERROR;
  435. }
  436. base_class = base_class->base_type.class_type;
  437. }
  438. p_class->base_type = result;
  439. class_type.native_type = result.native_type;
  440. p_class->set_datatype(class_type);
  441. parser->current_class = previous_class;
  442. return OK;
  443. }
  444. Error GDScriptAnalyzer::resolve_class_inheritance(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  445. Error err = resolve_class_inheritance(p_class);
  446. if (err) {
  447. return err;
  448. }
  449. if (p_recursive) {
  450. for (int i = 0; i < p_class->members.size(); i++) {
  451. if (p_class->members[i].type == GDScriptParser::ClassNode::Member::CLASS) {
  452. err = resolve_class_inheritance(p_class->members[i].m_class, true);
  453. if (err) {
  454. return err;
  455. }
  456. }
  457. }
  458. }
  459. return OK;
  460. }
  461. GDScriptParser::DataType GDScriptAnalyzer::resolve_datatype(GDScriptParser::TypeNode *p_type) {
  462. GDScriptParser::DataType bad_type;
  463. bad_type.kind = GDScriptParser::DataType::VARIANT;
  464. bad_type.type_source = GDScriptParser::DataType::INFERRED;
  465. if (p_type == nullptr) {
  466. return bad_type;
  467. }
  468. if (p_type->get_datatype().is_resolving()) {
  469. push_error(R"(Could not resolve datatype: Cyclic reference.)", p_type);
  470. return bad_type;
  471. }
  472. if (!p_type->get_datatype().has_no_type()) {
  473. return p_type->get_datatype();
  474. }
  475. GDScriptParser::DataType resolving_datatype;
  476. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  477. p_type->set_datatype(resolving_datatype);
  478. GDScriptParser::DataType result;
  479. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  480. if (p_type->type_chain.is_empty()) {
  481. // void.
  482. result.kind = GDScriptParser::DataType::BUILTIN;
  483. result.builtin_type = Variant::NIL;
  484. p_type->set_datatype(result);
  485. return result;
  486. }
  487. StringName first = p_type->type_chain[0]->name;
  488. if (first == SNAME("Variant")) {
  489. if (p_type->type_chain.size() > 1) {
  490. // TODO: Variant does actually have a nested Type though.
  491. push_error(R"(Variant doesn't contain nested types.)", p_type->type_chain[1]);
  492. return bad_type;
  493. }
  494. result.kind = GDScriptParser::DataType::VARIANT;
  495. } else if (first == SNAME("Object")) {
  496. // Object is treated like a native type, not a built-in.
  497. result.kind = GDScriptParser::DataType::NATIVE;
  498. result.builtin_type = Variant::OBJECT;
  499. result.native_type = SNAME("Object");
  500. } else if (GDScriptParser::get_builtin_type(first) < Variant::VARIANT_MAX) {
  501. // Built-in types.
  502. if (p_type->type_chain.size() > 1) {
  503. push_error(R"(Built-in types don't contain nested types.)", p_type->type_chain[1]);
  504. return bad_type;
  505. }
  506. result.kind = GDScriptParser::DataType::BUILTIN;
  507. result.builtin_type = GDScriptParser::get_builtin_type(first);
  508. if (result.builtin_type == Variant::ARRAY) {
  509. GDScriptParser::DataType container_type = type_from_metatype(resolve_datatype(p_type->container_type));
  510. if (container_type.kind != GDScriptParser::DataType::VARIANT) {
  511. container_type.is_constant = false;
  512. result.set_container_element_type(container_type);
  513. }
  514. }
  515. } else if (class_exists(first)) {
  516. // Native engine classes.
  517. result.kind = GDScriptParser::DataType::NATIVE;
  518. result.builtin_type = Variant::OBJECT;
  519. result.native_type = first;
  520. } else if (ScriptServer::is_global_class(first)) {
  521. if (parser->script_path == ScriptServer::get_global_class_path(first)) {
  522. result = parser->head->get_datatype();
  523. } else {
  524. String path = ScriptServer::get_global_class_path(first);
  525. String ext = path.get_extension();
  526. if (ext == GDScriptLanguage::get_singleton()->get_extension()) {
  527. Ref<GDScriptParserRef> ref = get_parser_for(path);
  528. if (!ref.is_valid() || ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED) != OK) {
  529. push_error(vformat(R"(Could not parse global class "%s" from "%s".)", first, ScriptServer::get_global_class_path(first)), p_type);
  530. return bad_type;
  531. }
  532. result = ref->get_parser()->head->get_datatype();
  533. } else {
  534. result = make_script_meta_type(ResourceLoader::load(path, "Script"));
  535. }
  536. }
  537. } else if (ProjectSettings::get_singleton()->has_autoload(first) && ProjectSettings::get_singleton()->get_autoload(first).is_singleton) {
  538. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(first);
  539. Ref<GDScriptParserRef> ref = get_parser_for(autoload.path);
  540. if (ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED) != OK) {
  541. push_error(vformat(R"(Could not parse singleton "%s" from "%s".)", first, autoload.path), p_type);
  542. return bad_type;
  543. }
  544. result = ref->get_parser()->head->get_datatype();
  545. } else if (ClassDB::has_enum(parser->current_class->base_type.native_type, first)) {
  546. // Native enum in current class.
  547. result = make_native_enum_type(first, parser->current_class->base_type.native_type);
  548. } else {
  549. // Classes in current scope.
  550. List<GDScriptParser::ClassNode *> script_classes;
  551. bool found = false;
  552. get_class_node_current_scope_classes(parser->current_class, &script_classes);
  553. for (GDScriptParser::ClassNode *script_class : script_classes) {
  554. if (found) {
  555. break;
  556. }
  557. if (script_class->identifier && script_class->identifier->name == first) {
  558. result = script_class->get_datatype();
  559. break;
  560. }
  561. if (script_class->members_indices.has(first)) {
  562. resolve_class_member(script_class, first, p_type);
  563. GDScriptParser::ClassNode::Member member = script_class->get_member(first);
  564. switch (member.type) {
  565. case GDScriptParser::ClassNode::Member::CLASS:
  566. result = member.get_datatype();
  567. found = true;
  568. break;
  569. case GDScriptParser::ClassNode::Member::ENUM:
  570. result = member.get_datatype();
  571. found = true;
  572. break;
  573. case GDScriptParser::ClassNode::Member::CONSTANT:
  574. if (member.get_datatype().is_meta_type) {
  575. result = member.get_datatype();
  576. found = true;
  577. break;
  578. } else if (Ref<Script>(member.constant->initializer->reduced_value).is_valid()) {
  579. Ref<GDScript> gdscript = member.constant->initializer->reduced_value;
  580. if (gdscript.is_valid()) {
  581. Ref<GDScriptParserRef> ref = get_parser_for(gdscript->get_script_path());
  582. if (ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED) != OK) {
  583. push_error(vformat(R"(Could not parse script from "%s".)", gdscript->get_script_path()), p_type);
  584. return bad_type;
  585. }
  586. result = ref->get_parser()->head->get_datatype();
  587. } else {
  588. result = make_script_meta_type(member.constant->initializer->reduced_value);
  589. }
  590. found = true;
  591. break;
  592. }
  593. [[fallthrough]];
  594. default:
  595. push_error(vformat(R"("%s" is a %s but does not contain a type.)", first, member.get_type_name()), p_type);
  596. return bad_type;
  597. }
  598. }
  599. }
  600. }
  601. if (!result.is_set()) {
  602. push_error(vformat(R"("%s" was not found in the current scope.)", first), p_type);
  603. return bad_type;
  604. }
  605. if (p_type->type_chain.size() > 1) {
  606. if (result.kind == GDScriptParser::DataType::CLASS) {
  607. for (int i = 1; i < p_type->type_chain.size(); i++) {
  608. GDScriptParser::DataType base = result;
  609. reduce_identifier_from_base(p_type->type_chain[i], &base);
  610. result = p_type->type_chain[i]->get_datatype();
  611. if (!result.is_set()) {
  612. push_error(vformat(R"(Could not find type "%s" under base "%s".)", p_type->type_chain[i]->name, base.to_string()), p_type->type_chain[1]);
  613. return bad_type;
  614. } else if (!result.is_meta_type) {
  615. push_error(vformat(R"(Member "%s" under base "%s" is not a valid type.)", p_type->type_chain[i]->name, base.to_string()), p_type->type_chain[1]);
  616. return bad_type;
  617. }
  618. }
  619. } else if (result.kind == GDScriptParser::DataType::NATIVE) {
  620. // Only enums allowed for native.
  621. if (ClassDB::has_enum(result.native_type, p_type->type_chain[1]->name)) {
  622. if (p_type->type_chain.size() > 2) {
  623. push_error(R"(Enums cannot contain nested types.)", p_type->type_chain[2]);
  624. return bad_type;
  625. } else {
  626. result = make_native_enum_type(p_type->type_chain[1]->name, result.native_type);
  627. }
  628. } else {
  629. push_error(vformat(R"(Could not find type "%s" in "%s".)", p_type->type_chain[1]->name, first), p_type->type_chain[1]);
  630. return bad_type;
  631. }
  632. } else {
  633. push_error(vformat(R"(Could not find nested type "%s" under base "%s".)", p_type->type_chain[1]->name, result.to_string()), p_type->type_chain[1]);
  634. return bad_type;
  635. }
  636. }
  637. if (result.builtin_type != Variant::ARRAY && p_type->container_type != nullptr) {
  638. push_error("Only arrays can specify the collection element type.", p_type);
  639. }
  640. p_type->set_datatype(result);
  641. return result;
  642. }
  643. void GDScriptAnalyzer::resolve_class_member(GDScriptParser::ClassNode *p_class, StringName p_name, const GDScriptParser::Node *p_source) {
  644. ERR_FAIL_COND(!p_class->has_member(p_name));
  645. resolve_class_member(p_class, p_class->members_indices[p_name], p_source);
  646. }
  647. void GDScriptAnalyzer::resolve_class_member(GDScriptParser::ClassNode *p_class, int p_index, const GDScriptParser::Node *p_source) {
  648. ERR_FAIL_INDEX(p_index, p_class->members.size());
  649. GDScriptParser::ClassNode::Member &member = p_class->members.write[p_index];
  650. if (p_source == nullptr && parser->has_class(p_class)) {
  651. p_source = member.get_source_node();
  652. }
  653. if (member.get_datatype().is_resolving()) {
  654. push_error(vformat(R"(Could not resolve member "%s": Cyclic reference.)", member.get_name()), p_source);
  655. return;
  656. }
  657. if (member.get_datatype().is_set()) {
  658. return;
  659. }
  660. if (!parser->has_class(p_class)) {
  661. String script_path = p_class->get_datatype().script_path;
  662. Ref<GDScriptParserRef> parser_ref = get_parser_for(script_path);
  663. if (parser_ref.is_null()) {
  664. push_error(vformat(R"(Could not find script "%s" (While resolving "%s").)", script_path, member.get_name()), p_source);
  665. return;
  666. }
  667. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  668. if (err) {
  669. push_error(vformat(R"(Could not resolve script "%s": %s (While resolving "%s").)", script_path, error_names[err], member.get_name()), p_source);
  670. return;
  671. }
  672. ERR_FAIL_COND_MSG(!parser_ref->get_parser()->has_class(p_class), R"(Parser bug: Mismatched external parser.)");
  673. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  674. GDScriptParser *other_parser = parser_ref->get_parser();
  675. int error_count = other_parser->errors.size();
  676. other_analyzer->resolve_class_member(p_class, p_index);
  677. if (other_parser->errors.size() > error_count) {
  678. push_error(vformat(R"(Could not resolve member "%s".)", member.get_name()), p_source);
  679. }
  680. return;
  681. }
  682. // If it's already resolving, that's ok.
  683. if (!p_class->base_type.is_resolving()) {
  684. Error err = resolve_class_inheritance(p_class);
  685. if (err) {
  686. return;
  687. }
  688. }
  689. GDScriptParser::ClassNode *previous_class = parser->current_class;
  690. parser->current_class = p_class;
  691. GDScriptParser::DataType resolving_datatype;
  692. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  693. {
  694. #ifdef DEBUG_ENABLED
  695. HashSet<GDScriptWarning::Code> previously_ignored_warnings = parser->ignored_warnings;
  696. GDScriptParser::Node *member_node = member.get_source_node();
  697. if (member_node && member_node->type != GDScriptParser::Node::ANNOTATION) {
  698. // Apply @warning_ignore annotations before resolving member.
  699. for (GDScriptParser::AnnotationNode *&E : member_node->annotations) {
  700. if (E->name == SNAME("@warning_ignore")) {
  701. resolve_annotation(E);
  702. E->apply(parser, member.variable);
  703. }
  704. }
  705. for (GDScriptWarning::Code ignored_warning : member_node->ignored_warnings) {
  706. parser->ignored_warnings.insert(ignored_warning);
  707. }
  708. }
  709. #endif
  710. switch (member.type) {
  711. case GDScriptParser::ClassNode::Member::VARIABLE: {
  712. check_class_member_name_conflict(p_class, member.variable->identifier->name, member.variable);
  713. member.variable->set_datatype(resolving_datatype);
  714. resolve_variable(member.variable, false);
  715. // Apply annotations.
  716. for (GDScriptParser::AnnotationNode *&E : member.variable->annotations) {
  717. if (E->name != SNAME("@warning_ignore")) {
  718. resolve_annotation(E);
  719. E->apply(parser, member.variable);
  720. }
  721. }
  722. #ifdef DEBUG_ENABLED
  723. if (member.variable->exported && member.variable->onready) {
  724. parser->push_warning(member.variable, GDScriptWarning::ONREADY_WITH_EXPORT);
  725. }
  726. if (member.variable->initializer) {
  727. // Check if it is call to get_node() on self (using shorthand $ or not), so we can check if @onready is needed.
  728. // This could be improved by traversing the expression fully and checking the presence of get_node at any level.
  729. if (!member.variable->onready && member.variable->initializer && (member.variable->initializer->type == GDScriptParser::Node::GET_NODE || member.variable->initializer->type == GDScriptParser::Node::CALL || member.variable->initializer->type == GDScriptParser::Node::CAST)) {
  730. GDScriptParser::Node *expr = member.variable->initializer;
  731. if (expr->type == GDScriptParser::Node::CAST) {
  732. expr = static_cast<GDScriptParser::CastNode *>(expr)->operand;
  733. }
  734. bool is_get_node = expr->type == GDScriptParser::Node::GET_NODE;
  735. bool is_using_shorthand = is_get_node;
  736. if (!is_get_node && expr->type == GDScriptParser::Node::CALL) {
  737. is_using_shorthand = false;
  738. GDScriptParser::CallNode *call = static_cast<GDScriptParser::CallNode *>(expr);
  739. if (call->function_name == SNAME("get_node")) {
  740. switch (call->get_callee_type()) {
  741. case GDScriptParser::Node::IDENTIFIER: {
  742. is_get_node = true;
  743. } break;
  744. case GDScriptParser::Node::SUBSCRIPT: {
  745. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(call->callee);
  746. is_get_node = subscript->is_attribute && subscript->base->type == GDScriptParser::Node::SELF;
  747. } break;
  748. default:
  749. break;
  750. }
  751. }
  752. }
  753. if (is_get_node) {
  754. parser->push_warning(member.variable, GDScriptWarning::GET_NODE_DEFAULT_WITHOUT_ONREADY, is_using_shorthand ? "$" : "get_node()");
  755. }
  756. }
  757. }
  758. #endif
  759. } break;
  760. case GDScriptParser::ClassNode::Member::CONSTANT: {
  761. check_class_member_name_conflict(p_class, member.constant->identifier->name, member.constant);
  762. member.constant->set_datatype(resolving_datatype);
  763. resolve_constant(member.constant, false);
  764. // Apply annotations.
  765. for (GDScriptParser::AnnotationNode *&E : member.constant->annotations) {
  766. resolve_annotation(E);
  767. E->apply(parser, member.constant);
  768. }
  769. } break;
  770. case GDScriptParser::ClassNode::Member::SIGNAL: {
  771. check_class_member_name_conflict(p_class, member.signal->identifier->name, member.signal);
  772. member.signal->set_datatype(resolving_datatype);
  773. // This is the _only_ way to declare a signal. Therefore, we can generate its
  774. // MethodInfo inline so it's a tiny bit more efficient.
  775. MethodInfo mi = MethodInfo(member.signal->identifier->name);
  776. for (int j = 0; j < member.signal->parameters.size(); j++) {
  777. GDScriptParser::ParameterNode *param = member.signal->parameters[j];
  778. GDScriptParser::DataType param_type = type_from_metatype(resolve_datatype(param->datatype_specifier));
  779. param->set_datatype(param_type);
  780. mi.arguments.push_back(PropertyInfo(param_type.builtin_type, param->identifier->name));
  781. // TODO: add signal parameter default values
  782. }
  783. member.signal->set_datatype(make_signal_type(mi));
  784. // Apply annotations.
  785. for (GDScriptParser::AnnotationNode *&E : member.signal->annotations) {
  786. resolve_annotation(E);
  787. E->apply(parser, member.signal);
  788. }
  789. } break;
  790. case GDScriptParser::ClassNode::Member::ENUM: {
  791. check_class_member_name_conflict(p_class, member.m_enum->identifier->name, member.m_enum);
  792. member.m_enum->set_datatype(resolving_datatype);
  793. GDScriptParser::DataType enum_type = make_enum_type(member.m_enum->identifier->name, p_class->fqcn, true);
  794. const GDScriptParser::EnumNode *prev_enum = current_enum;
  795. current_enum = member.m_enum;
  796. Dictionary dictionary;
  797. for (int j = 0; j < member.m_enum->values.size(); j++) {
  798. GDScriptParser::EnumNode::Value &element = member.m_enum->values.write[j];
  799. if (element.custom_value) {
  800. reduce_expression(element.custom_value);
  801. if (!element.custom_value->is_constant) {
  802. push_error(R"(Enum values must be constant.)", element.custom_value);
  803. } else if (element.custom_value->reduced_value.get_type() != Variant::INT) {
  804. push_error(R"(Enum values must be integers.)", element.custom_value);
  805. } else {
  806. element.value = element.custom_value->reduced_value;
  807. element.resolved = true;
  808. }
  809. } else {
  810. if (element.index > 0) {
  811. element.value = element.parent_enum->values[element.index - 1].value + 1;
  812. } else {
  813. element.value = 0;
  814. }
  815. element.resolved = true;
  816. }
  817. enum_type.enum_values[element.identifier->name] = element.value;
  818. dictionary[String(element.identifier->name)] = element.value;
  819. }
  820. current_enum = prev_enum;
  821. dictionary.make_read_only();
  822. member.m_enum->set_datatype(enum_type);
  823. member.m_enum->dictionary = dictionary;
  824. // Apply annotations.
  825. for (GDScriptParser::AnnotationNode *&E : member.m_enum->annotations) {
  826. resolve_annotation(E);
  827. E->apply(parser, member.m_enum);
  828. }
  829. } break;
  830. case GDScriptParser::ClassNode::Member::FUNCTION:
  831. for (GDScriptParser::AnnotationNode *&E : member.function->annotations) {
  832. resolve_annotation(E);
  833. E->apply(parser, member.function);
  834. }
  835. resolve_function_signature(member.function, p_source);
  836. break;
  837. case GDScriptParser::ClassNode::Member::ENUM_VALUE: {
  838. member.enum_value.identifier->set_datatype(resolving_datatype);
  839. if (member.enum_value.custom_value) {
  840. check_class_member_name_conflict(p_class, member.enum_value.identifier->name, member.enum_value.custom_value);
  841. const GDScriptParser::EnumNode *prev_enum = current_enum;
  842. current_enum = member.enum_value.parent_enum;
  843. reduce_expression(member.enum_value.custom_value);
  844. current_enum = prev_enum;
  845. if (!member.enum_value.custom_value->is_constant) {
  846. push_error(R"(Enum values must be constant.)", member.enum_value.custom_value);
  847. } else if (member.enum_value.custom_value->reduced_value.get_type() != Variant::INT) {
  848. push_error(R"(Enum values must be integers.)", member.enum_value.custom_value);
  849. } else {
  850. member.enum_value.value = member.enum_value.custom_value->reduced_value;
  851. member.enum_value.resolved = true;
  852. }
  853. } else {
  854. check_class_member_name_conflict(p_class, member.enum_value.identifier->name, member.enum_value.parent_enum);
  855. if (member.enum_value.index > 0) {
  856. const GDScriptParser::EnumNode::Value &prev_value = member.enum_value.parent_enum->values[member.enum_value.index - 1];
  857. resolve_class_member(p_class, prev_value.identifier->name, member.enum_value.identifier);
  858. member.enum_value.value = prev_value.value + 1;
  859. } else {
  860. member.enum_value.value = 0;
  861. }
  862. member.enum_value.resolved = true;
  863. }
  864. // Also update the original references.
  865. member.enum_value.parent_enum->values.set(member.enum_value.index, member.enum_value);
  866. member.enum_value.identifier->set_datatype(make_enum_type(UNNAMED_ENUM, p_class->fqcn, false));
  867. } break;
  868. case GDScriptParser::ClassNode::Member::CLASS:
  869. check_class_member_name_conflict(p_class, member.m_class->identifier->name, member.m_class);
  870. // If it's already resolving, that's ok.
  871. if (!member.m_class->base_type.is_resolving()) {
  872. resolve_class_inheritance(member.m_class, p_source);
  873. }
  874. break;
  875. case GDScriptParser::ClassNode::Member::GROUP:
  876. // No-op, but needed to silence warnings.
  877. break;
  878. case GDScriptParser::ClassNode::Member::UNDEFINED:
  879. ERR_PRINT("Trying to resolve undefined member.");
  880. break;
  881. }
  882. #ifdef DEBUG_ENABLED
  883. parser->ignored_warnings = previously_ignored_warnings;
  884. #endif
  885. }
  886. parser->current_class = previous_class;
  887. }
  888. void GDScriptAnalyzer::resolve_class_interface(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source) {
  889. if (p_source == nullptr && parser->has_class(p_class)) {
  890. p_source = p_class;
  891. }
  892. if (!p_class->resolved_interface) {
  893. if (!parser->has_class(p_class)) {
  894. String script_path = p_class->get_datatype().script_path;
  895. Ref<GDScriptParserRef> parser_ref = get_parser_for(script_path);
  896. if (parser_ref.is_null()) {
  897. push_error(vformat(R"(Could not find script "%s".)", script_path), p_source);
  898. return;
  899. }
  900. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  901. if (err) {
  902. push_error(vformat(R"(Could not resolve script "%s": %s.)", script_path, error_names[err]), p_source);
  903. return;
  904. }
  905. ERR_FAIL_COND_MSG(!parser_ref->get_parser()->has_class(p_class), R"(Parser bug: Mismatched external parser.)");
  906. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  907. GDScriptParser *other_parser = parser_ref->get_parser();
  908. int error_count = other_parser->errors.size();
  909. other_analyzer->resolve_class_interface(p_class);
  910. if (other_parser->errors.size() > error_count) {
  911. push_error(vformat(R"(Could not resolve class "%s".)", p_class->fqcn), p_source);
  912. }
  913. return;
  914. }
  915. p_class->resolved_interface = true;
  916. if (resolve_class_inheritance(p_class) != OK) {
  917. return;
  918. }
  919. GDScriptParser::DataType base_type = p_class->base_type;
  920. if (base_type.kind == GDScriptParser::DataType::CLASS) {
  921. GDScriptParser::ClassNode *base_class = base_type.class_type;
  922. resolve_class_interface(base_class, p_class);
  923. }
  924. for (int i = 0; i < p_class->members.size(); i++) {
  925. resolve_class_member(p_class, i);
  926. }
  927. }
  928. }
  929. void GDScriptAnalyzer::resolve_class_interface(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  930. resolve_class_interface(p_class);
  931. if (p_recursive) {
  932. for (int i = 0; i < p_class->members.size(); i++) {
  933. GDScriptParser::ClassNode::Member member = p_class->members[i];
  934. if (member.type == GDScriptParser::ClassNode::Member::CLASS) {
  935. resolve_class_interface(member.m_class, true);
  936. }
  937. }
  938. }
  939. }
  940. void GDScriptAnalyzer::resolve_class_body(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source) {
  941. if (p_source == nullptr && parser->has_class(p_class)) {
  942. p_source = p_class;
  943. }
  944. if (p_class->resolved_body) {
  945. return;
  946. }
  947. if (!parser->has_class(p_class)) {
  948. String script_path = p_class->get_datatype().script_path;
  949. Ref<GDScriptParserRef> parser_ref = get_parser_for(script_path);
  950. if (parser_ref.is_null()) {
  951. push_error(vformat(R"(Could not find script "%s".)", script_path), p_source);
  952. return;
  953. }
  954. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  955. if (err) {
  956. push_error(vformat(R"(Could not resolve script "%s": %s.)", script_path, error_names[err]), p_source);
  957. return;
  958. }
  959. ERR_FAIL_COND_MSG(!parser_ref->get_parser()->has_class(p_class), R"(Parser bug: Mismatched external parser.)");
  960. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  961. GDScriptParser *other_parser = parser_ref->get_parser();
  962. int error_count = other_parser->errors.size();
  963. other_analyzer->resolve_class_body(p_class);
  964. if (other_parser->errors.size() > error_count) {
  965. push_error(vformat(R"(Could not resolve class "%s".)", p_class->fqcn), p_source);
  966. }
  967. return;
  968. }
  969. p_class->resolved_body = true;
  970. GDScriptParser::ClassNode *previous_class = parser->current_class;
  971. parser->current_class = p_class;
  972. resolve_class_interface(p_class, p_source);
  973. GDScriptParser::DataType base_type = p_class->base_type;
  974. if (base_type.kind == GDScriptParser::DataType::CLASS) {
  975. GDScriptParser::ClassNode *base_class = base_type.class_type;
  976. resolve_class_body(base_class, p_class);
  977. }
  978. // Do functions, properties, and groups now.
  979. for (int i = 0; i < p_class->members.size(); i++) {
  980. GDScriptParser::ClassNode::Member member = p_class->members[i];
  981. if (member.type == GDScriptParser::ClassNode::Member::FUNCTION) {
  982. // Apply annotations.
  983. for (GDScriptParser::AnnotationNode *&E : member.function->annotations) {
  984. resolve_annotation(E);
  985. E->apply(parser, member.function);
  986. }
  987. resolve_function_body(member.function);
  988. } else if (member.type == GDScriptParser::ClassNode::Member::VARIABLE && member.variable->property != GDScriptParser::VariableNode::PROP_NONE) {
  989. if (member.variable->property == GDScriptParser::VariableNode::PROP_INLINE) {
  990. if (member.variable->getter != nullptr) {
  991. member.variable->getter->set_datatype(member.variable->datatype);
  992. resolve_function_body(member.variable->getter);
  993. }
  994. if (member.variable->setter != nullptr) {
  995. resolve_function_signature(member.variable->setter);
  996. if (member.variable->setter->parameters.size() > 0) {
  997. member.variable->setter->parameters[0]->datatype_specifier = member.variable->datatype_specifier;
  998. member.variable->setter->parameters[0]->set_datatype(member.get_datatype());
  999. }
  1000. resolve_function_body(member.variable->setter);
  1001. }
  1002. }
  1003. } else if (member.type == GDScriptParser::ClassNode::Member::GROUP) {
  1004. // Apply annotation (`@export_{category,group,subgroup}`).
  1005. resolve_annotation(member.annotation);
  1006. member.annotation->apply(parser, nullptr);
  1007. }
  1008. }
  1009. // Check unused variables and datatypes of property getters and setters.
  1010. for (int i = 0; i < p_class->members.size(); i++) {
  1011. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1012. if (member.type == GDScriptParser::ClassNode::Member::VARIABLE) {
  1013. #ifdef DEBUG_ENABLED
  1014. HashSet<GDScriptWarning::Code> previously_ignored_warnings = parser->ignored_warnings;
  1015. for (GDScriptWarning::Code ignored_warning : member.variable->ignored_warnings) {
  1016. parser->ignored_warnings.insert(ignored_warning);
  1017. }
  1018. if (member.variable->usages == 0 && String(member.variable->identifier->name).begins_with("_")) {
  1019. parser->push_warning(member.variable->identifier, GDScriptWarning::UNUSED_PRIVATE_CLASS_VARIABLE, member.variable->identifier->name);
  1020. }
  1021. #endif
  1022. if (member.variable->property == GDScriptParser::VariableNode::PROP_SETGET) {
  1023. GDScriptParser::FunctionNode *getter_function = nullptr;
  1024. GDScriptParser::FunctionNode *setter_function = nullptr;
  1025. bool has_valid_getter = false;
  1026. bool has_valid_setter = false;
  1027. if (member.variable->getter_pointer != nullptr) {
  1028. if (p_class->has_function(member.variable->getter_pointer->name)) {
  1029. getter_function = p_class->get_member(member.variable->getter_pointer->name).function;
  1030. }
  1031. if (getter_function == nullptr) {
  1032. push_error(vformat(R"(Getter "%s" not found.)", member.variable->getter_pointer->name), member.variable);
  1033. } else {
  1034. GDScriptParser::DataType return_datatype = getter_function->datatype;
  1035. if (getter_function->return_type != nullptr) {
  1036. return_datatype = getter_function->return_type->datatype;
  1037. return_datatype.is_meta_type = false;
  1038. }
  1039. if (getter_function->parameters.size() != 0 || return_datatype.has_no_type()) {
  1040. push_error(vformat(R"(Function "%s" cannot be used as getter because of its signature.)", getter_function->identifier->name), member.variable);
  1041. } else if (!is_type_compatible(member.variable->datatype, return_datatype, true)) {
  1042. push_error(vformat(R"(Function with return type "%s" cannot be used as getter for a property of type "%s".)", return_datatype.to_string(), member.variable->datatype.to_string()), member.variable);
  1043. } else {
  1044. has_valid_getter = true;
  1045. #ifdef DEBUG_ENABLED
  1046. if (member.variable->datatype.builtin_type == Variant::INT && return_datatype.builtin_type == Variant::FLOAT) {
  1047. parser->push_warning(member.variable, GDScriptWarning::NARROWING_CONVERSION);
  1048. }
  1049. #endif
  1050. }
  1051. }
  1052. }
  1053. if (member.variable->setter_pointer != nullptr) {
  1054. if (p_class->has_function(member.variable->setter_pointer->name)) {
  1055. setter_function = p_class->get_member(member.variable->setter_pointer->name).function;
  1056. }
  1057. if (setter_function == nullptr) {
  1058. push_error(vformat(R"(Setter "%s" not found.)", member.variable->setter_pointer->name), member.variable);
  1059. } else if (setter_function->parameters.size() != 1) {
  1060. push_error(vformat(R"(Function "%s" cannot be used as setter because of its signature.)", setter_function->identifier->name), member.variable);
  1061. } else if (!is_type_compatible(member.variable->datatype, setter_function->parameters[0]->datatype, true)) {
  1062. push_error(vformat(R"(Function with argument type "%s" cannot be used as setter for a property of type "%s".)", setter_function->parameters[0]->datatype.to_string(), member.variable->datatype.to_string()), member.variable);
  1063. } else {
  1064. has_valid_setter = true;
  1065. #ifdef DEBUG_ENABLED
  1066. if (member.variable->datatype.builtin_type == Variant::FLOAT && setter_function->parameters[0]->datatype.builtin_type == Variant::INT) {
  1067. parser->push_warning(member.variable, GDScriptWarning::NARROWING_CONVERSION);
  1068. }
  1069. #endif
  1070. }
  1071. }
  1072. if (member.variable->datatype.is_variant() && has_valid_getter && has_valid_setter) {
  1073. if (!is_type_compatible(getter_function->datatype, setter_function->parameters[0]->datatype, true)) {
  1074. push_error(vformat(R"(Getter with type "%s" cannot be used along with setter of type "%s".)", getter_function->datatype.to_string(), setter_function->parameters[0]->datatype.to_string()), member.variable);
  1075. }
  1076. }
  1077. #ifdef DEBUG_ENABLED
  1078. parser->ignored_warnings = previously_ignored_warnings;
  1079. #endif // DEBUG_ENABLED
  1080. }
  1081. }
  1082. }
  1083. parser->current_class = previous_class;
  1084. }
  1085. void GDScriptAnalyzer::resolve_class_body(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  1086. resolve_class_body(p_class);
  1087. if (p_recursive) {
  1088. for (int i = 0; i < p_class->members.size(); i++) {
  1089. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1090. if (member.type == GDScriptParser::ClassNode::Member::CLASS) {
  1091. resolve_class_body(member.m_class, true);
  1092. }
  1093. }
  1094. }
  1095. }
  1096. void GDScriptAnalyzer::resolve_node(GDScriptParser::Node *p_node, bool p_is_root) {
  1097. ERR_FAIL_COND_MSG(p_node == nullptr, "Trying to resolve type of a null node.");
  1098. switch (p_node->type) {
  1099. case GDScriptParser::Node::NONE:
  1100. break; // Unreachable.
  1101. case GDScriptParser::Node::CLASS:
  1102. if (OK == resolve_class_inheritance(static_cast<GDScriptParser::ClassNode *>(p_node), true)) {
  1103. resolve_class_interface(static_cast<GDScriptParser::ClassNode *>(p_node), true);
  1104. resolve_class_body(static_cast<GDScriptParser::ClassNode *>(p_node), true);
  1105. }
  1106. break;
  1107. case GDScriptParser::Node::CONSTANT:
  1108. resolve_constant(static_cast<GDScriptParser::ConstantNode *>(p_node), true);
  1109. break;
  1110. case GDScriptParser::Node::FOR:
  1111. resolve_for(static_cast<GDScriptParser::ForNode *>(p_node));
  1112. break;
  1113. case GDScriptParser::Node::IF:
  1114. resolve_if(static_cast<GDScriptParser::IfNode *>(p_node));
  1115. break;
  1116. case GDScriptParser::Node::SUITE:
  1117. resolve_suite(static_cast<GDScriptParser::SuiteNode *>(p_node));
  1118. break;
  1119. case GDScriptParser::Node::VARIABLE:
  1120. resolve_variable(static_cast<GDScriptParser::VariableNode *>(p_node), true);
  1121. break;
  1122. case GDScriptParser::Node::WHILE:
  1123. resolve_while(static_cast<GDScriptParser::WhileNode *>(p_node));
  1124. break;
  1125. case GDScriptParser::Node::ANNOTATION:
  1126. resolve_annotation(static_cast<GDScriptParser::AnnotationNode *>(p_node));
  1127. break;
  1128. case GDScriptParser::Node::ASSERT:
  1129. resolve_assert(static_cast<GDScriptParser::AssertNode *>(p_node));
  1130. break;
  1131. case GDScriptParser::Node::MATCH:
  1132. resolve_match(static_cast<GDScriptParser::MatchNode *>(p_node));
  1133. break;
  1134. case GDScriptParser::Node::MATCH_BRANCH:
  1135. resolve_match_branch(static_cast<GDScriptParser::MatchBranchNode *>(p_node), nullptr);
  1136. break;
  1137. case GDScriptParser::Node::PARAMETER:
  1138. resolve_parameter(static_cast<GDScriptParser::ParameterNode *>(p_node));
  1139. break;
  1140. case GDScriptParser::Node::PATTERN:
  1141. resolve_match_pattern(static_cast<GDScriptParser::PatternNode *>(p_node), nullptr);
  1142. break;
  1143. case GDScriptParser::Node::RETURN:
  1144. resolve_return(static_cast<GDScriptParser::ReturnNode *>(p_node));
  1145. break;
  1146. case GDScriptParser::Node::TYPE:
  1147. resolve_datatype(static_cast<GDScriptParser::TypeNode *>(p_node));
  1148. break;
  1149. // Resolving expression is the same as reducing them.
  1150. case GDScriptParser::Node::ARRAY:
  1151. case GDScriptParser::Node::ASSIGNMENT:
  1152. case GDScriptParser::Node::AWAIT:
  1153. case GDScriptParser::Node::BINARY_OPERATOR:
  1154. case GDScriptParser::Node::CALL:
  1155. case GDScriptParser::Node::CAST:
  1156. case GDScriptParser::Node::DICTIONARY:
  1157. case GDScriptParser::Node::GET_NODE:
  1158. case GDScriptParser::Node::IDENTIFIER:
  1159. case GDScriptParser::Node::LAMBDA:
  1160. case GDScriptParser::Node::LITERAL:
  1161. case GDScriptParser::Node::PRELOAD:
  1162. case GDScriptParser::Node::SELF:
  1163. case GDScriptParser::Node::SUBSCRIPT:
  1164. case GDScriptParser::Node::TERNARY_OPERATOR:
  1165. case GDScriptParser::Node::TYPE_TEST:
  1166. case GDScriptParser::Node::UNARY_OPERATOR:
  1167. reduce_expression(static_cast<GDScriptParser::ExpressionNode *>(p_node), p_is_root);
  1168. break;
  1169. case GDScriptParser::Node::BREAK:
  1170. case GDScriptParser::Node::BREAKPOINT:
  1171. case GDScriptParser::Node::CONTINUE:
  1172. case GDScriptParser::Node::ENUM:
  1173. case GDScriptParser::Node::FUNCTION:
  1174. case GDScriptParser::Node::PASS:
  1175. case GDScriptParser::Node::SIGNAL:
  1176. // Nothing to do.
  1177. break;
  1178. }
  1179. }
  1180. void GDScriptAnalyzer::resolve_annotation(GDScriptParser::AnnotationNode *p_annotation) {
  1181. ERR_FAIL_COND_MSG(!parser->valid_annotations.has(p_annotation->name), vformat(R"(Annotation "%s" not found to validate.)", p_annotation->name));
  1182. if (p_annotation->is_resolved) {
  1183. return;
  1184. }
  1185. p_annotation->is_resolved = true;
  1186. const MethodInfo &annotation_info = parser->valid_annotations[p_annotation->name].info;
  1187. const List<PropertyInfo>::Element *E = annotation_info.arguments.front();
  1188. for (int i = 0; i < p_annotation->arguments.size(); i++) {
  1189. GDScriptParser::ExpressionNode *argument = p_annotation->arguments[i];
  1190. const PropertyInfo &argument_info = E->get();
  1191. if (E->next() != nullptr) {
  1192. E = E->next();
  1193. }
  1194. reduce_expression(argument);
  1195. if (!argument->is_constant) {
  1196. push_error(vformat(R"(Argument %d of annotation "%s" isn't a constant expression.)", i + 1, p_annotation->name), argument);
  1197. return;
  1198. }
  1199. Variant value = argument->reduced_value;
  1200. if (value.get_type() != argument_info.type) {
  1201. #ifdef DEBUG_ENABLED
  1202. if (argument_info.type == Variant::INT && value.get_type() == Variant::FLOAT) {
  1203. parser->push_warning(argument, GDScriptWarning::NARROWING_CONVERSION);
  1204. }
  1205. #endif
  1206. if (!Variant::can_convert_strict(value.get_type(), argument_info.type)) {
  1207. push_error(vformat(R"(Invalid argument for annotation "%s": argument %d should be "%s" but is "%s".)", p_annotation->name, i + 1, Variant::get_type_name(argument_info.type), argument->get_datatype().to_string()), argument);
  1208. return;
  1209. }
  1210. Variant converted_to;
  1211. const Variant *converted_from = &value;
  1212. Callable::CallError call_error;
  1213. Variant::construct(argument_info.type, converted_to, &converted_from, 1, call_error);
  1214. if (call_error.error != Callable::CallError::CALL_OK) {
  1215. push_error(vformat(R"(Cannot convert argument %d of annotation "%s" from "%s" to "%s".)", i + 1, p_annotation->name, Variant::get_type_name(value.get_type()), Variant::get_type_name(argument_info.type)), argument);
  1216. return;
  1217. }
  1218. value = converted_to;
  1219. }
  1220. p_annotation->resolved_arguments.push_back(value);
  1221. }
  1222. }
  1223. void GDScriptAnalyzer::resolve_function_signature(GDScriptParser::FunctionNode *p_function, const GDScriptParser::Node *p_source, bool p_is_lambda) {
  1224. if (p_source == nullptr) {
  1225. p_source = p_function;
  1226. }
  1227. StringName function_name = p_function->identifier != nullptr ? p_function->identifier->name : StringName();
  1228. if (p_function->get_datatype().is_resolving()) {
  1229. push_error(vformat(R"(Could not resolve function "%s": Cyclic reference.)", function_name), p_source);
  1230. return;
  1231. }
  1232. if (p_function->resolved_signature) {
  1233. return;
  1234. }
  1235. p_function->resolved_signature = true;
  1236. #ifdef DEBUG_ENABLED
  1237. HashSet<GDScriptWarning::Code> previously_ignored_warnings = parser->ignored_warnings;
  1238. for (GDScriptWarning::Code ignored_warning : p_function->ignored_warnings) {
  1239. parser->ignored_warnings.insert(ignored_warning);
  1240. }
  1241. #endif
  1242. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  1243. parser->current_function = p_function;
  1244. GDScriptParser::DataType prev_datatype = p_function->get_datatype();
  1245. GDScriptParser::DataType resolving_datatype;
  1246. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  1247. p_function->set_datatype(resolving_datatype);
  1248. #ifdef TOOLS_ENABLED
  1249. int default_value_count = 0;
  1250. #endif // TOOLS_ENABLED
  1251. for (int i = 0; i < p_function->parameters.size(); i++) {
  1252. resolve_parameter(p_function->parameters[i]);
  1253. #ifdef DEBUG_ENABLED
  1254. if (p_function->parameters[i]->usages == 0 && !String(p_function->parameters[i]->identifier->name).begins_with("_")) {
  1255. parser->push_warning(p_function->parameters[i]->identifier, GDScriptWarning::UNUSED_PARAMETER, function_name, p_function->parameters[i]->identifier->name);
  1256. }
  1257. is_shadowing(p_function->parameters[i]->identifier, "function parameter");
  1258. #endif // DEBUG_ENABLED
  1259. #ifdef TOOLS_ENABLED
  1260. if (p_function->parameters[i]->initializer) {
  1261. default_value_count++;
  1262. if (p_function->parameters[i]->initializer->is_constant) {
  1263. p_function->default_arg_values.push_back(p_function->parameters[i]->initializer->reduced_value);
  1264. } else {
  1265. p_function->default_arg_values.push_back(Variant()); // Prevent shift.
  1266. }
  1267. }
  1268. #endif // TOOLS_ENABLED
  1269. }
  1270. if (!p_is_lambda && function_name == GDScriptLanguage::get_singleton()->strings._init) {
  1271. // Constructor.
  1272. GDScriptParser::DataType return_type = parser->current_class->get_datatype();
  1273. return_type.is_meta_type = false;
  1274. p_function->set_datatype(return_type);
  1275. if (p_function->return_type) {
  1276. GDScriptParser::DataType declared_return = resolve_datatype(p_function->return_type);
  1277. if (declared_return.kind != GDScriptParser::DataType::BUILTIN || declared_return.builtin_type != Variant::NIL) {
  1278. push_error("Constructor cannot have an explicit return type.", p_function->return_type);
  1279. }
  1280. }
  1281. } else {
  1282. if (p_function->return_type != nullptr) {
  1283. p_function->set_datatype(type_from_metatype(resolve_datatype(p_function->return_type)));
  1284. } else {
  1285. // In case the function is not typed, we can safely assume it's a Variant, so it's okay to mark as "inferred" here.
  1286. // It's not "undetected" to not mix up with unknown functions.
  1287. GDScriptParser::DataType return_type;
  1288. return_type.type_source = GDScriptParser::DataType::INFERRED;
  1289. return_type.kind = GDScriptParser::DataType::VARIANT;
  1290. p_function->set_datatype(return_type);
  1291. }
  1292. #ifdef TOOLS_ENABLED
  1293. // Check if the function signature matches the parent. If not it's an error since it breaks polymorphism.
  1294. // Not for the constructor which can vary in signature.
  1295. GDScriptParser::DataType base_type = parser->current_class->base_type;
  1296. GDScriptParser::DataType parent_return_type;
  1297. List<GDScriptParser::DataType> parameters_types;
  1298. int default_par_count = 0;
  1299. bool is_static = false;
  1300. bool is_vararg = false;
  1301. StringName native_base;
  1302. if (!p_is_lambda && get_function_signature(p_function, false, base_type, function_name, parent_return_type, parameters_types, default_par_count, is_static, is_vararg, &native_base)) {
  1303. bool valid = p_function->is_static == is_static;
  1304. valid = valid && parent_return_type == p_function->get_datatype();
  1305. int par_count_diff = p_function->parameters.size() - parameters_types.size();
  1306. valid = valid && par_count_diff >= 0;
  1307. valid = valid && default_value_count >= default_par_count + par_count_diff;
  1308. int i = 0;
  1309. for (const GDScriptParser::DataType &par_type : parameters_types) {
  1310. valid = valid && par_type == p_function->parameters[i++]->get_datatype();
  1311. }
  1312. if (!valid) {
  1313. // Compute parent signature as a string to show in the error message.
  1314. String parent_signature = String(function_name) + "(";
  1315. int j = 0;
  1316. for (const GDScriptParser::DataType &par_type : parameters_types) {
  1317. if (j > 0) {
  1318. parent_signature += ", ";
  1319. }
  1320. String parameter = par_type.to_string();
  1321. if (parameter == "null") {
  1322. parameter = "Variant";
  1323. }
  1324. parent_signature += parameter;
  1325. if (j >= parameters_types.size() - default_par_count) {
  1326. parent_signature += " = <default>";
  1327. }
  1328. j++;
  1329. }
  1330. parent_signature += ") -> ";
  1331. const String return_type = parent_return_type.is_hard_type() ? parent_return_type.to_string() : "Variant";
  1332. if (return_type == "null") {
  1333. parent_signature += "void";
  1334. } else {
  1335. parent_signature += return_type;
  1336. }
  1337. push_error(vformat(R"(The function signature doesn't match the parent. Parent signature is "%s".)", parent_signature), p_function);
  1338. }
  1339. #ifdef DEBUG_ENABLED
  1340. if (native_base != StringName()) {
  1341. parser->push_warning(p_function, GDScriptWarning::NATIVE_METHOD_OVERRIDE, function_name, native_base);
  1342. }
  1343. #endif
  1344. }
  1345. #endif // TOOLS_ENABLED
  1346. }
  1347. if (p_function->get_datatype().is_resolving()) {
  1348. p_function->set_datatype(prev_datatype);
  1349. }
  1350. #ifdef DEBUG_ENABLED
  1351. parser->ignored_warnings = previously_ignored_warnings;
  1352. #endif
  1353. parser->current_function = previous_function;
  1354. }
  1355. void GDScriptAnalyzer::resolve_function_body(GDScriptParser::FunctionNode *p_function, bool p_is_lambda) {
  1356. if (p_function->resolved_body) {
  1357. return;
  1358. }
  1359. p_function->resolved_body = true;
  1360. #ifdef DEBUG_ENABLED
  1361. HashSet<GDScriptWarning::Code> previously_ignored_warnings = parser->ignored_warnings;
  1362. for (GDScriptWarning::Code ignored_warning : p_function->ignored_warnings) {
  1363. parser->ignored_warnings.insert(ignored_warning);
  1364. }
  1365. #endif
  1366. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  1367. parser->current_function = p_function;
  1368. resolve_suite(p_function->body);
  1369. if (!p_function->get_datatype().is_hard_type() && p_function->body->get_datatype().is_set()) {
  1370. // Use the suite inferred type if return isn't explicitly set.
  1371. p_function->set_datatype(p_function->body->get_datatype());
  1372. } else if (p_function->get_datatype().is_hard_type() && (p_function->get_datatype().kind != GDScriptParser::DataType::BUILTIN || p_function->get_datatype().builtin_type != Variant::NIL)) {
  1373. if (!p_function->body->has_return && (p_is_lambda || p_function->identifier->name != GDScriptLanguage::get_singleton()->strings._init)) {
  1374. push_error(R"(Not all code paths return a value.)", p_function);
  1375. }
  1376. }
  1377. #ifdef DEBUG_ENABLED
  1378. parser->ignored_warnings = previously_ignored_warnings;
  1379. #endif
  1380. parser->current_function = previous_function;
  1381. }
  1382. void GDScriptAnalyzer::decide_suite_type(GDScriptParser::Node *p_suite, GDScriptParser::Node *p_statement) {
  1383. if (p_statement == nullptr) {
  1384. return;
  1385. }
  1386. switch (p_statement->type) {
  1387. case GDScriptParser::Node::IF:
  1388. case GDScriptParser::Node::FOR:
  1389. case GDScriptParser::Node::MATCH:
  1390. case GDScriptParser::Node::PATTERN:
  1391. case GDScriptParser::Node::RETURN:
  1392. case GDScriptParser::Node::WHILE:
  1393. // Use return or nested suite type as this suite type.
  1394. if (p_suite->get_datatype().is_set() && (p_suite->get_datatype() != p_statement->get_datatype())) {
  1395. // Mixed types.
  1396. // TODO: This could use the common supertype instead.
  1397. p_suite->datatype.kind = GDScriptParser::DataType::VARIANT;
  1398. p_suite->datatype.type_source = GDScriptParser::DataType::UNDETECTED;
  1399. } else {
  1400. p_suite->set_datatype(p_statement->get_datatype());
  1401. p_suite->datatype.type_source = GDScriptParser::DataType::INFERRED;
  1402. }
  1403. break;
  1404. default:
  1405. break;
  1406. }
  1407. }
  1408. void GDScriptAnalyzer::resolve_suite(GDScriptParser::SuiteNode *p_suite) {
  1409. for (int i = 0; i < p_suite->statements.size(); i++) {
  1410. GDScriptParser::Node *stmt = p_suite->statements[i];
  1411. // Apply annotations.
  1412. for (GDScriptParser::AnnotationNode *&E : stmt->annotations) {
  1413. resolve_annotation(E);
  1414. E->apply(parser, stmt);
  1415. }
  1416. #ifdef DEBUG_ENABLED
  1417. HashSet<GDScriptWarning::Code> previously_ignored_warnings = parser->ignored_warnings;
  1418. for (GDScriptWarning::Code ignored_warning : stmt->ignored_warnings) {
  1419. parser->ignored_warnings.insert(ignored_warning);
  1420. }
  1421. #endif // DEBUG_ENABLED
  1422. resolve_node(stmt);
  1423. #ifdef DEBUG_ENABLED
  1424. parser->ignored_warnings = previously_ignored_warnings;
  1425. #endif // DEBUG_ENABLED
  1426. decide_suite_type(p_suite, stmt);
  1427. }
  1428. }
  1429. void GDScriptAnalyzer::resolve_assignable(GDScriptParser::AssignableNode *p_assignable, const char *p_kind) {
  1430. GDScriptParser::DataType type;
  1431. type.kind = GDScriptParser::DataType::VARIANT;
  1432. bool is_constant = p_assignable->type == GDScriptParser::Node::CONSTANT;
  1433. GDScriptParser::DataType specified_type;
  1434. bool has_specified_type = p_assignable->datatype_specifier != nullptr;
  1435. if (has_specified_type) {
  1436. specified_type = type_from_metatype(resolve_datatype(p_assignable->datatype_specifier));
  1437. type = specified_type;
  1438. }
  1439. if (p_assignable->initializer != nullptr) {
  1440. reduce_expression(p_assignable->initializer);
  1441. if (p_assignable->initializer->type == GDScriptParser::Node::ARRAY) {
  1442. GDScriptParser::ArrayNode *array = static_cast<GDScriptParser::ArrayNode *>(p_assignable->initializer);
  1443. if (has_specified_type && specified_type.has_container_element_type()) {
  1444. update_array_literal_element_type(array, specified_type.get_container_element_type());
  1445. }
  1446. }
  1447. if (is_constant && !p_assignable->initializer->is_constant) {
  1448. bool is_initializer_value_reduced = false;
  1449. Variant initializer_value = make_expression_reduced_value(p_assignable->initializer, is_initializer_value_reduced);
  1450. if (is_initializer_value_reduced) {
  1451. p_assignable->initializer->is_constant = true;
  1452. p_assignable->initializer->reduced_value = initializer_value;
  1453. } else {
  1454. push_error(vformat(R"(Assigned value for %s "%s" isn't a constant expression.)", p_kind, p_assignable->identifier->name), p_assignable->initializer);
  1455. }
  1456. }
  1457. if (has_specified_type && p_assignable->initializer->is_constant) {
  1458. update_const_expression_builtin_type(p_assignable->initializer, specified_type, "assign");
  1459. }
  1460. GDScriptParser::DataType initializer_type = p_assignable->initializer->get_datatype();
  1461. if (p_assignable->infer_datatype) {
  1462. if (!initializer_type.is_set() || initializer_type.has_no_type() || !initializer_type.is_hard_type()) {
  1463. push_error(vformat(R"(Cannot infer the type of "%s" %s because the value doesn't have a set type.)", p_assignable->identifier->name, p_kind), p_assignable->initializer);
  1464. } else if (initializer_type.kind == GDScriptParser::DataType::BUILTIN && initializer_type.builtin_type == Variant::NIL && !is_constant) {
  1465. push_error(vformat(R"(Cannot infer the type of "%s" %s because the value is "null".)", p_assignable->identifier->name, p_kind), p_assignable->initializer);
  1466. }
  1467. #ifdef DEBUG_ENABLED
  1468. if (initializer_type.is_hard_type() && initializer_type.is_variant()) {
  1469. parser->push_warning(p_assignable, GDScriptWarning::INFERENCE_ON_VARIANT, p_kind);
  1470. }
  1471. #endif
  1472. } else {
  1473. if (!initializer_type.is_set()) {
  1474. push_error(vformat(R"(Could not resolve type for %s "%s".)", p_kind, p_assignable->identifier->name), p_assignable->initializer);
  1475. }
  1476. }
  1477. if (!has_specified_type) {
  1478. type = initializer_type;
  1479. if (!type.is_set() || (type.is_hard_type() && type.kind == GDScriptParser::DataType::BUILTIN && type.builtin_type == Variant::NIL && !is_constant)) {
  1480. type.kind = GDScriptParser::DataType::VARIANT;
  1481. }
  1482. if (p_assignable->infer_datatype || is_constant) {
  1483. type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1484. } else {
  1485. type.type_source = GDScriptParser::DataType::INFERRED;
  1486. }
  1487. } else if (!specified_type.is_variant()) {
  1488. if (initializer_type.is_variant() || !initializer_type.is_hard_type()) {
  1489. mark_node_unsafe(p_assignable->initializer);
  1490. p_assignable->use_conversion_assign = true;
  1491. if (!initializer_type.is_variant() && !is_type_compatible(specified_type, initializer_type, true, p_assignable->initializer)) {
  1492. downgrade_node_type_source(p_assignable->initializer);
  1493. }
  1494. } else if (!is_type_compatible(specified_type, initializer_type, true, p_assignable->initializer)) {
  1495. if (!is_constant && is_type_compatible(initializer_type, specified_type)) {
  1496. mark_node_unsafe(p_assignable->initializer);
  1497. p_assignable->use_conversion_assign = true;
  1498. } else {
  1499. push_error(vformat(R"(Cannot assign a value of type %s to %s "%s" with specified type %s.)", initializer_type.to_string(), p_kind, p_assignable->identifier->name, specified_type.to_string()), p_assignable->initializer);
  1500. }
  1501. } else if (specified_type.has_container_element_type() && !initializer_type.has_container_element_type()) {
  1502. mark_node_unsafe(p_assignable->initializer);
  1503. #ifdef DEBUG_ENABLED
  1504. } else if (specified_type.builtin_type == Variant::INT && initializer_type.builtin_type == Variant::FLOAT) {
  1505. parser->push_warning(p_assignable->initializer, GDScriptWarning::NARROWING_CONVERSION);
  1506. #endif
  1507. }
  1508. }
  1509. }
  1510. type.is_constant = is_constant;
  1511. type.is_read_only = false;
  1512. p_assignable->set_datatype(type);
  1513. }
  1514. void GDScriptAnalyzer::resolve_variable(GDScriptParser::VariableNode *p_variable, bool p_is_local) {
  1515. static constexpr const char *kind = "variable";
  1516. resolve_assignable(p_variable, kind);
  1517. #ifdef DEBUG_ENABLED
  1518. if (p_is_local) {
  1519. if (p_variable->usages == 0 && !String(p_variable->identifier->name).begins_with("_")) {
  1520. parser->push_warning(p_variable, GDScriptWarning::UNUSED_VARIABLE, p_variable->identifier->name);
  1521. } else if (p_variable->assignments == 0) {
  1522. parser->push_warning(p_variable, GDScriptWarning::UNASSIGNED_VARIABLE, p_variable->identifier->name);
  1523. }
  1524. is_shadowing(p_variable->identifier, kind);
  1525. }
  1526. #endif
  1527. }
  1528. void GDScriptAnalyzer::resolve_constant(GDScriptParser::ConstantNode *p_constant, bool p_is_local) {
  1529. static constexpr const char *kind = "constant";
  1530. resolve_assignable(p_constant, kind);
  1531. #ifdef DEBUG_ENABLED
  1532. if (p_is_local) {
  1533. if (p_constant->usages == 0) {
  1534. parser->push_warning(p_constant, GDScriptWarning::UNUSED_LOCAL_CONSTANT, p_constant->identifier->name);
  1535. }
  1536. is_shadowing(p_constant->identifier, kind);
  1537. }
  1538. #endif
  1539. }
  1540. void GDScriptAnalyzer::resolve_parameter(GDScriptParser::ParameterNode *p_parameter) {
  1541. static constexpr const char *kind = "parameter";
  1542. resolve_assignable(p_parameter, kind);
  1543. }
  1544. void GDScriptAnalyzer::resolve_if(GDScriptParser::IfNode *p_if) {
  1545. reduce_expression(p_if->condition);
  1546. resolve_suite(p_if->true_block);
  1547. p_if->set_datatype(p_if->true_block->get_datatype());
  1548. if (p_if->false_block != nullptr) {
  1549. resolve_suite(p_if->false_block);
  1550. decide_suite_type(p_if, p_if->false_block);
  1551. }
  1552. }
  1553. void GDScriptAnalyzer::resolve_for(GDScriptParser::ForNode *p_for) {
  1554. bool list_resolved = false;
  1555. // Optimize constant range() call to not allocate an array.
  1556. // Use int, Vector2i, Vector3i instead, which also can be used as range iterators.
  1557. if (p_for->list && p_for->list->type == GDScriptParser::Node::CALL) {
  1558. GDScriptParser::CallNode *call = static_cast<GDScriptParser::CallNode *>(p_for->list);
  1559. GDScriptParser::Node::Type callee_type = call->get_callee_type();
  1560. if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  1561. GDScriptParser::IdentifierNode *callee = static_cast<GDScriptParser::IdentifierNode *>(call->callee);
  1562. if (callee->name == "range") {
  1563. list_resolved = true;
  1564. if (call->arguments.size() < 1) {
  1565. push_error(R"*(Invalid call for "range()" function. Expected at least 1 argument, none given.)*", call->callee);
  1566. } else if (call->arguments.size() > 3) {
  1567. push_error(vformat(R"*(Invalid call for "range()" function. Expected at most 3 arguments, %d given.)*", call->arguments.size()), call->callee);
  1568. } else {
  1569. // Now we can optimize it.
  1570. bool all_is_constant = true;
  1571. Vector<Variant> args;
  1572. args.resize(call->arguments.size());
  1573. for (int i = 0; i < call->arguments.size(); i++) {
  1574. reduce_expression(call->arguments[i]);
  1575. if (!call->arguments[i]->is_constant) {
  1576. all_is_constant = false;
  1577. } else if (all_is_constant) {
  1578. args.write[i] = call->arguments[i]->reduced_value;
  1579. }
  1580. GDScriptParser::DataType arg_type = call->arguments[i]->get_datatype();
  1581. if (!arg_type.is_variant()) {
  1582. if (arg_type.kind != GDScriptParser::DataType::BUILTIN) {
  1583. all_is_constant = false;
  1584. push_error(vformat(R"*(Invalid argument for "range()" call. Argument %d should be int or float but "%s" was given.)*", i + 1, arg_type.to_string()), call->arguments[i]);
  1585. } else if (arg_type.builtin_type != Variant::INT && arg_type.builtin_type != Variant::FLOAT) {
  1586. all_is_constant = false;
  1587. push_error(vformat(R"*(Invalid argument for "range()" call. Argument %d should be int or float but "%s" was given.)*", i + 1, arg_type.to_string()), call->arguments[i]);
  1588. }
  1589. }
  1590. }
  1591. Variant reduced;
  1592. if (all_is_constant) {
  1593. switch (args.size()) {
  1594. case 1:
  1595. reduced = (int32_t)args[0];
  1596. break;
  1597. case 2:
  1598. reduced = Vector2i(args[0], args[1]);
  1599. break;
  1600. case 3:
  1601. reduced = Vector3i(args[0], args[1], args[2]);
  1602. break;
  1603. }
  1604. p_for->list->is_constant = true;
  1605. p_for->list->reduced_value = reduced;
  1606. }
  1607. }
  1608. if (p_for->list->is_constant) {
  1609. p_for->list->set_datatype(type_from_variant(p_for->list->reduced_value, p_for->list));
  1610. } else {
  1611. GDScriptParser::DataType list_type;
  1612. list_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1613. list_type.kind = GDScriptParser::DataType::BUILTIN;
  1614. list_type.builtin_type = Variant::ARRAY;
  1615. p_for->list->set_datatype(list_type);
  1616. }
  1617. }
  1618. }
  1619. }
  1620. GDScriptParser::DataType variable_type;
  1621. if (list_resolved) {
  1622. variable_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1623. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1624. variable_type.builtin_type = Variant::INT;
  1625. } else if (p_for->list) {
  1626. resolve_node(p_for->list, false);
  1627. GDScriptParser::DataType list_type = p_for->list->get_datatype();
  1628. if (!list_type.is_hard_type()) {
  1629. mark_node_unsafe(p_for->list);
  1630. }
  1631. if (list_type.is_variant()) {
  1632. variable_type.kind = GDScriptParser::DataType::VARIANT;
  1633. mark_node_unsafe(p_for->list);
  1634. } else if (list_type.has_container_element_type()) {
  1635. variable_type = list_type.get_container_element_type();
  1636. variable_type.type_source = list_type.type_source;
  1637. } else if (list_type.is_typed_container_type()) {
  1638. variable_type = list_type.get_typed_container_type();
  1639. variable_type.type_source = list_type.type_source;
  1640. } else if (list_type.builtin_type == Variant::INT || list_type.builtin_type == Variant::FLOAT || list_type.builtin_type == Variant::STRING) {
  1641. variable_type.type_source = list_type.type_source;
  1642. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1643. variable_type.builtin_type = list_type.builtin_type;
  1644. } else if (list_type.builtin_type == Variant::VECTOR2I || list_type.builtin_type == Variant::VECTOR3I) {
  1645. variable_type.type_source = list_type.type_source;
  1646. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1647. variable_type.builtin_type = Variant::INT;
  1648. } else if (list_type.builtin_type == Variant::VECTOR2 || list_type.builtin_type == Variant::VECTOR3) {
  1649. variable_type.type_source = list_type.type_source;
  1650. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1651. variable_type.builtin_type = Variant::FLOAT;
  1652. } else if (list_type.builtin_type == Variant::OBJECT) {
  1653. GDScriptParser::DataType return_type;
  1654. List<GDScriptParser::DataType> par_types;
  1655. int default_arg_count = 0;
  1656. bool is_static = false;
  1657. bool is_vararg = false;
  1658. if (get_function_signature(p_for->list, false, list_type, CoreStringNames::get_singleton()->_iter_get, return_type, par_types, default_arg_count, is_static, is_vararg)) {
  1659. variable_type = return_type;
  1660. variable_type.type_source = list_type.type_source;
  1661. } else if (!list_type.is_hard_type()) {
  1662. variable_type.kind = GDScriptParser::DataType::VARIANT;
  1663. } else {
  1664. push_error(vformat(R"(Unable to iterate on object of type "%s".)", list_type.to_string()), p_for->list);
  1665. }
  1666. } else if (list_type.builtin_type == Variant::ARRAY || list_type.builtin_type == Variant::DICTIONARY || !list_type.is_hard_type()) {
  1667. variable_type.kind = GDScriptParser::DataType::VARIANT;
  1668. } else {
  1669. push_error(vformat(R"(Unable to iterate on value of type "%s".)", list_type.to_string()), p_for->list);
  1670. }
  1671. }
  1672. if (p_for->variable) {
  1673. p_for->variable->set_datatype(variable_type);
  1674. }
  1675. resolve_suite(p_for->loop);
  1676. p_for->set_datatype(p_for->loop->get_datatype());
  1677. #ifdef DEBUG_ENABLED
  1678. if (p_for->variable) {
  1679. is_shadowing(p_for->variable, R"("for" iterator variable)");
  1680. }
  1681. #endif
  1682. }
  1683. void GDScriptAnalyzer::resolve_while(GDScriptParser::WhileNode *p_while) {
  1684. resolve_node(p_while->condition, false);
  1685. resolve_suite(p_while->loop);
  1686. p_while->set_datatype(p_while->loop->get_datatype());
  1687. }
  1688. void GDScriptAnalyzer::resolve_assert(GDScriptParser::AssertNode *p_assert) {
  1689. reduce_expression(p_assert->condition);
  1690. if (p_assert->message != nullptr) {
  1691. reduce_expression(p_assert->message);
  1692. if (!p_assert->message->get_datatype().has_no_type() && (p_assert->message->get_datatype().kind != GDScriptParser::DataType::BUILTIN || p_assert->message->get_datatype().builtin_type != Variant::STRING)) {
  1693. push_error(R"(Expected string for assert error message.)", p_assert->message);
  1694. }
  1695. }
  1696. p_assert->set_datatype(p_assert->condition->get_datatype());
  1697. #ifdef DEBUG_ENABLED
  1698. if (p_assert->condition->is_constant) {
  1699. if (p_assert->condition->reduced_value.booleanize()) {
  1700. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_TRUE);
  1701. } else {
  1702. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_FALSE);
  1703. }
  1704. }
  1705. #endif
  1706. }
  1707. void GDScriptAnalyzer::resolve_match(GDScriptParser::MatchNode *p_match) {
  1708. reduce_expression(p_match->test);
  1709. for (int i = 0; i < p_match->branches.size(); i++) {
  1710. resolve_match_branch(p_match->branches[i], p_match->test);
  1711. decide_suite_type(p_match, p_match->branches[i]);
  1712. }
  1713. }
  1714. void GDScriptAnalyzer::resolve_match_branch(GDScriptParser::MatchBranchNode *p_match_branch, GDScriptParser::ExpressionNode *p_match_test) {
  1715. for (int i = 0; i < p_match_branch->patterns.size(); i++) {
  1716. resolve_match_pattern(p_match_branch->patterns[i], p_match_test);
  1717. }
  1718. resolve_suite(p_match_branch->block);
  1719. decide_suite_type(p_match_branch, p_match_branch->block);
  1720. }
  1721. void GDScriptAnalyzer::resolve_match_pattern(GDScriptParser::PatternNode *p_match_pattern, GDScriptParser::ExpressionNode *p_match_test) {
  1722. if (p_match_pattern == nullptr) {
  1723. return;
  1724. }
  1725. GDScriptParser::DataType result;
  1726. switch (p_match_pattern->pattern_type) {
  1727. case GDScriptParser::PatternNode::PT_LITERAL:
  1728. if (p_match_pattern->literal) {
  1729. reduce_literal(p_match_pattern->literal);
  1730. result = p_match_pattern->literal->get_datatype();
  1731. }
  1732. break;
  1733. case GDScriptParser::PatternNode::PT_EXPRESSION:
  1734. if (p_match_pattern->expression) {
  1735. GDScriptParser::ExpressionNode *expr = p_match_pattern->expression;
  1736. reduce_expression(expr);
  1737. result = expr->get_datatype();
  1738. if (!expr->is_constant) {
  1739. while (expr && expr->type == GDScriptParser::Node::SUBSCRIPT) {
  1740. GDScriptParser::SubscriptNode *sub = static_cast<GDScriptParser::SubscriptNode *>(expr);
  1741. if (!sub->is_attribute) {
  1742. expr = nullptr;
  1743. } else {
  1744. expr = sub->base;
  1745. }
  1746. }
  1747. if (!expr || expr->type != GDScriptParser::Node::IDENTIFIER) {
  1748. push_error(R"(Expression in match pattern must be a constant expression, an identifier, or an attribute access ("A.B").)", expr);
  1749. }
  1750. }
  1751. }
  1752. break;
  1753. case GDScriptParser::PatternNode::PT_BIND:
  1754. if (p_match_test != nullptr) {
  1755. result = p_match_test->get_datatype();
  1756. } else {
  1757. result.kind = GDScriptParser::DataType::VARIANT;
  1758. }
  1759. p_match_pattern->bind->set_datatype(result);
  1760. #ifdef DEBUG_ENABLED
  1761. is_shadowing(p_match_pattern->bind, "pattern bind");
  1762. if (p_match_pattern->bind->usages == 0 && !String(p_match_pattern->bind->name).begins_with("_")) {
  1763. parser->push_warning(p_match_pattern->bind, GDScriptWarning::UNUSED_VARIABLE, p_match_pattern->bind->name);
  1764. }
  1765. #endif
  1766. break;
  1767. case GDScriptParser::PatternNode::PT_ARRAY:
  1768. for (int i = 0; i < p_match_pattern->array.size(); i++) {
  1769. resolve_match_pattern(p_match_pattern->array[i], nullptr);
  1770. decide_suite_type(p_match_pattern, p_match_pattern->array[i]);
  1771. }
  1772. result = p_match_pattern->get_datatype();
  1773. break;
  1774. case GDScriptParser::PatternNode::PT_DICTIONARY:
  1775. for (int i = 0; i < p_match_pattern->dictionary.size(); i++) {
  1776. if (p_match_pattern->dictionary[i].key) {
  1777. reduce_expression(p_match_pattern->dictionary[i].key);
  1778. if (!p_match_pattern->dictionary[i].key->is_constant) {
  1779. push_error(R"(Expression in dictionary pattern key must be a constant.)", p_match_pattern->dictionary[i].key);
  1780. }
  1781. }
  1782. if (p_match_pattern->dictionary[i].value_pattern) {
  1783. resolve_match_pattern(p_match_pattern->dictionary[i].value_pattern, nullptr);
  1784. decide_suite_type(p_match_pattern, p_match_pattern->dictionary[i].value_pattern);
  1785. }
  1786. }
  1787. result = p_match_pattern->get_datatype();
  1788. break;
  1789. case GDScriptParser::PatternNode::PT_WILDCARD:
  1790. case GDScriptParser::PatternNode::PT_REST:
  1791. result.kind = GDScriptParser::DataType::VARIANT;
  1792. break;
  1793. }
  1794. p_match_pattern->set_datatype(result);
  1795. }
  1796. void GDScriptAnalyzer::resolve_return(GDScriptParser::ReturnNode *p_return) {
  1797. GDScriptParser::DataType result;
  1798. GDScriptParser::DataType expected_type;
  1799. bool has_expected_type = parser->current_function != nullptr;
  1800. if (has_expected_type) {
  1801. expected_type = parser->current_function->get_datatype();
  1802. }
  1803. if (p_return->return_value != nullptr) {
  1804. bool is_void_function = has_expected_type && expected_type.is_hard_type() && expected_type.kind == GDScriptParser::DataType::BUILTIN && expected_type.builtin_type == Variant::NIL;
  1805. bool is_call = p_return->return_value->type == GDScriptParser::Node::CALL;
  1806. if (is_void_function && is_call) {
  1807. // Pretend the call is a root expression to allow those that are "void".
  1808. reduce_call(static_cast<GDScriptParser::CallNode *>(p_return->return_value), false, true);
  1809. } else {
  1810. reduce_expression(p_return->return_value);
  1811. }
  1812. if (is_void_function) {
  1813. p_return->void_return = true;
  1814. const GDScriptParser::DataType &return_type = p_return->return_value->datatype;
  1815. if (is_call && !return_type.is_hard_type()) {
  1816. String function_name = parser->current_function->identifier ? parser->current_function->identifier->name.operator String() : String("<anonymous function>");
  1817. String called_function_name = static_cast<GDScriptParser::CallNode *>(p_return->return_value)->function_name.operator String();
  1818. #ifdef DEBUG_ENABLED
  1819. parser->push_warning(p_return, GDScriptWarning::UNSAFE_VOID_RETURN, function_name, called_function_name);
  1820. #endif
  1821. mark_node_unsafe(p_return);
  1822. } else if (!is_call) {
  1823. push_error("A void function cannot return a value.", p_return);
  1824. }
  1825. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1826. result.kind = GDScriptParser::DataType::BUILTIN;
  1827. result.builtin_type = Variant::NIL;
  1828. result.is_constant = true;
  1829. } else {
  1830. if (p_return->return_value->type == GDScriptParser::Node::ARRAY && has_expected_type && expected_type.has_container_element_type()) {
  1831. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_return->return_value), expected_type.get_container_element_type());
  1832. }
  1833. if (has_expected_type && expected_type.is_hard_type() && p_return->return_value->is_constant) {
  1834. update_const_expression_builtin_type(p_return->return_value, expected_type, "return");
  1835. }
  1836. result = p_return->return_value->get_datatype();
  1837. }
  1838. } else {
  1839. // Return type is null by default.
  1840. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1841. result.kind = GDScriptParser::DataType::BUILTIN;
  1842. result.builtin_type = Variant::NIL;
  1843. result.is_constant = true;
  1844. }
  1845. if (has_expected_type && !expected_type.is_variant()) {
  1846. if (result.is_variant() || !result.is_hard_type()) {
  1847. mark_node_unsafe(p_return);
  1848. if (!is_type_compatible(expected_type, result, true, p_return)) {
  1849. downgrade_node_type_source(p_return);
  1850. }
  1851. } else if (!is_type_compatible(expected_type, result, true, p_return)) {
  1852. mark_node_unsafe(p_return);
  1853. if (!is_type_compatible(result, expected_type)) {
  1854. push_error(vformat(R"(Cannot return value of type "%s" because the function return type is "%s".)", result.to_string(), expected_type.to_string()), p_return);
  1855. }
  1856. #ifdef DEBUG_ENABLED
  1857. } else if (expected_type.builtin_type == Variant::INT && result.builtin_type == Variant::FLOAT) {
  1858. parser->push_warning(p_return, GDScriptWarning::NARROWING_CONVERSION);
  1859. #endif
  1860. }
  1861. }
  1862. p_return->set_datatype(result);
  1863. }
  1864. void GDScriptAnalyzer::reduce_expression(GDScriptParser::ExpressionNode *p_expression, bool p_is_root) {
  1865. // This one makes some magic happen.
  1866. if (p_expression == nullptr) {
  1867. return;
  1868. }
  1869. if (p_expression->reduced) {
  1870. // Don't do this more than once.
  1871. return;
  1872. }
  1873. p_expression->reduced = true;
  1874. switch (p_expression->type) {
  1875. case GDScriptParser::Node::ARRAY:
  1876. reduce_array(static_cast<GDScriptParser::ArrayNode *>(p_expression));
  1877. break;
  1878. case GDScriptParser::Node::ASSIGNMENT:
  1879. reduce_assignment(static_cast<GDScriptParser::AssignmentNode *>(p_expression));
  1880. break;
  1881. case GDScriptParser::Node::AWAIT:
  1882. reduce_await(static_cast<GDScriptParser::AwaitNode *>(p_expression));
  1883. break;
  1884. case GDScriptParser::Node::BINARY_OPERATOR:
  1885. reduce_binary_op(static_cast<GDScriptParser::BinaryOpNode *>(p_expression));
  1886. break;
  1887. case GDScriptParser::Node::CALL:
  1888. reduce_call(static_cast<GDScriptParser::CallNode *>(p_expression), false, p_is_root);
  1889. break;
  1890. case GDScriptParser::Node::CAST:
  1891. reduce_cast(static_cast<GDScriptParser::CastNode *>(p_expression));
  1892. break;
  1893. case GDScriptParser::Node::DICTIONARY:
  1894. reduce_dictionary(static_cast<GDScriptParser::DictionaryNode *>(p_expression));
  1895. break;
  1896. case GDScriptParser::Node::GET_NODE:
  1897. reduce_get_node(static_cast<GDScriptParser::GetNodeNode *>(p_expression));
  1898. break;
  1899. case GDScriptParser::Node::IDENTIFIER:
  1900. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_expression));
  1901. break;
  1902. case GDScriptParser::Node::LAMBDA:
  1903. reduce_lambda(static_cast<GDScriptParser::LambdaNode *>(p_expression));
  1904. break;
  1905. case GDScriptParser::Node::LITERAL:
  1906. reduce_literal(static_cast<GDScriptParser::LiteralNode *>(p_expression));
  1907. break;
  1908. case GDScriptParser::Node::PRELOAD:
  1909. reduce_preload(static_cast<GDScriptParser::PreloadNode *>(p_expression));
  1910. break;
  1911. case GDScriptParser::Node::SELF:
  1912. reduce_self(static_cast<GDScriptParser::SelfNode *>(p_expression));
  1913. break;
  1914. case GDScriptParser::Node::SUBSCRIPT:
  1915. reduce_subscript(static_cast<GDScriptParser::SubscriptNode *>(p_expression));
  1916. break;
  1917. case GDScriptParser::Node::TERNARY_OPERATOR:
  1918. reduce_ternary_op(static_cast<GDScriptParser::TernaryOpNode *>(p_expression), p_is_root);
  1919. break;
  1920. case GDScriptParser::Node::TYPE_TEST:
  1921. reduce_type_test(static_cast<GDScriptParser::TypeTestNode *>(p_expression));
  1922. break;
  1923. case GDScriptParser::Node::UNARY_OPERATOR:
  1924. reduce_unary_op(static_cast<GDScriptParser::UnaryOpNode *>(p_expression));
  1925. break;
  1926. // Non-expressions. Here only to make sure new nodes aren't forgotten.
  1927. case GDScriptParser::Node::NONE:
  1928. case GDScriptParser::Node::ANNOTATION:
  1929. case GDScriptParser::Node::ASSERT:
  1930. case GDScriptParser::Node::BREAK:
  1931. case GDScriptParser::Node::BREAKPOINT:
  1932. case GDScriptParser::Node::CLASS:
  1933. case GDScriptParser::Node::CONSTANT:
  1934. case GDScriptParser::Node::CONTINUE:
  1935. case GDScriptParser::Node::ENUM:
  1936. case GDScriptParser::Node::FOR:
  1937. case GDScriptParser::Node::FUNCTION:
  1938. case GDScriptParser::Node::IF:
  1939. case GDScriptParser::Node::MATCH:
  1940. case GDScriptParser::Node::MATCH_BRANCH:
  1941. case GDScriptParser::Node::PARAMETER:
  1942. case GDScriptParser::Node::PASS:
  1943. case GDScriptParser::Node::PATTERN:
  1944. case GDScriptParser::Node::RETURN:
  1945. case GDScriptParser::Node::SIGNAL:
  1946. case GDScriptParser::Node::SUITE:
  1947. case GDScriptParser::Node::TYPE:
  1948. case GDScriptParser::Node::VARIABLE:
  1949. case GDScriptParser::Node::WHILE:
  1950. ERR_FAIL_MSG("Reaching unreachable case");
  1951. }
  1952. }
  1953. void GDScriptAnalyzer::reduce_array(GDScriptParser::ArrayNode *p_array) {
  1954. for (int i = 0; i < p_array->elements.size(); i++) {
  1955. GDScriptParser::ExpressionNode *element = p_array->elements[i];
  1956. reduce_expression(element);
  1957. }
  1958. // It's array in any case.
  1959. GDScriptParser::DataType arr_type;
  1960. arr_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1961. arr_type.kind = GDScriptParser::DataType::BUILTIN;
  1962. arr_type.builtin_type = Variant::ARRAY;
  1963. arr_type.is_constant = true;
  1964. p_array->set_datatype(arr_type);
  1965. }
  1966. #ifdef DEBUG_ENABLED
  1967. static bool enum_has_value(const GDScriptParser::DataType p_type, int64_t p_value) {
  1968. for (const KeyValue<StringName, int64_t> &E : p_type.enum_values) {
  1969. if (E.value == p_value) {
  1970. return true;
  1971. }
  1972. }
  1973. return false;
  1974. }
  1975. #endif
  1976. void GDScriptAnalyzer::update_const_expression_builtin_type(GDScriptParser::ExpressionNode *p_expression, const GDScriptParser::DataType &p_type, const char *p_usage, bool p_is_cast) {
  1977. if (p_expression->get_datatype() == p_type) {
  1978. return;
  1979. }
  1980. if (p_type.kind != GDScriptParser::DataType::BUILTIN && p_type.kind != GDScriptParser::DataType::ENUM) {
  1981. return;
  1982. }
  1983. GDScriptParser::DataType expression_type = p_expression->get_datatype();
  1984. bool is_enum_cast = p_is_cast && p_type.kind == GDScriptParser::DataType::ENUM && p_type.is_meta_type == false && expression_type.builtin_type == Variant::INT;
  1985. if (!is_enum_cast && !is_type_compatible(p_type, expression_type, true, p_expression)) {
  1986. push_error(vformat(R"(Cannot %s a value of type "%s" as "%s".)", p_usage, expression_type.to_string(), p_type.to_string()), p_expression);
  1987. return;
  1988. }
  1989. GDScriptParser::DataType value_type = type_from_variant(p_expression->reduced_value, p_expression);
  1990. if (expression_type.is_variant() && !is_enum_cast && !is_type_compatible(p_type, value_type, true, p_expression)) {
  1991. push_error(vformat(R"(Cannot %s a value of type "%s" as "%s".)", p_usage, value_type.to_string(), p_type.to_string()), p_expression);
  1992. return;
  1993. }
  1994. #ifdef DEBUG_ENABLED
  1995. if (p_type.kind == GDScriptParser::DataType::ENUM && value_type.builtin_type == Variant::INT && !enum_has_value(p_type, p_expression->reduced_value)) {
  1996. parser->push_warning(p_expression, GDScriptWarning::INT_AS_ENUM_WITHOUT_MATCH, p_usage, p_expression->reduced_value.stringify(), p_type.to_string());
  1997. }
  1998. #endif
  1999. if (value_type.builtin_type == p_type.builtin_type) {
  2000. p_expression->set_datatype(p_type);
  2001. return;
  2002. }
  2003. Variant converted_to;
  2004. const Variant *converted_from = &p_expression->reduced_value;
  2005. Callable::CallError call_error;
  2006. Variant::construct(p_type.builtin_type, converted_to, &converted_from, 1, call_error);
  2007. if (call_error.error) {
  2008. push_error(vformat(R"(Failed to convert a value of type "%s" to "%s".)", value_type.to_string(), p_type.to_string()), p_expression);
  2009. return;
  2010. }
  2011. #ifdef DEBUG_ENABLED
  2012. if (p_type.builtin_type == Variant::INT && value_type.builtin_type == Variant::FLOAT) {
  2013. parser->push_warning(p_expression, GDScriptWarning::NARROWING_CONVERSION);
  2014. }
  2015. #endif
  2016. p_expression->reduced_value = converted_to;
  2017. p_expression->set_datatype(p_type);
  2018. }
  2019. // When an array literal is stored (or passed as function argument) to a typed context, we then assume the array is typed.
  2020. // This function determines which type is that (if any).
  2021. void GDScriptAnalyzer::update_array_literal_element_type(GDScriptParser::ArrayNode *p_array, const GDScriptParser::DataType &p_element_type) {
  2022. for (int i = 0; i < p_array->elements.size(); i++) {
  2023. GDScriptParser::ExpressionNode *element_node = p_array->elements[i];
  2024. if (element_node->is_constant) {
  2025. update_const_expression_builtin_type(element_node, p_element_type, "include");
  2026. }
  2027. const GDScriptParser::DataType &element_type = element_node->get_datatype();
  2028. if (element_type.has_no_type() || element_type.is_variant() || !element_type.is_hard_type()) {
  2029. mark_node_unsafe(element_node);
  2030. continue;
  2031. }
  2032. if (!is_type_compatible(p_element_type, element_type, true, p_array)) {
  2033. push_error(vformat(R"(Cannot have an element of type "%s" in an array of type "Array[%s]".)", element_type.to_string(), p_element_type.to_string()), element_node);
  2034. return;
  2035. }
  2036. }
  2037. GDScriptParser::DataType array_type = p_array->get_datatype();
  2038. array_type.set_container_element_type(p_element_type);
  2039. p_array->set_datatype(array_type);
  2040. }
  2041. void GDScriptAnalyzer::reduce_assignment(GDScriptParser::AssignmentNode *p_assignment) {
  2042. reduce_expression(p_assignment->assignee);
  2043. reduce_expression(p_assignment->assigned_value);
  2044. if (p_assignment->assigned_value == nullptr || p_assignment->assignee == nullptr) {
  2045. return;
  2046. }
  2047. GDScriptParser::DataType assignee_type = p_assignment->assignee->get_datatype();
  2048. if (assignee_type.is_constant || (p_assignment->assignee->type == GDScriptParser::Node::SUBSCRIPT && static_cast<GDScriptParser::SubscriptNode *>(p_assignment->assignee)->base->is_constant)) {
  2049. push_error("Cannot assign a new value to a constant.", p_assignment->assignee);
  2050. return;
  2051. } else if (assignee_type.is_read_only) {
  2052. push_error("Cannot assign a new value to a read-only property.", p_assignment->assignee);
  2053. return;
  2054. } else if (p_assignment->assignee->type == GDScriptParser::Node::SUBSCRIPT) {
  2055. GDScriptParser::SubscriptNode *sub = static_cast<GDScriptParser::SubscriptNode *>(p_assignment->assignee);
  2056. while (sub) {
  2057. const GDScriptParser::DataType &base_type = sub->base->datatype;
  2058. if (base_type.is_hard_type() && base_type.is_read_only) {
  2059. if (base_type.kind == GDScriptParser::DataType::BUILTIN && !Variant::is_type_shared(base_type.builtin_type)) {
  2060. push_error("Cannot assign a new value to a read-only property.", p_assignment->assignee);
  2061. return;
  2062. }
  2063. } else {
  2064. break;
  2065. }
  2066. if (sub->base->type == GDScriptParser::Node::SUBSCRIPT) {
  2067. sub = static_cast<GDScriptParser::SubscriptNode *>(sub->base);
  2068. } else {
  2069. sub = nullptr;
  2070. }
  2071. }
  2072. }
  2073. // Check if assigned value is an array literal, so we can make it a typed array too if appropriate.
  2074. if (p_assignment->assigned_value->type == GDScriptParser::Node::ARRAY && assignee_type.has_container_element_type()) {
  2075. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_assignment->assigned_value), assignee_type.get_container_element_type());
  2076. }
  2077. if (p_assignment->operation == GDScriptParser::AssignmentNode::OP_NONE && assignee_type.is_hard_type() && p_assignment->assigned_value->is_constant) {
  2078. update_const_expression_builtin_type(p_assignment->assigned_value, assignee_type, "assign");
  2079. }
  2080. GDScriptParser::DataType assigned_value_type = p_assignment->assigned_value->get_datatype();
  2081. bool assignee_is_variant = assignee_type.is_variant();
  2082. bool assignee_is_hard = assignee_type.is_hard_type();
  2083. bool assigned_is_variant = assigned_value_type.is_variant();
  2084. bool assigned_is_hard = assigned_value_type.is_hard_type();
  2085. bool compatible = true;
  2086. bool downgrades_assignee = false;
  2087. bool downgrades_assigned = false;
  2088. GDScriptParser::DataType op_type = assigned_value_type;
  2089. if (p_assignment->operation != GDScriptParser::AssignmentNode::OP_NONE && !op_type.is_variant()) {
  2090. op_type = get_operation_type(p_assignment->variant_op, assignee_type, assigned_value_type, compatible, p_assignment->assigned_value);
  2091. if (assignee_is_variant) {
  2092. // variant assignee
  2093. mark_node_unsafe(p_assignment);
  2094. } else if (!compatible) {
  2095. // incompatible hard types and non-variant assignee
  2096. mark_node_unsafe(p_assignment);
  2097. if (assigned_is_variant) {
  2098. // incompatible hard non-variant assignee and hard variant assigned
  2099. p_assignment->use_conversion_assign = true;
  2100. } else {
  2101. // incompatible hard non-variant types
  2102. push_error(vformat(R"(Invalid operands "%s" and "%s" for assignment operator.)", assignee_type.to_string(), assigned_value_type.to_string()), p_assignment);
  2103. }
  2104. } else if (op_type.type_source == GDScriptParser::DataType::UNDETECTED && !assigned_is_variant) {
  2105. // incompatible non-variant types (at least one weak)
  2106. downgrades_assignee = !assignee_is_hard;
  2107. downgrades_assigned = !assigned_is_hard;
  2108. }
  2109. }
  2110. p_assignment->set_datatype(op_type);
  2111. if (assignee_is_variant) {
  2112. if (!assignee_is_hard) {
  2113. // weak variant assignee
  2114. mark_node_unsafe(p_assignment);
  2115. }
  2116. } else {
  2117. if (assignee_is_hard && !assigned_is_hard) {
  2118. // hard non-variant assignee and weak assigned
  2119. mark_node_unsafe(p_assignment);
  2120. p_assignment->use_conversion_assign = true;
  2121. downgrades_assigned = downgrades_assigned || (!assigned_is_variant && !is_type_compatible(assignee_type, op_type, true, p_assignment->assigned_value));
  2122. } else if (compatible) {
  2123. if (op_type.is_variant()) {
  2124. // non-variant assignee and variant result
  2125. mark_node_unsafe(p_assignment);
  2126. if (assignee_is_hard) {
  2127. // hard non-variant assignee and variant result
  2128. p_assignment->use_conversion_assign = true;
  2129. } else {
  2130. // weak non-variant assignee and variant result
  2131. downgrades_assignee = true;
  2132. }
  2133. } else if (!is_type_compatible(assignee_type, op_type, assignee_is_hard, p_assignment->assigned_value)) {
  2134. // non-variant assignee and incompatible result
  2135. mark_node_unsafe(p_assignment);
  2136. if (assignee_is_hard) {
  2137. if (is_type_compatible(op_type, assignee_type)) {
  2138. // hard non-variant assignee and maybe compatible result
  2139. p_assignment->use_conversion_assign = true;
  2140. } else {
  2141. // hard non-variant assignee and incompatible result
  2142. push_error(vformat(R"(Value of type "%s" cannot be assigned to a variable of type "%s".)", assigned_value_type.to_string(), assignee_type.to_string()), p_assignment->assigned_value);
  2143. }
  2144. } else {
  2145. // weak non-variant assignee and incompatible result
  2146. downgrades_assignee = true;
  2147. }
  2148. } else if (assignee_type.has_container_element_type() && !op_type.has_container_element_type()) {
  2149. // typed array assignee and untyped array result
  2150. mark_node_unsafe(p_assignment);
  2151. }
  2152. }
  2153. }
  2154. if (downgrades_assignee) {
  2155. downgrade_node_type_source(p_assignment->assignee);
  2156. }
  2157. if (downgrades_assigned) {
  2158. downgrade_node_type_source(p_assignment->assigned_value);
  2159. }
  2160. #ifdef DEBUG_ENABLED
  2161. if (assignee_type.is_hard_type() && assignee_type.builtin_type == Variant::INT && assigned_value_type.builtin_type == Variant::FLOAT) {
  2162. parser->push_warning(p_assignment->assigned_value, GDScriptWarning::NARROWING_CONVERSION);
  2163. }
  2164. #endif
  2165. }
  2166. void GDScriptAnalyzer::reduce_await(GDScriptParser::AwaitNode *p_await) {
  2167. if (p_await->to_await == nullptr) {
  2168. GDScriptParser::DataType await_type;
  2169. await_type.kind = GDScriptParser::DataType::VARIANT;
  2170. p_await->set_datatype(await_type);
  2171. return;
  2172. }
  2173. if (p_await->to_await->type == GDScriptParser::Node::CALL) {
  2174. reduce_call(static_cast<GDScriptParser::CallNode *>(p_await->to_await), true);
  2175. } else {
  2176. reduce_expression(p_await->to_await);
  2177. }
  2178. GDScriptParser::DataType await_type = p_await->to_await->get_datatype();
  2179. // We cannot infer the type of the result of waiting for a signal.
  2180. if (await_type.is_hard_type() && await_type.kind == GDScriptParser::DataType::BUILTIN && await_type.builtin_type == Variant::SIGNAL) {
  2181. await_type.kind = GDScriptParser::DataType::VARIANT;
  2182. await_type.type_source = GDScriptParser::DataType::UNDETECTED;
  2183. } else if (p_await->to_await->is_constant) {
  2184. p_await->is_constant = p_await->to_await->is_constant;
  2185. p_await->reduced_value = p_await->to_await->reduced_value;
  2186. }
  2187. await_type.is_coroutine = false;
  2188. p_await->set_datatype(await_type);
  2189. #ifdef DEBUG_ENABLED
  2190. GDScriptParser::DataType to_await_type = p_await->to_await->get_datatype();
  2191. if (!(to_await_type.has_no_type() || to_await_type.is_coroutine || to_await_type.builtin_type == Variant::SIGNAL)) {
  2192. parser->push_warning(p_await, GDScriptWarning::REDUNDANT_AWAIT);
  2193. }
  2194. #endif
  2195. }
  2196. void GDScriptAnalyzer::reduce_binary_op(GDScriptParser::BinaryOpNode *p_binary_op) {
  2197. reduce_expression(p_binary_op->left_operand);
  2198. reduce_expression(p_binary_op->right_operand);
  2199. GDScriptParser::DataType left_type;
  2200. if (p_binary_op->left_operand) {
  2201. left_type = p_binary_op->left_operand->get_datatype();
  2202. }
  2203. GDScriptParser::DataType right_type;
  2204. if (p_binary_op->right_operand) {
  2205. right_type = p_binary_op->right_operand->get_datatype();
  2206. }
  2207. if (!left_type.is_set() || !right_type.is_set()) {
  2208. return;
  2209. }
  2210. #ifdef DEBUG_ENABLED
  2211. if (p_binary_op->variant_op == Variant::OP_DIVIDE && left_type.builtin_type == Variant::INT && right_type.builtin_type == Variant::INT) {
  2212. parser->push_warning(p_binary_op, GDScriptWarning::INTEGER_DIVISION);
  2213. }
  2214. #endif
  2215. if (p_binary_op->left_operand->is_constant && p_binary_op->right_operand->is_constant) {
  2216. p_binary_op->is_constant = true;
  2217. if (p_binary_op->variant_op < Variant::OP_MAX) {
  2218. bool valid = false;
  2219. Variant::evaluate(p_binary_op->variant_op, p_binary_op->left_operand->reduced_value, p_binary_op->right_operand->reduced_value, p_binary_op->reduced_value, valid);
  2220. if (!valid) {
  2221. if (p_binary_op->reduced_value.get_type() == Variant::STRING) {
  2222. push_error(vformat(R"(%s in operator %s.)", p_binary_op->reduced_value, Variant::get_operator_name(p_binary_op->variant_op)), p_binary_op);
  2223. } else {
  2224. push_error(vformat(R"(Invalid operands to operator %s, %s and %s.)",
  2225. Variant::get_operator_name(p_binary_op->variant_op),
  2226. Variant::get_type_name(p_binary_op->left_operand->reduced_value.get_type()),
  2227. Variant::get_type_name(p_binary_op->right_operand->reduced_value.get_type())),
  2228. p_binary_op);
  2229. }
  2230. }
  2231. } else {
  2232. ERR_PRINT("Parser bug: unknown binary operation.");
  2233. }
  2234. p_binary_op->set_datatype(type_from_variant(p_binary_op->reduced_value, p_binary_op));
  2235. return;
  2236. }
  2237. GDScriptParser::DataType result;
  2238. if ((p_binary_op->variant_op == Variant::OP_EQUAL || p_binary_op->variant_op == Variant::OP_NOT_EQUAL) &&
  2239. ((left_type.kind == GDScriptParser::DataType::BUILTIN && left_type.builtin_type == Variant::NIL) || (right_type.kind == GDScriptParser::DataType::BUILTIN && right_type.builtin_type == Variant::NIL))) {
  2240. // "==" and "!=" operators always return a boolean when comparing to null.
  2241. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2242. result.kind = GDScriptParser::DataType::BUILTIN;
  2243. result.builtin_type = Variant::BOOL;
  2244. } else if (left_type.is_variant() || right_type.is_variant()) {
  2245. // Cannot infer type because one operand can be anything.
  2246. result.kind = GDScriptParser::DataType::VARIANT;
  2247. mark_node_unsafe(p_binary_op);
  2248. } else if (p_binary_op->variant_op < Variant::OP_MAX) {
  2249. bool valid = false;
  2250. result = get_operation_type(p_binary_op->variant_op, left_type, right_type, valid, p_binary_op);
  2251. if (!valid) {
  2252. push_error(vformat(R"(Invalid operands "%s" and "%s" for "%s" operator.)", left_type.to_string(), right_type.to_string(), Variant::get_operator_name(p_binary_op->variant_op)), p_binary_op);
  2253. } else if (result.type_source != GDScriptParser::DataType::ANNOTATED_EXPLICIT) {
  2254. mark_node_unsafe(p_binary_op);
  2255. }
  2256. } else {
  2257. ERR_PRINT("Parser bug: unknown binary operation.");
  2258. }
  2259. p_binary_op->set_datatype(result);
  2260. }
  2261. #ifdef SUGGEST_GODOT4_RENAMES
  2262. const char *get_rename_from_map(const char *map[][2], String key) {
  2263. for (int index = 0; map[index][0]; index++) {
  2264. if (map[index][0] == key) {
  2265. return map[index][1];
  2266. }
  2267. }
  2268. return nullptr;
  2269. }
  2270. // Checks if an identifier/function name has been renamed in Godot 4, uses ProjectConverter3To4 for rename map.
  2271. // Returns the new name if found, nullptr otherwise.
  2272. const char *check_for_renamed_identifier(String identifier, GDScriptParser::Node::Type type) {
  2273. switch (type) {
  2274. case GDScriptParser::Node::IDENTIFIER: {
  2275. // Check properties
  2276. const char *result = get_rename_from_map(RenamesMap3To4::gdscript_properties_renames, identifier);
  2277. if (result) {
  2278. return result;
  2279. }
  2280. // Check enum values
  2281. result = get_rename_from_map(RenamesMap3To4::enum_renames, identifier);
  2282. if (result) {
  2283. return result;
  2284. }
  2285. // Check color constants
  2286. result = get_rename_from_map(RenamesMap3To4::color_renames, identifier);
  2287. if (result) {
  2288. return result;
  2289. }
  2290. // Check type names
  2291. result = get_rename_from_map(RenamesMap3To4::class_renames, identifier);
  2292. if (result) {
  2293. return result;
  2294. }
  2295. return get_rename_from_map(RenamesMap3To4::builtin_types_renames, identifier);
  2296. }
  2297. case GDScriptParser::Node::CALL: {
  2298. const char *result = get_rename_from_map(RenamesMap3To4::gdscript_function_renames, identifier);
  2299. if (result) {
  2300. return result;
  2301. }
  2302. // Built-in Types are mistaken for function calls when the built-in type is not found.
  2303. // Check built-in types if function rename not found
  2304. return get_rename_from_map(RenamesMap3To4::builtin_types_renames, identifier);
  2305. }
  2306. // Signal references don't get parsed through the GDScriptAnalyzer. No support for signal rename hints.
  2307. default:
  2308. // No rename found, return null
  2309. return nullptr;
  2310. }
  2311. }
  2312. #endif // SUGGEST_GODOT4_RENAMES
  2313. void GDScriptAnalyzer::reduce_call(GDScriptParser::CallNode *p_call, bool p_is_await, bool p_is_root) {
  2314. bool all_is_constant = true;
  2315. HashMap<int, GDScriptParser::ArrayNode *> arrays; // For array literal to potentially type when passing.
  2316. for (int i = 0; i < p_call->arguments.size(); i++) {
  2317. reduce_expression(p_call->arguments[i]);
  2318. if (p_call->arguments[i]->type == GDScriptParser::Node::ARRAY) {
  2319. arrays[i] = static_cast<GDScriptParser::ArrayNode *>(p_call->arguments[i]);
  2320. }
  2321. all_is_constant = all_is_constant && p_call->arguments[i]->is_constant;
  2322. }
  2323. GDScriptParser::Node::Type callee_type = p_call->get_callee_type();
  2324. GDScriptParser::DataType call_type;
  2325. if (!p_call->is_super && callee_type == GDScriptParser::Node::IDENTIFIER) {
  2326. // Call to name directly.
  2327. StringName function_name = p_call->function_name;
  2328. Variant::Type builtin_type = GDScriptParser::get_builtin_type(function_name);
  2329. if (builtin_type < Variant::VARIANT_MAX) {
  2330. // Is a builtin constructor.
  2331. call_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2332. call_type.kind = GDScriptParser::DataType::BUILTIN;
  2333. call_type.builtin_type = builtin_type;
  2334. if (builtin_type == Variant::OBJECT) {
  2335. call_type.kind = GDScriptParser::DataType::NATIVE;
  2336. call_type.native_type = function_name; // "Object".
  2337. }
  2338. bool safe_to_fold = true;
  2339. switch (builtin_type) {
  2340. // Those are stored by reference so not suited for compile-time construction.
  2341. // Because in this case they would be the same reference in all constructed values.
  2342. case Variant::OBJECT:
  2343. case Variant::DICTIONARY:
  2344. case Variant::ARRAY:
  2345. case Variant::PACKED_BYTE_ARRAY:
  2346. case Variant::PACKED_INT32_ARRAY:
  2347. case Variant::PACKED_INT64_ARRAY:
  2348. case Variant::PACKED_FLOAT32_ARRAY:
  2349. case Variant::PACKED_FLOAT64_ARRAY:
  2350. case Variant::PACKED_STRING_ARRAY:
  2351. case Variant::PACKED_VECTOR2_ARRAY:
  2352. case Variant::PACKED_VECTOR3_ARRAY:
  2353. case Variant::PACKED_COLOR_ARRAY:
  2354. safe_to_fold = false;
  2355. break;
  2356. default:
  2357. break;
  2358. }
  2359. if (all_is_constant && safe_to_fold) {
  2360. // Construct here.
  2361. Vector<const Variant *> args;
  2362. for (int i = 0; i < p_call->arguments.size(); i++) {
  2363. args.push_back(&(p_call->arguments[i]->reduced_value));
  2364. }
  2365. Callable::CallError err;
  2366. Variant value;
  2367. Variant::construct(builtin_type, value, (const Variant **)args.ptr(), args.size(), err);
  2368. switch (err.error) {
  2369. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT:
  2370. push_error(vformat(R"(Invalid argument for %s constructor: argument %d should be "%s" but is "%s".)", Variant::get_type_name(builtin_type), err.argument + 1,
  2371. Variant::get_type_name(Variant::Type(err.expected)), p_call->arguments[err.argument]->get_datatype().to_string()),
  2372. p_call->arguments[err.argument]);
  2373. break;
  2374. case Callable::CallError::CALL_ERROR_INVALID_METHOD: {
  2375. String signature = Variant::get_type_name(builtin_type) + "(";
  2376. for (int i = 0; i < p_call->arguments.size(); i++) {
  2377. if (i > 0) {
  2378. signature += ", ";
  2379. }
  2380. signature += p_call->arguments[i]->get_datatype().to_string();
  2381. }
  2382. signature += ")";
  2383. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call->callee);
  2384. } break;
  2385. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  2386. push_error(vformat(R"(Too many arguments for %s constructor. Received %d but expected %d.)", Variant::get_type_name(builtin_type), p_call->arguments.size(), err.expected), p_call);
  2387. break;
  2388. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  2389. push_error(vformat(R"(Too few arguments for %s constructor. Received %d but expected %d.)", Variant::get_type_name(builtin_type), p_call->arguments.size(), err.expected), p_call);
  2390. break;
  2391. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  2392. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  2393. break; // Can't happen in a builtin constructor.
  2394. case Callable::CallError::CALL_OK:
  2395. p_call->is_constant = true;
  2396. p_call->reduced_value = value;
  2397. break;
  2398. }
  2399. } else {
  2400. // TODO: Check constructors without constants.
  2401. // If there's one argument, try to use copy constructor (those aren't explicitly defined).
  2402. if (p_call->arguments.size() == 1) {
  2403. GDScriptParser::DataType arg_type = p_call->arguments[0]->get_datatype();
  2404. if (arg_type.is_variant()) {
  2405. mark_node_unsafe(p_call->arguments[0]);
  2406. } else {
  2407. if (arg_type.kind == GDScriptParser::DataType::BUILTIN && arg_type.builtin_type == builtin_type) {
  2408. // Okay.
  2409. p_call->set_datatype(call_type);
  2410. return;
  2411. }
  2412. }
  2413. }
  2414. List<MethodInfo> constructors;
  2415. Variant::get_constructor_list(builtin_type, &constructors);
  2416. bool match = false;
  2417. for (const MethodInfo &info : constructors) {
  2418. if (p_call->arguments.size() < info.arguments.size() - info.default_arguments.size()) {
  2419. continue;
  2420. }
  2421. if (p_call->arguments.size() > info.arguments.size()) {
  2422. continue;
  2423. }
  2424. bool types_match = true;
  2425. for (int i = 0; i < p_call->arguments.size(); i++) {
  2426. GDScriptParser::DataType par_type = type_from_property(info.arguments[i], true);
  2427. if (!is_type_compatible(par_type, p_call->arguments[i]->get_datatype(), true)) {
  2428. types_match = false;
  2429. break;
  2430. #ifdef DEBUG_ENABLED
  2431. } else {
  2432. if (par_type.builtin_type == Variant::INT && p_call->arguments[i]->get_datatype().builtin_type == Variant::FLOAT && builtin_type != Variant::INT) {
  2433. parser->push_warning(p_call, GDScriptWarning::NARROWING_CONVERSION, p_call->function_name);
  2434. }
  2435. #endif
  2436. }
  2437. }
  2438. if (types_match) {
  2439. for (int i = 0; i < p_call->arguments.size(); i++) {
  2440. if (p_call->arguments[i]->is_constant) {
  2441. update_const_expression_builtin_type(p_call->arguments[i], type_from_property(info.arguments[i], true), "pass");
  2442. }
  2443. }
  2444. match = true;
  2445. call_type = type_from_property(info.return_val);
  2446. break;
  2447. }
  2448. }
  2449. if (!match) {
  2450. String signature = Variant::get_type_name(builtin_type) + "(";
  2451. for (int i = 0; i < p_call->arguments.size(); i++) {
  2452. if (i > 0) {
  2453. signature += ", ";
  2454. }
  2455. signature += p_call->arguments[i]->get_datatype().to_string();
  2456. }
  2457. signature += ")";
  2458. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call);
  2459. }
  2460. }
  2461. p_call->set_datatype(call_type);
  2462. return;
  2463. } else if (GDScriptUtilityFunctions::function_exists(function_name)) {
  2464. MethodInfo function_info = GDScriptUtilityFunctions::get_function_info(function_name);
  2465. if (!p_is_root && !p_is_await && function_info.return_val.type == Variant::NIL && ((function_info.return_val.usage & PROPERTY_USAGE_NIL_IS_VARIANT) == 0)) {
  2466. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", function_name), p_call);
  2467. }
  2468. if (all_is_constant && GDScriptUtilityFunctions::is_function_constant(function_name)) {
  2469. // Can call on compilation.
  2470. Vector<const Variant *> args;
  2471. for (int i = 0; i < p_call->arguments.size(); i++) {
  2472. args.push_back(&(p_call->arguments[i]->reduced_value));
  2473. }
  2474. Variant value;
  2475. Callable::CallError err;
  2476. GDScriptUtilityFunctions::get_function(function_name)(&value, (const Variant **)args.ptr(), args.size(), err);
  2477. switch (err.error) {
  2478. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT: {
  2479. PropertyInfo wrong_arg = function_info.arguments[err.argument];
  2480. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*", function_name, err.argument + 1,
  2481. type_from_property(wrong_arg, true).to_string(), p_call->arguments[err.argument]->get_datatype().to_string()),
  2482. p_call->arguments[err.argument]);
  2483. } break;
  2484. case Callable::CallError::CALL_ERROR_INVALID_METHOD:
  2485. push_error(vformat(R"(Invalid call for function "%s".)", function_name), p_call);
  2486. break;
  2487. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  2488. push_error(vformat(R"*(Too many arguments for "%s()" call. Expected at most %d but received %d.)*", function_name, err.expected, p_call->arguments.size()), p_call);
  2489. break;
  2490. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  2491. push_error(vformat(R"*(Too few arguments for "%s()" call. Expected at least %d but received %d.)*", function_name, err.expected, p_call->arguments.size()), p_call);
  2492. break;
  2493. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  2494. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  2495. break; // Can't happen in a builtin constructor.
  2496. case Callable::CallError::CALL_OK:
  2497. p_call->is_constant = true;
  2498. p_call->reduced_value = value;
  2499. break;
  2500. }
  2501. } else {
  2502. validate_call_arg(function_info, p_call);
  2503. }
  2504. p_call->set_datatype(type_from_property(function_info.return_val));
  2505. return;
  2506. } else if (Variant::has_utility_function(function_name)) {
  2507. MethodInfo function_info = info_from_utility_func(function_name);
  2508. if (!p_is_root && !p_is_await && function_info.return_val.type == Variant::NIL && ((function_info.return_val.usage & PROPERTY_USAGE_NIL_IS_VARIANT) == 0)) {
  2509. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", function_name), p_call);
  2510. }
  2511. if (all_is_constant && Variant::get_utility_function_type(function_name) == Variant::UTILITY_FUNC_TYPE_MATH) {
  2512. // Can call on compilation.
  2513. Vector<const Variant *> args;
  2514. for (int i = 0; i < p_call->arguments.size(); i++) {
  2515. args.push_back(&(p_call->arguments[i]->reduced_value));
  2516. }
  2517. Variant value;
  2518. Callable::CallError err;
  2519. Variant::call_utility_function(function_name, &value, (const Variant **)args.ptr(), args.size(), err);
  2520. switch (err.error) {
  2521. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT: {
  2522. String expected_type_name;
  2523. if (err.argument < function_info.arguments.size()) {
  2524. expected_type_name = type_from_property(function_info.arguments[err.argument], true).to_string();
  2525. } else {
  2526. expected_type_name = Variant::get_type_name((Variant::Type)err.expected);
  2527. }
  2528. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*", function_name, err.argument + 1,
  2529. expected_type_name, p_call->arguments[err.argument]->get_datatype().to_string()),
  2530. p_call->arguments[err.argument]);
  2531. } break;
  2532. case Callable::CallError::CALL_ERROR_INVALID_METHOD:
  2533. push_error(vformat(R"(Invalid call for function "%s".)", function_name), p_call);
  2534. break;
  2535. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  2536. push_error(vformat(R"*(Too many arguments for "%s()" call. Expected at most %d but received %d.)*", function_name, err.expected, p_call->arguments.size()), p_call);
  2537. break;
  2538. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  2539. push_error(vformat(R"*(Too few arguments for "%s()" call. Expected at least %d but received %d.)*", function_name, err.expected, p_call->arguments.size()), p_call);
  2540. break;
  2541. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  2542. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  2543. break; // Can't happen in a builtin constructor.
  2544. case Callable::CallError::CALL_OK:
  2545. p_call->is_constant = true;
  2546. p_call->reduced_value = value;
  2547. break;
  2548. }
  2549. } else {
  2550. validate_call_arg(function_info, p_call);
  2551. }
  2552. p_call->set_datatype(type_from_property(function_info.return_val));
  2553. return;
  2554. }
  2555. }
  2556. GDScriptParser::DataType base_type;
  2557. call_type.kind = GDScriptParser::DataType::VARIANT;
  2558. bool is_self = false;
  2559. if (p_call->is_super) {
  2560. base_type = parser->current_class->base_type;
  2561. base_type.is_meta_type = false;
  2562. is_self = true;
  2563. if (p_call->callee == nullptr && !lambda_stack.is_empty()) {
  2564. push_error("Cannot use `super()` inside a lambda.", p_call);
  2565. }
  2566. } else if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  2567. base_type = parser->current_class->get_datatype();
  2568. base_type.is_meta_type = false;
  2569. is_self = true;
  2570. } else if (callee_type == GDScriptParser::Node::SUBSCRIPT) {
  2571. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee);
  2572. if (subscript->base == nullptr) {
  2573. // Invalid syntax, error already set on parser.
  2574. p_call->set_datatype(call_type);
  2575. mark_node_unsafe(p_call);
  2576. return;
  2577. }
  2578. if (!subscript->is_attribute) {
  2579. // Invalid call. Error already sent in parser.
  2580. // TODO: Could check if Callable here.
  2581. p_call->set_datatype(call_type);
  2582. mark_node_unsafe(p_call);
  2583. return;
  2584. }
  2585. if (subscript->attribute == nullptr) {
  2586. // Invalid call. Error already sent in parser.
  2587. p_call->set_datatype(call_type);
  2588. mark_node_unsafe(p_call);
  2589. return;
  2590. }
  2591. GDScriptParser::IdentifierNode *base_id = nullptr;
  2592. if (subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  2593. base_id = static_cast<GDScriptParser::IdentifierNode *>(subscript->base);
  2594. }
  2595. if (base_id && GDScriptParser::get_builtin_type(base_id->name) < Variant::VARIANT_MAX) {
  2596. base_type = make_builtin_meta_type(GDScriptParser::get_builtin_type(base_id->name));
  2597. } else {
  2598. reduce_expression(subscript->base);
  2599. base_type = subscript->base->get_datatype();
  2600. is_self = subscript->base->type == GDScriptParser::Node::SELF;
  2601. }
  2602. } else {
  2603. // Invalid call. Error already sent in parser.
  2604. // TODO: Could check if Callable here too.
  2605. p_call->set_datatype(call_type);
  2606. mark_node_unsafe(p_call);
  2607. return;
  2608. }
  2609. bool is_static = false;
  2610. bool is_vararg = false;
  2611. int default_arg_count = 0;
  2612. GDScriptParser::DataType return_type;
  2613. List<GDScriptParser::DataType> par_types;
  2614. bool is_constructor = (base_type.is_meta_type || (p_call->callee && p_call->callee->type == GDScriptParser::Node::IDENTIFIER)) && p_call->function_name == SNAME("new");
  2615. if (get_function_signature(p_call, is_constructor, base_type, p_call->function_name, return_type, par_types, default_arg_count, is_static, is_vararg)) {
  2616. // If the function require typed arrays we must make literals be typed.
  2617. for (const KeyValue<int, GDScriptParser::ArrayNode *> &E : arrays) {
  2618. int index = E.key;
  2619. if (index < par_types.size() && par_types[index].has_container_element_type()) {
  2620. update_array_literal_element_type(E.value, par_types[index].get_container_element_type());
  2621. }
  2622. }
  2623. validate_call_arg(par_types, default_arg_count, is_vararg, p_call);
  2624. if (base_type.kind == GDScriptParser::DataType::ENUM && base_type.is_meta_type) {
  2625. // Enum type is treated as a dictionary value for function calls.
  2626. base_type.is_meta_type = false;
  2627. }
  2628. if (is_self && parser->current_function != nullptr && parser->current_function->is_static && !is_static) {
  2629. // Get the parent function above any lambda.
  2630. GDScriptParser::FunctionNode *parent_function = parser->current_function;
  2631. while (parent_function->source_lambda) {
  2632. parent_function = parent_function->source_lambda->parent_function;
  2633. }
  2634. push_error(vformat(R"*(Cannot call non-static function "%s()" from static function "%s()".)*", p_call->function_name, parent_function->identifier->name), p_call);
  2635. } else if (!is_self && base_type.is_meta_type && !is_static) {
  2636. base_type.is_meta_type = false; // For `to_string()`.
  2637. push_error(vformat(R"*(Cannot call non-static function "%s()" on the class "%s" directly. Make an instance instead.)*", p_call->function_name, base_type.to_string()), p_call);
  2638. } else if (is_self && !is_static) {
  2639. mark_lambda_use_self();
  2640. }
  2641. if (!p_is_root && !p_is_await && return_type.is_hard_type() && return_type.kind == GDScriptParser::DataType::BUILTIN && return_type.builtin_type == Variant::NIL) {
  2642. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", p_call->function_name), p_call);
  2643. }
  2644. #ifdef DEBUG_ENABLED
  2645. if (p_is_root && return_type.kind != GDScriptParser::DataType::UNRESOLVED && return_type.builtin_type != Variant::NIL) {
  2646. parser->push_warning(p_call, GDScriptWarning::RETURN_VALUE_DISCARDED, p_call->function_name);
  2647. }
  2648. if (is_static && !base_type.is_meta_type && !(is_self && parser->current_function != nullptr && parser->current_function->is_static)) {
  2649. String caller_type = String(base_type.native_type);
  2650. if (caller_type.is_empty()) {
  2651. caller_type = base_type.to_string();
  2652. }
  2653. parser->push_warning(p_call, GDScriptWarning::STATIC_CALLED_ON_INSTANCE, p_call->function_name, caller_type);
  2654. }
  2655. #endif // DEBUG_ENABLED
  2656. call_type = return_type;
  2657. } else {
  2658. bool found = false;
  2659. // Enums do not have functions other than the built-in dictionary ones.
  2660. if (base_type.kind == GDScriptParser::DataType::ENUM && base_type.is_meta_type) {
  2661. if (base_type.builtin_type == Variant::DICTIONARY) {
  2662. push_error(vformat(R"*(Enums only have Dictionary built-in methods. Function "%s()" does not exist for enum "%s".)*", p_call->function_name, base_type.enum_type), p_call->callee);
  2663. } else {
  2664. push_error(vformat(R"*(The native enum "%s" does not behave like Dictionary and does not have methods of its own.)*", base_type.enum_type), p_call->callee);
  2665. }
  2666. } else if (!p_call->is_super && callee_type != GDScriptParser::Node::NONE) { // Check if the name exists as something else.
  2667. GDScriptParser::IdentifierNode *callee_id;
  2668. if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  2669. callee_id = static_cast<GDScriptParser::IdentifierNode *>(p_call->callee);
  2670. } else {
  2671. // Can only be attribute.
  2672. callee_id = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee)->attribute;
  2673. }
  2674. if (callee_id) {
  2675. reduce_identifier_from_base(callee_id, &base_type);
  2676. GDScriptParser::DataType callee_datatype = callee_id->get_datatype();
  2677. if (callee_datatype.is_set() && !callee_datatype.is_variant()) {
  2678. found = true;
  2679. if (callee_datatype.builtin_type == Variant::CALLABLE) {
  2680. push_error(vformat(R"*(Name "%s" is a Callable. You can call it with "%s.call()" instead.)*", p_call->function_name, p_call->function_name), p_call->callee);
  2681. } else {
  2682. push_error(vformat(R"*(Name "%s" called as a function but is a "%s".)*", p_call->function_name, callee_datatype.to_string()), p_call->callee);
  2683. }
  2684. #ifdef DEBUG_ENABLED
  2685. } else if (!is_self && !(base_type.is_hard_type() && base_type.kind == GDScriptParser::DataType::BUILTIN)) {
  2686. parser->push_warning(p_call, GDScriptWarning::UNSAFE_METHOD_ACCESS, p_call->function_name, base_type.to_string());
  2687. mark_node_unsafe(p_call);
  2688. #endif
  2689. }
  2690. }
  2691. }
  2692. if (!found && (is_self || (base_type.is_hard_type() && base_type.kind == GDScriptParser::DataType::BUILTIN))) {
  2693. String base_name = is_self && !p_call->is_super ? "self" : base_type.to_string();
  2694. #ifdef SUGGEST_GODOT4_RENAMES
  2695. String rename_hint = String();
  2696. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::Code::RENAMED_IN_GD4_HINT)).booleanize()) {
  2697. const char *renamed_function_name = check_for_renamed_identifier(p_call->function_name, p_call->type);
  2698. if (renamed_function_name) {
  2699. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", String(renamed_function_name) + "()");
  2700. }
  2701. }
  2702. push_error(vformat(R"*(Function "%s()" not found in base %s.%s)*", p_call->function_name, base_name, rename_hint), p_call->is_super ? p_call : p_call->callee);
  2703. #else
  2704. push_error(vformat(R"*(Function "%s()" not found in base %s.)*", p_call->function_name, base_name), p_call->is_super ? p_call : p_call->callee);
  2705. #endif // SUGGEST_GODOT4_RENAMES
  2706. } else if (!found && (!p_call->is_super && base_type.is_hard_type() && base_type.kind == GDScriptParser::DataType::NATIVE && base_type.is_meta_type)) {
  2707. push_error(vformat(R"*(Static function "%s()" not found in base "%s".)*", p_call->function_name, base_type.native_type), p_call);
  2708. }
  2709. }
  2710. if (call_type.is_coroutine && !p_is_await && !p_is_root) {
  2711. push_error(vformat(R"*(Function "%s()" is a coroutine, so it must be called with "await".)*", p_call->function_name), p_call);
  2712. }
  2713. p_call->set_datatype(call_type);
  2714. }
  2715. void GDScriptAnalyzer::reduce_cast(GDScriptParser::CastNode *p_cast) {
  2716. reduce_expression(p_cast->operand);
  2717. GDScriptParser::DataType cast_type = type_from_metatype(resolve_datatype(p_cast->cast_type));
  2718. if (!cast_type.is_set()) {
  2719. mark_node_unsafe(p_cast);
  2720. return;
  2721. }
  2722. p_cast->set_datatype(cast_type);
  2723. if (p_cast->operand->is_constant) {
  2724. update_const_expression_builtin_type(p_cast->operand, cast_type, "cast", true);
  2725. if (cast_type.is_variant() || p_cast->operand->get_datatype() == cast_type) {
  2726. p_cast->is_constant = true;
  2727. p_cast->reduced_value = p_cast->operand->reduced_value;
  2728. }
  2729. }
  2730. if (p_cast->operand->type == GDScriptParser::Node::ARRAY && cast_type.has_container_element_type()) {
  2731. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_cast->operand), cast_type.get_container_element_type());
  2732. }
  2733. if (!cast_type.is_variant()) {
  2734. GDScriptParser::DataType op_type = p_cast->operand->get_datatype();
  2735. if (op_type.is_variant() || !op_type.is_hard_type()) {
  2736. mark_node_unsafe(p_cast);
  2737. #ifdef DEBUG_ENABLED
  2738. if (op_type.is_variant() && !op_type.is_hard_type()) {
  2739. parser->push_warning(p_cast, GDScriptWarning::UNSAFE_CAST, cast_type.to_string());
  2740. }
  2741. #endif
  2742. } else {
  2743. bool valid = false;
  2744. if (op_type.builtin_type == Variant::INT && cast_type.kind == GDScriptParser::DataType::ENUM) {
  2745. mark_node_unsafe(p_cast);
  2746. valid = true;
  2747. } else if (op_type.kind == GDScriptParser::DataType::BUILTIN && cast_type.kind == GDScriptParser::DataType::BUILTIN) {
  2748. valid = Variant::can_convert(op_type.builtin_type, cast_type.builtin_type);
  2749. } else if (op_type.kind != GDScriptParser::DataType::BUILTIN && cast_type.kind != GDScriptParser::DataType::BUILTIN) {
  2750. valid = is_type_compatible(cast_type, op_type) || is_type_compatible(op_type, cast_type);
  2751. }
  2752. if (!valid) {
  2753. push_error(vformat(R"(Invalid cast. Cannot convert from "%s" to "%s".)", op_type.to_string(), cast_type.to_string()), p_cast->cast_type);
  2754. }
  2755. }
  2756. }
  2757. }
  2758. void GDScriptAnalyzer::reduce_dictionary(GDScriptParser::DictionaryNode *p_dictionary) {
  2759. HashMap<Variant, GDScriptParser::ExpressionNode *, VariantHasher, StringLikeVariantComparator> elements;
  2760. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  2761. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  2762. if (p_dictionary->style == GDScriptParser::DictionaryNode::PYTHON_DICT) {
  2763. reduce_expression(element.key);
  2764. }
  2765. reduce_expression(element.value);
  2766. if (element.key->is_constant) {
  2767. if (elements.has(element.key->reduced_value)) {
  2768. push_error(vformat(R"(Key "%s" was already used in this dictionary (at line %d).)", element.key->reduced_value, elements[element.key->reduced_value]->start_line), element.key);
  2769. } else {
  2770. elements[element.key->reduced_value] = element.value;
  2771. }
  2772. }
  2773. }
  2774. // It's dictionary in any case.
  2775. GDScriptParser::DataType dict_type;
  2776. dict_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2777. dict_type.kind = GDScriptParser::DataType::BUILTIN;
  2778. dict_type.builtin_type = Variant::DICTIONARY;
  2779. dict_type.is_constant = true;
  2780. p_dictionary->set_datatype(dict_type);
  2781. }
  2782. void GDScriptAnalyzer::reduce_get_node(GDScriptParser::GetNodeNode *p_get_node) {
  2783. GDScriptParser::DataType result;
  2784. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2785. result.kind = GDScriptParser::DataType::NATIVE;
  2786. result.native_type = SNAME("Node");
  2787. result.builtin_type = Variant::OBJECT;
  2788. if (!ClassDB::is_parent_class(parser->current_class->base_type.native_type, result.native_type)) {
  2789. push_error(R"*(Cannot use shorthand "get_node()" notation ("$") on a class that isn't a node.)*", p_get_node);
  2790. }
  2791. mark_lambda_use_self();
  2792. p_get_node->set_datatype(result);
  2793. }
  2794. GDScriptParser::DataType GDScriptAnalyzer::make_global_class_meta_type(const StringName &p_class_name, const GDScriptParser::Node *p_source) {
  2795. GDScriptParser::DataType type;
  2796. String path = ScriptServer::get_global_class_path(p_class_name);
  2797. String ext = path.get_extension();
  2798. if (ext == GDScriptLanguage::get_singleton()->get_extension()) {
  2799. Ref<GDScriptParserRef> ref = get_parser_for(path);
  2800. if (ref.is_null()) {
  2801. push_error(vformat(R"(Could not find script for class "%s".)", p_class_name), p_source);
  2802. type.type_source = GDScriptParser::DataType::UNDETECTED;
  2803. type.kind = GDScriptParser::DataType::VARIANT;
  2804. return type;
  2805. }
  2806. Error err = ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  2807. if (err) {
  2808. push_error(vformat(R"(Could not resolve class "%s", because of a parser error.)", p_class_name), p_source);
  2809. type.type_source = GDScriptParser::DataType::UNDETECTED;
  2810. type.kind = GDScriptParser::DataType::VARIANT;
  2811. return type;
  2812. }
  2813. return ref->get_parser()->head->get_datatype();
  2814. } else {
  2815. return make_script_meta_type(ResourceLoader::load(path, "Script"));
  2816. }
  2817. }
  2818. void GDScriptAnalyzer::reduce_identifier_from_base_set_class(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType p_identifier_datatype) {
  2819. ERR_FAIL_NULL(p_identifier);
  2820. p_identifier->set_datatype(p_identifier_datatype);
  2821. Error err = OK;
  2822. Ref<GDScript> scr = GDScriptCache::get_shallow_script(p_identifier_datatype.script_path, err);
  2823. if (err) {
  2824. push_error(vformat(R"(Error while getting cache for script "%s".)", p_identifier_datatype.script_path), p_identifier);
  2825. return;
  2826. }
  2827. p_identifier->reduced_value = scr->find_class(p_identifier_datatype.class_type->fqcn);
  2828. p_identifier->is_constant = true;
  2829. }
  2830. void GDScriptAnalyzer::reduce_identifier_from_base(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType *p_base) {
  2831. if (!p_identifier->get_datatype().has_no_type()) {
  2832. return;
  2833. }
  2834. GDScriptParser::DataType base;
  2835. if (p_base == nullptr) {
  2836. base = type_from_metatype(parser->current_class->get_datatype());
  2837. } else {
  2838. base = *p_base;
  2839. }
  2840. const StringName &name = p_identifier->name;
  2841. if (base.kind == GDScriptParser::DataType::ENUM) {
  2842. if (base.is_meta_type) {
  2843. if (base.enum_values.has(name)) {
  2844. p_identifier->set_datatype(type_from_metatype(base));
  2845. p_identifier->is_constant = true;
  2846. p_identifier->reduced_value = base.enum_values[name];
  2847. return;
  2848. }
  2849. // Enum does not have this value, return.
  2850. return;
  2851. } else {
  2852. push_error(R"(Cannot get property from enum value.)", p_identifier);
  2853. return;
  2854. }
  2855. }
  2856. if (base.kind == GDScriptParser::DataType::BUILTIN) {
  2857. if (base.is_meta_type) {
  2858. bool valid = true;
  2859. Variant result = Variant::get_constant_value(base.builtin_type, name, &valid);
  2860. if (valid) {
  2861. p_identifier->is_constant = true;
  2862. p_identifier->reduced_value = result;
  2863. p_identifier->set_datatype(type_from_variant(result, p_identifier));
  2864. } else if (base.is_hard_type()) {
  2865. #ifdef SUGGEST_GODOT4_RENAMES
  2866. String rename_hint = String();
  2867. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::Code::RENAMED_IN_GD4_HINT)).booleanize()) {
  2868. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  2869. if (renamed_identifier_name) {
  2870. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  2871. }
  2872. }
  2873. push_error(vformat(R"(Cannot find constant "%s" on base "%s".%s)", name, base.to_string(), rename_hint), p_identifier);
  2874. #else
  2875. push_error(vformat(R"(Cannot find constant "%s" on base "%s".)", name, base.to_string()), p_identifier);
  2876. #endif // SUGGEST_GODOT4_RENAMES
  2877. }
  2878. } else {
  2879. switch (base.builtin_type) {
  2880. case Variant::NIL: {
  2881. if (base.is_hard_type()) {
  2882. push_error(vformat(R"(Invalid get index "%s" on base Nil)", name), p_identifier);
  2883. }
  2884. return;
  2885. }
  2886. case Variant::DICTIONARY: {
  2887. GDScriptParser::DataType dummy;
  2888. dummy.kind = GDScriptParser::DataType::VARIANT;
  2889. p_identifier->set_datatype(dummy);
  2890. return;
  2891. }
  2892. default: {
  2893. Callable::CallError temp;
  2894. Variant dummy;
  2895. Variant::construct(base.builtin_type, dummy, nullptr, 0, temp);
  2896. List<PropertyInfo> properties;
  2897. dummy.get_property_list(&properties);
  2898. for (const PropertyInfo &prop : properties) {
  2899. if (prop.name == name) {
  2900. p_identifier->set_datatype(type_from_property(prop));
  2901. return;
  2902. }
  2903. }
  2904. if (base.is_hard_type()) {
  2905. #ifdef SUGGEST_GODOT4_RENAMES
  2906. String rename_hint = String();
  2907. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::Code::RENAMED_IN_GD4_HINT)).booleanize()) {
  2908. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  2909. if (renamed_identifier_name) {
  2910. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  2911. }
  2912. }
  2913. push_error(vformat(R"(Cannot find property "%s" on base "%s".%s)", name, base.to_string(), rename_hint), p_identifier);
  2914. #else
  2915. push_error(vformat(R"(Cannot find property "%s" on base "%s".)", name, base.to_string()), p_identifier);
  2916. #endif // SUGGEST_GODOT4_RENAMES
  2917. }
  2918. }
  2919. }
  2920. }
  2921. return;
  2922. }
  2923. GDScriptParser::ClassNode *base_class = base.class_type;
  2924. List<GDScriptParser::ClassNode *> script_classes;
  2925. bool is_base = true;
  2926. if (base_class != nullptr) {
  2927. get_class_node_current_scope_classes(base_class, &script_classes);
  2928. }
  2929. for (GDScriptParser::ClassNode *script_class : script_classes) {
  2930. if (p_base == nullptr && script_class->identifier && script_class->identifier->name == name) {
  2931. reduce_identifier_from_base_set_class(p_identifier, script_class->get_datatype());
  2932. return;
  2933. }
  2934. if (script_class->has_member(name)) {
  2935. resolve_class_member(script_class, name, p_identifier);
  2936. GDScriptParser::ClassNode::Member member = script_class->get_member(name);
  2937. switch (member.type) {
  2938. case GDScriptParser::ClassNode::Member::CONSTANT: {
  2939. p_identifier->set_datatype(member.get_datatype());
  2940. p_identifier->is_constant = true;
  2941. p_identifier->reduced_value = member.constant->initializer->reduced_value;
  2942. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  2943. p_identifier->constant_source = member.constant;
  2944. return;
  2945. }
  2946. case GDScriptParser::ClassNode::Member::ENUM_VALUE: {
  2947. p_identifier->set_datatype(member.get_datatype());
  2948. p_identifier->is_constant = true;
  2949. p_identifier->reduced_value = member.enum_value.value;
  2950. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  2951. return;
  2952. }
  2953. case GDScriptParser::ClassNode::Member::ENUM: {
  2954. p_identifier->set_datatype(member.get_datatype());
  2955. p_identifier->is_constant = true;
  2956. p_identifier->reduced_value = member.m_enum->dictionary;
  2957. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  2958. return;
  2959. }
  2960. case GDScriptParser::ClassNode::Member::VARIABLE: {
  2961. if (is_base && !base.is_meta_type) {
  2962. p_identifier->set_datatype(member.get_datatype());
  2963. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_VARIABLE;
  2964. p_identifier->variable_source = member.variable;
  2965. member.variable->usages += 1;
  2966. return;
  2967. }
  2968. } break;
  2969. case GDScriptParser::ClassNode::Member::SIGNAL: {
  2970. if (is_base && !base.is_meta_type) {
  2971. p_identifier->set_datatype(member.get_datatype());
  2972. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_SIGNAL;
  2973. return;
  2974. }
  2975. } break;
  2976. case GDScriptParser::ClassNode::Member::FUNCTION: {
  2977. if (is_base && !base.is_meta_type) {
  2978. p_identifier->set_datatype(make_callable_type(member.function->info));
  2979. return;
  2980. }
  2981. } break;
  2982. case GDScriptParser::ClassNode::Member::CLASS: {
  2983. reduce_identifier_from_base_set_class(p_identifier, member.get_datatype());
  2984. return;
  2985. }
  2986. default: {
  2987. // Do nothing
  2988. }
  2989. }
  2990. }
  2991. if (is_base) {
  2992. is_base = script_class->base_type.class_type != nullptr;
  2993. if (!is_base && p_base != nullptr) {
  2994. break;
  2995. }
  2996. }
  2997. }
  2998. // Check native members. No need for native class recursion because Node exposes all Object's properties.
  2999. const StringName &native = base.native_type;
  3000. if (class_exists(native)) {
  3001. MethodInfo method_info;
  3002. if (ClassDB::has_property(native, name)) {
  3003. StringName getter_name = ClassDB::get_property_getter(native, name);
  3004. MethodBind *getter = ClassDB::get_method(native, getter_name);
  3005. if (getter != nullptr) {
  3006. bool has_setter = ClassDB::get_property_setter(native, name) != StringName();
  3007. p_identifier->set_datatype(type_from_property(getter->get_return_info(), false, !has_setter));
  3008. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3009. }
  3010. return;
  3011. }
  3012. if (ClassDB::get_method_info(native, name, &method_info)) {
  3013. // Method is callable.
  3014. p_identifier->set_datatype(make_callable_type(method_info));
  3015. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3016. return;
  3017. }
  3018. if (ClassDB::get_signal(native, name, &method_info)) {
  3019. // Signal is a type too.
  3020. p_identifier->set_datatype(make_signal_type(method_info));
  3021. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3022. return;
  3023. }
  3024. if (ClassDB::has_enum(native, name)) {
  3025. p_identifier->set_datatype(make_native_enum_type(name, native));
  3026. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3027. return;
  3028. }
  3029. bool valid = false;
  3030. int64_t int_constant = ClassDB::get_integer_constant(native, name, &valid);
  3031. if (valid) {
  3032. p_identifier->is_constant = true;
  3033. p_identifier->reduced_value = int_constant;
  3034. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3035. // Check whether this constant, which exists, belongs to an enum
  3036. StringName enum_name = ClassDB::get_integer_constant_enum(native, name);
  3037. if (enum_name != StringName()) {
  3038. p_identifier->set_datatype(make_native_enum_type(enum_name, native, false));
  3039. } else {
  3040. p_identifier->set_datatype(type_from_variant(int_constant, p_identifier));
  3041. }
  3042. }
  3043. }
  3044. }
  3045. void GDScriptAnalyzer::reduce_identifier(GDScriptParser::IdentifierNode *p_identifier, bool can_be_builtin) {
  3046. // TODO: This is an opportunity to further infer types.
  3047. // Check if we are inside an enum. This allows enum values to access other elements of the same enum.
  3048. if (current_enum) {
  3049. for (int i = 0; i < current_enum->values.size(); i++) {
  3050. const GDScriptParser::EnumNode::Value &element = current_enum->values[i];
  3051. if (element.identifier->name == p_identifier->name) {
  3052. StringName enum_name = current_enum->identifier ? current_enum->identifier->name : UNNAMED_ENUM;
  3053. GDScriptParser::DataType type = make_enum_type(enum_name, parser->current_class->fqcn, false);
  3054. if (element.parent_enum->identifier) {
  3055. type.enum_type = element.parent_enum->identifier->name;
  3056. }
  3057. p_identifier->set_datatype(type);
  3058. if (element.resolved) {
  3059. p_identifier->is_constant = true;
  3060. p_identifier->reduced_value = element.value;
  3061. } else {
  3062. push_error(R"(Cannot use another enum element before it was declared.)", p_identifier);
  3063. }
  3064. return; // Found anyway.
  3065. }
  3066. }
  3067. }
  3068. bool found_source = false;
  3069. // Check if identifier is local.
  3070. // If that's the case, the declaration already was solved before.
  3071. switch (p_identifier->source) {
  3072. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER:
  3073. p_identifier->set_datatype(p_identifier->parameter_source->get_datatype());
  3074. found_source = true;
  3075. break;
  3076. case GDScriptParser::IdentifierNode::LOCAL_CONSTANT:
  3077. case GDScriptParser::IdentifierNode::MEMBER_CONSTANT:
  3078. p_identifier->set_datatype(p_identifier->constant_source->get_datatype());
  3079. p_identifier->is_constant = true;
  3080. // TODO: Constant should have a value on the node itself.
  3081. p_identifier->reduced_value = p_identifier->constant_source->initializer->reduced_value;
  3082. found_source = true;
  3083. break;
  3084. case GDScriptParser::IdentifierNode::MEMBER_SIGNAL:
  3085. case GDScriptParser::IdentifierNode::INHERITED_VARIABLE:
  3086. mark_lambda_use_self();
  3087. break;
  3088. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE:
  3089. mark_lambda_use_self();
  3090. p_identifier->variable_source->usages++;
  3091. [[fallthrough]];
  3092. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE:
  3093. p_identifier->set_datatype(p_identifier->variable_source->get_datatype());
  3094. found_source = true;
  3095. break;
  3096. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR:
  3097. p_identifier->set_datatype(p_identifier->bind_source->get_datatype());
  3098. found_source = true;
  3099. break;
  3100. case GDScriptParser::IdentifierNode::LOCAL_BIND: {
  3101. GDScriptParser::DataType result = p_identifier->bind_source->get_datatype();
  3102. result.is_constant = true;
  3103. p_identifier->set_datatype(result);
  3104. found_source = true;
  3105. } break;
  3106. case GDScriptParser::IdentifierNode::UNDEFINED_SOURCE:
  3107. break;
  3108. }
  3109. // Not a local, so check members.
  3110. if (!found_source) {
  3111. reduce_identifier_from_base(p_identifier);
  3112. if (p_identifier->source != GDScriptParser::IdentifierNode::UNDEFINED_SOURCE || p_identifier->get_datatype().is_set()) {
  3113. // Found.
  3114. found_source = true;
  3115. }
  3116. }
  3117. if (found_source) {
  3118. bool source_is_variable = p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_VARIABLE || p_identifier->source == GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3119. bool source_is_signal = p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_SIGNAL;
  3120. if ((source_is_variable || source_is_signal) && parser->current_function && parser->current_function->is_static) {
  3121. // Get the parent function above any lambda.
  3122. GDScriptParser::FunctionNode *parent_function = parser->current_function;
  3123. while (parent_function->source_lambda) {
  3124. parent_function = parent_function->source_lambda->parent_function;
  3125. }
  3126. push_error(vformat(R"*(Cannot access %s "%s" from the static function "%s()".)*", source_is_signal ? "signal" : "instance variable", p_identifier->name, parent_function->identifier->name), p_identifier);
  3127. }
  3128. if (!lambda_stack.is_empty()) {
  3129. // If the identifier is a member variable (including the native class properties) or a signal, we consider the lambda to be using `self`, so we keep a reference to the current instance.
  3130. if (source_is_variable || source_is_signal) {
  3131. mark_lambda_use_self();
  3132. return; // No need to capture.
  3133. }
  3134. // If the identifier is local, check if it's any kind of capture by comparing their source function.
  3135. // Only capture locals and enum values. Constants are still accessible from the lambda using the script reference. If not, this method is done.
  3136. if (p_identifier->source == GDScriptParser::IdentifierNode::UNDEFINED_SOURCE || p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_CONSTANT) {
  3137. return;
  3138. }
  3139. GDScriptParser::FunctionNode *function_test = lambda_stack.back()->get()->function;
  3140. // Make sure we aren't capturing variable in the same lambda.
  3141. // This also add captures for nested lambdas.
  3142. while (function_test != nullptr && function_test != p_identifier->source_function && function_test->source_lambda != nullptr && !function_test->source_lambda->captures_indices.has(p_identifier->name)) {
  3143. function_test->source_lambda->captures_indices[p_identifier->name] = function_test->source_lambda->captures.size();
  3144. function_test->source_lambda->captures.push_back(p_identifier);
  3145. function_test = function_test->source_lambda->parent_function;
  3146. }
  3147. }
  3148. return;
  3149. }
  3150. StringName name = p_identifier->name;
  3151. p_identifier->source = GDScriptParser::IdentifierNode::UNDEFINED_SOURCE;
  3152. // Check globals. We make an exception for Variant::OBJECT because it's the base class for
  3153. // non-builtin types so we allow doing e.g. Object.new()
  3154. Variant::Type builtin_type = GDScriptParser::get_builtin_type(name);
  3155. if (builtin_type != Variant::OBJECT && builtin_type < Variant::VARIANT_MAX) {
  3156. if (can_be_builtin) {
  3157. p_identifier->set_datatype(make_builtin_meta_type(builtin_type));
  3158. return;
  3159. } else {
  3160. push_error(R"(Builtin type cannot be used as a name on its own.)", p_identifier);
  3161. }
  3162. }
  3163. if (class_exists(name)) {
  3164. p_identifier->set_datatype(make_native_meta_type(name));
  3165. return;
  3166. }
  3167. if (ScriptServer::is_global_class(name)) {
  3168. p_identifier->set_datatype(make_global_class_meta_type(name, p_identifier));
  3169. return;
  3170. }
  3171. // Try singletons.
  3172. // Do this before globals because this might be a singleton loading another one before it's compiled.
  3173. if (ProjectSettings::get_singleton()->has_autoload(name)) {
  3174. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(name);
  3175. if (autoload.is_singleton) {
  3176. // Singleton exists, so it's at least a Node.
  3177. GDScriptParser::DataType result;
  3178. result.kind = GDScriptParser::DataType::NATIVE;
  3179. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3180. if (ResourceLoader::get_resource_type(autoload.path) == "GDScript") {
  3181. Ref<GDScriptParserRef> singl_parser = get_parser_for(autoload.path);
  3182. if (singl_parser.is_valid()) {
  3183. Error err = singl_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  3184. if (err == OK) {
  3185. result = type_from_metatype(singl_parser->get_parser()->head->get_datatype());
  3186. }
  3187. }
  3188. } else if (ResourceLoader::get_resource_type(autoload.path) == "PackedScene") {
  3189. if (GDScriptLanguage::get_singleton()->has_any_global_constant(name)) {
  3190. Variant constant = GDScriptLanguage::get_singleton()->get_any_global_constant(name);
  3191. Node *node = Object::cast_to<Node>(constant);
  3192. if (node != nullptr) {
  3193. Ref<GDScript> scr = node->get_script();
  3194. if (scr.is_valid()) {
  3195. Ref<GDScriptParserRef> singl_parser = get_parser_for(scr->get_script_path());
  3196. if (singl_parser.is_valid()) {
  3197. Error err = singl_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  3198. if (err == OK) {
  3199. result = type_from_metatype(singl_parser->get_parser()->head->get_datatype());
  3200. }
  3201. }
  3202. }
  3203. }
  3204. }
  3205. }
  3206. result.is_constant = true;
  3207. p_identifier->set_datatype(result);
  3208. return;
  3209. }
  3210. }
  3211. if (GDScriptLanguage::get_singleton()->has_any_global_constant(name)) {
  3212. Variant constant = GDScriptLanguage::get_singleton()->get_any_global_constant(name);
  3213. p_identifier->set_datatype(type_from_variant(constant, p_identifier));
  3214. p_identifier->is_constant = true;
  3215. p_identifier->reduced_value = constant;
  3216. return;
  3217. }
  3218. // Not found.
  3219. // Check if it's a builtin function.
  3220. if (GDScriptUtilityFunctions::function_exists(name)) {
  3221. push_error(vformat(R"(Built-in function "%s" cannot be used as an identifier.)", name), p_identifier);
  3222. } else {
  3223. #ifdef SUGGEST_GODOT4_RENAMES
  3224. String rename_hint = String();
  3225. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::Code::RENAMED_IN_GD4_HINT)).booleanize()) {
  3226. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  3227. if (renamed_identifier_name) {
  3228. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  3229. }
  3230. }
  3231. push_error(vformat(R"(Identifier "%s" not declared in the current scope.%s)", name, rename_hint), p_identifier);
  3232. #else
  3233. push_error(vformat(R"(Identifier "%s" not declared in the current scope.)", name), p_identifier);
  3234. #endif // SUGGEST_GODOT4_RENAMES
  3235. }
  3236. GDScriptParser::DataType dummy;
  3237. dummy.kind = GDScriptParser::DataType::VARIANT;
  3238. p_identifier->set_datatype(dummy); // Just so type is set to something.
  3239. }
  3240. void GDScriptAnalyzer::reduce_lambda(GDScriptParser::LambdaNode *p_lambda) {
  3241. // Lambda is always a Callable.
  3242. GDScriptParser::DataType lambda_type;
  3243. lambda_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  3244. lambda_type.kind = GDScriptParser::DataType::BUILTIN;
  3245. lambda_type.builtin_type = Variant::CALLABLE;
  3246. p_lambda->set_datatype(lambda_type);
  3247. if (p_lambda->function == nullptr) {
  3248. return;
  3249. }
  3250. lambda_stack.push_back(p_lambda);
  3251. resolve_function_signature(p_lambda->function, p_lambda, true);
  3252. resolve_function_body(p_lambda->function, true);
  3253. lambda_stack.pop_back();
  3254. int captures_amount = p_lambda->captures.size();
  3255. if (captures_amount > 0) {
  3256. // Create space for lambda parameters.
  3257. // At the beginning to not mess with optional parameters.
  3258. int param_count = p_lambda->function->parameters.size();
  3259. p_lambda->function->parameters.resize(param_count + captures_amount);
  3260. for (int i = param_count - 1; i >= 0; i--) {
  3261. p_lambda->function->parameters.write[i + captures_amount] = p_lambda->function->parameters[i];
  3262. p_lambda->function->parameters_indices[p_lambda->function->parameters[i]->identifier->name] = i + captures_amount;
  3263. }
  3264. // Add captures as extra parameters at the beginning.
  3265. for (int i = 0; i < p_lambda->captures.size(); i++) {
  3266. GDScriptParser::IdentifierNode *capture = p_lambda->captures[i];
  3267. GDScriptParser::ParameterNode *capture_param = parser->alloc_node<GDScriptParser::ParameterNode>();
  3268. capture_param->identifier = capture;
  3269. capture_param->usages = capture->usages;
  3270. capture_param->set_datatype(capture->get_datatype());
  3271. p_lambda->function->parameters.write[i] = capture_param;
  3272. p_lambda->function->parameters_indices[capture->name] = i;
  3273. }
  3274. }
  3275. }
  3276. void GDScriptAnalyzer::reduce_literal(GDScriptParser::LiteralNode *p_literal) {
  3277. p_literal->reduced_value = p_literal->value;
  3278. p_literal->is_constant = true;
  3279. p_literal->set_datatype(type_from_variant(p_literal->reduced_value, p_literal));
  3280. }
  3281. void GDScriptAnalyzer::reduce_preload(GDScriptParser::PreloadNode *p_preload) {
  3282. if (!p_preload->path) {
  3283. return;
  3284. }
  3285. reduce_expression(p_preload->path);
  3286. if (!p_preload->path->is_constant) {
  3287. push_error("Preloaded path must be a constant string.", p_preload->path);
  3288. return;
  3289. }
  3290. if (p_preload->path->reduced_value.get_type() != Variant::STRING) {
  3291. push_error("Preloaded path must be a constant string.", p_preload->path);
  3292. } else {
  3293. p_preload->resolved_path = p_preload->path->reduced_value;
  3294. // TODO: Save this as script dependency.
  3295. if (p_preload->resolved_path.is_relative_path()) {
  3296. p_preload->resolved_path = parser->script_path.get_base_dir().path_join(p_preload->resolved_path);
  3297. }
  3298. p_preload->resolved_path = p_preload->resolved_path.simplify_path();
  3299. if (!ResourceLoader::exists(p_preload->resolved_path)) {
  3300. Ref<FileAccess> file_check = FileAccess::create(FileAccess::ACCESS_RESOURCES);
  3301. if (file_check->file_exists(p_preload->resolved_path)) {
  3302. push_error(vformat(R"(Preload file "%s" has no resource loaders (unrecognized file extension).)", p_preload->resolved_path), p_preload->path);
  3303. } else {
  3304. push_error(vformat(R"(Preload file "%s" does not exist.)", p_preload->resolved_path), p_preload->path);
  3305. }
  3306. } else {
  3307. // TODO: Don't load if validating: use completion cache.
  3308. // Must load GDScript and PackedScenes separately to permit cyclic references
  3309. // as ResourceLoader::load() detect and reject those.
  3310. if (ResourceLoader::get_resource_type(p_preload->resolved_path) == "GDScript") {
  3311. Error err = OK;
  3312. Ref<GDScript> res = GDScriptCache::get_shallow_script(p_preload->resolved_path, err, parser->script_path);
  3313. p_preload->resource = res;
  3314. if (err != OK) {
  3315. push_error(vformat(R"(Could not preload resource script "%s".)", p_preload->resolved_path), p_preload->path);
  3316. }
  3317. } else if (ResourceLoader::get_resource_type(p_preload->resolved_path) == "PackedScene") {
  3318. Error err = OK;
  3319. Ref<PackedScene> res = GDScriptCache::get_packed_scene(p_preload->resolved_path, err, parser->script_path);
  3320. p_preload->resource = res;
  3321. if (err != OK) {
  3322. push_error(vformat(R"(Could not preload resource scene "%s".)", p_preload->resolved_path), p_preload->path);
  3323. }
  3324. } else {
  3325. p_preload->resource = ResourceLoader::load(p_preload->resolved_path);
  3326. if (p_preload->resource.is_null()) {
  3327. push_error(vformat(R"(Could not preload resource file "%s".)", p_preload->resolved_path), p_preload->path);
  3328. }
  3329. }
  3330. }
  3331. }
  3332. p_preload->is_constant = true;
  3333. p_preload->reduced_value = p_preload->resource;
  3334. p_preload->set_datatype(type_from_variant(p_preload->reduced_value, p_preload));
  3335. }
  3336. void GDScriptAnalyzer::reduce_self(GDScriptParser::SelfNode *p_self) {
  3337. p_self->is_constant = false;
  3338. p_self->set_datatype(type_from_metatype(parser->current_class->get_datatype()));
  3339. mark_lambda_use_self();
  3340. }
  3341. void GDScriptAnalyzer::reduce_subscript(GDScriptParser::SubscriptNode *p_subscript) {
  3342. if (p_subscript->base == nullptr) {
  3343. return;
  3344. }
  3345. if (p_subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  3346. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base), true);
  3347. } else {
  3348. reduce_expression(p_subscript->base);
  3349. }
  3350. GDScriptParser::DataType result_type;
  3351. if (p_subscript->is_attribute) {
  3352. if (p_subscript->attribute == nullptr) {
  3353. return;
  3354. }
  3355. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  3356. bool valid = false;
  3357. // If the base is a metatype, use the analyzer instead.
  3358. if (p_subscript->base->is_constant && !base_type.is_meta_type) {
  3359. // Just try to get it.
  3360. Variant value = p_subscript->base->reduced_value.get_named(p_subscript->attribute->name, valid);
  3361. if (valid) {
  3362. p_subscript->is_constant = true;
  3363. p_subscript->reduced_value = value;
  3364. result_type = type_from_variant(value, p_subscript);
  3365. }
  3366. } else if (base_type.is_variant() || !base_type.is_hard_type()) {
  3367. valid = true;
  3368. result_type.kind = GDScriptParser::DataType::VARIANT;
  3369. mark_node_unsafe(p_subscript);
  3370. } else {
  3371. reduce_identifier_from_base(p_subscript->attribute, &base_type);
  3372. GDScriptParser::DataType attr_type = p_subscript->attribute->get_datatype();
  3373. if (attr_type.is_set()) {
  3374. valid = true;
  3375. result_type = attr_type;
  3376. p_subscript->is_constant = p_subscript->attribute->is_constant;
  3377. p_subscript->reduced_value = p_subscript->attribute->reduced_value;
  3378. } else if (!base_type.is_meta_type || !base_type.is_constant) {
  3379. valid = base_type.kind != GDScriptParser::DataType::BUILTIN;
  3380. #ifdef DEBUG_ENABLED
  3381. if (valid) {
  3382. parser->push_warning(p_subscript, GDScriptWarning::UNSAFE_PROPERTY_ACCESS, p_subscript->attribute->name, base_type.to_string());
  3383. }
  3384. #endif
  3385. result_type.kind = GDScriptParser::DataType::VARIANT;
  3386. mark_node_unsafe(p_subscript);
  3387. }
  3388. }
  3389. if (!valid) {
  3390. push_error(vformat(R"(Cannot find member "%s" in base "%s".)", p_subscript->attribute->name, type_from_metatype(base_type).to_string()), p_subscript->attribute);
  3391. result_type.kind = GDScriptParser::DataType::VARIANT;
  3392. }
  3393. } else {
  3394. if (p_subscript->index == nullptr) {
  3395. return;
  3396. }
  3397. reduce_expression(p_subscript->index);
  3398. if (p_subscript->base->is_constant && p_subscript->index->is_constant) {
  3399. // Just try to get it.
  3400. bool valid = false;
  3401. Variant value = p_subscript->base->reduced_value.get(p_subscript->index->reduced_value, &valid);
  3402. if (!valid) {
  3403. push_error(vformat(R"(Cannot get index "%s" from "%s".)", p_subscript->index->reduced_value, p_subscript->base->reduced_value), p_subscript->index);
  3404. result_type.kind = GDScriptParser::DataType::VARIANT;
  3405. } else {
  3406. p_subscript->is_constant = true;
  3407. p_subscript->reduced_value = value;
  3408. result_type = type_from_variant(value, p_subscript);
  3409. }
  3410. } else {
  3411. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  3412. GDScriptParser::DataType index_type = p_subscript->index->get_datatype();
  3413. if (base_type.is_variant()) {
  3414. result_type.kind = GDScriptParser::DataType::VARIANT;
  3415. mark_node_unsafe(p_subscript);
  3416. } else {
  3417. if (base_type.kind == GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  3418. // Check if indexing is valid.
  3419. bool error = index_type.kind != GDScriptParser::DataType::BUILTIN && base_type.builtin_type != Variant::DICTIONARY;
  3420. if (!error) {
  3421. switch (base_type.builtin_type) {
  3422. // Expect int or real as index.
  3423. case Variant::PACKED_BYTE_ARRAY:
  3424. case Variant::PACKED_COLOR_ARRAY:
  3425. case Variant::PACKED_FLOAT32_ARRAY:
  3426. case Variant::PACKED_FLOAT64_ARRAY:
  3427. case Variant::PACKED_INT32_ARRAY:
  3428. case Variant::PACKED_INT64_ARRAY:
  3429. case Variant::PACKED_STRING_ARRAY:
  3430. case Variant::PACKED_VECTOR2_ARRAY:
  3431. case Variant::PACKED_VECTOR3_ARRAY:
  3432. case Variant::ARRAY:
  3433. case Variant::STRING:
  3434. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT;
  3435. break;
  3436. // Expect String only.
  3437. case Variant::RECT2:
  3438. case Variant::RECT2I:
  3439. case Variant::PLANE:
  3440. case Variant::QUATERNION:
  3441. case Variant::AABB:
  3442. case Variant::OBJECT:
  3443. error = index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  3444. break;
  3445. // Expect String or number.
  3446. case Variant::BASIS:
  3447. case Variant::VECTOR2:
  3448. case Variant::VECTOR2I:
  3449. case Variant::VECTOR3:
  3450. case Variant::VECTOR3I:
  3451. case Variant::VECTOR4:
  3452. case Variant::VECTOR4I:
  3453. case Variant::TRANSFORM2D:
  3454. case Variant::TRANSFORM3D:
  3455. case Variant::PROJECTION:
  3456. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT &&
  3457. index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  3458. break;
  3459. // Expect String or int.
  3460. case Variant::COLOR:
  3461. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  3462. break;
  3463. // Don't support indexing, but we will check it later.
  3464. case Variant::RID:
  3465. case Variant::BOOL:
  3466. case Variant::CALLABLE:
  3467. case Variant::FLOAT:
  3468. case Variant::INT:
  3469. case Variant::NIL:
  3470. case Variant::NODE_PATH:
  3471. case Variant::SIGNAL:
  3472. case Variant::STRING_NAME:
  3473. break;
  3474. // Here for completeness.
  3475. case Variant::DICTIONARY:
  3476. case Variant::VARIANT_MAX:
  3477. break;
  3478. }
  3479. if (error) {
  3480. push_error(vformat(R"(Invalid index type "%s" for a base of type "%s".)", index_type.to_string(), base_type.to_string()), p_subscript->index);
  3481. }
  3482. }
  3483. } else if (base_type.kind != GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  3484. if (index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME) {
  3485. push_error(vformat(R"(Only String or StringName can be used as index for type "%s", but received a "%s".)", base_type.to_string(), index_type.to_string()), p_subscript->index);
  3486. }
  3487. }
  3488. // Check resulting type if possible.
  3489. result_type.builtin_type = Variant::NIL;
  3490. result_type.kind = GDScriptParser::DataType::BUILTIN;
  3491. result_type.type_source = base_type.is_hard_type() ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  3492. if (base_type.kind != GDScriptParser::DataType::BUILTIN) {
  3493. base_type.builtin_type = Variant::OBJECT;
  3494. }
  3495. switch (base_type.builtin_type) {
  3496. // Can't index at all.
  3497. case Variant::RID:
  3498. case Variant::BOOL:
  3499. case Variant::CALLABLE:
  3500. case Variant::FLOAT:
  3501. case Variant::INT:
  3502. case Variant::NIL:
  3503. case Variant::NODE_PATH:
  3504. case Variant::SIGNAL:
  3505. case Variant::STRING_NAME:
  3506. result_type.kind = GDScriptParser::DataType::VARIANT;
  3507. push_error(vformat(R"(Cannot use subscript operator on a base of type "%s".)", base_type.to_string()), p_subscript->base);
  3508. break;
  3509. // Return int.
  3510. case Variant::PACKED_BYTE_ARRAY:
  3511. case Variant::PACKED_INT32_ARRAY:
  3512. case Variant::PACKED_INT64_ARRAY:
  3513. case Variant::VECTOR2I:
  3514. case Variant::VECTOR3I:
  3515. case Variant::VECTOR4I:
  3516. result_type.builtin_type = Variant::INT;
  3517. break;
  3518. // Return float.
  3519. case Variant::PACKED_FLOAT32_ARRAY:
  3520. case Variant::PACKED_FLOAT64_ARRAY:
  3521. case Variant::VECTOR2:
  3522. case Variant::VECTOR3:
  3523. case Variant::VECTOR4:
  3524. case Variant::QUATERNION:
  3525. result_type.builtin_type = Variant::FLOAT;
  3526. break;
  3527. // Return Color.
  3528. case Variant::PACKED_COLOR_ARRAY:
  3529. result_type.builtin_type = Variant::COLOR;
  3530. break;
  3531. // Return String.
  3532. case Variant::PACKED_STRING_ARRAY:
  3533. case Variant::STRING:
  3534. result_type.builtin_type = Variant::STRING;
  3535. break;
  3536. // Return Vector2.
  3537. case Variant::PACKED_VECTOR2_ARRAY:
  3538. case Variant::TRANSFORM2D:
  3539. case Variant::RECT2:
  3540. result_type.builtin_type = Variant::VECTOR2;
  3541. break;
  3542. // Return Vector2I.
  3543. case Variant::RECT2I:
  3544. result_type.builtin_type = Variant::VECTOR2I;
  3545. break;
  3546. // Return Vector3.
  3547. case Variant::PACKED_VECTOR3_ARRAY:
  3548. case Variant::AABB:
  3549. case Variant::BASIS:
  3550. result_type.builtin_type = Variant::VECTOR3;
  3551. break;
  3552. // Depends on the index.
  3553. case Variant::TRANSFORM3D:
  3554. case Variant::PROJECTION:
  3555. case Variant::PLANE:
  3556. case Variant::COLOR:
  3557. case Variant::DICTIONARY:
  3558. case Variant::OBJECT:
  3559. result_type.kind = GDScriptParser::DataType::VARIANT;
  3560. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  3561. break;
  3562. // Can have an element type.
  3563. case Variant::ARRAY:
  3564. if (base_type.has_container_element_type()) {
  3565. result_type = base_type.get_container_element_type();
  3566. result_type.type_source = base_type.type_source;
  3567. } else {
  3568. result_type.kind = GDScriptParser::DataType::VARIANT;
  3569. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  3570. }
  3571. break;
  3572. // Here for completeness.
  3573. case Variant::VARIANT_MAX:
  3574. break;
  3575. }
  3576. }
  3577. }
  3578. }
  3579. p_subscript->set_datatype(result_type);
  3580. }
  3581. void GDScriptAnalyzer::reduce_ternary_op(GDScriptParser::TernaryOpNode *p_ternary_op, bool p_is_root) {
  3582. reduce_expression(p_ternary_op->condition);
  3583. reduce_expression(p_ternary_op->true_expr, p_is_root);
  3584. reduce_expression(p_ternary_op->false_expr, p_is_root);
  3585. GDScriptParser::DataType result;
  3586. if (p_ternary_op->condition && p_ternary_op->condition->is_constant && p_ternary_op->true_expr->is_constant && p_ternary_op->false_expr && p_ternary_op->false_expr->is_constant) {
  3587. p_ternary_op->is_constant = true;
  3588. if (p_ternary_op->condition->reduced_value.booleanize()) {
  3589. p_ternary_op->reduced_value = p_ternary_op->true_expr->reduced_value;
  3590. } else {
  3591. p_ternary_op->reduced_value = p_ternary_op->false_expr->reduced_value;
  3592. }
  3593. }
  3594. GDScriptParser::DataType true_type;
  3595. if (p_ternary_op->true_expr) {
  3596. true_type = p_ternary_op->true_expr->get_datatype();
  3597. } else {
  3598. true_type.kind = GDScriptParser::DataType::VARIANT;
  3599. }
  3600. GDScriptParser::DataType false_type;
  3601. if (p_ternary_op->false_expr) {
  3602. false_type = p_ternary_op->false_expr->get_datatype();
  3603. } else {
  3604. false_type.kind = GDScriptParser::DataType::VARIANT;
  3605. }
  3606. if (true_type.is_variant() || false_type.is_variant()) {
  3607. result.kind = GDScriptParser::DataType::VARIANT;
  3608. } else {
  3609. result = true_type;
  3610. if (!is_type_compatible(true_type, false_type)) {
  3611. result = false_type;
  3612. if (!is_type_compatible(false_type, true_type)) {
  3613. result.kind = GDScriptParser::DataType::VARIANT;
  3614. #ifdef DEBUG_ENABLED
  3615. parser->push_warning(p_ternary_op, GDScriptWarning::INCOMPATIBLE_TERNARY);
  3616. #endif
  3617. }
  3618. }
  3619. }
  3620. result.type_source = true_type.is_hard_type() && false_type.is_hard_type() ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  3621. p_ternary_op->set_datatype(result);
  3622. }
  3623. void GDScriptAnalyzer::reduce_type_test(GDScriptParser::TypeTestNode *p_type_test) {
  3624. GDScriptParser::DataType result;
  3625. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3626. result.kind = GDScriptParser::DataType::BUILTIN;
  3627. result.builtin_type = Variant::BOOL;
  3628. p_type_test->set_datatype(result);
  3629. if (!p_type_test->operand || !p_type_test->test_type) {
  3630. return;
  3631. }
  3632. reduce_expression(p_type_test->operand);
  3633. GDScriptParser::DataType operand_type = p_type_test->operand->get_datatype();
  3634. GDScriptParser::DataType test_type = type_from_metatype(resolve_datatype(p_type_test->test_type));
  3635. p_type_test->test_datatype = test_type;
  3636. if (!operand_type.is_set() || !test_type.is_set()) {
  3637. return;
  3638. }
  3639. if (p_type_test->operand->is_constant) {
  3640. p_type_test->is_constant = true;
  3641. p_type_test->reduced_value = false;
  3642. if (!is_type_compatible(test_type, operand_type)) {
  3643. push_error(vformat(R"(Expression is of type "%s" so it can't be of type "%s".)", operand_type.to_string(), test_type.to_string()), p_type_test->operand);
  3644. } else if (is_type_compatible(test_type, type_from_variant(p_type_test->operand->reduced_value, p_type_test->operand))) {
  3645. p_type_test->reduced_value = test_type.builtin_type != Variant::OBJECT || !p_type_test->operand->reduced_value.is_null();
  3646. }
  3647. return;
  3648. }
  3649. if (!is_type_compatible(test_type, operand_type) && !is_type_compatible(operand_type, test_type)) {
  3650. if (operand_type.is_hard_type()) {
  3651. push_error(vformat(R"(Expression is of type "%s" so it can't be of type "%s".)", operand_type.to_string(), test_type.to_string()), p_type_test->operand);
  3652. } else {
  3653. downgrade_node_type_source(p_type_test->operand);
  3654. }
  3655. }
  3656. }
  3657. void GDScriptAnalyzer::reduce_unary_op(GDScriptParser::UnaryOpNode *p_unary_op) {
  3658. reduce_expression(p_unary_op->operand);
  3659. GDScriptParser::DataType result;
  3660. if (p_unary_op->operand == nullptr) {
  3661. result.kind = GDScriptParser::DataType::VARIANT;
  3662. p_unary_op->set_datatype(result);
  3663. return;
  3664. }
  3665. GDScriptParser::DataType operand_type = p_unary_op->operand->get_datatype();
  3666. if (p_unary_op->operand->is_constant) {
  3667. p_unary_op->is_constant = true;
  3668. p_unary_op->reduced_value = Variant::evaluate(p_unary_op->variant_op, p_unary_op->operand->reduced_value, Variant());
  3669. result = type_from_variant(p_unary_op->reduced_value, p_unary_op);
  3670. }
  3671. if (operand_type.is_variant()) {
  3672. result.kind = GDScriptParser::DataType::VARIANT;
  3673. mark_node_unsafe(p_unary_op);
  3674. } else {
  3675. bool valid = false;
  3676. result = get_operation_type(p_unary_op->variant_op, operand_type, valid, p_unary_op);
  3677. if (!valid) {
  3678. push_error(vformat(R"(Invalid operand of type "%s" for unary operator "%s".)", operand_type.to_string(), Variant::get_operator_name(p_unary_op->variant_op)), p_unary_op);
  3679. }
  3680. }
  3681. p_unary_op->set_datatype(result);
  3682. }
  3683. Variant GDScriptAnalyzer::make_expression_reduced_value(GDScriptParser::ExpressionNode *p_expression, bool &is_reduced) {
  3684. Variant value;
  3685. if (p_expression == nullptr) {
  3686. return value;
  3687. }
  3688. if (p_expression->is_constant) {
  3689. is_reduced = true;
  3690. value = p_expression->reduced_value;
  3691. } else if (p_expression->type == GDScriptParser::Node::ARRAY) {
  3692. value = make_array_reduced_value(static_cast<GDScriptParser::ArrayNode *>(p_expression), is_reduced);
  3693. } else if (p_expression->type == GDScriptParser::Node::DICTIONARY) {
  3694. value = make_dictionary_reduced_value(static_cast<GDScriptParser::DictionaryNode *>(p_expression), is_reduced);
  3695. } else if (p_expression->type == GDScriptParser::Node::SUBSCRIPT) {
  3696. value = make_subscript_reduced_value(static_cast<GDScriptParser::SubscriptNode *>(p_expression), is_reduced);
  3697. }
  3698. return value;
  3699. }
  3700. Variant GDScriptAnalyzer::make_array_reduced_value(GDScriptParser::ArrayNode *p_array, bool &is_reduced) {
  3701. Array array = p_array->get_datatype().has_container_element_type() ? make_array_from_element_datatype(p_array->get_datatype().get_container_element_type()) : Array();
  3702. array.resize(p_array->elements.size());
  3703. for (int i = 0; i < p_array->elements.size(); i++) {
  3704. GDScriptParser::ExpressionNode *element = p_array->elements[i];
  3705. bool is_element_value_reduced = false;
  3706. Variant element_value = make_expression_reduced_value(element, is_element_value_reduced);
  3707. if (!is_element_value_reduced) {
  3708. return Variant();
  3709. }
  3710. array[i] = element_value;
  3711. }
  3712. array.make_read_only();
  3713. is_reduced = true;
  3714. return array;
  3715. }
  3716. Variant GDScriptAnalyzer::make_dictionary_reduced_value(GDScriptParser::DictionaryNode *p_dictionary, bool &is_reduced) {
  3717. Dictionary dictionary;
  3718. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  3719. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  3720. bool is_element_key_reduced = false;
  3721. Variant element_key = make_expression_reduced_value(element.key, is_element_key_reduced);
  3722. if (!is_element_key_reduced) {
  3723. return Variant();
  3724. }
  3725. bool is_element_value_reduced = false;
  3726. Variant element_value = make_expression_reduced_value(element.value, is_element_value_reduced);
  3727. if (!is_element_value_reduced) {
  3728. return Variant();
  3729. }
  3730. dictionary[element_key] = element_value;
  3731. }
  3732. dictionary.make_read_only();
  3733. is_reduced = true;
  3734. return dictionary;
  3735. }
  3736. Variant GDScriptAnalyzer::make_subscript_reduced_value(GDScriptParser::SubscriptNode *p_subscript, bool &is_reduced) {
  3737. if (p_subscript->base == nullptr || p_subscript->index == nullptr) {
  3738. return Variant();
  3739. }
  3740. bool is_base_value_reduced = false;
  3741. Variant base_value = make_expression_reduced_value(p_subscript->base, is_base_value_reduced);
  3742. if (!is_base_value_reduced) {
  3743. return Variant();
  3744. }
  3745. if (p_subscript->is_attribute) {
  3746. bool is_valid = false;
  3747. Variant value = base_value.get_named(p_subscript->attribute->name, is_valid);
  3748. if (is_valid) {
  3749. is_reduced = true;
  3750. return value;
  3751. } else {
  3752. return Variant();
  3753. }
  3754. } else {
  3755. bool is_index_value_reduced = false;
  3756. Variant index_value = make_expression_reduced_value(p_subscript->index, is_index_value_reduced);
  3757. if (!is_index_value_reduced) {
  3758. return Variant();
  3759. }
  3760. bool is_valid = false;
  3761. Variant value = base_value.get(index_value, &is_valid);
  3762. if (is_valid) {
  3763. is_reduced = true;
  3764. return value;
  3765. } else {
  3766. return Variant();
  3767. }
  3768. }
  3769. }
  3770. Array GDScriptAnalyzer::make_array_from_element_datatype(const GDScriptParser::DataType &p_element_datatype, const GDScriptParser::Node *p_source_node) {
  3771. Array array;
  3772. if (p_element_datatype.builtin_type == Variant::OBJECT) {
  3773. Ref<Script> script_type = p_element_datatype.script_type;
  3774. if (p_element_datatype.kind == GDScriptParser::DataType::CLASS && script_type.is_null()) {
  3775. Error err = OK;
  3776. Ref<GDScript> scr = GDScriptCache::get_shallow_script(p_element_datatype.script_path, err);
  3777. if (err) {
  3778. push_error(vformat(R"(Error while getting cache for script "%s".)", p_element_datatype.script_path), p_source_node);
  3779. return array;
  3780. }
  3781. script_type.reference_ptr(scr->find_class(p_element_datatype.class_type->fqcn));
  3782. }
  3783. array.set_typed(p_element_datatype.builtin_type, p_element_datatype.native_type, script_type);
  3784. } else {
  3785. array.set_typed(p_element_datatype.builtin_type, StringName(), Variant());
  3786. }
  3787. return array;
  3788. }
  3789. Variant GDScriptAnalyzer::make_variable_default_value(GDScriptParser::VariableNode *p_variable) {
  3790. Variant result = Variant();
  3791. if (p_variable->initializer) {
  3792. bool is_initializer_value_reduced = false;
  3793. Variant initializer_value = make_expression_reduced_value(p_variable->initializer, is_initializer_value_reduced);
  3794. if (is_initializer_value_reduced) {
  3795. result = initializer_value;
  3796. }
  3797. } else {
  3798. GDScriptParser::DataType datatype = p_variable->get_datatype();
  3799. if (datatype.is_hard_type()) {
  3800. if (datatype.kind == GDScriptParser::DataType::BUILTIN && datatype.builtin_type != Variant::OBJECT) {
  3801. if (datatype.builtin_type == Variant::ARRAY && datatype.has_container_element_type()) {
  3802. result = make_array_from_element_datatype(datatype.get_container_element_type());
  3803. } else {
  3804. VariantInternal::initialize(&result, datatype.builtin_type);
  3805. }
  3806. } else if (datatype.kind == GDScriptParser::DataType::ENUM) {
  3807. result = 0;
  3808. }
  3809. }
  3810. }
  3811. return result;
  3812. }
  3813. GDScriptParser::DataType GDScriptAnalyzer::type_from_variant(const Variant &p_value, const GDScriptParser::Node *p_source) {
  3814. GDScriptParser::DataType result;
  3815. result.is_constant = true;
  3816. result.kind = GDScriptParser::DataType::BUILTIN;
  3817. result.builtin_type = p_value.get_type();
  3818. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT; // Constant has explicit type.
  3819. if (p_value.get_type() == Variant::OBJECT) {
  3820. // Object is treated as a native type, not a builtin type.
  3821. result.kind = GDScriptParser::DataType::NATIVE;
  3822. Object *obj = p_value;
  3823. if (!obj) {
  3824. return GDScriptParser::DataType();
  3825. }
  3826. result.native_type = obj->get_class_name();
  3827. Ref<Script> scr = p_value; // Check if value is a script itself.
  3828. if (scr.is_valid()) {
  3829. result.is_meta_type = true;
  3830. } else {
  3831. result.is_meta_type = false;
  3832. scr = obj->get_script();
  3833. }
  3834. if (scr.is_valid()) {
  3835. Ref<GDScript> gds = scr;
  3836. if (gds.is_valid()) {
  3837. // This might be an inner class, so we want to get the parser for the root.
  3838. // But still get the inner class from that tree.
  3839. String script_path = gds->get_script_path();
  3840. Ref<GDScriptParserRef> ref = get_parser_for(script_path);
  3841. if (ref.is_null()) {
  3842. push_error(vformat(R"(Could not find script "%s".)", script_path), p_source);
  3843. GDScriptParser::DataType error_type;
  3844. error_type.kind = GDScriptParser::DataType::VARIANT;
  3845. return error_type;
  3846. }
  3847. Error err = ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  3848. GDScriptParser::ClassNode *found = nullptr;
  3849. if (err == OK) {
  3850. found = ref->get_parser()->find_class(gds->fully_qualified_name);
  3851. if (found != nullptr) {
  3852. err = resolve_class_inheritance(found, p_source);
  3853. }
  3854. }
  3855. if (err || found == nullptr) {
  3856. push_error(vformat(R"(Could not resolve script "%s".)", script_path), p_source);
  3857. GDScriptParser::DataType error_type;
  3858. error_type.kind = GDScriptParser::DataType::VARIANT;
  3859. return error_type;
  3860. }
  3861. result.kind = GDScriptParser::DataType::CLASS;
  3862. result.native_type = found->get_datatype().native_type;
  3863. result.class_type = found;
  3864. result.script_path = ref->get_parser()->script_path;
  3865. } else {
  3866. result.kind = GDScriptParser::DataType::SCRIPT;
  3867. result.native_type = scr->get_instance_base_type();
  3868. result.script_path = scr->get_path();
  3869. }
  3870. result.script_type = scr;
  3871. } else {
  3872. result.kind = GDScriptParser::DataType::NATIVE;
  3873. if (result.native_type == GDScriptNativeClass::get_class_static()) {
  3874. result.is_meta_type = true;
  3875. }
  3876. }
  3877. }
  3878. return result;
  3879. }
  3880. GDScriptParser::DataType GDScriptAnalyzer::type_from_metatype(const GDScriptParser::DataType &p_meta_type) {
  3881. GDScriptParser::DataType result = p_meta_type;
  3882. result.is_meta_type = false;
  3883. if (p_meta_type.kind == GDScriptParser::DataType::ENUM) {
  3884. result.builtin_type = Variant::INT;
  3885. } else {
  3886. result.is_constant = false;
  3887. }
  3888. return result;
  3889. }
  3890. GDScriptParser::DataType GDScriptAnalyzer::type_from_property(const PropertyInfo &p_property, bool p_is_arg, bool p_is_readonly) const {
  3891. GDScriptParser::DataType result;
  3892. result.is_read_only = p_is_readonly;
  3893. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3894. if (p_property.type == Variant::NIL && (p_is_arg || (p_property.usage & PROPERTY_USAGE_NIL_IS_VARIANT))) {
  3895. // Variant
  3896. result.kind = GDScriptParser::DataType::VARIANT;
  3897. return result;
  3898. }
  3899. result.builtin_type = p_property.type;
  3900. if (p_property.type == Variant::OBJECT) {
  3901. result.kind = GDScriptParser::DataType::NATIVE;
  3902. result.native_type = p_property.class_name == StringName() ? SNAME("Object") : p_property.class_name;
  3903. } else {
  3904. result.kind = GDScriptParser::DataType::BUILTIN;
  3905. result.builtin_type = p_property.type;
  3906. if (p_property.type == Variant::ARRAY && p_property.hint == PROPERTY_HINT_ARRAY_TYPE) {
  3907. // Check element type.
  3908. StringName elem_type_name = p_property.hint_string;
  3909. GDScriptParser::DataType elem_type;
  3910. elem_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3911. Variant::Type elem_builtin_type = GDScriptParser::get_builtin_type(elem_type_name);
  3912. if (elem_builtin_type < Variant::VARIANT_MAX) {
  3913. // Builtin type.
  3914. elem_type.kind = GDScriptParser::DataType::BUILTIN;
  3915. elem_type.builtin_type = elem_builtin_type;
  3916. } else if (class_exists(elem_type_name)) {
  3917. elem_type.kind = GDScriptParser::DataType::NATIVE;
  3918. elem_type.builtin_type = Variant::OBJECT;
  3919. elem_type.native_type = p_property.hint_string;
  3920. } else if (ScriptServer::is_global_class(elem_type_name)) {
  3921. // Just load this as it shouldn't be a GDScript.
  3922. Ref<Script> script = ResourceLoader::load(ScriptServer::get_global_class_path(elem_type_name));
  3923. elem_type.kind = GDScriptParser::DataType::SCRIPT;
  3924. elem_type.builtin_type = Variant::OBJECT;
  3925. elem_type.native_type = script->get_instance_base_type();
  3926. elem_type.script_type = script;
  3927. } else {
  3928. ERR_FAIL_V_MSG(result, "Could not find element type from property hint of a typed array.");
  3929. }
  3930. elem_type.is_constant = false;
  3931. result.set_container_element_type(elem_type);
  3932. } else if (p_property.type == Variant::INT) {
  3933. // Check if it's enum.
  3934. if (p_property.class_name != StringName()) {
  3935. Vector<String> names = String(p_property.class_name).split(".");
  3936. if (names.size() == 2) {
  3937. result = make_native_enum_type(names[1], names[0], false);
  3938. result.is_constant = false;
  3939. }
  3940. }
  3941. }
  3942. }
  3943. return result;
  3944. }
  3945. bool GDScriptAnalyzer::get_function_signature(GDScriptParser::Node *p_source, bool p_is_constructor, GDScriptParser::DataType p_base_type, const StringName &p_function, GDScriptParser::DataType &r_return_type, List<GDScriptParser::DataType> &r_par_types, int &r_default_arg_count, bool &r_static, bool &r_vararg, StringName *r_native_class) {
  3946. r_static = false;
  3947. r_vararg = false;
  3948. r_default_arg_count = 0;
  3949. if (r_native_class) {
  3950. *r_native_class = StringName();
  3951. }
  3952. StringName function_name = p_function;
  3953. bool was_enum = false;
  3954. if (p_base_type.kind == GDScriptParser::DataType::ENUM) {
  3955. was_enum = true;
  3956. if (p_base_type.is_meta_type) {
  3957. // Enum type can be treated as a dictionary value.
  3958. p_base_type.kind = GDScriptParser::DataType::BUILTIN;
  3959. p_base_type.is_meta_type = false;
  3960. } else {
  3961. push_error("Cannot call function on enum value.", p_source);
  3962. return false;
  3963. }
  3964. }
  3965. if (p_base_type.kind == GDScriptParser::DataType::BUILTIN) {
  3966. // Construct a base type to get methods.
  3967. Callable::CallError err;
  3968. Variant dummy;
  3969. Variant::construct(p_base_type.builtin_type, dummy, nullptr, 0, err);
  3970. if (err.error != Callable::CallError::CALL_OK) {
  3971. ERR_FAIL_V_MSG(false, "Could not construct base Variant type.");
  3972. }
  3973. List<MethodInfo> methods;
  3974. dummy.get_method_list(&methods);
  3975. for (const MethodInfo &E : methods) {
  3976. if (E.name == p_function) {
  3977. function_signature_from_info(E, r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  3978. r_static = Variant::is_builtin_method_static(p_base_type.builtin_type, function_name);
  3979. // Cannot use non-const methods on enums.
  3980. if (!r_static && was_enum && !(E.flags & METHOD_FLAG_CONST)) {
  3981. push_error(vformat(R"*(Cannot call non-const Dictionary function "%s()" on enum "%s".)*", p_function, p_base_type.enum_type), p_source);
  3982. }
  3983. return true;
  3984. }
  3985. }
  3986. return false;
  3987. }
  3988. StringName base_native = p_base_type.native_type;
  3989. if (base_native != StringName()) {
  3990. // Empty native class might happen in some Script implementations.
  3991. // Just ignore it.
  3992. if (!class_exists(base_native)) {
  3993. push_error(vformat("Native class %s used in script doesn't exist or isn't exposed.", base_native), p_source);
  3994. return false;
  3995. } else if (p_is_constructor && !ClassDB::can_instantiate(base_native)) {
  3996. if (p_base_type.kind == GDScriptParser::DataType::CLASS) {
  3997. push_error(vformat(R"(Class "%s" cannot be constructed as it is based on abstract native class "%s".)", p_base_type.class_type->fqcn.get_file(), base_native), p_source);
  3998. } else if (p_base_type.kind == GDScriptParser::DataType::SCRIPT) {
  3999. push_error(vformat(R"(Script "%s" cannot be constructed as it is based on abstract native class "%s".)", p_base_type.script_path.get_file(), base_native), p_source);
  4000. } else {
  4001. push_error(vformat(R"(Native class "%s" cannot be constructed as it is abstract.)", base_native), p_source);
  4002. }
  4003. return false;
  4004. }
  4005. }
  4006. if (p_is_constructor) {
  4007. function_name = "_init";
  4008. r_static = true;
  4009. }
  4010. GDScriptParser::ClassNode *base_class = p_base_type.class_type;
  4011. GDScriptParser::FunctionNode *found_function = nullptr;
  4012. while (found_function == nullptr && base_class != nullptr) {
  4013. if (base_class->has_member(function_name)) {
  4014. if (base_class->get_member(function_name).type != GDScriptParser::ClassNode::Member::FUNCTION) {
  4015. // TODO: If this is Callable it can have a better error message.
  4016. push_error(vformat(R"(Member "%s" is not a function.)", function_name), p_source);
  4017. return false;
  4018. }
  4019. resolve_class_member(base_class, function_name, p_source);
  4020. found_function = base_class->get_member(function_name).function;
  4021. }
  4022. resolve_class_inheritance(base_class, p_source);
  4023. base_class = base_class->base_type.class_type;
  4024. }
  4025. if (found_function != nullptr) {
  4026. r_static = p_is_constructor || found_function->is_static;
  4027. for (int i = 0; i < found_function->parameters.size(); i++) {
  4028. r_par_types.push_back(found_function->parameters[i]->get_datatype());
  4029. if (found_function->parameters[i]->initializer != nullptr) {
  4030. r_default_arg_count++;
  4031. }
  4032. }
  4033. r_return_type = p_is_constructor ? p_base_type : found_function->get_datatype();
  4034. r_return_type.is_meta_type = false;
  4035. r_return_type.is_coroutine = found_function->is_coroutine;
  4036. return true;
  4037. }
  4038. Ref<Script> base_script = p_base_type.script_type;
  4039. while (base_script.is_valid() && base_script->has_method(function_name)) {
  4040. MethodInfo info = base_script->get_method_info(function_name);
  4041. if (!(info == MethodInfo())) {
  4042. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  4043. }
  4044. base_script = base_script->get_base_script();
  4045. }
  4046. // If the base is a script, it might be trying to access members of the Script class itself.
  4047. if (p_base_type.is_meta_type && !p_is_constructor && (p_base_type.kind == GDScriptParser::DataType::SCRIPT || p_base_type.kind == GDScriptParser::DataType::CLASS)) {
  4048. MethodInfo info;
  4049. StringName script_class = p_base_type.kind == GDScriptParser::DataType::SCRIPT ? p_base_type.script_type->get_class_name() : StringName(GDScript::get_class_static());
  4050. if (ClassDB::get_method_info(script_class, function_name, &info)) {
  4051. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  4052. }
  4053. }
  4054. if (p_is_constructor) {
  4055. // Native types always have a default constructor.
  4056. r_return_type = p_base_type;
  4057. r_return_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4058. r_return_type.is_meta_type = false;
  4059. return true;
  4060. }
  4061. MethodInfo info;
  4062. if (ClassDB::get_method_info(base_native, function_name, &info)) {
  4063. bool valid = function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_static, r_vararg);
  4064. if (valid && Engine::get_singleton()->has_singleton(base_native)) {
  4065. r_static = true;
  4066. }
  4067. #ifdef DEBUG_ENABLED
  4068. MethodBind *native_method = ClassDB::get_method(base_native, function_name);
  4069. if (native_method && r_native_class) {
  4070. *r_native_class = native_method->get_instance_class();
  4071. }
  4072. #endif
  4073. return valid;
  4074. }
  4075. return false;
  4076. }
  4077. bool GDScriptAnalyzer::function_signature_from_info(const MethodInfo &p_info, GDScriptParser::DataType &r_return_type, List<GDScriptParser::DataType> &r_par_types, int &r_default_arg_count, bool &r_static, bool &r_vararg) {
  4078. r_return_type = type_from_property(p_info.return_val);
  4079. r_default_arg_count = p_info.default_arguments.size();
  4080. r_vararg = (p_info.flags & METHOD_FLAG_VARARG) != 0;
  4081. r_static = (p_info.flags & METHOD_FLAG_STATIC) != 0;
  4082. for (const PropertyInfo &E : p_info.arguments) {
  4083. r_par_types.push_back(type_from_property(E, true));
  4084. }
  4085. return true;
  4086. }
  4087. void GDScriptAnalyzer::validate_call_arg(const MethodInfo &p_method, const GDScriptParser::CallNode *p_call) {
  4088. List<GDScriptParser::DataType> arg_types;
  4089. for (const PropertyInfo &E : p_method.arguments) {
  4090. arg_types.push_back(type_from_property(E, true));
  4091. }
  4092. validate_call_arg(arg_types, p_method.default_arguments.size(), (p_method.flags & METHOD_FLAG_VARARG) != 0, p_call);
  4093. }
  4094. void GDScriptAnalyzer::validate_call_arg(const List<GDScriptParser::DataType> &p_par_types, int p_default_args_count, bool p_is_vararg, const GDScriptParser::CallNode *p_call) {
  4095. if (p_call->arguments.size() < p_par_types.size() - p_default_args_count) {
  4096. push_error(vformat(R"*(Too few arguments for "%s()" call. Expected at least %d but received %d.)*", p_call->function_name, p_par_types.size() - p_default_args_count, p_call->arguments.size()), p_call);
  4097. }
  4098. if (!p_is_vararg && p_call->arguments.size() > p_par_types.size()) {
  4099. push_error(vformat(R"*(Too many arguments for "%s()" call. Expected at most %d but received %d.)*", p_call->function_name, p_par_types.size(), p_call->arguments.size()), p_call->arguments[p_par_types.size()]);
  4100. }
  4101. for (int i = 0; i < p_call->arguments.size(); i++) {
  4102. if (i >= p_par_types.size()) {
  4103. // Already on vararg place.
  4104. break;
  4105. }
  4106. GDScriptParser::DataType par_type = p_par_types[i];
  4107. if (par_type.is_hard_type() && p_call->arguments[i]->is_constant) {
  4108. update_const_expression_builtin_type(p_call->arguments[i], par_type, "pass");
  4109. }
  4110. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  4111. if ((arg_type.is_variant() || !arg_type.is_hard_type()) && !(par_type.is_hard_type() && par_type.is_variant())) {
  4112. // Argument can be anything, so this is unsafe.
  4113. mark_node_unsafe(p_call->arguments[i]);
  4114. } else if (par_type.is_hard_type() && !is_type_compatible(par_type, arg_type, true)) {
  4115. // Supertypes are acceptable for dynamic compliance, but it's unsafe.
  4116. mark_node_unsafe(p_call);
  4117. if (!is_type_compatible(arg_type, par_type)) {
  4118. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*",
  4119. p_call->function_name, i + 1, par_type.to_string(), arg_type.to_string()),
  4120. p_call->arguments[i]);
  4121. }
  4122. #ifdef DEBUG_ENABLED
  4123. } else if (par_type.kind == GDScriptParser::DataType::BUILTIN && par_type.builtin_type == Variant::INT && arg_type.kind == GDScriptParser::DataType::BUILTIN && arg_type.builtin_type == Variant::FLOAT) {
  4124. parser->push_warning(p_call, GDScriptWarning::NARROWING_CONVERSION, p_call->function_name);
  4125. #endif
  4126. }
  4127. }
  4128. }
  4129. #ifdef DEBUG_ENABLED
  4130. bool GDScriptAnalyzer::is_shadowing(GDScriptParser::IdentifierNode *p_local, const String &p_context) {
  4131. const StringName &name = p_local->name;
  4132. GDScriptParser::DataType base = parser->current_class->get_datatype();
  4133. GDScriptParser::ClassNode *base_class = base.class_type;
  4134. {
  4135. List<MethodInfo> gdscript_funcs;
  4136. GDScriptLanguage::get_singleton()->get_public_functions(&gdscript_funcs);
  4137. for (MethodInfo &info : gdscript_funcs) {
  4138. if (info.name == name) {
  4139. parser->push_warning(p_local, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "built-in function");
  4140. return true;
  4141. }
  4142. }
  4143. if (Variant::has_utility_function(name)) {
  4144. parser->push_warning(p_local, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "built-in function");
  4145. return true;
  4146. } else if (ClassDB::class_exists(name)) {
  4147. parser->push_warning(p_local, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "global class");
  4148. return true;
  4149. }
  4150. }
  4151. while (base_class != nullptr) {
  4152. if (base_class->has_member(name)) {
  4153. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE, p_context, p_local->name, base_class->get_member(name).get_type_name(), itos(base_class->get_member(name).get_line()));
  4154. return true;
  4155. }
  4156. base_class = base_class->base_type.class_type;
  4157. }
  4158. StringName parent = base.native_type;
  4159. while (parent != StringName()) {
  4160. ERR_FAIL_COND_V_MSG(!class_exists(parent), false, "Non-existent native base class.");
  4161. if (ClassDB::has_method(parent, name, true)) {
  4162. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "method", parent);
  4163. return true;
  4164. } else if (ClassDB::has_signal(parent, name, true)) {
  4165. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "signal", parent);
  4166. return true;
  4167. } else if (ClassDB::has_property(parent, name, true)) {
  4168. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "property", parent);
  4169. return true;
  4170. } else if (ClassDB::has_integer_constant(parent, name, true)) {
  4171. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "constant", parent);
  4172. return true;
  4173. } else if (ClassDB::has_enum(parent, name, true)) {
  4174. parser->push_warning(p_local, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_local->name, "enum", parent);
  4175. return true;
  4176. }
  4177. parent = ClassDB::get_parent_class(parent);
  4178. }
  4179. return false;
  4180. }
  4181. #endif
  4182. GDScriptParser::DataType GDScriptAnalyzer::get_operation_type(Variant::Operator p_operation, const GDScriptParser::DataType &p_a, bool &r_valid, const GDScriptParser::Node *p_source) {
  4183. // Unary version.
  4184. GDScriptParser::DataType nil_type;
  4185. nil_type.builtin_type = Variant::NIL;
  4186. nil_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  4187. return get_operation_type(p_operation, p_a, nil_type, r_valid, p_source);
  4188. }
  4189. GDScriptParser::DataType GDScriptAnalyzer::get_operation_type(Variant::Operator p_operation, const GDScriptParser::DataType &p_a, const GDScriptParser::DataType &p_b, bool &r_valid, const GDScriptParser::Node *p_source) {
  4190. Variant::Type a_type = p_a.builtin_type;
  4191. Variant::Type b_type = p_b.builtin_type;
  4192. if (p_a.kind == GDScriptParser::DataType::ENUM) {
  4193. if (p_a.is_meta_type) {
  4194. a_type = Variant::DICTIONARY;
  4195. } else {
  4196. a_type = Variant::INT;
  4197. }
  4198. }
  4199. if (p_b.kind == GDScriptParser::DataType::ENUM) {
  4200. if (p_b.is_meta_type) {
  4201. b_type = Variant::DICTIONARY;
  4202. } else {
  4203. b_type = Variant::INT;
  4204. }
  4205. }
  4206. Variant::ValidatedOperatorEvaluator op_eval = Variant::get_validated_operator_evaluator(p_operation, a_type, b_type);
  4207. bool hard_operation = p_a.is_hard_type() && p_b.is_hard_type();
  4208. bool validated = op_eval != nullptr;
  4209. GDScriptParser::DataType result;
  4210. if (validated) {
  4211. r_valid = true;
  4212. result.type_source = hard_operation ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  4213. result.kind = GDScriptParser::DataType::BUILTIN;
  4214. result.builtin_type = Variant::get_operator_return_type(p_operation, a_type, b_type);
  4215. } else {
  4216. r_valid = !hard_operation;
  4217. result.kind = GDScriptParser::DataType::VARIANT;
  4218. }
  4219. return result;
  4220. }
  4221. // TODO: Add safe/unsafe return variable (for variant cases)
  4222. bool GDScriptAnalyzer::is_type_compatible(const GDScriptParser::DataType &p_target, const GDScriptParser::DataType &p_source, bool p_allow_implicit_conversion, const GDScriptParser::Node *p_source_node) {
  4223. // These return "true" so it doesn't affect users negatively.
  4224. ERR_FAIL_COND_V_MSG(!p_target.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset target type");
  4225. ERR_FAIL_COND_V_MSG(!p_source.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset value type");
  4226. if (p_target.kind == GDScriptParser::DataType::VARIANT) {
  4227. // Variant can receive anything.
  4228. return true;
  4229. }
  4230. if (p_source.kind == GDScriptParser::DataType::VARIANT) {
  4231. // TODO: This is acceptable but unsafe. Make sure unsafe line is set.
  4232. return true;
  4233. }
  4234. if (p_target.kind == GDScriptParser::DataType::BUILTIN) {
  4235. bool valid = p_source.kind == GDScriptParser::DataType::BUILTIN && p_target.builtin_type == p_source.builtin_type;
  4236. if (!valid && p_allow_implicit_conversion) {
  4237. valid = Variant::can_convert_strict(p_source.builtin_type, p_target.builtin_type);
  4238. }
  4239. if (!valid && p_target.builtin_type == Variant::INT && p_source.kind == GDScriptParser::DataType::ENUM && !p_source.is_meta_type) {
  4240. // Enum value is also integer.
  4241. valid = true;
  4242. }
  4243. if (valid && p_target.builtin_type == Variant::ARRAY && p_source.builtin_type == Variant::ARRAY) {
  4244. // Check the element type.
  4245. if (p_target.has_container_element_type() && p_source.has_container_element_type()) {
  4246. valid = p_target.get_container_element_type() == p_source.get_container_element_type();
  4247. }
  4248. }
  4249. return valid;
  4250. }
  4251. if (p_target.kind == GDScriptParser::DataType::ENUM) {
  4252. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::INT) {
  4253. #ifdef DEBUG_ENABLED
  4254. if (p_source_node) {
  4255. parser->push_warning(p_source_node, GDScriptWarning::INT_AS_ENUM_WITHOUT_CAST);
  4256. }
  4257. #endif
  4258. return true;
  4259. }
  4260. if (p_source.kind == GDScriptParser::DataType::ENUM) {
  4261. if (p_source.native_type == p_target.native_type) {
  4262. return true;
  4263. }
  4264. }
  4265. return false;
  4266. }
  4267. // From here on the target type is an object, so we have to test polymorphism.
  4268. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::NIL) {
  4269. // null is acceptable in object.
  4270. return true;
  4271. }
  4272. StringName src_native;
  4273. Ref<Script> src_script;
  4274. const GDScriptParser::ClassNode *src_class = nullptr;
  4275. switch (p_source.kind) {
  4276. case GDScriptParser::DataType::NATIVE:
  4277. if (p_target.kind != GDScriptParser::DataType::NATIVE) {
  4278. // Non-native class cannot be supertype of native.
  4279. return false;
  4280. }
  4281. if (p_source.is_meta_type) {
  4282. src_native = GDScriptNativeClass::get_class_static();
  4283. } else {
  4284. src_native = p_source.native_type;
  4285. }
  4286. break;
  4287. case GDScriptParser::DataType::SCRIPT:
  4288. if (p_target.kind == GDScriptParser::DataType::CLASS) {
  4289. // A script type cannot be a subtype of a GDScript class.
  4290. return false;
  4291. }
  4292. if (p_source.is_meta_type) {
  4293. src_native = p_source.script_type->get_class_name();
  4294. } else {
  4295. src_script = p_source.script_type;
  4296. src_native = src_script->get_instance_base_type();
  4297. }
  4298. break;
  4299. case GDScriptParser::DataType::CLASS:
  4300. if (p_source.is_meta_type) {
  4301. src_native = GDScript::get_class_static();
  4302. } else {
  4303. src_class = p_source.class_type;
  4304. const GDScriptParser::ClassNode *base = src_class;
  4305. while (base->base_type.kind == GDScriptParser::DataType::CLASS) {
  4306. base = base->base_type.class_type;
  4307. }
  4308. src_native = base->base_type.native_type;
  4309. src_script = base->base_type.script_type;
  4310. }
  4311. break;
  4312. case GDScriptParser::DataType::VARIANT:
  4313. case GDScriptParser::DataType::BUILTIN:
  4314. case GDScriptParser::DataType::ENUM:
  4315. case GDScriptParser::DataType::RESOLVING:
  4316. case GDScriptParser::DataType::UNRESOLVED:
  4317. break; // Already solved before.
  4318. }
  4319. switch (p_target.kind) {
  4320. case GDScriptParser::DataType::NATIVE: {
  4321. if (p_target.is_meta_type) {
  4322. return ClassDB::is_parent_class(src_native, GDScriptNativeClass::get_class_static());
  4323. }
  4324. return ClassDB::is_parent_class(src_native, p_target.native_type);
  4325. }
  4326. case GDScriptParser::DataType::SCRIPT:
  4327. if (p_target.is_meta_type) {
  4328. return ClassDB::is_parent_class(src_native, p_target.script_type->get_class_name());
  4329. }
  4330. while (src_script.is_valid()) {
  4331. if (src_script == p_target.script_type) {
  4332. return true;
  4333. }
  4334. src_script = src_script->get_base_script();
  4335. }
  4336. return false;
  4337. case GDScriptParser::DataType::CLASS:
  4338. if (p_target.is_meta_type) {
  4339. return ClassDB::is_parent_class(src_native, GDScript::get_class_static());
  4340. }
  4341. while (src_class != nullptr) {
  4342. if (src_class == p_target.class_type || src_class->fqcn == p_target.class_type->fqcn) {
  4343. return true;
  4344. }
  4345. src_class = src_class->base_type.class_type;
  4346. }
  4347. return false;
  4348. case GDScriptParser::DataType::VARIANT:
  4349. case GDScriptParser::DataType::BUILTIN:
  4350. case GDScriptParser::DataType::ENUM:
  4351. case GDScriptParser::DataType::RESOLVING:
  4352. case GDScriptParser::DataType::UNRESOLVED:
  4353. break; // Already solved before.
  4354. }
  4355. return false;
  4356. }
  4357. void GDScriptAnalyzer::push_error(const String &p_message, const GDScriptParser::Node *p_origin) {
  4358. mark_node_unsafe(p_origin);
  4359. parser->push_error(p_message, p_origin);
  4360. }
  4361. void GDScriptAnalyzer::mark_node_unsafe(const GDScriptParser::Node *p_node) {
  4362. #ifdef DEBUG_ENABLED
  4363. if (p_node == nullptr) {
  4364. return;
  4365. }
  4366. for (int i = p_node->start_line; i <= p_node->end_line; i++) {
  4367. parser->unsafe_lines.insert(i);
  4368. }
  4369. #endif
  4370. }
  4371. void GDScriptAnalyzer::downgrade_node_type_source(GDScriptParser::Node *p_node) {
  4372. GDScriptParser::IdentifierNode *identifier = nullptr;
  4373. if (p_node->type == GDScriptParser::Node::IDENTIFIER) {
  4374. identifier = static_cast<GDScriptParser::IdentifierNode *>(p_node);
  4375. } else if (p_node->type == GDScriptParser::Node::SUBSCRIPT) {
  4376. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(p_node);
  4377. if (subscript->is_attribute) {
  4378. identifier = subscript->attribute;
  4379. }
  4380. }
  4381. if (identifier == nullptr) {
  4382. return;
  4383. }
  4384. GDScriptParser::Node *source = nullptr;
  4385. switch (identifier->source) {
  4386. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE: {
  4387. source = identifier->variable_source;
  4388. } break;
  4389. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER: {
  4390. source = identifier->parameter_source;
  4391. } break;
  4392. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE: {
  4393. source = identifier->variable_source;
  4394. } break;
  4395. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR: {
  4396. source = identifier->bind_source;
  4397. } break;
  4398. default:
  4399. break;
  4400. }
  4401. if (source == nullptr) {
  4402. return;
  4403. }
  4404. GDScriptParser::DataType datatype;
  4405. datatype.kind = GDScriptParser::DataType::VARIANT;
  4406. source->set_datatype(datatype);
  4407. }
  4408. void GDScriptAnalyzer::mark_lambda_use_self() {
  4409. for (GDScriptParser::LambdaNode *lambda : lambda_stack) {
  4410. lambda->use_self = true;
  4411. }
  4412. }
  4413. bool GDScriptAnalyzer::class_exists(const StringName &p_class) const {
  4414. return ClassDB::class_exists(p_class) && ClassDB::is_class_exposed(p_class);
  4415. }
  4416. Ref<GDScriptParserRef> GDScriptAnalyzer::get_parser_for(const String &p_path) {
  4417. Ref<GDScriptParserRef> ref;
  4418. if (depended_parsers.has(p_path)) {
  4419. ref = depended_parsers[p_path];
  4420. } else {
  4421. Error err = OK;
  4422. ref = GDScriptCache::get_parser(p_path, GDScriptParserRef::EMPTY, err, parser->script_path);
  4423. if (ref.is_valid()) {
  4424. depended_parsers[p_path] = ref;
  4425. }
  4426. }
  4427. return ref;
  4428. }
  4429. Error GDScriptAnalyzer::resolve_inheritance() {
  4430. return resolve_class_inheritance(parser->head, true);
  4431. }
  4432. Error GDScriptAnalyzer::resolve_interface() {
  4433. resolve_class_interface(parser->head, true);
  4434. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  4435. }
  4436. Error GDScriptAnalyzer::resolve_body() {
  4437. resolve_class_body(parser->head, true);
  4438. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  4439. }
  4440. Error GDScriptAnalyzer::resolve_dependencies() {
  4441. for (KeyValue<String, Ref<GDScriptParserRef>> &K : depended_parsers) {
  4442. if (K.value.is_null()) {
  4443. return ERR_PARSE_ERROR;
  4444. }
  4445. K.value->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  4446. }
  4447. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  4448. }
  4449. Error GDScriptAnalyzer::analyze() {
  4450. parser->errors.clear();
  4451. Error err = OK;
  4452. err = resolve_inheritance();
  4453. if (err) {
  4454. return err;
  4455. }
  4456. // Apply annotations.
  4457. for (GDScriptParser::AnnotationNode *&E : parser->head->annotations) {
  4458. resolve_annotation(E);
  4459. E->apply(parser, parser->head);
  4460. }
  4461. resolve_interface();
  4462. resolve_body();
  4463. if (!parser->errors.is_empty()) {
  4464. return ERR_PARSE_ERROR;
  4465. }
  4466. return resolve_dependencies();
  4467. }
  4468. GDScriptAnalyzer::GDScriptAnalyzer(GDScriptParser *p_parser) {
  4469. parser = p_parser;
  4470. }