gdscript_compiler.cpp 97 KB

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