gdscript_analyzer.cpp 224 KB

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