gdscript_compiler.cpp 101 KB

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