gdscript_analyzer.cpp 150 KB

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