gdscript_analyzer.cpp 162 KB

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