gdscript_compiler.cpp 115 KB

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