gdscript_compiler.cpp 115 KB

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