gdscript_compiler.cpp 90 KB

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