gdscript_compiler.cpp 123 KB

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