gdscript_compiler.cpp 116 KB

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