gdscript_analyzer.cpp 177 KB

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