gdscript_compiler.cpp 94 KB

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