gdscript_compiler.cpp 114 KB

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