gdscript_analyzer.cpp 179 KB

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