gdscript_analyzer.cpp 169 KB

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