gdscript_analyzer.cpp 149 KB

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