gdscript_analyzer.cpp 125 KB

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