gdscript_compiler.cpp 96 KB

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