gdscript_compiler.cpp 129 KB

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