gdscript_analyzer.cpp 141 KB

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