gdscript_compiler.cpp 95 KB

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