gdscript_compiler.cpp 97 KB

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