gdscript_compiler.cpp 97 KB

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