gdscript_compiler.cpp 101 KB

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