gdscript_compiler.cpp 124 KB

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