gdscript_compiler.cpp 103 KB

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