gdscript_compiler.cpp 97 KB

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