gdscript_analyzer.cpp 219 KB

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