gdscript_compiler.cpp 107 KB

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