gdscript_analyzer.cpp 175 KB

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