gdscript_analyzer.cpp 201 KB

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