gdscript_compiler.cpp 98 KB

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