2
0

gdscript_compiler.cpp 129 KB

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