gdscript_compiler.cpp 103 KB

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