gdscript_vm.cpp 119 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692
  1. /**************************************************************************/
  2. /* gdscript_vm.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.h"
  31. #include "gdscript_function.h"
  32. #include "gdscript_lambda_callable.h"
  33. #include "core/core_string_names.h"
  34. #include "core/os/os.h"
  35. #ifdef DEBUG_ENABLED
  36. static bool _profile_count_as_native(const Object *p_base_obj, const StringName &p_methodname) {
  37. if (!p_base_obj) {
  38. return false;
  39. }
  40. StringName cname = p_base_obj->get_class_name();
  41. if ((p_methodname == "new" && cname == "GDScript") || p_methodname == "call") {
  42. return false;
  43. }
  44. return ClassDB::class_exists(cname) && ClassDB::has_method(cname, p_methodname, false);
  45. }
  46. static String _get_element_type(Variant::Type builtin_type, const StringName &native_type, const Ref<Script> &script_type) {
  47. if (script_type.is_valid() && script_type->is_valid()) {
  48. return GDScript::debug_get_script_name(script_type);
  49. } else if (native_type != StringName()) {
  50. return native_type.operator String();
  51. } else {
  52. return Variant::get_type_name(builtin_type);
  53. }
  54. }
  55. static String _get_var_type(const Variant *p_var) {
  56. String basestr;
  57. if (p_var->get_type() == Variant::OBJECT) {
  58. bool was_freed;
  59. Object *bobj = p_var->get_validated_object_with_check(was_freed);
  60. if (!bobj) {
  61. if (was_freed) {
  62. basestr = "previously freed";
  63. } else {
  64. basestr = "null instance";
  65. }
  66. } else {
  67. if (bobj->is_class_ptr(GDScriptNativeClass::get_class_ptr_static())) {
  68. basestr = Object::cast_to<GDScriptNativeClass>(bobj)->get_name();
  69. } else {
  70. basestr = bobj->get_class();
  71. if (bobj->get_script_instance()) {
  72. basestr += " (" + GDScript::debug_get_script_name(bobj->get_script_instance()->get_script()) + ")";
  73. }
  74. }
  75. }
  76. } else {
  77. if (p_var->get_type() == Variant::ARRAY) {
  78. basestr = "Array";
  79. const Array *p_array = VariantInternal::get_array(p_var);
  80. Variant::Type builtin_type = (Variant::Type)p_array->get_typed_builtin();
  81. if (builtin_type != Variant::NIL) {
  82. basestr += "[" + _get_element_type(builtin_type, p_array->get_typed_class_name(), p_array->get_typed_script()) + "]";
  83. }
  84. } else {
  85. basestr = Variant::get_type_name(p_var->get_type());
  86. }
  87. }
  88. return basestr;
  89. }
  90. void GDScriptFunction::_profile_native_call(uint64_t p_t_taken, const String &p_func_name, const String &p_instance_class_name) {
  91. HashMap<String, Profile::NativeProfile>::Iterator inner_prof = profile.native_calls.find(p_func_name);
  92. if (inner_prof) {
  93. inner_prof->value.call_count += 1;
  94. } else {
  95. String sig = vformat("%s::0::%s%s%s", get_script()->get_script_path(), p_instance_class_name, p_instance_class_name.is_empty() ? "" : ".", p_func_name);
  96. inner_prof = profile.native_calls.insert(p_func_name, Profile::NativeProfile{ 1, 0, sig });
  97. }
  98. inner_prof->value.total_time += p_t_taken;
  99. }
  100. #endif // DEBUG_ENABLED
  101. Variant GDScriptFunction::_get_default_variant_for_data_type(const GDScriptDataType &p_data_type) {
  102. if (p_data_type.kind == GDScriptDataType::BUILTIN) {
  103. if (p_data_type.builtin_type == Variant::ARRAY) {
  104. Array array;
  105. // Typed array.
  106. if (p_data_type.has_container_element_type(0)) {
  107. const GDScriptDataType &element_type = p_data_type.get_container_element_type(0);
  108. array.set_typed(element_type.builtin_type, element_type.native_type, element_type.script_type);
  109. }
  110. return array;
  111. } else {
  112. Callable::CallError ce;
  113. Variant variant;
  114. Variant::construct(p_data_type.builtin_type, variant, nullptr, 0, ce);
  115. ERR_FAIL_COND_V(ce.error != Callable::CallError::CALL_OK, Variant());
  116. return variant;
  117. }
  118. }
  119. return Variant();
  120. }
  121. String GDScriptFunction::_get_call_error(const Callable::CallError &p_err, const String &p_where, const Variant **argptrs) const {
  122. String err_text;
  123. if (p_err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  124. int errorarg = p_err.argument;
  125. ERR_FAIL_COND_V_MSG(errorarg < 0 || argptrs[errorarg] == nullptr, "GDScript bug (please report): Invalid CallError argument index or null pointer.", "Invalid CallError argument index or null pointer.");
  126. // Handle the Object to Object case separately as we don't have further class details.
  127. #ifdef DEBUG_ENABLED
  128. if (p_err.expected == Variant::OBJECT && argptrs[errorarg]->get_type() == p_err.expected) {
  129. err_text = "Invalid type in " + p_where + ". The Object-derived class of argument " + itos(errorarg + 1) + " (" + _get_var_type(argptrs[errorarg]) + ") is not a subclass of the expected argument class.";
  130. } else if (p_err.expected == Variant::ARRAY && argptrs[errorarg]->get_type() == p_err.expected) {
  131. err_text = "Invalid type in " + p_where + ". The array of argument " + itos(errorarg + 1) + " (" + _get_var_type(argptrs[errorarg]) + ") does not have the same element type as the expected typed array argument.";
  132. } else
  133. #endif // DEBUG_ENABLED
  134. {
  135. err_text = "Invalid type in " + p_where + ". Cannot convert argument " + itos(errorarg + 1) + " from " + Variant::get_type_name(argptrs[errorarg]->get_type()) + " to " + Variant::get_type_name(Variant::Type(p_err.expected)) + ".";
  136. }
  137. } else if (p_err.error == Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS) {
  138. err_text = "Invalid call to " + p_where + ". Expected " + itos(p_err.expected) + " arguments.";
  139. } else if (p_err.error == Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS) {
  140. err_text = "Invalid call to " + p_where + ". Expected " + itos(p_err.expected) + " arguments.";
  141. } else if (p_err.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  142. err_text = "Invalid call. Nonexistent " + p_where + ".";
  143. } else if (p_err.error == Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL) {
  144. err_text = "Attempt to call " + p_where + " on a null instance.";
  145. } else if (p_err.error == Callable::CallError::CALL_ERROR_METHOD_NOT_CONST) {
  146. err_text = "Attempt to call " + p_where + " on a const instance.";
  147. } else {
  148. err_text = "Bug, call error: #" + itos(p_err.error);
  149. }
  150. return err_text;
  151. }
  152. void (*type_init_function_table[])(Variant *) = {
  153. nullptr, // NIL (shouldn't be called).
  154. &VariantInitializer<bool>::init, // BOOL.
  155. &VariantInitializer<int64_t>::init, // INT.
  156. &VariantInitializer<double>::init, // FLOAT.
  157. &VariantInitializer<String>::init, // STRING.
  158. &VariantInitializer<Vector2>::init, // VECTOR2.
  159. &VariantInitializer<Vector2i>::init, // VECTOR2I.
  160. &VariantInitializer<Rect2>::init, // RECT2.
  161. &VariantInitializer<Rect2i>::init, // RECT2I.
  162. &VariantInitializer<Vector3>::init, // VECTOR3.
  163. &VariantInitializer<Vector3i>::init, // VECTOR3I.
  164. &VariantInitializer<Transform2D>::init, // TRANSFORM2D.
  165. &VariantInitializer<Vector4>::init, // VECTOR4.
  166. &VariantInitializer<Vector4i>::init, // VECTOR4I.
  167. &VariantInitializer<Plane>::init, // PLANE.
  168. &VariantInitializer<Quaternion>::init, // QUATERNION.
  169. &VariantInitializer<AABB>::init, // AABB.
  170. &VariantInitializer<Basis>::init, // BASIS.
  171. &VariantInitializer<Transform3D>::init, // TRANSFORM3D.
  172. &VariantInitializer<Projection>::init, // PROJECTION.
  173. &VariantInitializer<Color>::init, // COLOR.
  174. &VariantInitializer<StringName>::init, // STRING_NAME.
  175. &VariantInitializer<NodePath>::init, // NODE_PATH.
  176. &VariantInitializer<RID>::init, // RID.
  177. &VariantInitializer<Object *>::init, // OBJECT.
  178. &VariantInitializer<Callable>::init, // CALLABLE.
  179. &VariantInitializer<Signal>::init, // SIGNAL.
  180. &VariantInitializer<Dictionary>::init, // DICTIONARY.
  181. &VariantInitializer<Array>::init, // ARRAY.
  182. &VariantInitializer<PackedByteArray>::init, // PACKED_BYTE_ARRAY.
  183. &VariantInitializer<PackedInt32Array>::init, // PACKED_INT32_ARRAY.
  184. &VariantInitializer<PackedInt64Array>::init, // PACKED_INT64_ARRAY.
  185. &VariantInitializer<PackedFloat32Array>::init, // PACKED_FLOAT32_ARRAY.
  186. &VariantInitializer<PackedFloat64Array>::init, // PACKED_FLOAT64_ARRAY.
  187. &VariantInitializer<PackedStringArray>::init, // PACKED_STRING_ARRAY.
  188. &VariantInitializer<PackedVector2Array>::init, // PACKED_VECTOR2_ARRAY.
  189. &VariantInitializer<PackedVector3Array>::init, // PACKED_VECTOR3_ARRAY.
  190. &VariantInitializer<PackedColorArray>::init, // PACKED_COLOR_ARRAY.
  191. };
  192. #if defined(__GNUC__)
  193. #define OPCODES_TABLE \
  194. static const void *switch_table_ops[] = { \
  195. &&OPCODE_OPERATOR, \
  196. &&OPCODE_OPERATOR_VALIDATED, \
  197. &&OPCODE_TYPE_TEST_BUILTIN, \
  198. &&OPCODE_TYPE_TEST_ARRAY, \
  199. &&OPCODE_TYPE_TEST_NATIVE, \
  200. &&OPCODE_TYPE_TEST_SCRIPT, \
  201. &&OPCODE_SET_KEYED, \
  202. &&OPCODE_SET_KEYED_VALIDATED, \
  203. &&OPCODE_SET_INDEXED_VALIDATED, \
  204. &&OPCODE_GET_KEYED, \
  205. &&OPCODE_GET_KEYED_VALIDATED, \
  206. &&OPCODE_GET_INDEXED_VALIDATED, \
  207. &&OPCODE_SET_NAMED, \
  208. &&OPCODE_SET_NAMED_VALIDATED, \
  209. &&OPCODE_GET_NAMED, \
  210. &&OPCODE_GET_NAMED_VALIDATED, \
  211. &&OPCODE_SET_MEMBER, \
  212. &&OPCODE_GET_MEMBER, \
  213. &&OPCODE_SET_STATIC_VARIABLE, \
  214. &&OPCODE_GET_STATIC_VARIABLE, \
  215. &&OPCODE_ASSIGN, \
  216. &&OPCODE_ASSIGN_NULL, \
  217. &&OPCODE_ASSIGN_TRUE, \
  218. &&OPCODE_ASSIGN_FALSE, \
  219. &&OPCODE_ASSIGN_TYPED_BUILTIN, \
  220. &&OPCODE_ASSIGN_TYPED_ARRAY, \
  221. &&OPCODE_ASSIGN_TYPED_NATIVE, \
  222. &&OPCODE_ASSIGN_TYPED_SCRIPT, \
  223. &&OPCODE_CAST_TO_BUILTIN, \
  224. &&OPCODE_CAST_TO_NATIVE, \
  225. &&OPCODE_CAST_TO_SCRIPT, \
  226. &&OPCODE_CONSTRUCT, \
  227. &&OPCODE_CONSTRUCT_VALIDATED, \
  228. &&OPCODE_CONSTRUCT_ARRAY, \
  229. &&OPCODE_CONSTRUCT_TYPED_ARRAY, \
  230. &&OPCODE_CONSTRUCT_DICTIONARY, \
  231. &&OPCODE_CALL, \
  232. &&OPCODE_CALL_RETURN, \
  233. &&OPCODE_CALL_ASYNC, \
  234. &&OPCODE_CALL_UTILITY, \
  235. &&OPCODE_CALL_UTILITY_VALIDATED, \
  236. &&OPCODE_CALL_GDSCRIPT_UTILITY, \
  237. &&OPCODE_CALL_BUILTIN_TYPE_VALIDATED, \
  238. &&OPCODE_CALL_SELF_BASE, \
  239. &&OPCODE_CALL_METHOD_BIND, \
  240. &&OPCODE_CALL_METHOD_BIND_RET, \
  241. &&OPCODE_CALL_BUILTIN_STATIC, \
  242. &&OPCODE_CALL_NATIVE_STATIC, \
  243. &&OPCODE_CALL_NATIVE_STATIC_VALIDATED_RETURN, \
  244. &&OPCODE_CALL_NATIVE_STATIC_VALIDATED_NO_RETURN, \
  245. &&OPCODE_CALL_METHOD_BIND_VALIDATED_RETURN, \
  246. &&OPCODE_CALL_METHOD_BIND_VALIDATED_NO_RETURN, \
  247. &&OPCODE_AWAIT, \
  248. &&OPCODE_AWAIT_RESUME, \
  249. &&OPCODE_CREATE_LAMBDA, \
  250. &&OPCODE_CREATE_SELF_LAMBDA, \
  251. &&OPCODE_JUMP, \
  252. &&OPCODE_JUMP_IF, \
  253. &&OPCODE_JUMP_IF_NOT, \
  254. &&OPCODE_JUMP_TO_DEF_ARGUMENT, \
  255. &&OPCODE_JUMP_IF_SHARED, \
  256. &&OPCODE_RETURN, \
  257. &&OPCODE_RETURN_TYPED_BUILTIN, \
  258. &&OPCODE_RETURN_TYPED_ARRAY, \
  259. &&OPCODE_RETURN_TYPED_NATIVE, \
  260. &&OPCODE_RETURN_TYPED_SCRIPT, \
  261. &&OPCODE_ITERATE_BEGIN, \
  262. &&OPCODE_ITERATE_BEGIN_INT, \
  263. &&OPCODE_ITERATE_BEGIN_FLOAT, \
  264. &&OPCODE_ITERATE_BEGIN_VECTOR2, \
  265. &&OPCODE_ITERATE_BEGIN_VECTOR2I, \
  266. &&OPCODE_ITERATE_BEGIN_VECTOR3, \
  267. &&OPCODE_ITERATE_BEGIN_VECTOR3I, \
  268. &&OPCODE_ITERATE_BEGIN_STRING, \
  269. &&OPCODE_ITERATE_BEGIN_DICTIONARY, \
  270. &&OPCODE_ITERATE_BEGIN_ARRAY, \
  271. &&OPCODE_ITERATE_BEGIN_PACKED_BYTE_ARRAY, \
  272. &&OPCODE_ITERATE_BEGIN_PACKED_INT32_ARRAY, \
  273. &&OPCODE_ITERATE_BEGIN_PACKED_INT64_ARRAY, \
  274. &&OPCODE_ITERATE_BEGIN_PACKED_FLOAT32_ARRAY, \
  275. &&OPCODE_ITERATE_BEGIN_PACKED_FLOAT64_ARRAY, \
  276. &&OPCODE_ITERATE_BEGIN_PACKED_STRING_ARRAY, \
  277. &&OPCODE_ITERATE_BEGIN_PACKED_VECTOR2_ARRAY, \
  278. &&OPCODE_ITERATE_BEGIN_PACKED_VECTOR3_ARRAY, \
  279. &&OPCODE_ITERATE_BEGIN_PACKED_COLOR_ARRAY, \
  280. &&OPCODE_ITERATE_BEGIN_OBJECT, \
  281. &&OPCODE_ITERATE, \
  282. &&OPCODE_ITERATE_INT, \
  283. &&OPCODE_ITERATE_FLOAT, \
  284. &&OPCODE_ITERATE_VECTOR2, \
  285. &&OPCODE_ITERATE_VECTOR2I, \
  286. &&OPCODE_ITERATE_VECTOR3, \
  287. &&OPCODE_ITERATE_VECTOR3I, \
  288. &&OPCODE_ITERATE_STRING, \
  289. &&OPCODE_ITERATE_DICTIONARY, \
  290. &&OPCODE_ITERATE_ARRAY, \
  291. &&OPCODE_ITERATE_PACKED_BYTE_ARRAY, \
  292. &&OPCODE_ITERATE_PACKED_INT32_ARRAY, \
  293. &&OPCODE_ITERATE_PACKED_INT64_ARRAY, \
  294. &&OPCODE_ITERATE_PACKED_FLOAT32_ARRAY, \
  295. &&OPCODE_ITERATE_PACKED_FLOAT64_ARRAY, \
  296. &&OPCODE_ITERATE_PACKED_STRING_ARRAY, \
  297. &&OPCODE_ITERATE_PACKED_VECTOR2_ARRAY, \
  298. &&OPCODE_ITERATE_PACKED_VECTOR3_ARRAY, \
  299. &&OPCODE_ITERATE_PACKED_COLOR_ARRAY, \
  300. &&OPCODE_ITERATE_OBJECT, \
  301. &&OPCODE_STORE_GLOBAL, \
  302. &&OPCODE_STORE_NAMED_GLOBAL, \
  303. &&OPCODE_TYPE_ADJUST_BOOL, \
  304. &&OPCODE_TYPE_ADJUST_INT, \
  305. &&OPCODE_TYPE_ADJUST_FLOAT, \
  306. &&OPCODE_TYPE_ADJUST_STRING, \
  307. &&OPCODE_TYPE_ADJUST_VECTOR2, \
  308. &&OPCODE_TYPE_ADJUST_VECTOR2I, \
  309. &&OPCODE_TYPE_ADJUST_RECT2, \
  310. &&OPCODE_TYPE_ADJUST_RECT2I, \
  311. &&OPCODE_TYPE_ADJUST_VECTOR3, \
  312. &&OPCODE_TYPE_ADJUST_VECTOR3I, \
  313. &&OPCODE_TYPE_ADJUST_TRANSFORM2D, \
  314. &&OPCODE_TYPE_ADJUST_VECTOR4, \
  315. &&OPCODE_TYPE_ADJUST_VECTOR4I, \
  316. &&OPCODE_TYPE_ADJUST_PLANE, \
  317. &&OPCODE_TYPE_ADJUST_QUATERNION, \
  318. &&OPCODE_TYPE_ADJUST_AABB, \
  319. &&OPCODE_TYPE_ADJUST_BASIS, \
  320. &&OPCODE_TYPE_ADJUST_TRANSFORM3D, \
  321. &&OPCODE_TYPE_ADJUST_PROJECTION, \
  322. &&OPCODE_TYPE_ADJUST_COLOR, \
  323. &&OPCODE_TYPE_ADJUST_STRING_NAME, \
  324. &&OPCODE_TYPE_ADJUST_NODE_PATH, \
  325. &&OPCODE_TYPE_ADJUST_RID, \
  326. &&OPCODE_TYPE_ADJUST_OBJECT, \
  327. &&OPCODE_TYPE_ADJUST_CALLABLE, \
  328. &&OPCODE_TYPE_ADJUST_SIGNAL, \
  329. &&OPCODE_TYPE_ADJUST_DICTIONARY, \
  330. &&OPCODE_TYPE_ADJUST_ARRAY, \
  331. &&OPCODE_TYPE_ADJUST_PACKED_BYTE_ARRAY, \
  332. &&OPCODE_TYPE_ADJUST_PACKED_INT32_ARRAY, \
  333. &&OPCODE_TYPE_ADJUST_PACKED_INT64_ARRAY, \
  334. &&OPCODE_TYPE_ADJUST_PACKED_FLOAT32_ARRAY, \
  335. &&OPCODE_TYPE_ADJUST_PACKED_FLOAT64_ARRAY, \
  336. &&OPCODE_TYPE_ADJUST_PACKED_STRING_ARRAY, \
  337. &&OPCODE_TYPE_ADJUST_PACKED_VECTOR2_ARRAY, \
  338. &&OPCODE_TYPE_ADJUST_PACKED_VECTOR3_ARRAY, \
  339. &&OPCODE_TYPE_ADJUST_PACKED_COLOR_ARRAY, \
  340. &&OPCODE_ASSERT, \
  341. &&OPCODE_BREAKPOINT, \
  342. &&OPCODE_LINE, \
  343. &&OPCODE_END \
  344. }; \
  345. static_assert((sizeof(switch_table_ops) / sizeof(switch_table_ops[0]) == (OPCODE_END + 1)), "Opcodes in jump table aren't the same as opcodes in enum.");
  346. #define OPCODE(m_op) \
  347. m_op:
  348. #define OPCODE_WHILE(m_test)
  349. #define OPCODES_END \
  350. OPSEXIT:
  351. #define OPCODES_OUT \
  352. OPSOUT:
  353. #define OPCODE_SWITCH(m_test) goto *switch_table_ops[m_test];
  354. #ifdef DEBUG_ENABLED
  355. #define DISPATCH_OPCODE \
  356. last_opcode = _code_ptr[ip]; \
  357. goto *switch_table_ops[last_opcode]
  358. #else
  359. #define DISPATCH_OPCODE goto *switch_table_ops[_code_ptr[ip]]
  360. #endif
  361. #define OPCODE_BREAK goto OPSEXIT
  362. #define OPCODE_OUT goto OPSOUT
  363. #else
  364. #define OPCODES_TABLE
  365. #define OPCODE(m_op) case m_op:
  366. #define OPCODE_WHILE(m_test) while (m_test)
  367. #define OPCODES_END
  368. #define OPCODES_OUT
  369. #define DISPATCH_OPCODE continue
  370. #ifdef _MSC_VER
  371. #define OPCODE_SWITCH(m_test) \
  372. __assume(m_test <= OPCODE_END); \
  373. switch (m_test)
  374. #else
  375. #define OPCODE_SWITCH(m_test) switch (m_test)
  376. #endif
  377. #define OPCODE_BREAK break
  378. #define OPCODE_OUT break
  379. #endif
  380. // Helpers for VariantInternal methods in macros.
  381. #define OP_GET_BOOL get_bool
  382. #define OP_GET_INT get_int
  383. #define OP_GET_FLOAT get_float
  384. #define OP_GET_VECTOR2 get_vector2
  385. #define OP_GET_VECTOR2I get_vector2i
  386. #define OP_GET_VECTOR3 get_vector3
  387. #define OP_GET_VECTOR3I get_vector3i
  388. #define OP_GET_RECT2 get_rect2
  389. #define OP_GET_VECTOR4 get_vector4
  390. #define OP_GET_VECTOR4I get_vector4i
  391. #define OP_GET_RECT2I get_rect2i
  392. #define OP_GET_QUATERNION get_quaternion
  393. #define OP_GET_COLOR get_color
  394. #define OP_GET_STRING get_string
  395. #define OP_GET_STRING_NAME get_string_name
  396. #define OP_GET_NODE_PATH get_node_path
  397. #define OP_GET_CALLABLE get_callable
  398. #define OP_GET_SIGNAL get_signal
  399. #define OP_GET_ARRAY get_array
  400. #define OP_GET_DICTIONARY get_dictionary
  401. #define OP_GET_PACKED_BYTE_ARRAY get_byte_array
  402. #define OP_GET_PACKED_INT32_ARRAY get_int32_array
  403. #define OP_GET_PACKED_INT64_ARRAY get_int64_array
  404. #define OP_GET_PACKED_FLOAT32_ARRAY get_float32_array
  405. #define OP_GET_PACKED_FLOAT64_ARRAY get_float64_array
  406. #define OP_GET_PACKED_STRING_ARRAY get_string_array
  407. #define OP_GET_PACKED_VECTOR2_ARRAY get_vector2_array
  408. #define OP_GET_PACKED_VECTOR3_ARRAY get_vector3_array
  409. #define OP_GET_PACKED_COLOR_ARRAY get_color_array
  410. #define OP_GET_TRANSFORM3D get_transform
  411. #define OP_GET_TRANSFORM2D get_transform2d
  412. #define OP_GET_PROJECTION get_projection
  413. #define OP_GET_PLANE get_plane
  414. #define OP_GET_AABB get_aabb
  415. #define OP_GET_BASIS get_basis
  416. #define OP_GET_RID get_rid
  417. #define METHOD_CALL_ON_NULL_VALUE_ERROR(method_pointer) "Cannot call method '" + (method_pointer)->get_name() + "' on a null value."
  418. #define METHOD_CALL_ON_FREED_INSTANCE_ERROR(method_pointer) "Cannot call method '" + (method_pointer)->get_name() + "' on a previously freed instance."
  419. Variant GDScriptFunction::call(GDScriptInstance *p_instance, const Variant **p_args, int p_argcount, Callable::CallError &r_err, CallState *p_state) {
  420. OPCODES_TABLE;
  421. if (!_code_ptr) {
  422. return _get_default_variant_for_data_type(return_type);
  423. }
  424. r_err.error = Callable::CallError::CALL_OK;
  425. static thread_local int call_depth = 0;
  426. if (unlikely(++call_depth > MAX_CALL_DEPTH)) {
  427. call_depth--;
  428. #ifdef DEBUG_ENABLED
  429. String err_file;
  430. if (p_instance && ObjectDB::get_instance(p_instance->owner_id) != nullptr && p_instance->script->is_valid() && !p_instance->script->path.is_empty()) {
  431. err_file = p_instance->script->path;
  432. } else if (_script) {
  433. err_file = _script->path;
  434. }
  435. if (err_file.is_empty()) {
  436. err_file = "<built-in>";
  437. }
  438. String err_func = name;
  439. if (p_instance && ObjectDB::get_instance(p_instance->owner_id) != nullptr && p_instance->script->is_valid() && p_instance->script->local_name != StringName()) {
  440. err_func = p_instance->script->local_name.operator String() + "." + err_func;
  441. }
  442. int err_line = _initial_line;
  443. const char *err_text = "Stack overflow. Check for infinite recursion in your script.";
  444. if (!GDScriptLanguage::get_singleton()->debug_break(err_text, false)) {
  445. // Debugger break did not happen.
  446. _err_print_error(err_func.utf8().get_data(), err_file.utf8().get_data(), err_line, err_text, false, ERR_HANDLER_SCRIPT);
  447. }
  448. #endif
  449. return _get_default_variant_for_data_type(return_type);
  450. }
  451. Variant retvalue;
  452. Variant *stack = nullptr;
  453. Variant **instruction_args = nullptr;
  454. int defarg = 0;
  455. #ifdef DEBUG_ENABLED
  456. //GDScriptLanguage::get_singleton()->calls++;
  457. #endif
  458. uint32_t alloca_size = 0;
  459. GDScript *script;
  460. int ip = 0;
  461. int line = _initial_line;
  462. if (p_state) {
  463. //use existing (supplied) state (awaited)
  464. stack = (Variant *)p_state->stack.ptr();
  465. instruction_args = (Variant **)&p_state->stack.ptr()[sizeof(Variant) * p_state->stack_size]; //ptr() to avoid bounds check
  466. line = p_state->line;
  467. ip = p_state->ip;
  468. alloca_size = p_state->stack.size();
  469. script = p_state->script;
  470. p_instance = p_state->instance;
  471. defarg = p_state->defarg;
  472. } else {
  473. if (p_argcount != _argument_count) {
  474. if (p_argcount > _argument_count) {
  475. r_err.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  476. r_err.expected = _argument_count;
  477. call_depth--;
  478. return _get_default_variant_for_data_type(return_type);
  479. } else if (p_argcount < _argument_count - _default_arg_count) {
  480. r_err.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  481. r_err.expected = _argument_count - _default_arg_count;
  482. call_depth--;
  483. return _get_default_variant_for_data_type(return_type);
  484. } else {
  485. defarg = _argument_count - p_argcount;
  486. }
  487. }
  488. // Add 3 here for self, class, and nil.
  489. alloca_size = sizeof(Variant *) * 3 + sizeof(Variant *) * _instruction_args_size + sizeof(Variant) * _stack_size;
  490. uint8_t *aptr = (uint8_t *)alloca(alloca_size);
  491. stack = (Variant *)aptr;
  492. for (int i = 0; i < p_argcount; i++) {
  493. if (!argument_types[i].has_type) {
  494. memnew_placement(&stack[i + 3], Variant(*p_args[i]));
  495. continue;
  496. }
  497. // If types already match, don't call Variant::construct(). Constructors of some types
  498. // (e.g. packed arrays) do copies, whereas they pass by reference when inside a Variant.
  499. if (argument_types[i].is_type(*p_args[i], false)) {
  500. memnew_placement(&stack[i + 3], Variant(*p_args[i]));
  501. continue;
  502. }
  503. if (!argument_types[i].is_type(*p_args[i], true)) {
  504. r_err.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  505. r_err.argument = i;
  506. r_err.expected = argument_types[i].builtin_type;
  507. call_depth--;
  508. return _get_default_variant_for_data_type(return_type);
  509. }
  510. if (argument_types[i].kind == GDScriptDataType::BUILTIN) {
  511. Variant arg;
  512. Variant::construct(argument_types[i].builtin_type, arg, &p_args[i], 1, r_err);
  513. memnew_placement(&stack[i + 3], Variant(arg));
  514. } else {
  515. memnew_placement(&stack[i + 3], Variant(*p_args[i]));
  516. }
  517. }
  518. for (int i = p_argcount + 3; i < _stack_size; i++) {
  519. memnew_placement(&stack[i], Variant);
  520. }
  521. if (_instruction_args_size) {
  522. instruction_args = (Variant **)&aptr[sizeof(Variant) * _stack_size];
  523. } else {
  524. instruction_args = nullptr;
  525. }
  526. for (const KeyValue<int, Variant::Type> &E : temporary_slots) {
  527. type_init_function_table[E.value](&stack[E.key]);
  528. }
  529. }
  530. if (p_instance) {
  531. memnew_placement(&stack[ADDR_STACK_SELF], Variant(p_instance->owner));
  532. script = p_instance->script.ptr();
  533. } else {
  534. memnew_placement(&stack[ADDR_STACK_SELF], Variant);
  535. script = _script;
  536. }
  537. memnew_placement(&stack[ADDR_STACK_CLASS], Variant(script));
  538. memnew_placement(&stack[ADDR_STACK_NIL], Variant);
  539. String err_text;
  540. #ifdef DEBUG_ENABLED
  541. if (EngineDebugger::is_active()) {
  542. GDScriptLanguage::get_singleton()->enter_function(p_instance, this, stack, &ip, &line);
  543. }
  544. #define GD_ERR_BREAK(m_cond) \
  545. { \
  546. if (unlikely(m_cond)) { \
  547. _err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition ' " _STR(m_cond) " ' is true. Breaking..:"); \
  548. OPCODE_BREAK; \
  549. } \
  550. }
  551. #define CHECK_SPACE(m_space) \
  552. GD_ERR_BREAK((ip + m_space) > _code_size)
  553. #define GET_VARIANT_PTR(m_v, m_code_ofs) \
  554. Variant *m_v; \
  555. { \
  556. int address = _code_ptr[ip + 1 + (m_code_ofs)]; \
  557. int address_type = (address & ADDR_TYPE_MASK) >> ADDR_BITS; \
  558. if (unlikely(address_type < 0 || address_type >= ADDR_TYPE_MAX)) { \
  559. err_text = "Bad address type."; \
  560. OPCODE_BREAK; \
  561. } \
  562. int address_index = address & ADDR_MASK; \
  563. if (unlikely(address_index < 0 || address_index >= variant_address_limits[address_type])) { \
  564. if (address_type == ADDR_TYPE_MEMBER && !p_instance) { \
  565. err_text = "Cannot access member without instance."; \
  566. } else { \
  567. err_text = "Bad address index."; \
  568. } \
  569. OPCODE_BREAK; \
  570. } \
  571. m_v = &variant_addresses[address_type][address_index]; \
  572. if (unlikely(!m_v)) \
  573. OPCODE_BREAK; \
  574. }
  575. #else
  576. #define GD_ERR_BREAK(m_cond)
  577. #define CHECK_SPACE(m_space)
  578. #define GET_VARIANT_PTR(m_v, m_code_ofs) \
  579. Variant *m_v; \
  580. { \
  581. int address = _code_ptr[ip + 1 + (m_code_ofs)]; \
  582. m_v = &variant_addresses[(address & ADDR_TYPE_MASK) >> ADDR_BITS][address & ADDR_MASK]; \
  583. if (unlikely(!m_v)) \
  584. OPCODE_BREAK; \
  585. }
  586. #endif
  587. #define LOAD_INSTRUCTION_ARGS \
  588. int instr_arg_count = _code_ptr[ip + 1]; \
  589. for (int i = 0; i < instr_arg_count; i++) { \
  590. GET_VARIANT_PTR(v, i + 1); \
  591. instruction_args[i] = v; \
  592. } \
  593. ip += 1; // Offset to skip instruction argcount.
  594. #define GET_INSTRUCTION_ARG(m_v, m_idx) \
  595. Variant *m_v = instruction_args[m_idx]
  596. #ifdef DEBUG_ENABLED
  597. uint64_t function_start_time = 0;
  598. uint64_t function_call_time = 0;
  599. if (GDScriptLanguage::get_singleton()->profiling) {
  600. function_start_time = OS::get_singleton()->get_ticks_usec();
  601. function_call_time = 0;
  602. profile.call_count.increment();
  603. profile.frame_call_count.increment();
  604. }
  605. bool exit_ok = false;
  606. bool awaited = false;
  607. int variant_address_limits[ADDR_TYPE_MAX] = { _stack_size, _constant_count, p_instance ? (int)p_instance->members.size() : 0 };
  608. #endif
  609. Variant *variant_addresses[ADDR_TYPE_MAX] = { stack, _constants_ptr, p_instance ? p_instance->members.ptrw() : nullptr };
  610. #ifdef DEBUG_ENABLED
  611. OPCODE_WHILE(ip < _code_size) {
  612. int last_opcode = _code_ptr[ip];
  613. #else
  614. OPCODE_WHILE(true) {
  615. #endif
  616. OPCODE_SWITCH(_code_ptr[ip]) {
  617. OPCODE(OPCODE_OPERATOR) {
  618. constexpr int _pointer_size = sizeof(Variant::ValidatedOperatorEvaluator) / sizeof(*_code_ptr);
  619. CHECK_SPACE(7 + _pointer_size);
  620. bool valid;
  621. Variant::Operator op = (Variant::Operator)_code_ptr[ip + 4];
  622. GD_ERR_BREAK(op >= Variant::OP_MAX);
  623. GET_VARIANT_PTR(a, 0);
  624. GET_VARIANT_PTR(b, 1);
  625. GET_VARIANT_PTR(dst, 2);
  626. // Compute signatures (types of operands) so it can be optimized when matching.
  627. uint32_t op_signature = _code_ptr[ip + 5];
  628. uint32_t actual_signature = (a->get_type() << 8) | (b->get_type());
  629. #ifdef DEBUG_ENABLED
  630. if (op == Variant::OP_DIVIDE || op == Variant::OP_MODULE) {
  631. // Don't optimize division and modulo since there's not check for division by zero with validated calls.
  632. op_signature = 0xFFFF;
  633. _code_ptr[ip + 5] = op_signature;
  634. }
  635. #endif
  636. // Check if this is the first run. If so, store the current signature for the optimized path.
  637. if (unlikely(op_signature == 0)) {
  638. static Mutex initializer_mutex;
  639. initializer_mutex.lock();
  640. Variant::Type a_type = (Variant::Type)((actual_signature >> 8) & 0xFF);
  641. Variant::Type b_type = (Variant::Type)(actual_signature & 0xFF);
  642. Variant::ValidatedOperatorEvaluator op_func = Variant::get_validated_operator_evaluator(op, a_type, b_type);
  643. if (unlikely(!op_func)) {
  644. #ifdef DEBUG_ENABLED
  645. err_text = "Invalid operands '" + Variant::get_type_name(a->get_type()) + "' and '" + Variant::get_type_name(b->get_type()) + "' in operator '" + Variant::get_operator_name(op) + "'.";
  646. #endif
  647. initializer_mutex.unlock();
  648. OPCODE_BREAK;
  649. } else {
  650. Variant::Type ret_type = Variant::get_operator_return_type(op, a_type, b_type);
  651. VariantInternal::initialize(dst, ret_type);
  652. op_func(a, b, dst);
  653. // Check again in case another thread already set it.
  654. if (_code_ptr[ip + 5] == 0) {
  655. _code_ptr[ip + 5] = actual_signature;
  656. _code_ptr[ip + 6] = static_cast<int>(ret_type);
  657. Variant::ValidatedOperatorEvaluator *tmp = reinterpret_cast<Variant::ValidatedOperatorEvaluator *>(&_code_ptr[ip + 7]);
  658. *tmp = op_func;
  659. }
  660. }
  661. initializer_mutex.unlock();
  662. } else if (likely(op_signature == actual_signature)) {
  663. // If the signature matches, we can use the optimized path.
  664. Variant::Type ret_type = static_cast<Variant::Type>(_code_ptr[ip + 6]);
  665. Variant::ValidatedOperatorEvaluator op_func = *reinterpret_cast<Variant::ValidatedOperatorEvaluator *>(&_code_ptr[ip + 7]);
  666. // Make sure the return value has the correct type.
  667. VariantInternal::initialize(dst, ret_type);
  668. op_func(a, b, dst);
  669. } else {
  670. // If the signature doesn't match, we have to use the slow path.
  671. #ifdef DEBUG_ENABLED
  672. Variant ret;
  673. Variant::evaluate(op, *a, *b, ret, valid);
  674. #else
  675. Variant::evaluate(op, *a, *b, *dst, valid);
  676. #endif
  677. #ifdef DEBUG_ENABLED
  678. if (!valid) {
  679. if (ret.get_type() == Variant::STRING) {
  680. //return a string when invalid with the error
  681. err_text = ret;
  682. err_text += " in operator '" + Variant::get_operator_name(op) + "'.";
  683. } else {
  684. err_text = "Invalid operands '" + Variant::get_type_name(a->get_type()) + "' and '" + Variant::get_type_name(b->get_type()) + "' in operator '" + Variant::get_operator_name(op) + "'.";
  685. }
  686. OPCODE_BREAK;
  687. }
  688. *dst = ret;
  689. #endif
  690. }
  691. ip += 7 + _pointer_size;
  692. }
  693. DISPATCH_OPCODE;
  694. OPCODE(OPCODE_OPERATOR_VALIDATED) {
  695. CHECK_SPACE(5);
  696. int operator_idx = _code_ptr[ip + 4];
  697. GD_ERR_BREAK(operator_idx < 0 || operator_idx >= _operator_funcs_count);
  698. Variant::ValidatedOperatorEvaluator operator_func = _operator_funcs_ptr[operator_idx];
  699. GET_VARIANT_PTR(a, 0);
  700. GET_VARIANT_PTR(b, 1);
  701. GET_VARIANT_PTR(dst, 2);
  702. operator_func(a, b, dst);
  703. ip += 5;
  704. }
  705. DISPATCH_OPCODE;
  706. OPCODE(OPCODE_TYPE_TEST_BUILTIN) {
  707. CHECK_SPACE(4);
  708. GET_VARIANT_PTR(dst, 0);
  709. GET_VARIANT_PTR(value, 1);
  710. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 3];
  711. GD_ERR_BREAK(builtin_type < 0 || builtin_type >= Variant::VARIANT_MAX);
  712. *dst = value->get_type() == builtin_type;
  713. ip += 4;
  714. }
  715. DISPATCH_OPCODE;
  716. OPCODE(OPCODE_TYPE_TEST_ARRAY) {
  717. CHECK_SPACE(6);
  718. GET_VARIANT_PTR(dst, 0);
  719. GET_VARIANT_PTR(value, 1);
  720. GET_VARIANT_PTR(script_type, 2);
  721. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 4];
  722. int native_type_idx = _code_ptr[ip + 5];
  723. GD_ERR_BREAK(native_type_idx < 0 || native_type_idx >= _global_names_count);
  724. const StringName native_type = _global_names_ptr[native_type_idx];
  725. bool result = false;
  726. if (value->get_type() == Variant::ARRAY) {
  727. Array *array = VariantInternal::get_array(value);
  728. result = array->get_typed_builtin() == ((uint32_t)builtin_type) && array->get_typed_class_name() == native_type && array->get_typed_script() == *script_type;
  729. }
  730. *dst = result;
  731. ip += 6;
  732. }
  733. DISPATCH_OPCODE;
  734. OPCODE(OPCODE_TYPE_TEST_NATIVE) {
  735. CHECK_SPACE(4);
  736. GET_VARIANT_PTR(dst, 0);
  737. GET_VARIANT_PTR(value, 1);
  738. int native_type_idx = _code_ptr[ip + 3];
  739. GD_ERR_BREAK(native_type_idx < 0 || native_type_idx >= _global_names_count);
  740. const StringName native_type = _global_names_ptr[native_type_idx];
  741. bool was_freed = false;
  742. Object *object = value->get_validated_object_with_check(was_freed);
  743. if (was_freed) {
  744. err_text = "Left operand of 'is' is a previously freed instance.";
  745. OPCODE_BREAK;
  746. }
  747. *dst = object && ClassDB::is_parent_class(object->get_class_name(), native_type);
  748. ip += 4;
  749. }
  750. DISPATCH_OPCODE;
  751. OPCODE(OPCODE_TYPE_TEST_SCRIPT) {
  752. CHECK_SPACE(4);
  753. GET_VARIANT_PTR(dst, 0);
  754. GET_VARIANT_PTR(value, 1);
  755. GET_VARIANT_PTR(type, 2);
  756. Script *script_type = Object::cast_to<Script>(type->operator Object *());
  757. GD_ERR_BREAK(!script_type);
  758. bool was_freed = false;
  759. Object *object = value->get_validated_object_with_check(was_freed);
  760. if (was_freed) {
  761. err_text = "Left operand of 'is' is a previously freed instance.";
  762. OPCODE_BREAK;
  763. }
  764. bool result = false;
  765. if (object && object->get_script_instance()) {
  766. Script *script_ptr = object->get_script_instance()->get_script().ptr();
  767. while (script_ptr) {
  768. if (script_ptr == script_type) {
  769. result = true;
  770. break;
  771. }
  772. script_ptr = script_ptr->get_base_script().ptr();
  773. }
  774. }
  775. *dst = result;
  776. ip += 4;
  777. }
  778. DISPATCH_OPCODE;
  779. OPCODE(OPCODE_SET_KEYED) {
  780. CHECK_SPACE(3);
  781. GET_VARIANT_PTR(dst, 0);
  782. GET_VARIANT_PTR(index, 1);
  783. GET_VARIANT_PTR(value, 2);
  784. bool valid;
  785. #ifdef DEBUG_ENABLED
  786. Variant::VariantSetError err_code;
  787. dst->set(*index, *value, &valid, &err_code);
  788. #else
  789. dst->set(*index, *value, &valid);
  790. #endif
  791. #ifdef DEBUG_ENABLED
  792. if (!valid) {
  793. if (dst->is_read_only()) {
  794. err_text = "Invalid assignment on read-only value (on base: '" + _get_var_type(dst) + "').";
  795. } else {
  796. Object *obj = dst->get_validated_object();
  797. String v = index->operator String();
  798. bool read_only_property = false;
  799. if (obj) {
  800. read_only_property = ClassDB::has_property(obj->get_class_name(), v) && (ClassDB::get_property_setter(obj->get_class_name(), v) == StringName());
  801. }
  802. if (read_only_property) {
  803. err_text = vformat(R"(Cannot set value into property "%s" (on base "%s") because it is read-only.)", v, _get_var_type(dst));
  804. } else {
  805. if (!v.is_empty()) {
  806. v = "'" + v + "'";
  807. } else {
  808. v = "of type '" + _get_var_type(index) + "'";
  809. }
  810. err_text = "Invalid assignment of property or key " + v + " with value of type '" + _get_var_type(value) + "' on a base object of type '" + _get_var_type(dst) + "'.";
  811. if (err_code == Variant::VariantSetError::SET_INDEXED_ERR) {
  812. err_text = "Invalid assignment of index " + v + " (on base: '" + _get_var_type(dst) + "') with value of type '" + _get_var_type(value) + "'.";
  813. }
  814. }
  815. }
  816. OPCODE_BREAK;
  817. }
  818. #endif
  819. ip += 4;
  820. }
  821. DISPATCH_OPCODE;
  822. OPCODE(OPCODE_SET_KEYED_VALIDATED) {
  823. CHECK_SPACE(4);
  824. GET_VARIANT_PTR(dst, 0);
  825. GET_VARIANT_PTR(index, 1);
  826. GET_VARIANT_PTR(value, 2);
  827. int index_setter = _code_ptr[ip + 4];
  828. GD_ERR_BREAK(index_setter < 0 || index_setter >= _keyed_setters_count);
  829. const Variant::ValidatedKeyedSetter setter = _keyed_setters_ptr[index_setter];
  830. bool valid;
  831. setter(dst, index, value, &valid);
  832. #ifdef DEBUG_ENABLED
  833. if (!valid) {
  834. if (dst->is_read_only()) {
  835. err_text = "Invalid assignment on read-only value (on base: '" + _get_var_type(dst) + "').";
  836. } else {
  837. String v = index->operator String();
  838. if (!v.is_empty()) {
  839. v = "'" + v + "'";
  840. } else {
  841. v = "of type '" + _get_var_type(index) + "'";
  842. }
  843. err_text = "Invalid assignment of property or key " + v + " with value of type '" + _get_var_type(value) + "' on a base object of type '" + _get_var_type(dst) + "'.";
  844. }
  845. OPCODE_BREAK;
  846. }
  847. #endif
  848. ip += 5;
  849. }
  850. DISPATCH_OPCODE;
  851. OPCODE(OPCODE_SET_INDEXED_VALIDATED) {
  852. CHECK_SPACE(4);
  853. GET_VARIANT_PTR(dst, 0);
  854. GET_VARIANT_PTR(index, 1);
  855. GET_VARIANT_PTR(value, 2);
  856. int index_setter = _code_ptr[ip + 4];
  857. GD_ERR_BREAK(index_setter < 0 || index_setter >= _indexed_setters_count);
  858. const Variant::ValidatedIndexedSetter setter = _indexed_setters_ptr[index_setter];
  859. int64_t int_index = *VariantInternal::get_int(index);
  860. bool oob;
  861. setter(dst, int_index, value, &oob);
  862. #ifdef DEBUG_ENABLED
  863. if (oob) {
  864. if (dst->is_read_only()) {
  865. err_text = "Invalid assignment on read-only value (on base: '" + _get_var_type(dst) + "').";
  866. } else {
  867. String v = index->operator String();
  868. if (!v.is_empty()) {
  869. v = "'" + v + "'";
  870. } else {
  871. v = "of type '" + _get_var_type(index) + "'";
  872. }
  873. err_text = "Out of bounds set index " + v + " (on base: '" + _get_var_type(dst) + "')";
  874. }
  875. OPCODE_BREAK;
  876. }
  877. #endif
  878. ip += 5;
  879. }
  880. DISPATCH_OPCODE;
  881. OPCODE(OPCODE_GET_KEYED) {
  882. CHECK_SPACE(3);
  883. GET_VARIANT_PTR(src, 0);
  884. GET_VARIANT_PTR(index, 1);
  885. GET_VARIANT_PTR(dst, 2);
  886. bool valid;
  887. #ifdef DEBUG_ENABLED
  888. // Allow better error message in cases where src and dst are the same stack position.
  889. Variant::VariantGetError err_code;
  890. Variant ret = src->get(*index, &valid, &err_code);
  891. #else
  892. *dst = src->get(*index, &valid);
  893. #endif
  894. #ifdef DEBUG_ENABLED
  895. if (!valid) {
  896. String v = index->operator String();
  897. if (!v.is_empty()) {
  898. v = "'" + v + "'";
  899. } else {
  900. v = "of type '" + _get_var_type(index) + "'";
  901. }
  902. err_text = "Invalid access to property or key " + v + " on a base object of type '" + _get_var_type(src) + "'.";
  903. if (err_code == Variant::VariantGetError::GET_INDEXED_ERR) {
  904. err_text = "Invalid access of index " + v + " on a base object of type: '" + _get_var_type(src) + "'.";
  905. }
  906. OPCODE_BREAK;
  907. }
  908. *dst = ret;
  909. #endif
  910. ip += 4;
  911. }
  912. DISPATCH_OPCODE;
  913. OPCODE(OPCODE_GET_KEYED_VALIDATED) {
  914. CHECK_SPACE(4);
  915. GET_VARIANT_PTR(src, 0);
  916. GET_VARIANT_PTR(key, 1);
  917. GET_VARIANT_PTR(dst, 2);
  918. int index_getter = _code_ptr[ip + 4];
  919. GD_ERR_BREAK(index_getter < 0 || index_getter >= _keyed_getters_count);
  920. const Variant::ValidatedKeyedGetter getter = _keyed_getters_ptr[index_getter];
  921. bool valid;
  922. #ifdef DEBUG_ENABLED
  923. // Allow better error message in cases where src and dst are the same stack position.
  924. Variant ret;
  925. getter(src, key, &ret, &valid);
  926. #else
  927. getter(src, key, dst, &valid);
  928. #endif
  929. #ifdef DEBUG_ENABLED
  930. if (!valid) {
  931. String v = key->operator String();
  932. if (!v.is_empty()) {
  933. v = "'" + v + "'";
  934. } else {
  935. v = "of type '" + _get_var_type(key) + "'";
  936. }
  937. err_text = "Invalid access to property or key " + v + " on a base object of type '" + _get_var_type(src) + "'.";
  938. OPCODE_BREAK;
  939. }
  940. *dst = ret;
  941. #endif
  942. ip += 5;
  943. }
  944. DISPATCH_OPCODE;
  945. OPCODE(OPCODE_GET_INDEXED_VALIDATED) {
  946. CHECK_SPACE(4);
  947. GET_VARIANT_PTR(src, 0);
  948. GET_VARIANT_PTR(index, 1);
  949. GET_VARIANT_PTR(dst, 2);
  950. int index_getter = _code_ptr[ip + 4];
  951. GD_ERR_BREAK(index_getter < 0 || index_getter >= _indexed_getters_count);
  952. const Variant::ValidatedIndexedGetter getter = _indexed_getters_ptr[index_getter];
  953. int64_t int_index = *VariantInternal::get_int(index);
  954. bool oob;
  955. getter(src, int_index, dst, &oob);
  956. #ifdef DEBUG_ENABLED
  957. if (oob) {
  958. String v = index->operator String();
  959. if (!v.is_empty()) {
  960. v = "'" + v + "'";
  961. } else {
  962. v = "of type '" + _get_var_type(index) + "'";
  963. }
  964. err_text = "Out of bounds get index " + v + " (on base: '" + _get_var_type(src) + "')";
  965. OPCODE_BREAK;
  966. }
  967. #endif
  968. ip += 5;
  969. }
  970. DISPATCH_OPCODE;
  971. OPCODE(OPCODE_SET_NAMED) {
  972. CHECK_SPACE(3);
  973. GET_VARIANT_PTR(dst, 0);
  974. GET_VARIANT_PTR(value, 1);
  975. int indexname = _code_ptr[ip + 3];
  976. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  977. const StringName *index = &_global_names_ptr[indexname];
  978. bool valid;
  979. dst->set_named(*index, *value, valid);
  980. #ifdef DEBUG_ENABLED
  981. if (!valid) {
  982. if (dst->is_read_only()) {
  983. err_text = "Invalid assignment on read-only value (on base: '" + _get_var_type(dst) + "').";
  984. } else {
  985. Object *obj = dst->get_validated_object();
  986. bool read_only_property = false;
  987. if (obj) {
  988. read_only_property = ClassDB::has_property(obj->get_class_name(), *index) && (ClassDB::get_property_setter(obj->get_class_name(), *index) == StringName());
  989. }
  990. if (read_only_property) {
  991. err_text = vformat(R"(Cannot set value into property "%s" (on base "%s") because it is read-only.)", String(*index), _get_var_type(dst));
  992. } else {
  993. err_text = "Invalid assignment of property or key '" + String(*index) + "' with value of type '" + _get_var_type(value) + "' on a base object of type '" + _get_var_type(dst) + "'.";
  994. }
  995. }
  996. OPCODE_BREAK;
  997. }
  998. #endif
  999. ip += 4;
  1000. }
  1001. DISPATCH_OPCODE;
  1002. OPCODE(OPCODE_SET_NAMED_VALIDATED) {
  1003. CHECK_SPACE(3);
  1004. GET_VARIANT_PTR(dst, 0);
  1005. GET_VARIANT_PTR(value, 1);
  1006. int index_setter = _code_ptr[ip + 3];
  1007. GD_ERR_BREAK(index_setter < 0 || index_setter >= _setters_count);
  1008. const Variant::ValidatedSetter setter = _setters_ptr[index_setter];
  1009. setter(dst, value);
  1010. ip += 4;
  1011. }
  1012. DISPATCH_OPCODE;
  1013. OPCODE(OPCODE_GET_NAMED) {
  1014. CHECK_SPACE(4);
  1015. GET_VARIANT_PTR(src, 0);
  1016. GET_VARIANT_PTR(dst, 1);
  1017. int indexname = _code_ptr[ip + 3];
  1018. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  1019. const StringName *index = &_global_names_ptr[indexname];
  1020. bool valid;
  1021. #ifdef DEBUG_ENABLED
  1022. //allow better error message in cases where src and dst are the same stack position
  1023. Variant ret = src->get_named(*index, valid);
  1024. #else
  1025. *dst = src->get_named(*index, valid);
  1026. #endif
  1027. #ifdef DEBUG_ENABLED
  1028. if (!valid) {
  1029. err_text = "Invalid access to property or key '" + index->operator String() + "' on a base object of type '" + _get_var_type(src) + "'.";
  1030. OPCODE_BREAK;
  1031. }
  1032. *dst = ret;
  1033. #endif
  1034. ip += 4;
  1035. }
  1036. DISPATCH_OPCODE;
  1037. OPCODE(OPCODE_GET_NAMED_VALIDATED) {
  1038. CHECK_SPACE(3);
  1039. GET_VARIANT_PTR(src, 0);
  1040. GET_VARIANT_PTR(dst, 1);
  1041. int index_getter = _code_ptr[ip + 3];
  1042. GD_ERR_BREAK(index_getter < 0 || index_getter >= _getters_count);
  1043. const Variant::ValidatedGetter getter = _getters_ptr[index_getter];
  1044. getter(src, dst);
  1045. ip += 4;
  1046. }
  1047. DISPATCH_OPCODE;
  1048. OPCODE(OPCODE_SET_MEMBER) {
  1049. CHECK_SPACE(3);
  1050. GET_VARIANT_PTR(src, 0);
  1051. int indexname = _code_ptr[ip + 2];
  1052. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  1053. const StringName *index = &_global_names_ptr[indexname];
  1054. bool valid;
  1055. #ifndef DEBUG_ENABLED
  1056. ClassDB::set_property(p_instance->owner, *index, *src, &valid);
  1057. #else
  1058. bool ok = ClassDB::set_property(p_instance->owner, *index, *src, &valid);
  1059. if (!ok) {
  1060. err_text = "Internal error setting property: " + String(*index);
  1061. OPCODE_BREAK;
  1062. } else if (!valid) {
  1063. err_text = "Error setting property '" + String(*index) + "' with value of type " + Variant::get_type_name(src->get_type()) + ".";
  1064. OPCODE_BREAK;
  1065. }
  1066. #endif
  1067. ip += 3;
  1068. }
  1069. DISPATCH_OPCODE;
  1070. OPCODE(OPCODE_GET_MEMBER) {
  1071. CHECK_SPACE(3);
  1072. GET_VARIANT_PTR(dst, 0);
  1073. int indexname = _code_ptr[ip + 2];
  1074. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  1075. const StringName *index = &_global_names_ptr[indexname];
  1076. #ifndef DEBUG_ENABLED
  1077. ClassDB::get_property(p_instance->owner, *index, *dst);
  1078. #else
  1079. bool ok = ClassDB::get_property(p_instance->owner, *index, *dst);
  1080. if (!ok) {
  1081. err_text = "Internal error getting property: " + String(*index);
  1082. OPCODE_BREAK;
  1083. }
  1084. #endif
  1085. ip += 3;
  1086. }
  1087. DISPATCH_OPCODE;
  1088. OPCODE(OPCODE_SET_STATIC_VARIABLE) {
  1089. CHECK_SPACE(4);
  1090. GET_VARIANT_PTR(value, 0);
  1091. GET_VARIANT_PTR(_class, 1);
  1092. GDScript *gdscript = Object::cast_to<GDScript>(_class->operator Object *());
  1093. GD_ERR_BREAK(!gdscript);
  1094. int index = _code_ptr[ip + 3];
  1095. GD_ERR_BREAK(index < 0 || index >= gdscript->static_variables.size());
  1096. gdscript->static_variables.write[index] = *value;
  1097. ip += 4;
  1098. }
  1099. DISPATCH_OPCODE;
  1100. OPCODE(OPCODE_GET_STATIC_VARIABLE) {
  1101. CHECK_SPACE(4);
  1102. GET_VARIANT_PTR(target, 0);
  1103. GET_VARIANT_PTR(_class, 1);
  1104. GDScript *gdscript = Object::cast_to<GDScript>(_class->operator Object *());
  1105. GD_ERR_BREAK(!gdscript);
  1106. int index = _code_ptr[ip + 3];
  1107. GD_ERR_BREAK(index < 0 || index >= gdscript->static_variables.size());
  1108. *target = gdscript->static_variables[index];
  1109. ip += 4;
  1110. }
  1111. DISPATCH_OPCODE;
  1112. OPCODE(OPCODE_ASSIGN) {
  1113. CHECK_SPACE(3);
  1114. GET_VARIANT_PTR(dst, 0);
  1115. GET_VARIANT_PTR(src, 1);
  1116. *dst = *src;
  1117. ip += 3;
  1118. }
  1119. DISPATCH_OPCODE;
  1120. OPCODE(OPCODE_ASSIGN_NULL) {
  1121. CHECK_SPACE(2);
  1122. GET_VARIANT_PTR(dst, 0);
  1123. *dst = Variant();
  1124. ip += 2;
  1125. }
  1126. DISPATCH_OPCODE;
  1127. OPCODE(OPCODE_ASSIGN_TRUE) {
  1128. CHECK_SPACE(2);
  1129. GET_VARIANT_PTR(dst, 0);
  1130. *dst = true;
  1131. ip += 2;
  1132. }
  1133. DISPATCH_OPCODE;
  1134. OPCODE(OPCODE_ASSIGN_FALSE) {
  1135. CHECK_SPACE(2);
  1136. GET_VARIANT_PTR(dst, 0);
  1137. *dst = false;
  1138. ip += 2;
  1139. }
  1140. DISPATCH_OPCODE;
  1141. OPCODE(OPCODE_ASSIGN_TYPED_BUILTIN) {
  1142. CHECK_SPACE(4);
  1143. GET_VARIANT_PTR(dst, 0);
  1144. GET_VARIANT_PTR(src, 1);
  1145. Variant::Type var_type = (Variant::Type)_code_ptr[ip + 3];
  1146. GD_ERR_BREAK(var_type < 0 || var_type >= Variant::VARIANT_MAX);
  1147. if (src->get_type() != var_type) {
  1148. #ifdef DEBUG_ENABLED
  1149. if (Variant::can_convert_strict(src->get_type(), var_type)) {
  1150. #endif // DEBUG_ENABLED
  1151. Callable::CallError ce;
  1152. Variant::construct(var_type, *dst, const_cast<const Variant **>(&src), 1, ce);
  1153. } else {
  1154. #ifdef DEBUG_ENABLED
  1155. err_text = "Trying to assign value of type '" + Variant::get_type_name(src->get_type()) +
  1156. "' to a variable of type '" + Variant::get_type_name(var_type) + "'.";
  1157. OPCODE_BREAK;
  1158. }
  1159. } else {
  1160. #endif // DEBUG_ENABLED
  1161. *dst = *src;
  1162. }
  1163. ip += 4;
  1164. }
  1165. DISPATCH_OPCODE;
  1166. OPCODE(OPCODE_ASSIGN_TYPED_ARRAY) {
  1167. CHECK_SPACE(6);
  1168. GET_VARIANT_PTR(dst, 0);
  1169. GET_VARIANT_PTR(src, 1);
  1170. GET_VARIANT_PTR(script_type, 2);
  1171. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 4];
  1172. int native_type_idx = _code_ptr[ip + 5];
  1173. GD_ERR_BREAK(native_type_idx < 0 || native_type_idx >= _global_names_count);
  1174. const StringName native_type = _global_names_ptr[native_type_idx];
  1175. if (src->get_type() != Variant::ARRAY) {
  1176. #ifdef DEBUG_ENABLED
  1177. err_text = vformat(R"(Trying to assign a value of type "%s" to a variable of type "Array[%s]".)",
  1178. _get_var_type(src), _get_element_type(builtin_type, native_type, *script_type));
  1179. #endif // DEBUG_ENABLED
  1180. OPCODE_BREAK;
  1181. }
  1182. Array *array = VariantInternal::get_array(src);
  1183. if (array->get_typed_builtin() != ((uint32_t)builtin_type) || array->get_typed_class_name() != native_type || array->get_typed_script() != *script_type) {
  1184. #ifdef DEBUG_ENABLED
  1185. err_text = vformat(R"(Trying to assign an array of type "%s" to a variable of type "Array[%s]".)",
  1186. _get_var_type(src), _get_element_type(builtin_type, native_type, *script_type));
  1187. #endif // DEBUG_ENABLED
  1188. OPCODE_BREAK;
  1189. }
  1190. *dst = *src;
  1191. ip += 6;
  1192. }
  1193. DISPATCH_OPCODE;
  1194. OPCODE(OPCODE_ASSIGN_TYPED_NATIVE) {
  1195. CHECK_SPACE(4);
  1196. GET_VARIANT_PTR(dst, 0);
  1197. GET_VARIANT_PTR(src, 1);
  1198. #ifdef DEBUG_ENABLED
  1199. GET_VARIANT_PTR(type, 2);
  1200. GDScriptNativeClass *nc = Object::cast_to<GDScriptNativeClass>(type->operator Object *());
  1201. GD_ERR_BREAK(!nc);
  1202. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  1203. err_text = "Trying to assign value of type '" + Variant::get_type_name(src->get_type()) +
  1204. "' to a variable of type '" + nc->get_name() + "'.";
  1205. OPCODE_BREAK;
  1206. }
  1207. if (src->get_type() == Variant::OBJECT) {
  1208. bool was_freed = false;
  1209. Object *src_obj = src->get_validated_object_with_check(was_freed);
  1210. if (!src_obj && was_freed) {
  1211. err_text = "Trying to assign invalid previously freed instance.";
  1212. OPCODE_BREAK;
  1213. }
  1214. if (src_obj && !ClassDB::is_parent_class(src_obj->get_class_name(), nc->get_name())) {
  1215. err_text = "Trying to assign value of type '" + src_obj->get_class_name() +
  1216. "' to a variable of type '" + nc->get_name() + "'.";
  1217. OPCODE_BREAK;
  1218. }
  1219. }
  1220. #endif // DEBUG_ENABLED
  1221. *dst = *src;
  1222. ip += 4;
  1223. }
  1224. DISPATCH_OPCODE;
  1225. OPCODE(OPCODE_ASSIGN_TYPED_SCRIPT) {
  1226. CHECK_SPACE(4);
  1227. GET_VARIANT_PTR(dst, 0);
  1228. GET_VARIANT_PTR(src, 1);
  1229. #ifdef DEBUG_ENABLED
  1230. GET_VARIANT_PTR(type, 2);
  1231. Script *base_type = Object::cast_to<Script>(type->operator Object *());
  1232. GD_ERR_BREAK(!base_type);
  1233. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  1234. err_text = "Trying to assign a non-object value to a variable of type '" + base_type->get_path().get_file() + "'.";
  1235. OPCODE_BREAK;
  1236. }
  1237. if (src->get_type() == Variant::OBJECT) {
  1238. bool was_freed = false;
  1239. Object *val_obj = src->get_validated_object_with_check(was_freed);
  1240. if (!val_obj && was_freed) {
  1241. err_text = "Trying to assign invalid previously freed instance.";
  1242. OPCODE_BREAK;
  1243. }
  1244. if (val_obj) { // src is not null
  1245. ScriptInstance *scr_inst = val_obj->get_script_instance();
  1246. if (!scr_inst) {
  1247. err_text = "Trying to assign value of type '" + val_obj->get_class_name() +
  1248. "' to a variable of type '" + base_type->get_path().get_file() + "'.";
  1249. OPCODE_BREAK;
  1250. }
  1251. Script *src_type = scr_inst->get_script().ptr();
  1252. bool valid = false;
  1253. while (src_type) {
  1254. if (src_type == base_type) {
  1255. valid = true;
  1256. break;
  1257. }
  1258. src_type = src_type->get_base_script().ptr();
  1259. }
  1260. if (!valid) {
  1261. err_text = "Trying to assign value of type '" + val_obj->get_script_instance()->get_script()->get_path().get_file() +
  1262. "' to a variable of type '" + base_type->get_path().get_file() + "'.";
  1263. OPCODE_BREAK;
  1264. }
  1265. }
  1266. }
  1267. #endif // DEBUG_ENABLED
  1268. *dst = *src;
  1269. ip += 4;
  1270. }
  1271. DISPATCH_OPCODE;
  1272. OPCODE(OPCODE_CAST_TO_BUILTIN) {
  1273. CHECK_SPACE(4);
  1274. GET_VARIANT_PTR(src, 0);
  1275. GET_VARIANT_PTR(dst, 1);
  1276. Variant::Type to_type = (Variant::Type)_code_ptr[ip + 3];
  1277. GD_ERR_BREAK(to_type < 0 || to_type >= Variant::VARIANT_MAX);
  1278. #ifdef DEBUG_ENABLED
  1279. if (src->operator Object *() && !src->get_validated_object()) {
  1280. err_text = "Trying to cast a freed object.";
  1281. OPCODE_BREAK;
  1282. }
  1283. #endif
  1284. Callable::CallError err;
  1285. Variant::construct(to_type, *dst, (const Variant **)&src, 1, err);
  1286. #ifdef DEBUG_ENABLED
  1287. if (err.error != Callable::CallError::CALL_OK) {
  1288. err_text = "Invalid cast: could not convert value to '" + Variant::get_type_name(to_type) + "'.";
  1289. OPCODE_BREAK;
  1290. }
  1291. #endif
  1292. ip += 4;
  1293. }
  1294. DISPATCH_OPCODE;
  1295. OPCODE(OPCODE_CAST_TO_NATIVE) {
  1296. CHECK_SPACE(4);
  1297. GET_VARIANT_PTR(src, 0);
  1298. GET_VARIANT_PTR(dst, 1);
  1299. GET_VARIANT_PTR(to_type, 2);
  1300. GDScriptNativeClass *nc = Object::cast_to<GDScriptNativeClass>(to_type->operator Object *());
  1301. GD_ERR_BREAK(!nc);
  1302. #ifdef DEBUG_ENABLED
  1303. if (src->operator Object *() && !src->get_validated_object()) {
  1304. err_text = "Trying to cast a freed object.";
  1305. OPCODE_BREAK;
  1306. }
  1307. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  1308. err_text = "Invalid cast: can't convert a non-object value to an object type.";
  1309. OPCODE_BREAK;
  1310. }
  1311. #endif
  1312. Object *src_obj = src->operator Object *();
  1313. if (src_obj && !ClassDB::is_parent_class(src_obj->get_class_name(), nc->get_name())) {
  1314. *dst = Variant(); // invalid cast, assign NULL
  1315. } else {
  1316. *dst = *src;
  1317. }
  1318. ip += 4;
  1319. }
  1320. DISPATCH_OPCODE;
  1321. OPCODE(OPCODE_CAST_TO_SCRIPT) {
  1322. CHECK_SPACE(4);
  1323. GET_VARIANT_PTR(src, 0);
  1324. GET_VARIANT_PTR(dst, 1);
  1325. GET_VARIANT_PTR(to_type, 2);
  1326. Script *base_type = Object::cast_to<Script>(to_type->operator Object *());
  1327. GD_ERR_BREAK(!base_type);
  1328. #ifdef DEBUG_ENABLED
  1329. if (src->operator Object *() && !src->get_validated_object()) {
  1330. err_text = "Trying to cast a freed object.";
  1331. OPCODE_BREAK;
  1332. }
  1333. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  1334. err_text = "Trying to assign a non-object value to a variable of type '" + base_type->get_path().get_file() + "'.";
  1335. OPCODE_BREAK;
  1336. }
  1337. #endif
  1338. bool valid = false;
  1339. if (src->get_type() != Variant::NIL && src->operator Object *() != nullptr) {
  1340. ScriptInstance *scr_inst = src->operator Object *()->get_script_instance();
  1341. if (scr_inst) {
  1342. Script *src_type = src->operator Object *()->get_script_instance()->get_script().ptr();
  1343. while (src_type) {
  1344. if (src_type == base_type) {
  1345. valid = true;
  1346. break;
  1347. }
  1348. src_type = src_type->get_base_script().ptr();
  1349. }
  1350. }
  1351. }
  1352. if (valid) {
  1353. *dst = *src; // Valid cast, copy the source object
  1354. } else {
  1355. *dst = Variant(); // invalid cast, assign NULL
  1356. }
  1357. ip += 4;
  1358. }
  1359. DISPATCH_OPCODE;
  1360. OPCODE(OPCODE_CONSTRUCT) {
  1361. LOAD_INSTRUCTION_ARGS
  1362. CHECK_SPACE(2 + instr_arg_count);
  1363. ip += instr_arg_count;
  1364. int argc = _code_ptr[ip + 1];
  1365. Variant::Type t = Variant::Type(_code_ptr[ip + 2]);
  1366. Variant **argptrs = instruction_args;
  1367. GET_INSTRUCTION_ARG(dst, argc);
  1368. Callable::CallError err;
  1369. Variant::construct(t, *dst, (const Variant **)argptrs, argc, err);
  1370. #ifdef DEBUG_ENABLED
  1371. if (err.error != Callable::CallError::CALL_OK) {
  1372. err_text = _get_call_error(err, "'" + Variant::get_type_name(t) + "' constructor", (const Variant **)argptrs);
  1373. OPCODE_BREAK;
  1374. }
  1375. #endif
  1376. ip += 3;
  1377. }
  1378. DISPATCH_OPCODE;
  1379. OPCODE(OPCODE_CONSTRUCT_VALIDATED) {
  1380. LOAD_INSTRUCTION_ARGS
  1381. CHECK_SPACE(2 + instr_arg_count);
  1382. ip += instr_arg_count;
  1383. int argc = _code_ptr[ip + 1];
  1384. int constructor_idx = _code_ptr[ip + 2];
  1385. GD_ERR_BREAK(constructor_idx < 0 || constructor_idx >= _constructors_count);
  1386. Variant::ValidatedConstructor constructor = _constructors_ptr[constructor_idx];
  1387. Variant **argptrs = instruction_args;
  1388. GET_INSTRUCTION_ARG(dst, argc);
  1389. constructor(dst, (const Variant **)argptrs);
  1390. ip += 3;
  1391. }
  1392. DISPATCH_OPCODE;
  1393. OPCODE(OPCODE_CONSTRUCT_ARRAY) {
  1394. LOAD_INSTRUCTION_ARGS
  1395. CHECK_SPACE(1 + instr_arg_count);
  1396. ip += instr_arg_count;
  1397. int argc = _code_ptr[ip + 1];
  1398. Array array;
  1399. array.resize(argc);
  1400. for (int i = 0; i < argc; i++) {
  1401. array[i] = *(instruction_args[i]);
  1402. }
  1403. GET_INSTRUCTION_ARG(dst, argc);
  1404. *dst = Variant(); // Clear potential previous typed array.
  1405. *dst = array;
  1406. ip += 2;
  1407. }
  1408. DISPATCH_OPCODE;
  1409. OPCODE(OPCODE_CONSTRUCT_TYPED_ARRAY) {
  1410. LOAD_INSTRUCTION_ARGS
  1411. CHECK_SPACE(3 + instr_arg_count);
  1412. ip += instr_arg_count;
  1413. int argc = _code_ptr[ip + 1];
  1414. GET_INSTRUCTION_ARG(script_type, argc + 1);
  1415. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 2];
  1416. int native_type_idx = _code_ptr[ip + 3];
  1417. GD_ERR_BREAK(native_type_idx < 0 || native_type_idx >= _global_names_count);
  1418. const StringName native_type = _global_names_ptr[native_type_idx];
  1419. Array array;
  1420. array.resize(argc);
  1421. for (int i = 0; i < argc; i++) {
  1422. array[i] = *(instruction_args[i]);
  1423. }
  1424. GET_INSTRUCTION_ARG(dst, argc);
  1425. *dst = Variant(); // Clear potential previous typed array.
  1426. *dst = Array(array, builtin_type, native_type, *script_type);
  1427. ip += 4;
  1428. }
  1429. DISPATCH_OPCODE;
  1430. OPCODE(OPCODE_CONSTRUCT_DICTIONARY) {
  1431. LOAD_INSTRUCTION_ARGS
  1432. CHECK_SPACE(2 + instr_arg_count);
  1433. ip += instr_arg_count;
  1434. int argc = _code_ptr[ip + 1];
  1435. Dictionary dict;
  1436. for (int i = 0; i < argc; i++) {
  1437. GET_INSTRUCTION_ARG(k, i * 2 + 0);
  1438. GET_INSTRUCTION_ARG(v, i * 2 + 1);
  1439. dict[*k] = *v;
  1440. }
  1441. GET_INSTRUCTION_ARG(dst, argc * 2);
  1442. *dst = dict;
  1443. ip += 2;
  1444. }
  1445. DISPATCH_OPCODE;
  1446. OPCODE(OPCODE_CALL_ASYNC)
  1447. OPCODE(OPCODE_CALL_RETURN)
  1448. OPCODE(OPCODE_CALL) {
  1449. bool call_ret = (_code_ptr[ip]) != OPCODE_CALL;
  1450. #ifdef DEBUG_ENABLED
  1451. bool call_async = (_code_ptr[ip]) == OPCODE_CALL_ASYNC;
  1452. #endif
  1453. LOAD_INSTRUCTION_ARGS
  1454. CHECK_SPACE(3 + instr_arg_count);
  1455. ip += instr_arg_count;
  1456. int argc = _code_ptr[ip + 1];
  1457. GD_ERR_BREAK(argc < 0);
  1458. int methodname_idx = _code_ptr[ip + 2];
  1459. GD_ERR_BREAK(methodname_idx < 0 || methodname_idx >= _global_names_count);
  1460. const StringName *methodname = &_global_names_ptr[methodname_idx];
  1461. GET_INSTRUCTION_ARG(base, argc);
  1462. Variant **argptrs = instruction_args;
  1463. #ifdef DEBUG_ENABLED
  1464. uint64_t call_time = 0;
  1465. if (GDScriptLanguage::get_singleton()->profiling) {
  1466. call_time = OS::get_singleton()->get_ticks_usec();
  1467. }
  1468. Variant::Type base_type = base->get_type();
  1469. Object *base_obj = base->get_validated_object();
  1470. StringName base_class = base_obj ? base_obj->get_class_name() : StringName();
  1471. #endif
  1472. Callable::CallError err;
  1473. if (call_ret) {
  1474. GET_INSTRUCTION_ARG(ret, argc + 1);
  1475. base->callp(*methodname, (const Variant **)argptrs, argc, *ret, err);
  1476. #ifdef DEBUG_ENABLED
  1477. if (ret->get_type() == Variant::NIL) {
  1478. if (base_type == Variant::OBJECT) {
  1479. if (base_obj) {
  1480. MethodBind *method = ClassDB::get_method(base_class, *methodname);
  1481. if (*methodname == CoreStringNames::get_singleton()->_free || (method && !method->has_return())) {
  1482. err_text = R"(Trying to get a return value of a method that returns "void")";
  1483. OPCODE_BREAK;
  1484. }
  1485. }
  1486. } else if (Variant::has_builtin_method(base_type, *methodname) && !Variant::has_builtin_method_return_value(base_type, *methodname)) {
  1487. err_text = R"(Trying to get a return value of a method that returns "void")";
  1488. OPCODE_BREAK;
  1489. }
  1490. }
  1491. if (!call_async && ret->get_type() == Variant::OBJECT) {
  1492. // Check if getting a function state without await.
  1493. bool was_freed = false;
  1494. Object *obj = ret->get_validated_object_with_check(was_freed);
  1495. if (obj && obj->is_class_ptr(GDScriptFunctionState::get_class_ptr_static())) {
  1496. err_text = R"(Trying to call an async function without "await".)";
  1497. OPCODE_BREAK;
  1498. }
  1499. }
  1500. #endif
  1501. } else {
  1502. Variant ret;
  1503. base->callp(*methodname, (const Variant **)argptrs, argc, ret, err);
  1504. }
  1505. #ifdef DEBUG_ENABLED
  1506. if (GDScriptLanguage::get_singleton()->profiling) {
  1507. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1508. if (GDScriptLanguage::get_singleton()->profile_native_calls && _profile_count_as_native(base_obj, *methodname)) {
  1509. _profile_native_call(t_taken, *methodname, base_class);
  1510. }
  1511. function_call_time += t_taken;
  1512. }
  1513. if (err.error != Callable::CallError::CALL_OK) {
  1514. String methodstr = *methodname;
  1515. String basestr = _get_var_type(base);
  1516. bool is_callable = false;
  1517. if (methodstr == "call") {
  1518. if (argc >= 1 && base->get_type() != Variant::CALLABLE) {
  1519. methodstr = String(*argptrs[0]) + " (via call)";
  1520. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  1521. err.argument += 1;
  1522. }
  1523. } else {
  1524. methodstr = base->operator String() + " (Callable)";
  1525. is_callable = true;
  1526. }
  1527. } else if (methodstr == "free") {
  1528. if (err.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  1529. if (base->is_ref_counted()) {
  1530. err_text = "Attempted to free a reference.";
  1531. OPCODE_BREAK;
  1532. } else if (base->get_type() == Variant::OBJECT) {
  1533. err_text = "Attempted to free a locked object (calling or emitting).";
  1534. OPCODE_BREAK;
  1535. }
  1536. }
  1537. } else if (methodstr == "call_recursive" && basestr == "TreeItem") {
  1538. if (argc >= 1) {
  1539. methodstr = String(*argptrs[0]) + " (via TreeItem.call_recursive)";
  1540. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  1541. err.argument += 1;
  1542. }
  1543. }
  1544. }
  1545. err_text = _get_call_error(err, "function '" + methodstr + (is_callable ? "" : "' in base '" + basestr) + "'", (const Variant **)argptrs);
  1546. OPCODE_BREAK;
  1547. }
  1548. #endif
  1549. ip += 3;
  1550. }
  1551. DISPATCH_OPCODE;
  1552. OPCODE(OPCODE_CALL_METHOD_BIND)
  1553. OPCODE(OPCODE_CALL_METHOD_BIND_RET) {
  1554. bool call_ret = (_code_ptr[ip]) == OPCODE_CALL_METHOD_BIND_RET;
  1555. LOAD_INSTRUCTION_ARGS
  1556. CHECK_SPACE(3 + instr_arg_count);
  1557. ip += instr_arg_count;
  1558. int argc = _code_ptr[ip + 1];
  1559. GD_ERR_BREAK(argc < 0);
  1560. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1561. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1562. GET_INSTRUCTION_ARG(base, argc);
  1563. #ifdef DEBUG_ENABLED
  1564. bool freed = false;
  1565. Object *base_obj = base->get_validated_object_with_check(freed);
  1566. if (freed) {
  1567. err_text = METHOD_CALL_ON_FREED_INSTANCE_ERROR(method);
  1568. OPCODE_BREAK;
  1569. } else if (!base_obj) {
  1570. err_text = METHOD_CALL_ON_NULL_VALUE_ERROR(method);
  1571. OPCODE_BREAK;
  1572. }
  1573. #else
  1574. Object *base_obj = base->operator Object *();
  1575. #endif
  1576. Variant **argptrs = instruction_args;
  1577. #ifdef DEBUG_ENABLED
  1578. uint64_t call_time = 0;
  1579. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1580. call_time = OS::get_singleton()->get_ticks_usec();
  1581. }
  1582. #endif
  1583. Callable::CallError err;
  1584. if (call_ret) {
  1585. GET_INSTRUCTION_ARG(ret, argc + 1);
  1586. *ret = method->call(base_obj, (const Variant **)argptrs, argc, err);
  1587. } else {
  1588. method->call(base_obj, (const Variant **)argptrs, argc, err);
  1589. }
  1590. #ifdef DEBUG_ENABLED
  1591. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1592. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1593. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1594. function_call_time += t_taken;
  1595. }
  1596. if (err.error != Callable::CallError::CALL_OK) {
  1597. String methodstr = method->get_name();
  1598. String basestr = _get_var_type(base);
  1599. if (methodstr == "call") {
  1600. if (argc >= 1) {
  1601. methodstr = String(*argptrs[0]) + " (via call)";
  1602. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  1603. err.argument += 1;
  1604. }
  1605. }
  1606. } else if (methodstr == "free") {
  1607. if (err.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  1608. if (base->is_ref_counted()) {
  1609. err_text = "Attempted to free a reference.";
  1610. OPCODE_BREAK;
  1611. } else if (base->get_type() == Variant::OBJECT) {
  1612. err_text = "Attempted to free a locked object (calling or emitting).";
  1613. OPCODE_BREAK;
  1614. }
  1615. }
  1616. }
  1617. err_text = _get_call_error(err, "function '" + methodstr + "' in base '" + basestr + "'", (const Variant **)argptrs);
  1618. OPCODE_BREAK;
  1619. }
  1620. #endif
  1621. ip += 3;
  1622. }
  1623. DISPATCH_OPCODE;
  1624. OPCODE(OPCODE_CALL_BUILTIN_STATIC) {
  1625. LOAD_INSTRUCTION_ARGS
  1626. CHECK_SPACE(4 + instr_arg_count);
  1627. ip += instr_arg_count;
  1628. GD_ERR_BREAK(_code_ptr[ip + 1] < 0 || _code_ptr[ip + 1] >= Variant::VARIANT_MAX);
  1629. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 1];
  1630. int methodname_idx = _code_ptr[ip + 2];
  1631. GD_ERR_BREAK(methodname_idx < 0 || methodname_idx >= _global_names_count);
  1632. const StringName *methodname = &_global_names_ptr[methodname_idx];
  1633. int argc = _code_ptr[ip + 3];
  1634. GD_ERR_BREAK(argc < 0);
  1635. GET_INSTRUCTION_ARG(ret, argc);
  1636. const Variant **argptrs = const_cast<const Variant **>(instruction_args);
  1637. Callable::CallError err;
  1638. Variant::call_static(builtin_type, *methodname, argptrs, argc, *ret, err);
  1639. #ifdef DEBUG_ENABLED
  1640. if (err.error != Callable::CallError::CALL_OK) {
  1641. err_text = _get_call_error(err, "static function '" + methodname->operator String() + "' in type '" + Variant::get_type_name(builtin_type) + "'", argptrs);
  1642. OPCODE_BREAK;
  1643. }
  1644. #endif
  1645. ip += 4;
  1646. }
  1647. DISPATCH_OPCODE;
  1648. OPCODE(OPCODE_CALL_NATIVE_STATIC) {
  1649. LOAD_INSTRUCTION_ARGS
  1650. CHECK_SPACE(3 + instr_arg_count);
  1651. ip += instr_arg_count;
  1652. GD_ERR_BREAK(_code_ptr[ip + 1] < 0 || _code_ptr[ip + 1] >= _methods_count);
  1653. MethodBind *method = _methods_ptr[_code_ptr[ip + 1]];
  1654. int argc = _code_ptr[ip + 2];
  1655. GD_ERR_BREAK(argc < 0);
  1656. GET_INSTRUCTION_ARG(ret, argc);
  1657. const Variant **argptrs = const_cast<const Variant **>(instruction_args);
  1658. #ifdef DEBUG_ENABLED
  1659. uint64_t call_time = 0;
  1660. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1661. call_time = OS::get_singleton()->get_ticks_usec();
  1662. }
  1663. #endif
  1664. Callable::CallError err;
  1665. *ret = method->call(nullptr, argptrs, argc, err);
  1666. #ifdef DEBUG_ENABLED
  1667. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1668. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1669. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1670. function_call_time += t_taken;
  1671. }
  1672. #endif
  1673. if (err.error != Callable::CallError::CALL_OK) {
  1674. err_text = _get_call_error(err, "static function '" + method->get_name().operator String() + "' in type '" + method->get_instance_class().operator String() + "'", argptrs);
  1675. OPCODE_BREAK;
  1676. }
  1677. ip += 3;
  1678. }
  1679. DISPATCH_OPCODE;
  1680. OPCODE(OPCODE_CALL_NATIVE_STATIC_VALIDATED_RETURN) {
  1681. LOAD_INSTRUCTION_ARGS
  1682. CHECK_SPACE(3 + instr_arg_count);
  1683. ip += instr_arg_count;
  1684. int argc = _code_ptr[ip + 1];
  1685. GD_ERR_BREAK(argc < 0);
  1686. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1687. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1688. Variant **argptrs = instruction_args;
  1689. #ifdef DEBUG_ENABLED
  1690. uint64_t call_time = 0;
  1691. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1692. call_time = OS::get_singleton()->get_ticks_usec();
  1693. }
  1694. #endif
  1695. GET_INSTRUCTION_ARG(ret, argc);
  1696. method->validated_call(nullptr, (const Variant **)argptrs, ret);
  1697. #ifdef DEBUG_ENABLED
  1698. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1699. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1700. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1701. function_call_time += t_taken;
  1702. }
  1703. #endif
  1704. ip += 3;
  1705. }
  1706. DISPATCH_OPCODE;
  1707. OPCODE(OPCODE_CALL_NATIVE_STATIC_VALIDATED_NO_RETURN) {
  1708. LOAD_INSTRUCTION_ARGS
  1709. CHECK_SPACE(3 + instr_arg_count);
  1710. ip += instr_arg_count;
  1711. int argc = _code_ptr[ip + 1];
  1712. GD_ERR_BREAK(argc < 0);
  1713. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1714. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1715. Variant **argptrs = instruction_args;
  1716. #ifdef DEBUG_ENABLED
  1717. uint64_t call_time = 0;
  1718. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1719. call_time = OS::get_singleton()->get_ticks_usec();
  1720. }
  1721. #endif
  1722. GET_INSTRUCTION_ARG(ret, argc);
  1723. VariantInternal::initialize(ret, Variant::NIL);
  1724. method->validated_call(nullptr, (const Variant **)argptrs, nullptr);
  1725. #ifdef DEBUG_ENABLED
  1726. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1727. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1728. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1729. function_call_time += t_taken;
  1730. }
  1731. #endif
  1732. ip += 3;
  1733. }
  1734. DISPATCH_OPCODE;
  1735. OPCODE(OPCODE_CALL_METHOD_BIND_VALIDATED_RETURN) {
  1736. LOAD_INSTRUCTION_ARGS
  1737. CHECK_SPACE(3 + instr_arg_count);
  1738. ip += instr_arg_count;
  1739. int argc = _code_ptr[ip + 1];
  1740. GD_ERR_BREAK(argc < 0);
  1741. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1742. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1743. GET_INSTRUCTION_ARG(base, argc);
  1744. #ifdef DEBUG_ENABLED
  1745. bool freed = false;
  1746. Object *base_obj = base->get_validated_object_with_check(freed);
  1747. if (freed) {
  1748. err_text = METHOD_CALL_ON_FREED_INSTANCE_ERROR(method);
  1749. OPCODE_BREAK;
  1750. } else if (!base_obj) {
  1751. err_text = METHOD_CALL_ON_NULL_VALUE_ERROR(method);
  1752. OPCODE_BREAK;
  1753. }
  1754. #else
  1755. Object *base_obj = *VariantInternal::get_object(base);
  1756. #endif
  1757. Variant **argptrs = instruction_args;
  1758. #ifdef DEBUG_ENABLED
  1759. uint64_t call_time = 0;
  1760. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1761. call_time = OS::get_singleton()->get_ticks_usec();
  1762. }
  1763. #endif
  1764. GET_INSTRUCTION_ARG(ret, argc + 1);
  1765. method->validated_call(base_obj, (const Variant **)argptrs, ret);
  1766. #ifdef DEBUG_ENABLED
  1767. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1768. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1769. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1770. function_call_time += t_taken;
  1771. }
  1772. #endif
  1773. ip += 3;
  1774. }
  1775. DISPATCH_OPCODE;
  1776. OPCODE(OPCODE_CALL_METHOD_BIND_VALIDATED_NO_RETURN) {
  1777. LOAD_INSTRUCTION_ARGS
  1778. CHECK_SPACE(3 + instr_arg_count);
  1779. ip += instr_arg_count;
  1780. int argc = _code_ptr[ip + 1];
  1781. GD_ERR_BREAK(argc < 0);
  1782. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1783. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1784. GET_INSTRUCTION_ARG(base, argc);
  1785. #ifdef DEBUG_ENABLED
  1786. bool freed = false;
  1787. Object *base_obj = base->get_validated_object_with_check(freed);
  1788. if (freed) {
  1789. err_text = METHOD_CALL_ON_FREED_INSTANCE_ERROR(method);
  1790. OPCODE_BREAK;
  1791. } else if (!base_obj) {
  1792. err_text = METHOD_CALL_ON_NULL_VALUE_ERROR(method);
  1793. OPCODE_BREAK;
  1794. }
  1795. #else
  1796. Object *base_obj = *VariantInternal::get_object(base);
  1797. #endif
  1798. Variant **argptrs = instruction_args;
  1799. #ifdef DEBUG_ENABLED
  1800. uint64_t call_time = 0;
  1801. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1802. call_time = OS::get_singleton()->get_ticks_usec();
  1803. }
  1804. #endif
  1805. GET_INSTRUCTION_ARG(ret, argc + 1);
  1806. VariantInternal::initialize(ret, Variant::NIL);
  1807. method->validated_call(base_obj, (const Variant **)argptrs, nullptr);
  1808. #ifdef DEBUG_ENABLED
  1809. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1810. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1811. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1812. function_call_time += t_taken;
  1813. }
  1814. #endif
  1815. ip += 3;
  1816. }
  1817. DISPATCH_OPCODE;
  1818. OPCODE(OPCODE_CALL_BUILTIN_TYPE_VALIDATED) {
  1819. LOAD_INSTRUCTION_ARGS
  1820. CHECK_SPACE(3 + instr_arg_count);
  1821. ip += instr_arg_count;
  1822. int argc = _code_ptr[ip + 1];
  1823. GD_ERR_BREAK(argc < 0);
  1824. GET_INSTRUCTION_ARG(base, argc);
  1825. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _builtin_methods_count);
  1826. Variant::ValidatedBuiltInMethod method = _builtin_methods_ptr[_code_ptr[ip + 2]];
  1827. Variant **argptrs = instruction_args;
  1828. GET_INSTRUCTION_ARG(ret, argc + 1);
  1829. method(base, (const Variant **)argptrs, argc, ret);
  1830. ip += 3;
  1831. }
  1832. DISPATCH_OPCODE;
  1833. OPCODE(OPCODE_CALL_UTILITY) {
  1834. LOAD_INSTRUCTION_ARGS
  1835. CHECK_SPACE(3 + instr_arg_count);
  1836. ip += instr_arg_count;
  1837. int argc = _code_ptr[ip + 1];
  1838. GD_ERR_BREAK(argc < 0);
  1839. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _global_names_count);
  1840. StringName function = _global_names_ptr[_code_ptr[ip + 2]];
  1841. Variant **argptrs = instruction_args;
  1842. GET_INSTRUCTION_ARG(dst, argc);
  1843. Callable::CallError err;
  1844. Variant::call_utility_function(function, dst, (const Variant **)argptrs, argc, err);
  1845. #ifdef DEBUG_ENABLED
  1846. if (err.error != Callable::CallError::CALL_OK) {
  1847. String methodstr = function;
  1848. if (dst->get_type() == Variant::STRING && !dst->operator String().is_empty()) {
  1849. // Call provided error string.
  1850. err_text = vformat(R"*(Error calling utility function "%s()": %s)*", methodstr, *dst);
  1851. } else {
  1852. err_text = _get_call_error(err, vformat(R"*(utility function "%s()")*", methodstr), (const Variant **)argptrs);
  1853. }
  1854. OPCODE_BREAK;
  1855. }
  1856. #endif
  1857. ip += 3;
  1858. }
  1859. DISPATCH_OPCODE;
  1860. OPCODE(OPCODE_CALL_UTILITY_VALIDATED) {
  1861. LOAD_INSTRUCTION_ARGS
  1862. CHECK_SPACE(3 + instr_arg_count);
  1863. ip += instr_arg_count;
  1864. int argc = _code_ptr[ip + 1];
  1865. GD_ERR_BREAK(argc < 0);
  1866. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _utilities_count);
  1867. Variant::ValidatedUtilityFunction function = _utilities_ptr[_code_ptr[ip + 2]];
  1868. Variant **argptrs = instruction_args;
  1869. GET_INSTRUCTION_ARG(dst, argc);
  1870. function(dst, (const Variant **)argptrs, argc);
  1871. ip += 3;
  1872. }
  1873. DISPATCH_OPCODE;
  1874. OPCODE(OPCODE_CALL_GDSCRIPT_UTILITY) {
  1875. LOAD_INSTRUCTION_ARGS
  1876. CHECK_SPACE(3 + instr_arg_count);
  1877. ip += instr_arg_count;
  1878. int argc = _code_ptr[ip + 1];
  1879. GD_ERR_BREAK(argc < 0);
  1880. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _gds_utilities_count);
  1881. GDScriptUtilityFunctions::FunctionPtr function = _gds_utilities_ptr[_code_ptr[ip + 2]];
  1882. Variant **argptrs = instruction_args;
  1883. GET_INSTRUCTION_ARG(dst, argc);
  1884. Callable::CallError err;
  1885. function(dst, (const Variant **)argptrs, argc, err);
  1886. #ifdef DEBUG_ENABLED
  1887. if (err.error != Callable::CallError::CALL_OK) {
  1888. String methodstr = gds_utilities_names[_code_ptr[ip + 2]];
  1889. if (dst->get_type() == Variant::STRING && !dst->operator String().is_empty()) {
  1890. // Call provided error string.
  1891. err_text = vformat(R"*(Error calling GDScript utility function "%s()": %s)*", methodstr, *dst);
  1892. } else {
  1893. err_text = _get_call_error(err, vformat(R"*(GDScript utility function "%s()")*", methodstr), (const Variant **)argptrs);
  1894. }
  1895. OPCODE_BREAK;
  1896. }
  1897. #endif
  1898. ip += 3;
  1899. }
  1900. DISPATCH_OPCODE;
  1901. OPCODE(OPCODE_CALL_SELF_BASE) {
  1902. LOAD_INSTRUCTION_ARGS
  1903. CHECK_SPACE(3 + instr_arg_count);
  1904. ip += instr_arg_count;
  1905. int argc = _code_ptr[ip + 1];
  1906. GD_ERR_BREAK(argc < 0);
  1907. int self_fun = _code_ptr[ip + 2];
  1908. #ifdef DEBUG_ENABLED
  1909. if (self_fun < 0 || self_fun >= _global_names_count) {
  1910. err_text = "compiler bug, function name not found";
  1911. OPCODE_BREAK;
  1912. }
  1913. #endif
  1914. const StringName *methodname = &_global_names_ptr[self_fun];
  1915. Variant **argptrs = instruction_args;
  1916. GET_INSTRUCTION_ARG(dst, argc);
  1917. const GDScript *gds = _script;
  1918. HashMap<StringName, GDScriptFunction *>::ConstIterator E;
  1919. while (gds->base.ptr()) {
  1920. gds = gds->base.ptr();
  1921. E = gds->member_functions.find(*methodname);
  1922. if (E) {
  1923. break;
  1924. }
  1925. }
  1926. Callable::CallError err;
  1927. if (E) {
  1928. *dst = E->value->call(p_instance, (const Variant **)argptrs, argc, err);
  1929. } else if (gds->native.ptr()) {
  1930. if (*methodname != GDScriptLanguage::get_singleton()->strings._init) {
  1931. MethodBind *mb = ClassDB::get_method(gds->native->get_name(), *methodname);
  1932. if (!mb) {
  1933. err.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1934. } else {
  1935. *dst = mb->call(p_instance->owner, (const Variant **)argptrs, argc, err);
  1936. }
  1937. } else {
  1938. err.error = Callable::CallError::CALL_OK;
  1939. }
  1940. } else {
  1941. if (*methodname != GDScriptLanguage::get_singleton()->strings._init) {
  1942. err.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1943. } else {
  1944. err.error = Callable::CallError::CALL_OK;
  1945. }
  1946. }
  1947. if (err.error != Callable::CallError::CALL_OK) {
  1948. String methodstr = *methodname;
  1949. err_text = _get_call_error(err, "function '" + methodstr + "'", (const Variant **)argptrs);
  1950. OPCODE_BREAK;
  1951. }
  1952. ip += 3;
  1953. }
  1954. DISPATCH_OPCODE;
  1955. OPCODE(OPCODE_AWAIT) {
  1956. CHECK_SPACE(2);
  1957. // Do the one-shot connect.
  1958. GET_VARIANT_PTR(argobj, 0);
  1959. Signal sig;
  1960. bool is_signal = true;
  1961. {
  1962. Variant result = *argobj;
  1963. if (argobj->get_type() == Variant::OBJECT) {
  1964. bool was_freed = false;
  1965. Object *obj = argobj->get_validated_object_with_check(was_freed);
  1966. if (was_freed) {
  1967. err_text = "Trying to await on a freed object.";
  1968. OPCODE_BREAK;
  1969. }
  1970. // Is this even possible to be null at this point?
  1971. if (obj) {
  1972. if (obj->is_class_ptr(GDScriptFunctionState::get_class_ptr_static())) {
  1973. result = Signal(obj, "completed");
  1974. }
  1975. }
  1976. }
  1977. if (result.get_type() != Variant::SIGNAL) {
  1978. // Not async, return immediately using the target from OPCODE_AWAIT_RESUME.
  1979. GET_VARIANT_PTR(target, 2);
  1980. *target = result;
  1981. ip += 4; // Skip OPCODE_AWAIT_RESUME and its data.
  1982. is_signal = false;
  1983. } else {
  1984. sig = result;
  1985. }
  1986. }
  1987. if (is_signal) {
  1988. Ref<GDScriptFunctionState> gdfs = memnew(GDScriptFunctionState);
  1989. gdfs->function = this;
  1990. gdfs->state.stack.resize(alloca_size);
  1991. // First 3 stack addresses are special, so we just skip them here.
  1992. for (int i = 3; i < _stack_size; i++) {
  1993. memnew_placement(&gdfs->state.stack.write[sizeof(Variant) * i], Variant(stack[i]));
  1994. }
  1995. gdfs->state.stack_size = _stack_size;
  1996. gdfs->state.alloca_size = alloca_size;
  1997. gdfs->state.ip = ip + 2;
  1998. gdfs->state.line = line;
  1999. gdfs->state.script = _script;
  2000. {
  2001. MutexLock lock(GDScriptLanguage::get_singleton()->mutex);
  2002. _script->pending_func_states.add(&gdfs->scripts_list);
  2003. if (p_instance) {
  2004. gdfs->state.instance = p_instance;
  2005. p_instance->pending_func_states.add(&gdfs->instances_list);
  2006. } else {
  2007. gdfs->state.instance = nullptr;
  2008. }
  2009. }
  2010. #ifdef DEBUG_ENABLED
  2011. gdfs->state.function_name = name;
  2012. gdfs->state.script_path = _script->get_script_path();
  2013. #endif
  2014. gdfs->state.defarg = defarg;
  2015. gdfs->function = this;
  2016. retvalue = gdfs;
  2017. Error err = sig.connect(Callable(gdfs.ptr(), "_signal_callback").bind(retvalue), Object::CONNECT_ONE_SHOT);
  2018. if (err != OK) {
  2019. err_text = "Error connecting to signal: " + sig.get_name() + " during await.";
  2020. OPCODE_BREAK;
  2021. }
  2022. #ifdef DEBUG_ENABLED
  2023. exit_ok = true;
  2024. awaited = true;
  2025. #endif
  2026. OPCODE_BREAK;
  2027. }
  2028. }
  2029. DISPATCH_OPCODE; // Needed for synchronous calls (when result is immediately available).
  2030. OPCODE(OPCODE_AWAIT_RESUME) {
  2031. CHECK_SPACE(2);
  2032. #ifdef DEBUG_ENABLED
  2033. if (!p_state) {
  2034. err_text = ("Invalid Resume (bug?)");
  2035. OPCODE_BREAK;
  2036. }
  2037. #endif
  2038. GET_VARIANT_PTR(result, 0);
  2039. *result = p_state->result;
  2040. ip += 2;
  2041. }
  2042. DISPATCH_OPCODE;
  2043. OPCODE(OPCODE_CREATE_LAMBDA) {
  2044. LOAD_INSTRUCTION_ARGS
  2045. CHECK_SPACE(2 + instr_arg_count);
  2046. ip += instr_arg_count;
  2047. int captures_count = _code_ptr[ip + 1];
  2048. GD_ERR_BREAK(captures_count < 0);
  2049. int lambda_index = _code_ptr[ip + 2];
  2050. GD_ERR_BREAK(lambda_index < 0 || lambda_index >= _lambdas_count);
  2051. GDScriptFunction *lambda = _lambdas_ptr[lambda_index];
  2052. Vector<Variant> captures;
  2053. captures.resize(captures_count);
  2054. for (int i = 0; i < captures_count; i++) {
  2055. GET_INSTRUCTION_ARG(arg, i);
  2056. captures.write[i] = *arg;
  2057. }
  2058. GDScriptLambdaCallable *callable = memnew(GDScriptLambdaCallable(Ref<GDScript>(script), lambda, captures));
  2059. GET_INSTRUCTION_ARG(result, captures_count);
  2060. *result = Callable(callable);
  2061. ip += 3;
  2062. }
  2063. DISPATCH_OPCODE;
  2064. OPCODE(OPCODE_CREATE_SELF_LAMBDA) {
  2065. LOAD_INSTRUCTION_ARGS
  2066. CHECK_SPACE(2 + instr_arg_count);
  2067. GD_ERR_BREAK(p_instance == nullptr);
  2068. ip += instr_arg_count;
  2069. int captures_count = _code_ptr[ip + 1];
  2070. GD_ERR_BREAK(captures_count < 0);
  2071. int lambda_index = _code_ptr[ip + 2];
  2072. GD_ERR_BREAK(lambda_index < 0 || lambda_index >= _lambdas_count);
  2073. GDScriptFunction *lambda = _lambdas_ptr[lambda_index];
  2074. Vector<Variant> captures;
  2075. captures.resize(captures_count);
  2076. for (int i = 0; i < captures_count; i++) {
  2077. GET_INSTRUCTION_ARG(arg, i);
  2078. captures.write[i] = *arg;
  2079. }
  2080. GDScriptLambdaSelfCallable *callable;
  2081. if (Object::cast_to<RefCounted>(p_instance->owner)) {
  2082. callable = memnew(GDScriptLambdaSelfCallable(Ref<RefCounted>(Object::cast_to<RefCounted>(p_instance->owner)), lambda, captures));
  2083. } else {
  2084. callable = memnew(GDScriptLambdaSelfCallable(p_instance->owner, lambda, captures));
  2085. }
  2086. GET_INSTRUCTION_ARG(result, captures_count);
  2087. *result = Callable(callable);
  2088. ip += 3;
  2089. }
  2090. DISPATCH_OPCODE;
  2091. OPCODE(OPCODE_JUMP) {
  2092. CHECK_SPACE(2);
  2093. int to = _code_ptr[ip + 1];
  2094. GD_ERR_BREAK(to < 0 || to > _code_size);
  2095. ip = to;
  2096. }
  2097. DISPATCH_OPCODE;
  2098. OPCODE(OPCODE_JUMP_IF) {
  2099. CHECK_SPACE(3);
  2100. GET_VARIANT_PTR(test, 0);
  2101. bool result = test->booleanize();
  2102. if (result) {
  2103. int to = _code_ptr[ip + 2];
  2104. GD_ERR_BREAK(to < 0 || to > _code_size);
  2105. ip = to;
  2106. } else {
  2107. ip += 3;
  2108. }
  2109. }
  2110. DISPATCH_OPCODE;
  2111. OPCODE(OPCODE_JUMP_IF_NOT) {
  2112. CHECK_SPACE(3);
  2113. GET_VARIANT_PTR(test, 0);
  2114. bool result = test->booleanize();
  2115. if (!result) {
  2116. int to = _code_ptr[ip + 2];
  2117. GD_ERR_BREAK(to < 0 || to > _code_size);
  2118. ip = to;
  2119. } else {
  2120. ip += 3;
  2121. }
  2122. }
  2123. DISPATCH_OPCODE;
  2124. OPCODE(OPCODE_JUMP_TO_DEF_ARGUMENT) {
  2125. CHECK_SPACE(2);
  2126. ip = _default_arg_ptr[defarg];
  2127. }
  2128. DISPATCH_OPCODE;
  2129. OPCODE(OPCODE_JUMP_IF_SHARED) {
  2130. CHECK_SPACE(3);
  2131. GET_VARIANT_PTR(val, 0);
  2132. if (val->is_shared()) {
  2133. int to = _code_ptr[ip + 2];
  2134. GD_ERR_BREAK(to < 0 || to > _code_size);
  2135. ip = to;
  2136. } else {
  2137. ip += 3;
  2138. }
  2139. }
  2140. DISPATCH_OPCODE;
  2141. OPCODE(OPCODE_RETURN) {
  2142. CHECK_SPACE(2);
  2143. GET_VARIANT_PTR(r, 0);
  2144. retvalue = *r;
  2145. #ifdef DEBUG_ENABLED
  2146. exit_ok = true;
  2147. #endif
  2148. OPCODE_BREAK;
  2149. }
  2150. OPCODE(OPCODE_RETURN_TYPED_BUILTIN) {
  2151. CHECK_SPACE(3);
  2152. GET_VARIANT_PTR(r, 0);
  2153. Variant::Type ret_type = (Variant::Type)_code_ptr[ip + 2];
  2154. GD_ERR_BREAK(ret_type < 0 || ret_type >= Variant::VARIANT_MAX);
  2155. if (r->get_type() != ret_type) {
  2156. if (Variant::can_convert_strict(r->get_type(), ret_type)) {
  2157. Callable::CallError ce;
  2158. Variant::construct(ret_type, retvalue, const_cast<const Variant **>(&r), 1, ce);
  2159. } else {
  2160. #ifdef DEBUG_ENABLED
  2161. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "%s".)",
  2162. Variant::get_type_name(r->get_type()), Variant::get_type_name(ret_type));
  2163. #endif // DEBUG_ENABLED
  2164. // Construct a base type anyway so type constraints are met.
  2165. Callable::CallError ce;
  2166. Variant::construct(ret_type, retvalue, nullptr, 0, ce);
  2167. OPCODE_BREAK;
  2168. }
  2169. } else {
  2170. retvalue = *r;
  2171. }
  2172. #ifdef DEBUG_ENABLED
  2173. exit_ok = true;
  2174. #endif // DEBUG_ENABLED
  2175. OPCODE_BREAK;
  2176. }
  2177. OPCODE(OPCODE_RETURN_TYPED_ARRAY) {
  2178. CHECK_SPACE(5);
  2179. GET_VARIANT_PTR(r, 0);
  2180. GET_VARIANT_PTR(script_type, 1);
  2181. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 3];
  2182. int native_type_idx = _code_ptr[ip + 4];
  2183. GD_ERR_BREAK(native_type_idx < 0 || native_type_idx >= _global_names_count);
  2184. const StringName native_type = _global_names_ptr[native_type_idx];
  2185. if (r->get_type() != Variant::ARRAY) {
  2186. #ifdef DEBUG_ENABLED
  2187. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "Array[%s]".)",
  2188. Variant::get_type_name(r->get_type()), Variant::get_type_name(builtin_type));
  2189. #endif
  2190. OPCODE_BREAK;
  2191. }
  2192. Array *array = VariantInternal::get_array(r);
  2193. if (array->get_typed_builtin() != ((uint32_t)builtin_type) || array->get_typed_class_name() != native_type || array->get_typed_script() != *script_type) {
  2194. #ifdef DEBUG_ENABLED
  2195. err_text = vformat(R"(Trying to return an array of type "%s" where expected return type is "Array[%s]".)",
  2196. _get_var_type(r), _get_element_type(builtin_type, native_type, *script_type));
  2197. #endif // DEBUG_ENABLED
  2198. OPCODE_BREAK;
  2199. }
  2200. retvalue = *array;
  2201. #ifdef DEBUG_ENABLED
  2202. exit_ok = true;
  2203. #endif // DEBUG_ENABLED
  2204. OPCODE_BREAK;
  2205. }
  2206. OPCODE(OPCODE_RETURN_TYPED_NATIVE) {
  2207. CHECK_SPACE(3);
  2208. GET_VARIANT_PTR(r, 0);
  2209. GET_VARIANT_PTR(type, 1);
  2210. GDScriptNativeClass *nc = Object::cast_to<GDScriptNativeClass>(type->operator Object *());
  2211. GD_ERR_BREAK(!nc);
  2212. if (r->get_type() != Variant::OBJECT && r->get_type() != Variant::NIL) {
  2213. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "%s".)",
  2214. Variant::get_type_name(r->get_type()), nc->get_name());
  2215. OPCODE_BREAK;
  2216. }
  2217. #ifdef DEBUG_ENABLED
  2218. bool freed = false;
  2219. Object *ret_obj = r->get_validated_object_with_check(freed);
  2220. if (freed) {
  2221. err_text = "Trying to return a previously freed instance.";
  2222. OPCODE_BREAK;
  2223. }
  2224. #else
  2225. Object *ret_obj = r->operator Object *();
  2226. #endif // DEBUG_ENABLED
  2227. if (ret_obj && !ClassDB::is_parent_class(ret_obj->get_class_name(), nc->get_name())) {
  2228. #ifdef DEBUG_ENABLED
  2229. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "%s".)",
  2230. ret_obj->get_class_name(), nc->get_name());
  2231. #endif // DEBUG_ENABLED
  2232. OPCODE_BREAK;
  2233. }
  2234. retvalue = *r;
  2235. #ifdef DEBUG_ENABLED
  2236. exit_ok = true;
  2237. #endif // DEBUG_ENABLED
  2238. OPCODE_BREAK;
  2239. }
  2240. OPCODE(OPCODE_RETURN_TYPED_SCRIPT) {
  2241. CHECK_SPACE(3);
  2242. GET_VARIANT_PTR(r, 0);
  2243. GET_VARIANT_PTR(type, 1);
  2244. Script *base_type = Object::cast_to<Script>(type->operator Object *());
  2245. GD_ERR_BREAK(!base_type);
  2246. if (r->get_type() != Variant::OBJECT && r->get_type() != Variant::NIL) {
  2247. #ifdef DEBUG_ENABLED
  2248. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "%s".)",
  2249. Variant::get_type_name(r->get_type()), GDScript::debug_get_script_name(Ref<Script>(base_type)));
  2250. #endif // DEBUG_ENABLED
  2251. OPCODE_BREAK;
  2252. }
  2253. #ifdef DEBUG_ENABLED
  2254. bool freed = false;
  2255. Object *ret_obj = r->get_validated_object_with_check(freed);
  2256. if (freed) {
  2257. err_text = "Trying to return a previously freed instance.";
  2258. OPCODE_BREAK;
  2259. }
  2260. #else
  2261. Object *ret_obj = r->operator Object *();
  2262. #endif // DEBUG_ENABLED
  2263. if (ret_obj) {
  2264. ScriptInstance *ret_inst = ret_obj->get_script_instance();
  2265. if (!ret_inst) {
  2266. #ifdef DEBUG_ENABLED
  2267. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "%s".)",
  2268. ret_obj->get_class_name(), GDScript::debug_get_script_name(Ref<GDScript>(base_type)));
  2269. #endif // DEBUG_ENABLED
  2270. OPCODE_BREAK;
  2271. }
  2272. Script *ret_type = ret_obj->get_script_instance()->get_script().ptr();
  2273. bool valid = false;
  2274. while (ret_type) {
  2275. if (ret_type == base_type) {
  2276. valid = true;
  2277. break;
  2278. }
  2279. ret_type = ret_type->get_base_script().ptr();
  2280. }
  2281. if (!valid) {
  2282. #ifdef DEBUG_ENABLED
  2283. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "%s".)",
  2284. GDScript::debug_get_script_name(ret_obj->get_script_instance()->get_script()), GDScript::debug_get_script_name(Ref<GDScript>(base_type)));
  2285. #endif // DEBUG_ENABLED
  2286. OPCODE_BREAK;
  2287. }
  2288. }
  2289. retvalue = *r;
  2290. #ifdef DEBUG_ENABLED
  2291. exit_ok = true;
  2292. #endif // DEBUG_ENABLED
  2293. OPCODE_BREAK;
  2294. }
  2295. OPCODE(OPCODE_ITERATE_BEGIN) {
  2296. CHECK_SPACE(8); // Space for this and a regular iterate.
  2297. GET_VARIANT_PTR(counter, 0);
  2298. GET_VARIANT_PTR(container, 1);
  2299. *counter = Variant();
  2300. bool valid;
  2301. if (!container->iter_init(*counter, valid)) {
  2302. #ifdef DEBUG_ENABLED
  2303. if (!valid) {
  2304. err_text = "Unable to iterate on object of type '" + Variant::get_type_name(container->get_type()) + "'.";
  2305. OPCODE_BREAK;
  2306. }
  2307. #endif
  2308. int jumpto = _code_ptr[ip + 4];
  2309. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2310. ip = jumpto;
  2311. } else {
  2312. GET_VARIANT_PTR(iterator, 2);
  2313. *iterator = container->iter_get(*counter, valid);
  2314. #ifdef DEBUG_ENABLED
  2315. if (!valid) {
  2316. err_text = "Unable to obtain iterator object of type '" + Variant::get_type_name(container->get_type()) + "'.";
  2317. OPCODE_BREAK;
  2318. }
  2319. #endif
  2320. ip += 5; // Skip regular iterate which is always next.
  2321. }
  2322. }
  2323. DISPATCH_OPCODE;
  2324. OPCODE(OPCODE_ITERATE_BEGIN_INT) {
  2325. CHECK_SPACE(8); // Check space for iterate instruction too.
  2326. GET_VARIANT_PTR(counter, 0);
  2327. GET_VARIANT_PTR(container, 1);
  2328. int64_t size = *VariantInternal::get_int(container);
  2329. VariantInternal::initialize(counter, Variant::INT);
  2330. *VariantInternal::get_int(counter) = 0;
  2331. if (size > 0) {
  2332. GET_VARIANT_PTR(iterator, 2);
  2333. VariantInternal::initialize(iterator, Variant::INT);
  2334. *VariantInternal::get_int(iterator) = 0;
  2335. // Skip regular iterate.
  2336. ip += 5;
  2337. } else {
  2338. // Jump to end of loop.
  2339. int jumpto = _code_ptr[ip + 4];
  2340. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2341. ip = jumpto;
  2342. }
  2343. }
  2344. DISPATCH_OPCODE;
  2345. OPCODE(OPCODE_ITERATE_BEGIN_FLOAT) {
  2346. CHECK_SPACE(8); // Check space for iterate instruction too.
  2347. GET_VARIANT_PTR(counter, 0);
  2348. GET_VARIANT_PTR(container, 1);
  2349. double size = *VariantInternal::get_float(container);
  2350. VariantInternal::initialize(counter, Variant::FLOAT);
  2351. *VariantInternal::get_float(counter) = 0.0;
  2352. if (size > 0) {
  2353. GET_VARIANT_PTR(iterator, 2);
  2354. VariantInternal::initialize(iterator, Variant::FLOAT);
  2355. *VariantInternal::get_float(iterator) = 0;
  2356. // Skip regular iterate.
  2357. ip += 5;
  2358. } else {
  2359. // Jump to end of loop.
  2360. int jumpto = _code_ptr[ip + 4];
  2361. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2362. ip = jumpto;
  2363. }
  2364. }
  2365. DISPATCH_OPCODE;
  2366. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR2) {
  2367. CHECK_SPACE(8); // Check space for iterate instruction too.
  2368. GET_VARIANT_PTR(counter, 0);
  2369. GET_VARIANT_PTR(container, 1);
  2370. Vector2 *bounds = VariantInternal::get_vector2(container);
  2371. VariantInternal::initialize(counter, Variant::FLOAT);
  2372. *VariantInternal::get_float(counter) = bounds->x;
  2373. if (bounds->x < bounds->y) {
  2374. GET_VARIANT_PTR(iterator, 2);
  2375. VariantInternal::initialize(iterator, Variant::FLOAT);
  2376. *VariantInternal::get_float(iterator) = bounds->x;
  2377. // Skip regular iterate.
  2378. ip += 5;
  2379. } else {
  2380. // Jump to end of loop.
  2381. int jumpto = _code_ptr[ip + 4];
  2382. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2383. ip = jumpto;
  2384. }
  2385. }
  2386. DISPATCH_OPCODE;
  2387. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR2I) {
  2388. CHECK_SPACE(8); // Check space for iterate instruction too.
  2389. GET_VARIANT_PTR(counter, 0);
  2390. GET_VARIANT_PTR(container, 1);
  2391. Vector2i *bounds = VariantInternal::get_vector2i(container);
  2392. VariantInternal::initialize(counter, Variant::FLOAT);
  2393. *VariantInternal::get_int(counter) = bounds->x;
  2394. if (bounds->x < bounds->y) {
  2395. GET_VARIANT_PTR(iterator, 2);
  2396. VariantInternal::initialize(iterator, Variant::INT);
  2397. *VariantInternal::get_int(iterator) = bounds->x;
  2398. // Skip regular iterate.
  2399. ip += 5;
  2400. } else {
  2401. // Jump to end of loop.
  2402. int jumpto = _code_ptr[ip + 4];
  2403. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2404. ip = jumpto;
  2405. }
  2406. }
  2407. DISPATCH_OPCODE;
  2408. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR3) {
  2409. CHECK_SPACE(8); // Check space for iterate instruction too.
  2410. GET_VARIANT_PTR(counter, 0);
  2411. GET_VARIANT_PTR(container, 1);
  2412. Vector3 *bounds = VariantInternal::get_vector3(container);
  2413. double from = bounds->x;
  2414. double to = bounds->y;
  2415. double step = bounds->z;
  2416. VariantInternal::initialize(counter, Variant::FLOAT);
  2417. *VariantInternal::get_float(counter) = from;
  2418. bool do_continue = from == to ? false : (from < to ? step > 0 : step < 0);
  2419. if (do_continue) {
  2420. GET_VARIANT_PTR(iterator, 2);
  2421. VariantInternal::initialize(iterator, Variant::FLOAT);
  2422. *VariantInternal::get_float(iterator) = from;
  2423. // Skip regular iterate.
  2424. ip += 5;
  2425. } else {
  2426. // Jump to end of loop.
  2427. int jumpto = _code_ptr[ip + 4];
  2428. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2429. ip = jumpto;
  2430. }
  2431. }
  2432. DISPATCH_OPCODE;
  2433. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR3I) {
  2434. CHECK_SPACE(8); // Check space for iterate instruction too.
  2435. GET_VARIANT_PTR(counter, 0);
  2436. GET_VARIANT_PTR(container, 1);
  2437. Vector3i *bounds = VariantInternal::get_vector3i(container);
  2438. int64_t from = bounds->x;
  2439. int64_t to = bounds->y;
  2440. int64_t step = bounds->z;
  2441. VariantInternal::initialize(counter, Variant::INT);
  2442. *VariantInternal::get_int(counter) = from;
  2443. bool do_continue = from == to ? false : (from < to ? step > 0 : step < 0);
  2444. if (do_continue) {
  2445. GET_VARIANT_PTR(iterator, 2);
  2446. VariantInternal::initialize(iterator, Variant::INT);
  2447. *VariantInternal::get_int(iterator) = from;
  2448. // Skip regular iterate.
  2449. ip += 5;
  2450. } else {
  2451. // Jump to end of loop.
  2452. int jumpto = _code_ptr[ip + 4];
  2453. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2454. ip = jumpto;
  2455. }
  2456. }
  2457. DISPATCH_OPCODE;
  2458. OPCODE(OPCODE_ITERATE_BEGIN_STRING) {
  2459. CHECK_SPACE(8); // Check space for iterate instruction too.
  2460. GET_VARIANT_PTR(counter, 0);
  2461. GET_VARIANT_PTR(container, 1);
  2462. String *str = VariantInternal::get_string(container);
  2463. VariantInternal::initialize(counter, Variant::INT);
  2464. *VariantInternal::get_int(counter) = 0;
  2465. if (!str->is_empty()) {
  2466. GET_VARIANT_PTR(iterator, 2);
  2467. VariantInternal::initialize(iterator, Variant::STRING);
  2468. *VariantInternal::get_string(iterator) = str->substr(0, 1);
  2469. // Skip regular iterate.
  2470. ip += 5;
  2471. } else {
  2472. // Jump to end of loop.
  2473. int jumpto = _code_ptr[ip + 4];
  2474. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2475. ip = jumpto;
  2476. }
  2477. }
  2478. DISPATCH_OPCODE;
  2479. OPCODE(OPCODE_ITERATE_BEGIN_DICTIONARY) {
  2480. CHECK_SPACE(8); // Check space for iterate instruction too.
  2481. GET_VARIANT_PTR(counter, 0);
  2482. GET_VARIANT_PTR(container, 1);
  2483. Dictionary *dict = VariantInternal::get_dictionary(container);
  2484. const Variant *next = dict->next(nullptr);
  2485. if (!dict->is_empty()) {
  2486. GET_VARIANT_PTR(iterator, 2);
  2487. *counter = *next;
  2488. *iterator = *next;
  2489. // Skip regular iterate.
  2490. ip += 5;
  2491. } else {
  2492. // Jump to end of loop.
  2493. int jumpto = _code_ptr[ip + 4];
  2494. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2495. ip = jumpto;
  2496. }
  2497. }
  2498. DISPATCH_OPCODE;
  2499. OPCODE(OPCODE_ITERATE_BEGIN_ARRAY) {
  2500. CHECK_SPACE(8); // Check space for iterate instruction too.
  2501. GET_VARIANT_PTR(counter, 0);
  2502. GET_VARIANT_PTR(container, 1);
  2503. Array *array = VariantInternal::get_array(container);
  2504. VariantInternal::initialize(counter, Variant::INT);
  2505. *VariantInternal::get_int(counter) = 0;
  2506. if (!array->is_empty()) {
  2507. GET_VARIANT_PTR(iterator, 2);
  2508. *iterator = array->get(0);
  2509. // Skip regular iterate.
  2510. ip += 5;
  2511. } else {
  2512. // Jump to end of loop.
  2513. int jumpto = _code_ptr[ip + 4];
  2514. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2515. ip = jumpto;
  2516. }
  2517. }
  2518. DISPATCH_OPCODE;
  2519. #define OPCODE_ITERATE_BEGIN_PACKED_ARRAY(m_var_type, m_elem_type, m_get_func, m_var_ret_type, m_ret_type, m_ret_get_func) \
  2520. OPCODE(OPCODE_ITERATE_BEGIN_PACKED_##m_var_type##_ARRAY) { \
  2521. CHECK_SPACE(8); \
  2522. GET_VARIANT_PTR(counter, 0); \
  2523. GET_VARIANT_PTR(container, 1); \
  2524. Vector<m_elem_type> *array = VariantInternal::m_get_func(container); \
  2525. VariantInternal::initialize(counter, Variant::INT); \
  2526. *VariantInternal::get_int(counter) = 0; \
  2527. if (!array->is_empty()) { \
  2528. GET_VARIANT_PTR(iterator, 2); \
  2529. VariantInternal::initialize(iterator, Variant::m_var_ret_type); \
  2530. m_ret_type *it = VariantInternal::m_ret_get_func(iterator); \
  2531. *it = array->get(0); \
  2532. ip += 5; \
  2533. } else { \
  2534. int jumpto = _code_ptr[ip + 4]; \
  2535. GD_ERR_BREAK(jumpto<0 || jumpto> _code_size); \
  2536. ip = jumpto; \
  2537. } \
  2538. } \
  2539. DISPATCH_OPCODE
  2540. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(BYTE, uint8_t, get_byte_array, INT, int64_t, get_int);
  2541. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(INT32, int32_t, get_int32_array, INT, int64_t, get_int);
  2542. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(INT64, int64_t, get_int64_array, INT, int64_t, get_int);
  2543. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(FLOAT32, float, get_float32_array, FLOAT, double, get_float);
  2544. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(FLOAT64, double, get_float64_array, FLOAT, double, get_float);
  2545. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(STRING, String, get_string_array, STRING, String, get_string);
  2546. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(VECTOR2, Vector2, get_vector2_array, VECTOR2, Vector2, get_vector2);
  2547. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(VECTOR3, Vector3, get_vector3_array, VECTOR3, Vector3, get_vector3);
  2548. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(COLOR, Color, get_color_array, COLOR, Color, get_color);
  2549. OPCODE(OPCODE_ITERATE_BEGIN_OBJECT) {
  2550. CHECK_SPACE(4);
  2551. GET_VARIANT_PTR(counter, 0);
  2552. GET_VARIANT_PTR(container, 1);
  2553. #ifdef DEBUG_ENABLED
  2554. bool freed = false;
  2555. Object *obj = container->get_validated_object_with_check(freed);
  2556. if (freed) {
  2557. err_text = "Trying to iterate on a previously freed object.";
  2558. OPCODE_BREAK;
  2559. } else if (!obj) {
  2560. err_text = "Trying to iterate on a null value.";
  2561. OPCODE_BREAK;
  2562. }
  2563. #else
  2564. Object *obj = *VariantInternal::get_object(container);
  2565. #endif
  2566. *counter = Variant();
  2567. Array ref;
  2568. ref.push_back(*counter);
  2569. Variant vref;
  2570. VariantInternal::initialize(&vref, Variant::ARRAY);
  2571. *VariantInternal::get_array(&vref) = ref;
  2572. const Variant *args[] = { &vref };
  2573. Callable::CallError ce;
  2574. Variant has_next = obj->callp(CoreStringNames::get_singleton()->_iter_init, args, 1, ce);
  2575. #ifdef DEBUG_ENABLED
  2576. if (ref.size() != 1 || ce.error != Callable::CallError::CALL_OK) {
  2577. err_text = vformat(R"(There was an error calling "_iter_next" on iterator object of type %s.)", *container);
  2578. OPCODE_BREAK;
  2579. }
  2580. #endif
  2581. if (!has_next.booleanize()) {
  2582. int jumpto = _code_ptr[ip + 4];
  2583. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2584. ip = jumpto;
  2585. } else {
  2586. *counter = ref[0];
  2587. GET_VARIANT_PTR(iterator, 2);
  2588. *iterator = obj->callp(CoreStringNames::get_singleton()->_iter_get, (const Variant **)&counter, 1, ce);
  2589. #ifdef DEBUG_ENABLED
  2590. if (ce.error != Callable::CallError::CALL_OK) {
  2591. err_text = vformat(R"(There was an error calling "_iter_get" on iterator object of type %s.)", *container);
  2592. OPCODE_BREAK;
  2593. }
  2594. #endif
  2595. ip += 5; // Loop again.
  2596. }
  2597. }
  2598. DISPATCH_OPCODE;
  2599. OPCODE(OPCODE_ITERATE) {
  2600. CHECK_SPACE(4);
  2601. GET_VARIANT_PTR(counter, 0);
  2602. GET_VARIANT_PTR(container, 1);
  2603. bool valid;
  2604. if (!container->iter_next(*counter, valid)) {
  2605. #ifdef DEBUG_ENABLED
  2606. if (!valid) {
  2607. err_text = "Unable to iterate on object of type '" + Variant::get_type_name(container->get_type()) + "' (type changed since first iteration?).";
  2608. OPCODE_BREAK;
  2609. }
  2610. #endif
  2611. int jumpto = _code_ptr[ip + 4];
  2612. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2613. ip = jumpto;
  2614. } else {
  2615. GET_VARIANT_PTR(iterator, 2);
  2616. *iterator = container->iter_get(*counter, valid);
  2617. #ifdef DEBUG_ENABLED
  2618. if (!valid) {
  2619. err_text = "Unable to obtain iterator object of type '" + Variant::get_type_name(container->get_type()) + "' (but was obtained on first iteration?).";
  2620. OPCODE_BREAK;
  2621. }
  2622. #endif
  2623. ip += 5; //loop again
  2624. }
  2625. }
  2626. DISPATCH_OPCODE;
  2627. OPCODE(OPCODE_ITERATE_INT) {
  2628. CHECK_SPACE(4);
  2629. GET_VARIANT_PTR(counter, 0);
  2630. GET_VARIANT_PTR(container, 1);
  2631. int64_t size = *VariantInternal::get_int(container);
  2632. int64_t *count = VariantInternal::get_int(counter);
  2633. (*count)++;
  2634. if (*count >= size) {
  2635. int jumpto = _code_ptr[ip + 4];
  2636. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2637. ip = jumpto;
  2638. } else {
  2639. GET_VARIANT_PTR(iterator, 2);
  2640. *VariantInternal::get_int(iterator) = *count;
  2641. ip += 5; // Loop again.
  2642. }
  2643. }
  2644. DISPATCH_OPCODE;
  2645. OPCODE(OPCODE_ITERATE_FLOAT) {
  2646. CHECK_SPACE(4);
  2647. GET_VARIANT_PTR(counter, 0);
  2648. GET_VARIANT_PTR(container, 1);
  2649. double size = *VariantInternal::get_float(container);
  2650. double *count = VariantInternal::get_float(counter);
  2651. (*count)++;
  2652. if (*count >= size) {
  2653. int jumpto = _code_ptr[ip + 4];
  2654. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2655. ip = jumpto;
  2656. } else {
  2657. GET_VARIANT_PTR(iterator, 2);
  2658. *VariantInternal::get_float(iterator) = *count;
  2659. ip += 5; // Loop again.
  2660. }
  2661. }
  2662. DISPATCH_OPCODE;
  2663. OPCODE(OPCODE_ITERATE_VECTOR2) {
  2664. CHECK_SPACE(4);
  2665. GET_VARIANT_PTR(counter, 0);
  2666. GET_VARIANT_PTR(container, 1);
  2667. const Vector2 *bounds = VariantInternal::get_vector2((const Variant *)container);
  2668. double *count = VariantInternal::get_float(counter);
  2669. (*count)++;
  2670. if (*count >= bounds->y) {
  2671. int jumpto = _code_ptr[ip + 4];
  2672. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2673. ip = jumpto;
  2674. } else {
  2675. GET_VARIANT_PTR(iterator, 2);
  2676. *VariantInternal::get_float(iterator) = *count;
  2677. ip += 5; // Loop again.
  2678. }
  2679. }
  2680. DISPATCH_OPCODE;
  2681. OPCODE(OPCODE_ITERATE_VECTOR2I) {
  2682. CHECK_SPACE(4);
  2683. GET_VARIANT_PTR(counter, 0);
  2684. GET_VARIANT_PTR(container, 1);
  2685. const Vector2i *bounds = VariantInternal::get_vector2i((const Variant *)container);
  2686. int64_t *count = VariantInternal::get_int(counter);
  2687. (*count)++;
  2688. if (*count >= bounds->y) {
  2689. int jumpto = _code_ptr[ip + 4];
  2690. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2691. ip = jumpto;
  2692. } else {
  2693. GET_VARIANT_PTR(iterator, 2);
  2694. *VariantInternal::get_int(iterator) = *count;
  2695. ip += 5; // Loop again.
  2696. }
  2697. }
  2698. DISPATCH_OPCODE;
  2699. OPCODE(OPCODE_ITERATE_VECTOR3) {
  2700. CHECK_SPACE(4);
  2701. GET_VARIANT_PTR(counter, 0);
  2702. GET_VARIANT_PTR(container, 1);
  2703. const Vector3 *bounds = VariantInternal::get_vector3((const Variant *)container);
  2704. double *count = VariantInternal::get_float(counter);
  2705. *count += bounds->z;
  2706. if ((bounds->z < 0 && *count <= bounds->y) || (bounds->z > 0 && *count >= bounds->y)) {
  2707. int jumpto = _code_ptr[ip + 4];
  2708. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2709. ip = jumpto;
  2710. } else {
  2711. GET_VARIANT_PTR(iterator, 2);
  2712. *VariantInternal::get_float(iterator) = *count;
  2713. ip += 5; // Loop again.
  2714. }
  2715. }
  2716. DISPATCH_OPCODE;
  2717. OPCODE(OPCODE_ITERATE_VECTOR3I) {
  2718. CHECK_SPACE(4);
  2719. GET_VARIANT_PTR(counter, 0);
  2720. GET_VARIANT_PTR(container, 1);
  2721. const Vector3i *bounds = VariantInternal::get_vector3i((const Variant *)container);
  2722. int64_t *count = VariantInternal::get_int(counter);
  2723. *count += bounds->z;
  2724. if ((bounds->z < 0 && *count <= bounds->y) || (bounds->z > 0 && *count >= bounds->y)) {
  2725. int jumpto = _code_ptr[ip + 4];
  2726. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2727. ip = jumpto;
  2728. } else {
  2729. GET_VARIANT_PTR(iterator, 2);
  2730. *VariantInternal::get_int(iterator) = *count;
  2731. ip += 5; // Loop again.
  2732. }
  2733. }
  2734. DISPATCH_OPCODE;
  2735. OPCODE(OPCODE_ITERATE_STRING) {
  2736. CHECK_SPACE(4);
  2737. GET_VARIANT_PTR(counter, 0);
  2738. GET_VARIANT_PTR(container, 1);
  2739. const String *str = VariantInternal::get_string((const Variant *)container);
  2740. int64_t *idx = VariantInternal::get_int(counter);
  2741. (*idx)++;
  2742. if (*idx >= str->length()) {
  2743. int jumpto = _code_ptr[ip + 4];
  2744. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2745. ip = jumpto;
  2746. } else {
  2747. GET_VARIANT_PTR(iterator, 2);
  2748. *VariantInternal::get_string(iterator) = str->substr(*idx, 1);
  2749. ip += 5; // Loop again.
  2750. }
  2751. }
  2752. DISPATCH_OPCODE;
  2753. OPCODE(OPCODE_ITERATE_DICTIONARY) {
  2754. CHECK_SPACE(4);
  2755. GET_VARIANT_PTR(counter, 0);
  2756. GET_VARIANT_PTR(container, 1);
  2757. const Dictionary *dict = VariantInternal::get_dictionary((const Variant *)container);
  2758. const Variant *next = dict->next(counter);
  2759. if (!next) {
  2760. int jumpto = _code_ptr[ip + 4];
  2761. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2762. ip = jumpto;
  2763. } else {
  2764. GET_VARIANT_PTR(iterator, 2);
  2765. *counter = *next;
  2766. *iterator = *next;
  2767. ip += 5; // Loop again.
  2768. }
  2769. }
  2770. DISPATCH_OPCODE;
  2771. OPCODE(OPCODE_ITERATE_ARRAY) {
  2772. CHECK_SPACE(4);
  2773. GET_VARIANT_PTR(counter, 0);
  2774. GET_VARIANT_PTR(container, 1);
  2775. const Array *array = VariantInternal::get_array((const Variant *)container);
  2776. int64_t *idx = VariantInternal::get_int(counter);
  2777. (*idx)++;
  2778. if (*idx >= array->size()) {
  2779. int jumpto = _code_ptr[ip + 4];
  2780. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2781. ip = jumpto;
  2782. } else {
  2783. GET_VARIANT_PTR(iterator, 2);
  2784. *iterator = array->get(*idx);
  2785. ip += 5; // Loop again.
  2786. }
  2787. }
  2788. DISPATCH_OPCODE;
  2789. #define OPCODE_ITERATE_PACKED_ARRAY(m_var_type, m_elem_type, m_get_func, m_ret_get_func) \
  2790. OPCODE(OPCODE_ITERATE_PACKED_##m_var_type##_ARRAY) { \
  2791. CHECK_SPACE(4); \
  2792. GET_VARIANT_PTR(counter, 0); \
  2793. GET_VARIANT_PTR(container, 1); \
  2794. const Vector<m_elem_type> *array = VariantInternal::m_get_func((const Variant *)container); \
  2795. int64_t *idx = VariantInternal::get_int(counter); \
  2796. (*idx)++; \
  2797. if (*idx >= array->size()) { \
  2798. int jumpto = _code_ptr[ip + 4]; \
  2799. GD_ERR_BREAK(jumpto<0 || jumpto> _code_size); \
  2800. ip = jumpto; \
  2801. } else { \
  2802. GET_VARIANT_PTR(iterator, 2); \
  2803. *VariantInternal::m_ret_get_func(iterator) = array->get(*idx); \
  2804. ip += 5; \
  2805. } \
  2806. } \
  2807. DISPATCH_OPCODE
  2808. OPCODE_ITERATE_PACKED_ARRAY(BYTE, uint8_t, get_byte_array, get_int);
  2809. OPCODE_ITERATE_PACKED_ARRAY(INT32, int32_t, get_int32_array, get_int);
  2810. OPCODE_ITERATE_PACKED_ARRAY(INT64, int64_t, get_int64_array, get_int);
  2811. OPCODE_ITERATE_PACKED_ARRAY(FLOAT32, float, get_float32_array, get_float);
  2812. OPCODE_ITERATE_PACKED_ARRAY(FLOAT64, double, get_float64_array, get_float);
  2813. OPCODE_ITERATE_PACKED_ARRAY(STRING, String, get_string_array, get_string);
  2814. OPCODE_ITERATE_PACKED_ARRAY(VECTOR2, Vector2, get_vector2_array, get_vector2);
  2815. OPCODE_ITERATE_PACKED_ARRAY(VECTOR3, Vector3, get_vector3_array, get_vector3);
  2816. OPCODE_ITERATE_PACKED_ARRAY(COLOR, Color, get_color_array, get_color);
  2817. OPCODE(OPCODE_ITERATE_OBJECT) {
  2818. CHECK_SPACE(4);
  2819. GET_VARIANT_PTR(counter, 0);
  2820. GET_VARIANT_PTR(container, 1);
  2821. #ifdef DEBUG_ENABLED
  2822. bool freed = false;
  2823. Object *obj = container->get_validated_object_with_check(freed);
  2824. if (freed) {
  2825. err_text = "Trying to iterate on a previously freed object.";
  2826. OPCODE_BREAK;
  2827. } else if (!obj) {
  2828. err_text = "Trying to iterate on a null value.";
  2829. OPCODE_BREAK;
  2830. }
  2831. #else
  2832. Object *obj = *VariantInternal::get_object(container);
  2833. #endif
  2834. Array ref;
  2835. ref.push_back(*counter);
  2836. Variant vref;
  2837. VariantInternal::initialize(&vref, Variant::ARRAY);
  2838. *VariantInternal::get_array(&vref) = ref;
  2839. const Variant *args[] = { &vref };
  2840. Callable::CallError ce;
  2841. Variant has_next = obj->callp(CoreStringNames::get_singleton()->_iter_next, args, 1, ce);
  2842. #ifdef DEBUG_ENABLED
  2843. if (ref.size() != 1 || ce.error != Callable::CallError::CALL_OK) {
  2844. err_text = vformat(R"(There was an error calling "_iter_next" on iterator object of type %s.)", *container);
  2845. OPCODE_BREAK;
  2846. }
  2847. #endif
  2848. if (!has_next.booleanize()) {
  2849. int jumpto = _code_ptr[ip + 4];
  2850. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2851. ip = jumpto;
  2852. } else {
  2853. *counter = ref[0];
  2854. GET_VARIANT_PTR(iterator, 2);
  2855. *iterator = obj->callp(CoreStringNames::get_singleton()->_iter_get, (const Variant **)&counter, 1, ce);
  2856. #ifdef DEBUG_ENABLED
  2857. if (ce.error != Callable::CallError::CALL_OK) {
  2858. err_text = vformat(R"(There was an error calling "_iter_get" on iterator object of type %s.)", *container);
  2859. OPCODE_BREAK;
  2860. }
  2861. #endif
  2862. ip += 5; // Loop again.
  2863. }
  2864. }
  2865. DISPATCH_OPCODE;
  2866. OPCODE(OPCODE_STORE_GLOBAL) {
  2867. CHECK_SPACE(3);
  2868. int global_idx = _code_ptr[ip + 2];
  2869. GD_ERR_BREAK(global_idx < 0 || global_idx >= GDScriptLanguage::get_singleton()->get_global_array_size());
  2870. GET_VARIANT_PTR(dst, 0);
  2871. *dst = GDScriptLanguage::get_singleton()->get_global_array()[global_idx];
  2872. ip += 3;
  2873. }
  2874. DISPATCH_OPCODE;
  2875. OPCODE(OPCODE_STORE_NAMED_GLOBAL) {
  2876. CHECK_SPACE(3);
  2877. int globalname_idx = _code_ptr[ip + 2];
  2878. GD_ERR_BREAK(globalname_idx < 0 || globalname_idx >= _global_names_count);
  2879. const StringName *globalname = &_global_names_ptr[globalname_idx];
  2880. GD_ERR_BREAK(!GDScriptLanguage::get_singleton()->get_named_globals_map().has(*globalname));
  2881. GET_VARIANT_PTR(dst, 0);
  2882. *dst = GDScriptLanguage::get_singleton()->get_named_globals_map()[*globalname];
  2883. ip += 3;
  2884. }
  2885. DISPATCH_OPCODE;
  2886. #define OPCODE_TYPE_ADJUST(m_v_type, m_c_type) \
  2887. OPCODE(OPCODE_TYPE_ADJUST_##m_v_type) { \
  2888. CHECK_SPACE(2); \
  2889. GET_VARIANT_PTR(arg, 0); \
  2890. VariantTypeAdjust<m_c_type>::adjust(arg); \
  2891. ip += 2; \
  2892. } \
  2893. DISPATCH_OPCODE
  2894. OPCODE_TYPE_ADJUST(BOOL, bool);
  2895. OPCODE_TYPE_ADJUST(INT, int64_t);
  2896. OPCODE_TYPE_ADJUST(FLOAT, double);
  2897. OPCODE_TYPE_ADJUST(STRING, String);
  2898. OPCODE_TYPE_ADJUST(VECTOR2, Vector2);
  2899. OPCODE_TYPE_ADJUST(VECTOR2I, Vector2i);
  2900. OPCODE_TYPE_ADJUST(RECT2, Rect2);
  2901. OPCODE_TYPE_ADJUST(RECT2I, Rect2i);
  2902. OPCODE_TYPE_ADJUST(VECTOR3, Vector3);
  2903. OPCODE_TYPE_ADJUST(VECTOR3I, Vector3i);
  2904. OPCODE_TYPE_ADJUST(TRANSFORM2D, Transform2D);
  2905. OPCODE_TYPE_ADJUST(VECTOR4, Vector4);
  2906. OPCODE_TYPE_ADJUST(VECTOR4I, Vector4i);
  2907. OPCODE_TYPE_ADJUST(PLANE, Plane);
  2908. OPCODE_TYPE_ADJUST(QUATERNION, Quaternion);
  2909. OPCODE_TYPE_ADJUST(AABB, AABB);
  2910. OPCODE_TYPE_ADJUST(BASIS, Basis);
  2911. OPCODE_TYPE_ADJUST(TRANSFORM3D, Transform3D);
  2912. OPCODE_TYPE_ADJUST(PROJECTION, Projection);
  2913. OPCODE_TYPE_ADJUST(COLOR, Color);
  2914. OPCODE_TYPE_ADJUST(STRING_NAME, StringName);
  2915. OPCODE_TYPE_ADJUST(NODE_PATH, NodePath);
  2916. OPCODE_TYPE_ADJUST(RID, RID);
  2917. OPCODE_TYPE_ADJUST(OBJECT, Object *);
  2918. OPCODE_TYPE_ADJUST(CALLABLE, Callable);
  2919. OPCODE_TYPE_ADJUST(SIGNAL, Signal);
  2920. OPCODE_TYPE_ADJUST(DICTIONARY, Dictionary);
  2921. OPCODE_TYPE_ADJUST(ARRAY, Array);
  2922. OPCODE_TYPE_ADJUST(PACKED_BYTE_ARRAY, PackedByteArray);
  2923. OPCODE_TYPE_ADJUST(PACKED_INT32_ARRAY, PackedInt32Array);
  2924. OPCODE_TYPE_ADJUST(PACKED_INT64_ARRAY, PackedInt64Array);
  2925. OPCODE_TYPE_ADJUST(PACKED_FLOAT32_ARRAY, PackedFloat32Array);
  2926. OPCODE_TYPE_ADJUST(PACKED_FLOAT64_ARRAY, PackedFloat64Array);
  2927. OPCODE_TYPE_ADJUST(PACKED_STRING_ARRAY, PackedStringArray);
  2928. OPCODE_TYPE_ADJUST(PACKED_VECTOR2_ARRAY, PackedVector2Array);
  2929. OPCODE_TYPE_ADJUST(PACKED_VECTOR3_ARRAY, PackedVector3Array);
  2930. OPCODE_TYPE_ADJUST(PACKED_COLOR_ARRAY, PackedColorArray);
  2931. OPCODE(OPCODE_ASSERT) {
  2932. CHECK_SPACE(3);
  2933. #ifdef DEBUG_ENABLED
  2934. GET_VARIANT_PTR(test, 0);
  2935. bool result = test->booleanize();
  2936. if (!result) {
  2937. String message_str;
  2938. if (_code_ptr[ip + 2] != 0) {
  2939. GET_VARIANT_PTR(message, 1);
  2940. Variant message_var = *message;
  2941. if (message->get_type() != Variant::NIL) {
  2942. message_str = message_var;
  2943. }
  2944. }
  2945. if (message_str.is_empty()) {
  2946. err_text = "Assertion failed.";
  2947. } else {
  2948. err_text = "Assertion failed: " + message_str;
  2949. }
  2950. OPCODE_BREAK;
  2951. }
  2952. #endif
  2953. ip += 3;
  2954. }
  2955. DISPATCH_OPCODE;
  2956. OPCODE(OPCODE_BREAKPOINT) {
  2957. #ifdef DEBUG_ENABLED
  2958. if (EngineDebugger::is_active()) {
  2959. GDScriptLanguage::get_singleton()->debug_break("Breakpoint Statement", true);
  2960. }
  2961. #endif
  2962. ip += 1;
  2963. }
  2964. DISPATCH_OPCODE;
  2965. OPCODE(OPCODE_LINE) {
  2966. CHECK_SPACE(2);
  2967. line = _code_ptr[ip + 1];
  2968. ip += 2;
  2969. if (EngineDebugger::is_active()) {
  2970. // line
  2971. bool do_break = false;
  2972. if (unlikely(EngineDebugger::get_script_debugger()->get_lines_left() > 0)) {
  2973. if (EngineDebugger::get_script_debugger()->get_depth() <= 0) {
  2974. EngineDebugger::get_script_debugger()->set_lines_left(EngineDebugger::get_script_debugger()->get_lines_left() - 1);
  2975. }
  2976. if (EngineDebugger::get_script_debugger()->get_lines_left() <= 0) {
  2977. do_break = true;
  2978. }
  2979. }
  2980. if (EngineDebugger::get_script_debugger()->is_breakpoint(line, source)) {
  2981. do_break = true;
  2982. }
  2983. if (unlikely(do_break)) {
  2984. GDScriptLanguage::get_singleton()->debug_break("Breakpoint", true);
  2985. }
  2986. EngineDebugger::get_singleton()->line_poll();
  2987. }
  2988. }
  2989. DISPATCH_OPCODE;
  2990. OPCODE(OPCODE_END) {
  2991. #ifdef DEBUG_ENABLED
  2992. exit_ok = true;
  2993. #endif
  2994. OPCODE_BREAK;
  2995. }
  2996. #if 0 // Enable for debugging.
  2997. default: {
  2998. err_text = "Illegal opcode " + itos(_code_ptr[ip]) + " at address " + itos(ip);
  2999. OPCODE_BREAK;
  3000. }
  3001. #endif
  3002. }
  3003. OPCODES_END
  3004. #ifdef DEBUG_ENABLED
  3005. if (exit_ok) {
  3006. OPCODE_OUT;
  3007. }
  3008. //error
  3009. // function, file, line, error, explanation
  3010. String err_file;
  3011. bool instance_valid_with_script = p_instance && ObjectDB::get_instance(p_instance->owner_id) != nullptr && p_instance->script->is_valid();
  3012. if (instance_valid_with_script && !get_script()->path.is_empty()) {
  3013. err_file = get_script()->path;
  3014. } else if (script) {
  3015. err_file = script->path;
  3016. }
  3017. if (err_file.is_empty()) {
  3018. err_file = "<built-in>";
  3019. }
  3020. String err_func = name;
  3021. if (instance_valid_with_script && p_instance->script->local_name != StringName()) {
  3022. err_func = p_instance->script->local_name.operator String() + "." + err_func;
  3023. }
  3024. int err_line = line;
  3025. if (err_text.is_empty()) {
  3026. err_text = "Internal script error! Opcode: " + itos(last_opcode) + " (please report).";
  3027. }
  3028. if (!GDScriptLanguage::get_singleton()->debug_break(err_text, false)) {
  3029. // debugger break did not happen
  3030. _err_print_error(err_func.utf8().get_data(), err_file.utf8().get_data(), err_line, err_text.utf8().get_data(), false, ERR_HANDLER_SCRIPT);
  3031. }
  3032. // Get a default return type in case of failure
  3033. retvalue = _get_default_variant_for_data_type(return_type);
  3034. #endif
  3035. OPCODE_OUT;
  3036. }
  3037. OPCODES_OUT
  3038. #ifdef DEBUG_ENABLED
  3039. if (GDScriptLanguage::get_singleton()->profiling) {
  3040. uint64_t time_taken = OS::get_singleton()->get_ticks_usec() - function_start_time;
  3041. profile.total_time.add(time_taken);
  3042. profile.self_time.add(time_taken - function_call_time);
  3043. profile.frame_total_time.add(time_taken);
  3044. profile.frame_self_time.add(time_taken - function_call_time);
  3045. if (Thread::get_caller_id() == Thread::get_main_id()) {
  3046. GDScriptLanguage::get_singleton()->script_frame_time += time_taken - function_call_time;
  3047. }
  3048. }
  3049. // Check if this is not the last time it was interrupted by `await` or if it's the first time executing.
  3050. // If that is the case then we exit the function as normal. Otherwise we postpone it until the last `await` is completed.
  3051. // This ensures the call stack can be properly shown when using `await`, showing what resumed the function.
  3052. if (!p_state || awaited) {
  3053. if (EngineDebugger::is_active()) {
  3054. GDScriptLanguage::get_singleton()->exit_function();
  3055. }
  3056. #endif
  3057. // Free stack, except reserved addresses.
  3058. for (int i = FIXED_ADDRESSES_MAX; i < _stack_size; i++) {
  3059. stack[i].~Variant();
  3060. }
  3061. #ifdef DEBUG_ENABLED
  3062. }
  3063. #endif
  3064. // Always free reserved addresses, since they are never copied.
  3065. for (int i = 0; i < FIXED_ADDRESSES_MAX; i++) {
  3066. stack[i].~Variant();
  3067. }
  3068. call_depth--;
  3069. return retvalue;
  3070. }