gdscript_compiler.cpp 111 KB

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