gdscript_compiler.cpp 101 KB

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