gdscript_compiler.cpp 98 KB

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