gdscript_compiler.cpp 102 KB

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