gdscript_analyzer.cpp 254 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289
  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 "gdscript.h"
  32. #include "gdscript_utility_callable.h"
  33. #include "gdscript_utility_functions.h"
  34. #include "core/config/engine.h"
  35. #include "core/config/project_settings.h"
  36. #include "core/core_constants.h"
  37. #include "core/io/file_access.h"
  38. #include "core/io/resource_loader.h"
  39. #include "core/object/class_db.h"
  40. #include "core/object/script_language.h"
  41. #include "core/templates/hash_map.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_class_enum_type(const StringName &p_enum_name, GDScriptParser::ClassNode *p_class, const String &p_script_path, bool p_meta = true) {
  134. GDScriptParser::DataType type = make_enum_type(p_enum_name, p_class->fqcn, p_meta);
  135. type.class_type = p_class;
  136. type.script_path = p_script_path;
  137. return type;
  138. }
  139. static GDScriptParser::DataType make_native_enum_type(const StringName &p_enum_name, const StringName &p_native_class, bool p_meta = true) {
  140. // Find out which base class declared the enum, so the name is always the same even when coming from other contexts.
  141. StringName native_base = p_native_class;
  142. while (true && native_base != StringName()) {
  143. if (ClassDB::has_enum(native_base, p_enum_name, true)) {
  144. break;
  145. }
  146. native_base = ClassDB::get_parent_class_nocheck(native_base);
  147. }
  148. GDScriptParser::DataType type = make_enum_type(p_enum_name, native_base, p_meta);
  149. if (p_meta) {
  150. type.builtin_type = Variant::NIL; // Native enum types are not Dictionaries.
  151. }
  152. List<StringName> enum_values;
  153. ClassDB::get_enum_constants(native_base, p_enum_name, &enum_values, true);
  154. for (const StringName &E : enum_values) {
  155. type.enum_values[E] = ClassDB::get_integer_constant(native_base, E);
  156. }
  157. return type;
  158. }
  159. static GDScriptParser::DataType make_global_enum_type(const StringName &p_enum_name, const StringName &p_base, bool p_meta = true) {
  160. GDScriptParser::DataType type = make_enum_type(p_enum_name, p_base, p_meta);
  161. if (p_meta) {
  162. type.builtin_type = Variant::NIL; // Native enum types are not Dictionaries.
  163. type.is_pseudo_type = true;
  164. }
  165. HashMap<StringName, int64_t> enum_values;
  166. CoreConstants::get_enum_values(type.native_type, &enum_values);
  167. for (const KeyValue<StringName, int64_t> &element : enum_values) {
  168. type.enum_values[element.key] = element.value;
  169. }
  170. return type;
  171. }
  172. static GDScriptParser::DataType make_builtin_meta_type(Variant::Type p_type) {
  173. GDScriptParser::DataType type;
  174. type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  175. type.kind = GDScriptParser::DataType::BUILTIN;
  176. type.builtin_type = p_type;
  177. type.is_constant = true;
  178. type.is_meta_type = true;
  179. return type;
  180. }
  181. bool GDScriptAnalyzer::has_member_name_conflict_in_script_class(const StringName &p_member_name, const GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_member) {
  182. if (p_class->members_indices.has(p_member_name)) {
  183. int index = p_class->members_indices[p_member_name];
  184. const GDScriptParser::ClassNode::Member *member = &p_class->members[index];
  185. if (member->type == GDScriptParser::ClassNode::Member::VARIABLE ||
  186. member->type == GDScriptParser::ClassNode::Member::CONSTANT ||
  187. member->type == GDScriptParser::ClassNode::Member::ENUM ||
  188. member->type == GDScriptParser::ClassNode::Member::ENUM_VALUE ||
  189. member->type == GDScriptParser::ClassNode::Member::CLASS ||
  190. member->type == GDScriptParser::ClassNode::Member::SIGNAL) {
  191. return true;
  192. }
  193. if (p_member->type != GDScriptParser::Node::FUNCTION && member->type == GDScriptParser::ClassNode::Member::FUNCTION) {
  194. return true;
  195. }
  196. }
  197. return false;
  198. }
  199. bool GDScriptAnalyzer::has_member_name_conflict_in_native_type(const StringName &p_member_name, const StringName &p_native_type_string) {
  200. if (ClassDB::has_signal(p_native_type_string, p_member_name)) {
  201. return true;
  202. }
  203. if (ClassDB::has_property(p_native_type_string, p_member_name)) {
  204. return true;
  205. }
  206. if (ClassDB::has_integer_constant(p_native_type_string, p_member_name)) {
  207. return true;
  208. }
  209. if (p_member_name == CoreStringName(script)) {
  210. return true;
  211. }
  212. return false;
  213. }
  214. Error GDScriptAnalyzer::check_native_member_name_conflict(const StringName &p_member_name, const GDScriptParser::Node *p_member_node, const StringName &p_native_type_string) {
  215. if (has_member_name_conflict_in_native_type(p_member_name, p_native_type_string)) {
  216. push_error(vformat(R"(Member "%s" redefined (original in native class '%s'))", p_member_name, p_native_type_string), p_member_node);
  217. return ERR_PARSE_ERROR;
  218. }
  219. if (class_exists(p_member_name)) {
  220. push_error(vformat(R"(The member "%s" shadows a native class.)", p_member_name), p_member_node);
  221. return ERR_PARSE_ERROR;
  222. }
  223. if (GDScriptParser::get_builtin_type(p_member_name) < Variant::VARIANT_MAX) {
  224. push_error(vformat(R"(The member "%s" cannot have the same name as a builtin type.)", p_member_name), p_member_node);
  225. return ERR_PARSE_ERROR;
  226. }
  227. return OK;
  228. }
  229. Error GDScriptAnalyzer::check_class_member_name_conflict(const GDScriptParser::ClassNode *p_class_node, const StringName &p_member_name, const GDScriptParser::Node *p_member_node) {
  230. // TODO check outer classes for static members only
  231. const GDScriptParser::DataType *current_data_type = &p_class_node->base_type;
  232. while (current_data_type && current_data_type->kind == GDScriptParser::DataType::Kind::CLASS) {
  233. GDScriptParser::ClassNode *current_class_node = current_data_type->class_type;
  234. if (has_member_name_conflict_in_script_class(p_member_name, current_class_node, p_member_node)) {
  235. String parent_class_name = current_class_node->fqcn;
  236. if (current_class_node->identifier != nullptr) {
  237. parent_class_name = current_class_node->identifier->name;
  238. }
  239. push_error(vformat(R"(The member "%s" already exists in parent class %s.)", p_member_name, parent_class_name), p_member_node);
  240. return ERR_PARSE_ERROR;
  241. }
  242. current_data_type = &current_class_node->base_type;
  243. }
  244. // No need for native class recursion because Node exposes all Object's properties.
  245. if (current_data_type && current_data_type->kind == GDScriptParser::DataType::Kind::NATIVE) {
  246. if (current_data_type->native_type != StringName()) {
  247. return check_native_member_name_conflict(
  248. p_member_name,
  249. p_member_node,
  250. current_data_type->native_type);
  251. }
  252. }
  253. return OK;
  254. }
  255. void GDScriptAnalyzer::get_class_node_current_scope_classes(GDScriptParser::ClassNode *p_node, List<GDScriptParser::ClassNode *> *p_list, GDScriptParser::Node *p_source) {
  256. ERR_FAIL_NULL(p_node);
  257. ERR_FAIL_NULL(p_list);
  258. if (p_list->find(p_node) != nullptr) {
  259. return;
  260. }
  261. p_list->push_back(p_node);
  262. // TODO: Try to solve class inheritance if not yet resolving.
  263. // Prioritize node base type over its outer class
  264. if (p_node->base_type.class_type != nullptr) {
  265. // TODO: 'ensure_cached_external_parser_for_class()' is only necessary because 'resolve_class_inheritance()' is not getting called here.
  266. ensure_cached_external_parser_for_class(p_node->base_type.class_type, p_node, "Trying to fetch classes in the current scope", p_source);
  267. get_class_node_current_scope_classes(p_node->base_type.class_type, p_list, p_source);
  268. }
  269. if (p_node->outer != nullptr) {
  270. // TODO: 'ensure_cached_external_parser_for_class()' is only necessary because 'resolve_class_inheritance()' is not getting called here.
  271. ensure_cached_external_parser_for_class(p_node->outer, p_node, "Trying to fetch classes in the current scope", p_source);
  272. get_class_node_current_scope_classes(p_node->outer, p_list, p_source);
  273. }
  274. }
  275. Error GDScriptAnalyzer::resolve_class_inheritance(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source) {
  276. if (p_source == nullptr && parser->has_class(p_class)) {
  277. p_source = p_class;
  278. }
  279. Ref<GDScriptParserRef> parser_ref = ensure_cached_external_parser_for_class(p_class, nullptr, "Trying to resolve class inheritance", p_source);
  280. Finally finally([&]() {
  281. for (GDScriptParser::ClassNode *look_class = p_class; look_class != nullptr; look_class = look_class->base_type.class_type) {
  282. ensure_cached_external_parser_for_class(look_class->base_type.class_type, look_class, "Trying to resolve class inheritance", p_source);
  283. }
  284. });
  285. if (p_class->base_type.is_resolving()) {
  286. push_error(vformat(R"(Could not resolve class "%s": Cyclic reference.)", type_from_metatype(p_class->get_datatype()).to_string()), p_source);
  287. return ERR_PARSE_ERROR;
  288. }
  289. if (!p_class->base_type.has_no_type()) {
  290. // Already resolved.
  291. return OK;
  292. }
  293. if (!parser->has_class(p_class)) {
  294. if (parser_ref.is_null()) {
  295. // Error already pushed.
  296. return ERR_PARSE_ERROR;
  297. }
  298. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  299. if (err) {
  300. push_error(vformat(R"(Could not parse script "%s": %s.)", p_class->get_datatype().script_path, error_names[err]), p_source);
  301. return ERR_PARSE_ERROR;
  302. }
  303. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  304. GDScriptParser *other_parser = parser_ref->get_parser();
  305. int error_count = other_parser->errors.size();
  306. other_analyzer->resolve_class_inheritance(p_class);
  307. if (other_parser->errors.size() > error_count) {
  308. push_error(vformat(R"(Could not resolve inheritance for class "%s".)", p_class->fqcn), p_source);
  309. return ERR_PARSE_ERROR;
  310. }
  311. return OK;
  312. }
  313. GDScriptParser::ClassNode *previous_class = parser->current_class;
  314. parser->current_class = p_class;
  315. if (p_class->identifier) {
  316. StringName class_name = p_class->identifier->name;
  317. if (GDScriptParser::get_builtin_type(class_name) < Variant::VARIANT_MAX) {
  318. push_error(vformat(R"(Class "%s" hides a built-in type.)", class_name), p_class->identifier);
  319. } else if (class_exists(class_name)) {
  320. push_error(vformat(R"(Class "%s" hides a native class.)", class_name), p_class->identifier);
  321. } else if (ScriptServer::is_global_class(class_name) && (!GDScript::is_canonically_equal_paths(ScriptServer::get_global_class_path(class_name), parser->script_path) || p_class != parser->head)) {
  322. push_error(vformat(R"(Class "%s" hides a global script class.)", class_name), p_class->identifier);
  323. } else if (ProjectSettings::get_singleton()->has_autoload(class_name) && ProjectSettings::get_singleton()->get_autoload(class_name).is_singleton) {
  324. push_error(vformat(R"(Class "%s" hides an autoload singleton.)", class_name), p_class->identifier);
  325. }
  326. }
  327. GDScriptParser::DataType resolving_datatype;
  328. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  329. p_class->base_type = resolving_datatype;
  330. // Set datatype for class.
  331. GDScriptParser::DataType class_type;
  332. class_type.is_constant = true;
  333. class_type.is_meta_type = true;
  334. class_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  335. class_type.kind = GDScriptParser::DataType::CLASS;
  336. class_type.class_type = p_class;
  337. class_type.script_path = parser->script_path;
  338. class_type.builtin_type = Variant::OBJECT;
  339. p_class->set_datatype(class_type);
  340. GDScriptParser::DataType result;
  341. if (!p_class->extends_used) {
  342. result.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  343. result.kind = GDScriptParser::DataType::NATIVE;
  344. result.builtin_type = Variant::OBJECT;
  345. result.native_type = SNAME("RefCounted");
  346. } else {
  347. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  348. GDScriptParser::DataType base;
  349. int extends_index = 0;
  350. if (!p_class->extends_path.is_empty()) {
  351. if (p_class->extends_path.is_relative_path()) {
  352. p_class->extends_path = class_type.script_path.get_base_dir().path_join(p_class->extends_path).simplify_path();
  353. }
  354. Ref<GDScriptParserRef> ext_parser = parser->get_depended_parser_for(p_class->extends_path);
  355. if (ext_parser.is_null()) {
  356. push_error(vformat(R"(Could not resolve super class path "%s".)", p_class->extends_path), p_class);
  357. return ERR_PARSE_ERROR;
  358. }
  359. Error err = ext_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  360. if (err != OK) {
  361. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", p_class->extends_path), p_class);
  362. return err;
  363. }
  364. #ifdef DEBUG_ENABLED
  365. if (!parser->_is_tool && ext_parser->get_parser()->_is_tool) {
  366. parser->push_warning(p_class, GDScriptWarning::MISSING_TOOL);
  367. }
  368. #endif
  369. base = ext_parser->get_parser()->head->get_datatype();
  370. } else {
  371. if (p_class->extends.is_empty()) {
  372. push_error("Could not resolve an empty super class path.", p_class);
  373. return ERR_PARSE_ERROR;
  374. }
  375. GDScriptParser::IdentifierNode *id = p_class->extends[extends_index++];
  376. const StringName &name = id->name;
  377. base.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  378. if (ScriptServer::is_global_class(name)) {
  379. String base_path = ScriptServer::get_global_class_path(name);
  380. if (GDScript::is_canonically_equal_paths(base_path, parser->script_path)) {
  381. base = parser->head->get_datatype();
  382. } else {
  383. Ref<GDScriptParserRef> base_parser = parser->get_depended_parser_for(base_path);
  384. if (base_parser.is_null()) {
  385. push_error(vformat(R"(Could not resolve super class "%s".)", name), id);
  386. return ERR_PARSE_ERROR;
  387. }
  388. Error err = base_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  389. if (err != OK) {
  390. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", name), id);
  391. return err;
  392. }
  393. #ifdef DEBUG_ENABLED
  394. if (!parser->_is_tool && base_parser->get_parser()->_is_tool) {
  395. parser->push_warning(p_class, GDScriptWarning::MISSING_TOOL);
  396. }
  397. #endif
  398. base = base_parser->get_parser()->head->get_datatype();
  399. }
  400. } else if (ProjectSettings::get_singleton()->has_autoload(name) && ProjectSettings::get_singleton()->get_autoload(name).is_singleton) {
  401. const ProjectSettings::AutoloadInfo &info = ProjectSettings::get_singleton()->get_autoload(name);
  402. if (info.path.get_extension().to_lower() != GDScriptLanguage::get_singleton()->get_extension()) {
  403. push_error(vformat(R"(Singleton %s is not a GDScript.)", info.name), id);
  404. return ERR_PARSE_ERROR;
  405. }
  406. Ref<GDScriptParserRef> info_parser = parser->get_depended_parser_for(info.path);
  407. if (info_parser.is_null()) {
  408. push_error(vformat(R"(Could not parse singleton from "%s".)", info.path), id);
  409. return ERR_PARSE_ERROR;
  410. }
  411. Error err = info_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  412. if (err != OK) {
  413. push_error(vformat(R"(Could not resolve super class inheritance from "%s".)", name), id);
  414. return err;
  415. }
  416. #ifdef DEBUG_ENABLED
  417. if (!parser->_is_tool && info_parser->get_parser()->_is_tool) {
  418. parser->push_warning(p_class, GDScriptWarning::MISSING_TOOL);
  419. }
  420. #endif
  421. base = info_parser->get_parser()->head->get_datatype();
  422. } else if (class_exists(name)) {
  423. if (Engine::get_singleton()->has_singleton(name)) {
  424. push_error(vformat(R"(Cannot inherit native class "%s" because it is an engine singleton.)", name), id);
  425. return ERR_PARSE_ERROR;
  426. }
  427. base.kind = GDScriptParser::DataType::NATIVE;
  428. base.builtin_type = Variant::OBJECT;
  429. base.native_type = name;
  430. } else {
  431. // Look for other classes in script.
  432. bool found = false;
  433. List<GDScriptParser::ClassNode *> script_classes;
  434. get_class_node_current_scope_classes(p_class, &script_classes, id);
  435. for (GDScriptParser::ClassNode *look_class : script_classes) {
  436. if (look_class->identifier && look_class->identifier->name == name) {
  437. if (!look_class->get_datatype().is_set()) {
  438. Error err = resolve_class_inheritance(look_class, id);
  439. if (err) {
  440. return err;
  441. }
  442. }
  443. base = look_class->get_datatype();
  444. found = true;
  445. break;
  446. }
  447. if (look_class->has_member(name)) {
  448. resolve_class_member(look_class, name, id);
  449. GDScriptParser::ClassNode::Member member = look_class->get_member(name);
  450. GDScriptParser::DataType member_datatype = member.get_datatype();
  451. switch (member.type) {
  452. case GDScriptParser::ClassNode::Member::CLASS:
  453. break; // OK.
  454. case GDScriptParser::ClassNode::Member::CONSTANT:
  455. if (member_datatype.kind != GDScriptParser::DataType::SCRIPT && member_datatype.kind != GDScriptParser::DataType::CLASS) {
  456. push_error(vformat(R"(Constant "%s" is not a preloaded script or class.)", name), id);
  457. return ERR_PARSE_ERROR;
  458. }
  459. break;
  460. default:
  461. push_error(vformat(R"(Cannot use %s "%s" in extends chain.)", member.get_type_name(), name), id);
  462. return ERR_PARSE_ERROR;
  463. }
  464. base = member_datatype;
  465. found = true;
  466. break;
  467. }
  468. }
  469. if (!found) {
  470. push_error(vformat(R"(Could not find base class "%s".)", name), id);
  471. return ERR_PARSE_ERROR;
  472. }
  473. }
  474. }
  475. for (int index = extends_index; index < p_class->extends.size(); index++) {
  476. GDScriptParser::IdentifierNode *id = p_class->extends[index];
  477. if (base.kind != GDScriptParser::DataType::CLASS) {
  478. push_error(vformat(R"(Cannot get nested types for extension from non-GDScript type "%s".)", base.to_string()), id);
  479. return ERR_PARSE_ERROR;
  480. }
  481. reduce_identifier_from_base(id, &base);
  482. GDScriptParser::DataType id_type = id->get_datatype();
  483. if (!id_type.is_set()) {
  484. push_error(vformat(R"(Could not find nested type "%s".)", id->name), id);
  485. return ERR_PARSE_ERROR;
  486. } else if (id_type.kind != GDScriptParser::DataType::SCRIPT && id_type.kind != GDScriptParser::DataType::CLASS) {
  487. push_error(vformat(R"(Identifier "%s" is not a preloaded script or class.)", id->name), id);
  488. return ERR_PARSE_ERROR;
  489. }
  490. base = id_type;
  491. }
  492. result = base;
  493. }
  494. if (!result.is_set() || result.has_no_type()) {
  495. // TODO: More specific error messages.
  496. push_error(vformat(R"(Could not resolve inheritance for class "%s".)", p_class->identifier == nullptr ? "<main>" : p_class->identifier->name), p_class);
  497. return ERR_PARSE_ERROR;
  498. }
  499. // Check for cyclic inheritance.
  500. const GDScriptParser::ClassNode *base_class = result.class_type;
  501. while (base_class) {
  502. if (base_class->fqcn == p_class->fqcn) {
  503. push_error("Cyclic inheritance.", p_class);
  504. return ERR_PARSE_ERROR;
  505. }
  506. base_class = base_class->base_type.class_type;
  507. }
  508. p_class->base_type = result;
  509. class_type.native_type = result.native_type;
  510. p_class->set_datatype(class_type);
  511. // Apply annotations.
  512. for (GDScriptParser::AnnotationNode *&E : p_class->annotations) {
  513. resolve_annotation(E);
  514. E->apply(parser, p_class, p_class->outer);
  515. }
  516. parser->current_class = previous_class;
  517. return OK;
  518. }
  519. Error GDScriptAnalyzer::resolve_class_inheritance(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  520. Error err = resolve_class_inheritance(p_class);
  521. if (err) {
  522. return err;
  523. }
  524. if (p_recursive) {
  525. for (int i = 0; i < p_class->members.size(); i++) {
  526. if (p_class->members[i].type == GDScriptParser::ClassNode::Member::CLASS) {
  527. err = resolve_class_inheritance(p_class->members[i].m_class, true);
  528. if (err) {
  529. return err;
  530. }
  531. }
  532. }
  533. }
  534. return OK;
  535. }
  536. GDScriptParser::DataType GDScriptAnalyzer::resolve_datatype(GDScriptParser::TypeNode *p_type) {
  537. GDScriptParser::DataType bad_type;
  538. bad_type.kind = GDScriptParser::DataType::VARIANT;
  539. bad_type.type_source = GDScriptParser::DataType::INFERRED;
  540. if (p_type == nullptr) {
  541. return bad_type;
  542. }
  543. if (p_type->get_datatype().is_resolving()) {
  544. push_error(R"(Could not resolve datatype: Cyclic reference.)", p_type);
  545. return bad_type;
  546. }
  547. if (!p_type->get_datatype().has_no_type()) {
  548. return p_type->get_datatype();
  549. }
  550. GDScriptParser::DataType resolving_datatype;
  551. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  552. p_type->set_datatype(resolving_datatype);
  553. GDScriptParser::DataType result;
  554. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  555. if (p_type->type_chain.is_empty()) {
  556. // void.
  557. result.kind = GDScriptParser::DataType::BUILTIN;
  558. result.builtin_type = Variant::NIL;
  559. p_type->set_datatype(result);
  560. return result;
  561. }
  562. const GDScriptParser::IdentifierNode *first_id = p_type->type_chain[0];
  563. StringName first = first_id->name;
  564. bool type_found = false;
  565. if (first_id->suite && first_id->suite->has_local(first)) {
  566. const GDScriptParser::SuiteNode::Local &local = first_id->suite->get_local(first);
  567. if (local.type == GDScriptParser::SuiteNode::Local::CONSTANT) {
  568. result = local.get_datatype();
  569. if (!result.is_set()) {
  570. // Don't try to resolve it as the constant can be declared below.
  571. push_error(vformat(R"(Local constant "%s" is not resolved at this point.)", first), first_id);
  572. return bad_type;
  573. }
  574. if (result.is_meta_type) {
  575. type_found = true;
  576. } else if (Ref<Script>(local.constant->initializer->reduced_value).is_valid()) {
  577. Ref<GDScript> gdscript = local.constant->initializer->reduced_value;
  578. if (gdscript.is_valid()) {
  579. Ref<GDScriptParserRef> ref = parser->get_depended_parser_for(gdscript->get_script_path());
  580. if (ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED) != OK) {
  581. push_error(vformat(R"(Could not parse script from "%s".)", gdscript->get_script_path()), first_id);
  582. return bad_type;
  583. }
  584. result = ref->get_parser()->head->get_datatype();
  585. } else {
  586. result = make_script_meta_type(local.constant->initializer->reduced_value);
  587. }
  588. type_found = true;
  589. } else {
  590. push_error(vformat(R"(Local constant "%s" is not a valid type.)", first), first_id);
  591. return bad_type;
  592. }
  593. } else {
  594. push_error(vformat(R"(Local %s "%s" cannot be used as a type.)", local.get_name(), first), first_id);
  595. return bad_type;
  596. }
  597. }
  598. if (!type_found) {
  599. if (first == SNAME("Variant")) {
  600. if (p_type->type_chain.size() == 2) {
  601. // May be nested enum.
  602. StringName enum_name = p_type->type_chain[1]->name;
  603. StringName qualified_name = String(first) + ENUM_SEPARATOR + String(p_type->type_chain[1]->name);
  604. if (CoreConstants::is_global_enum(qualified_name)) {
  605. result = make_global_enum_type(enum_name, first, true);
  606. return result;
  607. } else {
  608. push_error(vformat(R"(Name "%s" is not a nested type of "Variant".)", enum_name), p_type->type_chain[1]);
  609. return bad_type;
  610. }
  611. } else if (p_type->type_chain.size() > 2) {
  612. push_error(R"(Variant only contains enum types, which do not have nested types.)", p_type->type_chain[2]);
  613. return bad_type;
  614. }
  615. result.kind = GDScriptParser::DataType::VARIANT;
  616. } else if (GDScriptParser::get_builtin_type(first) < Variant::VARIANT_MAX) {
  617. // Built-in types.
  618. if (p_type->type_chain.size() > 1) {
  619. push_error(R"(Built-in types don't contain nested types.)", p_type->type_chain[1]);
  620. return bad_type;
  621. }
  622. result.kind = GDScriptParser::DataType::BUILTIN;
  623. result.builtin_type = GDScriptParser::get_builtin_type(first);
  624. if (result.builtin_type == Variant::ARRAY) {
  625. GDScriptParser::DataType container_type = type_from_metatype(resolve_datatype(p_type->get_container_type_or_null(0)));
  626. if (container_type.kind != GDScriptParser::DataType::VARIANT) {
  627. container_type.is_constant = false;
  628. result.set_container_element_type(0, container_type);
  629. }
  630. }
  631. if (result.builtin_type == Variant::DICTIONARY) {
  632. GDScriptParser::DataType key_type = type_from_metatype(resolve_datatype(p_type->get_container_type_or_null(0)));
  633. if (key_type.kind != GDScriptParser::DataType::VARIANT) {
  634. key_type.is_constant = false;
  635. result.set_container_element_type(0, key_type);
  636. }
  637. GDScriptParser::DataType value_type = type_from_metatype(resolve_datatype(p_type->get_container_type_or_null(1)));
  638. if (value_type.kind != GDScriptParser::DataType::VARIANT) {
  639. value_type.is_constant = false;
  640. result.set_container_element_type(1, value_type);
  641. }
  642. }
  643. } else if (class_exists(first)) {
  644. // Native engine classes.
  645. result.kind = GDScriptParser::DataType::NATIVE;
  646. result.builtin_type = Variant::OBJECT;
  647. result.native_type = first;
  648. } else if (ScriptServer::is_global_class(first)) {
  649. if (GDScript::is_canonically_equal_paths(parser->script_path, ScriptServer::get_global_class_path(first))) {
  650. result = parser->head->get_datatype();
  651. } else {
  652. String path = ScriptServer::get_global_class_path(first);
  653. String ext = path.get_extension();
  654. if (ext == GDScriptLanguage::get_singleton()->get_extension()) {
  655. Ref<GDScriptParserRef> ref = parser->get_depended_parser_for(path);
  656. if (!ref.is_valid() || ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED) != OK) {
  657. push_error(vformat(R"(Could not parse global class "%s" from "%s".)", first, ScriptServer::get_global_class_path(first)), p_type);
  658. return bad_type;
  659. }
  660. result = ref->get_parser()->head->get_datatype();
  661. } else {
  662. result = make_script_meta_type(ResourceLoader::load(path, "Script"));
  663. }
  664. }
  665. } else if (ProjectSettings::get_singleton()->has_autoload(first) && ProjectSettings::get_singleton()->get_autoload(first).is_singleton) {
  666. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(first);
  667. String script_path;
  668. if (ResourceLoader::get_resource_type(autoload.path) == "PackedScene") {
  669. // Try to get script from scene if possible.
  670. if (GDScriptLanguage::get_singleton()->has_any_global_constant(autoload.name)) {
  671. Variant constant = GDScriptLanguage::get_singleton()->get_any_global_constant(autoload.name);
  672. Node *node = Object::cast_to<Node>(constant);
  673. if (node != nullptr) {
  674. Ref<GDScript> scr = node->get_script();
  675. if (scr.is_valid()) {
  676. script_path = scr->get_script_path();
  677. }
  678. }
  679. }
  680. } else if (ResourceLoader::get_resource_type(autoload.path) == "GDScript") {
  681. script_path = autoload.path;
  682. }
  683. if (script_path.is_empty()) {
  684. return bad_type;
  685. }
  686. Ref<GDScriptParserRef> ref = parser->get_depended_parser_for(script_path);
  687. if (ref.is_null()) {
  688. push_error(vformat(R"(The referenced autoload "%s" (from "%s") could not be loaded.)", first, script_path), p_type);
  689. return bad_type;
  690. }
  691. if (ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED) != OK) {
  692. push_error(vformat(R"(Could not parse singleton "%s" from "%s".)", first, script_path), p_type);
  693. return bad_type;
  694. }
  695. result = ref->get_parser()->head->get_datatype();
  696. } else if (ClassDB::has_enum(parser->current_class->base_type.native_type, first)) {
  697. // Native enum in current class.
  698. result = make_native_enum_type(first, parser->current_class->base_type.native_type);
  699. } else if (CoreConstants::is_global_enum(first)) {
  700. if (p_type->type_chain.size() > 1) {
  701. push_error(R"(Enums cannot contain nested types.)", p_type->type_chain[1]);
  702. return bad_type;
  703. }
  704. result = make_global_enum_type(first, StringName());
  705. } else {
  706. // Classes in current scope.
  707. List<GDScriptParser::ClassNode *> script_classes;
  708. bool found = false;
  709. get_class_node_current_scope_classes(parser->current_class, &script_classes, p_type);
  710. for (GDScriptParser::ClassNode *script_class : script_classes) {
  711. if (found) {
  712. break;
  713. }
  714. if (script_class->identifier && script_class->identifier->name == first) {
  715. result = script_class->get_datatype();
  716. break;
  717. }
  718. if (script_class->members_indices.has(first)) {
  719. resolve_class_member(script_class, first, p_type);
  720. GDScriptParser::ClassNode::Member member = script_class->get_member(first);
  721. switch (member.type) {
  722. case GDScriptParser::ClassNode::Member::CLASS:
  723. result = member.get_datatype();
  724. found = true;
  725. break;
  726. case GDScriptParser::ClassNode::Member::ENUM:
  727. result = member.get_datatype();
  728. found = true;
  729. break;
  730. case GDScriptParser::ClassNode::Member::CONSTANT:
  731. if (member.get_datatype().is_meta_type) {
  732. result = member.get_datatype();
  733. found = true;
  734. break;
  735. } else if (Ref<Script>(member.constant->initializer->reduced_value).is_valid()) {
  736. Ref<GDScript> gdscript = member.constant->initializer->reduced_value;
  737. if (gdscript.is_valid()) {
  738. Ref<GDScriptParserRef> ref = parser->get_depended_parser_for(gdscript->get_script_path());
  739. if (ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED) != OK) {
  740. push_error(vformat(R"(Could not parse script from "%s".)", gdscript->get_script_path()), p_type);
  741. return bad_type;
  742. }
  743. result = ref->get_parser()->head->get_datatype();
  744. } else {
  745. result = make_script_meta_type(member.constant->initializer->reduced_value);
  746. }
  747. found = true;
  748. break;
  749. }
  750. [[fallthrough]];
  751. default:
  752. push_error(vformat(R"("%s" is a %s but does not contain a type.)", first, member.get_type_name()), p_type);
  753. return bad_type;
  754. }
  755. }
  756. }
  757. }
  758. }
  759. if (!result.is_set()) {
  760. push_error(vformat(R"(Could not find type "%s" in the current scope.)", first), p_type);
  761. return bad_type;
  762. }
  763. if (p_type->type_chain.size() > 1) {
  764. if (result.kind == GDScriptParser::DataType::CLASS) {
  765. for (int i = 1; i < p_type->type_chain.size(); i++) {
  766. GDScriptParser::DataType base = result;
  767. reduce_identifier_from_base(p_type->type_chain[i], &base);
  768. result = p_type->type_chain[i]->get_datatype();
  769. if (!result.is_set()) {
  770. 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]);
  771. return bad_type;
  772. } else if (!result.is_meta_type) {
  773. 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]);
  774. return bad_type;
  775. }
  776. }
  777. } else if (result.kind == GDScriptParser::DataType::NATIVE) {
  778. // Only enums allowed for native.
  779. if (ClassDB::has_enum(result.native_type, p_type->type_chain[1]->name)) {
  780. if (p_type->type_chain.size() > 2) {
  781. push_error(R"(Enums cannot contain nested types.)", p_type->type_chain[2]);
  782. return bad_type;
  783. } else {
  784. result = make_native_enum_type(p_type->type_chain[1]->name, result.native_type);
  785. }
  786. } else {
  787. push_error(vformat(R"(Could not find type "%s" in "%s".)", p_type->type_chain[1]->name, first), p_type->type_chain[1]);
  788. return bad_type;
  789. }
  790. } else {
  791. 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]);
  792. return bad_type;
  793. }
  794. }
  795. if (!p_type->container_types.is_empty()) {
  796. if (result.builtin_type == Variant::ARRAY) {
  797. if (p_type->container_types.size() != 1) {
  798. push_error(R"(Typed arrays require exactly one collection element type.)", p_type);
  799. return bad_type;
  800. }
  801. } else if (result.builtin_type == Variant::DICTIONARY) {
  802. if (p_type->container_types.size() != 2) {
  803. push_error(R"(Typed dictionaries require exactly two collection element types.)", p_type);
  804. return bad_type;
  805. }
  806. } else {
  807. push_error(R"(Only arrays and dictionaries can specify collection element types.)", p_type);
  808. return bad_type;
  809. }
  810. }
  811. p_type->set_datatype(result);
  812. return result;
  813. }
  814. void GDScriptAnalyzer::resolve_class_member(GDScriptParser::ClassNode *p_class, const StringName &p_name, const GDScriptParser::Node *p_source) {
  815. ERR_FAIL_COND(!p_class->has_member(p_name));
  816. resolve_class_member(p_class, p_class->members_indices[p_name], p_source);
  817. }
  818. void GDScriptAnalyzer::resolve_class_member(GDScriptParser::ClassNode *p_class, int p_index, const GDScriptParser::Node *p_source) {
  819. ERR_FAIL_INDEX(p_index, p_class->members.size());
  820. GDScriptParser::ClassNode::Member &member = p_class->members.write[p_index];
  821. if (p_source == nullptr && parser->has_class(p_class)) {
  822. p_source = member.get_source_node();
  823. }
  824. Ref<GDScriptParserRef> parser_ref = ensure_cached_external_parser_for_class(p_class, nullptr, "Trying to resolve class member", p_source);
  825. Finally finally([&]() {
  826. ensure_cached_external_parser_for_class(member.get_datatype().class_type, p_class, "Trying to resolve datatype of class member", p_source);
  827. GDScriptParser::DataType member_type = member.get_datatype();
  828. for (int i = 0; i < member_type.get_container_element_type_count(); ++i) {
  829. ensure_cached_external_parser_for_class(member_type.get_container_element_type(i).class_type, p_class, "Trying to resolve datatype of class member", p_source);
  830. }
  831. });
  832. if (member.get_datatype().is_resolving()) {
  833. push_error(vformat(R"(Could not resolve member "%s": Cyclic reference.)", member.get_name()), p_source);
  834. return;
  835. }
  836. if (member.get_datatype().is_set()) {
  837. return;
  838. }
  839. // If it's already resolving, that's ok.
  840. if (!p_class->base_type.is_resolving()) {
  841. Error err = resolve_class_inheritance(p_class);
  842. if (err) {
  843. return;
  844. }
  845. }
  846. if (!parser->has_class(p_class)) {
  847. if (parser_ref.is_null()) {
  848. // Error already pushed.
  849. return;
  850. }
  851. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  852. if (err) {
  853. push_error(vformat(R"(Could not parse script "%s": %s (While resolving external class member "%s").)", p_class->get_datatype().script_path, error_names[err], member.get_name()), p_source);
  854. return;
  855. }
  856. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  857. GDScriptParser *other_parser = parser_ref->get_parser();
  858. int error_count = other_parser->errors.size();
  859. other_analyzer->resolve_class_member(p_class, p_index);
  860. if (other_parser->errors.size() > error_count) {
  861. push_error(vformat(R"(Could not resolve external class member "%s".)", member.get_name()), p_source);
  862. return;
  863. }
  864. return;
  865. }
  866. GDScriptParser::ClassNode *previous_class = parser->current_class;
  867. parser->current_class = p_class;
  868. GDScriptParser::DataType resolving_datatype;
  869. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  870. {
  871. #ifdef DEBUG_ENABLED
  872. GDScriptParser::Node *member_node = member.get_source_node();
  873. if (member_node && member_node->type != GDScriptParser::Node::ANNOTATION) {
  874. // Apply @warning_ignore annotations before resolving member.
  875. for (GDScriptParser::AnnotationNode *&E : member_node->annotations) {
  876. if (E->name == SNAME("@warning_ignore")) {
  877. resolve_annotation(E);
  878. E->apply(parser, member.variable, p_class);
  879. }
  880. }
  881. }
  882. #endif
  883. switch (member.type) {
  884. case GDScriptParser::ClassNode::Member::VARIABLE: {
  885. bool previous_static_context = static_context;
  886. static_context = member.variable->is_static;
  887. check_class_member_name_conflict(p_class, member.variable->identifier->name, member.variable);
  888. member.variable->set_datatype(resolving_datatype);
  889. resolve_variable(member.variable, false);
  890. resolve_pending_lambda_bodies();
  891. // Apply annotations.
  892. for (GDScriptParser::AnnotationNode *&E : member.variable->annotations) {
  893. if (E->name != SNAME("@warning_ignore")) {
  894. resolve_annotation(E);
  895. E->apply(parser, member.variable, p_class);
  896. }
  897. }
  898. static_context = previous_static_context;
  899. #ifdef DEBUG_ENABLED
  900. if (member.variable->exported && member.variable->onready) {
  901. parser->push_warning(member.variable, GDScriptWarning::ONREADY_WITH_EXPORT);
  902. }
  903. if (member.variable->initializer) {
  904. // Check if it is call to get_node() on self (using shorthand $ or not), so we can check if @onready is needed.
  905. // This could be improved by traversing the expression fully and checking the presence of get_node at any level.
  906. if (!member.variable->is_static && !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)) {
  907. GDScriptParser::Node *expr = member.variable->initializer;
  908. if (expr->type == GDScriptParser::Node::CAST) {
  909. expr = static_cast<GDScriptParser::CastNode *>(expr)->operand;
  910. }
  911. bool is_get_node = expr->type == GDScriptParser::Node::GET_NODE;
  912. bool is_using_shorthand = is_get_node;
  913. if (!is_get_node && expr->type == GDScriptParser::Node::CALL) {
  914. is_using_shorthand = false;
  915. GDScriptParser::CallNode *call = static_cast<GDScriptParser::CallNode *>(expr);
  916. if (call->function_name == SNAME("get_node")) {
  917. switch (call->get_callee_type()) {
  918. case GDScriptParser::Node::IDENTIFIER: {
  919. is_get_node = true;
  920. } break;
  921. case GDScriptParser::Node::SUBSCRIPT: {
  922. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(call->callee);
  923. is_get_node = subscript->is_attribute && subscript->base->type == GDScriptParser::Node::SELF;
  924. } break;
  925. default:
  926. break;
  927. }
  928. }
  929. }
  930. if (is_get_node) {
  931. parser->push_warning(member.variable, GDScriptWarning::GET_NODE_DEFAULT_WITHOUT_ONREADY, is_using_shorthand ? "$" : "get_node()");
  932. }
  933. }
  934. }
  935. #endif
  936. } break;
  937. case GDScriptParser::ClassNode::Member::CONSTANT: {
  938. check_class_member_name_conflict(p_class, member.constant->identifier->name, member.constant);
  939. member.constant->set_datatype(resolving_datatype);
  940. resolve_constant(member.constant, false);
  941. // Apply annotations.
  942. for (GDScriptParser::AnnotationNode *&E : member.constant->annotations) {
  943. resolve_annotation(E);
  944. E->apply(parser, member.constant, p_class);
  945. }
  946. } break;
  947. case GDScriptParser::ClassNode::Member::SIGNAL: {
  948. check_class_member_name_conflict(p_class, member.signal->identifier->name, member.signal);
  949. member.signal->set_datatype(resolving_datatype);
  950. // This is the _only_ way to declare a signal. Therefore, we can generate its
  951. // MethodInfo inline so it's a tiny bit more efficient.
  952. MethodInfo mi = MethodInfo(member.signal->identifier->name);
  953. for (int j = 0; j < member.signal->parameters.size(); j++) {
  954. GDScriptParser::ParameterNode *param = member.signal->parameters[j];
  955. GDScriptParser::DataType param_type = type_from_metatype(resolve_datatype(param->datatype_specifier));
  956. param->set_datatype(param_type);
  957. #ifdef DEBUG_ENABLED
  958. if (param->datatype_specifier == nullptr) {
  959. parser->push_warning(param, GDScriptWarning::UNTYPED_DECLARATION, "Parameter", param->identifier->name);
  960. }
  961. #endif
  962. mi.arguments.push_back(param_type.to_property_info(param->identifier->name));
  963. // Signals do not support parameter default values.
  964. }
  965. member.signal->set_datatype(make_signal_type(mi));
  966. member.signal->method_info = mi;
  967. // Apply annotations.
  968. for (GDScriptParser::AnnotationNode *&E : member.signal->annotations) {
  969. resolve_annotation(E);
  970. E->apply(parser, member.signal, p_class);
  971. }
  972. } break;
  973. case GDScriptParser::ClassNode::Member::ENUM: {
  974. check_class_member_name_conflict(p_class, member.m_enum->identifier->name, member.m_enum);
  975. member.m_enum->set_datatype(resolving_datatype);
  976. GDScriptParser::DataType enum_type = make_class_enum_type(member.m_enum->identifier->name, p_class, parser->script_path, true);
  977. const GDScriptParser::EnumNode *prev_enum = current_enum;
  978. current_enum = member.m_enum;
  979. Dictionary dictionary;
  980. for (int j = 0; j < member.m_enum->values.size(); j++) {
  981. GDScriptParser::EnumNode::Value &element = member.m_enum->values.write[j];
  982. if (element.custom_value) {
  983. reduce_expression(element.custom_value);
  984. if (!element.custom_value->is_constant) {
  985. push_error(R"(Enum values must be constant.)", element.custom_value);
  986. } else if (element.custom_value->reduced_value.get_type() != Variant::INT) {
  987. push_error(R"(Enum values must be integers.)", element.custom_value);
  988. } else {
  989. element.value = element.custom_value->reduced_value;
  990. element.resolved = true;
  991. }
  992. } else {
  993. if (element.index > 0) {
  994. element.value = element.parent_enum->values[element.index - 1].value + 1;
  995. } else {
  996. element.value = 0;
  997. }
  998. element.resolved = true;
  999. }
  1000. enum_type.enum_values[element.identifier->name] = element.value;
  1001. dictionary[String(element.identifier->name)] = element.value;
  1002. #ifdef DEBUG_ENABLED
  1003. // Named enum identifiers do not shadow anything since you can only access them with `NamedEnum.ENUM_VALUE`.
  1004. if (member.m_enum->identifier->name == StringName()) {
  1005. is_shadowing(element.identifier, "enum member", false);
  1006. }
  1007. #endif
  1008. }
  1009. current_enum = prev_enum;
  1010. dictionary.make_read_only();
  1011. member.m_enum->set_datatype(enum_type);
  1012. member.m_enum->dictionary = dictionary;
  1013. // Apply annotations.
  1014. for (GDScriptParser::AnnotationNode *&E : member.m_enum->annotations) {
  1015. resolve_annotation(E);
  1016. E->apply(parser, member.m_enum, p_class);
  1017. }
  1018. } break;
  1019. case GDScriptParser::ClassNode::Member::FUNCTION:
  1020. for (GDScriptParser::AnnotationNode *&E : member.function->annotations) {
  1021. resolve_annotation(E);
  1022. E->apply(parser, member.function, p_class);
  1023. }
  1024. resolve_function_signature(member.function, p_source);
  1025. break;
  1026. case GDScriptParser::ClassNode::Member::ENUM_VALUE: {
  1027. member.enum_value.identifier->set_datatype(resolving_datatype);
  1028. if (member.enum_value.custom_value) {
  1029. check_class_member_name_conflict(p_class, member.enum_value.identifier->name, member.enum_value.custom_value);
  1030. const GDScriptParser::EnumNode *prev_enum = current_enum;
  1031. current_enum = member.enum_value.parent_enum;
  1032. reduce_expression(member.enum_value.custom_value);
  1033. current_enum = prev_enum;
  1034. if (!member.enum_value.custom_value->is_constant) {
  1035. push_error(R"(Enum values must be constant.)", member.enum_value.custom_value);
  1036. } else if (member.enum_value.custom_value->reduced_value.get_type() != Variant::INT) {
  1037. push_error(R"(Enum values must be integers.)", member.enum_value.custom_value);
  1038. } else {
  1039. member.enum_value.value = member.enum_value.custom_value->reduced_value;
  1040. member.enum_value.resolved = true;
  1041. }
  1042. } else {
  1043. check_class_member_name_conflict(p_class, member.enum_value.identifier->name, member.enum_value.parent_enum);
  1044. if (member.enum_value.index > 0) {
  1045. const GDScriptParser::EnumNode::Value &prev_value = member.enum_value.parent_enum->values[member.enum_value.index - 1];
  1046. resolve_class_member(p_class, prev_value.identifier->name, member.enum_value.identifier);
  1047. member.enum_value.value = prev_value.value + 1;
  1048. } else {
  1049. member.enum_value.value = 0;
  1050. }
  1051. member.enum_value.resolved = true;
  1052. }
  1053. // Also update the original references.
  1054. member.enum_value.parent_enum->values.set(member.enum_value.index, member.enum_value);
  1055. member.enum_value.identifier->set_datatype(make_class_enum_type(UNNAMED_ENUM, p_class, parser->script_path, false));
  1056. } break;
  1057. case GDScriptParser::ClassNode::Member::CLASS:
  1058. check_class_member_name_conflict(p_class, member.m_class->identifier->name, member.m_class);
  1059. // If it's already resolving, that's ok.
  1060. if (!member.m_class->base_type.is_resolving()) {
  1061. resolve_class_inheritance(member.m_class, p_source);
  1062. }
  1063. break;
  1064. case GDScriptParser::ClassNode::Member::GROUP:
  1065. // No-op, but needed to silence warnings.
  1066. break;
  1067. case GDScriptParser::ClassNode::Member::UNDEFINED:
  1068. ERR_PRINT("Trying to resolve undefined member.");
  1069. break;
  1070. }
  1071. }
  1072. parser->current_class = previous_class;
  1073. }
  1074. void GDScriptAnalyzer::resolve_class_interface(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source) {
  1075. if (p_source == nullptr && parser->has_class(p_class)) {
  1076. p_source = p_class;
  1077. }
  1078. Ref<GDScriptParserRef> parser_ref = ensure_cached_external_parser_for_class(p_class, nullptr, "Trying to resolve class interface", p_source);
  1079. if (!p_class->resolved_interface) {
  1080. #ifdef DEBUG_ENABLED
  1081. bool has_static_data = p_class->has_static_data;
  1082. #endif
  1083. if (!parser->has_class(p_class)) {
  1084. if (parser_ref.is_null()) {
  1085. // Error already pushed.
  1086. return;
  1087. }
  1088. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  1089. if (err) {
  1090. push_error(vformat(R"(Could not parse script "%s": %s.)", p_class->get_datatype().script_path, error_names[err]), p_source);
  1091. return;
  1092. }
  1093. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  1094. GDScriptParser *other_parser = parser_ref->get_parser();
  1095. int error_count = other_parser->errors.size();
  1096. other_analyzer->resolve_class_interface(p_class);
  1097. if (other_parser->errors.size() > error_count) {
  1098. push_error(vformat(R"(Could not resolve class "%s".)", p_class->fqcn), p_source);
  1099. return;
  1100. }
  1101. return;
  1102. }
  1103. p_class->resolved_interface = true;
  1104. if (resolve_class_inheritance(p_class) != OK) {
  1105. return;
  1106. }
  1107. GDScriptParser::DataType base_type = p_class->base_type;
  1108. if (base_type.kind == GDScriptParser::DataType::CLASS) {
  1109. GDScriptParser::ClassNode *base_class = base_type.class_type;
  1110. resolve_class_interface(base_class, p_class);
  1111. }
  1112. for (int i = 0; i < p_class->members.size(); i++) {
  1113. resolve_class_member(p_class, i);
  1114. #ifdef DEBUG_ENABLED
  1115. if (!has_static_data) {
  1116. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1117. if (member.type == GDScriptParser::ClassNode::Member::CLASS) {
  1118. has_static_data = member.m_class->has_static_data;
  1119. }
  1120. }
  1121. #endif
  1122. }
  1123. #ifdef DEBUG_ENABLED
  1124. if (!has_static_data && p_class->annotated_static_unload) {
  1125. GDScriptParser::Node *static_unload = nullptr;
  1126. for (GDScriptParser::AnnotationNode *node : p_class->annotations) {
  1127. if (node->name == "@static_unload") {
  1128. static_unload = node;
  1129. break;
  1130. }
  1131. }
  1132. parser->push_warning(static_unload ? static_unload : p_class, GDScriptWarning::REDUNDANT_STATIC_UNLOAD);
  1133. }
  1134. #endif
  1135. }
  1136. }
  1137. void GDScriptAnalyzer::resolve_class_interface(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  1138. resolve_class_interface(p_class);
  1139. if (p_recursive) {
  1140. for (int i = 0; i < p_class->members.size(); i++) {
  1141. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1142. if (member.type == GDScriptParser::ClassNode::Member::CLASS) {
  1143. resolve_class_interface(member.m_class, true);
  1144. }
  1145. }
  1146. }
  1147. }
  1148. void GDScriptAnalyzer::resolve_class_body(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source) {
  1149. if (p_source == nullptr && parser->has_class(p_class)) {
  1150. p_source = p_class;
  1151. }
  1152. Ref<GDScriptParserRef> parser_ref = ensure_cached_external_parser_for_class(p_class, nullptr, "Trying to resolve class body", p_source);
  1153. if (p_class->resolved_body) {
  1154. return;
  1155. }
  1156. if (!parser->has_class(p_class)) {
  1157. if (parser_ref.is_null()) {
  1158. // Error already pushed.
  1159. return;
  1160. }
  1161. Error err = parser_ref->raise_status(GDScriptParserRef::PARSED);
  1162. if (err) {
  1163. push_error(vformat(R"(Could not parse script "%s": %s.)", p_class->get_datatype().script_path, error_names[err]), p_source);
  1164. return;
  1165. }
  1166. GDScriptAnalyzer *other_analyzer = parser_ref->get_analyzer();
  1167. GDScriptParser *other_parser = parser_ref->get_parser();
  1168. int error_count = other_parser->errors.size();
  1169. other_analyzer->resolve_class_body(p_class);
  1170. if (other_parser->errors.size() > error_count) {
  1171. push_error(vformat(R"(Could not resolve class "%s".)", p_class->fqcn), p_source);
  1172. return;
  1173. }
  1174. return;
  1175. }
  1176. p_class->resolved_body = true;
  1177. GDScriptParser::ClassNode *previous_class = parser->current_class;
  1178. parser->current_class = p_class;
  1179. resolve_class_interface(p_class, p_source);
  1180. GDScriptParser::DataType base_type = p_class->base_type;
  1181. if (base_type.kind == GDScriptParser::DataType::CLASS) {
  1182. GDScriptParser::ClassNode *base_class = base_type.class_type;
  1183. resolve_class_body(base_class, p_class);
  1184. }
  1185. // Do functions, properties, and groups now.
  1186. for (int i = 0; i < p_class->members.size(); i++) {
  1187. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1188. if (member.type == GDScriptParser::ClassNode::Member::FUNCTION) {
  1189. // Apply annotations.
  1190. for (GDScriptParser::AnnotationNode *&E : member.function->annotations) {
  1191. resolve_annotation(E);
  1192. E->apply(parser, member.function, p_class);
  1193. }
  1194. resolve_function_body(member.function);
  1195. } else if (member.type == GDScriptParser::ClassNode::Member::VARIABLE && member.variable->property != GDScriptParser::VariableNode::PROP_NONE) {
  1196. if (member.variable->property == GDScriptParser::VariableNode::PROP_INLINE) {
  1197. if (member.variable->getter != nullptr) {
  1198. member.variable->getter->return_type = member.variable->datatype_specifier;
  1199. member.variable->getter->set_datatype(member.get_datatype());
  1200. resolve_function_body(member.variable->getter);
  1201. }
  1202. if (member.variable->setter != nullptr) {
  1203. ERR_CONTINUE(member.variable->setter->parameters.is_empty());
  1204. member.variable->setter->parameters[0]->datatype_specifier = member.variable->datatype_specifier;
  1205. member.variable->setter->parameters[0]->set_datatype(member.get_datatype());
  1206. resolve_function_body(member.variable->setter);
  1207. }
  1208. }
  1209. } else if (member.type == GDScriptParser::ClassNode::Member::GROUP) {
  1210. // Apply annotation (`@export_{category,group,subgroup}`).
  1211. resolve_annotation(member.annotation);
  1212. member.annotation->apply(parser, nullptr, p_class);
  1213. }
  1214. }
  1215. // Check unused variables and datatypes of property getters and setters.
  1216. for (int i = 0; i < p_class->members.size(); i++) {
  1217. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1218. if (member.type == GDScriptParser::ClassNode::Member::VARIABLE) {
  1219. #ifdef DEBUG_ENABLED
  1220. if (member.variable->usages == 0 && String(member.variable->identifier->name).begins_with("_")) {
  1221. parser->push_warning(member.variable->identifier, GDScriptWarning::UNUSED_PRIVATE_CLASS_VARIABLE, member.variable->identifier->name);
  1222. }
  1223. #endif
  1224. if (member.variable->property == GDScriptParser::VariableNode::PROP_SETGET) {
  1225. GDScriptParser::FunctionNode *getter_function = nullptr;
  1226. GDScriptParser::FunctionNode *setter_function = nullptr;
  1227. bool has_valid_getter = false;
  1228. bool has_valid_setter = false;
  1229. if (member.variable->getter_pointer != nullptr) {
  1230. if (p_class->has_function(member.variable->getter_pointer->name)) {
  1231. getter_function = p_class->get_member(member.variable->getter_pointer->name).function;
  1232. }
  1233. if (getter_function == nullptr) {
  1234. push_error(vformat(R"(Getter "%s" not found.)", member.variable->getter_pointer->name), member.variable);
  1235. } else {
  1236. GDScriptParser::DataType return_datatype = getter_function->datatype;
  1237. if (getter_function->return_type != nullptr) {
  1238. return_datatype = getter_function->return_type->datatype;
  1239. return_datatype.is_meta_type = false;
  1240. }
  1241. if (getter_function->parameters.size() != 0 || return_datatype.has_no_type()) {
  1242. push_error(vformat(R"(Function "%s" cannot be used as getter because of its signature.)", getter_function->identifier->name), member.variable);
  1243. } else if (!is_type_compatible(member.variable->datatype, return_datatype, true)) {
  1244. 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);
  1245. } else {
  1246. has_valid_getter = true;
  1247. #ifdef DEBUG_ENABLED
  1248. if (member.variable->datatype.builtin_type == Variant::INT && return_datatype.builtin_type == Variant::FLOAT) {
  1249. parser->push_warning(member.variable, GDScriptWarning::NARROWING_CONVERSION);
  1250. }
  1251. #endif
  1252. }
  1253. }
  1254. }
  1255. if (member.variable->setter_pointer != nullptr) {
  1256. if (p_class->has_function(member.variable->setter_pointer->name)) {
  1257. setter_function = p_class->get_member(member.variable->setter_pointer->name).function;
  1258. }
  1259. if (setter_function == nullptr) {
  1260. push_error(vformat(R"(Setter "%s" not found.)", member.variable->setter_pointer->name), member.variable);
  1261. } else if (setter_function->parameters.size() != 1) {
  1262. push_error(vformat(R"(Function "%s" cannot be used as setter because of its signature.)", setter_function->identifier->name), member.variable);
  1263. } else if (!is_type_compatible(member.variable->datatype, setter_function->parameters[0]->datatype, true)) {
  1264. 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);
  1265. } else {
  1266. has_valid_setter = true;
  1267. #ifdef DEBUG_ENABLED
  1268. if (member.variable->datatype.builtin_type == Variant::FLOAT && setter_function->parameters[0]->datatype.builtin_type == Variant::INT) {
  1269. parser->push_warning(member.variable, GDScriptWarning::NARROWING_CONVERSION);
  1270. }
  1271. #endif
  1272. }
  1273. }
  1274. if (member.variable->datatype.is_variant() && has_valid_getter && has_valid_setter) {
  1275. if (!is_type_compatible(getter_function->datatype, setter_function->parameters[0]->datatype, true)) {
  1276. 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);
  1277. }
  1278. }
  1279. }
  1280. } else if (member.type == GDScriptParser::ClassNode::Member::SIGNAL) {
  1281. #ifdef DEBUG_ENABLED
  1282. if (member.signal->usages == 0) {
  1283. parser->push_warning(member.signal->identifier, GDScriptWarning::UNUSED_SIGNAL, member.signal->identifier->name);
  1284. }
  1285. #endif
  1286. }
  1287. }
  1288. if (!pending_body_resolution_lambdas.is_empty()) {
  1289. ERR_PRINT("GDScript bug (please report): Not all pending lambda bodies were resolved in time.");
  1290. resolve_pending_lambda_bodies();
  1291. }
  1292. parser->current_class = previous_class;
  1293. }
  1294. void GDScriptAnalyzer::resolve_class_body(GDScriptParser::ClassNode *p_class, bool p_recursive) {
  1295. resolve_class_body(p_class);
  1296. if (p_recursive) {
  1297. for (int i = 0; i < p_class->members.size(); i++) {
  1298. GDScriptParser::ClassNode::Member member = p_class->members[i];
  1299. if (member.type == GDScriptParser::ClassNode::Member::CLASS) {
  1300. resolve_class_body(member.m_class, true);
  1301. }
  1302. }
  1303. }
  1304. }
  1305. void GDScriptAnalyzer::resolve_node(GDScriptParser::Node *p_node, bool p_is_root) {
  1306. ERR_FAIL_NULL_MSG(p_node, "Trying to resolve type of a null node.");
  1307. switch (p_node->type) {
  1308. case GDScriptParser::Node::NONE:
  1309. break; // Unreachable.
  1310. case GDScriptParser::Node::CLASS:
  1311. // NOTE: Currently this route is never executed, `resolve_class_*()` is called directly.
  1312. if (OK == resolve_class_inheritance(static_cast<GDScriptParser::ClassNode *>(p_node), true)) {
  1313. resolve_class_interface(static_cast<GDScriptParser::ClassNode *>(p_node), true);
  1314. resolve_class_body(static_cast<GDScriptParser::ClassNode *>(p_node), true);
  1315. }
  1316. break;
  1317. case GDScriptParser::Node::CONSTANT:
  1318. resolve_constant(static_cast<GDScriptParser::ConstantNode *>(p_node), true);
  1319. break;
  1320. case GDScriptParser::Node::FOR:
  1321. resolve_for(static_cast<GDScriptParser::ForNode *>(p_node));
  1322. break;
  1323. case GDScriptParser::Node::IF:
  1324. resolve_if(static_cast<GDScriptParser::IfNode *>(p_node));
  1325. break;
  1326. case GDScriptParser::Node::SUITE:
  1327. resolve_suite(static_cast<GDScriptParser::SuiteNode *>(p_node));
  1328. break;
  1329. case GDScriptParser::Node::VARIABLE:
  1330. resolve_variable(static_cast<GDScriptParser::VariableNode *>(p_node), true);
  1331. break;
  1332. case GDScriptParser::Node::WHILE:
  1333. resolve_while(static_cast<GDScriptParser::WhileNode *>(p_node));
  1334. break;
  1335. case GDScriptParser::Node::ANNOTATION:
  1336. resolve_annotation(static_cast<GDScriptParser::AnnotationNode *>(p_node));
  1337. break;
  1338. case GDScriptParser::Node::ASSERT:
  1339. resolve_assert(static_cast<GDScriptParser::AssertNode *>(p_node));
  1340. break;
  1341. case GDScriptParser::Node::MATCH:
  1342. resolve_match(static_cast<GDScriptParser::MatchNode *>(p_node));
  1343. break;
  1344. case GDScriptParser::Node::MATCH_BRANCH:
  1345. resolve_match_branch(static_cast<GDScriptParser::MatchBranchNode *>(p_node), nullptr);
  1346. break;
  1347. case GDScriptParser::Node::PARAMETER:
  1348. resolve_parameter(static_cast<GDScriptParser::ParameterNode *>(p_node));
  1349. break;
  1350. case GDScriptParser::Node::PATTERN:
  1351. resolve_match_pattern(static_cast<GDScriptParser::PatternNode *>(p_node), nullptr);
  1352. break;
  1353. case GDScriptParser::Node::RETURN:
  1354. resolve_return(static_cast<GDScriptParser::ReturnNode *>(p_node));
  1355. break;
  1356. case GDScriptParser::Node::TYPE:
  1357. resolve_datatype(static_cast<GDScriptParser::TypeNode *>(p_node));
  1358. break;
  1359. // Resolving expression is the same as reducing them.
  1360. case GDScriptParser::Node::ARRAY:
  1361. case GDScriptParser::Node::ASSIGNMENT:
  1362. case GDScriptParser::Node::AWAIT:
  1363. case GDScriptParser::Node::BINARY_OPERATOR:
  1364. case GDScriptParser::Node::CALL:
  1365. case GDScriptParser::Node::CAST:
  1366. case GDScriptParser::Node::DICTIONARY:
  1367. case GDScriptParser::Node::GET_NODE:
  1368. case GDScriptParser::Node::IDENTIFIER:
  1369. case GDScriptParser::Node::LAMBDA:
  1370. case GDScriptParser::Node::LITERAL:
  1371. case GDScriptParser::Node::PRELOAD:
  1372. case GDScriptParser::Node::SELF:
  1373. case GDScriptParser::Node::SUBSCRIPT:
  1374. case GDScriptParser::Node::TERNARY_OPERATOR:
  1375. case GDScriptParser::Node::TYPE_TEST:
  1376. case GDScriptParser::Node::UNARY_OPERATOR:
  1377. reduce_expression(static_cast<GDScriptParser::ExpressionNode *>(p_node), p_is_root);
  1378. break;
  1379. case GDScriptParser::Node::BREAK:
  1380. case GDScriptParser::Node::BREAKPOINT:
  1381. case GDScriptParser::Node::CONTINUE:
  1382. case GDScriptParser::Node::ENUM:
  1383. case GDScriptParser::Node::FUNCTION:
  1384. case GDScriptParser::Node::PASS:
  1385. case GDScriptParser::Node::SIGNAL:
  1386. // Nothing to do.
  1387. break;
  1388. }
  1389. }
  1390. void GDScriptAnalyzer::resolve_annotation(GDScriptParser::AnnotationNode *p_annotation) {
  1391. ERR_FAIL_COND_MSG(!parser->valid_annotations.has(p_annotation->name), vformat(R"(Annotation "%s" not found to validate.)", p_annotation->name));
  1392. if (p_annotation->is_resolved) {
  1393. return;
  1394. }
  1395. p_annotation->is_resolved = true;
  1396. const MethodInfo &annotation_info = parser->valid_annotations[p_annotation->name].info;
  1397. const List<PropertyInfo>::Element *E = annotation_info.arguments.front();
  1398. for (int i = 0; i < p_annotation->arguments.size(); i++) {
  1399. GDScriptParser::ExpressionNode *argument = p_annotation->arguments[i];
  1400. const PropertyInfo &argument_info = E->get();
  1401. if (E->next() != nullptr) {
  1402. E = E->next();
  1403. }
  1404. reduce_expression(argument);
  1405. if (!argument->is_constant) {
  1406. push_error(vformat(R"(Argument %d of annotation "%s" isn't a constant expression.)", i + 1, p_annotation->name), argument);
  1407. return;
  1408. }
  1409. Variant value = argument->reduced_value;
  1410. if (value.get_type() != argument_info.type) {
  1411. #ifdef DEBUG_ENABLED
  1412. if (argument_info.type == Variant::INT && value.get_type() == Variant::FLOAT) {
  1413. parser->push_warning(argument, GDScriptWarning::NARROWING_CONVERSION);
  1414. }
  1415. #endif
  1416. if (!Variant::can_convert_strict(value.get_type(), argument_info.type)) {
  1417. 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);
  1418. return;
  1419. }
  1420. Variant converted_to;
  1421. const Variant *converted_from = &value;
  1422. Callable::CallError call_error;
  1423. Variant::construct(argument_info.type, converted_to, &converted_from, 1, call_error);
  1424. if (call_error.error != Callable::CallError::CALL_OK) {
  1425. 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);
  1426. return;
  1427. }
  1428. value = converted_to;
  1429. }
  1430. p_annotation->resolved_arguments.push_back(value);
  1431. }
  1432. }
  1433. void GDScriptAnalyzer::resolve_function_signature(GDScriptParser::FunctionNode *p_function, const GDScriptParser::Node *p_source, bool p_is_lambda) {
  1434. if (p_source == nullptr) {
  1435. p_source = p_function;
  1436. }
  1437. StringName function_name = p_function->identifier != nullptr ? p_function->identifier->name : StringName();
  1438. if (p_function->get_datatype().is_resolving()) {
  1439. push_error(vformat(R"(Could not resolve function "%s": Cyclic reference.)", function_name), p_source);
  1440. return;
  1441. }
  1442. if (p_function->resolved_signature) {
  1443. return;
  1444. }
  1445. p_function->resolved_signature = true;
  1446. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  1447. parser->current_function = p_function;
  1448. bool previous_static_context = static_context;
  1449. if (p_is_lambda) {
  1450. // For lambdas this is determined from the context, the `static` keyword is not allowed.
  1451. p_function->is_static = static_context;
  1452. } else {
  1453. // For normal functions, this is determined in the parser by the `static` keyword.
  1454. static_context = p_function->is_static;
  1455. }
  1456. GDScriptParser::DataType prev_datatype = p_function->get_datatype();
  1457. GDScriptParser::DataType resolving_datatype;
  1458. resolving_datatype.kind = GDScriptParser::DataType::RESOLVING;
  1459. p_function->set_datatype(resolving_datatype);
  1460. #ifdef TOOLS_ENABLED
  1461. int default_value_count = 0;
  1462. #endif // TOOLS_ENABLED
  1463. #ifdef DEBUG_ENABLED
  1464. String function_visible_name = function_name;
  1465. if (function_name == StringName()) {
  1466. function_visible_name = p_is_lambda ? "<anonymous lambda>" : "<unknown function>";
  1467. }
  1468. #endif
  1469. for (int i = 0; i < p_function->parameters.size(); i++) {
  1470. resolve_parameter(p_function->parameters[i]);
  1471. #ifdef DEBUG_ENABLED
  1472. if (p_function->parameters[i]->usages == 0 && !String(p_function->parameters[i]->identifier->name).begins_with("_")) {
  1473. parser->push_warning(p_function->parameters[i]->identifier, GDScriptWarning::UNUSED_PARAMETER, function_visible_name, p_function->parameters[i]->identifier->name);
  1474. }
  1475. is_shadowing(p_function->parameters[i]->identifier, "function parameter", true);
  1476. #endif // DEBUG_ENABLED
  1477. if (p_function->parameters[i]->initializer) {
  1478. #ifdef TOOLS_ENABLED
  1479. default_value_count++;
  1480. #endif // TOOLS_ENABLED
  1481. if (p_function->parameters[i]->initializer->is_constant) {
  1482. p_function->default_arg_values.push_back(p_function->parameters[i]->initializer->reduced_value);
  1483. } else {
  1484. p_function->default_arg_values.push_back(Variant()); // Prevent shift.
  1485. }
  1486. }
  1487. }
  1488. if (!p_is_lambda && function_name == GDScriptLanguage::get_singleton()->strings._init) {
  1489. // Constructor.
  1490. GDScriptParser::DataType return_type = parser->current_class->get_datatype();
  1491. return_type.is_meta_type = false;
  1492. p_function->set_datatype(return_type);
  1493. if (p_function->return_type) {
  1494. GDScriptParser::DataType declared_return = resolve_datatype(p_function->return_type);
  1495. if (declared_return.kind != GDScriptParser::DataType::BUILTIN || declared_return.builtin_type != Variant::NIL) {
  1496. push_error("Constructor cannot have an explicit return type.", p_function->return_type);
  1497. }
  1498. }
  1499. } else if (!p_is_lambda && function_name == GDScriptLanguage::get_singleton()->strings._static_init) {
  1500. // Static constructor.
  1501. GDScriptParser::DataType return_type;
  1502. return_type.kind = GDScriptParser::DataType::BUILTIN;
  1503. return_type.builtin_type = Variant::NIL;
  1504. p_function->set_datatype(return_type);
  1505. if (p_function->return_type) {
  1506. GDScriptParser::DataType declared_return = resolve_datatype(p_function->return_type);
  1507. if (declared_return.kind != GDScriptParser::DataType::BUILTIN || declared_return.builtin_type != Variant::NIL) {
  1508. push_error("Static constructor cannot have an explicit return type.", p_function->return_type);
  1509. }
  1510. }
  1511. } else {
  1512. if (p_function->return_type != nullptr) {
  1513. p_function->set_datatype(type_from_metatype(resolve_datatype(p_function->return_type)));
  1514. } else {
  1515. // In case the function is not typed, we can safely assume it's a Variant, so it's okay to mark as "inferred" here.
  1516. // It's not "undetected" to not mix up with unknown functions.
  1517. GDScriptParser::DataType return_type;
  1518. return_type.type_source = GDScriptParser::DataType::INFERRED;
  1519. return_type.kind = GDScriptParser::DataType::VARIANT;
  1520. p_function->set_datatype(return_type);
  1521. }
  1522. #ifdef TOOLS_ENABLED
  1523. // Check if the function signature matches the parent. If not it's an error since it breaks polymorphism.
  1524. // Not for the constructor which can vary in signature.
  1525. GDScriptParser::DataType base_type = parser->current_class->base_type;
  1526. base_type.is_meta_type = false;
  1527. GDScriptParser::DataType parent_return_type;
  1528. List<GDScriptParser::DataType> parameters_types;
  1529. int default_par_count = 0;
  1530. BitField<MethodFlags> method_flags;
  1531. StringName native_base;
  1532. if (!p_is_lambda && get_function_signature(p_function, false, base_type, function_name, parent_return_type, parameters_types, default_par_count, method_flags, &native_base)) {
  1533. bool valid = p_function->is_static == method_flags.has_flag(METHOD_FLAG_STATIC);
  1534. if (p_function->return_type != nullptr) {
  1535. // Check return type covariance.
  1536. GDScriptParser::DataType return_type = p_function->get_datatype();
  1537. if (return_type.is_variant()) {
  1538. // `is_type_compatible()` returns `true` if one of the types is `Variant`.
  1539. // Don't allow an explicitly specified `Variant` if the parent return type is narrower.
  1540. valid = valid && parent_return_type.is_variant();
  1541. } else if (return_type.kind == GDScriptParser::DataType::BUILTIN && return_type.builtin_type == Variant::NIL) {
  1542. // `is_type_compatible()` returns `true` if target is an `Object` and source is `null`.
  1543. // Don't allow `void` if the parent return type is a hard non-`void` type.
  1544. if (parent_return_type.is_hard_type() && !(parent_return_type.kind == GDScriptParser::DataType::BUILTIN && parent_return_type.builtin_type == Variant::NIL)) {
  1545. valid = false;
  1546. }
  1547. } else {
  1548. valid = valid && is_type_compatible(parent_return_type, return_type);
  1549. }
  1550. }
  1551. int par_count_diff = p_function->parameters.size() - parameters_types.size();
  1552. valid = valid && par_count_diff >= 0;
  1553. valid = valid && default_value_count >= default_par_count + par_count_diff;
  1554. if (valid) {
  1555. int i = 0;
  1556. for (const GDScriptParser::DataType &parent_par_type : parameters_types) {
  1557. // Check parameter type contravariance.
  1558. GDScriptParser::DataType current_par_type = p_function->parameters[i++]->get_datatype();
  1559. if (parent_par_type.is_variant() && parent_par_type.is_hard_type()) {
  1560. // `is_type_compatible()` returns `true` if one of the types is `Variant`.
  1561. // Don't allow narrowing a hard `Variant`.
  1562. valid = valid && current_par_type.is_variant();
  1563. } else {
  1564. valid = valid && is_type_compatible(current_par_type, parent_par_type);
  1565. }
  1566. }
  1567. }
  1568. if (!valid) {
  1569. // Compute parent signature as a string to show in the error message.
  1570. String parent_signature = String(function_name) + "(";
  1571. int j = 0;
  1572. for (const GDScriptParser::DataType &par_type : parameters_types) {
  1573. if (j > 0) {
  1574. parent_signature += ", ";
  1575. }
  1576. String parameter = par_type.to_string();
  1577. if (parameter == "null") {
  1578. parameter = "Variant";
  1579. }
  1580. parent_signature += parameter;
  1581. if (j >= parameters_types.size() - default_par_count) {
  1582. parent_signature += " = <default>";
  1583. }
  1584. j++;
  1585. }
  1586. parent_signature += ") -> ";
  1587. const String return_type = parent_return_type.to_string_strict();
  1588. if (return_type == "null") {
  1589. parent_signature += "void";
  1590. } else {
  1591. parent_signature += return_type;
  1592. }
  1593. push_error(vformat(R"(The function signature doesn't match the parent. Parent signature is "%s".)", parent_signature), p_function);
  1594. }
  1595. #ifdef DEBUG_ENABLED
  1596. if (native_base != StringName()) {
  1597. parser->push_warning(p_function, GDScriptWarning::NATIVE_METHOD_OVERRIDE, function_name, native_base);
  1598. }
  1599. #endif
  1600. }
  1601. #endif // TOOLS_ENABLED
  1602. }
  1603. #ifdef DEBUG_ENABLED
  1604. if (p_function->return_type == nullptr) {
  1605. parser->push_warning(p_function, GDScriptWarning::UNTYPED_DECLARATION, "Function", function_visible_name);
  1606. }
  1607. #endif
  1608. if (p_function->get_datatype().is_resolving()) {
  1609. p_function->set_datatype(prev_datatype);
  1610. }
  1611. parser->current_function = previous_function;
  1612. static_context = previous_static_context;
  1613. }
  1614. void GDScriptAnalyzer::resolve_function_body(GDScriptParser::FunctionNode *p_function, bool p_is_lambda) {
  1615. if (p_function->resolved_body) {
  1616. return;
  1617. }
  1618. p_function->resolved_body = true;
  1619. GDScriptParser::FunctionNode *previous_function = parser->current_function;
  1620. parser->current_function = p_function;
  1621. bool previous_static_context = static_context;
  1622. static_context = p_function->is_static;
  1623. resolve_suite(p_function->body);
  1624. if (!p_function->get_datatype().is_hard_type() && p_function->body->get_datatype().is_set()) {
  1625. // Use the suite inferred type if return isn't explicitly set.
  1626. p_function->set_datatype(p_function->body->get_datatype());
  1627. } 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)) {
  1628. if (!p_function->body->has_return && (p_is_lambda || p_function->identifier->name != GDScriptLanguage::get_singleton()->strings._init)) {
  1629. push_error(R"(Not all code paths return a value.)", p_function);
  1630. }
  1631. }
  1632. parser->current_function = previous_function;
  1633. static_context = previous_static_context;
  1634. }
  1635. void GDScriptAnalyzer::decide_suite_type(GDScriptParser::Node *p_suite, GDScriptParser::Node *p_statement) {
  1636. if (p_statement == nullptr) {
  1637. return;
  1638. }
  1639. switch (p_statement->type) {
  1640. case GDScriptParser::Node::IF:
  1641. case GDScriptParser::Node::FOR:
  1642. case GDScriptParser::Node::MATCH:
  1643. case GDScriptParser::Node::PATTERN:
  1644. case GDScriptParser::Node::RETURN:
  1645. case GDScriptParser::Node::WHILE:
  1646. // Use return or nested suite type as this suite type.
  1647. if (p_suite->get_datatype().is_set() && (p_suite->get_datatype() != p_statement->get_datatype())) {
  1648. // Mixed types.
  1649. // TODO: This could use the common supertype instead.
  1650. p_suite->datatype.kind = GDScriptParser::DataType::VARIANT;
  1651. p_suite->datatype.type_source = GDScriptParser::DataType::UNDETECTED;
  1652. } else {
  1653. p_suite->set_datatype(p_statement->get_datatype());
  1654. p_suite->datatype.type_source = GDScriptParser::DataType::INFERRED;
  1655. }
  1656. break;
  1657. default:
  1658. break;
  1659. }
  1660. }
  1661. void GDScriptAnalyzer::resolve_suite(GDScriptParser::SuiteNode *p_suite) {
  1662. for (int i = 0; i < p_suite->statements.size(); i++) {
  1663. GDScriptParser::Node *stmt = p_suite->statements[i];
  1664. // Apply annotations.
  1665. for (GDScriptParser::AnnotationNode *&E : stmt->annotations) {
  1666. resolve_annotation(E);
  1667. E->apply(parser, stmt, nullptr); // TODO: Provide `p_class`.
  1668. }
  1669. resolve_node(stmt);
  1670. resolve_pending_lambda_bodies();
  1671. decide_suite_type(p_suite, stmt);
  1672. }
  1673. }
  1674. void GDScriptAnalyzer::resolve_assignable(GDScriptParser::AssignableNode *p_assignable, const char *p_kind) {
  1675. GDScriptParser::DataType type;
  1676. type.kind = GDScriptParser::DataType::VARIANT;
  1677. bool is_constant = p_assignable->type == GDScriptParser::Node::CONSTANT;
  1678. #ifdef DEBUG_ENABLED
  1679. if (p_assignable->identifier != nullptr && p_assignable->identifier->suite != nullptr && p_assignable->identifier->suite->parent_block != nullptr) {
  1680. if (p_assignable->identifier->suite->parent_block->has_local(p_assignable->identifier->name)) {
  1681. const GDScriptParser::SuiteNode::Local &local = p_assignable->identifier->suite->parent_block->get_local(p_assignable->identifier->name);
  1682. parser->push_warning(p_assignable->identifier, GDScriptWarning::CONFUSABLE_LOCAL_DECLARATION, local.get_name(), p_assignable->identifier->name);
  1683. }
  1684. }
  1685. #endif
  1686. GDScriptParser::DataType specified_type;
  1687. bool has_specified_type = p_assignable->datatype_specifier != nullptr;
  1688. if (has_specified_type) {
  1689. specified_type = type_from_metatype(resolve_datatype(p_assignable->datatype_specifier));
  1690. type = specified_type;
  1691. }
  1692. if (p_assignable->initializer != nullptr) {
  1693. reduce_expression(p_assignable->initializer);
  1694. if (p_assignable->initializer->type == GDScriptParser::Node::ARRAY) {
  1695. GDScriptParser::ArrayNode *array = static_cast<GDScriptParser::ArrayNode *>(p_assignable->initializer);
  1696. if (has_specified_type && specified_type.has_container_element_type(0)) {
  1697. update_array_literal_element_type(array, specified_type.get_container_element_type(0));
  1698. }
  1699. } else if (p_assignable->initializer->type == GDScriptParser::Node::DICTIONARY) {
  1700. GDScriptParser::DictionaryNode *dictionary = static_cast<GDScriptParser::DictionaryNode *>(p_assignable->initializer);
  1701. if (has_specified_type && specified_type.has_container_element_types()) {
  1702. update_dictionary_literal_element_type(dictionary, specified_type.get_container_element_type_or_variant(0), specified_type.get_container_element_type_or_variant(1));
  1703. }
  1704. }
  1705. if (is_constant && !p_assignable->initializer->is_constant) {
  1706. bool is_initializer_value_reduced = false;
  1707. Variant initializer_value = make_expression_reduced_value(p_assignable->initializer, is_initializer_value_reduced);
  1708. if (is_initializer_value_reduced) {
  1709. p_assignable->initializer->is_constant = true;
  1710. p_assignable->initializer->reduced_value = initializer_value;
  1711. } else {
  1712. push_error(vformat(R"(Assigned value for %s "%s" isn't a constant expression.)", p_kind, p_assignable->identifier->name), p_assignable->initializer);
  1713. }
  1714. }
  1715. if (has_specified_type && p_assignable->initializer->is_constant) {
  1716. update_const_expression_builtin_type(p_assignable->initializer, specified_type, "assign");
  1717. }
  1718. GDScriptParser::DataType initializer_type = p_assignable->initializer->get_datatype();
  1719. if (p_assignable->infer_datatype) {
  1720. if (!initializer_type.is_set() || initializer_type.has_no_type() || !initializer_type.is_hard_type()) {
  1721. 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);
  1722. } else if (initializer_type.kind == GDScriptParser::DataType::BUILTIN && initializer_type.builtin_type == Variant::NIL && !is_constant) {
  1723. 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);
  1724. }
  1725. #ifdef DEBUG_ENABLED
  1726. if (initializer_type.is_hard_type() && initializer_type.is_variant()) {
  1727. parser->push_warning(p_assignable, GDScriptWarning::INFERENCE_ON_VARIANT, p_kind);
  1728. }
  1729. #endif
  1730. } else {
  1731. if (!initializer_type.is_set()) {
  1732. push_error(vformat(R"(Could not resolve type for %s "%s".)", p_kind, p_assignable->identifier->name), p_assignable->initializer);
  1733. }
  1734. }
  1735. if (!has_specified_type) {
  1736. type = initializer_type;
  1737. if (!type.is_set() || (type.is_hard_type() && type.kind == GDScriptParser::DataType::BUILTIN && type.builtin_type == Variant::NIL && !is_constant)) {
  1738. type.kind = GDScriptParser::DataType::VARIANT;
  1739. }
  1740. if (p_assignable->infer_datatype || is_constant) {
  1741. type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1742. } else {
  1743. type.type_source = GDScriptParser::DataType::INFERRED;
  1744. }
  1745. } else if (!specified_type.is_variant()) {
  1746. if (initializer_type.is_variant() || !initializer_type.is_hard_type()) {
  1747. mark_node_unsafe(p_assignable->initializer);
  1748. p_assignable->use_conversion_assign = true;
  1749. if (!initializer_type.is_variant() && !is_type_compatible(specified_type, initializer_type, true, p_assignable->initializer)) {
  1750. downgrade_node_type_source(p_assignable->initializer);
  1751. }
  1752. } else if (!is_type_compatible(specified_type, initializer_type, true, p_assignable->initializer)) {
  1753. if (!is_constant && is_type_compatible(initializer_type, specified_type)) {
  1754. mark_node_unsafe(p_assignable->initializer);
  1755. p_assignable->use_conversion_assign = true;
  1756. } else {
  1757. 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);
  1758. }
  1759. } else if ((specified_type.has_container_element_type(0) && !initializer_type.has_container_element_type(0)) || (specified_type.has_container_element_type(1) && !initializer_type.has_container_element_type(1))) {
  1760. mark_node_unsafe(p_assignable->initializer);
  1761. #ifdef DEBUG_ENABLED
  1762. } else if (specified_type.builtin_type == Variant::INT && initializer_type.builtin_type == Variant::FLOAT) {
  1763. parser->push_warning(p_assignable->initializer, GDScriptWarning::NARROWING_CONVERSION);
  1764. #endif
  1765. }
  1766. }
  1767. }
  1768. #ifdef DEBUG_ENABLED
  1769. const bool is_parameter = p_assignable->type == GDScriptParser::Node::PARAMETER;
  1770. if (!has_specified_type) {
  1771. const String declaration_type = is_constant ? "Constant" : (is_parameter ? "Parameter" : "Variable");
  1772. if (p_assignable->infer_datatype || is_constant) {
  1773. // Do not produce the `INFERRED_DECLARATION` warning on type import because there is no way to specify the true type.
  1774. // And removing the metatype makes it impossible to use the constant as a type hint (especially for enums).
  1775. const bool is_type_import = is_constant && p_assignable->initializer != nullptr && p_assignable->initializer->datatype.is_meta_type;
  1776. if (!is_type_import) {
  1777. parser->push_warning(p_assignable, GDScriptWarning::INFERRED_DECLARATION, declaration_type, p_assignable->identifier->name);
  1778. }
  1779. } else {
  1780. parser->push_warning(p_assignable, GDScriptWarning::UNTYPED_DECLARATION, declaration_type, p_assignable->identifier->name);
  1781. }
  1782. } else if (!is_parameter && specified_type.kind == GDScriptParser::DataType::ENUM && p_assignable->initializer == nullptr) {
  1783. // Warn about enum variables without default value. Unless the enum defines the "0" value, then it's fine.
  1784. bool has_zero_value = false;
  1785. for (const KeyValue<StringName, int64_t> &kv : specified_type.enum_values) {
  1786. if (kv.value == 0) {
  1787. has_zero_value = true;
  1788. break;
  1789. }
  1790. }
  1791. if (!has_zero_value) {
  1792. parser->push_warning(p_assignable, GDScriptWarning::ENUM_VARIABLE_WITHOUT_DEFAULT, p_assignable->identifier->name);
  1793. }
  1794. }
  1795. #endif
  1796. type.is_constant = is_constant;
  1797. type.is_read_only = false;
  1798. p_assignable->set_datatype(type);
  1799. }
  1800. void GDScriptAnalyzer::resolve_variable(GDScriptParser::VariableNode *p_variable, bool p_is_local) {
  1801. static constexpr const char *kind = "variable";
  1802. resolve_assignable(p_variable, kind);
  1803. #ifdef DEBUG_ENABLED
  1804. if (p_is_local) {
  1805. if (p_variable->usages == 0 && !String(p_variable->identifier->name).begins_with("_")) {
  1806. parser->push_warning(p_variable, GDScriptWarning::UNUSED_VARIABLE, p_variable->identifier->name);
  1807. }
  1808. }
  1809. is_shadowing(p_variable->identifier, kind, p_is_local);
  1810. #endif
  1811. }
  1812. void GDScriptAnalyzer::resolve_constant(GDScriptParser::ConstantNode *p_constant, bool p_is_local) {
  1813. static constexpr const char *kind = "constant";
  1814. resolve_assignable(p_constant, kind);
  1815. #ifdef DEBUG_ENABLED
  1816. if (p_is_local) {
  1817. if (p_constant->usages == 0 && !String(p_constant->identifier->name).begins_with("_")) {
  1818. parser->push_warning(p_constant, GDScriptWarning::UNUSED_LOCAL_CONSTANT, p_constant->identifier->name);
  1819. }
  1820. }
  1821. is_shadowing(p_constant->identifier, kind, p_is_local);
  1822. #endif
  1823. }
  1824. void GDScriptAnalyzer::resolve_parameter(GDScriptParser::ParameterNode *p_parameter) {
  1825. static constexpr const char *kind = "parameter";
  1826. resolve_assignable(p_parameter, kind);
  1827. }
  1828. void GDScriptAnalyzer::resolve_if(GDScriptParser::IfNode *p_if) {
  1829. reduce_expression(p_if->condition);
  1830. resolve_suite(p_if->true_block);
  1831. p_if->set_datatype(p_if->true_block->get_datatype());
  1832. if (p_if->false_block != nullptr) {
  1833. resolve_suite(p_if->false_block);
  1834. decide_suite_type(p_if, p_if->false_block);
  1835. }
  1836. }
  1837. void GDScriptAnalyzer::resolve_for(GDScriptParser::ForNode *p_for) {
  1838. bool list_resolved = false;
  1839. // Optimize constant range() call to not allocate an array.
  1840. // Use int, Vector2i, Vector3i instead, which also can be used as range iterators.
  1841. if (p_for->list && p_for->list->type == GDScriptParser::Node::CALL) {
  1842. GDScriptParser::CallNode *call = static_cast<GDScriptParser::CallNode *>(p_for->list);
  1843. GDScriptParser::Node::Type callee_type = call->get_callee_type();
  1844. if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  1845. GDScriptParser::IdentifierNode *callee = static_cast<GDScriptParser::IdentifierNode *>(call->callee);
  1846. if (callee->name == "range") {
  1847. list_resolved = true;
  1848. if (call->arguments.size() < 1) {
  1849. push_error(R"*(Invalid call for "range()" function. Expected at least 1 argument, none given.)*", call->callee);
  1850. } else if (call->arguments.size() > 3) {
  1851. push_error(vformat(R"*(Invalid call for "range()" function. Expected at most 3 arguments, %d given.)*", call->arguments.size()), call->callee);
  1852. } else {
  1853. // Now we can optimize it.
  1854. bool can_reduce = true;
  1855. Vector<Variant> args;
  1856. args.resize(call->arguments.size());
  1857. for (int i = 0; i < call->arguments.size(); i++) {
  1858. GDScriptParser::ExpressionNode *argument = call->arguments[i];
  1859. reduce_expression(argument);
  1860. if (argument->is_constant) {
  1861. if (argument->reduced_value.get_type() != Variant::INT && argument->reduced_value.get_type() != Variant::FLOAT) {
  1862. can_reduce = false;
  1863. 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);
  1864. }
  1865. if (can_reduce) {
  1866. args.write[i] = argument->reduced_value;
  1867. }
  1868. } else {
  1869. can_reduce = false;
  1870. GDScriptParser::DataType argument_type = argument->get_datatype();
  1871. if (argument_type.is_variant() || !argument_type.is_hard_type()) {
  1872. mark_node_unsafe(argument);
  1873. }
  1874. if (!argument_type.is_variant() && (argument_type.builtin_type != Variant::INT && argument_type.builtin_type != Variant::FLOAT)) {
  1875. if (!argument_type.is_hard_type()) {
  1876. downgrade_node_type_source(argument);
  1877. } else {
  1878. 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);
  1879. }
  1880. }
  1881. }
  1882. }
  1883. Variant reduced;
  1884. if (can_reduce) {
  1885. switch (args.size()) {
  1886. case 1:
  1887. reduced = (int32_t)args[0];
  1888. break;
  1889. case 2:
  1890. reduced = Vector2i(args[0], args[1]);
  1891. break;
  1892. case 3:
  1893. reduced = Vector3i(args[0], args[1], args[2]);
  1894. break;
  1895. }
  1896. p_for->list->is_constant = true;
  1897. p_for->list->reduced_value = reduced;
  1898. }
  1899. }
  1900. if (p_for->list->is_constant) {
  1901. p_for->list->set_datatype(type_from_variant(p_for->list->reduced_value, p_for->list));
  1902. } else {
  1903. GDScriptParser::DataType list_type;
  1904. list_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  1905. list_type.kind = GDScriptParser::DataType::BUILTIN;
  1906. list_type.builtin_type = Variant::ARRAY;
  1907. p_for->list->set_datatype(list_type);
  1908. }
  1909. }
  1910. }
  1911. }
  1912. GDScriptParser::DataType variable_type;
  1913. String list_visible_type = "<unresolved type>";
  1914. if (list_resolved) {
  1915. variable_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  1916. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1917. variable_type.builtin_type = Variant::INT;
  1918. list_visible_type = "Array[int]"; // NOTE: `range()` has `Array` return type.
  1919. } else if (p_for->list) {
  1920. resolve_node(p_for->list, false);
  1921. GDScriptParser::DataType list_type = p_for->list->get_datatype();
  1922. list_visible_type = list_type.to_string();
  1923. if (!list_type.is_hard_type()) {
  1924. mark_node_unsafe(p_for->list);
  1925. }
  1926. if (list_type.is_variant()) {
  1927. variable_type.kind = GDScriptParser::DataType::VARIANT;
  1928. mark_node_unsafe(p_for->list);
  1929. } else if (list_type.has_container_element_type(0)) {
  1930. variable_type = list_type.get_container_element_type(0);
  1931. variable_type.type_source = list_type.type_source;
  1932. } else if (list_type.is_typed_container_type()) {
  1933. variable_type = list_type.get_typed_container_type();
  1934. variable_type.type_source = list_type.type_source;
  1935. } else if (list_type.builtin_type == Variant::INT || list_type.builtin_type == Variant::FLOAT || list_type.builtin_type == Variant::STRING) {
  1936. variable_type.type_source = list_type.type_source;
  1937. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1938. variable_type.builtin_type = list_type.builtin_type;
  1939. } else if (list_type.builtin_type == Variant::VECTOR2I || list_type.builtin_type == Variant::VECTOR3I) {
  1940. variable_type.type_source = list_type.type_source;
  1941. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1942. variable_type.builtin_type = Variant::INT;
  1943. } else if (list_type.builtin_type == Variant::VECTOR2 || list_type.builtin_type == Variant::VECTOR3) {
  1944. variable_type.type_source = list_type.type_source;
  1945. variable_type.kind = GDScriptParser::DataType::BUILTIN;
  1946. variable_type.builtin_type = Variant::FLOAT;
  1947. } else if (list_type.builtin_type == Variant::OBJECT) {
  1948. GDScriptParser::DataType return_type;
  1949. List<GDScriptParser::DataType> par_types;
  1950. int default_arg_count = 0;
  1951. BitField<MethodFlags> method_flags;
  1952. if (get_function_signature(p_for->list, false, list_type, CoreStringName(_iter_get), return_type, par_types, default_arg_count, method_flags)) {
  1953. variable_type = return_type;
  1954. variable_type.type_source = list_type.type_source;
  1955. } else if (!list_type.is_hard_type()) {
  1956. variable_type.kind = GDScriptParser::DataType::VARIANT;
  1957. } else {
  1958. push_error(vformat(R"(Unable to iterate on object of type "%s".)", list_type.to_string()), p_for->list);
  1959. }
  1960. } else if (list_type.builtin_type == Variant::ARRAY || list_type.builtin_type == Variant::DICTIONARY || !list_type.is_hard_type()) {
  1961. variable_type.kind = GDScriptParser::DataType::VARIANT;
  1962. } else {
  1963. push_error(vformat(R"(Unable to iterate on value of type "%s".)", list_type.to_string()), p_for->list);
  1964. }
  1965. }
  1966. if (p_for->variable) {
  1967. if (p_for->datatype_specifier) {
  1968. GDScriptParser::DataType specified_type = type_from_metatype(resolve_datatype(p_for->datatype_specifier));
  1969. if (!specified_type.is_variant()) {
  1970. if (variable_type.is_variant() || !variable_type.is_hard_type()) {
  1971. mark_node_unsafe(p_for->variable);
  1972. p_for->use_conversion_assign = true;
  1973. } else if (!is_type_compatible(specified_type, variable_type, true, p_for->variable)) {
  1974. if (is_type_compatible(variable_type, specified_type)) {
  1975. mark_node_unsafe(p_for->variable);
  1976. p_for->use_conversion_assign = true;
  1977. } else {
  1978. push_error(vformat(R"(Unable to iterate on value of type "%s" with variable of type "%s".)", list_visible_type, specified_type.to_string()), p_for->datatype_specifier);
  1979. }
  1980. } else if (!is_type_compatible(specified_type, variable_type)) {
  1981. p_for->use_conversion_assign = true;
  1982. }
  1983. if (p_for->list) {
  1984. if (p_for->list->type == GDScriptParser::Node::ARRAY) {
  1985. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_for->list), specified_type);
  1986. } else if (p_for->list->type == GDScriptParser::Node::DICTIONARY) {
  1987. update_dictionary_literal_element_type(static_cast<GDScriptParser::DictionaryNode *>(p_for->list), specified_type, GDScriptParser::DataType::get_variant_type());
  1988. }
  1989. }
  1990. }
  1991. p_for->variable->set_datatype(specified_type);
  1992. } else {
  1993. p_for->variable->set_datatype(variable_type);
  1994. #ifdef DEBUG_ENABLED
  1995. if (variable_type.is_hard_type()) {
  1996. parser->push_warning(p_for->variable, GDScriptWarning::INFERRED_DECLARATION, R"("for" iterator variable)", p_for->variable->name);
  1997. } else {
  1998. parser->push_warning(p_for->variable, GDScriptWarning::UNTYPED_DECLARATION, R"("for" iterator variable)", p_for->variable->name);
  1999. }
  2000. #endif
  2001. }
  2002. }
  2003. resolve_suite(p_for->loop);
  2004. p_for->set_datatype(p_for->loop->get_datatype());
  2005. #ifdef DEBUG_ENABLED
  2006. if (p_for->variable) {
  2007. is_shadowing(p_for->variable, R"("for" iterator variable)", true);
  2008. }
  2009. #endif
  2010. }
  2011. void GDScriptAnalyzer::resolve_while(GDScriptParser::WhileNode *p_while) {
  2012. resolve_node(p_while->condition, false);
  2013. resolve_suite(p_while->loop);
  2014. p_while->set_datatype(p_while->loop->get_datatype());
  2015. }
  2016. void GDScriptAnalyzer::resolve_assert(GDScriptParser::AssertNode *p_assert) {
  2017. reduce_expression(p_assert->condition);
  2018. if (p_assert->message != nullptr) {
  2019. reduce_expression(p_assert->message);
  2020. 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)) {
  2021. push_error(R"(Expected string for assert error message.)", p_assert->message);
  2022. }
  2023. }
  2024. p_assert->set_datatype(p_assert->condition->get_datatype());
  2025. #ifdef DEBUG_ENABLED
  2026. if (p_assert->condition->is_constant) {
  2027. if (p_assert->condition->reduced_value.booleanize()) {
  2028. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_TRUE);
  2029. } else if (!(p_assert->condition->type == GDScriptParser::Node::LITERAL && static_cast<GDScriptParser::LiteralNode *>(p_assert->condition)->value.get_type() == Variant::BOOL)) {
  2030. parser->push_warning(p_assert->condition, GDScriptWarning::ASSERT_ALWAYS_FALSE);
  2031. }
  2032. }
  2033. #endif
  2034. }
  2035. void GDScriptAnalyzer::resolve_match(GDScriptParser::MatchNode *p_match) {
  2036. reduce_expression(p_match->test);
  2037. for (int i = 0; i < p_match->branches.size(); i++) {
  2038. resolve_match_branch(p_match->branches[i], p_match->test);
  2039. decide_suite_type(p_match, p_match->branches[i]);
  2040. }
  2041. }
  2042. void GDScriptAnalyzer::resolve_match_branch(GDScriptParser::MatchBranchNode *p_match_branch, GDScriptParser::ExpressionNode *p_match_test) {
  2043. // Apply annotations.
  2044. for (GDScriptParser::AnnotationNode *&E : p_match_branch->annotations) {
  2045. resolve_annotation(E);
  2046. E->apply(parser, p_match_branch, nullptr); // TODO: Provide `p_class`.
  2047. }
  2048. for (int i = 0; i < p_match_branch->patterns.size(); i++) {
  2049. resolve_match_pattern(p_match_branch->patterns[i], p_match_test);
  2050. }
  2051. if (p_match_branch->guard_body) {
  2052. resolve_suite(p_match_branch->guard_body);
  2053. }
  2054. resolve_suite(p_match_branch->block);
  2055. decide_suite_type(p_match_branch, p_match_branch->block);
  2056. }
  2057. void GDScriptAnalyzer::resolve_match_pattern(GDScriptParser::PatternNode *p_match_pattern, GDScriptParser::ExpressionNode *p_match_test) {
  2058. if (p_match_pattern == nullptr) {
  2059. return;
  2060. }
  2061. GDScriptParser::DataType result;
  2062. switch (p_match_pattern->pattern_type) {
  2063. case GDScriptParser::PatternNode::PT_LITERAL:
  2064. if (p_match_pattern->literal) {
  2065. reduce_literal(p_match_pattern->literal);
  2066. result = p_match_pattern->literal->get_datatype();
  2067. }
  2068. break;
  2069. case GDScriptParser::PatternNode::PT_EXPRESSION:
  2070. if (p_match_pattern->expression) {
  2071. GDScriptParser::ExpressionNode *expr = p_match_pattern->expression;
  2072. reduce_expression(expr);
  2073. result = expr->get_datatype();
  2074. if (!expr->is_constant) {
  2075. while (expr && expr->type == GDScriptParser::Node::SUBSCRIPT) {
  2076. GDScriptParser::SubscriptNode *sub = static_cast<GDScriptParser::SubscriptNode *>(expr);
  2077. if (!sub->is_attribute) {
  2078. expr = nullptr;
  2079. } else {
  2080. expr = sub->base;
  2081. }
  2082. }
  2083. if (!expr || expr->type != GDScriptParser::Node::IDENTIFIER) {
  2084. push_error(R"(Expression in match pattern must be a constant expression, an identifier, or an attribute access ("A.B").)", expr);
  2085. }
  2086. }
  2087. }
  2088. break;
  2089. case GDScriptParser::PatternNode::PT_BIND:
  2090. if (p_match_test != nullptr) {
  2091. result = p_match_test->get_datatype();
  2092. } else {
  2093. result.kind = GDScriptParser::DataType::VARIANT;
  2094. }
  2095. p_match_pattern->bind->set_datatype(result);
  2096. #ifdef DEBUG_ENABLED
  2097. is_shadowing(p_match_pattern->bind, "pattern bind", true);
  2098. if (p_match_pattern->bind->usages == 0 && !String(p_match_pattern->bind->name).begins_with("_")) {
  2099. parser->push_warning(p_match_pattern->bind, GDScriptWarning::UNUSED_VARIABLE, p_match_pattern->bind->name);
  2100. }
  2101. #endif
  2102. break;
  2103. case GDScriptParser::PatternNode::PT_ARRAY:
  2104. for (int i = 0; i < p_match_pattern->array.size(); i++) {
  2105. resolve_match_pattern(p_match_pattern->array[i], nullptr);
  2106. decide_suite_type(p_match_pattern, p_match_pattern->array[i]);
  2107. }
  2108. result = p_match_pattern->get_datatype();
  2109. break;
  2110. case GDScriptParser::PatternNode::PT_DICTIONARY:
  2111. for (int i = 0; i < p_match_pattern->dictionary.size(); i++) {
  2112. if (p_match_pattern->dictionary[i].key) {
  2113. reduce_expression(p_match_pattern->dictionary[i].key);
  2114. if (!p_match_pattern->dictionary[i].key->is_constant) {
  2115. push_error(R"(Expression in dictionary pattern key must be a constant.)", p_match_pattern->dictionary[i].key);
  2116. }
  2117. }
  2118. if (p_match_pattern->dictionary[i].value_pattern) {
  2119. resolve_match_pattern(p_match_pattern->dictionary[i].value_pattern, nullptr);
  2120. decide_suite_type(p_match_pattern, p_match_pattern->dictionary[i].value_pattern);
  2121. }
  2122. }
  2123. result = p_match_pattern->get_datatype();
  2124. break;
  2125. case GDScriptParser::PatternNode::PT_WILDCARD:
  2126. case GDScriptParser::PatternNode::PT_REST:
  2127. result.kind = GDScriptParser::DataType::VARIANT;
  2128. break;
  2129. }
  2130. p_match_pattern->set_datatype(result);
  2131. }
  2132. void GDScriptAnalyzer::resolve_return(GDScriptParser::ReturnNode *p_return) {
  2133. GDScriptParser::DataType result;
  2134. GDScriptParser::DataType expected_type;
  2135. bool has_expected_type = parser->current_function != nullptr;
  2136. if (has_expected_type) {
  2137. expected_type = parser->current_function->get_datatype();
  2138. }
  2139. if (p_return->return_value != nullptr) {
  2140. bool is_void_function = has_expected_type && expected_type.is_hard_type() && expected_type.kind == GDScriptParser::DataType::BUILTIN && expected_type.builtin_type == Variant::NIL;
  2141. bool is_call = p_return->return_value->type == GDScriptParser::Node::CALL;
  2142. if (is_void_function && is_call) {
  2143. // Pretend the call is a root expression to allow those that are "void".
  2144. reduce_call(static_cast<GDScriptParser::CallNode *>(p_return->return_value), false, true);
  2145. } else {
  2146. reduce_expression(p_return->return_value);
  2147. }
  2148. if (is_void_function) {
  2149. p_return->void_return = true;
  2150. const GDScriptParser::DataType &return_type = p_return->return_value->datatype;
  2151. if (is_call && !return_type.is_hard_type()) {
  2152. String function_name = parser->current_function->identifier ? parser->current_function->identifier->name.operator String() : String("<anonymous function>");
  2153. String called_function_name = static_cast<GDScriptParser::CallNode *>(p_return->return_value)->function_name.operator String();
  2154. #ifdef DEBUG_ENABLED
  2155. parser->push_warning(p_return, GDScriptWarning::UNSAFE_VOID_RETURN, function_name, called_function_name);
  2156. #endif
  2157. mark_node_unsafe(p_return);
  2158. } else if (!is_call) {
  2159. push_error("A void function cannot return a value.", p_return);
  2160. }
  2161. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2162. result.kind = GDScriptParser::DataType::BUILTIN;
  2163. result.builtin_type = Variant::NIL;
  2164. result.is_constant = true;
  2165. } else {
  2166. if (p_return->return_value->type == GDScriptParser::Node::ARRAY && has_expected_type && expected_type.has_container_element_type(0)) {
  2167. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_return->return_value), expected_type.get_container_element_type(0));
  2168. } else if (p_return->return_value->type == GDScriptParser::Node::DICTIONARY && has_expected_type && expected_type.has_container_element_types()) {
  2169. update_dictionary_literal_element_type(static_cast<GDScriptParser::DictionaryNode *>(p_return->return_value),
  2170. expected_type.get_container_element_type_or_variant(0), expected_type.get_container_element_type_or_variant(1));
  2171. }
  2172. if (has_expected_type && expected_type.is_hard_type() && p_return->return_value->is_constant) {
  2173. update_const_expression_builtin_type(p_return->return_value, expected_type, "return");
  2174. }
  2175. result = p_return->return_value->get_datatype();
  2176. }
  2177. } else {
  2178. // Return type is null by default.
  2179. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2180. result.kind = GDScriptParser::DataType::BUILTIN;
  2181. result.builtin_type = Variant::NIL;
  2182. result.is_constant = true;
  2183. }
  2184. if (has_expected_type && !expected_type.is_variant()) {
  2185. if (result.is_variant() || !result.is_hard_type()) {
  2186. mark_node_unsafe(p_return);
  2187. if (!is_type_compatible(expected_type, result, true, p_return)) {
  2188. downgrade_node_type_source(p_return);
  2189. }
  2190. } else if (!is_type_compatible(expected_type, result, true, p_return)) {
  2191. mark_node_unsafe(p_return);
  2192. if (!is_type_compatible(result, expected_type)) {
  2193. 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);
  2194. }
  2195. #ifdef DEBUG_ENABLED
  2196. } else if (expected_type.builtin_type == Variant::INT && result.builtin_type == Variant::FLOAT) {
  2197. parser->push_warning(p_return, GDScriptWarning::NARROWING_CONVERSION);
  2198. #endif
  2199. }
  2200. }
  2201. p_return->set_datatype(result);
  2202. }
  2203. void GDScriptAnalyzer::reduce_expression(GDScriptParser::ExpressionNode *p_expression, bool p_is_root) {
  2204. // This one makes some magic happen.
  2205. if (p_expression == nullptr) {
  2206. return;
  2207. }
  2208. if (p_expression->reduced) {
  2209. // Don't do this more than once.
  2210. return;
  2211. }
  2212. p_expression->reduced = true;
  2213. switch (p_expression->type) {
  2214. case GDScriptParser::Node::ARRAY:
  2215. reduce_array(static_cast<GDScriptParser::ArrayNode *>(p_expression));
  2216. break;
  2217. case GDScriptParser::Node::ASSIGNMENT:
  2218. reduce_assignment(static_cast<GDScriptParser::AssignmentNode *>(p_expression));
  2219. break;
  2220. case GDScriptParser::Node::AWAIT:
  2221. reduce_await(static_cast<GDScriptParser::AwaitNode *>(p_expression));
  2222. break;
  2223. case GDScriptParser::Node::BINARY_OPERATOR:
  2224. reduce_binary_op(static_cast<GDScriptParser::BinaryOpNode *>(p_expression));
  2225. break;
  2226. case GDScriptParser::Node::CALL:
  2227. reduce_call(static_cast<GDScriptParser::CallNode *>(p_expression), false, p_is_root);
  2228. break;
  2229. case GDScriptParser::Node::CAST:
  2230. reduce_cast(static_cast<GDScriptParser::CastNode *>(p_expression));
  2231. break;
  2232. case GDScriptParser::Node::DICTIONARY:
  2233. reduce_dictionary(static_cast<GDScriptParser::DictionaryNode *>(p_expression));
  2234. break;
  2235. case GDScriptParser::Node::GET_NODE:
  2236. reduce_get_node(static_cast<GDScriptParser::GetNodeNode *>(p_expression));
  2237. break;
  2238. case GDScriptParser::Node::IDENTIFIER:
  2239. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_expression));
  2240. break;
  2241. case GDScriptParser::Node::LAMBDA:
  2242. reduce_lambda(static_cast<GDScriptParser::LambdaNode *>(p_expression));
  2243. break;
  2244. case GDScriptParser::Node::LITERAL:
  2245. reduce_literal(static_cast<GDScriptParser::LiteralNode *>(p_expression));
  2246. break;
  2247. case GDScriptParser::Node::PRELOAD:
  2248. reduce_preload(static_cast<GDScriptParser::PreloadNode *>(p_expression));
  2249. break;
  2250. case GDScriptParser::Node::SELF:
  2251. reduce_self(static_cast<GDScriptParser::SelfNode *>(p_expression));
  2252. break;
  2253. case GDScriptParser::Node::SUBSCRIPT:
  2254. reduce_subscript(static_cast<GDScriptParser::SubscriptNode *>(p_expression));
  2255. break;
  2256. case GDScriptParser::Node::TERNARY_OPERATOR:
  2257. reduce_ternary_op(static_cast<GDScriptParser::TernaryOpNode *>(p_expression), p_is_root);
  2258. break;
  2259. case GDScriptParser::Node::TYPE_TEST:
  2260. reduce_type_test(static_cast<GDScriptParser::TypeTestNode *>(p_expression));
  2261. break;
  2262. case GDScriptParser::Node::UNARY_OPERATOR:
  2263. reduce_unary_op(static_cast<GDScriptParser::UnaryOpNode *>(p_expression));
  2264. break;
  2265. // Non-expressions. Here only to make sure new nodes aren't forgotten.
  2266. case GDScriptParser::Node::NONE:
  2267. case GDScriptParser::Node::ANNOTATION:
  2268. case GDScriptParser::Node::ASSERT:
  2269. case GDScriptParser::Node::BREAK:
  2270. case GDScriptParser::Node::BREAKPOINT:
  2271. case GDScriptParser::Node::CLASS:
  2272. case GDScriptParser::Node::CONSTANT:
  2273. case GDScriptParser::Node::CONTINUE:
  2274. case GDScriptParser::Node::ENUM:
  2275. case GDScriptParser::Node::FOR:
  2276. case GDScriptParser::Node::FUNCTION:
  2277. case GDScriptParser::Node::IF:
  2278. case GDScriptParser::Node::MATCH:
  2279. case GDScriptParser::Node::MATCH_BRANCH:
  2280. case GDScriptParser::Node::PARAMETER:
  2281. case GDScriptParser::Node::PASS:
  2282. case GDScriptParser::Node::PATTERN:
  2283. case GDScriptParser::Node::RETURN:
  2284. case GDScriptParser::Node::SIGNAL:
  2285. case GDScriptParser::Node::SUITE:
  2286. case GDScriptParser::Node::TYPE:
  2287. case GDScriptParser::Node::VARIABLE:
  2288. case GDScriptParser::Node::WHILE:
  2289. ERR_FAIL_MSG("Reaching unreachable case");
  2290. }
  2291. if (p_expression->get_datatype().kind == GDScriptParser::DataType::UNRESOLVED) {
  2292. // Prevent `is_type_compatible()` errors for incomplete expressions.
  2293. // The error can still occur if `reduce_*()` is called directly.
  2294. GDScriptParser::DataType dummy;
  2295. dummy.kind = GDScriptParser::DataType::VARIANT;
  2296. p_expression->set_datatype(dummy);
  2297. }
  2298. }
  2299. void GDScriptAnalyzer::reduce_array(GDScriptParser::ArrayNode *p_array) {
  2300. for (int i = 0; i < p_array->elements.size(); i++) {
  2301. GDScriptParser::ExpressionNode *element = p_array->elements[i];
  2302. reduce_expression(element);
  2303. }
  2304. // It's array in any case.
  2305. GDScriptParser::DataType arr_type;
  2306. arr_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2307. arr_type.kind = GDScriptParser::DataType::BUILTIN;
  2308. arr_type.builtin_type = Variant::ARRAY;
  2309. arr_type.is_constant = true;
  2310. p_array->set_datatype(arr_type);
  2311. }
  2312. #ifdef DEBUG_ENABLED
  2313. static bool enum_has_value(const GDScriptParser::DataType p_type, int64_t p_value) {
  2314. for (const KeyValue<StringName, int64_t> &E : p_type.enum_values) {
  2315. if (E.value == p_value) {
  2316. return true;
  2317. }
  2318. }
  2319. return false;
  2320. }
  2321. #endif
  2322. void GDScriptAnalyzer::update_const_expression_builtin_type(GDScriptParser::ExpressionNode *p_expression, const GDScriptParser::DataType &p_type, const char *p_usage, bool p_is_cast) {
  2323. if (p_expression->get_datatype() == p_type) {
  2324. return;
  2325. }
  2326. if (p_type.kind != GDScriptParser::DataType::BUILTIN && p_type.kind != GDScriptParser::DataType::ENUM) {
  2327. return;
  2328. }
  2329. GDScriptParser::DataType expression_type = p_expression->get_datatype();
  2330. 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;
  2331. if (!is_enum_cast && !is_type_compatible(p_type, expression_type, true, p_expression)) {
  2332. 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);
  2333. return;
  2334. }
  2335. GDScriptParser::DataType value_type = type_from_variant(p_expression->reduced_value, p_expression);
  2336. if (expression_type.is_variant() && !is_enum_cast && !is_type_compatible(p_type, value_type, true, p_expression)) {
  2337. 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);
  2338. return;
  2339. }
  2340. #ifdef DEBUG_ENABLED
  2341. if (p_type.kind == GDScriptParser::DataType::ENUM && value_type.builtin_type == Variant::INT && !enum_has_value(p_type, p_expression->reduced_value)) {
  2342. parser->push_warning(p_expression, GDScriptWarning::INT_AS_ENUM_WITHOUT_MATCH, p_usage, p_expression->reduced_value.stringify(), p_type.to_string());
  2343. }
  2344. #endif
  2345. if (value_type.builtin_type == p_type.builtin_type) {
  2346. p_expression->set_datatype(p_type);
  2347. return;
  2348. }
  2349. Variant converted_to;
  2350. const Variant *converted_from = &p_expression->reduced_value;
  2351. Callable::CallError call_error;
  2352. Variant::construct(p_type.builtin_type, converted_to, &converted_from, 1, call_error);
  2353. if (call_error.error) {
  2354. push_error(vformat(R"(Failed to convert a value of type "%s" to "%s".)", value_type.to_string(), p_type.to_string()), p_expression);
  2355. return;
  2356. }
  2357. #ifdef DEBUG_ENABLED
  2358. if (p_type.builtin_type == Variant::INT && value_type.builtin_type == Variant::FLOAT) {
  2359. parser->push_warning(p_expression, GDScriptWarning::NARROWING_CONVERSION);
  2360. }
  2361. #endif
  2362. p_expression->reduced_value = converted_to;
  2363. p_expression->set_datatype(p_type);
  2364. }
  2365. // When an array literal is stored (or passed as function argument) to a typed context, we then assume the array is typed.
  2366. // This function determines which type is that (if any).
  2367. void GDScriptAnalyzer::update_array_literal_element_type(GDScriptParser::ArrayNode *p_array, const GDScriptParser::DataType &p_element_type) {
  2368. GDScriptParser::DataType expected_type = p_element_type;
  2369. expected_type.container_element_types.clear(); // Nested types (like `Array[Array[int]]`) are not currently supported.
  2370. for (int i = 0; i < p_array->elements.size(); i++) {
  2371. GDScriptParser::ExpressionNode *element_node = p_array->elements[i];
  2372. if (element_node->is_constant) {
  2373. update_const_expression_builtin_type(element_node, expected_type, "include");
  2374. }
  2375. const GDScriptParser::DataType &actual_type = element_node->get_datatype();
  2376. if (actual_type.has_no_type() || actual_type.is_variant() || !actual_type.is_hard_type()) {
  2377. mark_node_unsafe(element_node);
  2378. continue;
  2379. }
  2380. if (!is_type_compatible(expected_type, actual_type, true, p_array)) {
  2381. if (is_type_compatible(actual_type, expected_type)) {
  2382. mark_node_unsafe(element_node);
  2383. continue;
  2384. }
  2385. push_error(vformat(R"(Cannot have an element of type "%s" in an array of type "Array[%s]".)", actual_type.to_string(), expected_type.to_string()), element_node);
  2386. return;
  2387. }
  2388. }
  2389. GDScriptParser::DataType array_type = p_array->get_datatype();
  2390. array_type.set_container_element_type(0, expected_type);
  2391. p_array->set_datatype(array_type);
  2392. }
  2393. // When a dictionary literal is stored (or passed as function argument) to a typed context, we then assume the dictionary is typed.
  2394. // This function determines which type is that (if any).
  2395. void GDScriptAnalyzer::update_dictionary_literal_element_type(GDScriptParser::DictionaryNode *p_dictionary, const GDScriptParser::DataType &p_key_element_type, const GDScriptParser::DataType &p_value_element_type) {
  2396. GDScriptParser::DataType expected_key_type = p_key_element_type;
  2397. GDScriptParser::DataType expected_value_type = p_value_element_type;
  2398. expected_key_type.container_element_types.clear(); // Nested types (like `Dictionary[String, Array[int]]`) are not currently supported.
  2399. expected_value_type.container_element_types.clear();
  2400. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  2401. GDScriptParser::ExpressionNode *key_element_node = p_dictionary->elements[i].key;
  2402. if (key_element_node->is_constant) {
  2403. update_const_expression_builtin_type(key_element_node, expected_key_type, "include");
  2404. }
  2405. const GDScriptParser::DataType &actual_key_type = key_element_node->get_datatype();
  2406. if (actual_key_type.has_no_type() || actual_key_type.is_variant() || !actual_key_type.is_hard_type()) {
  2407. mark_node_unsafe(key_element_node);
  2408. } else if (!is_type_compatible(expected_key_type, actual_key_type, true, p_dictionary)) {
  2409. if (is_type_compatible(actual_key_type, expected_key_type)) {
  2410. mark_node_unsafe(key_element_node);
  2411. } else {
  2412. push_error(vformat(R"(Cannot have a key of type "%s" in a dictionary of type "Dictionary[%s, %s]".)", actual_key_type.to_string(), expected_key_type.to_string(), expected_value_type.to_string()), key_element_node);
  2413. return;
  2414. }
  2415. }
  2416. GDScriptParser::ExpressionNode *value_element_node = p_dictionary->elements[i].value;
  2417. if (value_element_node->is_constant) {
  2418. update_const_expression_builtin_type(value_element_node, expected_value_type, "include");
  2419. }
  2420. const GDScriptParser::DataType &actual_value_type = value_element_node->get_datatype();
  2421. if (actual_value_type.has_no_type() || actual_value_type.is_variant() || !actual_value_type.is_hard_type()) {
  2422. mark_node_unsafe(value_element_node);
  2423. } else if (!is_type_compatible(expected_value_type, actual_value_type, true, p_dictionary)) {
  2424. if (is_type_compatible(actual_value_type, expected_value_type)) {
  2425. mark_node_unsafe(value_element_node);
  2426. } else {
  2427. push_error(vformat(R"(Cannot have a value of type "%s" in a dictionary of type "Dictionary[%s, %s]".)", actual_value_type.to_string(), expected_key_type.to_string(), expected_value_type.to_string()), value_element_node);
  2428. return;
  2429. }
  2430. }
  2431. }
  2432. GDScriptParser::DataType dictionary_type = p_dictionary->get_datatype();
  2433. dictionary_type.set_container_element_type(0, expected_key_type);
  2434. dictionary_type.set_container_element_type(1, expected_value_type);
  2435. p_dictionary->set_datatype(dictionary_type);
  2436. }
  2437. void GDScriptAnalyzer::reduce_assignment(GDScriptParser::AssignmentNode *p_assignment) {
  2438. reduce_expression(p_assignment->assigned_value);
  2439. #ifdef DEBUG_ENABLED
  2440. // Increment assignment count for local variables.
  2441. // Before we reduce the assignee because we don't want to warn about not being assigned when performing the assignment.
  2442. if (p_assignment->assignee->type == GDScriptParser::Node::IDENTIFIER) {
  2443. GDScriptParser::IdentifierNode *id = static_cast<GDScriptParser::IdentifierNode *>(p_assignment->assignee);
  2444. if (id->source == GDScriptParser::IdentifierNode::LOCAL_VARIABLE && id->variable_source) {
  2445. id->variable_source->assignments++;
  2446. }
  2447. }
  2448. #endif
  2449. reduce_expression(p_assignment->assignee);
  2450. #ifdef DEBUG_ENABLED
  2451. {
  2452. bool is_subscript = false;
  2453. GDScriptParser::ExpressionNode *base = p_assignment->assignee;
  2454. while (base && base->type == GDScriptParser::Node::SUBSCRIPT) {
  2455. is_subscript = true;
  2456. base = static_cast<GDScriptParser::SubscriptNode *>(base)->base;
  2457. }
  2458. if (base && base->type == GDScriptParser::Node::IDENTIFIER) {
  2459. GDScriptParser::IdentifierNode *id = static_cast<GDScriptParser::IdentifierNode *>(base);
  2460. if (current_lambda && current_lambda->captures_indices.has(id->name)) {
  2461. bool need_warn = false;
  2462. if (is_subscript) {
  2463. const GDScriptParser::DataType &id_type = id->datatype;
  2464. if (id_type.is_hard_type()) {
  2465. switch (id_type.kind) {
  2466. case GDScriptParser::DataType::BUILTIN:
  2467. // TODO: Change `Variant::is_type_shared()` to include packed arrays?
  2468. need_warn = !Variant::is_type_shared(id_type.builtin_type) && id_type.builtin_type < Variant::PACKED_BYTE_ARRAY;
  2469. break;
  2470. case GDScriptParser::DataType::ENUM:
  2471. need_warn = true;
  2472. break;
  2473. default:
  2474. break;
  2475. }
  2476. }
  2477. } else {
  2478. need_warn = true;
  2479. }
  2480. if (need_warn) {
  2481. parser->push_warning(p_assignment, GDScriptWarning::CONFUSABLE_CAPTURE_REASSIGNMENT, id->name);
  2482. }
  2483. }
  2484. }
  2485. }
  2486. #endif
  2487. if (p_assignment->assigned_value == nullptr || p_assignment->assignee == nullptr) {
  2488. return;
  2489. }
  2490. GDScriptParser::DataType assignee_type = p_assignment->assignee->get_datatype();
  2491. if (assignee_type.is_constant) {
  2492. push_error("Cannot assign a new value to a constant.", p_assignment->assignee);
  2493. return;
  2494. } else if (p_assignment->assignee->type == GDScriptParser::Node::SUBSCRIPT && static_cast<GDScriptParser::SubscriptNode *>(p_assignment->assignee)->base->is_constant) {
  2495. const GDScriptParser::DataType &base_type = static_cast<GDScriptParser::SubscriptNode *>(p_assignment->assignee)->base->datatype;
  2496. if (base_type.kind != GDScriptParser::DataType::SCRIPT && base_type.kind != GDScriptParser::DataType::CLASS) { // Static variables.
  2497. push_error("Cannot assign a new value to a constant.", p_assignment->assignee);
  2498. return;
  2499. }
  2500. } else if (assignee_type.is_read_only) {
  2501. push_error("Cannot assign a new value to a read-only property.", p_assignment->assignee);
  2502. return;
  2503. } else if (p_assignment->assignee->type == GDScriptParser::Node::SUBSCRIPT) {
  2504. GDScriptParser::SubscriptNode *sub = static_cast<GDScriptParser::SubscriptNode *>(p_assignment->assignee);
  2505. while (sub) {
  2506. const GDScriptParser::DataType &base_type = sub->base->datatype;
  2507. if (base_type.is_hard_type() && base_type.is_read_only) {
  2508. if (base_type.kind == GDScriptParser::DataType::BUILTIN && !Variant::is_type_shared(base_type.builtin_type)) {
  2509. push_error("Cannot assign a new value to a read-only property.", p_assignment->assignee);
  2510. return;
  2511. }
  2512. } else {
  2513. break;
  2514. }
  2515. if (sub->base->type == GDScriptParser::Node::SUBSCRIPT) {
  2516. sub = static_cast<GDScriptParser::SubscriptNode *>(sub->base);
  2517. } else {
  2518. sub = nullptr;
  2519. }
  2520. }
  2521. }
  2522. // Check if assigned value is an array/dictionary literal, so we can make it a typed container too if appropriate.
  2523. if (p_assignment->assigned_value->type == GDScriptParser::Node::ARRAY && assignee_type.is_hard_type() && assignee_type.has_container_element_type(0)) {
  2524. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_assignment->assigned_value), assignee_type.get_container_element_type(0));
  2525. } else if (p_assignment->assigned_value->type == GDScriptParser::Node::DICTIONARY && assignee_type.is_hard_type() && assignee_type.has_container_element_types()) {
  2526. update_dictionary_literal_element_type(static_cast<GDScriptParser::DictionaryNode *>(p_assignment->assigned_value),
  2527. assignee_type.get_container_element_type_or_variant(0), assignee_type.get_container_element_type_or_variant(1));
  2528. }
  2529. if (p_assignment->operation == GDScriptParser::AssignmentNode::OP_NONE && assignee_type.is_hard_type() && p_assignment->assigned_value->is_constant) {
  2530. update_const_expression_builtin_type(p_assignment->assigned_value, assignee_type, "assign");
  2531. }
  2532. GDScriptParser::DataType assigned_value_type = p_assignment->assigned_value->get_datatype();
  2533. bool assignee_is_variant = assignee_type.is_variant();
  2534. bool assignee_is_hard = assignee_type.is_hard_type();
  2535. bool assigned_is_variant = assigned_value_type.is_variant();
  2536. bool assigned_is_hard = assigned_value_type.is_hard_type();
  2537. bool compatible = true;
  2538. bool downgrades_assignee = false;
  2539. bool downgrades_assigned = false;
  2540. GDScriptParser::DataType op_type = assigned_value_type;
  2541. if (p_assignment->operation != GDScriptParser::AssignmentNode::OP_NONE && !op_type.is_variant()) {
  2542. op_type = get_operation_type(p_assignment->variant_op, assignee_type, assigned_value_type, compatible, p_assignment->assigned_value);
  2543. if (assignee_is_variant) {
  2544. // variant assignee
  2545. mark_node_unsafe(p_assignment);
  2546. } else if (!compatible) {
  2547. // incompatible hard types and non-variant assignee
  2548. mark_node_unsafe(p_assignment);
  2549. if (assigned_is_variant) {
  2550. // incompatible hard non-variant assignee and hard variant assigned
  2551. p_assignment->use_conversion_assign = true;
  2552. } else {
  2553. // incompatible hard non-variant types
  2554. push_error(vformat(R"(Invalid operands "%s" and "%s" for assignment operator.)", assignee_type.to_string(), assigned_value_type.to_string()), p_assignment);
  2555. }
  2556. } else if (op_type.type_source == GDScriptParser::DataType::UNDETECTED && !assigned_is_variant) {
  2557. // incompatible non-variant types (at least one weak)
  2558. downgrades_assignee = !assignee_is_hard;
  2559. downgrades_assigned = !assigned_is_hard;
  2560. }
  2561. }
  2562. p_assignment->set_datatype(op_type);
  2563. if (assignee_is_variant) {
  2564. if (!assignee_is_hard) {
  2565. // weak variant assignee
  2566. mark_node_unsafe(p_assignment);
  2567. }
  2568. } else {
  2569. if (assignee_is_hard && !assigned_is_hard) {
  2570. // hard non-variant assignee and weak assigned
  2571. mark_node_unsafe(p_assignment);
  2572. p_assignment->use_conversion_assign = true;
  2573. downgrades_assigned = downgrades_assigned || (!assigned_is_variant && !is_type_compatible(assignee_type, op_type, true, p_assignment->assigned_value));
  2574. } else if (compatible) {
  2575. if (op_type.is_variant()) {
  2576. // non-variant assignee and variant result
  2577. mark_node_unsafe(p_assignment);
  2578. if (assignee_is_hard) {
  2579. // hard non-variant assignee and variant result
  2580. p_assignment->use_conversion_assign = true;
  2581. } else {
  2582. // weak non-variant assignee and variant result
  2583. downgrades_assignee = true;
  2584. }
  2585. } else if (!is_type_compatible(assignee_type, op_type, assignee_is_hard, p_assignment->assigned_value)) {
  2586. // non-variant assignee and incompatible result
  2587. mark_node_unsafe(p_assignment);
  2588. if (assignee_is_hard) {
  2589. if (is_type_compatible(op_type, assignee_type)) {
  2590. // hard non-variant assignee and maybe compatible result
  2591. p_assignment->use_conversion_assign = true;
  2592. } else {
  2593. // hard non-variant assignee and incompatible result
  2594. 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);
  2595. }
  2596. } else {
  2597. // weak non-variant assignee and incompatible result
  2598. downgrades_assignee = true;
  2599. }
  2600. } else if ((assignee_type.has_container_element_type(0) && !op_type.has_container_element_type(0)) || (assignee_type.has_container_element_type(1) && !op_type.has_container_element_type(1))) {
  2601. // Typed assignee and untyped result.
  2602. mark_node_unsafe(p_assignment);
  2603. }
  2604. }
  2605. }
  2606. if (downgrades_assignee) {
  2607. downgrade_node_type_source(p_assignment->assignee);
  2608. }
  2609. if (downgrades_assigned) {
  2610. downgrade_node_type_source(p_assignment->assigned_value);
  2611. }
  2612. #ifdef DEBUG_ENABLED
  2613. if (assignee_type.is_hard_type() && assignee_type.builtin_type == Variant::INT && assigned_value_type.builtin_type == Variant::FLOAT) {
  2614. parser->push_warning(p_assignment->assigned_value, GDScriptWarning::NARROWING_CONVERSION);
  2615. }
  2616. // Check for assignment with operation before assignment.
  2617. if (p_assignment->operation != GDScriptParser::AssignmentNode::OP_NONE && p_assignment->assignee->type == GDScriptParser::Node::IDENTIFIER) {
  2618. GDScriptParser::IdentifierNode *id = static_cast<GDScriptParser::IdentifierNode *>(p_assignment->assignee);
  2619. // Use == 1 here because this assignment was already counted in the beginning of the function.
  2620. if (id->source == GDScriptParser::IdentifierNode::LOCAL_VARIABLE && id->variable_source && id->variable_source->assignments == 1) {
  2621. parser->push_warning(p_assignment, GDScriptWarning::UNASSIGNED_VARIABLE_OP_ASSIGN, id->name);
  2622. }
  2623. }
  2624. #endif
  2625. }
  2626. void GDScriptAnalyzer::reduce_await(GDScriptParser::AwaitNode *p_await) {
  2627. if (p_await->to_await == nullptr) {
  2628. GDScriptParser::DataType await_type;
  2629. await_type.kind = GDScriptParser::DataType::VARIANT;
  2630. p_await->set_datatype(await_type);
  2631. return;
  2632. }
  2633. if (p_await->to_await->type == GDScriptParser::Node::CALL) {
  2634. reduce_call(static_cast<GDScriptParser::CallNode *>(p_await->to_await), true);
  2635. } else {
  2636. reduce_expression(p_await->to_await);
  2637. }
  2638. GDScriptParser::DataType await_type = p_await->to_await->get_datatype();
  2639. // We cannot infer the type of the result of waiting for a signal.
  2640. if (await_type.is_hard_type() && await_type.kind == GDScriptParser::DataType::BUILTIN && await_type.builtin_type == Variant::SIGNAL) {
  2641. await_type.kind = GDScriptParser::DataType::VARIANT;
  2642. await_type.type_source = GDScriptParser::DataType::UNDETECTED;
  2643. } else if (p_await->to_await->is_constant) {
  2644. p_await->is_constant = p_await->to_await->is_constant;
  2645. p_await->reduced_value = p_await->to_await->reduced_value;
  2646. }
  2647. await_type.is_coroutine = false;
  2648. p_await->set_datatype(await_type);
  2649. #ifdef DEBUG_ENABLED
  2650. GDScriptParser::DataType to_await_type = p_await->to_await->get_datatype();
  2651. if (!to_await_type.is_coroutine && !to_await_type.is_variant() && to_await_type.builtin_type != Variant::SIGNAL) {
  2652. parser->push_warning(p_await, GDScriptWarning::REDUNDANT_AWAIT);
  2653. }
  2654. #endif
  2655. }
  2656. void GDScriptAnalyzer::reduce_binary_op(GDScriptParser::BinaryOpNode *p_binary_op) {
  2657. reduce_expression(p_binary_op->left_operand);
  2658. reduce_expression(p_binary_op->right_operand);
  2659. GDScriptParser::DataType left_type;
  2660. if (p_binary_op->left_operand) {
  2661. left_type = p_binary_op->left_operand->get_datatype();
  2662. }
  2663. GDScriptParser::DataType right_type;
  2664. if (p_binary_op->right_operand) {
  2665. right_type = p_binary_op->right_operand->get_datatype();
  2666. }
  2667. if (!left_type.is_set() || !right_type.is_set()) {
  2668. return;
  2669. }
  2670. #ifdef DEBUG_ENABLED
  2671. if (p_binary_op->variant_op == Variant::OP_DIVIDE && left_type.builtin_type == Variant::INT && right_type.builtin_type == Variant::INT) {
  2672. parser->push_warning(p_binary_op, GDScriptWarning::INTEGER_DIVISION);
  2673. }
  2674. #endif
  2675. if (p_binary_op->left_operand->is_constant && p_binary_op->right_operand->is_constant) {
  2676. p_binary_op->is_constant = true;
  2677. if (p_binary_op->variant_op < Variant::OP_MAX) {
  2678. bool valid = false;
  2679. 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);
  2680. if (!valid) {
  2681. if (p_binary_op->reduced_value.get_type() == Variant::STRING) {
  2682. 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);
  2683. } else {
  2684. push_error(vformat(R"(Invalid operands to operator %s, %s and %s.)",
  2685. Variant::get_operator_name(p_binary_op->variant_op),
  2686. Variant::get_type_name(p_binary_op->left_operand->reduced_value.get_type()),
  2687. Variant::get_type_name(p_binary_op->right_operand->reduced_value.get_type())),
  2688. p_binary_op);
  2689. }
  2690. }
  2691. } else {
  2692. ERR_PRINT("Parser bug: unknown binary operation.");
  2693. }
  2694. p_binary_op->set_datatype(type_from_variant(p_binary_op->reduced_value, p_binary_op));
  2695. return;
  2696. }
  2697. GDScriptParser::DataType result;
  2698. if ((p_binary_op->variant_op == Variant::OP_EQUAL || p_binary_op->variant_op == Variant::OP_NOT_EQUAL) &&
  2699. ((left_type.kind == GDScriptParser::DataType::BUILTIN && left_type.builtin_type == Variant::NIL) || (right_type.kind == GDScriptParser::DataType::BUILTIN && right_type.builtin_type == Variant::NIL))) {
  2700. // "==" and "!=" operators always return a boolean when comparing to null.
  2701. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2702. result.kind = GDScriptParser::DataType::BUILTIN;
  2703. result.builtin_type = Variant::BOOL;
  2704. } else if (p_binary_op->variant_op == Variant::OP_MODULE && left_type.builtin_type == Variant::STRING) {
  2705. // The modulo operator (%) on string acts as formatting and will always return a string.
  2706. result.type_source = left_type.type_source;
  2707. result.kind = GDScriptParser::DataType::BUILTIN;
  2708. result.builtin_type = Variant::STRING;
  2709. } else if (left_type.is_variant() || right_type.is_variant()) {
  2710. // Cannot infer type because one operand can be anything.
  2711. result.kind = GDScriptParser::DataType::VARIANT;
  2712. mark_node_unsafe(p_binary_op);
  2713. } else if (p_binary_op->variant_op < Variant::OP_MAX) {
  2714. bool valid = false;
  2715. result = get_operation_type(p_binary_op->variant_op, left_type, right_type, valid, p_binary_op);
  2716. if (!valid) {
  2717. 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);
  2718. } else if (!result.is_hard_type()) {
  2719. mark_node_unsafe(p_binary_op);
  2720. }
  2721. } else {
  2722. ERR_PRINT("Parser bug: unknown binary operation.");
  2723. }
  2724. p_binary_op->set_datatype(result);
  2725. }
  2726. #ifdef SUGGEST_GODOT4_RENAMES
  2727. const char *get_rename_from_map(const char *map[][2], String key) {
  2728. for (int index = 0; map[index][0]; index++) {
  2729. if (map[index][0] == key) {
  2730. return map[index][1];
  2731. }
  2732. }
  2733. return nullptr;
  2734. }
  2735. // Checks if an identifier/function name has been renamed in Godot 4, uses ProjectConverter3To4 for rename map.
  2736. // Returns the new name if found, nullptr otherwise.
  2737. const char *check_for_renamed_identifier(String identifier, GDScriptParser::Node::Type type) {
  2738. switch (type) {
  2739. case GDScriptParser::Node::IDENTIFIER: {
  2740. // Check properties
  2741. const char *result = get_rename_from_map(RenamesMap3To4::gdscript_properties_renames, identifier);
  2742. if (result) {
  2743. return result;
  2744. }
  2745. // Check enum values
  2746. result = get_rename_from_map(RenamesMap3To4::enum_renames, identifier);
  2747. if (result) {
  2748. return result;
  2749. }
  2750. // Check color constants
  2751. result = get_rename_from_map(RenamesMap3To4::color_renames, identifier);
  2752. if (result) {
  2753. return result;
  2754. }
  2755. // Check type names
  2756. result = get_rename_from_map(RenamesMap3To4::class_renames, identifier);
  2757. if (result) {
  2758. return result;
  2759. }
  2760. return get_rename_from_map(RenamesMap3To4::builtin_types_renames, identifier);
  2761. }
  2762. case GDScriptParser::Node::CALL: {
  2763. const char *result = get_rename_from_map(RenamesMap3To4::gdscript_function_renames, identifier);
  2764. if (result) {
  2765. return result;
  2766. }
  2767. // Built-in Types are mistaken for function calls when the built-in type is not found.
  2768. // Check built-in types if function rename not found
  2769. return get_rename_from_map(RenamesMap3To4::builtin_types_renames, identifier);
  2770. }
  2771. // Signal references don't get parsed through the GDScriptAnalyzer. No support for signal rename hints.
  2772. default:
  2773. // No rename found, return null
  2774. return nullptr;
  2775. }
  2776. }
  2777. #endif // SUGGEST_GODOT4_RENAMES
  2778. void GDScriptAnalyzer::reduce_call(GDScriptParser::CallNode *p_call, bool p_is_await, bool p_is_root) {
  2779. bool all_is_constant = true;
  2780. HashMap<int, GDScriptParser::ArrayNode *> arrays; // For array literal to potentially type when passing.
  2781. HashMap<int, GDScriptParser::DictionaryNode *> dictionaries; // Same, but for dictionaries.
  2782. for (int i = 0; i < p_call->arguments.size(); i++) {
  2783. reduce_expression(p_call->arguments[i]);
  2784. if (p_call->arguments[i]->type == GDScriptParser::Node::ARRAY) {
  2785. arrays[i] = static_cast<GDScriptParser::ArrayNode *>(p_call->arguments[i]);
  2786. } else if (p_call->arguments[i]->type == GDScriptParser::Node::DICTIONARY) {
  2787. dictionaries[i] = static_cast<GDScriptParser::DictionaryNode *>(p_call->arguments[i]);
  2788. }
  2789. all_is_constant = all_is_constant && p_call->arguments[i]->is_constant;
  2790. }
  2791. GDScriptParser::Node::Type callee_type = p_call->get_callee_type();
  2792. GDScriptParser::DataType call_type;
  2793. if (!p_call->is_super && callee_type == GDScriptParser::Node::IDENTIFIER) {
  2794. // Call to name directly.
  2795. StringName function_name = p_call->function_name;
  2796. if (function_name == SNAME("Object")) {
  2797. push_error(R"*(Invalid constructor "Object()", use "Object.new()" instead.)*", p_call);
  2798. p_call->set_datatype(call_type);
  2799. return;
  2800. }
  2801. Variant::Type builtin_type = GDScriptParser::get_builtin_type(function_name);
  2802. if (builtin_type < Variant::VARIANT_MAX) {
  2803. // Is a builtin constructor.
  2804. call_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  2805. call_type.kind = GDScriptParser::DataType::BUILTIN;
  2806. call_type.builtin_type = builtin_type;
  2807. bool safe_to_fold = true;
  2808. switch (builtin_type) {
  2809. // Those are stored by reference so not suited for compile-time construction.
  2810. // Because in this case they would be the same reference in all constructed values.
  2811. case Variant::OBJECT:
  2812. case Variant::DICTIONARY:
  2813. case Variant::ARRAY:
  2814. case Variant::PACKED_BYTE_ARRAY:
  2815. case Variant::PACKED_INT32_ARRAY:
  2816. case Variant::PACKED_INT64_ARRAY:
  2817. case Variant::PACKED_FLOAT32_ARRAY:
  2818. case Variant::PACKED_FLOAT64_ARRAY:
  2819. case Variant::PACKED_STRING_ARRAY:
  2820. case Variant::PACKED_VECTOR2_ARRAY:
  2821. case Variant::PACKED_VECTOR3_ARRAY:
  2822. case Variant::PACKED_COLOR_ARRAY:
  2823. case Variant::PACKED_VECTOR4_ARRAY:
  2824. safe_to_fold = false;
  2825. break;
  2826. default:
  2827. break;
  2828. }
  2829. if (all_is_constant && safe_to_fold) {
  2830. // Construct here.
  2831. Vector<const Variant *> args;
  2832. for (int i = 0; i < p_call->arguments.size(); i++) {
  2833. args.push_back(&(p_call->arguments[i]->reduced_value));
  2834. }
  2835. Callable::CallError err;
  2836. Variant value;
  2837. Variant::construct(builtin_type, value, (const Variant **)args.ptr(), args.size(), err);
  2838. switch (err.error) {
  2839. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT:
  2840. 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,
  2841. Variant::get_type_name(Variant::Type(err.expected)), p_call->arguments[err.argument]->get_datatype().to_string()),
  2842. p_call->arguments[err.argument]);
  2843. break;
  2844. case Callable::CallError::CALL_ERROR_INVALID_METHOD: {
  2845. String signature = Variant::get_type_name(builtin_type) + "(";
  2846. for (int i = 0; i < p_call->arguments.size(); i++) {
  2847. if (i > 0) {
  2848. signature += ", ";
  2849. }
  2850. signature += p_call->arguments[i]->get_datatype().to_string();
  2851. }
  2852. signature += ")";
  2853. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call->callee);
  2854. } break;
  2855. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  2856. 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);
  2857. break;
  2858. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  2859. 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);
  2860. break;
  2861. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  2862. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  2863. break; // Can't happen in a builtin constructor.
  2864. case Callable::CallError::CALL_OK:
  2865. p_call->is_constant = true;
  2866. p_call->reduced_value = value;
  2867. break;
  2868. }
  2869. } else {
  2870. // If there's one argument, try to use copy constructor (those aren't explicitly defined).
  2871. if (p_call->arguments.size() == 1) {
  2872. GDScriptParser::DataType arg_type = p_call->arguments[0]->get_datatype();
  2873. if (arg_type.is_hard_type() && !arg_type.is_variant()) {
  2874. if (arg_type.kind == GDScriptParser::DataType::BUILTIN && arg_type.builtin_type == builtin_type) {
  2875. // Okay.
  2876. p_call->set_datatype(call_type);
  2877. return;
  2878. }
  2879. } else {
  2880. #ifdef DEBUG_ENABLED
  2881. mark_node_unsafe(p_call);
  2882. // Constructors support overloads.
  2883. Vector<String> types;
  2884. for (int i = 0; i < Variant::VARIANT_MAX; i++) {
  2885. if (i != builtin_type && Variant::can_convert_strict((Variant::Type)i, builtin_type)) {
  2886. types.push_back(Variant::get_type_name((Variant::Type)i));
  2887. }
  2888. }
  2889. String expected_types = function_name;
  2890. if (types.size() == 1) {
  2891. expected_types += "\" or \"" + types[0];
  2892. } else if (types.size() >= 2) {
  2893. for (int i = 0; i < types.size() - 1; i++) {
  2894. expected_types += "\", \"" + types[i];
  2895. }
  2896. expected_types += "\", or \"" + types[types.size() - 1];
  2897. }
  2898. parser->push_warning(p_call->arguments[0], GDScriptWarning::UNSAFE_CALL_ARGUMENT, "1", "constructor", function_name, expected_types, "Variant");
  2899. #endif
  2900. p_call->set_datatype(call_type);
  2901. return;
  2902. }
  2903. }
  2904. List<MethodInfo> constructors;
  2905. Variant::get_constructor_list(builtin_type, &constructors);
  2906. bool match = false;
  2907. for (const MethodInfo &info : constructors) {
  2908. if (p_call->arguments.size() < info.arguments.size() - info.default_arguments.size()) {
  2909. continue;
  2910. }
  2911. if (p_call->arguments.size() > info.arguments.size()) {
  2912. continue;
  2913. }
  2914. bool types_match = true;
  2915. {
  2916. List<PropertyInfo>::ConstIterator arg_itr = info.arguments.begin();
  2917. for (int i = 0; i < p_call->arguments.size(); ++arg_itr, ++i) {
  2918. GDScriptParser::DataType par_type = type_from_property(*arg_itr, true);
  2919. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  2920. if (!is_type_compatible(par_type, arg_type, true)) {
  2921. types_match = false;
  2922. break;
  2923. #ifdef DEBUG_ENABLED
  2924. } else {
  2925. if (par_type.builtin_type == Variant::INT && arg_type.builtin_type == Variant::FLOAT && builtin_type != Variant::INT) {
  2926. parser->push_warning(p_call, GDScriptWarning::NARROWING_CONVERSION, function_name);
  2927. }
  2928. #endif
  2929. }
  2930. }
  2931. }
  2932. if (types_match) {
  2933. List<PropertyInfo>::ConstIterator arg_itr = info.arguments.begin();
  2934. for (int i = 0; i < p_call->arguments.size(); ++arg_itr, ++i) {
  2935. GDScriptParser::DataType par_type = type_from_property(*arg_itr, true);
  2936. if (p_call->arguments[i]->is_constant) {
  2937. update_const_expression_builtin_type(p_call->arguments[i], par_type, "pass");
  2938. }
  2939. #ifdef DEBUG_ENABLED
  2940. if (!(par_type.is_variant() && par_type.is_hard_type())) {
  2941. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  2942. if (arg_type.is_variant() || !arg_type.is_hard_type()) {
  2943. mark_node_unsafe(p_call);
  2944. parser->push_warning(p_call->arguments[i], GDScriptWarning::UNSAFE_CALL_ARGUMENT, itos(i + 1), "constructor", function_name, par_type.to_string(), arg_type.to_string_strict());
  2945. }
  2946. }
  2947. #endif
  2948. }
  2949. match = true;
  2950. call_type = type_from_property(info.return_val);
  2951. break;
  2952. }
  2953. }
  2954. if (!match) {
  2955. String signature = Variant::get_type_name(builtin_type) + "(";
  2956. for (int i = 0; i < p_call->arguments.size(); i++) {
  2957. if (i > 0) {
  2958. signature += ", ";
  2959. }
  2960. signature += p_call->arguments[i]->get_datatype().to_string();
  2961. }
  2962. signature += ")";
  2963. push_error(vformat(R"(No constructor of "%s" matches the signature "%s".)", Variant::get_type_name(builtin_type), signature), p_call);
  2964. }
  2965. }
  2966. #ifdef DEBUG_ENABLED
  2967. // Consider `Signal(self, "my_signal")` as an implicit use of the signal.
  2968. if (builtin_type == Variant::SIGNAL && p_call->arguments.size() >= 2) {
  2969. const GDScriptParser::ExpressionNode *object_arg = p_call->arguments[0];
  2970. if (object_arg && object_arg->type == GDScriptParser::Node::SELF) {
  2971. const GDScriptParser::ExpressionNode *signal_arg = p_call->arguments[1];
  2972. if (signal_arg && signal_arg->is_constant) {
  2973. const StringName &signal_name = signal_arg->reduced_value;
  2974. if (parser->current_class->has_member(signal_name)) {
  2975. const GDScriptParser::ClassNode::Member &member = parser->current_class->get_member(signal_name);
  2976. if (member.type == GDScriptParser::ClassNode::Member::SIGNAL) {
  2977. member.signal->usages++;
  2978. }
  2979. }
  2980. }
  2981. }
  2982. }
  2983. #endif
  2984. p_call->set_datatype(call_type);
  2985. return;
  2986. } else if (GDScriptUtilityFunctions::function_exists(function_name)) {
  2987. MethodInfo function_info = GDScriptUtilityFunctions::get_function_info(function_name);
  2988. 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)) {
  2989. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", function_name), p_call);
  2990. }
  2991. if (all_is_constant && GDScriptUtilityFunctions::is_function_constant(function_name)) {
  2992. // Can call on compilation.
  2993. Vector<const Variant *> args;
  2994. for (int i = 0; i < p_call->arguments.size(); i++) {
  2995. args.push_back(&(p_call->arguments[i]->reduced_value));
  2996. }
  2997. Variant value;
  2998. Callable::CallError err;
  2999. GDScriptUtilityFunctions::get_function(function_name)(&value, (const Variant **)args.ptr(), args.size(), err);
  3000. switch (err.error) {
  3001. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT:
  3002. if (value.get_type() == Variant::STRING && !value.operator String().is_empty()) {
  3003. push_error(vformat(R"*(Invalid argument for "%s()" function: %s)*", function_name, value), p_call->arguments[err.argument]);
  3004. } else {
  3005. // Do not use `type_from_property()` for expected type, since utility functions use their own checks.
  3006. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*", function_name, err.argument + 1,
  3007. Variant::get_type_name((Variant::Type)err.expected), p_call->arguments[err.argument]->get_datatype().to_string()),
  3008. p_call->arguments[err.argument]);
  3009. }
  3010. break;
  3011. case Callable::CallError::CALL_ERROR_INVALID_METHOD:
  3012. push_error(vformat(R"(Invalid call for function "%s".)", function_name), p_call);
  3013. break;
  3014. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  3015. 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);
  3016. break;
  3017. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  3018. 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);
  3019. break;
  3020. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  3021. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  3022. break; // Can't happen in a builtin constructor.
  3023. case Callable::CallError::CALL_OK:
  3024. p_call->is_constant = true;
  3025. p_call->reduced_value = value;
  3026. break;
  3027. }
  3028. } else {
  3029. validate_call_arg(function_info, p_call);
  3030. }
  3031. p_call->set_datatype(type_from_property(function_info.return_val));
  3032. return;
  3033. } else if (Variant::has_utility_function(function_name)) {
  3034. MethodInfo function_info = info_from_utility_func(function_name);
  3035. 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)) {
  3036. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", function_name), p_call);
  3037. }
  3038. if (all_is_constant && Variant::get_utility_function_type(function_name) == Variant::UTILITY_FUNC_TYPE_MATH) {
  3039. // Can call on compilation.
  3040. Vector<const Variant *> args;
  3041. for (int i = 0; i < p_call->arguments.size(); i++) {
  3042. args.push_back(&(p_call->arguments[i]->reduced_value));
  3043. }
  3044. Variant value;
  3045. Callable::CallError err;
  3046. Variant::call_utility_function(function_name, &value, (const Variant **)args.ptr(), args.size(), err);
  3047. switch (err.error) {
  3048. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT:
  3049. if (value.get_type() == Variant::STRING && !value.operator String().is_empty()) {
  3050. push_error(vformat(R"*(Invalid argument for "%s()" function: %s)*", function_name, value), p_call->arguments[err.argument]);
  3051. } else {
  3052. // Do not use `type_from_property()` for expected type, since utility functions use their own checks.
  3053. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*", function_name, err.argument + 1,
  3054. Variant::get_type_name((Variant::Type)err.expected), p_call->arguments[err.argument]->get_datatype().to_string()),
  3055. p_call->arguments[err.argument]);
  3056. }
  3057. break;
  3058. case Callable::CallError::CALL_ERROR_INVALID_METHOD:
  3059. push_error(vformat(R"(Invalid call for function "%s".)", function_name), p_call);
  3060. break;
  3061. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  3062. 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);
  3063. break;
  3064. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  3065. 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);
  3066. break;
  3067. case Callable::CallError::CALL_ERROR_METHOD_NOT_CONST:
  3068. case Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  3069. break; // Can't happen in a builtin constructor.
  3070. case Callable::CallError::CALL_OK:
  3071. p_call->is_constant = true;
  3072. p_call->reduced_value = value;
  3073. break;
  3074. }
  3075. } else {
  3076. validate_call_arg(function_info, p_call);
  3077. }
  3078. p_call->set_datatype(type_from_property(function_info.return_val));
  3079. return;
  3080. }
  3081. }
  3082. GDScriptParser::DataType base_type;
  3083. call_type.kind = GDScriptParser::DataType::VARIANT;
  3084. bool is_self = false;
  3085. if (p_call->is_super) {
  3086. base_type = parser->current_class->base_type;
  3087. base_type.is_meta_type = false;
  3088. is_self = true;
  3089. if (p_call->callee == nullptr && current_lambda != nullptr) {
  3090. push_error("Cannot use `super()` inside a lambda.", p_call);
  3091. }
  3092. } else if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  3093. base_type = parser->current_class->get_datatype();
  3094. base_type.is_meta_type = false;
  3095. is_self = true;
  3096. } else if (callee_type == GDScriptParser::Node::SUBSCRIPT) {
  3097. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee);
  3098. if (subscript->base == nullptr) {
  3099. // Invalid syntax, error already set on parser.
  3100. p_call->set_datatype(call_type);
  3101. mark_node_unsafe(p_call);
  3102. return;
  3103. }
  3104. if (!subscript->is_attribute) {
  3105. // Invalid call. Error already sent in parser.
  3106. // TODO: Could check if Callable here.
  3107. p_call->set_datatype(call_type);
  3108. mark_node_unsafe(p_call);
  3109. return;
  3110. }
  3111. if (subscript->attribute == nullptr) {
  3112. // Invalid call. Error already sent in parser.
  3113. p_call->set_datatype(call_type);
  3114. mark_node_unsafe(p_call);
  3115. return;
  3116. }
  3117. GDScriptParser::IdentifierNode *base_id = nullptr;
  3118. if (subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  3119. base_id = static_cast<GDScriptParser::IdentifierNode *>(subscript->base);
  3120. }
  3121. if (base_id && GDScriptParser::get_builtin_type(base_id->name) < Variant::VARIANT_MAX) {
  3122. base_type = make_builtin_meta_type(GDScriptParser::get_builtin_type(base_id->name));
  3123. } else {
  3124. reduce_expression(subscript->base);
  3125. base_type = subscript->base->get_datatype();
  3126. is_self = subscript->base->type == GDScriptParser::Node::SELF;
  3127. }
  3128. } else {
  3129. // Invalid call. Error already sent in parser.
  3130. // TODO: Could check if Callable here too.
  3131. p_call->set_datatype(call_type);
  3132. mark_node_unsafe(p_call);
  3133. return;
  3134. }
  3135. int default_arg_count = 0;
  3136. BitField<MethodFlags> method_flags;
  3137. GDScriptParser::DataType return_type;
  3138. List<GDScriptParser::DataType> par_types;
  3139. bool is_constructor = (base_type.is_meta_type || (p_call->callee && p_call->callee->type == GDScriptParser::Node::IDENTIFIER)) && p_call->function_name == SNAME("new");
  3140. if (is_constructor && Engine::get_singleton()->has_singleton(base_type.native_type)) {
  3141. push_error(vformat(R"(Cannot construct native class "%s" because it is an engine singleton.)", base_type.native_type), p_call);
  3142. p_call->set_datatype(call_type);
  3143. return;
  3144. }
  3145. if (get_function_signature(p_call, is_constructor, base_type, p_call->function_name, return_type, par_types, default_arg_count, method_flags)) {
  3146. // If the method is implemented in the class hierarchy, the virtual flag will not be set for that MethodInfo and the search stops there.
  3147. // Virtual check only possible for super() calls because class hierarchy is known. Node/Objects may have scripts attached we don't know of at compile-time.
  3148. p_call->is_static = method_flags.has_flag(METHOD_FLAG_STATIC);
  3149. if (p_call->is_super && method_flags.has_flag(METHOD_FLAG_VIRTUAL)) {
  3150. push_error(vformat(R"*(Cannot call the parent class' virtual function "%s()" because it hasn't been defined.)*", p_call->function_name), p_call);
  3151. }
  3152. // If the function requires typed arrays we must make literals be typed.
  3153. for (const KeyValue<int, GDScriptParser::ArrayNode *> &E : arrays) {
  3154. int index = E.key;
  3155. if (index < par_types.size() && par_types.get(index).is_hard_type() && par_types.get(index).has_container_element_type(0)) {
  3156. update_array_literal_element_type(E.value, par_types.get(index).get_container_element_type(0));
  3157. }
  3158. }
  3159. for (const KeyValue<int, GDScriptParser::DictionaryNode *> &E : dictionaries) {
  3160. int index = E.key;
  3161. if (index < par_types.size() && par_types.get(index).is_hard_type() && par_types.get(index).has_container_element_types()) {
  3162. GDScriptParser::DataType key = par_types.get(index).get_container_element_type_or_variant(0);
  3163. GDScriptParser::DataType value = par_types.get(index).get_container_element_type_or_variant(1);
  3164. update_dictionary_literal_element_type(E.value, key, value);
  3165. }
  3166. }
  3167. validate_call_arg(par_types, default_arg_count, method_flags.has_flag(METHOD_FLAG_VARARG), p_call);
  3168. if (base_type.kind == GDScriptParser::DataType::ENUM && base_type.is_meta_type) {
  3169. // Enum type is treated as a dictionary value for function calls.
  3170. base_type.is_meta_type = false;
  3171. }
  3172. if (is_self && static_context && !p_call->is_static) {
  3173. // Get the parent function above any lambda.
  3174. GDScriptParser::FunctionNode *parent_function = parser->current_function;
  3175. while (parent_function && parent_function->source_lambda) {
  3176. parent_function = parent_function->source_lambda->parent_function;
  3177. }
  3178. if (parent_function) {
  3179. push_error(vformat(R"*(Cannot call non-static function "%s()" from the static function "%s()".)*", p_call->function_name, parent_function->identifier->name), p_call);
  3180. } else {
  3181. push_error(vformat(R"*(Cannot call non-static function "%s()" from a static variable initializer.)*", p_call->function_name), p_call);
  3182. }
  3183. } else if (!is_self && base_type.is_meta_type && !p_call->is_static) {
  3184. base_type.is_meta_type = false; // For `to_string()`.
  3185. 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);
  3186. } else if (is_self && !p_call->is_static) {
  3187. mark_lambda_use_self();
  3188. }
  3189. if (!p_is_root && !p_is_await && return_type.is_hard_type() && return_type.kind == GDScriptParser::DataType::BUILTIN && return_type.builtin_type == Variant::NIL) {
  3190. push_error(vformat(R"*(Cannot get return value of call to "%s()" because it returns "void".)*", p_call->function_name), p_call);
  3191. }
  3192. #ifdef DEBUG_ENABLED
  3193. // FIXME: No warning for built-in constructors and utilities due to early return.
  3194. if (p_is_root && return_type.kind != GDScriptParser::DataType::UNRESOLVED && return_type.builtin_type != Variant::NIL &&
  3195. !(p_call->is_super && p_call->function_name == GDScriptLanguage::get_singleton()->strings._init)) {
  3196. parser->push_warning(p_call, GDScriptWarning::RETURN_VALUE_DISCARDED, p_call->function_name);
  3197. }
  3198. if (method_flags.has_flag(METHOD_FLAG_STATIC) && !is_constructor && !base_type.is_meta_type && !is_self) {
  3199. String caller_type = base_type.to_string();
  3200. parser->push_warning(p_call, GDScriptWarning::STATIC_CALLED_ON_INSTANCE, p_call->function_name, caller_type);
  3201. }
  3202. // Consider `emit_signal()`, `connect()`, and `disconnect()` as implicit uses of the signal.
  3203. if (is_self && (p_call->function_name == SNAME("emit_signal") || p_call->function_name == SNAME("connect") || p_call->function_name == SNAME("disconnect")) && !p_call->arguments.is_empty()) {
  3204. const GDScriptParser::ExpressionNode *signal_arg = p_call->arguments[0];
  3205. if (signal_arg && signal_arg->is_constant) {
  3206. const StringName &signal_name = signal_arg->reduced_value;
  3207. if (parser->current_class->has_member(signal_name)) {
  3208. const GDScriptParser::ClassNode::Member &member = parser->current_class->get_member(signal_name);
  3209. if (member.type == GDScriptParser::ClassNode::Member::SIGNAL) {
  3210. member.signal->usages++;
  3211. }
  3212. }
  3213. }
  3214. }
  3215. #endif // DEBUG_ENABLED
  3216. call_type = return_type;
  3217. } else {
  3218. bool found = false;
  3219. // Enums do not have functions other than the built-in dictionary ones.
  3220. if (base_type.kind == GDScriptParser::DataType::ENUM && base_type.is_meta_type) {
  3221. if (base_type.builtin_type == Variant::DICTIONARY) {
  3222. 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);
  3223. } else {
  3224. 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);
  3225. }
  3226. } else if (!p_call->is_super && callee_type != GDScriptParser::Node::NONE) { // Check if the name exists as something else.
  3227. GDScriptParser::IdentifierNode *callee_id;
  3228. if (callee_type == GDScriptParser::Node::IDENTIFIER) {
  3229. callee_id = static_cast<GDScriptParser::IdentifierNode *>(p_call->callee);
  3230. } else {
  3231. // Can only be attribute.
  3232. callee_id = static_cast<GDScriptParser::SubscriptNode *>(p_call->callee)->attribute;
  3233. }
  3234. if (callee_id) {
  3235. reduce_identifier_from_base(callee_id, &base_type);
  3236. GDScriptParser::DataType callee_datatype = callee_id->get_datatype();
  3237. if (callee_datatype.is_set() && !callee_datatype.is_variant()) {
  3238. found = true;
  3239. if (callee_datatype.builtin_type == Variant::CALLABLE) {
  3240. 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);
  3241. } else {
  3242. 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);
  3243. }
  3244. #ifdef DEBUG_ENABLED
  3245. } else if (!is_self && !(base_type.is_hard_type() && base_type.kind == GDScriptParser::DataType::BUILTIN)) {
  3246. parser->push_warning(p_call, GDScriptWarning::UNSAFE_METHOD_ACCESS, p_call->function_name, base_type.to_string());
  3247. mark_node_unsafe(p_call);
  3248. #endif
  3249. }
  3250. }
  3251. }
  3252. if (!found && (is_self || (base_type.is_hard_type() && base_type.kind == GDScriptParser::DataType::BUILTIN))) {
  3253. String base_name = is_self && !p_call->is_super ? "self" : base_type.to_string();
  3254. #ifdef SUGGEST_GODOT4_RENAMES
  3255. String rename_hint;
  3256. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::RENAMED_IN_GODOT_4_HINT)).booleanize()) {
  3257. const char *renamed_function_name = check_for_renamed_identifier(p_call->function_name, p_call->type);
  3258. if (renamed_function_name) {
  3259. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", String(renamed_function_name) + "()");
  3260. }
  3261. }
  3262. 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);
  3263. #else
  3264. 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);
  3265. #endif // SUGGEST_GODOT4_RENAMES
  3266. } else if (!found && (!p_call->is_super && base_type.is_hard_type() && base_type.is_meta_type)) {
  3267. push_error(vformat(R"*(Static function "%s()" not found in base "%s".)*", p_call->function_name, base_type.to_string()), p_call);
  3268. }
  3269. }
  3270. if (call_type.is_coroutine && !p_is_await && !p_is_root) {
  3271. push_error(vformat(R"*(Function "%s()" is a coroutine, so it must be called with "await".)*", p_call->function_name), p_call);
  3272. }
  3273. p_call->set_datatype(call_type);
  3274. }
  3275. void GDScriptAnalyzer::reduce_cast(GDScriptParser::CastNode *p_cast) {
  3276. reduce_expression(p_cast->operand);
  3277. GDScriptParser::DataType cast_type = type_from_metatype(resolve_datatype(p_cast->cast_type));
  3278. if (!cast_type.is_set()) {
  3279. mark_node_unsafe(p_cast);
  3280. return;
  3281. }
  3282. p_cast->set_datatype(cast_type);
  3283. if (p_cast->operand->is_constant) {
  3284. update_const_expression_builtin_type(p_cast->operand, cast_type, "cast", true);
  3285. if (cast_type.is_variant() || p_cast->operand->get_datatype() == cast_type) {
  3286. p_cast->is_constant = true;
  3287. p_cast->reduced_value = p_cast->operand->reduced_value;
  3288. }
  3289. }
  3290. if (p_cast->operand->type == GDScriptParser::Node::ARRAY && cast_type.has_container_element_type(0)) {
  3291. update_array_literal_element_type(static_cast<GDScriptParser::ArrayNode *>(p_cast->operand), cast_type.get_container_element_type(0));
  3292. }
  3293. if (p_cast->operand->type == GDScriptParser::Node::DICTIONARY && cast_type.has_container_element_types()) {
  3294. update_dictionary_literal_element_type(static_cast<GDScriptParser::DictionaryNode *>(p_cast->operand),
  3295. cast_type.get_container_element_type_or_variant(0), cast_type.get_container_element_type_or_variant(1));
  3296. }
  3297. if (!cast_type.is_variant()) {
  3298. GDScriptParser::DataType op_type = p_cast->operand->get_datatype();
  3299. if (op_type.is_variant() || !op_type.is_hard_type()) {
  3300. mark_node_unsafe(p_cast);
  3301. #ifdef DEBUG_ENABLED
  3302. parser->push_warning(p_cast, GDScriptWarning::UNSAFE_CAST, cast_type.to_string());
  3303. #endif
  3304. } else {
  3305. bool valid = false;
  3306. if (op_type.builtin_type == Variant::INT && cast_type.kind == GDScriptParser::DataType::ENUM) {
  3307. mark_node_unsafe(p_cast);
  3308. valid = true;
  3309. } else if (op_type.kind == GDScriptParser::DataType::ENUM && cast_type.builtin_type == Variant::INT) {
  3310. valid = true;
  3311. } else if (op_type.kind == GDScriptParser::DataType::BUILTIN && cast_type.kind == GDScriptParser::DataType::BUILTIN) {
  3312. valid = Variant::can_convert(op_type.builtin_type, cast_type.builtin_type);
  3313. } else if (op_type.kind != GDScriptParser::DataType::BUILTIN && cast_type.kind != GDScriptParser::DataType::BUILTIN) {
  3314. valid = is_type_compatible(cast_type, op_type) || is_type_compatible(op_type, cast_type);
  3315. }
  3316. if (!valid) {
  3317. push_error(vformat(R"(Invalid cast. Cannot convert from "%s" to "%s".)", op_type.to_string(), cast_type.to_string()), p_cast->cast_type);
  3318. }
  3319. }
  3320. }
  3321. }
  3322. void GDScriptAnalyzer::reduce_dictionary(GDScriptParser::DictionaryNode *p_dictionary) {
  3323. HashMap<Variant, GDScriptParser::ExpressionNode *, VariantHasher, StringLikeVariantComparator> elements;
  3324. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  3325. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  3326. if (p_dictionary->style == GDScriptParser::DictionaryNode::PYTHON_DICT) {
  3327. reduce_expression(element.key);
  3328. }
  3329. reduce_expression(element.value);
  3330. if (element.key->is_constant) {
  3331. if (elements.has(element.key->reduced_value)) {
  3332. 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);
  3333. } else {
  3334. elements[element.key->reduced_value] = element.value;
  3335. }
  3336. }
  3337. }
  3338. // It's dictionary in any case.
  3339. GDScriptParser::DataType dict_type;
  3340. dict_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3341. dict_type.kind = GDScriptParser::DataType::BUILTIN;
  3342. dict_type.builtin_type = Variant::DICTIONARY;
  3343. dict_type.is_constant = true;
  3344. p_dictionary->set_datatype(dict_type);
  3345. }
  3346. void GDScriptAnalyzer::reduce_get_node(GDScriptParser::GetNodeNode *p_get_node) {
  3347. GDScriptParser::DataType result;
  3348. result.kind = GDScriptParser::DataType::VARIANT;
  3349. if (!ClassDB::is_parent_class(parser->current_class->base_type.native_type, SNAME("Node"))) {
  3350. push_error(vformat(R"*(Cannot use shorthand "get_node()" notation ("%c") on a class that isn't a node.)*", p_get_node->use_dollar ? '$' : '%'), p_get_node);
  3351. p_get_node->set_datatype(result);
  3352. return;
  3353. }
  3354. if (static_context) {
  3355. push_error(vformat(R"*(Cannot use shorthand "get_node()" notation ("%c") in a static function.)*", p_get_node->use_dollar ? '$' : '%'), p_get_node);
  3356. p_get_node->set_datatype(result);
  3357. return;
  3358. }
  3359. mark_lambda_use_self();
  3360. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3361. result.kind = GDScriptParser::DataType::NATIVE;
  3362. result.builtin_type = Variant::OBJECT;
  3363. result.native_type = SNAME("Node");
  3364. p_get_node->set_datatype(result);
  3365. }
  3366. GDScriptParser::DataType GDScriptAnalyzer::make_global_class_meta_type(const StringName &p_class_name, const GDScriptParser::Node *p_source) {
  3367. GDScriptParser::DataType type;
  3368. String path = ScriptServer::get_global_class_path(p_class_name);
  3369. String ext = path.get_extension();
  3370. if (ext == GDScriptLanguage::get_singleton()->get_extension()) {
  3371. Ref<GDScriptParserRef> ref = parser->get_depended_parser_for(path);
  3372. if (ref.is_null()) {
  3373. push_error(vformat(R"(Could not find script for class "%s".)", p_class_name), p_source);
  3374. type.type_source = GDScriptParser::DataType::UNDETECTED;
  3375. type.kind = GDScriptParser::DataType::VARIANT;
  3376. return type;
  3377. }
  3378. Error err = ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  3379. if (err) {
  3380. push_error(vformat(R"(Could not resolve class "%s", because of a parser error.)", p_class_name), p_source);
  3381. type.type_source = GDScriptParser::DataType::UNDETECTED;
  3382. type.kind = GDScriptParser::DataType::VARIANT;
  3383. return type;
  3384. }
  3385. return ref->get_parser()->head->get_datatype();
  3386. } else {
  3387. return make_script_meta_type(ResourceLoader::load(path, "Script"));
  3388. }
  3389. }
  3390. Ref<GDScriptParserRef> GDScriptAnalyzer::ensure_cached_external_parser_for_class(const GDScriptParser::ClassNode *p_class, const GDScriptParser::ClassNode *p_from_class, const char *p_context, const GDScriptParser::Node *p_source) {
  3391. // Delicate piece of code that intentionally doesn't use the GDScript cache or `get_depended_parser_for`.
  3392. // Search dependencies for the parser that owns `p_class` and make a cache entry for it.
  3393. // Required for how we store pointers to classes owned by other parser trees and need to call `resolve_class_member` and such on the same parser tree.
  3394. // Since https://github.com/godotengine/godot/pull/94871 there can technically be multiple parsers for the same script in the same parser tree.
  3395. // Even if unlikely, getting the wrong parser could lead to strange undefined behavior without errors.
  3396. if (p_class == nullptr) {
  3397. return nullptr;
  3398. }
  3399. if (HashMap<const GDScriptParser::ClassNode *, Ref<GDScriptParserRef>>::Iterator E = external_class_parser_cache.find(p_class)) {
  3400. return E->value;
  3401. }
  3402. if (parser->has_class(p_class)) {
  3403. return nullptr;
  3404. }
  3405. if (p_from_class == nullptr) {
  3406. p_from_class = parser->head;
  3407. }
  3408. Ref<GDScriptParserRef> parser_ref;
  3409. for (const GDScriptParser::ClassNode *look_class = p_from_class; look_class != nullptr; look_class = look_class->base_type.class_type) {
  3410. if (parser->has_class(look_class)) {
  3411. parser_ref = find_cached_external_parser_for_class(p_class, parser);
  3412. if (parser_ref.is_valid()) {
  3413. break;
  3414. }
  3415. }
  3416. if (HashMap<const GDScriptParser::ClassNode *, Ref<GDScriptParserRef>>::Iterator E = external_class_parser_cache.find(look_class)) {
  3417. parser_ref = find_cached_external_parser_for_class(p_class, E->value);
  3418. if (parser_ref.is_valid()) {
  3419. break;
  3420. }
  3421. }
  3422. String look_class_script_path = look_class->get_datatype().script_path;
  3423. if (HashMap<String, Ref<GDScriptParserRef>>::Iterator E = parser->depended_parsers.find(look_class_script_path)) {
  3424. parser_ref = find_cached_external_parser_for_class(p_class, E->value);
  3425. if (parser_ref.is_valid()) {
  3426. break;
  3427. }
  3428. }
  3429. }
  3430. if (parser_ref.is_null()) {
  3431. push_error(vformat(R"(Parser bug (please report): Could not find external parser for class "%s". (%s))", p_class->fqcn, p_context), p_source);
  3432. // A null parser will be inserted into the cache, so this error won't spam for the same class.
  3433. // This is ok, the values of external_class_parser_cache are not assumed to be valid references.
  3434. }
  3435. external_class_parser_cache.insert(p_class, parser_ref);
  3436. return parser_ref;
  3437. }
  3438. Ref<GDScriptParserRef> GDScriptAnalyzer::find_cached_external_parser_for_class(const GDScriptParser::ClassNode *p_class, const Ref<GDScriptParserRef> &p_dependant_parser) {
  3439. if (p_dependant_parser.is_null()) {
  3440. return nullptr;
  3441. }
  3442. if (HashMap<const GDScriptParser::ClassNode *, Ref<GDScriptParserRef>>::Iterator E = p_dependant_parser->get_analyzer()->external_class_parser_cache.find(p_class)) {
  3443. if (E->value.is_valid()) {
  3444. // Silently ensure it's parsed.
  3445. E->value->raise_status(GDScriptParserRef::PARSED);
  3446. if (E->value->get_parser()->has_class(p_class)) {
  3447. return E->value;
  3448. }
  3449. }
  3450. }
  3451. if (p_dependant_parser->get_parser()->has_class(p_class)) {
  3452. return p_dependant_parser;
  3453. }
  3454. // Silently ensure it's parsed.
  3455. p_dependant_parser->raise_status(GDScriptParserRef::PARSED);
  3456. return find_cached_external_parser_for_class(p_class, p_dependant_parser->get_parser());
  3457. }
  3458. Ref<GDScriptParserRef> GDScriptAnalyzer::find_cached_external_parser_for_class(const GDScriptParser::ClassNode *p_class, GDScriptParser *p_dependant_parser) {
  3459. if (p_dependant_parser == nullptr) {
  3460. return nullptr;
  3461. }
  3462. String script_path = p_class->get_datatype().script_path;
  3463. if (HashMap<String, Ref<GDScriptParserRef>>::Iterator E = p_dependant_parser->depended_parsers.find(script_path)) {
  3464. if (E->value.is_valid()) {
  3465. // Silently ensure it's parsed.
  3466. E->value->raise_status(GDScriptParserRef::PARSED);
  3467. if (E->value->get_parser()->has_class(p_class)) {
  3468. return E->value;
  3469. }
  3470. }
  3471. }
  3472. return nullptr;
  3473. }
  3474. Ref<GDScript> GDScriptAnalyzer::get_depended_shallow_script(const String &p_path, Error &r_error) {
  3475. // To keep a local cache of the parser for resolving external nodes later.
  3476. parser->get_depended_parser_for(p_path);
  3477. Ref<GDScript> scr = GDScriptCache::get_shallow_script(p_path, r_error, parser->script_path);
  3478. return scr;
  3479. }
  3480. void GDScriptAnalyzer::reduce_identifier_from_base_set_class(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType p_identifier_datatype) {
  3481. ERR_FAIL_NULL(p_identifier);
  3482. p_identifier->set_datatype(p_identifier_datatype);
  3483. Error err = OK;
  3484. Ref<GDScript> scr = get_depended_shallow_script(p_identifier_datatype.script_path, err);
  3485. if (err) {
  3486. push_error(vformat(R"(Error while getting cache for script "%s".)", p_identifier_datatype.script_path), p_identifier);
  3487. return;
  3488. }
  3489. p_identifier->reduced_value = scr->find_class(p_identifier_datatype.class_type->fqcn);
  3490. p_identifier->is_constant = true;
  3491. }
  3492. void GDScriptAnalyzer::reduce_identifier_from_base(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType *p_base) {
  3493. if (!p_identifier->get_datatype().has_no_type()) {
  3494. return;
  3495. }
  3496. GDScriptParser::DataType base;
  3497. if (p_base == nullptr) {
  3498. base = type_from_metatype(parser->current_class->get_datatype());
  3499. } else {
  3500. base = *p_base;
  3501. }
  3502. StringName name = p_identifier->name;
  3503. if (base.kind == GDScriptParser::DataType::ENUM) {
  3504. if (base.is_meta_type) {
  3505. if (base.enum_values.has(name)) {
  3506. p_identifier->set_datatype(type_from_metatype(base));
  3507. p_identifier->is_constant = true;
  3508. p_identifier->reduced_value = base.enum_values[name];
  3509. return;
  3510. }
  3511. // Enum does not have this value, return.
  3512. return;
  3513. } else {
  3514. push_error(R"(Cannot get property from enum value.)", p_identifier);
  3515. return;
  3516. }
  3517. }
  3518. if (base.kind == GDScriptParser::DataType::BUILTIN) {
  3519. if (base.is_meta_type) {
  3520. bool valid = true;
  3521. Variant result = Variant::get_constant_value(base.builtin_type, name, &valid);
  3522. if (valid) {
  3523. p_identifier->is_constant = true;
  3524. p_identifier->reduced_value = result;
  3525. p_identifier->set_datatype(type_from_variant(result, p_identifier));
  3526. } else if (base.is_hard_type()) {
  3527. #ifdef SUGGEST_GODOT4_RENAMES
  3528. String rename_hint;
  3529. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::RENAMED_IN_GODOT_4_HINT)).booleanize()) {
  3530. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  3531. if (renamed_identifier_name) {
  3532. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  3533. }
  3534. }
  3535. push_error(vformat(R"(Cannot find constant "%s" on base "%s".%s)", name, base.to_string(), rename_hint), p_identifier);
  3536. #else
  3537. push_error(vformat(R"(Cannot find constant "%s" on base "%s".)", name, base.to_string()), p_identifier);
  3538. #endif // SUGGEST_GODOT4_RENAMES
  3539. }
  3540. } else {
  3541. switch (base.builtin_type) {
  3542. case Variant::NIL: {
  3543. if (base.is_hard_type()) {
  3544. push_error(vformat(R"(Cannot get property "%s" on a null object.)", name), p_identifier);
  3545. }
  3546. return;
  3547. }
  3548. case Variant::DICTIONARY: {
  3549. GDScriptParser::DataType dummy;
  3550. dummy.kind = GDScriptParser::DataType::VARIANT;
  3551. p_identifier->set_datatype(dummy);
  3552. return;
  3553. }
  3554. default: {
  3555. Callable::CallError temp;
  3556. Variant dummy;
  3557. Variant::construct(base.builtin_type, dummy, nullptr, 0, temp);
  3558. List<PropertyInfo> properties;
  3559. dummy.get_property_list(&properties);
  3560. for (const PropertyInfo &prop : properties) {
  3561. if (prop.name == name) {
  3562. p_identifier->set_datatype(type_from_property(prop));
  3563. return;
  3564. }
  3565. }
  3566. if (Variant::has_builtin_method(base.builtin_type, name)) {
  3567. p_identifier->set_datatype(make_callable_type(Variant::get_builtin_method_info(base.builtin_type, name)));
  3568. return;
  3569. }
  3570. if (base.is_hard_type()) {
  3571. #ifdef SUGGEST_GODOT4_RENAMES
  3572. String rename_hint;
  3573. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::RENAMED_IN_GODOT_4_HINT)).booleanize()) {
  3574. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  3575. if (renamed_identifier_name) {
  3576. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  3577. }
  3578. }
  3579. push_error(vformat(R"(Cannot find property "%s" on base "%s".%s)", name, base.to_string(), rename_hint), p_identifier);
  3580. #else
  3581. push_error(vformat(R"(Cannot find property "%s" on base "%s".)", name, base.to_string()), p_identifier);
  3582. #endif // SUGGEST_GODOT4_RENAMES
  3583. }
  3584. }
  3585. }
  3586. }
  3587. return;
  3588. }
  3589. GDScriptParser::ClassNode *base_class = base.class_type;
  3590. List<GDScriptParser::ClassNode *> script_classes;
  3591. bool is_base = true;
  3592. if (base_class != nullptr) {
  3593. get_class_node_current_scope_classes(base_class, &script_classes, p_identifier);
  3594. }
  3595. bool is_constructor = base.is_meta_type && p_identifier->name == SNAME("new");
  3596. for (GDScriptParser::ClassNode *script_class : script_classes) {
  3597. if (p_base == nullptr && script_class->identifier && script_class->identifier->name == name) {
  3598. reduce_identifier_from_base_set_class(p_identifier, script_class->get_datatype());
  3599. if (script_class->outer != nullptr) {
  3600. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CLASS;
  3601. }
  3602. return;
  3603. }
  3604. if (is_constructor) {
  3605. name = "_init";
  3606. }
  3607. if (script_class->has_member(name)) {
  3608. resolve_class_member(script_class, name, p_identifier);
  3609. GDScriptParser::ClassNode::Member member = script_class->get_member(name);
  3610. switch (member.type) {
  3611. case GDScriptParser::ClassNode::Member::CONSTANT: {
  3612. p_identifier->set_datatype(member.get_datatype());
  3613. p_identifier->is_constant = true;
  3614. p_identifier->reduced_value = member.constant->initializer->reduced_value;
  3615. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3616. p_identifier->constant_source = member.constant;
  3617. return;
  3618. }
  3619. case GDScriptParser::ClassNode::Member::ENUM_VALUE: {
  3620. p_identifier->set_datatype(member.get_datatype());
  3621. p_identifier->is_constant = true;
  3622. p_identifier->reduced_value = member.enum_value.value;
  3623. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3624. return;
  3625. }
  3626. case GDScriptParser::ClassNode::Member::ENUM: {
  3627. p_identifier->set_datatype(member.get_datatype());
  3628. p_identifier->is_constant = true;
  3629. p_identifier->reduced_value = member.m_enum->dictionary;
  3630. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3631. return;
  3632. }
  3633. case GDScriptParser::ClassNode::Member::VARIABLE: {
  3634. if (is_base && (!base.is_meta_type || member.variable->is_static)) {
  3635. p_identifier->set_datatype(member.get_datatype());
  3636. p_identifier->source = member.variable->is_static ? GDScriptParser::IdentifierNode::STATIC_VARIABLE : GDScriptParser::IdentifierNode::MEMBER_VARIABLE;
  3637. p_identifier->variable_source = member.variable;
  3638. member.variable->usages += 1;
  3639. return;
  3640. }
  3641. } break;
  3642. case GDScriptParser::ClassNode::Member::SIGNAL: {
  3643. if (is_base && !base.is_meta_type) {
  3644. p_identifier->set_datatype(member.get_datatype());
  3645. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_SIGNAL;
  3646. p_identifier->signal_source = member.signal;
  3647. member.signal->usages += 1;
  3648. return;
  3649. }
  3650. } break;
  3651. case GDScriptParser::ClassNode::Member::FUNCTION: {
  3652. if (is_base && (!base.is_meta_type || member.function->is_static || is_constructor)) {
  3653. p_identifier->set_datatype(make_callable_type(member.function->info));
  3654. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_FUNCTION;
  3655. p_identifier->function_source = member.function;
  3656. p_identifier->function_source_is_static = member.function->is_static;
  3657. return;
  3658. }
  3659. } break;
  3660. case GDScriptParser::ClassNode::Member::CLASS: {
  3661. reduce_identifier_from_base_set_class(p_identifier, member.get_datatype());
  3662. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CLASS;
  3663. return;
  3664. }
  3665. default: {
  3666. // Do nothing
  3667. }
  3668. }
  3669. }
  3670. if (is_base) {
  3671. is_base = script_class->base_type.class_type != nullptr;
  3672. if (!is_base && p_base != nullptr) {
  3673. break;
  3674. }
  3675. }
  3676. }
  3677. // Check non-GDScript scripts.
  3678. Ref<Script> script_type = base.script_type;
  3679. if (base_class == nullptr && script_type.is_valid()) {
  3680. List<PropertyInfo> property_list;
  3681. script_type->get_script_property_list(&property_list);
  3682. for (const PropertyInfo &property_info : property_list) {
  3683. if (property_info.name != p_identifier->name) {
  3684. continue;
  3685. }
  3686. const GDScriptParser::DataType property_type = GDScriptAnalyzer::type_from_property(property_info, false, false);
  3687. p_identifier->set_datatype(property_type);
  3688. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_VARIABLE;
  3689. return;
  3690. }
  3691. MethodInfo method_info = script_type->get_method_info(p_identifier->name);
  3692. if (method_info.name == p_identifier->name) {
  3693. p_identifier->set_datatype(make_callable_type(method_info));
  3694. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_FUNCTION;
  3695. p_identifier->function_source_is_static = method_info.flags & METHOD_FLAG_STATIC;
  3696. return;
  3697. }
  3698. List<MethodInfo> signal_list;
  3699. script_type->get_script_signal_list(&signal_list);
  3700. for (const MethodInfo &signal_info : signal_list) {
  3701. if (signal_info.name != p_identifier->name) {
  3702. continue;
  3703. }
  3704. const GDScriptParser::DataType signal_type = make_signal_type(signal_info);
  3705. p_identifier->set_datatype(signal_type);
  3706. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_SIGNAL;
  3707. return;
  3708. }
  3709. HashMap<StringName, Variant> constant_map;
  3710. script_type->get_constants(&constant_map);
  3711. if (constant_map.has(p_identifier->name)) {
  3712. Variant constant = constant_map.get(p_identifier->name);
  3713. p_identifier->set_datatype(make_builtin_meta_type(constant.get_type()));
  3714. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3715. return;
  3716. }
  3717. }
  3718. // Check native members. No need for native class recursion because Node exposes all Object's properties.
  3719. const StringName &native = base.native_type;
  3720. if (class_exists(native)) {
  3721. if (is_constructor) {
  3722. name = "_init";
  3723. }
  3724. MethodInfo method_info;
  3725. if (ClassDB::has_property(native, name)) {
  3726. StringName getter_name = ClassDB::get_property_getter(native, name);
  3727. MethodBind *getter = ClassDB::get_method(native, getter_name);
  3728. if (getter != nullptr) {
  3729. bool has_setter = ClassDB::get_property_setter(native, name) != StringName();
  3730. p_identifier->set_datatype(type_from_property(getter->get_return_info(), false, !has_setter));
  3731. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3732. }
  3733. return;
  3734. }
  3735. if (ClassDB::get_method_info(native, name, &method_info)) {
  3736. // Method is callable.
  3737. p_identifier->set_datatype(make_callable_type(method_info));
  3738. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3739. return;
  3740. }
  3741. if (ClassDB::get_signal(native, name, &method_info)) {
  3742. // Signal is a type too.
  3743. p_identifier->set_datatype(make_signal_type(method_info));
  3744. p_identifier->source = GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3745. return;
  3746. }
  3747. if (ClassDB::has_enum(native, name)) {
  3748. p_identifier->set_datatype(make_native_enum_type(name, native));
  3749. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3750. return;
  3751. }
  3752. bool valid = false;
  3753. int64_t int_constant = ClassDB::get_integer_constant(native, name, &valid);
  3754. if (valid) {
  3755. p_identifier->is_constant = true;
  3756. p_identifier->reduced_value = int_constant;
  3757. p_identifier->source = GDScriptParser::IdentifierNode::MEMBER_CONSTANT;
  3758. // Check whether this constant, which exists, belongs to an enum
  3759. StringName enum_name = ClassDB::get_integer_constant_enum(native, name);
  3760. if (enum_name != StringName()) {
  3761. p_identifier->set_datatype(make_native_enum_type(enum_name, native, false));
  3762. } else {
  3763. p_identifier->set_datatype(type_from_variant(int_constant, p_identifier));
  3764. }
  3765. }
  3766. }
  3767. }
  3768. void GDScriptAnalyzer::reduce_identifier(GDScriptParser::IdentifierNode *p_identifier, bool can_be_builtin) {
  3769. // TODO: This is an opportunity to further infer types.
  3770. // Check if we are inside an enum. This allows enum values to access other elements of the same enum.
  3771. if (current_enum) {
  3772. for (int i = 0; i < current_enum->values.size(); i++) {
  3773. const GDScriptParser::EnumNode::Value &element = current_enum->values[i];
  3774. if (element.identifier->name == p_identifier->name) {
  3775. StringName enum_name = current_enum->identifier ? current_enum->identifier->name : UNNAMED_ENUM;
  3776. GDScriptParser::DataType type = make_class_enum_type(enum_name, parser->current_class, parser->script_path, false);
  3777. if (element.parent_enum->identifier) {
  3778. type.enum_type = element.parent_enum->identifier->name;
  3779. }
  3780. p_identifier->set_datatype(type);
  3781. if (element.resolved) {
  3782. p_identifier->is_constant = true;
  3783. p_identifier->reduced_value = element.value;
  3784. } else {
  3785. push_error(R"(Cannot use another enum element before it was declared.)", p_identifier);
  3786. }
  3787. return; // Found anyway.
  3788. }
  3789. }
  3790. }
  3791. bool found_source = false;
  3792. // Check if identifier is local.
  3793. // If that's the case, the declaration already was solved before.
  3794. switch (p_identifier->source) {
  3795. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER:
  3796. p_identifier->set_datatype(p_identifier->parameter_source->get_datatype());
  3797. found_source = true;
  3798. break;
  3799. case GDScriptParser::IdentifierNode::LOCAL_CONSTANT:
  3800. case GDScriptParser::IdentifierNode::MEMBER_CONSTANT:
  3801. p_identifier->set_datatype(p_identifier->constant_source->get_datatype());
  3802. p_identifier->is_constant = true;
  3803. // TODO: Constant should have a value on the node itself.
  3804. p_identifier->reduced_value = p_identifier->constant_source->initializer->reduced_value;
  3805. found_source = true;
  3806. break;
  3807. case GDScriptParser::IdentifierNode::MEMBER_SIGNAL:
  3808. p_identifier->signal_source->usages++;
  3809. [[fallthrough]];
  3810. case GDScriptParser::IdentifierNode::INHERITED_VARIABLE:
  3811. mark_lambda_use_self();
  3812. break;
  3813. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE:
  3814. mark_lambda_use_self();
  3815. p_identifier->variable_source->usages++;
  3816. [[fallthrough]];
  3817. case GDScriptParser::IdentifierNode::STATIC_VARIABLE:
  3818. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE:
  3819. p_identifier->set_datatype(p_identifier->variable_source->get_datatype());
  3820. found_source = true;
  3821. #ifdef DEBUG_ENABLED
  3822. if (p_identifier->variable_source && p_identifier->variable_source->assignments == 0 && !(p_identifier->get_datatype().is_hard_type() && p_identifier->get_datatype().kind == GDScriptParser::DataType::BUILTIN)) {
  3823. parser->push_warning(p_identifier, GDScriptWarning::UNASSIGNED_VARIABLE, p_identifier->name);
  3824. }
  3825. #endif
  3826. break;
  3827. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR:
  3828. p_identifier->set_datatype(p_identifier->bind_source->get_datatype());
  3829. found_source = true;
  3830. break;
  3831. case GDScriptParser::IdentifierNode::LOCAL_BIND: {
  3832. GDScriptParser::DataType result = p_identifier->bind_source->get_datatype();
  3833. result.is_constant = true;
  3834. p_identifier->set_datatype(result);
  3835. found_source = true;
  3836. } break;
  3837. case GDScriptParser::IdentifierNode::UNDEFINED_SOURCE:
  3838. case GDScriptParser::IdentifierNode::MEMBER_FUNCTION:
  3839. case GDScriptParser::IdentifierNode::MEMBER_CLASS:
  3840. break;
  3841. }
  3842. #ifdef DEBUG_ENABLED
  3843. if (!found_source && p_identifier->suite != nullptr && p_identifier->suite->has_local(p_identifier->name)) {
  3844. parser->push_warning(p_identifier, GDScriptWarning::CONFUSABLE_LOCAL_USAGE, p_identifier->name);
  3845. }
  3846. #endif
  3847. // Not a local, so check members.
  3848. if (!found_source) {
  3849. reduce_identifier_from_base(p_identifier);
  3850. if (p_identifier->source != GDScriptParser::IdentifierNode::UNDEFINED_SOURCE || p_identifier->get_datatype().is_set()) {
  3851. // Found.
  3852. found_source = true;
  3853. }
  3854. }
  3855. if (found_source) {
  3856. const bool source_is_instance_variable = p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_VARIABLE || p_identifier->source == GDScriptParser::IdentifierNode::INHERITED_VARIABLE;
  3857. const bool source_is_instance_function = p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_FUNCTION && !p_identifier->function_source_is_static;
  3858. const bool source_is_signal = p_identifier->source == GDScriptParser::IdentifierNode::MEMBER_SIGNAL;
  3859. if (static_context && (source_is_instance_variable || source_is_instance_function || source_is_signal)) {
  3860. // Get the parent function above any lambda.
  3861. GDScriptParser::FunctionNode *parent_function = parser->current_function;
  3862. while (parent_function && parent_function->source_lambda) {
  3863. parent_function = parent_function->source_lambda->parent_function;
  3864. }
  3865. String source_type;
  3866. if (source_is_instance_variable) {
  3867. source_type = "non-static variable";
  3868. } else if (source_is_instance_function) {
  3869. source_type = "non-static function";
  3870. } else { // source_is_signal
  3871. source_type = "signal";
  3872. }
  3873. if (parent_function) {
  3874. push_error(vformat(R"*(Cannot access %s "%s" from the static function "%s()".)*", source_type, p_identifier->name, parent_function->identifier->name), p_identifier);
  3875. } else {
  3876. push_error(vformat(R"*(Cannot access %s "%s" from a static variable initializer.)*", source_type, p_identifier->name), p_identifier);
  3877. }
  3878. }
  3879. if (current_lambda != nullptr) {
  3880. // If the identifier is a member variable (including the native class properties), member function, or a signal,
  3881. // we consider the lambda to be using `self`, so we keep a reference to the current instance.
  3882. if (source_is_instance_variable || source_is_instance_function || source_is_signal) {
  3883. mark_lambda_use_self();
  3884. return; // No need to capture.
  3885. }
  3886. switch (p_identifier->source) {
  3887. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER:
  3888. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE:
  3889. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR:
  3890. case GDScriptParser::IdentifierNode::LOCAL_BIND:
  3891. break; // Need to capture.
  3892. case GDScriptParser::IdentifierNode::UNDEFINED_SOURCE: // A global.
  3893. case GDScriptParser::IdentifierNode::LOCAL_CONSTANT:
  3894. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE:
  3895. case GDScriptParser::IdentifierNode::MEMBER_CONSTANT:
  3896. case GDScriptParser::IdentifierNode::MEMBER_FUNCTION:
  3897. case GDScriptParser::IdentifierNode::MEMBER_SIGNAL:
  3898. case GDScriptParser::IdentifierNode::MEMBER_CLASS:
  3899. case GDScriptParser::IdentifierNode::INHERITED_VARIABLE:
  3900. case GDScriptParser::IdentifierNode::STATIC_VARIABLE:
  3901. return; // No need to capture.
  3902. }
  3903. GDScriptParser::FunctionNode *function_test = current_lambda->function;
  3904. // Make sure we aren't capturing variable in the same lambda.
  3905. // This also add captures for nested lambdas.
  3906. 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)) {
  3907. function_test->source_lambda->captures_indices[p_identifier->name] = function_test->source_lambda->captures.size();
  3908. function_test->source_lambda->captures.push_back(p_identifier);
  3909. function_test = function_test->source_lambda->parent_function;
  3910. }
  3911. }
  3912. return;
  3913. }
  3914. StringName name = p_identifier->name;
  3915. p_identifier->source = GDScriptParser::IdentifierNode::UNDEFINED_SOURCE;
  3916. // Not a local or a member, so check globals.
  3917. Variant::Type builtin_type = GDScriptParser::get_builtin_type(name);
  3918. if (builtin_type < Variant::VARIANT_MAX) {
  3919. if (can_be_builtin) {
  3920. p_identifier->set_datatype(make_builtin_meta_type(builtin_type));
  3921. return;
  3922. } else {
  3923. push_error(R"(Builtin type cannot be used as a name on its own.)", p_identifier);
  3924. }
  3925. }
  3926. if (class_exists(name)) {
  3927. p_identifier->set_datatype(make_native_meta_type(name));
  3928. return;
  3929. }
  3930. if (ScriptServer::is_global_class(name)) {
  3931. p_identifier->set_datatype(make_global_class_meta_type(name, p_identifier));
  3932. return;
  3933. }
  3934. // Try singletons.
  3935. // Do this before globals because this might be a singleton loading another one before it's compiled.
  3936. if (ProjectSettings::get_singleton()->has_autoload(name)) {
  3937. const ProjectSettings::AutoloadInfo &autoload = ProjectSettings::get_singleton()->get_autoload(name);
  3938. if (autoload.is_singleton) {
  3939. // Singleton exists, so it's at least a Node.
  3940. GDScriptParser::DataType result;
  3941. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  3942. result.kind = GDScriptParser::DataType::NATIVE;
  3943. result.builtin_type = Variant::OBJECT;
  3944. result.native_type = SNAME("Node");
  3945. if (ResourceLoader::get_resource_type(autoload.path) == "GDScript") {
  3946. Ref<GDScriptParserRef> singl_parser = parser->get_depended_parser_for(autoload.path);
  3947. if (singl_parser.is_valid()) {
  3948. Error err = singl_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  3949. if (err == OK) {
  3950. result = type_from_metatype(singl_parser->get_parser()->head->get_datatype());
  3951. }
  3952. }
  3953. } else if (ResourceLoader::get_resource_type(autoload.path) == "PackedScene") {
  3954. if (GDScriptLanguage::get_singleton()->has_any_global_constant(name)) {
  3955. Variant constant = GDScriptLanguage::get_singleton()->get_any_global_constant(name);
  3956. Node *node = Object::cast_to<Node>(constant);
  3957. if (node != nullptr) {
  3958. Ref<GDScript> scr = node->get_script();
  3959. if (scr.is_valid()) {
  3960. Ref<GDScriptParserRef> singl_parser = parser->get_depended_parser_for(scr->get_script_path());
  3961. if (singl_parser.is_valid()) {
  3962. Error err = singl_parser->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  3963. if (err == OK) {
  3964. result = type_from_metatype(singl_parser->get_parser()->head->get_datatype());
  3965. }
  3966. }
  3967. }
  3968. }
  3969. }
  3970. }
  3971. result.is_constant = true;
  3972. p_identifier->set_datatype(result);
  3973. return;
  3974. }
  3975. }
  3976. if (CoreConstants::is_global_constant(name)) {
  3977. int index = CoreConstants::get_global_constant_index(name);
  3978. StringName enum_name = CoreConstants::get_global_constant_enum(index);
  3979. int64_t value = CoreConstants::get_global_constant_value(index);
  3980. if (enum_name != StringName()) {
  3981. p_identifier->set_datatype(make_global_enum_type(enum_name, StringName(), false));
  3982. } else {
  3983. p_identifier->set_datatype(type_from_variant(value, p_identifier));
  3984. }
  3985. p_identifier->is_constant = true;
  3986. p_identifier->reduced_value = value;
  3987. return;
  3988. }
  3989. if (GDScriptLanguage::get_singleton()->has_any_global_constant(name)) {
  3990. Variant constant = GDScriptLanguage::get_singleton()->get_any_global_constant(name);
  3991. p_identifier->set_datatype(type_from_variant(constant, p_identifier));
  3992. p_identifier->is_constant = true;
  3993. p_identifier->reduced_value = constant;
  3994. return;
  3995. }
  3996. if (CoreConstants::is_global_enum(name)) {
  3997. p_identifier->set_datatype(make_global_enum_type(name, StringName(), true));
  3998. if (!can_be_builtin) {
  3999. push_error(vformat(R"(Global enum "%s" cannot be used on its own.)", name), p_identifier);
  4000. }
  4001. return;
  4002. }
  4003. if (Variant::has_utility_function(name) || GDScriptUtilityFunctions::function_exists(name)) {
  4004. p_identifier->is_constant = true;
  4005. p_identifier->reduced_value = Callable(memnew(GDScriptUtilityCallable(name)));
  4006. MethodInfo method_info;
  4007. if (GDScriptUtilityFunctions::function_exists(name)) {
  4008. method_info = GDScriptUtilityFunctions::get_function_info(name);
  4009. } else {
  4010. method_info = Variant::get_utility_function_info(name);
  4011. }
  4012. p_identifier->set_datatype(make_callable_type(method_info));
  4013. return;
  4014. }
  4015. // Allow "Variant" here since it might be used for nested enums.
  4016. if (can_be_builtin && name == SNAME("Variant")) {
  4017. GDScriptParser::DataType variant;
  4018. variant.kind = GDScriptParser::DataType::VARIANT;
  4019. variant.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4020. variant.is_meta_type = true;
  4021. variant.is_pseudo_type = true;
  4022. p_identifier->set_datatype(variant);
  4023. return;
  4024. }
  4025. // Not found.
  4026. #ifdef SUGGEST_GODOT4_RENAMES
  4027. String rename_hint;
  4028. if (GLOBAL_GET(GDScriptWarning::get_settings_path_from_code(GDScriptWarning::RENAMED_IN_GODOT_4_HINT)).booleanize()) {
  4029. const char *renamed_identifier_name = check_for_renamed_identifier(name, p_identifier->type);
  4030. if (renamed_identifier_name) {
  4031. rename_hint = " " + vformat(R"(Did you mean to use "%s"?)", renamed_identifier_name);
  4032. }
  4033. }
  4034. push_error(vformat(R"(Identifier "%s" not declared in the current scope.%s)", name, rename_hint), p_identifier);
  4035. #else
  4036. push_error(vformat(R"(Identifier "%s" not declared in the current scope.)", name), p_identifier);
  4037. #endif // SUGGEST_GODOT4_RENAMES
  4038. GDScriptParser::DataType dummy;
  4039. dummy.kind = GDScriptParser::DataType::VARIANT;
  4040. p_identifier->set_datatype(dummy); // Just so type is set to something.
  4041. }
  4042. void GDScriptAnalyzer::reduce_lambda(GDScriptParser::LambdaNode *p_lambda) {
  4043. // Lambda is always a Callable.
  4044. GDScriptParser::DataType lambda_type;
  4045. lambda_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  4046. lambda_type.kind = GDScriptParser::DataType::BUILTIN;
  4047. lambda_type.builtin_type = Variant::CALLABLE;
  4048. p_lambda->set_datatype(lambda_type);
  4049. if (p_lambda->function == nullptr) {
  4050. return;
  4051. }
  4052. GDScriptParser::LambdaNode *previous_lambda = current_lambda;
  4053. current_lambda = p_lambda;
  4054. resolve_function_signature(p_lambda->function, p_lambda, true);
  4055. current_lambda = previous_lambda;
  4056. pending_body_resolution_lambdas.push_back(p_lambda);
  4057. }
  4058. void GDScriptAnalyzer::reduce_literal(GDScriptParser::LiteralNode *p_literal) {
  4059. p_literal->reduced_value = p_literal->value;
  4060. p_literal->is_constant = true;
  4061. p_literal->set_datatype(type_from_variant(p_literal->reduced_value, p_literal));
  4062. }
  4063. void GDScriptAnalyzer::reduce_preload(GDScriptParser::PreloadNode *p_preload) {
  4064. if (!p_preload->path) {
  4065. return;
  4066. }
  4067. reduce_expression(p_preload->path);
  4068. if (!p_preload->path->is_constant) {
  4069. push_error("Preloaded path must be a constant string.", p_preload->path);
  4070. return;
  4071. }
  4072. if (p_preload->path->reduced_value.get_type() != Variant::STRING) {
  4073. push_error("Preloaded path must be a constant string.", p_preload->path);
  4074. } else {
  4075. p_preload->resolved_path = p_preload->path->reduced_value;
  4076. // TODO: Save this as script dependency.
  4077. if (p_preload->resolved_path.is_relative_path()) {
  4078. p_preload->resolved_path = parser->script_path.get_base_dir().path_join(p_preload->resolved_path);
  4079. }
  4080. p_preload->resolved_path = p_preload->resolved_path.simplify_path();
  4081. if (!ResourceLoader::exists(p_preload->resolved_path)) {
  4082. Ref<FileAccess> file_check = FileAccess::create(FileAccess::ACCESS_RESOURCES);
  4083. if (file_check->file_exists(p_preload->resolved_path)) {
  4084. push_error(vformat(R"(Preload file "%s" has no resource loaders (unrecognized file extension).)", p_preload->resolved_path), p_preload->path);
  4085. } else {
  4086. push_error(vformat(R"(Preload file "%s" does not exist.)", p_preload->resolved_path), p_preload->path);
  4087. }
  4088. } else {
  4089. // TODO: Don't load if validating: use completion cache.
  4090. // Must load GDScript separately to permit cyclic references
  4091. // as ResourceLoader::load() detects and rejects those.
  4092. const String &res_type = ResourceLoader::get_resource_type(p_preload->resolved_path);
  4093. if (res_type == "GDScript") {
  4094. Error err = OK;
  4095. Ref<GDScript> res = get_depended_shallow_script(p_preload->resolved_path, err);
  4096. p_preload->resource = res;
  4097. if (err != OK) {
  4098. push_error(vformat(R"(Could not preload resource script "%s".)", p_preload->resolved_path), p_preload->path);
  4099. }
  4100. } else {
  4101. Error err = OK;
  4102. p_preload->resource = ResourceLoader::load(p_preload->resolved_path, res_type, ResourceFormatLoader::CACHE_MODE_REUSE, &err);
  4103. if (err == ERR_BUSY) {
  4104. p_preload->resource = ResourceLoader::ensure_resource_ref_override_for_outer_load(p_preload->resolved_path, res_type);
  4105. }
  4106. if (p_preload->resource.is_null()) {
  4107. push_error(vformat(R"(Could not preload resource file "%s".)", p_preload->resolved_path), p_preload->path);
  4108. }
  4109. }
  4110. }
  4111. }
  4112. p_preload->is_constant = true;
  4113. p_preload->reduced_value = p_preload->resource;
  4114. p_preload->set_datatype(type_from_variant(p_preload->reduced_value, p_preload));
  4115. // TODO: Not sure if this is necessary anymore.
  4116. // 'type_from_variant()' should call 'resolve_class_inheritance()' which would call 'ensure_cached_external_parser_for_class()'
  4117. // Better safe than sorry.
  4118. ensure_cached_external_parser_for_class(p_preload->get_datatype().class_type, nullptr, "Trying to resolve preload", p_preload);
  4119. }
  4120. void GDScriptAnalyzer::reduce_self(GDScriptParser::SelfNode *p_self) {
  4121. p_self->is_constant = false;
  4122. p_self->set_datatype(type_from_metatype(parser->current_class->get_datatype()));
  4123. mark_lambda_use_self();
  4124. }
  4125. void GDScriptAnalyzer::reduce_subscript(GDScriptParser::SubscriptNode *p_subscript, bool p_can_be_pseudo_type) {
  4126. if (p_subscript->base == nullptr) {
  4127. return;
  4128. }
  4129. if (p_subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  4130. reduce_identifier(static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base), true);
  4131. } else if (p_subscript->base->type == GDScriptParser::Node::SUBSCRIPT) {
  4132. reduce_subscript(static_cast<GDScriptParser::SubscriptNode *>(p_subscript->base), true);
  4133. } else {
  4134. reduce_expression(p_subscript->base);
  4135. }
  4136. GDScriptParser::DataType result_type;
  4137. if (p_subscript->is_attribute) {
  4138. if (p_subscript->attribute == nullptr) {
  4139. return;
  4140. }
  4141. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  4142. bool valid = false;
  4143. // If the base is a metatype, use the analyzer instead.
  4144. if (p_subscript->base->is_constant && !base_type.is_meta_type) {
  4145. // GH-92534. If the base is a GDScript, use the analyzer instead.
  4146. bool base_is_gdscript = false;
  4147. if (p_subscript->base->reduced_value.get_type() == Variant::OBJECT) {
  4148. Ref<GDScript> gdscript = Object::cast_to<GDScript>(p_subscript->base->reduced_value.get_validated_object());
  4149. if (gdscript.is_valid()) {
  4150. base_is_gdscript = true;
  4151. // Makes a metatype from a constant GDScript, since `base_type` is not a metatype.
  4152. GDScriptParser::DataType base_type_meta = type_from_variant(gdscript, p_subscript);
  4153. // First try to reduce the attribute from the metatype.
  4154. reduce_identifier_from_base(p_subscript->attribute, &base_type_meta);
  4155. GDScriptParser::DataType attr_type = p_subscript->attribute->get_datatype();
  4156. if (attr_type.is_set()) {
  4157. valid = !attr_type.is_pseudo_type || p_can_be_pseudo_type;
  4158. result_type = attr_type;
  4159. p_subscript->is_constant = p_subscript->attribute->is_constant;
  4160. p_subscript->reduced_value = p_subscript->attribute->reduced_value;
  4161. }
  4162. if (!valid) {
  4163. // If unsuccessful, reset and return to the normal route.
  4164. p_subscript->attribute->set_datatype(GDScriptParser::DataType());
  4165. }
  4166. }
  4167. }
  4168. if (!base_is_gdscript) {
  4169. // Just try to get it.
  4170. Variant value = p_subscript->base->reduced_value.get_named(p_subscript->attribute->name, valid);
  4171. if (valid) {
  4172. p_subscript->is_constant = true;
  4173. p_subscript->reduced_value = value;
  4174. result_type = type_from_variant(value, p_subscript);
  4175. }
  4176. }
  4177. }
  4178. if (valid) {
  4179. // Do nothing.
  4180. } else if (base_type.is_variant() || !base_type.is_hard_type()) {
  4181. valid = !base_type.is_pseudo_type || p_can_be_pseudo_type;
  4182. result_type.kind = GDScriptParser::DataType::VARIANT;
  4183. if (base_type.is_variant() && base_type.is_hard_type() && base_type.is_meta_type && base_type.is_pseudo_type) {
  4184. // Special case: it may be a global enum with pseudo base (e.g. Variant.Type).
  4185. String enum_name;
  4186. if (p_subscript->base->type == GDScriptParser::Node::IDENTIFIER) {
  4187. enum_name = String(static_cast<GDScriptParser::IdentifierNode *>(p_subscript->base)->name) + ENUM_SEPARATOR + String(p_subscript->attribute->name);
  4188. }
  4189. if (CoreConstants::is_global_enum(enum_name)) {
  4190. result_type = make_global_enum_type(enum_name, StringName());
  4191. } else {
  4192. valid = false;
  4193. mark_node_unsafe(p_subscript);
  4194. }
  4195. } else {
  4196. mark_node_unsafe(p_subscript);
  4197. }
  4198. } else {
  4199. reduce_identifier_from_base(p_subscript->attribute, &base_type);
  4200. GDScriptParser::DataType attr_type = p_subscript->attribute->get_datatype();
  4201. if (attr_type.is_set()) {
  4202. if (base_type.builtin_type == Variant::DICTIONARY && base_type.has_container_element_types()) {
  4203. Variant::Type key_type = base_type.get_container_element_type_or_variant(0).builtin_type;
  4204. valid = key_type == Variant::NIL || key_type == Variant::STRING || key_type == Variant::STRING_NAME;
  4205. if (base_type.has_container_element_type(1)) {
  4206. result_type = base_type.get_container_element_type(1);
  4207. result_type.type_source = base_type.type_source;
  4208. } else {
  4209. result_type.builtin_type = Variant::NIL;
  4210. result_type.kind = GDScriptParser::DataType::VARIANT;
  4211. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  4212. }
  4213. } else {
  4214. valid = !attr_type.is_pseudo_type || p_can_be_pseudo_type;
  4215. result_type = attr_type;
  4216. p_subscript->is_constant = p_subscript->attribute->is_constant;
  4217. p_subscript->reduced_value = p_subscript->attribute->reduced_value;
  4218. }
  4219. } else if (!base_type.is_meta_type || !base_type.is_constant) {
  4220. valid = base_type.kind != GDScriptParser::DataType::BUILTIN;
  4221. #ifdef DEBUG_ENABLED
  4222. if (valid) {
  4223. parser->push_warning(p_subscript, GDScriptWarning::UNSAFE_PROPERTY_ACCESS, p_subscript->attribute->name, base_type.to_string());
  4224. }
  4225. #endif
  4226. result_type.kind = GDScriptParser::DataType::VARIANT;
  4227. mark_node_unsafe(p_subscript);
  4228. }
  4229. }
  4230. if (!valid) {
  4231. GDScriptParser::DataType attr_type = p_subscript->attribute->get_datatype();
  4232. if (!p_can_be_pseudo_type && (attr_type.is_pseudo_type || result_type.is_pseudo_type)) {
  4233. 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);
  4234. } else {
  4235. 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);
  4236. }
  4237. result_type.kind = GDScriptParser::DataType::VARIANT;
  4238. }
  4239. } else {
  4240. if (p_subscript->index == nullptr) {
  4241. return;
  4242. }
  4243. reduce_expression(p_subscript->index);
  4244. if (p_subscript->base->is_constant && p_subscript->index->is_constant) {
  4245. // Just try to get it.
  4246. bool valid = false;
  4247. // TODO: Check if `p_subscript->base->reduced_value` is GDScript.
  4248. Variant value = p_subscript->base->reduced_value.get(p_subscript->index->reduced_value, &valid);
  4249. if (!valid) {
  4250. push_error(vformat(R"(Cannot get index "%s" from "%s".)", p_subscript->index->reduced_value, p_subscript->base->reduced_value), p_subscript->index);
  4251. result_type.kind = GDScriptParser::DataType::VARIANT;
  4252. } else {
  4253. p_subscript->is_constant = true;
  4254. p_subscript->reduced_value = value;
  4255. result_type = type_from_variant(value, p_subscript);
  4256. }
  4257. } else {
  4258. GDScriptParser::DataType base_type = p_subscript->base->get_datatype();
  4259. GDScriptParser::DataType index_type = p_subscript->index->get_datatype();
  4260. if (base_type.is_variant()) {
  4261. result_type.kind = GDScriptParser::DataType::VARIANT;
  4262. mark_node_unsafe(p_subscript);
  4263. } else {
  4264. if (base_type.kind == GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  4265. // Check if indexing is valid.
  4266. bool error = index_type.kind != GDScriptParser::DataType::BUILTIN && base_type.builtin_type != Variant::DICTIONARY;
  4267. if (!error) {
  4268. switch (base_type.builtin_type) {
  4269. // Expect int or real as index.
  4270. case Variant::PACKED_BYTE_ARRAY:
  4271. case Variant::PACKED_FLOAT32_ARRAY:
  4272. case Variant::PACKED_FLOAT64_ARRAY:
  4273. case Variant::PACKED_INT32_ARRAY:
  4274. case Variant::PACKED_INT64_ARRAY:
  4275. case Variant::PACKED_STRING_ARRAY:
  4276. case Variant::PACKED_VECTOR2_ARRAY:
  4277. case Variant::PACKED_VECTOR3_ARRAY:
  4278. case Variant::PACKED_COLOR_ARRAY:
  4279. case Variant::PACKED_VECTOR4_ARRAY:
  4280. case Variant::ARRAY:
  4281. case Variant::STRING:
  4282. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT;
  4283. break;
  4284. // Expect String only.
  4285. case Variant::RECT2:
  4286. case Variant::RECT2I:
  4287. case Variant::PLANE:
  4288. case Variant::QUATERNION:
  4289. case Variant::AABB:
  4290. case Variant::OBJECT:
  4291. error = index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  4292. break;
  4293. // Expect String or number.
  4294. case Variant::BASIS:
  4295. case Variant::VECTOR2:
  4296. case Variant::VECTOR2I:
  4297. case Variant::VECTOR3:
  4298. case Variant::VECTOR3I:
  4299. case Variant::VECTOR4:
  4300. case Variant::VECTOR4I:
  4301. case Variant::TRANSFORM2D:
  4302. case Variant::TRANSFORM3D:
  4303. case Variant::PROJECTION:
  4304. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::FLOAT &&
  4305. index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  4306. break;
  4307. // Expect String or int.
  4308. case Variant::COLOR:
  4309. error = index_type.builtin_type != Variant::INT && index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME;
  4310. break;
  4311. // Don't support indexing, but we will check it later.
  4312. case Variant::RID:
  4313. case Variant::BOOL:
  4314. case Variant::CALLABLE:
  4315. case Variant::FLOAT:
  4316. case Variant::INT:
  4317. case Variant::NIL:
  4318. case Variant::NODE_PATH:
  4319. case Variant::SIGNAL:
  4320. case Variant::STRING_NAME:
  4321. break;
  4322. // Support depends on if the dictionary has a typed key, otherwise anything is valid.
  4323. case Variant::DICTIONARY:
  4324. if (base_type.has_container_element_type(0)) {
  4325. GDScriptParser::DataType key_type = base_type.get_container_element_type(0);
  4326. switch (index_type.builtin_type) {
  4327. // Null value will be treated as an empty object, allow.
  4328. case Variant::NIL:
  4329. error = key_type.builtin_type != Variant::OBJECT;
  4330. break;
  4331. // Objects are parsed for validity in a similar manner to container types.
  4332. case Variant::OBJECT:
  4333. if (key_type.builtin_type == Variant::OBJECT) {
  4334. error = !key_type.can_reference(index_type);
  4335. } else {
  4336. error = key_type.builtin_type != Variant::NIL;
  4337. }
  4338. break;
  4339. // String and StringName interchangeable in this context.
  4340. case Variant::STRING:
  4341. case Variant::STRING_NAME:
  4342. error = key_type.builtin_type != Variant::STRING_NAME && key_type.builtin_type != Variant::STRING;
  4343. break;
  4344. // Ints are valid indices for floats, but not the other way around.
  4345. case Variant::INT:
  4346. error = key_type.builtin_type != Variant::INT && key_type.builtin_type != Variant::FLOAT;
  4347. break;
  4348. // All other cases require the types to match exactly.
  4349. default:
  4350. error = key_type.builtin_type != index_type.builtin_type;
  4351. break;
  4352. }
  4353. }
  4354. break;
  4355. // Here for completeness.
  4356. case Variant::VARIANT_MAX:
  4357. break;
  4358. }
  4359. if (error) {
  4360. 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);
  4361. }
  4362. }
  4363. } else if (base_type.kind != GDScriptParser::DataType::BUILTIN && !index_type.is_variant()) {
  4364. if (index_type.builtin_type != Variant::STRING && index_type.builtin_type != Variant::STRING_NAME) {
  4365. push_error(vformat(R"(Only "String" or "StringName" can be used as index for type "%s", but received "%s".)", base_type.to_string(), index_type.to_string()), p_subscript->index);
  4366. }
  4367. }
  4368. // Check resulting type if possible.
  4369. result_type.builtin_type = Variant::NIL;
  4370. result_type.kind = GDScriptParser::DataType::BUILTIN;
  4371. result_type.type_source = base_type.is_hard_type() ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  4372. if (base_type.kind != GDScriptParser::DataType::BUILTIN) {
  4373. base_type.builtin_type = Variant::OBJECT;
  4374. }
  4375. switch (base_type.builtin_type) {
  4376. // Can't index at all.
  4377. case Variant::RID:
  4378. case Variant::BOOL:
  4379. case Variant::CALLABLE:
  4380. case Variant::FLOAT:
  4381. case Variant::INT:
  4382. case Variant::NIL:
  4383. case Variant::NODE_PATH:
  4384. case Variant::SIGNAL:
  4385. case Variant::STRING_NAME:
  4386. result_type.kind = GDScriptParser::DataType::VARIANT;
  4387. push_error(vformat(R"(Cannot use subscript operator on a base of type "%s".)", base_type.to_string()), p_subscript->base);
  4388. break;
  4389. // Return int.
  4390. case Variant::PACKED_BYTE_ARRAY:
  4391. case Variant::PACKED_INT32_ARRAY:
  4392. case Variant::PACKED_INT64_ARRAY:
  4393. case Variant::VECTOR2I:
  4394. case Variant::VECTOR3I:
  4395. case Variant::VECTOR4I:
  4396. result_type.builtin_type = Variant::INT;
  4397. break;
  4398. // Return float.
  4399. case Variant::PACKED_FLOAT32_ARRAY:
  4400. case Variant::PACKED_FLOAT64_ARRAY:
  4401. case Variant::VECTOR2:
  4402. case Variant::VECTOR3:
  4403. case Variant::VECTOR4:
  4404. case Variant::QUATERNION:
  4405. result_type.builtin_type = Variant::FLOAT;
  4406. break;
  4407. // Return String.
  4408. case Variant::PACKED_STRING_ARRAY:
  4409. case Variant::STRING:
  4410. result_type.builtin_type = Variant::STRING;
  4411. break;
  4412. // Return Vector2.
  4413. case Variant::PACKED_VECTOR2_ARRAY:
  4414. case Variant::TRANSFORM2D:
  4415. case Variant::RECT2:
  4416. result_type.builtin_type = Variant::VECTOR2;
  4417. break;
  4418. // Return Vector2I.
  4419. case Variant::RECT2I:
  4420. result_type.builtin_type = Variant::VECTOR2I;
  4421. break;
  4422. // Return Vector3.
  4423. case Variant::PACKED_VECTOR3_ARRAY:
  4424. case Variant::AABB:
  4425. case Variant::BASIS:
  4426. result_type.builtin_type = Variant::VECTOR3;
  4427. break;
  4428. // Return Color.
  4429. case Variant::PACKED_COLOR_ARRAY:
  4430. result_type.builtin_type = Variant::COLOR;
  4431. break;
  4432. // Return Vector4.
  4433. case Variant::PACKED_VECTOR4_ARRAY:
  4434. result_type.builtin_type = Variant::VECTOR4;
  4435. break;
  4436. // Depends on the index.
  4437. case Variant::TRANSFORM3D:
  4438. case Variant::PROJECTION:
  4439. case Variant::PLANE:
  4440. case Variant::COLOR:
  4441. case Variant::OBJECT:
  4442. result_type.kind = GDScriptParser::DataType::VARIANT;
  4443. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  4444. break;
  4445. // Can have an element type.
  4446. case Variant::ARRAY:
  4447. if (base_type.has_container_element_type(0)) {
  4448. result_type = base_type.get_container_element_type(0);
  4449. result_type.type_source = base_type.type_source;
  4450. } else {
  4451. result_type.kind = GDScriptParser::DataType::VARIANT;
  4452. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  4453. }
  4454. break;
  4455. // Can have two element types, but we only care about the value.
  4456. case Variant::DICTIONARY:
  4457. if (base_type.has_container_element_type(1)) {
  4458. result_type = base_type.get_container_element_type(1);
  4459. result_type.type_source = base_type.type_source;
  4460. } else {
  4461. result_type.kind = GDScriptParser::DataType::VARIANT;
  4462. result_type.type_source = GDScriptParser::DataType::UNDETECTED;
  4463. }
  4464. break;
  4465. // Here for completeness.
  4466. case Variant::VARIANT_MAX:
  4467. break;
  4468. }
  4469. }
  4470. }
  4471. }
  4472. p_subscript->set_datatype(result_type);
  4473. }
  4474. void GDScriptAnalyzer::reduce_ternary_op(GDScriptParser::TernaryOpNode *p_ternary_op, bool p_is_root) {
  4475. reduce_expression(p_ternary_op->condition);
  4476. reduce_expression(p_ternary_op->true_expr, p_is_root);
  4477. reduce_expression(p_ternary_op->false_expr, p_is_root);
  4478. GDScriptParser::DataType result;
  4479. 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) {
  4480. p_ternary_op->is_constant = true;
  4481. if (p_ternary_op->condition->reduced_value.booleanize()) {
  4482. p_ternary_op->reduced_value = p_ternary_op->true_expr->reduced_value;
  4483. } else {
  4484. p_ternary_op->reduced_value = p_ternary_op->false_expr->reduced_value;
  4485. }
  4486. }
  4487. GDScriptParser::DataType true_type;
  4488. if (p_ternary_op->true_expr) {
  4489. true_type = p_ternary_op->true_expr->get_datatype();
  4490. } else {
  4491. true_type.kind = GDScriptParser::DataType::VARIANT;
  4492. }
  4493. GDScriptParser::DataType false_type;
  4494. if (p_ternary_op->false_expr) {
  4495. false_type = p_ternary_op->false_expr->get_datatype();
  4496. } else {
  4497. false_type.kind = GDScriptParser::DataType::VARIANT;
  4498. }
  4499. if (true_type.is_variant() || false_type.is_variant()) {
  4500. result.kind = GDScriptParser::DataType::VARIANT;
  4501. } else {
  4502. result = true_type;
  4503. if (!is_type_compatible(true_type, false_type)) {
  4504. result = false_type;
  4505. if (!is_type_compatible(false_type, true_type)) {
  4506. result.kind = GDScriptParser::DataType::VARIANT;
  4507. #ifdef DEBUG_ENABLED
  4508. parser->push_warning(p_ternary_op, GDScriptWarning::INCOMPATIBLE_TERNARY);
  4509. #endif
  4510. }
  4511. }
  4512. }
  4513. result.type_source = true_type.is_hard_type() && false_type.is_hard_type() ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  4514. p_ternary_op->set_datatype(result);
  4515. }
  4516. void GDScriptAnalyzer::reduce_type_test(GDScriptParser::TypeTestNode *p_type_test) {
  4517. GDScriptParser::DataType result;
  4518. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4519. result.kind = GDScriptParser::DataType::BUILTIN;
  4520. result.builtin_type = Variant::BOOL;
  4521. p_type_test->set_datatype(result);
  4522. if (!p_type_test->operand || !p_type_test->test_type) {
  4523. return;
  4524. }
  4525. reduce_expression(p_type_test->operand);
  4526. GDScriptParser::DataType operand_type = p_type_test->operand->get_datatype();
  4527. GDScriptParser::DataType test_type = type_from_metatype(resolve_datatype(p_type_test->test_type));
  4528. p_type_test->test_datatype = test_type;
  4529. if (!operand_type.is_set() || !test_type.is_set()) {
  4530. return;
  4531. }
  4532. if (p_type_test->operand->is_constant) {
  4533. p_type_test->is_constant = true;
  4534. p_type_test->reduced_value = false;
  4535. if (!is_type_compatible(test_type, operand_type)) {
  4536. 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);
  4537. } else if (is_type_compatible(test_type, type_from_variant(p_type_test->operand->reduced_value, p_type_test->operand))) {
  4538. p_type_test->reduced_value = test_type.builtin_type != Variant::OBJECT || !p_type_test->operand->reduced_value.is_null();
  4539. }
  4540. return;
  4541. }
  4542. if (!is_type_compatible(test_type, operand_type) && !is_type_compatible(operand_type, test_type)) {
  4543. if (operand_type.is_hard_type()) {
  4544. 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);
  4545. } else {
  4546. downgrade_node_type_source(p_type_test->operand);
  4547. }
  4548. }
  4549. }
  4550. void GDScriptAnalyzer::reduce_unary_op(GDScriptParser::UnaryOpNode *p_unary_op) {
  4551. reduce_expression(p_unary_op->operand);
  4552. GDScriptParser::DataType result;
  4553. if (p_unary_op->operand == nullptr) {
  4554. result.kind = GDScriptParser::DataType::VARIANT;
  4555. p_unary_op->set_datatype(result);
  4556. return;
  4557. }
  4558. GDScriptParser::DataType operand_type = p_unary_op->operand->get_datatype();
  4559. if (p_unary_op->operand->is_constant) {
  4560. p_unary_op->is_constant = true;
  4561. p_unary_op->reduced_value = Variant::evaluate(p_unary_op->variant_op, p_unary_op->operand->reduced_value, Variant());
  4562. result = type_from_variant(p_unary_op->reduced_value, p_unary_op);
  4563. }
  4564. if (operand_type.is_variant()) {
  4565. result.kind = GDScriptParser::DataType::VARIANT;
  4566. mark_node_unsafe(p_unary_op);
  4567. } else {
  4568. bool valid = false;
  4569. result = get_operation_type(p_unary_op->variant_op, operand_type, valid, p_unary_op);
  4570. if (!valid) {
  4571. 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);
  4572. }
  4573. }
  4574. p_unary_op->set_datatype(result);
  4575. }
  4576. Variant GDScriptAnalyzer::make_expression_reduced_value(GDScriptParser::ExpressionNode *p_expression, bool &is_reduced) {
  4577. Variant value;
  4578. if (p_expression == nullptr) {
  4579. return value;
  4580. }
  4581. if (p_expression->is_constant) {
  4582. is_reduced = true;
  4583. value = p_expression->reduced_value;
  4584. } else if (p_expression->type == GDScriptParser::Node::ARRAY) {
  4585. value = make_array_reduced_value(static_cast<GDScriptParser::ArrayNode *>(p_expression), is_reduced);
  4586. } else if (p_expression->type == GDScriptParser::Node::DICTIONARY) {
  4587. value = make_dictionary_reduced_value(static_cast<GDScriptParser::DictionaryNode *>(p_expression), is_reduced);
  4588. } else if (p_expression->type == GDScriptParser::Node::SUBSCRIPT) {
  4589. value = make_subscript_reduced_value(static_cast<GDScriptParser::SubscriptNode *>(p_expression), is_reduced);
  4590. }
  4591. return value;
  4592. }
  4593. Variant GDScriptAnalyzer::make_array_reduced_value(GDScriptParser::ArrayNode *p_array, bool &is_reduced) {
  4594. Array array = p_array->get_datatype().has_container_element_type(0) ? make_array_from_element_datatype(p_array->get_datatype().get_container_element_type(0)) : Array();
  4595. array.resize(p_array->elements.size());
  4596. for (int i = 0; i < p_array->elements.size(); i++) {
  4597. GDScriptParser::ExpressionNode *element = p_array->elements[i];
  4598. bool is_element_value_reduced = false;
  4599. Variant element_value = make_expression_reduced_value(element, is_element_value_reduced);
  4600. if (!is_element_value_reduced) {
  4601. return Variant();
  4602. }
  4603. array[i] = element_value;
  4604. }
  4605. array.make_read_only();
  4606. is_reduced = true;
  4607. return array;
  4608. }
  4609. Variant GDScriptAnalyzer::make_dictionary_reduced_value(GDScriptParser::DictionaryNode *p_dictionary, bool &is_reduced) {
  4610. Dictionary dictionary = p_dictionary->get_datatype().has_container_element_types()
  4611. ? make_dictionary_from_element_datatype(p_dictionary->get_datatype().get_container_element_type_or_variant(0), p_dictionary->get_datatype().get_container_element_type_or_variant(1))
  4612. : Dictionary();
  4613. for (int i = 0; i < p_dictionary->elements.size(); i++) {
  4614. const GDScriptParser::DictionaryNode::Pair &element = p_dictionary->elements[i];
  4615. bool is_element_key_reduced = false;
  4616. Variant element_key = make_expression_reduced_value(element.key, is_element_key_reduced);
  4617. if (!is_element_key_reduced) {
  4618. return Variant();
  4619. }
  4620. bool is_element_value_reduced = false;
  4621. Variant element_value = make_expression_reduced_value(element.value, is_element_value_reduced);
  4622. if (!is_element_value_reduced) {
  4623. return Variant();
  4624. }
  4625. dictionary[element_key] = element_value;
  4626. }
  4627. dictionary.make_read_only();
  4628. is_reduced = true;
  4629. return dictionary;
  4630. }
  4631. Variant GDScriptAnalyzer::make_subscript_reduced_value(GDScriptParser::SubscriptNode *p_subscript, bool &is_reduced) {
  4632. if (p_subscript->base == nullptr || p_subscript->index == nullptr) {
  4633. return Variant();
  4634. }
  4635. bool is_base_value_reduced = false;
  4636. Variant base_value = make_expression_reduced_value(p_subscript->base, is_base_value_reduced);
  4637. if (!is_base_value_reduced) {
  4638. return Variant();
  4639. }
  4640. if (p_subscript->is_attribute) {
  4641. bool is_valid = false;
  4642. Variant value = base_value.get_named(p_subscript->attribute->name, is_valid);
  4643. if (is_valid) {
  4644. is_reduced = true;
  4645. return value;
  4646. } else {
  4647. return Variant();
  4648. }
  4649. } else {
  4650. bool is_index_value_reduced = false;
  4651. Variant index_value = make_expression_reduced_value(p_subscript->index, is_index_value_reduced);
  4652. if (!is_index_value_reduced) {
  4653. return Variant();
  4654. }
  4655. bool is_valid = false;
  4656. Variant value = base_value.get(index_value, &is_valid);
  4657. if (is_valid) {
  4658. is_reduced = true;
  4659. return value;
  4660. } else {
  4661. return Variant();
  4662. }
  4663. }
  4664. }
  4665. Array GDScriptAnalyzer::make_array_from_element_datatype(const GDScriptParser::DataType &p_element_datatype, const GDScriptParser::Node *p_source_node) {
  4666. Array array;
  4667. if (p_element_datatype.builtin_type == Variant::OBJECT) {
  4668. Ref<Script> script_type = p_element_datatype.script_type;
  4669. if (p_element_datatype.kind == GDScriptParser::DataType::CLASS && script_type.is_null()) {
  4670. Error err = OK;
  4671. Ref<GDScript> scr = get_depended_shallow_script(p_element_datatype.script_path, err);
  4672. if (err) {
  4673. push_error(vformat(R"(Error while getting cache for script "%s".)", p_element_datatype.script_path), p_source_node);
  4674. return array;
  4675. }
  4676. script_type.reference_ptr(scr->find_class(p_element_datatype.class_type->fqcn));
  4677. }
  4678. array.set_typed(p_element_datatype.builtin_type, p_element_datatype.native_type, script_type);
  4679. } else {
  4680. array.set_typed(p_element_datatype.builtin_type, StringName(), Variant());
  4681. }
  4682. return array;
  4683. }
  4684. Dictionary GDScriptAnalyzer::make_dictionary_from_element_datatype(const GDScriptParser::DataType &p_key_element_datatype, const GDScriptParser::DataType &p_value_element_datatype, const GDScriptParser::Node *p_source_node) {
  4685. Dictionary dictionary;
  4686. StringName key_name;
  4687. Variant key_script;
  4688. StringName value_name;
  4689. Variant value_script;
  4690. if (p_key_element_datatype.builtin_type == Variant::OBJECT) {
  4691. Ref<Script> script_type = p_key_element_datatype.script_type;
  4692. if (p_key_element_datatype.kind == GDScriptParser::DataType::CLASS && script_type.is_null()) {
  4693. Error err = OK;
  4694. Ref<GDScript> scr = get_depended_shallow_script(p_key_element_datatype.script_path, err);
  4695. if (err) {
  4696. push_error(vformat(R"(Error while getting cache for script "%s".)", p_key_element_datatype.script_path), p_source_node);
  4697. return dictionary;
  4698. }
  4699. script_type.reference_ptr(scr->find_class(p_key_element_datatype.class_type->fqcn));
  4700. }
  4701. key_name = p_key_element_datatype.native_type;
  4702. key_script = script_type;
  4703. }
  4704. if (p_value_element_datatype.builtin_type == Variant::OBJECT) {
  4705. Ref<Script> script_type = p_value_element_datatype.script_type;
  4706. if (p_value_element_datatype.kind == GDScriptParser::DataType::CLASS && script_type.is_null()) {
  4707. Error err = OK;
  4708. Ref<GDScript> scr = get_depended_shallow_script(p_value_element_datatype.script_path, err);
  4709. if (err) {
  4710. push_error(vformat(R"(Error while getting cache for script "%s".)", p_value_element_datatype.script_path), p_source_node);
  4711. return dictionary;
  4712. }
  4713. script_type.reference_ptr(scr->find_class(p_value_element_datatype.class_type->fqcn));
  4714. }
  4715. value_name = p_value_element_datatype.native_type;
  4716. value_script = script_type;
  4717. }
  4718. dictionary.set_typed(p_key_element_datatype.builtin_type, key_name, key_script, p_value_element_datatype.builtin_type, value_name, value_script);
  4719. return dictionary;
  4720. }
  4721. Variant GDScriptAnalyzer::make_variable_default_value(GDScriptParser::VariableNode *p_variable) {
  4722. Variant result = Variant();
  4723. if (p_variable->initializer) {
  4724. bool is_initializer_value_reduced = false;
  4725. Variant initializer_value = make_expression_reduced_value(p_variable->initializer, is_initializer_value_reduced);
  4726. if (is_initializer_value_reduced) {
  4727. result = initializer_value;
  4728. }
  4729. } else {
  4730. GDScriptParser::DataType datatype = p_variable->get_datatype();
  4731. if (datatype.is_hard_type()) {
  4732. if (datatype.kind == GDScriptParser::DataType::BUILTIN && datatype.builtin_type != Variant::OBJECT) {
  4733. if (datatype.builtin_type == Variant::ARRAY && datatype.has_container_element_type(0)) {
  4734. result = make_array_from_element_datatype(datatype.get_container_element_type(0));
  4735. } else if (datatype.builtin_type == Variant::DICTIONARY && datatype.has_container_element_types()) {
  4736. GDScriptParser::DataType key = datatype.get_container_element_type_or_variant(0);
  4737. GDScriptParser::DataType value = datatype.get_container_element_type_or_variant(1);
  4738. result = make_dictionary_from_element_datatype(key, value);
  4739. } else {
  4740. VariantInternal::initialize(&result, datatype.builtin_type);
  4741. }
  4742. } else if (datatype.kind == GDScriptParser::DataType::ENUM) {
  4743. result = 0;
  4744. }
  4745. }
  4746. }
  4747. return result;
  4748. }
  4749. GDScriptParser::DataType GDScriptAnalyzer::type_from_variant(const Variant &p_value, const GDScriptParser::Node *p_source) {
  4750. GDScriptParser::DataType result;
  4751. result.is_constant = true;
  4752. result.kind = GDScriptParser::DataType::BUILTIN;
  4753. result.builtin_type = p_value.get_type();
  4754. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT; // Constant has explicit type.
  4755. if (p_value.get_type() == Variant::ARRAY) {
  4756. const Array &array = p_value;
  4757. if (array.get_typed_script()) {
  4758. result.set_container_element_type(0, type_from_metatype(make_script_meta_type(array.get_typed_script())));
  4759. } else if (array.get_typed_class_name()) {
  4760. result.set_container_element_type(0, type_from_metatype(make_native_meta_type(array.get_typed_class_name())));
  4761. } else if (array.get_typed_builtin() != Variant::NIL) {
  4762. result.set_container_element_type(0, type_from_metatype(make_builtin_meta_type((Variant::Type)array.get_typed_builtin())));
  4763. }
  4764. } else if (p_value.get_type() == Variant::DICTIONARY) {
  4765. const Dictionary &dict = p_value;
  4766. if (dict.get_typed_key_script()) {
  4767. result.set_container_element_type(0, type_from_metatype(make_script_meta_type(dict.get_typed_key_script())));
  4768. } else if (dict.get_typed_key_class_name()) {
  4769. result.set_container_element_type(0, type_from_metatype(make_native_meta_type(dict.get_typed_key_class_name())));
  4770. } else if (dict.get_typed_key_builtin() != Variant::NIL) {
  4771. result.set_container_element_type(0, type_from_metatype(make_builtin_meta_type((Variant::Type)dict.get_typed_key_builtin())));
  4772. }
  4773. if (dict.get_typed_value_script()) {
  4774. result.set_container_element_type(1, type_from_metatype(make_script_meta_type(dict.get_typed_value_script())));
  4775. } else if (dict.get_typed_value_class_name()) {
  4776. result.set_container_element_type(1, type_from_metatype(make_native_meta_type(dict.get_typed_value_class_name())));
  4777. } else if (dict.get_typed_value_builtin() != Variant::NIL) {
  4778. result.set_container_element_type(1, type_from_metatype(make_builtin_meta_type((Variant::Type)dict.get_typed_value_builtin())));
  4779. }
  4780. } else if (p_value.get_type() == Variant::OBJECT) {
  4781. // Object is treated as a native type, not a builtin type.
  4782. result.kind = GDScriptParser::DataType::NATIVE;
  4783. Object *obj = p_value;
  4784. if (!obj) {
  4785. return GDScriptParser::DataType();
  4786. }
  4787. result.native_type = obj->get_class_name();
  4788. Ref<Script> scr = p_value; // Check if value is a script itself.
  4789. if (scr.is_valid()) {
  4790. result.is_meta_type = true;
  4791. } else {
  4792. result.is_meta_type = false;
  4793. scr = obj->get_script();
  4794. }
  4795. if (scr.is_valid()) {
  4796. Ref<GDScript> gds = scr;
  4797. if (gds.is_valid()) {
  4798. // This might be an inner class, so we want to get the parser for the root.
  4799. // But still get the inner class from that tree.
  4800. String script_path = gds->get_script_path();
  4801. Ref<GDScriptParserRef> ref = parser->get_depended_parser_for(script_path);
  4802. if (ref.is_null()) {
  4803. push_error(vformat(R"(Could not find script "%s".)", script_path), p_source);
  4804. GDScriptParser::DataType error_type;
  4805. error_type.kind = GDScriptParser::DataType::VARIANT;
  4806. return error_type;
  4807. }
  4808. Error err = ref->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  4809. GDScriptParser::ClassNode *found = nullptr;
  4810. if (err == OK) {
  4811. found = ref->get_parser()->find_class(gds->fully_qualified_name);
  4812. if (found != nullptr) {
  4813. err = resolve_class_inheritance(found, p_source);
  4814. }
  4815. }
  4816. if (err || found == nullptr) {
  4817. push_error(vformat(R"(Could not resolve script "%s".)", script_path), p_source);
  4818. GDScriptParser::DataType error_type;
  4819. error_type.kind = GDScriptParser::DataType::VARIANT;
  4820. return error_type;
  4821. }
  4822. result.kind = GDScriptParser::DataType::CLASS;
  4823. result.native_type = found->get_datatype().native_type;
  4824. result.class_type = found;
  4825. result.script_path = ref->get_parser()->script_path;
  4826. } else {
  4827. result.kind = GDScriptParser::DataType::SCRIPT;
  4828. result.native_type = scr->get_instance_base_type();
  4829. result.script_path = scr->get_path();
  4830. }
  4831. result.script_type = scr;
  4832. } else {
  4833. result.kind = GDScriptParser::DataType::NATIVE;
  4834. if (result.native_type == GDScriptNativeClass::get_class_static()) {
  4835. result.is_meta_type = true;
  4836. }
  4837. }
  4838. }
  4839. return result;
  4840. }
  4841. GDScriptParser::DataType GDScriptAnalyzer::type_from_metatype(const GDScriptParser::DataType &p_meta_type) {
  4842. GDScriptParser::DataType result = p_meta_type;
  4843. result.is_meta_type = false;
  4844. result.is_pseudo_type = false;
  4845. if (p_meta_type.kind == GDScriptParser::DataType::ENUM) {
  4846. result.builtin_type = Variant::INT;
  4847. } else {
  4848. result.is_constant = false;
  4849. }
  4850. return result;
  4851. }
  4852. GDScriptParser::DataType GDScriptAnalyzer::type_from_property(const PropertyInfo &p_property, bool p_is_arg, bool p_is_readonly) const {
  4853. GDScriptParser::DataType result;
  4854. result.is_read_only = p_is_readonly;
  4855. result.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4856. if (p_property.type == Variant::NIL && (p_is_arg || (p_property.usage & PROPERTY_USAGE_NIL_IS_VARIANT))) {
  4857. // Variant
  4858. result.kind = GDScriptParser::DataType::VARIANT;
  4859. return result;
  4860. }
  4861. result.builtin_type = p_property.type;
  4862. if (p_property.type == Variant::OBJECT) {
  4863. if (ScriptServer::is_global_class(p_property.class_name)) {
  4864. result.kind = GDScriptParser::DataType::SCRIPT;
  4865. result.script_path = ScriptServer::get_global_class_path(p_property.class_name);
  4866. result.native_type = ScriptServer::get_global_class_native_base(p_property.class_name);
  4867. Ref<Script> scr = ResourceLoader::load(ScriptServer::get_global_class_path(p_property.class_name));
  4868. if (scr.is_valid()) {
  4869. result.script_type = scr;
  4870. }
  4871. } else {
  4872. result.kind = GDScriptParser::DataType::NATIVE;
  4873. result.native_type = p_property.class_name == StringName() ? "Object" : p_property.class_name;
  4874. }
  4875. } else {
  4876. result.kind = GDScriptParser::DataType::BUILTIN;
  4877. result.builtin_type = p_property.type;
  4878. if (p_property.type == Variant::ARRAY && p_property.hint == PROPERTY_HINT_ARRAY_TYPE) {
  4879. // Check element type.
  4880. StringName elem_type_name = p_property.hint_string;
  4881. GDScriptParser::DataType elem_type;
  4882. elem_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4883. Variant::Type elem_builtin_type = GDScriptParser::get_builtin_type(elem_type_name);
  4884. if (elem_builtin_type < Variant::VARIANT_MAX) {
  4885. // Builtin type.
  4886. elem_type.kind = GDScriptParser::DataType::BUILTIN;
  4887. elem_type.builtin_type = elem_builtin_type;
  4888. } else if (class_exists(elem_type_name)) {
  4889. elem_type.kind = GDScriptParser::DataType::NATIVE;
  4890. elem_type.builtin_type = Variant::OBJECT;
  4891. elem_type.native_type = elem_type_name;
  4892. } else if (ScriptServer::is_global_class(elem_type_name)) {
  4893. // Just load this as it shouldn't be a GDScript.
  4894. Ref<Script> script = ResourceLoader::load(ScriptServer::get_global_class_path(elem_type_name));
  4895. elem_type.kind = GDScriptParser::DataType::SCRIPT;
  4896. elem_type.builtin_type = Variant::OBJECT;
  4897. elem_type.native_type = script->get_instance_base_type();
  4898. elem_type.script_type = script;
  4899. } else {
  4900. ERR_FAIL_V_MSG(result, "Could not find element type from property hint of a typed array.");
  4901. }
  4902. elem_type.is_constant = false;
  4903. result.set_container_element_type(0, elem_type);
  4904. } else if (p_property.type == Variant::DICTIONARY && p_property.hint == PROPERTY_HINT_DICTIONARY_TYPE) {
  4905. // Check element type.
  4906. StringName key_elem_type_name = p_property.hint_string.get_slice(";", 0);
  4907. GDScriptParser::DataType key_elem_type;
  4908. key_elem_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4909. Variant::Type key_elem_builtin_type = GDScriptParser::get_builtin_type(key_elem_type_name);
  4910. if (key_elem_builtin_type < Variant::VARIANT_MAX) {
  4911. // Builtin type.
  4912. key_elem_type.kind = GDScriptParser::DataType::BUILTIN;
  4913. key_elem_type.builtin_type = key_elem_builtin_type;
  4914. } else if (class_exists(key_elem_type_name)) {
  4915. key_elem_type.kind = GDScriptParser::DataType::NATIVE;
  4916. key_elem_type.builtin_type = Variant::OBJECT;
  4917. key_elem_type.native_type = key_elem_type_name;
  4918. } else if (ScriptServer::is_global_class(key_elem_type_name)) {
  4919. // Just load this as it shouldn't be a GDScript.
  4920. Ref<Script> script = ResourceLoader::load(ScriptServer::get_global_class_path(key_elem_type_name));
  4921. key_elem_type.kind = GDScriptParser::DataType::SCRIPT;
  4922. key_elem_type.builtin_type = Variant::OBJECT;
  4923. key_elem_type.native_type = script->get_instance_base_type();
  4924. key_elem_type.script_type = script;
  4925. } else {
  4926. ERR_FAIL_V_MSG(result, "Could not find element type from property hint of a typed dictionary.");
  4927. }
  4928. key_elem_type.is_constant = false;
  4929. StringName value_elem_type_name = p_property.hint_string.get_slice(";", 1);
  4930. GDScriptParser::DataType value_elem_type;
  4931. value_elem_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  4932. Variant::Type value_elem_builtin_type = GDScriptParser::get_builtin_type(value_elem_type_name);
  4933. if (value_elem_builtin_type < Variant::VARIANT_MAX) {
  4934. // Builtin type.
  4935. value_elem_type.kind = GDScriptParser::DataType::BUILTIN;
  4936. value_elem_type.builtin_type = value_elem_builtin_type;
  4937. } else if (class_exists(value_elem_type_name)) {
  4938. value_elem_type.kind = GDScriptParser::DataType::NATIVE;
  4939. value_elem_type.builtin_type = Variant::OBJECT;
  4940. value_elem_type.native_type = value_elem_type_name;
  4941. } else if (ScriptServer::is_global_class(value_elem_type_name)) {
  4942. // Just load this as it shouldn't be a GDScript.
  4943. Ref<Script> script = ResourceLoader::load(ScriptServer::get_global_class_path(value_elem_type_name));
  4944. value_elem_type.kind = GDScriptParser::DataType::SCRIPT;
  4945. value_elem_type.builtin_type = Variant::OBJECT;
  4946. value_elem_type.native_type = script->get_instance_base_type();
  4947. value_elem_type.script_type = script;
  4948. } else {
  4949. ERR_FAIL_V_MSG(result, "Could not find element type from property hint of a typed dictionary.");
  4950. }
  4951. value_elem_type.is_constant = false;
  4952. result.set_container_element_type(0, key_elem_type);
  4953. result.set_container_element_type(1, value_elem_type);
  4954. } else if (p_property.type == Variant::INT) {
  4955. // Check if it's enum.
  4956. if ((p_property.usage & PROPERTY_USAGE_CLASS_IS_ENUM) && p_property.class_name != StringName()) {
  4957. if (CoreConstants::is_global_enum(p_property.class_name)) {
  4958. result = make_global_enum_type(p_property.class_name, StringName(), false);
  4959. result.is_constant = false;
  4960. } else {
  4961. Vector<String> names = String(p_property.class_name).split(ENUM_SEPARATOR);
  4962. if (names.size() == 2) {
  4963. result = make_native_enum_type(names[1], names[0], false);
  4964. result.is_constant = false;
  4965. }
  4966. }
  4967. }
  4968. // PROPERTY_USAGE_CLASS_IS_BITFIELD: BitField[T] isn't supported (yet?), use plain int.
  4969. }
  4970. }
  4971. return result;
  4972. }
  4973. 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, BitField<MethodFlags> &r_method_flags, StringName *r_native_class) {
  4974. r_method_flags = METHOD_FLAGS_DEFAULT;
  4975. r_default_arg_count = 0;
  4976. if (r_native_class) {
  4977. *r_native_class = StringName();
  4978. }
  4979. StringName function_name = p_function;
  4980. bool was_enum = false;
  4981. if (p_base_type.kind == GDScriptParser::DataType::ENUM) {
  4982. was_enum = true;
  4983. if (p_base_type.is_meta_type) {
  4984. // Enum type can be treated as a dictionary value.
  4985. p_base_type.kind = GDScriptParser::DataType::BUILTIN;
  4986. p_base_type.is_meta_type = false;
  4987. } else {
  4988. push_error("Cannot call function on enum value.", p_source);
  4989. return false;
  4990. }
  4991. }
  4992. if (p_base_type.kind == GDScriptParser::DataType::BUILTIN) {
  4993. // Construct a base type to get methods.
  4994. Callable::CallError err;
  4995. Variant dummy;
  4996. Variant::construct(p_base_type.builtin_type, dummy, nullptr, 0, err);
  4997. if (err.error != Callable::CallError::CALL_OK) {
  4998. ERR_FAIL_V_MSG(false, "Could not construct base Variant type.");
  4999. }
  5000. List<MethodInfo> methods;
  5001. dummy.get_method_list(&methods);
  5002. for (const MethodInfo &E : methods) {
  5003. if (E.name == p_function) {
  5004. function_signature_from_info(E, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  5005. // Cannot use non-const methods on enums.
  5006. if (!r_method_flags.has_flag(METHOD_FLAG_STATIC) && was_enum && !(E.flags & METHOD_FLAG_CONST)) {
  5007. push_error(vformat(R"*(Cannot call non-const Dictionary function "%s()" on enum "%s".)*", p_function, p_base_type.enum_type), p_source);
  5008. }
  5009. return true;
  5010. }
  5011. }
  5012. return false;
  5013. }
  5014. StringName base_native = p_base_type.native_type;
  5015. if (base_native != StringName()) {
  5016. // Empty native class might happen in some Script implementations.
  5017. // Just ignore it.
  5018. if (!class_exists(base_native)) {
  5019. push_error(vformat("Native class %s used in script doesn't exist or isn't exposed.", base_native), p_source);
  5020. return false;
  5021. } else if (p_is_constructor && ClassDB::is_abstract(base_native)) {
  5022. if (p_base_type.kind == GDScriptParser::DataType::CLASS) {
  5023. 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);
  5024. } else if (p_base_type.kind == GDScriptParser::DataType::SCRIPT) {
  5025. 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);
  5026. } else {
  5027. push_error(vformat(R"(Native class "%s" cannot be constructed as it is abstract.)", base_native), p_source);
  5028. }
  5029. return false;
  5030. }
  5031. }
  5032. if (p_is_constructor) {
  5033. function_name = GDScriptLanguage::get_singleton()->strings._init;
  5034. r_method_flags.set_flag(METHOD_FLAG_STATIC);
  5035. }
  5036. GDScriptParser::ClassNode *base_class = p_base_type.class_type;
  5037. GDScriptParser::FunctionNode *found_function = nullptr;
  5038. while (found_function == nullptr && base_class != nullptr) {
  5039. if (base_class->has_member(function_name)) {
  5040. if (base_class->get_member(function_name).type != GDScriptParser::ClassNode::Member::FUNCTION) {
  5041. // TODO: If this is Callable it can have a better error message.
  5042. push_error(vformat(R"(Member "%s" is not a function.)", function_name), p_source);
  5043. return false;
  5044. }
  5045. resolve_class_member(base_class, function_name, p_source);
  5046. found_function = base_class->get_member(function_name).function;
  5047. }
  5048. resolve_class_inheritance(base_class, p_source);
  5049. base_class = base_class->base_type.class_type;
  5050. }
  5051. if (found_function != nullptr) {
  5052. if (p_is_constructor || found_function->is_static) {
  5053. r_method_flags.set_flag(METHOD_FLAG_STATIC);
  5054. }
  5055. for (int i = 0; i < found_function->parameters.size(); i++) {
  5056. r_par_types.push_back(found_function->parameters[i]->get_datatype());
  5057. if (found_function->parameters[i]->initializer != nullptr) {
  5058. r_default_arg_count++;
  5059. }
  5060. }
  5061. r_return_type = p_is_constructor ? p_base_type : found_function->get_datatype();
  5062. r_return_type.is_meta_type = false;
  5063. r_return_type.is_coroutine = found_function->is_coroutine;
  5064. return true;
  5065. }
  5066. Ref<Script> base_script = p_base_type.script_type;
  5067. while (base_script.is_valid() && base_script->has_method(function_name)) {
  5068. MethodInfo info = base_script->get_method_info(function_name);
  5069. if (!(info == MethodInfo())) {
  5070. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  5071. }
  5072. base_script = base_script->get_base_script();
  5073. }
  5074. // If the base is a script, it might be trying to access members of the Script class itself.
  5075. if (p_base_type.is_meta_type && !p_is_constructor && (p_base_type.kind == GDScriptParser::DataType::SCRIPT || p_base_type.kind == GDScriptParser::DataType::CLASS)) {
  5076. MethodInfo info;
  5077. StringName script_class = p_base_type.kind == GDScriptParser::DataType::SCRIPT ? p_base_type.script_type->get_class_name() : StringName(GDScript::get_class_static());
  5078. if (ClassDB::get_method_info(script_class, function_name, &info)) {
  5079. return function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  5080. }
  5081. }
  5082. if (p_is_constructor) {
  5083. // Native types always have a default constructor.
  5084. r_return_type = p_base_type;
  5085. r_return_type.type_source = GDScriptParser::DataType::ANNOTATED_EXPLICIT;
  5086. r_return_type.is_meta_type = false;
  5087. return true;
  5088. }
  5089. MethodInfo info;
  5090. if (ClassDB::get_method_info(base_native, function_name, &info)) {
  5091. bool valid = function_signature_from_info(info, r_return_type, r_par_types, r_default_arg_count, r_method_flags);
  5092. if (valid && Engine::get_singleton()->has_singleton(base_native)) {
  5093. r_method_flags.set_flag(METHOD_FLAG_STATIC);
  5094. }
  5095. #ifdef DEBUG_ENABLED
  5096. MethodBind *native_method = ClassDB::get_method(base_native, function_name);
  5097. if (native_method && r_native_class) {
  5098. *r_native_class = native_method->get_instance_class();
  5099. }
  5100. #endif
  5101. return valid;
  5102. }
  5103. return false;
  5104. }
  5105. 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, BitField<MethodFlags> &r_method_flags) {
  5106. r_return_type = type_from_property(p_info.return_val);
  5107. r_default_arg_count = p_info.default_arguments.size();
  5108. r_method_flags = p_info.flags;
  5109. for (const PropertyInfo &E : p_info.arguments) {
  5110. r_par_types.push_back(type_from_property(E, true));
  5111. }
  5112. return true;
  5113. }
  5114. void GDScriptAnalyzer::validate_call_arg(const MethodInfo &p_method, const GDScriptParser::CallNode *p_call) {
  5115. List<GDScriptParser::DataType> arg_types;
  5116. for (const PropertyInfo &E : p_method.arguments) {
  5117. arg_types.push_back(type_from_property(E, true));
  5118. }
  5119. validate_call_arg(arg_types, p_method.default_arguments.size(), (p_method.flags & METHOD_FLAG_VARARG) != 0, p_call);
  5120. }
  5121. 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) {
  5122. if (p_call->arguments.size() < p_par_types.size() - p_default_args_count) {
  5123. 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);
  5124. }
  5125. if (!p_is_vararg && p_call->arguments.size() > p_par_types.size()) {
  5126. 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()]);
  5127. }
  5128. List<GDScriptParser::DataType>::ConstIterator par_itr = p_par_types.begin();
  5129. for (int i = 0; i < p_call->arguments.size(); ++par_itr, ++i) {
  5130. if (i >= p_par_types.size()) {
  5131. // Already on vararg place.
  5132. break;
  5133. }
  5134. GDScriptParser::DataType par_type = *par_itr;
  5135. if (par_type.is_hard_type() && p_call->arguments[i]->is_constant) {
  5136. update_const_expression_builtin_type(p_call->arguments[i], par_type, "pass");
  5137. }
  5138. GDScriptParser::DataType arg_type = p_call->arguments[i]->get_datatype();
  5139. if (arg_type.is_variant() || !arg_type.is_hard_type()) {
  5140. #ifdef DEBUG_ENABLED
  5141. // Argument can be anything, so this is unsafe (unless the parameter is a hard variant).
  5142. if (!(par_type.is_hard_type() && par_type.is_variant())) {
  5143. mark_node_unsafe(p_call->arguments[i]);
  5144. parser->push_warning(p_call->arguments[i], GDScriptWarning::UNSAFE_CALL_ARGUMENT, itos(i + 1), "function", p_call->function_name, par_type.to_string(), arg_type.to_string_strict());
  5145. }
  5146. #endif
  5147. } else if (par_type.is_hard_type() && !is_type_compatible(par_type, arg_type, true)) {
  5148. if (!is_type_compatible(arg_type, par_type)) {
  5149. push_error(vformat(R"*(Invalid argument for "%s()" function: argument %d should be "%s" but is "%s".)*",
  5150. p_call->function_name, i + 1, par_type.to_string(), arg_type.to_string()),
  5151. p_call->arguments[i]);
  5152. #ifdef DEBUG_ENABLED
  5153. } else {
  5154. // Supertypes are acceptable for dynamic compliance, but it's unsafe.
  5155. mark_node_unsafe(p_call);
  5156. parser->push_warning(p_call->arguments[i], GDScriptWarning::UNSAFE_CALL_ARGUMENT, itos(i + 1), "function", p_call->function_name, par_type.to_string(), arg_type.to_string_strict());
  5157. #endif
  5158. }
  5159. #ifdef DEBUG_ENABLED
  5160. } 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) {
  5161. parser->push_warning(p_call->arguments[i], GDScriptWarning::NARROWING_CONVERSION, p_call->function_name);
  5162. #endif
  5163. }
  5164. }
  5165. }
  5166. #ifdef DEBUG_ENABLED
  5167. void GDScriptAnalyzer::is_shadowing(GDScriptParser::IdentifierNode *p_identifier, const String &p_context, const bool p_in_local_scope) {
  5168. const StringName &name = p_identifier->name;
  5169. {
  5170. List<MethodInfo> gdscript_funcs;
  5171. GDScriptLanguage::get_singleton()->get_public_functions(&gdscript_funcs);
  5172. for (MethodInfo &info : gdscript_funcs) {
  5173. if (info.name == name) {
  5174. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "built-in function");
  5175. return;
  5176. }
  5177. }
  5178. if (Variant::has_utility_function(name)) {
  5179. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "built-in function");
  5180. return;
  5181. } else if (ClassDB::class_exists(name)) {
  5182. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "native class");
  5183. return;
  5184. } else if (ScriptServer::is_global_class(name)) {
  5185. String class_path = ScriptServer::get_global_class_path(name).get_file();
  5186. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, vformat(R"(global class defined in "%s")", class_path));
  5187. return;
  5188. } else if (GDScriptParser::get_builtin_type(name) < Variant::VARIANT_MAX) {
  5189. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_GLOBAL_IDENTIFIER, p_context, name, "built-in type");
  5190. return;
  5191. }
  5192. }
  5193. const GDScriptParser::DataType current_class_type = parser->current_class->get_datatype();
  5194. if (p_in_local_scope) {
  5195. GDScriptParser::ClassNode *base_class = current_class_type.class_type;
  5196. if (base_class != nullptr) {
  5197. if (base_class->has_member(name)) {
  5198. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE, p_context, p_identifier->name, base_class->get_member(name).get_type_name(), itos(base_class->get_member(name).get_line()));
  5199. return;
  5200. }
  5201. base_class = base_class->base_type.class_type;
  5202. }
  5203. while (base_class != nullptr) {
  5204. if (base_class->has_member(name)) {
  5205. String base_class_name = base_class->get_global_name();
  5206. if (base_class_name.is_empty()) {
  5207. base_class_name = base_class->fqcn;
  5208. }
  5209. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, base_class->get_member(name).get_type_name(), itos(base_class->get_member(name).get_line()), base_class_name);
  5210. return;
  5211. }
  5212. base_class = base_class->base_type.class_type;
  5213. }
  5214. }
  5215. StringName native_base_class = current_class_type.native_type;
  5216. while (native_base_class != StringName()) {
  5217. ERR_FAIL_COND_MSG(!class_exists(native_base_class), "Non-existent native base class.");
  5218. if (ClassDB::has_method(native_base_class, name, true)) {
  5219. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "method", native_base_class);
  5220. return;
  5221. } else if (ClassDB::has_signal(native_base_class, name, true)) {
  5222. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "signal", native_base_class);
  5223. return;
  5224. } else if (ClassDB::has_property(native_base_class, name, true)) {
  5225. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "property", native_base_class);
  5226. return;
  5227. } else if (ClassDB::has_integer_constant(native_base_class, name, true)) {
  5228. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "constant", native_base_class);
  5229. return;
  5230. } else if (ClassDB::has_enum(native_base_class, name, true)) {
  5231. parser->push_warning(p_identifier, GDScriptWarning::SHADOWED_VARIABLE_BASE_CLASS, p_context, p_identifier->name, "enum", native_base_class);
  5232. return;
  5233. }
  5234. native_base_class = ClassDB::get_parent_class(native_base_class);
  5235. }
  5236. }
  5237. #endif // DEBUG_ENABLED
  5238. GDScriptParser::DataType GDScriptAnalyzer::get_operation_type(Variant::Operator p_operation, const GDScriptParser::DataType &p_a, bool &r_valid, const GDScriptParser::Node *p_source) {
  5239. // Unary version.
  5240. GDScriptParser::DataType nil_type;
  5241. nil_type.builtin_type = Variant::NIL;
  5242. nil_type.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  5243. return get_operation_type(p_operation, p_a, nil_type, r_valid, p_source);
  5244. }
  5245. 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) {
  5246. if (p_operation == Variant::OP_AND || p_operation == Variant::OP_OR) {
  5247. // Those work for any type of argument and always return a boolean.
  5248. // They don't use the Variant operator since they have short-circuit semantics.
  5249. r_valid = true;
  5250. GDScriptParser::DataType result;
  5251. result.type_source = GDScriptParser::DataType::ANNOTATED_INFERRED;
  5252. result.kind = GDScriptParser::DataType::BUILTIN;
  5253. result.builtin_type = Variant::BOOL;
  5254. return result;
  5255. }
  5256. Variant::Type a_type = p_a.builtin_type;
  5257. Variant::Type b_type = p_b.builtin_type;
  5258. if (p_a.kind == GDScriptParser::DataType::ENUM) {
  5259. if (p_a.is_meta_type) {
  5260. a_type = Variant::DICTIONARY;
  5261. } else {
  5262. a_type = Variant::INT;
  5263. }
  5264. }
  5265. if (p_b.kind == GDScriptParser::DataType::ENUM) {
  5266. if (p_b.is_meta_type) {
  5267. b_type = Variant::DICTIONARY;
  5268. } else {
  5269. b_type = Variant::INT;
  5270. }
  5271. }
  5272. GDScriptParser::DataType result;
  5273. bool hard_operation = p_a.is_hard_type() && p_b.is_hard_type();
  5274. if (p_operation == Variant::OP_ADD && a_type == Variant::ARRAY && b_type == Variant::ARRAY) {
  5275. if (p_a.has_container_element_type(0) && p_b.has_container_element_type(0) && p_a.get_container_element_type(0) == p_b.get_container_element_type(0)) {
  5276. r_valid = true;
  5277. result = p_a;
  5278. result.type_source = hard_operation ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  5279. return result;
  5280. }
  5281. }
  5282. Variant::ValidatedOperatorEvaluator op_eval = Variant::get_validated_operator_evaluator(p_operation, a_type, b_type);
  5283. bool validated = op_eval != nullptr;
  5284. if (validated) {
  5285. r_valid = true;
  5286. result.type_source = hard_operation ? GDScriptParser::DataType::ANNOTATED_INFERRED : GDScriptParser::DataType::INFERRED;
  5287. result.kind = GDScriptParser::DataType::BUILTIN;
  5288. result.builtin_type = Variant::get_operator_return_type(p_operation, a_type, b_type);
  5289. } else {
  5290. r_valid = !hard_operation;
  5291. result.kind = GDScriptParser::DataType::VARIANT;
  5292. }
  5293. return result;
  5294. }
  5295. 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) {
  5296. #ifdef DEBUG_ENABLED
  5297. if (p_source_node) {
  5298. if (p_target.kind == GDScriptParser::DataType::ENUM) {
  5299. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::INT) {
  5300. parser->push_warning(p_source_node, GDScriptWarning::INT_AS_ENUM_WITHOUT_CAST);
  5301. }
  5302. }
  5303. }
  5304. #endif
  5305. return check_type_compatibility(p_target, p_source, p_allow_implicit_conversion, p_source_node);
  5306. }
  5307. // TODO: Add safe/unsafe return variable (for variant cases)
  5308. bool GDScriptAnalyzer::check_type_compatibility(const GDScriptParser::DataType &p_target, const GDScriptParser::DataType &p_source, bool p_allow_implicit_conversion, const GDScriptParser::Node *p_source_node) {
  5309. // These return "true" so it doesn't affect users negatively.
  5310. ERR_FAIL_COND_V_MSG(!p_target.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset target type");
  5311. ERR_FAIL_COND_V_MSG(!p_source.is_set(), true, "Parser bug (please report): Trying to check compatibility of unset value type");
  5312. if (p_target.kind == GDScriptParser::DataType::VARIANT) {
  5313. // Variant can receive anything.
  5314. return true;
  5315. }
  5316. if (p_source.kind == GDScriptParser::DataType::VARIANT) {
  5317. // TODO: This is acceptable but unsafe. Make sure unsafe line is set.
  5318. return true;
  5319. }
  5320. if (p_target.kind == GDScriptParser::DataType::BUILTIN) {
  5321. bool valid = p_source.kind == GDScriptParser::DataType::BUILTIN && p_target.builtin_type == p_source.builtin_type;
  5322. if (!valid && p_allow_implicit_conversion) {
  5323. valid = Variant::can_convert_strict(p_source.builtin_type, p_target.builtin_type);
  5324. }
  5325. if (!valid && p_target.builtin_type == Variant::INT && p_source.kind == GDScriptParser::DataType::ENUM && !p_source.is_meta_type) {
  5326. // Enum value is also integer.
  5327. valid = true;
  5328. }
  5329. if (valid && p_target.builtin_type == Variant::ARRAY && p_source.builtin_type == Variant::ARRAY) {
  5330. // Check the element type.
  5331. if (p_target.has_container_element_type(0) && p_source.has_container_element_type(0)) {
  5332. valid = p_target.get_container_element_type(0) == p_source.get_container_element_type(0);
  5333. }
  5334. }
  5335. if (valid && p_target.builtin_type == Variant::DICTIONARY && p_source.builtin_type == Variant::DICTIONARY) {
  5336. // Check the element types.
  5337. if (p_target.has_container_element_type(0) && p_source.has_container_element_type(0)) {
  5338. valid = p_target.get_container_element_type(0) == p_source.get_container_element_type(0);
  5339. }
  5340. if (valid && p_target.has_container_element_type(1) && p_source.has_container_element_type(1)) {
  5341. valid = p_target.get_container_element_type(1) == p_source.get_container_element_type(1);
  5342. }
  5343. }
  5344. return valid;
  5345. }
  5346. if (p_target.kind == GDScriptParser::DataType::ENUM) {
  5347. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::INT) {
  5348. return true;
  5349. }
  5350. if (p_source.kind == GDScriptParser::DataType::ENUM) {
  5351. if (p_source.native_type == p_target.native_type) {
  5352. return true;
  5353. }
  5354. }
  5355. return false;
  5356. }
  5357. // From here on the target type is an object, so we have to test polymorphism.
  5358. if (p_source.kind == GDScriptParser::DataType::BUILTIN && p_source.builtin_type == Variant::NIL) {
  5359. // null is acceptable in object.
  5360. return true;
  5361. }
  5362. StringName src_native;
  5363. Ref<Script> src_script;
  5364. const GDScriptParser::ClassNode *src_class = nullptr;
  5365. switch (p_source.kind) {
  5366. case GDScriptParser::DataType::NATIVE:
  5367. if (p_target.kind != GDScriptParser::DataType::NATIVE) {
  5368. // Non-native class cannot be supertype of native.
  5369. return false;
  5370. }
  5371. if (p_source.is_meta_type) {
  5372. src_native = GDScriptNativeClass::get_class_static();
  5373. } else {
  5374. src_native = p_source.native_type;
  5375. }
  5376. break;
  5377. case GDScriptParser::DataType::SCRIPT:
  5378. if (p_target.kind == GDScriptParser::DataType::CLASS) {
  5379. // A script type cannot be a subtype of a GDScript class.
  5380. return false;
  5381. }
  5382. if (p_source.script_type.is_null()) {
  5383. return false;
  5384. }
  5385. if (p_source.is_meta_type) {
  5386. src_native = p_source.script_type->get_class_name();
  5387. } else {
  5388. src_script = p_source.script_type;
  5389. src_native = src_script->get_instance_base_type();
  5390. }
  5391. break;
  5392. case GDScriptParser::DataType::CLASS:
  5393. if (p_source.is_meta_type) {
  5394. src_native = GDScript::get_class_static();
  5395. } else {
  5396. src_class = p_source.class_type;
  5397. const GDScriptParser::ClassNode *base = src_class;
  5398. while (base->base_type.kind == GDScriptParser::DataType::CLASS) {
  5399. base = base->base_type.class_type;
  5400. }
  5401. src_native = base->base_type.native_type;
  5402. src_script = base->base_type.script_type;
  5403. }
  5404. break;
  5405. case GDScriptParser::DataType::VARIANT:
  5406. case GDScriptParser::DataType::BUILTIN:
  5407. case GDScriptParser::DataType::ENUM:
  5408. case GDScriptParser::DataType::RESOLVING:
  5409. case GDScriptParser::DataType::UNRESOLVED:
  5410. break; // Already solved before.
  5411. }
  5412. switch (p_target.kind) {
  5413. case GDScriptParser::DataType::NATIVE: {
  5414. if (p_target.is_meta_type) {
  5415. return ClassDB::is_parent_class(src_native, GDScriptNativeClass::get_class_static());
  5416. }
  5417. return ClassDB::is_parent_class(src_native, p_target.native_type);
  5418. }
  5419. case GDScriptParser::DataType::SCRIPT:
  5420. if (p_target.is_meta_type) {
  5421. return ClassDB::is_parent_class(src_native, p_target.script_type->get_class_name());
  5422. }
  5423. while (src_script.is_valid()) {
  5424. if (src_script == p_target.script_type) {
  5425. return true;
  5426. }
  5427. src_script = src_script->get_base_script();
  5428. }
  5429. return false;
  5430. case GDScriptParser::DataType::CLASS:
  5431. if (p_target.is_meta_type) {
  5432. return ClassDB::is_parent_class(src_native, GDScript::get_class_static());
  5433. }
  5434. while (src_class != nullptr) {
  5435. if (src_class == p_target.class_type || src_class->fqcn == p_target.class_type->fqcn) {
  5436. return true;
  5437. }
  5438. src_class = src_class->base_type.class_type;
  5439. }
  5440. return false;
  5441. case GDScriptParser::DataType::VARIANT:
  5442. case GDScriptParser::DataType::BUILTIN:
  5443. case GDScriptParser::DataType::ENUM:
  5444. case GDScriptParser::DataType::RESOLVING:
  5445. case GDScriptParser::DataType::UNRESOLVED:
  5446. break; // Already solved before.
  5447. }
  5448. return false;
  5449. }
  5450. void GDScriptAnalyzer::push_error(const String &p_message, const GDScriptParser::Node *p_origin) {
  5451. mark_node_unsafe(p_origin);
  5452. parser->push_error(p_message, p_origin);
  5453. }
  5454. void GDScriptAnalyzer::mark_node_unsafe(const GDScriptParser::Node *p_node) {
  5455. #ifdef DEBUG_ENABLED
  5456. if (p_node == nullptr) {
  5457. return;
  5458. }
  5459. for (int i = p_node->start_line; i <= p_node->end_line; i++) {
  5460. parser->unsafe_lines.insert(i);
  5461. }
  5462. #endif
  5463. }
  5464. void GDScriptAnalyzer::downgrade_node_type_source(GDScriptParser::Node *p_node) {
  5465. GDScriptParser::IdentifierNode *identifier = nullptr;
  5466. if (p_node->type == GDScriptParser::Node::IDENTIFIER) {
  5467. identifier = static_cast<GDScriptParser::IdentifierNode *>(p_node);
  5468. } else if (p_node->type == GDScriptParser::Node::SUBSCRIPT) {
  5469. GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(p_node);
  5470. if (subscript->is_attribute) {
  5471. identifier = subscript->attribute;
  5472. }
  5473. }
  5474. if (identifier == nullptr) {
  5475. return;
  5476. }
  5477. GDScriptParser::Node *source = nullptr;
  5478. switch (identifier->source) {
  5479. case GDScriptParser::IdentifierNode::MEMBER_VARIABLE: {
  5480. source = identifier->variable_source;
  5481. } break;
  5482. case GDScriptParser::IdentifierNode::FUNCTION_PARAMETER: {
  5483. source = identifier->parameter_source;
  5484. } break;
  5485. case GDScriptParser::IdentifierNode::LOCAL_VARIABLE: {
  5486. source = identifier->variable_source;
  5487. } break;
  5488. case GDScriptParser::IdentifierNode::LOCAL_ITERATOR: {
  5489. source = identifier->bind_source;
  5490. } break;
  5491. default:
  5492. break;
  5493. }
  5494. if (source == nullptr) {
  5495. return;
  5496. }
  5497. GDScriptParser::DataType datatype;
  5498. datatype.kind = GDScriptParser::DataType::VARIANT;
  5499. source->set_datatype(datatype);
  5500. }
  5501. void GDScriptAnalyzer::mark_lambda_use_self() {
  5502. GDScriptParser::LambdaNode *lambda = current_lambda;
  5503. while (lambda != nullptr) {
  5504. lambda->use_self = true;
  5505. lambda = lambda->parent_lambda;
  5506. }
  5507. }
  5508. void GDScriptAnalyzer::resolve_pending_lambda_bodies() {
  5509. if (pending_body_resolution_lambdas.is_empty()) {
  5510. return;
  5511. }
  5512. GDScriptParser::LambdaNode *previous_lambda = current_lambda;
  5513. bool previous_static_context = static_context;
  5514. List<GDScriptParser::LambdaNode *> lambdas = pending_body_resolution_lambdas;
  5515. pending_body_resolution_lambdas.clear();
  5516. for (GDScriptParser::LambdaNode *lambda : lambdas) {
  5517. current_lambda = lambda;
  5518. static_context = lambda->function->is_static;
  5519. resolve_function_body(lambda->function, true);
  5520. int captures_amount = lambda->captures.size();
  5521. if (captures_amount > 0) {
  5522. // Create space for lambda parameters.
  5523. // At the beginning to not mess with optional parameters.
  5524. int param_count = lambda->function->parameters.size();
  5525. lambda->function->parameters.resize(param_count + captures_amount);
  5526. for (int i = param_count - 1; i >= 0; i--) {
  5527. lambda->function->parameters.write[i + captures_amount] = lambda->function->parameters[i];
  5528. lambda->function->parameters_indices[lambda->function->parameters[i]->identifier->name] = i + captures_amount;
  5529. }
  5530. // Add captures as extra parameters at the beginning.
  5531. for (int i = 0; i < lambda->captures.size(); i++) {
  5532. GDScriptParser::IdentifierNode *capture = lambda->captures[i];
  5533. GDScriptParser::ParameterNode *capture_param = parser->alloc_node<GDScriptParser::ParameterNode>();
  5534. capture_param->identifier = capture;
  5535. capture_param->usages = capture->usages;
  5536. capture_param->set_datatype(capture->get_datatype());
  5537. lambda->function->parameters.write[i] = capture_param;
  5538. lambda->function->parameters_indices[capture->name] = i;
  5539. }
  5540. }
  5541. }
  5542. current_lambda = previous_lambda;
  5543. static_context = previous_static_context;
  5544. }
  5545. bool GDScriptAnalyzer::class_exists(const StringName &p_class) const {
  5546. return ClassDB::class_exists(p_class) && ClassDB::is_class_exposed(p_class);
  5547. }
  5548. Error GDScriptAnalyzer::resolve_inheritance() {
  5549. return resolve_class_inheritance(parser->head, true);
  5550. }
  5551. Error GDScriptAnalyzer::resolve_interface() {
  5552. resolve_class_interface(parser->head, true);
  5553. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  5554. }
  5555. Error GDScriptAnalyzer::resolve_body() {
  5556. resolve_class_body(parser->head, true);
  5557. #ifdef DEBUG_ENABLED
  5558. // Apply here, after all `@warning_ignore`s have been resolved and applied.
  5559. parser->apply_pending_warnings();
  5560. #endif
  5561. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  5562. }
  5563. Error GDScriptAnalyzer::resolve_dependencies() {
  5564. for (KeyValue<String, Ref<GDScriptParserRef>> &K : parser->depended_parsers) {
  5565. if (K.value.is_null()) {
  5566. return ERR_PARSE_ERROR;
  5567. }
  5568. K.value->raise_status(GDScriptParserRef::INHERITANCE_SOLVED);
  5569. }
  5570. return parser->errors.is_empty() ? OK : ERR_PARSE_ERROR;
  5571. }
  5572. Error GDScriptAnalyzer::analyze() {
  5573. parser->errors.clear();
  5574. Error err = resolve_inheritance();
  5575. if (err) {
  5576. return err;
  5577. }
  5578. resolve_interface();
  5579. err = resolve_body();
  5580. if (err) {
  5581. return err;
  5582. }
  5583. return resolve_dependencies();
  5584. }
  5585. GDScriptAnalyzer::GDScriptAnalyzer(GDScriptParser *p_parser) {
  5586. parser = p_parser;
  5587. }