gdscript_compiler.cpp 95 KB

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