gdscript_compiler.cpp 124 KB

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