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