gdscript_analyzer.cpp 196 KB

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