gdscript_compiler.cpp 127 KB

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