gdscript_compiler.cpp 128 KB

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