gdscript_compiler.cpp 97 KB

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