gdscript_compiler.cpp 115 KB

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