gdscript_compiler.cpp 91 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537
  1. /*************************************************************************/
  2. /* gdscript_compiler.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "gdscript_compiler.h"
  31. #include "gdscript.h"
  32. #include "gdscript_byte_codegen.h"
  33. #include "gdscript_cache.h"
  34. #include "gdscript_utility_functions.h"
  35. bool GDScriptCompiler::_is_class_member_property(CodeGen &codegen, const StringName &p_name) {
  36. if (codegen.function_node && codegen.function_node->is_static) {
  37. return false;
  38. }
  39. if (codegen.locals.has(p_name)) {
  40. return false; //shadowed
  41. }
  42. return _is_class_member_property(codegen.script, p_name);
  43. }
  44. bool GDScriptCompiler::_is_class_member_property(GDScript *owner, const StringName &p_name) {
  45. GDScript *scr = owner;
  46. GDScriptNativeClass *nc = nullptr;
  47. while (scr) {
  48. if (scr->native.is_valid()) {
  49. nc = scr->native.ptr();
  50. }
  51. scr = scr->_base;
  52. }
  53. ERR_FAIL_COND_V(!nc, false);
  54. return ClassDB::has_property(nc->get_name(), p_name);
  55. }
  56. void GDScriptCompiler::_set_error(const String &p_error, const GDScriptParser::Node *p_node) {
  57. if (error != "") {
  58. return;
  59. }
  60. error = p_error;
  61. if (p_node) {
  62. err_line = p_node->start_line;
  63. err_column = p_node->leftmost_column;
  64. } else {
  65. err_line = 0;
  66. err_column = 0;
  67. }
  68. }
  69. GDScriptDataType GDScriptCompiler::_gdtype_from_datatype(const GDScriptParser::DataType &p_datatype, GDScript *p_owner) const {
  70. if (!p_datatype.is_set() || !p_datatype.is_hard_type()) {
  71. return GDScriptDataType();
  72. }
  73. GDScriptDataType result;
  74. result.has_type = true;
  75. switch (p_datatype.kind) {
  76. case GDScriptParser::DataType::VARIANT: {
  77. result.has_type = false;
  78. } break;
  79. case GDScriptParser::DataType::BUILTIN: {
  80. result.kind = GDScriptDataType::BUILTIN;
  81. result.builtin_type = p_datatype.builtin_type;
  82. } break;
  83. case GDScriptParser::DataType::NATIVE: {
  84. result.kind = GDScriptDataType::NATIVE;
  85. result.native_type = p_datatype.native_type;
  86. } break;
  87. case GDScriptParser::DataType::SCRIPT: {
  88. result.kind = GDScriptDataType::SCRIPT;
  89. result.script_type_ref = Ref<Script>(p_datatype.script_type);
  90. result.script_type = result.script_type_ref.ptr();
  91. result.native_type = result.script_type->get_instance_base_type();
  92. } break;
  93. case GDScriptParser::DataType::CLASS: {
  94. // Locate class by constructing the path to it and following that path
  95. GDScriptParser::ClassNode *class_type = p_datatype.class_type;
  96. if (class_type) {
  97. if (class_type->fqcn.begins_with(main_script->path) || (!main_script->name.is_empty() && class_type->fqcn.begins_with(main_script->name))) {
  98. // Local class.
  99. List<StringName> names;
  100. while (class_type->outer) {
  101. names.push_back(class_type->identifier->name);
  102. class_type = class_type->outer;
  103. }
  104. Ref<GDScript> script = Ref<GDScript>(main_script);
  105. while (names.back()) {
  106. if (!script->subclasses.has(names.back()->get())) {
  107. ERR_PRINT("Parser bug: Cannot locate datatype class.");
  108. result.has_type = false;
  109. return GDScriptDataType();
  110. }
  111. script = script->subclasses[names.back()->get()];
  112. names.pop_back();
  113. }
  114. result.kind = GDScriptDataType::GDSCRIPT;
  115. result.script_type_ref = script;
  116. result.script_type = result.script_type_ref.ptr();
  117. result.native_type = script->get_instance_base_type();
  118. } else {
  119. result.kind = GDScriptDataType::GDSCRIPT;
  120. result.script_type_ref = GDScriptCache::get_shallow_script(p_datatype.script_path, main_script->path);
  121. result.script_type = result.script_type_ref.ptr();
  122. result.native_type = p_datatype.native_type;
  123. }
  124. }
  125. } break;
  126. case GDScriptParser::DataType::ENUM_VALUE:
  127. result.has_type = true;
  128. result.kind = GDScriptDataType::BUILTIN;
  129. result.builtin_type = Variant::INT;
  130. break;
  131. case GDScriptParser::DataType::ENUM:
  132. result.has_type = true;
  133. result.kind = GDScriptDataType::BUILTIN;
  134. result.builtin_type = Variant::DICTIONARY;
  135. break;
  136. case GDScriptParser::DataType::UNRESOLVED: {
  137. ERR_PRINT("Parser bug: converting unresolved type.");
  138. return GDScriptDataType();
  139. }
  140. }
  141. // Only hold strong reference to the script if it's not the owner of the
  142. // element qualified with this type, to avoid cyclic references (leaks).
  143. if (result.script_type && result.script_type == p_owner) {
  144. result.script_type_ref = Ref<Script>();
  145. }
  146. return result;
  147. }
  148. static bool _is_exact_type(const PropertyInfo &p_par_type, const GDScriptDataType &p_arg_type) {
  149. if (!p_arg_type.has_type) {
  150. return false;
  151. }
  152. if (p_par_type.type == Variant::NIL) {
  153. return false;
  154. }
  155. if (p_par_type.type == Variant::OBJECT) {
  156. if (p_arg_type.kind == GDScriptDataType::BUILTIN) {
  157. return false;
  158. }
  159. StringName class_name;
  160. if (p_arg_type.kind == GDScriptDataType::NATIVE) {
  161. class_name = p_arg_type.native_type;
  162. } else {
  163. class_name = p_arg_type.native_type == StringName() ? p_arg_type.script_type->get_instance_base_type() : p_arg_type.native_type;
  164. }
  165. return p_par_type.class_name == class_name || ClassDB::is_parent_class(class_name, p_par_type.class_name);
  166. } else {
  167. if (p_arg_type.kind != GDScriptDataType::BUILTIN) {
  168. return false;
  169. }
  170. return p_par_type.type == p_arg_type.builtin_type;
  171. }
  172. }
  173. static bool _have_exact_arguments(const MethodBind *p_method, const Vector<GDScriptCodeGenerator::Address> &p_arguments) {
  174. if (p_method->get_argument_count() != p_arguments.size()) {
  175. // ptrcall won't work with default arguments.
  176. return false;
  177. }
  178. MethodInfo info;
  179. ClassDB::get_method_info(p_method->get_instance_class(), p_method->get_name(), &info);
  180. for (int i = 0; i < p_arguments.size(); i++) {
  181. const PropertyInfo &prop = info.arguments[i];
  182. if (!_is_exact_type(prop, p_arguments[i].type)) {
  183. return false;
  184. }
  185. }
  186. return true;
  187. }
  188. GDScriptCodeGenerator::Address GDScriptCompiler::_parse_expression(CodeGen &codegen, Error &r_error, const GDScriptParser::ExpressionNode *p_expression, bool p_root, bool p_initializer, const GDScriptCodeGenerator::Address &p_index_addr) {
  189. if (p_expression->is_constant) {
  190. return codegen.add_constant(p_expression->reduced_value);
  191. }
  192. GDScriptCodeGenerator *gen = codegen.generator;
  193. switch (p_expression->type) {
  194. case GDScriptParser::Node::IDENTIFIER: {
  195. // Look for identifiers in current scope.
  196. const GDScriptParser::IdentifierNode *in = static_cast<const GDScriptParser::IdentifierNode *>(p_expression);
  197. StringName identifier = in->name;
  198. // Try function parameters.
  199. if (codegen.parameters.has(identifier)) {
  200. return codegen.parameters[identifier];
  201. }
  202. // Try local variables and constants.
  203. if (!p_initializer && codegen.locals.has(identifier)) {
  204. return codegen.locals[identifier];
  205. }
  206. // Try class members.
  207. if (_is_class_member_property(codegen, identifier)) {
  208. // Get property.
  209. GDScriptCodeGenerator::Address temp = codegen.add_temporary(); // TODO: Could get the type of the class member here.
  210. gen->write_get_member(temp, identifier);
  211. return temp;
  212. }
  213. // Try members.
  214. if (!codegen.function_node || !codegen.function_node->is_static) {
  215. // Try member variables.
  216. if (codegen.script->member_indices.has(identifier)) {
  217. if (codegen.script->member_indices[identifier].getter != StringName() && codegen.script->member_indices[identifier].getter != codegen.function_name) {
  218. // Perform getter.
  219. GDScriptCodeGenerator::Address temp = codegen.add_temporary();
  220. Vector<GDScriptCodeGenerator::Address> args; // No argument needed.
  221. gen->write_call_self(temp, codegen.script->member_indices[identifier].getter, args);
  222. return temp;
  223. } else {
  224. // No getter or inside getter: direct member access.,
  225. int idx = codegen.script->member_indices[identifier].index;
  226. return GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::MEMBER, idx, codegen.script->get_member_type(identifier));
  227. }
  228. }
  229. }
  230. // Try class constants.
  231. {
  232. GDScript *owner = codegen.script;
  233. while (owner) {
  234. GDScript *scr = owner;
  235. GDScriptNativeClass *nc = nullptr;
  236. while (scr) {
  237. if (scr->constants.has(identifier)) {
  238. return GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::CLASS_CONSTANT, gen->add_or_get_name(identifier)); // TODO: Get type here.
  239. }
  240. if (scr->native.is_valid()) {
  241. nc = scr->native.ptr();
  242. }
  243. scr = scr->_base;
  244. }
  245. // Class C++ integer constant.
  246. if (nc) {
  247. bool success = false;
  248. int constant = ClassDB::get_integer_constant(nc->get_name(), identifier, &success);
  249. if (success) {
  250. return codegen.add_constant(constant);
  251. }
  252. }
  253. owner = owner->_owner;
  254. }
  255. }
  256. // Try signals and methods (can be made callables).
  257. {
  258. if (codegen.class_node->members_indices.has(identifier)) {
  259. const GDScriptParser::ClassNode::Member &member = codegen.class_node->members[codegen.class_node->members_indices[identifier]];
  260. if (member.type == GDScriptParser::ClassNode::Member::FUNCTION || member.type == GDScriptParser::ClassNode::Member::SIGNAL) {
  261. // Get like it was a property.
  262. GDScriptCodeGenerator::Address temp = codegen.add_temporary(); // TODO: Get type here.
  263. GDScriptCodeGenerator::Address self(GDScriptCodeGenerator::Address::SELF);
  264. gen->write_get_named(temp, identifier, self);
  265. return temp;
  266. }
  267. }
  268. // Try in native base.
  269. GDScript *scr = codegen.script;
  270. GDScriptNativeClass *nc = nullptr;
  271. while (scr) {
  272. if (scr->native.is_valid()) {
  273. nc = scr->native.ptr();
  274. }
  275. scr = scr->_base;
  276. }
  277. if (nc && (ClassDB::has_signal(nc->get_name(), identifier) || ClassDB::has_method(nc->get_name(), identifier))) {
  278. // Get like it was a property.
  279. GDScriptCodeGenerator::Address temp = codegen.add_temporary(); // TODO: Get type here.
  280. GDScriptCodeGenerator::Address self(GDScriptCodeGenerator::Address::SELF);
  281. gen->write_get_named(temp, identifier, self);
  282. return temp;
  283. }
  284. }
  285. if (GDScriptLanguage::get_singleton()->get_global_map().has(identifier)) {
  286. int idx = GDScriptLanguage::get_singleton()->get_global_map()[identifier];
  287. return GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::GLOBAL, idx); // TODO: Get type.
  288. }
  289. // Try global classes.
  290. if (ScriptServer::is_global_class(identifier)) {
  291. const GDScriptParser::ClassNode *class_node = codegen.class_node;
  292. while (class_node->outer) {
  293. class_node = class_node->outer;
  294. }
  295. RES res;
  296. if (class_node->identifier && class_node->identifier->name == identifier) {
  297. res = Ref<GDScript>(main_script);
  298. } else {
  299. res = ResourceLoader::load(ScriptServer::get_global_class_path(identifier));
  300. if (res.is_null()) {
  301. _set_error("Can't load global class " + String(identifier) + ", cyclic reference?", p_expression);
  302. r_error = ERR_COMPILATION_FAILED;
  303. return GDScriptCodeGenerator::Address();
  304. }
  305. }
  306. return codegen.add_constant(res);
  307. }
  308. #ifdef TOOLS_ENABLED
  309. if (GDScriptLanguage::get_singleton()->get_named_globals_map().has(identifier)) {
  310. return GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::NAMED_GLOBAL, gen->add_or_get_name(identifier)); // TODO: Get type.
  311. }
  312. #endif
  313. // Not found, error.
  314. _set_error("Identifier not found: " + String(identifier), p_expression);
  315. r_error = ERR_COMPILATION_FAILED;
  316. return GDScriptCodeGenerator::Address();
  317. } break;
  318. case GDScriptParser::Node::LITERAL: {
  319. // Return constant.
  320. const GDScriptParser::LiteralNode *cn = static_cast<const GDScriptParser::LiteralNode *>(p_expression);
  321. return codegen.add_constant(cn->value);
  322. } break;
  323. case GDScriptParser::Node::SELF: {
  324. //return constant
  325. if (codegen.function_node && codegen.function_node->is_static) {
  326. _set_error("'self' not present in static function!", p_expression);
  327. r_error = ERR_COMPILATION_FAILED;
  328. return GDScriptCodeGenerator::Address();
  329. }
  330. return GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::SELF);
  331. } break;
  332. case GDScriptParser::Node::ARRAY: {
  333. const GDScriptParser::ArrayNode *an = static_cast<const GDScriptParser::ArrayNode *>(p_expression);
  334. Vector<GDScriptCodeGenerator::Address> values;
  335. // Create the result temporary first since it's the last to be killed.
  336. GDScriptDataType array_type;
  337. array_type.has_type = true;
  338. array_type.kind = GDScriptDataType::BUILTIN;
  339. array_type.builtin_type = Variant::ARRAY;
  340. GDScriptCodeGenerator::Address result = codegen.add_temporary(array_type);
  341. for (int i = 0; i < an->elements.size(); i++) {
  342. GDScriptCodeGenerator::Address val = _parse_expression(codegen, r_error, an->elements[i]);
  343. if (r_error) {
  344. return GDScriptCodeGenerator::Address();
  345. }
  346. values.push_back(val);
  347. }
  348. gen->write_construct_array(result, values);
  349. for (int i = 0; i < values.size(); i++) {
  350. if (values[i].mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  351. gen->pop_temporary();
  352. }
  353. }
  354. return result;
  355. } break;
  356. case GDScriptParser::Node::DICTIONARY: {
  357. const GDScriptParser::DictionaryNode *dn = static_cast<const GDScriptParser::DictionaryNode *>(p_expression);
  358. Vector<GDScriptCodeGenerator::Address> elements;
  359. // Create the result temporary first since it's the last to be killed.
  360. GDScriptDataType dict_type;
  361. dict_type.has_type = true;
  362. dict_type.kind = GDScriptDataType::BUILTIN;
  363. dict_type.builtin_type = Variant::DICTIONARY;
  364. GDScriptCodeGenerator::Address result = codegen.add_temporary(dict_type);
  365. for (int i = 0; i < dn->elements.size(); i++) {
  366. // Key.
  367. GDScriptCodeGenerator::Address element;
  368. switch (dn->style) {
  369. case GDScriptParser::DictionaryNode::PYTHON_DICT:
  370. // Python-style: key is any expression.
  371. element = _parse_expression(codegen, r_error, dn->elements[i].key);
  372. if (r_error) {
  373. return GDScriptCodeGenerator::Address();
  374. }
  375. break;
  376. case GDScriptParser::DictionaryNode::LUA_TABLE:
  377. // Lua-style: key is an identifier interpreted as string.
  378. String key = static_cast<const GDScriptParser::IdentifierNode *>(dn->elements[i].key)->name;
  379. element = codegen.add_constant(key);
  380. break;
  381. }
  382. elements.push_back(element);
  383. element = _parse_expression(codegen, r_error, dn->elements[i].value);
  384. if (r_error) {
  385. return GDScriptCodeGenerator::Address();
  386. }
  387. elements.push_back(element);
  388. }
  389. gen->write_construct_dictionary(result, elements);
  390. for (int i = 0; i < elements.size(); i++) {
  391. if (elements[i].mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  392. gen->pop_temporary();
  393. }
  394. }
  395. return result;
  396. } break;
  397. case GDScriptParser::Node::CAST: {
  398. const GDScriptParser::CastNode *cn = static_cast<const GDScriptParser::CastNode *>(p_expression);
  399. GDScriptDataType cast_type = _gdtype_from_datatype(cn->cast_type->get_datatype());
  400. // Create temporary for result first since it will be deleted last.
  401. GDScriptCodeGenerator::Address result = codegen.add_temporary(cast_type);
  402. GDScriptCodeGenerator::Address source = _parse_expression(codegen, r_error, cn->operand);
  403. gen->write_cast(result, source, cast_type);
  404. if (source.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  405. gen->pop_temporary();
  406. }
  407. return result;
  408. } break;
  409. case GDScriptParser::Node::CALL: {
  410. const GDScriptParser::CallNode *call = static_cast<const GDScriptParser::CallNode *>(p_expression);
  411. GDScriptDataType type = _gdtype_from_datatype(call->get_datatype());
  412. GDScriptCodeGenerator::Address result = codegen.add_temporary(type);
  413. Vector<GDScriptCodeGenerator::Address> arguments;
  414. for (int i = 0; i < call->arguments.size(); i++) {
  415. GDScriptCodeGenerator::Address arg = _parse_expression(codegen, r_error, call->arguments[i]);
  416. if (r_error) {
  417. return GDScriptCodeGenerator::Address();
  418. }
  419. arguments.push_back(arg);
  420. }
  421. if (!call->is_super && call->callee->type == GDScriptParser::Node::IDENTIFIER && GDScriptParser::get_builtin_type(call->function_name) != Variant::VARIANT_MAX) {
  422. // Construct a built-in type.
  423. Variant::Type vtype = GDScriptParser::get_builtin_type(static_cast<GDScriptParser::IdentifierNode *>(call->callee)->name);
  424. gen->write_construct(result, vtype, arguments);
  425. } else if (!call->is_super && call->callee->type == GDScriptParser::Node::IDENTIFIER && Variant::has_utility_function(call->function_name)) {
  426. // Variant utility function.
  427. gen->write_call_utility(result, call->function_name, arguments);
  428. } else if (!call->is_super && call->callee->type == GDScriptParser::Node::IDENTIFIER && GDScriptUtilityFunctions::function_exists(call->function_name)) {
  429. // GDScript utility function.
  430. gen->write_call_gdscript_utility(result, GDScriptUtilityFunctions::get_function(call->function_name), arguments);
  431. } else {
  432. // Regular function.
  433. const GDScriptParser::ExpressionNode *callee = call->callee;
  434. if (call->is_super) {
  435. // Super call.
  436. gen->write_super_call(result, call->function_name, arguments);
  437. } else {
  438. if (callee->type == GDScriptParser::Node::IDENTIFIER) {
  439. // Self function call.
  440. if (ClassDB::has_method(codegen.script->native->get_name(), call->function_name)) {
  441. // Native method, use faster path.
  442. GDScriptCodeGenerator::Address self;
  443. self.mode = GDScriptCodeGenerator::Address::SELF;
  444. MethodBind *method = ClassDB::get_method(codegen.script->native->get_name(), call->function_name);
  445. if (_have_exact_arguments(method, arguments)) {
  446. // Exact arguments, use ptrcall.
  447. gen->write_call_ptrcall(result, self, method, arguments);
  448. } else {
  449. // Not exact arguments, but still can use method bind call.
  450. gen->write_call_method_bind(result, self, method, arguments);
  451. }
  452. } else if ((codegen.function_node && codegen.function_node->is_static) || call->function_name == "new") {
  453. GDScriptCodeGenerator::Address self;
  454. self.mode = GDScriptCodeGenerator::Address::CLASS;
  455. if (within_await) {
  456. gen->write_call_async(result, self, call->function_name, arguments);
  457. } else {
  458. gen->write_call(result, self, call->function_name, arguments);
  459. }
  460. } else {
  461. if (within_await) {
  462. gen->write_call_self_async(result, call->function_name, arguments);
  463. } else {
  464. gen->write_call_self(result, call->function_name, arguments);
  465. }
  466. }
  467. } else if (callee->type == GDScriptParser::Node::SUBSCRIPT) {
  468. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(call->callee);
  469. if (subscript->is_attribute) {
  470. GDScriptCodeGenerator::Address base = _parse_expression(codegen, r_error, subscript->base);
  471. if (r_error) {
  472. return GDScriptCodeGenerator::Address();
  473. }
  474. if (within_await) {
  475. gen->write_call_async(result, base, call->function_name, arguments);
  476. } else if (base.type.has_type && base.type.kind != GDScriptDataType::BUILTIN) {
  477. // Native method, use faster path.
  478. StringName class_name;
  479. if (base.type.kind == GDScriptDataType::NATIVE) {
  480. class_name = base.type.native_type;
  481. } else {
  482. class_name = base.type.native_type == StringName() ? base.type.script_type->get_instance_base_type() : base.type.native_type;
  483. }
  484. if (ClassDB::class_exists(class_name) && ClassDB::has_method(class_name, call->function_name)) {
  485. MethodBind *method = ClassDB::get_method(class_name, call->function_name);
  486. if (_have_exact_arguments(method, arguments)) {
  487. // Exact arguments, use ptrcall.
  488. gen->write_call_ptrcall(result, base, method, arguments);
  489. } else {
  490. // Not exact arguments, but still can use method bind call.
  491. gen->write_call_method_bind(result, base, method, arguments);
  492. }
  493. } else {
  494. gen->write_call(result, base, call->function_name, arguments);
  495. }
  496. } else if (base.type.has_type && base.type.kind == GDScriptDataType::BUILTIN) {
  497. gen->write_call_builtin_type(result, base, base.type.builtin_type, call->function_name, arguments);
  498. } else {
  499. gen->write_call(result, base, call->function_name, arguments);
  500. }
  501. if (base.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  502. gen->pop_temporary();
  503. }
  504. } else {
  505. _set_error("Cannot call something that isn't a function.", call->callee);
  506. r_error = ERR_COMPILATION_FAILED;
  507. return GDScriptCodeGenerator::Address();
  508. }
  509. } else {
  510. r_error = ERR_COMPILATION_FAILED;
  511. return GDScriptCodeGenerator::Address();
  512. }
  513. }
  514. }
  515. for (int i = 0; i < arguments.size(); i++) {
  516. if (arguments[i].mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  517. gen->pop_temporary();
  518. }
  519. }
  520. return result;
  521. } break;
  522. case GDScriptParser::Node::GET_NODE: {
  523. const GDScriptParser::GetNodeNode *get_node = static_cast<const GDScriptParser::GetNodeNode *>(p_expression);
  524. String node_name;
  525. if (get_node->string != nullptr) {
  526. node_name += String(get_node->string->value);
  527. } else {
  528. for (int i = 0; i < get_node->chain.size(); i++) {
  529. if (i > 0) {
  530. node_name += "/";
  531. }
  532. node_name += get_node->chain[i]->name;
  533. }
  534. }
  535. Vector<GDScriptCodeGenerator::Address> args;
  536. args.push_back(codegen.add_constant(NodePath(node_name)));
  537. GDScriptCodeGenerator::Address result = codegen.add_temporary(_gdtype_from_datatype(get_node->get_datatype()));
  538. MethodBind *get_node_method = ClassDB::get_method("Node", "get_node");
  539. gen->write_call_ptrcall(result, GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::SELF), get_node_method, args);
  540. return result;
  541. } break;
  542. case GDScriptParser::Node::PRELOAD: {
  543. const GDScriptParser::PreloadNode *preload = static_cast<const GDScriptParser::PreloadNode *>(p_expression);
  544. // Add resource as constant.
  545. return codegen.add_constant(preload->resource);
  546. } break;
  547. case GDScriptParser::Node::AWAIT: {
  548. const GDScriptParser::AwaitNode *await = static_cast<const GDScriptParser::AwaitNode *>(p_expression);
  549. GDScriptCodeGenerator::Address result = codegen.add_temporary(_gdtype_from_datatype(p_expression->get_datatype()));
  550. within_await = true;
  551. GDScriptCodeGenerator::Address argument = _parse_expression(codegen, r_error, await->to_await);
  552. within_await = false;
  553. if (r_error) {
  554. return GDScriptCodeGenerator::Address();
  555. }
  556. gen->write_await(result, argument);
  557. if (argument.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  558. gen->pop_temporary();
  559. }
  560. return result;
  561. } break;
  562. // Indexing operator.
  563. case GDScriptParser::Node::SUBSCRIPT: {
  564. const GDScriptParser::SubscriptNode *subscript = static_cast<const GDScriptParser::SubscriptNode *>(p_expression);
  565. GDScriptCodeGenerator::Address result = codegen.add_temporary(_gdtype_from_datatype(subscript->get_datatype()));
  566. GDScriptCodeGenerator::Address base = _parse_expression(codegen, r_error, subscript->base);
  567. if (r_error) {
  568. return GDScriptCodeGenerator::Address();
  569. }
  570. bool named = subscript->is_attribute;
  571. StringName name;
  572. GDScriptCodeGenerator::Address index;
  573. if (p_index_addr.mode != GDScriptCodeGenerator::Address::NIL) {
  574. index = p_index_addr;
  575. } else if (subscript->is_attribute) {
  576. if (subscript->base->type == GDScriptParser::Node::SELF && codegen.script) {
  577. GDScriptParser::IdentifierNode *identifier = subscript->attribute;
  578. const Map<StringName, GDScript::MemberInfo>::Element *MI = codegen.script->member_indices.find(identifier->name);
  579. #ifdef DEBUG_ENABLED
  580. if (MI && MI->get().getter == codegen.function_name) {
  581. String n = identifier->name;
  582. _set_error("Must use '" + n + "' instead of 'self." + n + "' in getter.", identifier);
  583. r_error = ERR_COMPILATION_FAILED;
  584. return GDScriptCodeGenerator::Address();
  585. }
  586. #endif
  587. if (MI && MI->get().getter == "") {
  588. // Remove result temp as we don't need it.
  589. gen->pop_temporary();
  590. // Faster than indexing self (as if no self. had been used).
  591. return GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::MEMBER, MI->get().index, _gdtype_from_datatype(subscript->get_datatype()));
  592. }
  593. }
  594. name = subscript->attribute->name;
  595. named = true;
  596. } else {
  597. if (subscript->index->type == GDScriptParser::Node::LITERAL && static_cast<const GDScriptParser::LiteralNode *>(subscript->index)->value.get_type() == Variant::STRING) {
  598. // Also, somehow, named (speed up anyway).
  599. name = static_cast<const GDScriptParser::LiteralNode *>(subscript->index)->value;
  600. named = true;
  601. } else {
  602. // Regular indexing.
  603. index = _parse_expression(codegen, r_error, subscript->index);
  604. if (r_error) {
  605. return GDScriptCodeGenerator::Address();
  606. }
  607. }
  608. }
  609. if (named) {
  610. gen->write_get_named(result, name, base);
  611. } else {
  612. gen->write_get(result, index, base);
  613. }
  614. if (index.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  615. gen->pop_temporary();
  616. }
  617. if (base.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  618. gen->pop_temporary();
  619. }
  620. return result;
  621. } break;
  622. case GDScriptParser::Node::UNARY_OPERATOR: {
  623. const GDScriptParser::UnaryOpNode *unary = static_cast<const GDScriptParser::UnaryOpNode *>(p_expression);
  624. GDScriptCodeGenerator::Address result = codegen.add_temporary();
  625. GDScriptCodeGenerator::Address operand = _parse_expression(codegen, r_error, unary->operand);
  626. if (r_error) {
  627. return GDScriptCodeGenerator::Address();
  628. }
  629. gen->write_unary_operator(result, unary->variant_op, operand);
  630. if (operand.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  631. gen->pop_temporary();
  632. }
  633. return result;
  634. }
  635. case GDScriptParser::Node::BINARY_OPERATOR: {
  636. const GDScriptParser::BinaryOpNode *binary = static_cast<const GDScriptParser::BinaryOpNode *>(p_expression);
  637. GDScriptCodeGenerator::Address result = codegen.add_temporary();
  638. switch (binary->operation) {
  639. case GDScriptParser::BinaryOpNode::OP_LOGIC_AND: {
  640. // AND operator with early out on failure.
  641. GDScriptCodeGenerator::Address left_operand = _parse_expression(codegen, r_error, binary->left_operand);
  642. gen->write_and_left_operand(left_operand);
  643. GDScriptCodeGenerator::Address right_operand = _parse_expression(codegen, r_error, binary->right_operand);
  644. gen->write_and_right_operand(right_operand);
  645. gen->write_end_and(result);
  646. if (right_operand.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  647. gen->pop_temporary();
  648. }
  649. if (left_operand.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  650. gen->pop_temporary();
  651. }
  652. } break;
  653. case GDScriptParser::BinaryOpNode::OP_LOGIC_OR: {
  654. // OR operator with early out on success.
  655. GDScriptCodeGenerator::Address left_operand = _parse_expression(codegen, r_error, binary->left_operand);
  656. gen->write_or_left_operand(left_operand);
  657. GDScriptCodeGenerator::Address right_operand = _parse_expression(codegen, r_error, binary->right_operand);
  658. gen->write_or_right_operand(right_operand);
  659. gen->write_end_or(result);
  660. if (right_operand.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  661. gen->pop_temporary();
  662. }
  663. if (left_operand.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  664. gen->pop_temporary();
  665. }
  666. } break;
  667. case GDScriptParser::BinaryOpNode::OP_TYPE_TEST: {
  668. GDScriptCodeGenerator::Address operand = _parse_expression(codegen, r_error, binary->left_operand);
  669. if (binary->right_operand->type == GDScriptParser::Node::IDENTIFIER && GDScriptParser::get_builtin_type(static_cast<const GDScriptParser::IdentifierNode *>(binary->right_operand)->name) != Variant::VARIANT_MAX) {
  670. // `is` with builtin type)
  671. Variant::Type type = GDScriptParser::get_builtin_type(static_cast<const GDScriptParser::IdentifierNode *>(binary->right_operand)->name);
  672. gen->write_type_test_builtin(result, operand, type);
  673. } else {
  674. GDScriptCodeGenerator::Address type = _parse_expression(codegen, r_error, binary->right_operand);
  675. if (r_error) {
  676. return GDScriptCodeGenerator::Address();
  677. }
  678. gen->write_type_test(result, operand, type);
  679. if (type.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  680. gen->pop_temporary();
  681. }
  682. }
  683. } break;
  684. default: {
  685. GDScriptCodeGenerator::Address left_operand = _parse_expression(codegen, r_error, binary->left_operand);
  686. GDScriptCodeGenerator::Address right_operand = _parse_expression(codegen, r_error, binary->right_operand);
  687. gen->write_binary_operator(result, binary->variant_op, left_operand, right_operand);
  688. if (right_operand.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  689. gen->pop_temporary();
  690. }
  691. if (left_operand.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  692. gen->pop_temporary();
  693. }
  694. }
  695. }
  696. return result;
  697. } break;
  698. case GDScriptParser::Node::TERNARY_OPERATOR: {
  699. // x IF a ELSE y operator with early out on failure.
  700. const GDScriptParser::TernaryOpNode *ternary = static_cast<const GDScriptParser::TernaryOpNode *>(p_expression);
  701. GDScriptCodeGenerator::Address result = codegen.add_temporary(_gdtype_from_datatype(ternary->get_datatype()));
  702. gen->write_start_ternary(result);
  703. GDScriptCodeGenerator::Address condition = _parse_expression(codegen, r_error, ternary->condition);
  704. if (r_error) {
  705. return GDScriptCodeGenerator::Address();
  706. }
  707. gen->write_ternary_condition(condition);
  708. if (condition.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  709. gen->pop_temporary();
  710. }
  711. GDScriptCodeGenerator::Address true_expr = _parse_expression(codegen, r_error, ternary->true_expr);
  712. if (r_error) {
  713. return GDScriptCodeGenerator::Address();
  714. }
  715. gen->write_ternary_true_expr(true_expr);
  716. if (true_expr.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  717. gen->pop_temporary();
  718. }
  719. GDScriptCodeGenerator::Address false_expr = _parse_expression(codegen, r_error, ternary->false_expr);
  720. if (r_error) {
  721. return GDScriptCodeGenerator::Address();
  722. }
  723. gen->write_ternary_false_expr(false_expr);
  724. if (false_expr.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  725. gen->pop_temporary();
  726. }
  727. gen->write_end_ternary();
  728. return result;
  729. } break;
  730. case GDScriptParser::Node::ASSIGNMENT: {
  731. const GDScriptParser::AssignmentNode *assignment = static_cast<const GDScriptParser::AssignmentNode *>(p_expression);
  732. if (assignment->assignee->type == GDScriptParser::Node::SUBSCRIPT) {
  733. // SET (chained) MODE!
  734. const GDScriptParser::SubscriptNode *subscript = static_cast<GDScriptParser::SubscriptNode *>(assignment->assignee);
  735. #ifdef DEBUG_ENABLED
  736. if (subscript->is_attribute && subscript->base->type == GDScriptParser::Node::SELF && codegen.script) {
  737. const Map<StringName, GDScript::MemberInfo>::Element *MI = codegen.script->member_indices.find(subscript->attribute->name);
  738. if (MI && MI->get().setter == codegen.function_name) {
  739. String n = subscript->attribute->name;
  740. _set_error("Must use '" + n + "' instead of 'self." + n + "' in setter.", subscript);
  741. r_error = ERR_COMPILATION_FAILED;
  742. return GDScriptCodeGenerator::Address();
  743. }
  744. }
  745. #endif
  746. /* Find chain of sets */
  747. StringName assign_property;
  748. List<const GDScriptParser::SubscriptNode *> chain;
  749. {
  750. // Create get/set chain.
  751. const GDScriptParser::SubscriptNode *n = subscript;
  752. while (true) {
  753. chain.push_back(n);
  754. if (n->base->type != GDScriptParser::Node::SUBSCRIPT) {
  755. // Check for a built-in property.
  756. if (n->base->type == GDScriptParser::Node::IDENTIFIER) {
  757. GDScriptParser::IdentifierNode *identifier = static_cast<GDScriptParser::IdentifierNode *>(n->base);
  758. if (_is_class_member_property(codegen, identifier->name)) {
  759. assign_property = identifier->name;
  760. }
  761. }
  762. break;
  763. }
  764. n = static_cast<const GDScriptParser::SubscriptNode *>(n->base);
  765. }
  766. }
  767. /* Chain of gets */
  768. // Get at (potential) root stack pos, so it can be returned.
  769. GDScriptCodeGenerator::Address base = _parse_expression(codegen, r_error, chain.back()->get()->base);
  770. if (r_error) {
  771. return GDScriptCodeGenerator::Address();
  772. }
  773. GDScriptCodeGenerator::Address prev_base = base;
  774. struct ChainInfo {
  775. bool is_named = false;
  776. GDScriptCodeGenerator::Address base;
  777. GDScriptCodeGenerator::Address key;
  778. StringName name;
  779. };
  780. List<ChainInfo> set_chain;
  781. for (List<const GDScriptParser::SubscriptNode *>::Element *E = chain.back(); E; E = E->prev()) {
  782. if (E == chain.front()) {
  783. // Skip the main subscript, since we'll assign to that.
  784. break;
  785. }
  786. const GDScriptParser::SubscriptNode *subscript_elem = E->get();
  787. GDScriptCodeGenerator::Address value = codegen.add_temporary(_gdtype_from_datatype(subscript_elem->get_datatype()));
  788. GDScriptCodeGenerator::Address key;
  789. StringName name;
  790. if (subscript_elem->is_attribute) {
  791. name = subscript_elem->attribute->name;
  792. gen->write_get_named(value, name, prev_base);
  793. } else {
  794. key = _parse_expression(codegen, r_error, subscript_elem->index);
  795. if (r_error) {
  796. return GDScriptCodeGenerator::Address();
  797. }
  798. gen->write_get(value, key, prev_base);
  799. }
  800. // Store base and key for setting it back later.
  801. set_chain.push_front({ subscript_elem->is_attribute, prev_base, key, name }); // Push to front to invert the list.
  802. prev_base = value;
  803. }
  804. // Get value to assign.
  805. GDScriptCodeGenerator::Address assigned = _parse_expression(codegen, r_error, assignment->assigned_value);
  806. if (r_error) {
  807. return GDScriptCodeGenerator::Address();
  808. }
  809. // Get the key if needed.
  810. GDScriptCodeGenerator::Address key;
  811. StringName name;
  812. if (subscript->is_attribute) {
  813. name = subscript->attribute->name;
  814. } else {
  815. key = _parse_expression(codegen, r_error, subscript->index);
  816. if (r_error) {
  817. return GDScriptCodeGenerator::Address();
  818. }
  819. }
  820. // Perform operator if any.
  821. if (assignment->operation != GDScriptParser::AssignmentNode::OP_NONE) {
  822. GDScriptCodeGenerator::Address value = codegen.add_temporary();
  823. if (subscript->is_attribute) {
  824. gen->write_get_named(value, name, prev_base);
  825. } else {
  826. gen->write_get(value, key, prev_base);
  827. }
  828. gen->write_binary_operator(value, assignment->variant_op, value, assigned);
  829. if (assigned.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  830. gen->pop_temporary();
  831. }
  832. assigned = value;
  833. }
  834. // Perform assignment.
  835. if (subscript->is_attribute) {
  836. gen->write_set_named(prev_base, name, assigned);
  837. } else {
  838. gen->write_set(prev_base, key, assigned);
  839. }
  840. if (assigned.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  841. gen->pop_temporary();
  842. }
  843. assigned = prev_base;
  844. // Set back the values into their bases.
  845. for (List<ChainInfo>::Element *E = set_chain.front(); E; E = E->next()) {
  846. const ChainInfo &info = E->get();
  847. if (!info.is_named) {
  848. gen->write_set(info.base, info.key, assigned);
  849. if (info.key.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  850. gen->pop_temporary();
  851. }
  852. } else {
  853. gen->write_set_named(info.base, info.name, assigned);
  854. }
  855. if (assigned.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  856. gen->pop_temporary();
  857. }
  858. assigned = info.base;
  859. }
  860. // If this is a local member, also assign to it.
  861. // This allow things like: position.x += 2.0
  862. if (assign_property != StringName()) {
  863. gen->write_set_member(assigned, assign_property);
  864. }
  865. if (assigned.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  866. gen->pop_temporary();
  867. }
  868. } else if (assignment->assignee->type == GDScriptParser::Node::IDENTIFIER && _is_class_member_property(codegen, static_cast<GDScriptParser::IdentifierNode *>(assignment->assignee)->name)) {
  869. // Assignment to member property.
  870. GDScriptCodeGenerator::Address assigned = _parse_expression(codegen, r_error, assignment->assigned_value);
  871. if (r_error) {
  872. return GDScriptCodeGenerator::Address();
  873. }
  874. GDScriptCodeGenerator::Address assign_temp = assigned;
  875. StringName name = static_cast<GDScriptParser::IdentifierNode *>(assignment->assignee)->name;
  876. if (assignment->operation != GDScriptParser::AssignmentNode::OP_NONE) {
  877. GDScriptCodeGenerator::Address member = codegen.add_temporary();
  878. gen->write_get_member(member, name);
  879. gen->write_binary_operator(assigned, assignment->variant_op, member, assigned);
  880. gen->pop_temporary();
  881. }
  882. gen->write_set_member(assigned, name);
  883. if (assign_temp.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  884. gen->pop_temporary();
  885. }
  886. } else {
  887. // Regular assignment.
  888. GDScriptCodeGenerator::Address target;
  889. bool has_setter = false;
  890. bool is_in_setter = false;
  891. StringName setter_function;
  892. if (assignment->assignee->type == GDScriptParser::Node::IDENTIFIER) {
  893. StringName var_name = static_cast<const GDScriptParser::IdentifierNode *>(assignment->assignee)->name;
  894. if (!codegen.locals.has(var_name) && codegen.script->member_indices.has(var_name)) {
  895. setter_function = codegen.script->member_indices[var_name].setter;
  896. if (setter_function != StringName()) {
  897. has_setter = true;
  898. is_in_setter = setter_function == codegen.function_name;
  899. target.mode = GDScriptCodeGenerator::Address::MEMBER;
  900. target.address = codegen.script->member_indices[var_name].index;
  901. }
  902. }
  903. }
  904. if (has_setter) {
  905. if (!is_in_setter) {
  906. // Store stack slot for the temp value.
  907. target = codegen.add_temporary(_gdtype_from_datatype(assignment->assignee->get_datatype()));
  908. }
  909. } else {
  910. target = _parse_expression(codegen, r_error, assignment->assignee);
  911. if (r_error) {
  912. return GDScriptCodeGenerator::Address();
  913. }
  914. }
  915. GDScriptCodeGenerator::Address assigned = _parse_expression(codegen, r_error, assignment->assigned_value);
  916. GDScriptCodeGenerator::Address op_result;
  917. if (r_error) {
  918. return GDScriptCodeGenerator::Address();
  919. }
  920. if (assignment->operation != GDScriptParser::AssignmentNode::OP_NONE) {
  921. // Perform operation.
  922. op_result = codegen.add_temporary();
  923. gen->write_binary_operator(op_result, assignment->variant_op, target, assigned);
  924. } else {
  925. op_result = assigned;
  926. assigned = GDScriptCodeGenerator::Address();
  927. }
  928. GDScriptDataType assign_type = _gdtype_from_datatype(assignment->assignee->get_datatype());
  929. if (has_setter && !is_in_setter) {
  930. // Call setter.
  931. Vector<GDScriptCodeGenerator::Address> args;
  932. args.push_back(op_result);
  933. gen->write_call(GDScriptCodeGenerator::Address(), GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::SELF), setter_function, args);
  934. } else {
  935. // Just assign.
  936. gen->write_assign(target, op_result);
  937. }
  938. if (op_result.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  939. gen->pop_temporary();
  940. }
  941. if (assigned.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  942. gen->pop_temporary();
  943. }
  944. if (target.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  945. gen->pop_temporary();
  946. }
  947. }
  948. return GDScriptCodeGenerator::Address(); // Assignment does not return a value.
  949. } break;
  950. default: {
  951. ERR_FAIL_V_MSG(GDScriptCodeGenerator::Address(), "Bug in bytecode compiler, unexpected node in parse tree while parsing expression."); // Unreachable code.
  952. } break;
  953. }
  954. }
  955. GDScriptCodeGenerator::Address GDScriptCompiler::_parse_match_pattern(CodeGen &codegen, Error &r_error, const GDScriptParser::PatternNode *p_pattern, const GDScriptCodeGenerator::Address &p_value_addr, const GDScriptCodeGenerator::Address &p_type_addr, const GDScriptCodeGenerator::Address &p_previous_test, bool p_is_first, bool p_is_nested) {
  956. switch (p_pattern->pattern_type) {
  957. case GDScriptParser::PatternNode::PT_LITERAL: {
  958. if (p_is_nested) {
  959. codegen.generator->write_and_left_operand(p_previous_test);
  960. } else if (!p_is_first) {
  961. codegen.generator->write_or_left_operand(p_previous_test);
  962. }
  963. // Get literal type into constant map.
  964. GDScriptCodeGenerator::Address literal_type_addr = codegen.add_constant((int)p_pattern->literal->value.get_type());
  965. // Equality is always a boolean.
  966. GDScriptDataType equality_type;
  967. equality_type.has_type = true;
  968. equality_type.kind = GDScriptDataType::BUILTIN;
  969. equality_type.builtin_type = Variant::BOOL;
  970. // Check type equality.
  971. GDScriptCodeGenerator::Address type_equality_addr = codegen.add_temporary(equality_type);
  972. codegen.generator->write_binary_operator(type_equality_addr, Variant::OP_EQUAL, p_type_addr, literal_type_addr);
  973. codegen.generator->write_and_left_operand(type_equality_addr);
  974. // Get literal.
  975. GDScriptCodeGenerator::Address literal_addr = _parse_expression(codegen, r_error, p_pattern->literal);
  976. if (r_error) {
  977. return GDScriptCodeGenerator::Address();
  978. }
  979. // Check value equality.
  980. GDScriptCodeGenerator::Address equality_addr = codegen.add_temporary(equality_type);
  981. codegen.generator->write_binary_operator(equality_addr, Variant::OP_EQUAL, p_value_addr, literal_addr);
  982. codegen.generator->write_and_right_operand(equality_addr);
  983. // AND both together (reuse temporary location).
  984. codegen.generator->write_end_and(type_equality_addr);
  985. codegen.generator->pop_temporary(); // Remove equality_addr from stack.
  986. if (literal_addr.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  987. codegen.generator->pop_temporary();
  988. }
  989. // If this isn't the first, we need to OR with the previous pattern. If it's nested, we use AND instead.
  990. if (p_is_nested) {
  991. // Use the previous value as target, since we only need one temporary variable.
  992. codegen.generator->write_and_right_operand(type_equality_addr);
  993. codegen.generator->write_end_and(p_previous_test);
  994. } else if (!p_is_first) {
  995. // Use the previous value as target, since we only need one temporary variable.
  996. codegen.generator->write_or_right_operand(type_equality_addr);
  997. codegen.generator->write_end_or(p_previous_test);
  998. } else {
  999. // Just assign this value to the accumulator temporary.
  1000. codegen.generator->write_assign(p_previous_test, type_equality_addr);
  1001. }
  1002. codegen.generator->pop_temporary(); // Remove type_equality_addr.
  1003. return p_previous_test;
  1004. } break;
  1005. case GDScriptParser::PatternNode::PT_EXPRESSION: {
  1006. if (p_is_nested) {
  1007. codegen.generator->write_and_left_operand(p_previous_test);
  1008. } else if (!p_is_first) {
  1009. codegen.generator->write_or_left_operand(p_previous_test);
  1010. }
  1011. // Create the result temps first since it's the last to go away.
  1012. GDScriptCodeGenerator::Address result_addr = codegen.add_temporary();
  1013. GDScriptCodeGenerator::Address equality_test_addr = codegen.add_temporary();
  1014. // Evaluate expression.
  1015. GDScriptCodeGenerator::Address expr_addr;
  1016. expr_addr = _parse_expression(codegen, r_error, p_pattern->expression);
  1017. if (r_error) {
  1018. return GDScriptCodeGenerator::Address();
  1019. }
  1020. // Evaluate expression type.
  1021. Vector<GDScriptCodeGenerator::Address> typeof_args;
  1022. typeof_args.push_back(expr_addr);
  1023. codegen.generator->write_call_utility(result_addr, "typeof", typeof_args);
  1024. // Check type equality.
  1025. codegen.generator->write_binary_operator(result_addr, Variant::OP_EQUAL, p_type_addr, result_addr);
  1026. codegen.generator->write_and_left_operand(result_addr);
  1027. // Check value equality.
  1028. codegen.generator->write_binary_operator(equality_test_addr, Variant::OP_EQUAL, p_value_addr, expr_addr);
  1029. codegen.generator->write_and_right_operand(equality_test_addr);
  1030. // AND both type and value equality.
  1031. codegen.generator->write_end_and(result_addr);
  1032. // We don't need the expression temporary anymore.
  1033. if (expr_addr.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1034. codegen.generator->pop_temporary();
  1035. }
  1036. codegen.generator->pop_temporary(); // Remove type equality temporary.
  1037. // If this isn't the first, we need to OR with the previous pattern. If it's nested, we use AND instead.
  1038. if (p_is_nested) {
  1039. // Use the previous value as target, since we only need one temporary variable.
  1040. codegen.generator->write_and_right_operand(result_addr);
  1041. codegen.generator->write_end_and(p_previous_test);
  1042. } else if (!p_is_first) {
  1043. // Use the previous value as target, since we only need one temporary variable.
  1044. codegen.generator->write_or_right_operand(result_addr);
  1045. codegen.generator->write_end_or(p_previous_test);
  1046. } else {
  1047. // Just assign this value to the accumulator temporary.
  1048. codegen.generator->write_assign(p_previous_test, result_addr);
  1049. }
  1050. codegen.generator->pop_temporary(); // Remove temp result addr.
  1051. return p_previous_test;
  1052. } break;
  1053. case GDScriptParser::PatternNode::PT_ARRAY: {
  1054. if (p_is_nested) {
  1055. codegen.generator->write_and_left_operand(p_previous_test);
  1056. } else if (!p_is_first) {
  1057. codegen.generator->write_or_left_operand(p_previous_test);
  1058. }
  1059. // Get array type into constant map.
  1060. GDScriptCodeGenerator::Address array_type_addr = codegen.add_constant((int)Variant::ARRAY);
  1061. // Equality is always a boolean.
  1062. GDScriptDataType temp_type;
  1063. temp_type.has_type = true;
  1064. temp_type.kind = GDScriptDataType::BUILTIN;
  1065. temp_type.builtin_type = Variant::BOOL;
  1066. // Check type equality.
  1067. GDScriptCodeGenerator::Address result_addr = codegen.add_temporary(temp_type);
  1068. codegen.generator->write_binary_operator(result_addr, Variant::OP_EQUAL, p_type_addr, array_type_addr);
  1069. codegen.generator->write_and_left_operand(result_addr);
  1070. // Store pattern length in constant map.
  1071. GDScriptCodeGenerator::Address array_length_addr = codegen.add_constant(p_pattern->rest_used ? p_pattern->array.size() - 1 : p_pattern->array.size());
  1072. // Get value length.
  1073. temp_type.builtin_type = Variant::INT;
  1074. GDScriptCodeGenerator::Address value_length_addr = codegen.add_temporary(temp_type);
  1075. Vector<GDScriptCodeGenerator::Address> len_args;
  1076. len_args.push_back(p_value_addr);
  1077. codegen.generator->write_call_gdscript_utility(value_length_addr, GDScriptUtilityFunctions::get_function("len"), len_args);
  1078. // Test length compatibility.
  1079. temp_type.builtin_type = Variant::BOOL;
  1080. GDScriptCodeGenerator::Address length_compat_addr = codegen.add_temporary(temp_type);
  1081. codegen.generator->write_binary_operator(length_compat_addr, p_pattern->rest_used ? Variant::OP_GREATER_EQUAL : Variant::OP_EQUAL, value_length_addr, array_length_addr);
  1082. codegen.generator->write_and_right_operand(length_compat_addr);
  1083. // AND type and length check.
  1084. codegen.generator->write_end_and(result_addr);
  1085. // Remove length temporaries.
  1086. codegen.generator->pop_temporary();
  1087. codegen.generator->pop_temporary();
  1088. // If this isn't the first, we need to OR with the previous pattern. If it's nested, we use AND instead.
  1089. if (p_is_nested) {
  1090. // Use the previous value as target, since we only need one temporary variable.
  1091. codegen.generator->write_and_right_operand(result_addr);
  1092. codegen.generator->write_end_and(p_previous_test);
  1093. } else if (!p_is_first) {
  1094. // Use the previous value as target, since we only need one temporary variable.
  1095. codegen.generator->write_or_right_operand(result_addr);
  1096. codegen.generator->write_end_or(p_previous_test);
  1097. } else {
  1098. // Just assign this value to the accumulator temporary.
  1099. codegen.generator->write_assign(p_previous_test, result_addr);
  1100. }
  1101. codegen.generator->pop_temporary(); // Remove temp result addr.
  1102. // Create temporaries outside the loop so they can be reused.
  1103. GDScriptCodeGenerator::Address element_addr = codegen.add_temporary();
  1104. GDScriptCodeGenerator::Address element_type_addr = codegen.add_temporary();
  1105. GDScriptCodeGenerator::Address test_addr = p_previous_test;
  1106. // Evaluate element by element.
  1107. for (int i = 0; i < p_pattern->array.size(); i++) {
  1108. if (p_pattern->array[i]->pattern_type == GDScriptParser::PatternNode::PT_REST) {
  1109. // Don't want to access an extra element of the user array.
  1110. break;
  1111. }
  1112. // Use AND here too, as we don't want to be checking elements if previous test failed (which means this might be an invalid get).
  1113. codegen.generator->write_and_left_operand(test_addr);
  1114. // Add index to constant map.
  1115. GDScriptCodeGenerator::Address index_addr = codegen.add_constant(i);
  1116. // Get the actual element from the user-sent array.
  1117. codegen.generator->write_get(element_addr, index_addr, p_value_addr);
  1118. // Also get type of element.
  1119. Vector<GDScriptCodeGenerator::Address> typeof_args;
  1120. typeof_args.push_back(element_addr);
  1121. codegen.generator->write_call_utility(element_type_addr, "typeof", typeof_args);
  1122. // Try the pattern inside the element.
  1123. test_addr = _parse_match_pattern(codegen, r_error, p_pattern->array[i], element_addr, element_type_addr, p_previous_test, false, true);
  1124. if (r_error != OK) {
  1125. return GDScriptCodeGenerator::Address();
  1126. }
  1127. codegen.generator->write_and_right_operand(test_addr);
  1128. codegen.generator->write_end_and(test_addr);
  1129. }
  1130. // Remove element temporaries.
  1131. codegen.generator->pop_temporary();
  1132. codegen.generator->pop_temporary();
  1133. return test_addr;
  1134. } break;
  1135. case GDScriptParser::PatternNode::PT_DICTIONARY: {
  1136. if (p_is_nested) {
  1137. codegen.generator->write_and_left_operand(p_previous_test);
  1138. } else if (!p_is_first) {
  1139. codegen.generator->write_or_left_operand(p_previous_test);
  1140. }
  1141. // Get dictionary type into constant map.
  1142. GDScriptCodeGenerator::Address dict_type_addr = codegen.add_constant((int)Variant::DICTIONARY);
  1143. // Equality is always a boolean.
  1144. GDScriptDataType temp_type;
  1145. temp_type.has_type = true;
  1146. temp_type.kind = GDScriptDataType::BUILTIN;
  1147. temp_type.builtin_type = Variant::BOOL;
  1148. // Check type equality.
  1149. GDScriptCodeGenerator::Address result_addr = codegen.add_temporary(temp_type);
  1150. codegen.generator->write_binary_operator(result_addr, Variant::OP_EQUAL, p_type_addr, dict_type_addr);
  1151. codegen.generator->write_and_left_operand(result_addr);
  1152. // Store pattern length in constant map.
  1153. GDScriptCodeGenerator::Address dict_length_addr = codegen.add_constant(p_pattern->rest_used ? p_pattern->dictionary.size() - 1 : p_pattern->dictionary.size());
  1154. // Get user's dictionary length.
  1155. temp_type.builtin_type = Variant::INT;
  1156. GDScriptCodeGenerator::Address value_length_addr = codegen.add_temporary(temp_type);
  1157. Vector<GDScriptCodeGenerator::Address> func_args;
  1158. func_args.push_back(p_value_addr);
  1159. codegen.generator->write_call_gdscript_utility(value_length_addr, GDScriptUtilityFunctions::get_function("len"), func_args);
  1160. // Test length compatibility.
  1161. temp_type.builtin_type = Variant::BOOL;
  1162. GDScriptCodeGenerator::Address length_compat_addr = codegen.add_temporary(temp_type);
  1163. codegen.generator->write_binary_operator(length_compat_addr, p_pattern->rest_used ? Variant::OP_GREATER_EQUAL : Variant::OP_EQUAL, value_length_addr, dict_length_addr);
  1164. codegen.generator->write_and_right_operand(length_compat_addr);
  1165. // AND type and length check.
  1166. codegen.generator->write_end_and(result_addr);
  1167. // Remove length temporaries.
  1168. codegen.generator->pop_temporary();
  1169. codegen.generator->pop_temporary();
  1170. // If this isn't the first, we need to OR with the previous pattern. If it's nested, we use AND instead.
  1171. if (p_is_nested) {
  1172. // Use the previous value as target, since we only need one temporary variable.
  1173. codegen.generator->write_and_right_operand(result_addr);
  1174. codegen.generator->write_end_and(p_previous_test);
  1175. } else if (!p_is_first) {
  1176. // Use the previous value as target, since we only need one temporary variable.
  1177. codegen.generator->write_or_right_operand(result_addr);
  1178. codegen.generator->write_end_or(p_previous_test);
  1179. } else {
  1180. // Just assign this value to the accumulator temporary.
  1181. codegen.generator->write_assign(p_previous_test, result_addr);
  1182. }
  1183. codegen.generator->pop_temporary(); // Remove temp result addr.
  1184. // Create temporaries outside the loop so they can be reused.
  1185. temp_type.builtin_type = Variant::BOOL;
  1186. GDScriptCodeGenerator::Address test_result = codegen.add_temporary(temp_type);
  1187. GDScriptCodeGenerator::Address element_addr = codegen.add_temporary();
  1188. GDScriptCodeGenerator::Address element_type_addr = codegen.add_temporary();
  1189. GDScriptCodeGenerator::Address test_addr = p_previous_test;
  1190. // Evaluate element by element.
  1191. for (int i = 0; i < p_pattern->dictionary.size(); i++) {
  1192. const GDScriptParser::PatternNode::Pair &element = p_pattern->dictionary[i];
  1193. if (element.value_pattern && element.value_pattern->pattern_type == GDScriptParser::PatternNode::PT_REST) {
  1194. // Ignore rest pattern.
  1195. break;
  1196. }
  1197. // Use AND here too, as we don't want to be checking elements if previous test failed (which means this might be an invalid get).
  1198. codegen.generator->write_and_left_operand(test_addr);
  1199. // Get the pattern key.
  1200. GDScriptCodeGenerator::Address pattern_key_addr = _parse_expression(codegen, r_error, element.key);
  1201. if (r_error) {
  1202. return GDScriptCodeGenerator::Address();
  1203. }
  1204. // Check if pattern key exists in user's dictionary. This will be AND-ed with next result.
  1205. func_args.clear();
  1206. func_args.push_back(pattern_key_addr);
  1207. codegen.generator->write_call(test_result, p_value_addr, "has", func_args);
  1208. if (element.value_pattern != nullptr) {
  1209. // Use AND here too, as we don't want to be checking elements if previous test failed (which means this might be an invalid get).
  1210. codegen.generator->write_and_left_operand(test_result);
  1211. // Get actual value from user dictionary.
  1212. codegen.generator->write_get(element_addr, pattern_key_addr, p_value_addr);
  1213. // Also get type of value.
  1214. func_args.clear();
  1215. func_args.push_back(element_addr);
  1216. codegen.generator->write_call_utility(element_type_addr, "typeof", func_args);
  1217. // Try the pattern inside the value.
  1218. test_addr = _parse_match_pattern(codegen, r_error, element.value_pattern, element_addr, element_type_addr, test_addr, false, true);
  1219. if (r_error != OK) {
  1220. return GDScriptCodeGenerator::Address();
  1221. }
  1222. codegen.generator->write_and_right_operand(test_addr);
  1223. codegen.generator->write_end_and(test_addr);
  1224. }
  1225. codegen.generator->write_and_right_operand(test_addr);
  1226. codegen.generator->write_end_and(test_addr);
  1227. // Remove pattern key temporary.
  1228. if (pattern_key_addr.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1229. codegen.generator->pop_temporary();
  1230. }
  1231. }
  1232. // Remove element temporaries.
  1233. codegen.generator->pop_temporary();
  1234. codegen.generator->pop_temporary();
  1235. codegen.generator->pop_temporary();
  1236. return test_addr;
  1237. } break;
  1238. case GDScriptParser::PatternNode::PT_REST:
  1239. // Do nothing.
  1240. return p_previous_test;
  1241. break;
  1242. case GDScriptParser::PatternNode::PT_BIND: {
  1243. if (p_is_nested) {
  1244. codegen.generator->write_and_left_operand(p_previous_test);
  1245. } else if (!p_is_first) {
  1246. codegen.generator->write_or_left_operand(p_previous_test);
  1247. }
  1248. // Get the bind address.
  1249. GDScriptCodeGenerator::Address bind = codegen.locals[p_pattern->bind->name];
  1250. // Assign value to bound variable.
  1251. codegen.generator->write_assign(bind, p_value_addr);
  1252. }
  1253. [[fallthrough]]; // Act like matching anything too.
  1254. case GDScriptParser::PatternNode::PT_WILDCARD:
  1255. // If this is a fall through we don't want to do this again.
  1256. if (p_pattern->pattern_type != GDScriptParser::PatternNode::PT_BIND) {
  1257. if (p_is_nested) {
  1258. codegen.generator->write_and_left_operand(p_previous_test);
  1259. } else if (!p_is_first) {
  1260. codegen.generator->write_or_left_operand(p_previous_test);
  1261. }
  1262. }
  1263. // This matches anything so just do the same as `if(true)`.
  1264. // If this isn't the first, we need to OR with the previous pattern. If it's nested, we use AND instead.
  1265. if (p_is_nested) {
  1266. // Use the operator with the `true` constant so it works as always matching.
  1267. GDScriptCodeGenerator::Address constant = codegen.add_constant(true);
  1268. codegen.generator->write_and_right_operand(constant);
  1269. codegen.generator->write_end_and(p_previous_test);
  1270. } else if (!p_is_first) {
  1271. // Use the operator with the `true` constant so it works as always matching.
  1272. GDScriptCodeGenerator::Address constant = codegen.add_constant(true);
  1273. codegen.generator->write_or_right_operand(constant);
  1274. codegen.generator->write_end_or(p_previous_test);
  1275. } else {
  1276. // Just assign this value to the accumulator temporary.
  1277. codegen.generator->write_assign_true(p_previous_test);
  1278. }
  1279. return p_previous_test;
  1280. }
  1281. ERR_FAIL_V_MSG(p_previous_test, "Reaching the end of pattern compilation without matching a pattern.");
  1282. }
  1283. void GDScriptCompiler::_add_locals_in_block(CodeGen &codegen, const GDScriptParser::SuiteNode *p_block) {
  1284. for (int i = 0; i < p_block->locals.size(); i++) {
  1285. if (p_block->locals[i].type == GDScriptParser::SuiteNode::Local::PARAMETER || p_block->locals[i].type == GDScriptParser::SuiteNode::Local::FOR_VARIABLE) {
  1286. // Parameters are added directly from function and loop variables are declared explicitly.
  1287. continue;
  1288. }
  1289. codegen.add_local(p_block->locals[i].name, _gdtype_from_datatype(p_block->locals[i].get_datatype()));
  1290. }
  1291. }
  1292. Error GDScriptCompiler::_parse_block(CodeGen &codegen, const GDScriptParser::SuiteNode *p_block, bool p_add_locals) {
  1293. Error error = OK;
  1294. GDScriptCodeGenerator *gen = codegen.generator;
  1295. codegen.start_block();
  1296. if (p_add_locals) {
  1297. _add_locals_in_block(codegen, p_block);
  1298. }
  1299. for (int i = 0; i < p_block->statements.size(); i++) {
  1300. const GDScriptParser::Node *s = p_block->statements[i];
  1301. #ifdef DEBUG_ENABLED
  1302. // Add a newline before each statement, since the debugger needs those.
  1303. gen->write_newline(s->start_line);
  1304. #endif
  1305. switch (s->type) {
  1306. case GDScriptParser::Node::MATCH: {
  1307. const GDScriptParser::MatchNode *match = static_cast<const GDScriptParser::MatchNode *>(s);
  1308. gen->start_match();
  1309. codegen.start_block();
  1310. // Evaluate the match expression.
  1311. GDScriptCodeGenerator::Address value_local = codegen.add_local("@match_value", _gdtype_from_datatype(match->test->get_datatype()));
  1312. GDScriptCodeGenerator::Address value = _parse_expression(codegen, error, match->test);
  1313. if (error) {
  1314. return error;
  1315. }
  1316. // Assign to local.
  1317. // TODO: This can be improved by passing the target to parse_expression().
  1318. gen->write_assign(value_local, value);
  1319. if (value.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1320. codegen.generator->pop_temporary();
  1321. }
  1322. // Then, let's save the type of the value in the stack too, so we can reuse for later comparisons.
  1323. GDScriptDataType typeof_type;
  1324. typeof_type.has_type = true;
  1325. typeof_type.kind = GDScriptDataType::BUILTIN;
  1326. typeof_type.builtin_type = Variant::INT;
  1327. GDScriptCodeGenerator::Address type = codegen.add_local("@match_type", typeof_type);
  1328. Vector<GDScriptCodeGenerator::Address> typeof_args;
  1329. typeof_args.push_back(value);
  1330. gen->write_call_utility(type, "typeof", typeof_args);
  1331. // Now we can actually start testing.
  1332. // For each branch.
  1333. for (int j = 0; j < match->branches.size(); j++) {
  1334. if (j > 0) {
  1335. // Use `else` to not check the next branch after matching.
  1336. gen->write_else();
  1337. }
  1338. const GDScriptParser::MatchBranchNode *branch = match->branches[j];
  1339. gen->start_match_branch(); // Need so lower level code can patch 'continue' jumps.
  1340. codegen.start_block(); // Create an extra block around for binds.
  1341. // Add locals in block before patterns, so temporaries don't use the stack address for binds.
  1342. _add_locals_in_block(codegen, branch->block);
  1343. #ifdef DEBUG_ENABLED
  1344. // Add a newline before each branch, since the debugger needs those.
  1345. gen->write_newline(branch->start_line);
  1346. #endif
  1347. // For each pattern in branch.
  1348. GDScriptCodeGenerator::Address pattern_result = codegen.add_temporary();
  1349. for (int k = 0; k < branch->patterns.size(); k++) {
  1350. pattern_result = _parse_match_pattern(codegen, error, branch->patterns[k], value, type, pattern_result, k == 0, false);
  1351. if (error != OK) {
  1352. return error;
  1353. }
  1354. }
  1355. // Check if pattern did match.
  1356. gen->write_if(pattern_result);
  1357. // Remove the result from stack.
  1358. gen->pop_temporary();
  1359. // Parse the branch block.
  1360. error = _parse_block(codegen, branch->block, false); // Don't add locals again.
  1361. if (error) {
  1362. return error;
  1363. }
  1364. codegen.end_block(); // Get out of extra block.
  1365. }
  1366. // End all nested `if`s.
  1367. for (int j = 0; j < match->branches.size(); j++) {
  1368. gen->write_endif();
  1369. }
  1370. gen->end_match();
  1371. } break;
  1372. case GDScriptParser::Node::IF: {
  1373. const GDScriptParser::IfNode *if_n = static_cast<const GDScriptParser::IfNode *>(s);
  1374. GDScriptCodeGenerator::Address condition = _parse_expression(codegen, error, if_n->condition);
  1375. if (error) {
  1376. return error;
  1377. }
  1378. gen->write_if(condition);
  1379. if (condition.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1380. codegen.generator->pop_temporary();
  1381. }
  1382. error = _parse_block(codegen, if_n->true_block);
  1383. if (error) {
  1384. return error;
  1385. }
  1386. if (if_n->false_block) {
  1387. gen->write_else();
  1388. error = _parse_block(codegen, if_n->false_block);
  1389. if (error) {
  1390. return error;
  1391. }
  1392. }
  1393. gen->write_endif();
  1394. } break;
  1395. case GDScriptParser::Node::FOR: {
  1396. const GDScriptParser::ForNode *for_n = static_cast<const GDScriptParser::ForNode *>(s);
  1397. codegen.start_block();
  1398. GDScriptCodeGenerator::Address iterator = codegen.add_local(for_n->variable->name, _gdtype_from_datatype(for_n->variable->get_datatype()));
  1399. gen->start_for(iterator.type, _gdtype_from_datatype(for_n->list->get_datatype()));
  1400. GDScriptCodeGenerator::Address list = _parse_expression(codegen, error, for_n->list);
  1401. if (error) {
  1402. return error;
  1403. }
  1404. gen->write_for_assignment(iterator, list);
  1405. if (list.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1406. codegen.generator->pop_temporary();
  1407. }
  1408. gen->write_for();
  1409. error = _parse_block(codegen, for_n->loop);
  1410. if (error) {
  1411. return error;
  1412. }
  1413. gen->write_endfor();
  1414. codegen.end_block();
  1415. } break;
  1416. case GDScriptParser::Node::WHILE: {
  1417. const GDScriptParser::WhileNode *while_n = static_cast<const GDScriptParser::WhileNode *>(s);
  1418. gen->start_while_condition();
  1419. GDScriptCodeGenerator::Address condition = _parse_expression(codegen, error, while_n->condition);
  1420. if (error) {
  1421. return error;
  1422. }
  1423. gen->write_while(condition);
  1424. if (condition.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1425. codegen.generator->pop_temporary();
  1426. }
  1427. error = _parse_block(codegen, while_n->loop);
  1428. if (error) {
  1429. return error;
  1430. }
  1431. gen->write_endwhile();
  1432. } break;
  1433. case GDScriptParser::Node::BREAK: {
  1434. gen->write_break();
  1435. } break;
  1436. case GDScriptParser::Node::CONTINUE: {
  1437. const GDScriptParser::ContinueNode *cont = static_cast<const GDScriptParser::ContinueNode *>(s);
  1438. if (cont->is_for_match) {
  1439. gen->write_continue_match();
  1440. } else {
  1441. gen->write_continue();
  1442. }
  1443. } break;
  1444. case GDScriptParser::Node::RETURN: {
  1445. const GDScriptParser::ReturnNode *return_n = static_cast<const GDScriptParser::ReturnNode *>(s);
  1446. GDScriptCodeGenerator::Address return_value;
  1447. if (return_n->return_value != nullptr) {
  1448. return_value = _parse_expression(codegen, error, return_n->return_value);
  1449. if (error) {
  1450. return error;
  1451. }
  1452. }
  1453. gen->write_return(return_value);
  1454. if (return_value.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1455. codegen.generator->pop_temporary();
  1456. }
  1457. } break;
  1458. case GDScriptParser::Node::ASSERT: {
  1459. #ifdef DEBUG_ENABLED
  1460. const GDScriptParser::AssertNode *as = static_cast<const GDScriptParser::AssertNode *>(s);
  1461. GDScriptCodeGenerator::Address condition = _parse_expression(codegen, error, as->condition);
  1462. if (error) {
  1463. return error;
  1464. }
  1465. GDScriptCodeGenerator::Address message;
  1466. if (as->message) {
  1467. message = _parse_expression(codegen, error, as->message);
  1468. if (error) {
  1469. return error;
  1470. }
  1471. }
  1472. gen->write_assert(condition, message);
  1473. if (condition.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1474. codegen.generator->pop_temporary();
  1475. }
  1476. if (message.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1477. codegen.generator->pop_temporary();
  1478. }
  1479. #endif
  1480. } break;
  1481. case GDScriptParser::Node::BREAKPOINT: {
  1482. #ifdef DEBUG_ENABLED
  1483. gen->write_breakpoint();
  1484. #endif
  1485. } break;
  1486. case GDScriptParser::Node::VARIABLE: {
  1487. const GDScriptParser::VariableNode *lv = static_cast<const GDScriptParser::VariableNode *>(s);
  1488. // Should be already in stack when the block began.
  1489. GDScriptCodeGenerator::Address local = codegen.locals[lv->identifier->name];
  1490. if (lv->initializer != nullptr) {
  1491. GDScriptCodeGenerator::Address src_address = _parse_expression(codegen, error, lv->initializer);
  1492. if (error) {
  1493. return error;
  1494. }
  1495. gen->write_assign(local, src_address);
  1496. if (src_address.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1497. codegen.generator->pop_temporary();
  1498. }
  1499. }
  1500. } break;
  1501. case GDScriptParser::Node::CONSTANT: {
  1502. // Local constants.
  1503. const GDScriptParser::ConstantNode *lc = static_cast<const GDScriptParser::ConstantNode *>(s);
  1504. if (!lc->initializer->is_constant) {
  1505. _set_error("Local constant must have a constant value as initializer.", lc->initializer);
  1506. return ERR_PARSE_ERROR;
  1507. }
  1508. codegen.add_local_constant(lc->identifier->name, lc->initializer->reduced_value);
  1509. } break;
  1510. case GDScriptParser::Node::PASS:
  1511. // Nothing to do.
  1512. break;
  1513. default: {
  1514. // Expression.
  1515. if (s->is_expression()) {
  1516. GDScriptCodeGenerator::Address expr = _parse_expression(codegen, error, static_cast<const GDScriptParser::ExpressionNode *>(s), true);
  1517. if (error) {
  1518. return error;
  1519. }
  1520. if (expr.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1521. codegen.generator->pop_temporary();
  1522. }
  1523. } else {
  1524. ERR_FAIL_V_MSG(ERR_INVALID_DATA, "Bug in bytecode compiler, unexpected node in parse tree while parsing statement."); // Unreachable code.
  1525. }
  1526. } break;
  1527. }
  1528. }
  1529. codegen.end_block();
  1530. return OK;
  1531. }
  1532. Error GDScriptCompiler::_parse_function(GDScript *p_script, const GDScriptParser::ClassNode *p_class, const GDScriptParser::FunctionNode *p_func, bool p_for_ready) {
  1533. Error error = OK;
  1534. CodeGen codegen;
  1535. codegen.generator = memnew(GDScriptByteCodeGenerator);
  1536. codegen.class_node = p_class;
  1537. codegen.script = p_script;
  1538. codegen.function_node = p_func;
  1539. StringName func_name;
  1540. bool is_static = false;
  1541. MultiplayerAPI::RPCMode rpc_mode = MultiplayerAPI::RPC_MODE_DISABLED;
  1542. GDScriptDataType return_type;
  1543. return_type.has_type = true;
  1544. return_type.kind = GDScriptDataType::BUILTIN;
  1545. return_type.builtin_type = Variant::NIL;
  1546. if (p_func) {
  1547. func_name = p_func->identifier->name;
  1548. is_static = p_func->is_static;
  1549. rpc_mode = p_func->rpc_mode;
  1550. return_type = _gdtype_from_datatype(p_func->get_datatype(), p_script);
  1551. } else {
  1552. if (p_for_ready) {
  1553. func_name = "_ready";
  1554. } else {
  1555. func_name = "@implicit_new";
  1556. }
  1557. }
  1558. codegen.function_name = func_name;
  1559. codegen.generator->write_start(p_script, func_name, is_static, rpc_mode, return_type);
  1560. int optional_parameters = 0;
  1561. if (p_func) {
  1562. for (int i = 0; i < p_func->parameters.size(); i++) {
  1563. const GDScriptParser::ParameterNode *parameter = p_func->parameters[i];
  1564. GDScriptDataType par_type = _gdtype_from_datatype(parameter->get_datatype(), p_script);
  1565. uint32_t par_addr = codegen.generator->add_parameter(parameter->identifier->name, parameter->default_value != nullptr, par_type);
  1566. codegen.parameters[parameter->identifier->name] = GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::FUNCTION_PARAMETER, par_addr, par_type);
  1567. if (p_func->parameters[i]->default_value != nullptr) {
  1568. optional_parameters++;
  1569. }
  1570. }
  1571. }
  1572. // Parse initializer if applies.
  1573. bool is_implicit_initializer = !p_for_ready && !p_func;
  1574. bool is_initializer = p_func && String(p_func->identifier->name) == GDScriptLanguage::get_singleton()->strings._init;
  1575. bool is_for_ready = p_for_ready || (p_func && String(p_func->identifier->name) == "_ready");
  1576. if (is_implicit_initializer || is_for_ready) {
  1577. // Initialize class fields.
  1578. for (int i = 0; i < p_class->members.size(); i++) {
  1579. if (p_class->members[i].type != GDScriptParser::ClassNode::Member::VARIABLE) {
  1580. continue;
  1581. }
  1582. const GDScriptParser::VariableNode *field = p_class->members[i].variable;
  1583. if (field->onready != is_for_ready) {
  1584. // Only initialize in _ready.
  1585. continue;
  1586. }
  1587. if (field->initializer) {
  1588. // Emit proper line change.
  1589. codegen.generator->write_newline(field->initializer->start_line);
  1590. GDScriptCodeGenerator::Address src_address = _parse_expression(codegen, error, field->initializer, false, true);
  1591. if (error) {
  1592. memdelete(codegen.generator);
  1593. return error;
  1594. }
  1595. GDScriptCodeGenerator::Address dst_address(GDScriptCodeGenerator::Address::MEMBER, codegen.script->member_indices[field->identifier->name].index, _gdtype_from_datatype(field->get_datatype()));
  1596. codegen.generator->write_assign(dst_address, src_address);
  1597. if (src_address.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1598. codegen.generator->pop_temporary();
  1599. }
  1600. }
  1601. }
  1602. }
  1603. // Parse default argument code if applies.
  1604. if (p_func) {
  1605. if (optional_parameters > 0) {
  1606. codegen.generator->start_parameters();
  1607. for (int i = p_func->parameters.size() - optional_parameters; i < p_func->parameters.size(); i++) {
  1608. const GDScriptParser::ParameterNode *parameter = p_func->parameters[i];
  1609. GDScriptCodeGenerator::Address src_addr = _parse_expression(codegen, error, parameter->default_value, true);
  1610. if (error) {
  1611. memdelete(codegen.generator);
  1612. return error;
  1613. }
  1614. GDScriptCodeGenerator::Address dst_addr = codegen.parameters[parameter->identifier->name];
  1615. codegen.generator->write_assign_default_parameter(dst_addr, src_addr);
  1616. if (src_addr.mode == GDScriptCodeGenerator::Address::TEMPORARY) {
  1617. codegen.generator->pop_temporary();
  1618. }
  1619. }
  1620. codegen.generator->end_parameters();
  1621. }
  1622. Error err = _parse_block(codegen, p_func->body);
  1623. if (err) {
  1624. memdelete(codegen.generator);
  1625. return err;
  1626. }
  1627. }
  1628. #ifdef DEBUG_ENABLED
  1629. if (EngineDebugger::is_active()) {
  1630. String signature;
  1631. // Path.
  1632. if (p_script->get_path() != String()) {
  1633. signature += p_script->get_path();
  1634. }
  1635. // Location.
  1636. if (p_func) {
  1637. signature += "::" + itos(p_func->body->start_line);
  1638. } else {
  1639. signature += "::0";
  1640. }
  1641. // Function and class.
  1642. if (p_class->identifier) {
  1643. signature += "::" + String(p_class->identifier->name) + "." + String(func_name);
  1644. } else {
  1645. signature += "::" + String(func_name);
  1646. }
  1647. codegen.generator->set_signature(signature);
  1648. }
  1649. #endif
  1650. if (p_func) {
  1651. codegen.generator->set_initial_line(p_func->start_line);
  1652. #ifdef TOOLS_ENABLED
  1653. p_script->member_lines[func_name] = p_func->start_line;
  1654. p_script->doc_functions[func_name] = p_func->doc_description;
  1655. #endif
  1656. } else {
  1657. codegen.generator->set_initial_line(0);
  1658. }
  1659. GDScriptFunction *gd_function = codegen.generator->write_end();
  1660. if (is_initializer) {
  1661. p_script->initializer = gd_function;
  1662. } else if (is_implicit_initializer) {
  1663. p_script->implicit_initializer = gd_function;
  1664. }
  1665. if (p_func) {
  1666. // if no return statement -> return type is void not unresolved Variant
  1667. if (p_func->body->has_return) {
  1668. gd_function->return_type = _gdtype_from_datatype(p_func->get_datatype());
  1669. } else {
  1670. gd_function->return_type = GDScriptDataType();
  1671. gd_function->return_type.has_type = true;
  1672. gd_function->return_type.kind = GDScriptDataType::BUILTIN;
  1673. gd_function->return_type.builtin_type = Variant::NIL;
  1674. }
  1675. #ifdef TOOLS_ENABLED
  1676. gd_function->default_arg_values = p_func->default_arg_values;
  1677. #endif
  1678. }
  1679. p_script->member_functions[func_name] = gd_function;
  1680. memdelete(codegen.generator);
  1681. return OK;
  1682. }
  1683. Error GDScriptCompiler::_parse_setter_getter(GDScript *p_script, const GDScriptParser::ClassNode *p_class, const GDScriptParser::VariableNode *p_variable, bool p_is_setter) {
  1684. Error error = OK;
  1685. CodeGen codegen;
  1686. codegen.generator = memnew(GDScriptByteCodeGenerator);
  1687. codegen.class_node = p_class;
  1688. codegen.script = p_script;
  1689. StringName func_name;
  1690. if (p_is_setter) {
  1691. func_name = "@" + p_variable->identifier->name + "_setter";
  1692. } else {
  1693. func_name = "@" + p_variable->identifier->name + "_getter";
  1694. }
  1695. GDScriptDataType return_type;
  1696. if (p_is_setter) {
  1697. return_type.has_type = true;
  1698. return_type.kind = GDScriptDataType::BUILTIN;
  1699. return_type.builtin_type = Variant::NIL;
  1700. } else {
  1701. return_type = _gdtype_from_datatype(p_variable->get_datatype(), p_script);
  1702. }
  1703. codegen.generator->write_start(p_script, func_name, false, p_variable->rpc_mode, return_type);
  1704. if (p_is_setter) {
  1705. uint32_t par_addr = codegen.generator->add_parameter(p_variable->setter_parameter->name, false, _gdtype_from_datatype(p_variable->get_datatype()));
  1706. codegen.parameters[p_variable->setter_parameter->name] = GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::FUNCTION_PARAMETER, par_addr, _gdtype_from_datatype(p_variable->get_datatype()));
  1707. }
  1708. error = _parse_block(codegen, p_is_setter ? p_variable->setter : p_variable->getter);
  1709. if (error) {
  1710. memdelete(codegen.generator);
  1711. return error;
  1712. }
  1713. GDScriptFunction *gd_function = codegen.generator->write_end();
  1714. p_script->member_functions[func_name] = gd_function;
  1715. #ifdef DEBUG_ENABLED
  1716. if (EngineDebugger::is_active()) {
  1717. String signature;
  1718. //path
  1719. if (p_script->get_path() != String()) {
  1720. signature += p_script->get_path();
  1721. }
  1722. //loc
  1723. signature += "::" + itos(p_is_setter ? p_variable->setter->start_line : p_variable->getter->start_line);
  1724. //function and class
  1725. if (p_class->identifier) {
  1726. signature += "::" + String(p_class->identifier->name) + "." + String(func_name);
  1727. } else {
  1728. signature += "::" + String(func_name);
  1729. }
  1730. codegen.generator->set_signature(signature);
  1731. }
  1732. #endif
  1733. codegen.generator->set_initial_line(p_is_setter ? p_variable->setter->start_line : p_variable->getter->start_line);
  1734. #ifdef TOOLS_ENABLED
  1735. p_script->member_lines[func_name] = p_is_setter ? p_variable->setter->start_line : p_variable->getter->start_line;
  1736. #endif
  1737. memdelete(codegen.generator);
  1738. return OK;
  1739. }
  1740. Error GDScriptCompiler::_parse_class_level(GDScript *p_script, const GDScriptParser::ClassNode *p_class, bool p_keep_state) {
  1741. parsing_classes.insert(p_script);
  1742. if (p_class->outer && p_class->outer->outer) {
  1743. // Owner is not root
  1744. if (!parsed_classes.has(p_script->_owner)) {
  1745. if (parsing_classes.has(p_script->_owner)) {
  1746. _set_error("Cyclic class reference for '" + String(p_class->identifier->name) + "'.", p_class);
  1747. return ERR_PARSE_ERROR;
  1748. }
  1749. Error err = _parse_class_level(p_script->_owner, p_class->outer, p_keep_state);
  1750. if (err) {
  1751. return err;
  1752. }
  1753. }
  1754. }
  1755. #ifdef TOOLS_ENABLED
  1756. p_script->doc_functions.clear();
  1757. p_script->doc_variables.clear();
  1758. p_script->doc_constants.clear();
  1759. p_script->doc_enums.clear();
  1760. p_script->doc_signals.clear();
  1761. p_script->doc_tutorials.clear();
  1762. p_script->doc_brief_description = p_class->doc_brief_description;
  1763. p_script->doc_description = p_class->doc_description;
  1764. for (int i = 0; i < p_class->doc_tutorials.size(); i++) {
  1765. DocData::TutorialDoc td;
  1766. td.title = p_class->doc_tutorials[i].first;
  1767. td.link = p_class->doc_tutorials[i].second;
  1768. p_script->doc_tutorials.append(td);
  1769. }
  1770. #endif
  1771. p_script->native = Ref<GDScriptNativeClass>();
  1772. p_script->base = Ref<GDScript>();
  1773. p_script->_base = nullptr;
  1774. p_script->members.clear();
  1775. p_script->constants.clear();
  1776. for (Map<StringName, GDScriptFunction *>::Element *E = p_script->member_functions.front(); E; E = E->next()) {
  1777. memdelete(E->get());
  1778. }
  1779. p_script->member_functions.clear();
  1780. p_script->member_indices.clear();
  1781. p_script->member_info.clear();
  1782. p_script->_signals.clear();
  1783. p_script->initializer = nullptr;
  1784. p_script->tool = parser->is_tool();
  1785. p_script->name = p_class->identifier ? p_class->identifier->name : "";
  1786. Ref<GDScriptNativeClass> native;
  1787. GDScriptDataType base_type = _gdtype_from_datatype(p_class->base_type);
  1788. // Inheritance
  1789. switch (base_type.kind) {
  1790. case GDScriptDataType::NATIVE: {
  1791. int native_idx = GDScriptLanguage::get_singleton()->get_global_map()[base_type.native_type];
  1792. native = GDScriptLanguage::get_singleton()->get_global_array()[native_idx];
  1793. ERR_FAIL_COND_V(native.is_null(), ERR_BUG);
  1794. p_script->native = native;
  1795. } break;
  1796. case GDScriptDataType::GDSCRIPT: {
  1797. Ref<GDScript> base = Ref<GDScript>(base_type.script_type);
  1798. p_script->base = base;
  1799. p_script->_base = base.ptr();
  1800. if (p_class->base_type.kind == GDScriptParser::DataType::CLASS && p_class->base_type.class_type != nullptr) {
  1801. if (p_class->base_type.script_path == main_script->path) {
  1802. if (!parsed_classes.has(p_script->_base)) {
  1803. if (parsing_classes.has(p_script->_base)) {
  1804. String class_name = p_class->identifier ? p_class->identifier->name : "<main>";
  1805. _set_error("Cyclic class reference for '" + class_name + "'.", p_class);
  1806. return ERR_PARSE_ERROR;
  1807. }
  1808. Error err = _parse_class_level(p_script->_base, p_class->base_type.class_type, p_keep_state);
  1809. if (err) {
  1810. return err;
  1811. }
  1812. }
  1813. } else {
  1814. Error err = OK;
  1815. base = GDScriptCache::get_full_script(p_class->base_type.script_path, err, main_script->path);
  1816. if (err) {
  1817. return err;
  1818. }
  1819. if (base.is_null() && !base->is_valid()) {
  1820. return ERR_COMPILATION_FAILED;
  1821. }
  1822. }
  1823. }
  1824. p_script->member_indices = base->member_indices;
  1825. native = base->native;
  1826. p_script->native = native;
  1827. } break;
  1828. default: {
  1829. _set_error("Parser bug: invalid inheritance.", p_class);
  1830. return ERR_BUG;
  1831. } break;
  1832. }
  1833. for (int i = 0; i < p_class->members.size(); i++) {
  1834. const GDScriptParser::ClassNode::Member &member = p_class->members[i];
  1835. switch (member.type) {
  1836. case GDScriptParser::ClassNode::Member::VARIABLE: {
  1837. const GDScriptParser::VariableNode *variable = member.variable;
  1838. StringName name = variable->identifier->name;
  1839. GDScript::MemberInfo minfo;
  1840. minfo.index = p_script->member_indices.size();
  1841. switch (variable->property) {
  1842. case GDScriptParser::VariableNode::PROP_NONE:
  1843. break; // Nothing to do.
  1844. case GDScriptParser::VariableNode::PROP_SETGET:
  1845. if (variable->setter_pointer != nullptr) {
  1846. minfo.setter = variable->setter_pointer->name;
  1847. }
  1848. if (variable->getter_pointer != nullptr) {
  1849. minfo.getter = variable->getter_pointer->name;
  1850. }
  1851. break;
  1852. case GDScriptParser::VariableNode::PROP_INLINE:
  1853. if (variable->setter != nullptr) {
  1854. minfo.setter = "@" + variable->identifier->name + "_setter";
  1855. }
  1856. if (variable->getter != nullptr) {
  1857. minfo.getter = "@" + variable->identifier->name + "_getter";
  1858. }
  1859. break;
  1860. }
  1861. minfo.rpc_mode = variable->rpc_mode;
  1862. minfo.data_type = _gdtype_from_datatype(variable->get_datatype(), p_script);
  1863. PropertyInfo prop_info = minfo.data_type;
  1864. prop_info.name = name;
  1865. PropertyInfo export_info = variable->export_info;
  1866. if (variable->exported) {
  1867. if (!minfo.data_type.has_type) {
  1868. prop_info.type = export_info.type;
  1869. prop_info.class_name = export_info.class_name;
  1870. }
  1871. prop_info.hint = export_info.hint;
  1872. prop_info.hint_string = export_info.hint_string;
  1873. prop_info.usage = export_info.usage;
  1874. } else {
  1875. prop_info.usage = PROPERTY_USAGE_SCRIPT_VARIABLE;
  1876. }
  1877. #ifdef TOOLS_ENABLED
  1878. p_script->doc_variables[name] = variable->doc_description;
  1879. #endif
  1880. p_script->member_info[name] = prop_info;
  1881. p_script->member_indices[name] = minfo;
  1882. p_script->members.insert(name);
  1883. #ifdef TOOLS_ENABLED
  1884. if (variable->initializer != nullptr && variable->initializer->is_constant) {
  1885. p_script->member_default_values[name] = variable->initializer->reduced_value;
  1886. } else {
  1887. p_script->member_default_values.erase(name);
  1888. }
  1889. p_script->member_lines[name] = variable->start_line;
  1890. #endif
  1891. } break;
  1892. case GDScriptParser::ClassNode::Member::CONSTANT: {
  1893. const GDScriptParser::ConstantNode *constant = member.constant;
  1894. StringName name = constant->identifier->name;
  1895. p_script->constants.insert(name, constant->initializer->reduced_value);
  1896. #ifdef TOOLS_ENABLED
  1897. p_script->member_lines[name] = constant->start_line;
  1898. if (constant->doc_description != String()) {
  1899. p_script->doc_constants[name] = constant->doc_description;
  1900. }
  1901. #endif
  1902. } break;
  1903. case GDScriptParser::ClassNode::Member::ENUM_VALUE: {
  1904. const GDScriptParser::EnumNode::Value &enum_value = member.enum_value;
  1905. StringName name = enum_value.identifier->name;
  1906. p_script->constants.insert(name, enum_value.value);
  1907. #ifdef TOOLS_ENABLED
  1908. p_script->member_lines[name] = enum_value.identifier->start_line;
  1909. if (!p_script->doc_enums.has("@unnamed_enums")) {
  1910. p_script->doc_enums["@unnamed_enums"] = DocData::EnumDoc();
  1911. p_script->doc_enums["@unnamed_enums"].name = "@unnamed_enums";
  1912. }
  1913. DocData::ConstantDoc const_doc;
  1914. const_doc.name = enum_value.identifier->name;
  1915. const_doc.value = Variant(enum_value.value).operator String(); // TODO-DOC: enum value currently is int.
  1916. const_doc.description = enum_value.doc_description;
  1917. p_script->doc_enums["@unnamed_enums"].values.push_back(const_doc);
  1918. #endif
  1919. } break;
  1920. case GDScriptParser::ClassNode::Member::SIGNAL: {
  1921. const GDScriptParser::SignalNode *signal = member.signal;
  1922. StringName name = signal->identifier->name;
  1923. GDScript *c = p_script;
  1924. while (c) {
  1925. if (c->_signals.has(name)) {
  1926. _set_error("Signal '" + name + "' redefined (in current or parent class)", p_class);
  1927. return ERR_ALREADY_EXISTS;
  1928. }
  1929. if (c->base.is_valid()) {
  1930. c = c->base.ptr();
  1931. } else {
  1932. c = nullptr;
  1933. }
  1934. }
  1935. if (native.is_valid()) {
  1936. if (ClassDB::has_signal(native->get_name(), name)) {
  1937. _set_error("Signal '" + name + "' redefined (original in native class '" + String(native->get_name()) + "')", p_class);
  1938. return ERR_ALREADY_EXISTS;
  1939. }
  1940. }
  1941. Vector<StringName> parameters_names;
  1942. parameters_names.resize(signal->parameters.size());
  1943. for (int j = 0; j < signal->parameters.size(); j++) {
  1944. parameters_names.write[j] = signal->parameters[j]->identifier->name;
  1945. }
  1946. p_script->_signals[name] = parameters_names;
  1947. #ifdef TOOLS_ENABLED
  1948. if (!signal->doc_description.is_empty()) {
  1949. p_script->doc_signals[name] = signal->doc_description;
  1950. }
  1951. #endif
  1952. } break;
  1953. case GDScriptParser::ClassNode::Member::ENUM: {
  1954. const GDScriptParser::EnumNode *enum_n = member.m_enum;
  1955. // TODO: Make enums not be just a dictionary?
  1956. Dictionary new_enum;
  1957. for (int j = 0; j < enum_n->values.size(); j++) {
  1958. int value = enum_n->values[j].value;
  1959. // Needs to be string because Variant::get will convert to String.
  1960. new_enum[String(enum_n->values[j].identifier->name)] = value;
  1961. }
  1962. p_script->constants.insert(enum_n->identifier->name, new_enum);
  1963. #ifdef TOOLS_ENABLED
  1964. p_script->member_lines[enum_n->identifier->name] = enum_n->start_line;
  1965. p_script->doc_enums[enum_n->identifier->name] = DocData::EnumDoc();
  1966. p_script->doc_enums[enum_n->identifier->name].name = enum_n->identifier->name;
  1967. p_script->doc_enums[enum_n->identifier->name].description = enum_n->doc_description;
  1968. for (int j = 0; j < enum_n->values.size(); j++) {
  1969. DocData::ConstantDoc const_doc;
  1970. const_doc.name = enum_n->values[j].identifier->name;
  1971. const_doc.value = Variant(enum_n->values[j].value).operator String();
  1972. const_doc.description = enum_n->values[j].doc_description;
  1973. p_script->doc_enums[enum_n->identifier->name].values.push_back(const_doc);
  1974. }
  1975. #endif
  1976. } break;
  1977. default:
  1978. break; // Nothing to do here.
  1979. }
  1980. }
  1981. parsed_classes.insert(p_script);
  1982. parsing_classes.erase(p_script);
  1983. //parse sub-classes
  1984. for (int i = 0; i < p_class->members.size(); i++) {
  1985. const GDScriptParser::ClassNode::Member &member = p_class->members[i];
  1986. if (member.type != member.CLASS) {
  1987. continue;
  1988. }
  1989. const GDScriptParser::ClassNode *inner_class = member.m_class;
  1990. StringName name = inner_class->identifier->name;
  1991. Ref<GDScript> &subclass = p_script->subclasses[name];
  1992. GDScript *subclass_ptr = subclass.ptr();
  1993. // Subclass might still be parsing, just skip it
  1994. if (!parsed_classes.has(subclass_ptr) && !parsing_classes.has(subclass_ptr)) {
  1995. Error err = _parse_class_level(subclass_ptr, inner_class, p_keep_state);
  1996. if (err) {
  1997. return err;
  1998. }
  1999. }
  2000. #ifdef TOOLS_ENABLED
  2001. p_script->member_lines[name] = inner_class->start_line;
  2002. #endif
  2003. p_script->constants.insert(name, subclass); //once parsed, goes to the list of constants
  2004. }
  2005. return OK;
  2006. }
  2007. Error GDScriptCompiler::_parse_class_blocks(GDScript *p_script, const GDScriptParser::ClassNode *p_class, bool p_keep_state) {
  2008. //parse methods
  2009. bool has_ready = false;
  2010. for (int i = 0; i < p_class->members.size(); i++) {
  2011. const GDScriptParser::ClassNode::Member &member = p_class->members[i];
  2012. if (member.type == member.FUNCTION) {
  2013. const GDScriptParser::FunctionNode *function = member.function;
  2014. if (!has_ready && function->identifier->name == "_ready") {
  2015. has_ready = true;
  2016. }
  2017. Error err = _parse_function(p_script, p_class, function);
  2018. if (err) {
  2019. return err;
  2020. }
  2021. } else if (member.type == member.VARIABLE) {
  2022. const GDScriptParser::VariableNode *variable = member.variable;
  2023. if (variable->property == GDScriptParser::VariableNode::PROP_INLINE) {
  2024. if (variable->setter != nullptr) {
  2025. Error err = _parse_setter_getter(p_script, p_class, variable, true);
  2026. if (err) {
  2027. return err;
  2028. }
  2029. }
  2030. if (variable->getter != nullptr) {
  2031. Error err = _parse_setter_getter(p_script, p_class, variable, false);
  2032. if (err) {
  2033. return err;
  2034. }
  2035. }
  2036. }
  2037. }
  2038. }
  2039. {
  2040. // Create an implicit constructor in any case.
  2041. Error err = _parse_function(p_script, p_class, nullptr);
  2042. if (err) {
  2043. return err;
  2044. }
  2045. }
  2046. if (!has_ready && p_class->onready_used) {
  2047. //create a _ready constructor
  2048. Error err = _parse_function(p_script, p_class, nullptr, true);
  2049. if (err) {
  2050. return err;
  2051. }
  2052. }
  2053. #ifdef DEBUG_ENABLED
  2054. //validate instances if keeping state
  2055. if (p_keep_state) {
  2056. for (Set<Object *>::Element *E = p_script->instances.front(); E;) {
  2057. Set<Object *>::Element *N = E->next();
  2058. ScriptInstance *si = E->get()->get_script_instance();
  2059. if (si->is_placeholder()) {
  2060. #ifdef TOOLS_ENABLED
  2061. PlaceHolderScriptInstance *psi = static_cast<PlaceHolderScriptInstance *>(si);
  2062. if (p_script->is_tool()) {
  2063. //re-create as an instance
  2064. p_script->placeholders.erase(psi); //remove placeholder
  2065. GDScriptInstance *instance = memnew(GDScriptInstance);
  2066. instance->base_ref = Object::cast_to<Reference>(E->get());
  2067. instance->members.resize(p_script->member_indices.size());
  2068. instance->script = Ref<GDScript>(p_script);
  2069. instance->owner = E->get();
  2070. //needed for hot reloading
  2071. for (Map<StringName, GDScript::MemberInfo>::Element *F = p_script->member_indices.front(); F; F = F->next()) {
  2072. instance->member_indices_cache[F->key()] = F->get().index;
  2073. }
  2074. instance->owner->set_script_instance(instance);
  2075. /* STEP 2, INITIALIZE AND CONSTRUCT */
  2076. Callable::CallError ce;
  2077. p_script->initializer->call(instance, nullptr, 0, ce);
  2078. if (ce.error != Callable::CallError::CALL_OK) {
  2079. //well, tough luck, not gonna do anything here
  2080. }
  2081. }
  2082. #endif
  2083. } else {
  2084. GDScriptInstance *gi = static_cast<GDScriptInstance *>(si);
  2085. gi->reload_members();
  2086. }
  2087. E = N;
  2088. }
  2089. }
  2090. #endif
  2091. for (int i = 0; i < p_class->members.size(); i++) {
  2092. if (p_class->members[i].type != GDScriptParser::ClassNode::Member::CLASS) {
  2093. continue;
  2094. }
  2095. const GDScriptParser::ClassNode *inner_class = p_class->members[i].m_class;
  2096. StringName name = inner_class->identifier->name;
  2097. GDScript *subclass = p_script->subclasses[name].ptr();
  2098. Error err = _parse_class_blocks(subclass, inner_class, p_keep_state);
  2099. if (err) {
  2100. return err;
  2101. }
  2102. }
  2103. p_script->valid = true;
  2104. return OK;
  2105. }
  2106. void GDScriptCompiler::_make_scripts(GDScript *p_script, const GDScriptParser::ClassNode *p_class, bool p_keep_state) {
  2107. Map<StringName, Ref<GDScript>> old_subclasses;
  2108. if (p_keep_state) {
  2109. old_subclasses = p_script->subclasses;
  2110. }
  2111. p_script->subclasses.clear();
  2112. for (int i = 0; i < p_class->members.size(); i++) {
  2113. if (p_class->members[i].type != GDScriptParser::ClassNode::Member::CLASS) {
  2114. continue;
  2115. }
  2116. const GDScriptParser::ClassNode *inner_class = p_class->members[i].m_class;
  2117. StringName name = inner_class->identifier->name;
  2118. Ref<GDScript> subclass;
  2119. String fully_qualified_name = p_script->fully_qualified_name + "::" + name;
  2120. if (old_subclasses.has(name)) {
  2121. subclass = old_subclasses[name];
  2122. } else {
  2123. Ref<GDScript> orphan_subclass = GDScriptLanguage::get_singleton()->get_orphan_subclass(fully_qualified_name);
  2124. if (orphan_subclass.is_valid()) {
  2125. subclass = orphan_subclass;
  2126. } else {
  2127. subclass.instance();
  2128. }
  2129. }
  2130. subclass->_owner = p_script;
  2131. subclass->fully_qualified_name = fully_qualified_name;
  2132. p_script->subclasses.insert(name, subclass);
  2133. _make_scripts(subclass.ptr(), inner_class, false);
  2134. }
  2135. }
  2136. Error GDScriptCompiler::compile(const GDScriptParser *p_parser, GDScript *p_script, bool p_keep_state) {
  2137. err_line = -1;
  2138. err_column = -1;
  2139. error = "";
  2140. parser = p_parser;
  2141. main_script = p_script;
  2142. const GDScriptParser::ClassNode *root = parser->get_tree();
  2143. source = p_script->get_path();
  2144. // The best fully qualified name for a base level script is its file path
  2145. p_script->fully_qualified_name = p_script->path;
  2146. // Create scripts for subclasses beforehand so they can be referenced
  2147. _make_scripts(p_script, root, p_keep_state);
  2148. p_script->_owner = nullptr;
  2149. Error err = _parse_class_level(p_script, root, p_keep_state);
  2150. if (err) {
  2151. return err;
  2152. }
  2153. err = _parse_class_blocks(p_script, root, p_keep_state);
  2154. if (err) {
  2155. return err;
  2156. }
  2157. return GDScriptCache::finish_compiling(p_script->get_path());
  2158. }
  2159. String GDScriptCompiler::get_error() const {
  2160. return error;
  2161. }
  2162. int GDScriptCompiler::get_error_line() const {
  2163. return err_line;
  2164. }
  2165. int GDScriptCompiler::get_error_column() const {
  2166. return err_column;
  2167. }
  2168. GDScriptCompiler::GDScriptCompiler() {
  2169. }