gdscript_compiler.cpp 113 KB

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