gdscript_analyzer.cpp 169 KB

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