gdscript_analyzer.cpp 147 KB

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