gdscript_compiler.cpp 90 KB

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