gdscript_analyzer.cpp 125 KB

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