gdscript_compiler.cpp 108 KB

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