gdscript_analyzer.cpp 182 KB

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