2
0

gdscript_compiler.cpp 98 KB

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