gdscript_vm.cpp 119 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668
  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. Object *obj = dst->get_validated_object();
  794. String v = index->operator String();
  795. bool read_only_property = false;
  796. if (obj) {
  797. read_only_property = ClassDB::has_property(obj->get_class_name(), v) && (ClassDB::get_property_setter(obj->get_class_name(), v) == StringName());
  798. }
  799. if (read_only_property) {
  800. err_text = vformat(R"(Cannot set value into property "%s" (on base "%s") because it is read-only.)", v, _get_var_type(dst));
  801. } else {
  802. if (!v.is_empty()) {
  803. v = "'" + v + "'";
  804. } else {
  805. v = "of type '" + _get_var_type(index) + "'";
  806. }
  807. 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) + "'.";
  808. if (err_code == Variant::VariantSetError::SET_INDEXED_ERR) {
  809. err_text = "Invalid assignment of index " + v + " (on base: '" + _get_var_type(dst) + "') with value of type '" + _get_var_type(value) + "'.";
  810. }
  811. }
  812. OPCODE_BREAK;
  813. }
  814. #endif
  815. ip += 4;
  816. }
  817. DISPATCH_OPCODE;
  818. OPCODE(OPCODE_SET_KEYED_VALIDATED) {
  819. CHECK_SPACE(4);
  820. GET_VARIANT_PTR(dst, 0);
  821. GET_VARIANT_PTR(index, 1);
  822. GET_VARIANT_PTR(value, 2);
  823. int index_setter = _code_ptr[ip + 4];
  824. GD_ERR_BREAK(index_setter < 0 || index_setter >= _keyed_setters_count);
  825. const Variant::ValidatedKeyedSetter setter = _keyed_setters_ptr[index_setter];
  826. bool valid;
  827. setter(dst, index, value, &valid);
  828. #ifdef DEBUG_ENABLED
  829. if (!valid) {
  830. String v = index->operator String();
  831. if (!v.is_empty()) {
  832. v = "'" + v + "'";
  833. } else {
  834. v = "of type '" + _get_var_type(index) + "'";
  835. }
  836. 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) + "'.";
  837. OPCODE_BREAK;
  838. }
  839. #endif
  840. ip += 5;
  841. }
  842. DISPATCH_OPCODE;
  843. OPCODE(OPCODE_SET_INDEXED_VALIDATED) {
  844. CHECK_SPACE(4);
  845. GET_VARIANT_PTR(dst, 0);
  846. GET_VARIANT_PTR(index, 1);
  847. GET_VARIANT_PTR(value, 2);
  848. int index_setter = _code_ptr[ip + 4];
  849. GD_ERR_BREAK(index_setter < 0 || index_setter >= _indexed_setters_count);
  850. const Variant::ValidatedIndexedSetter setter = _indexed_setters_ptr[index_setter];
  851. int64_t int_index = *VariantInternal::get_int(index);
  852. bool oob;
  853. setter(dst, int_index, value, &oob);
  854. #ifdef DEBUG_ENABLED
  855. if (oob) {
  856. String v = index->operator String();
  857. if (!v.is_empty()) {
  858. v = "'" + v + "'";
  859. } else {
  860. v = "of type '" + _get_var_type(index) + "'";
  861. }
  862. err_text = "Out of bounds set index " + v + " (on base: '" + _get_var_type(dst) + "')";
  863. OPCODE_BREAK;
  864. }
  865. #endif
  866. ip += 5;
  867. }
  868. DISPATCH_OPCODE;
  869. OPCODE(OPCODE_GET_KEYED) {
  870. CHECK_SPACE(3);
  871. GET_VARIANT_PTR(src, 0);
  872. GET_VARIANT_PTR(index, 1);
  873. GET_VARIANT_PTR(dst, 2);
  874. bool valid;
  875. #ifdef DEBUG_ENABLED
  876. // Allow better error message in cases where src and dst are the same stack position.
  877. Variant::VariantGetError err_code;
  878. Variant ret = src->get(*index, &valid, &err_code);
  879. #else
  880. *dst = src->get(*index, &valid);
  881. #endif
  882. #ifdef DEBUG_ENABLED
  883. if (!valid) {
  884. String v = index->operator String();
  885. if (!v.is_empty()) {
  886. v = "'" + v + "'";
  887. } else {
  888. v = "of type '" + _get_var_type(index) + "'";
  889. }
  890. err_text = "Invalid access to property or key " + v + " on a base object of type '" + _get_var_type(src) + "'.";
  891. if (err_code == Variant::VariantGetError::GET_INDEXED_ERR) {
  892. err_text = "Invalid access of index " + v + " on a base object of type: '" + _get_var_type(src) + "'.";
  893. }
  894. OPCODE_BREAK;
  895. }
  896. *dst = ret;
  897. #endif
  898. ip += 4;
  899. }
  900. DISPATCH_OPCODE;
  901. OPCODE(OPCODE_GET_KEYED_VALIDATED) {
  902. CHECK_SPACE(4);
  903. GET_VARIANT_PTR(src, 0);
  904. GET_VARIANT_PTR(key, 1);
  905. GET_VARIANT_PTR(dst, 2);
  906. int index_getter = _code_ptr[ip + 4];
  907. GD_ERR_BREAK(index_getter < 0 || index_getter >= _keyed_getters_count);
  908. const Variant::ValidatedKeyedGetter getter = _keyed_getters_ptr[index_getter];
  909. bool valid;
  910. #ifdef DEBUG_ENABLED
  911. // Allow better error message in cases where src and dst are the same stack position.
  912. Variant ret;
  913. getter(src, key, &ret, &valid);
  914. #else
  915. getter(src, key, dst, &valid);
  916. #endif
  917. #ifdef DEBUG_ENABLED
  918. if (!valid) {
  919. String v = key->operator String();
  920. if (!v.is_empty()) {
  921. v = "'" + v + "'";
  922. } else {
  923. v = "of type '" + _get_var_type(key) + "'";
  924. }
  925. err_text = "Invalid access to property or key " + v + " on a base object of type '" + _get_var_type(src) + "'.";
  926. OPCODE_BREAK;
  927. }
  928. *dst = ret;
  929. #endif
  930. ip += 5;
  931. }
  932. DISPATCH_OPCODE;
  933. OPCODE(OPCODE_GET_INDEXED_VALIDATED) {
  934. CHECK_SPACE(4);
  935. GET_VARIANT_PTR(src, 0);
  936. GET_VARIANT_PTR(index, 1);
  937. GET_VARIANT_PTR(dst, 2);
  938. int index_getter = _code_ptr[ip + 4];
  939. GD_ERR_BREAK(index_getter < 0 || index_getter >= _indexed_getters_count);
  940. const Variant::ValidatedIndexedGetter getter = _indexed_getters_ptr[index_getter];
  941. int64_t int_index = *VariantInternal::get_int(index);
  942. bool oob;
  943. getter(src, int_index, dst, &oob);
  944. #ifdef DEBUG_ENABLED
  945. if (oob) {
  946. String v = index->operator String();
  947. if (!v.is_empty()) {
  948. v = "'" + v + "'";
  949. } else {
  950. v = "of type '" + _get_var_type(index) + "'";
  951. }
  952. err_text = "Out of bounds get index " + v + " (on base: '" + _get_var_type(src) + "')";
  953. OPCODE_BREAK;
  954. }
  955. #endif
  956. ip += 5;
  957. }
  958. DISPATCH_OPCODE;
  959. OPCODE(OPCODE_SET_NAMED) {
  960. CHECK_SPACE(3);
  961. GET_VARIANT_PTR(dst, 0);
  962. GET_VARIANT_PTR(value, 1);
  963. int indexname = _code_ptr[ip + 3];
  964. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  965. const StringName *index = &_global_names_ptr[indexname];
  966. bool valid;
  967. dst->set_named(*index, *value, valid);
  968. #ifdef DEBUG_ENABLED
  969. if (!valid) {
  970. Object *obj = dst->get_validated_object();
  971. bool read_only_property = false;
  972. if (obj) {
  973. read_only_property = ClassDB::has_property(obj->get_class_name(), *index) && (ClassDB::get_property_setter(obj->get_class_name(), *index) == StringName());
  974. }
  975. if (read_only_property) {
  976. err_text = vformat(R"(Cannot set value into property "%s" (on base "%s") because it is read-only.)", String(*index), _get_var_type(dst));
  977. } else {
  978. 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) + "'.";
  979. }
  980. OPCODE_BREAK;
  981. }
  982. #endif
  983. ip += 4;
  984. }
  985. DISPATCH_OPCODE;
  986. OPCODE(OPCODE_SET_NAMED_VALIDATED) {
  987. CHECK_SPACE(3);
  988. GET_VARIANT_PTR(dst, 0);
  989. GET_VARIANT_PTR(value, 1);
  990. int index_setter = _code_ptr[ip + 3];
  991. GD_ERR_BREAK(index_setter < 0 || index_setter >= _setters_count);
  992. const Variant::ValidatedSetter setter = _setters_ptr[index_setter];
  993. setter(dst, value);
  994. ip += 4;
  995. }
  996. DISPATCH_OPCODE;
  997. OPCODE(OPCODE_GET_NAMED) {
  998. CHECK_SPACE(4);
  999. GET_VARIANT_PTR(src, 0);
  1000. GET_VARIANT_PTR(dst, 1);
  1001. int indexname = _code_ptr[ip + 3];
  1002. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  1003. const StringName *index = &_global_names_ptr[indexname];
  1004. bool valid;
  1005. #ifdef DEBUG_ENABLED
  1006. //allow better error message in cases where src and dst are the same stack position
  1007. Variant ret = src->get_named(*index, valid);
  1008. #else
  1009. *dst = src->get_named(*index, valid);
  1010. #endif
  1011. #ifdef DEBUG_ENABLED
  1012. if (!valid) {
  1013. err_text = "Invalid access to property or key '" + index->operator String() + "' on a base object of type '" + _get_var_type(src) + "'.";
  1014. OPCODE_BREAK;
  1015. }
  1016. *dst = ret;
  1017. #endif
  1018. ip += 4;
  1019. }
  1020. DISPATCH_OPCODE;
  1021. OPCODE(OPCODE_GET_NAMED_VALIDATED) {
  1022. CHECK_SPACE(3);
  1023. GET_VARIANT_PTR(src, 0);
  1024. GET_VARIANT_PTR(dst, 1);
  1025. int index_getter = _code_ptr[ip + 3];
  1026. GD_ERR_BREAK(index_getter < 0 || index_getter >= _getters_count);
  1027. const Variant::ValidatedGetter getter = _getters_ptr[index_getter];
  1028. getter(src, dst);
  1029. ip += 4;
  1030. }
  1031. DISPATCH_OPCODE;
  1032. OPCODE(OPCODE_SET_MEMBER) {
  1033. CHECK_SPACE(3);
  1034. GET_VARIANT_PTR(src, 0);
  1035. int indexname = _code_ptr[ip + 2];
  1036. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  1037. const StringName *index = &_global_names_ptr[indexname];
  1038. bool valid;
  1039. #ifndef DEBUG_ENABLED
  1040. ClassDB::set_property(p_instance->owner, *index, *src, &valid);
  1041. #else
  1042. bool ok = ClassDB::set_property(p_instance->owner, *index, *src, &valid);
  1043. if (!ok) {
  1044. err_text = "Internal error setting property: " + String(*index);
  1045. OPCODE_BREAK;
  1046. } else if (!valid) {
  1047. err_text = "Error setting property '" + String(*index) + "' with value of type " + Variant::get_type_name(src->get_type()) + ".";
  1048. OPCODE_BREAK;
  1049. }
  1050. #endif
  1051. ip += 3;
  1052. }
  1053. DISPATCH_OPCODE;
  1054. OPCODE(OPCODE_GET_MEMBER) {
  1055. CHECK_SPACE(3);
  1056. GET_VARIANT_PTR(dst, 0);
  1057. int indexname = _code_ptr[ip + 2];
  1058. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  1059. const StringName *index = &_global_names_ptr[indexname];
  1060. #ifndef DEBUG_ENABLED
  1061. ClassDB::get_property(p_instance->owner, *index, *dst);
  1062. #else
  1063. bool ok = ClassDB::get_property(p_instance->owner, *index, *dst);
  1064. if (!ok) {
  1065. err_text = "Internal error getting property: " + String(*index);
  1066. OPCODE_BREAK;
  1067. }
  1068. #endif
  1069. ip += 3;
  1070. }
  1071. DISPATCH_OPCODE;
  1072. OPCODE(OPCODE_SET_STATIC_VARIABLE) {
  1073. CHECK_SPACE(4);
  1074. GET_VARIANT_PTR(value, 0);
  1075. GET_VARIANT_PTR(_class, 1);
  1076. GDScript *gdscript = Object::cast_to<GDScript>(_class->operator Object *());
  1077. GD_ERR_BREAK(!gdscript);
  1078. int index = _code_ptr[ip + 3];
  1079. GD_ERR_BREAK(index < 0 || index >= gdscript->static_variables.size());
  1080. gdscript->static_variables.write[index] = *value;
  1081. ip += 4;
  1082. }
  1083. DISPATCH_OPCODE;
  1084. OPCODE(OPCODE_GET_STATIC_VARIABLE) {
  1085. CHECK_SPACE(4);
  1086. GET_VARIANT_PTR(target, 0);
  1087. GET_VARIANT_PTR(_class, 1);
  1088. GDScript *gdscript = Object::cast_to<GDScript>(_class->operator Object *());
  1089. GD_ERR_BREAK(!gdscript);
  1090. int index = _code_ptr[ip + 3];
  1091. GD_ERR_BREAK(index < 0 || index >= gdscript->static_variables.size());
  1092. *target = gdscript->static_variables[index];
  1093. ip += 4;
  1094. }
  1095. DISPATCH_OPCODE;
  1096. OPCODE(OPCODE_ASSIGN) {
  1097. CHECK_SPACE(3);
  1098. GET_VARIANT_PTR(dst, 0);
  1099. GET_VARIANT_PTR(src, 1);
  1100. *dst = *src;
  1101. ip += 3;
  1102. }
  1103. DISPATCH_OPCODE;
  1104. OPCODE(OPCODE_ASSIGN_NULL) {
  1105. CHECK_SPACE(2);
  1106. GET_VARIANT_PTR(dst, 0);
  1107. *dst = Variant();
  1108. ip += 2;
  1109. }
  1110. DISPATCH_OPCODE;
  1111. OPCODE(OPCODE_ASSIGN_TRUE) {
  1112. CHECK_SPACE(2);
  1113. GET_VARIANT_PTR(dst, 0);
  1114. *dst = true;
  1115. ip += 2;
  1116. }
  1117. DISPATCH_OPCODE;
  1118. OPCODE(OPCODE_ASSIGN_FALSE) {
  1119. CHECK_SPACE(2);
  1120. GET_VARIANT_PTR(dst, 0);
  1121. *dst = false;
  1122. ip += 2;
  1123. }
  1124. DISPATCH_OPCODE;
  1125. OPCODE(OPCODE_ASSIGN_TYPED_BUILTIN) {
  1126. CHECK_SPACE(4);
  1127. GET_VARIANT_PTR(dst, 0);
  1128. GET_VARIANT_PTR(src, 1);
  1129. Variant::Type var_type = (Variant::Type)_code_ptr[ip + 3];
  1130. GD_ERR_BREAK(var_type < 0 || var_type >= Variant::VARIANT_MAX);
  1131. if (src->get_type() != var_type) {
  1132. #ifdef DEBUG_ENABLED
  1133. if (Variant::can_convert_strict(src->get_type(), var_type)) {
  1134. #endif // DEBUG_ENABLED
  1135. Callable::CallError ce;
  1136. Variant::construct(var_type, *dst, const_cast<const Variant **>(&src), 1, ce);
  1137. } else {
  1138. #ifdef DEBUG_ENABLED
  1139. err_text = "Trying to assign value of type '" + Variant::get_type_name(src->get_type()) +
  1140. "' to a variable of type '" + Variant::get_type_name(var_type) + "'.";
  1141. OPCODE_BREAK;
  1142. }
  1143. } else {
  1144. #endif // DEBUG_ENABLED
  1145. *dst = *src;
  1146. }
  1147. ip += 4;
  1148. }
  1149. DISPATCH_OPCODE;
  1150. OPCODE(OPCODE_ASSIGN_TYPED_ARRAY) {
  1151. CHECK_SPACE(6);
  1152. GET_VARIANT_PTR(dst, 0);
  1153. GET_VARIANT_PTR(src, 1);
  1154. GET_VARIANT_PTR(script_type, 2);
  1155. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 4];
  1156. int native_type_idx = _code_ptr[ip + 5];
  1157. GD_ERR_BREAK(native_type_idx < 0 || native_type_idx >= _global_names_count);
  1158. const StringName native_type = _global_names_ptr[native_type_idx];
  1159. if (src->get_type() != Variant::ARRAY) {
  1160. #ifdef DEBUG_ENABLED
  1161. err_text = vformat(R"(Trying to assign a value of type "%s" to a variable of type "Array[%s]".)",
  1162. _get_var_type(src), _get_element_type(builtin_type, native_type, *script_type));
  1163. #endif // DEBUG_ENABLED
  1164. OPCODE_BREAK;
  1165. }
  1166. Array *array = VariantInternal::get_array(src);
  1167. if (array->get_typed_builtin() != ((uint32_t)builtin_type) || array->get_typed_class_name() != native_type || array->get_typed_script() != *script_type) {
  1168. #ifdef DEBUG_ENABLED
  1169. err_text = vformat(R"(Trying to assign an array of type "%s" to a variable of type "Array[%s]".)",
  1170. _get_var_type(src), _get_element_type(builtin_type, native_type, *script_type));
  1171. #endif // DEBUG_ENABLED
  1172. OPCODE_BREAK;
  1173. }
  1174. *dst = *src;
  1175. ip += 6;
  1176. }
  1177. DISPATCH_OPCODE;
  1178. OPCODE(OPCODE_ASSIGN_TYPED_NATIVE) {
  1179. CHECK_SPACE(4);
  1180. GET_VARIANT_PTR(dst, 0);
  1181. GET_VARIANT_PTR(src, 1);
  1182. #ifdef DEBUG_ENABLED
  1183. GET_VARIANT_PTR(type, 2);
  1184. GDScriptNativeClass *nc = Object::cast_to<GDScriptNativeClass>(type->operator Object *());
  1185. GD_ERR_BREAK(!nc);
  1186. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  1187. err_text = "Trying to assign value of type '" + Variant::get_type_name(src->get_type()) +
  1188. "' to a variable of type '" + nc->get_name() + "'.";
  1189. OPCODE_BREAK;
  1190. }
  1191. if (src->get_type() == Variant::OBJECT) {
  1192. bool was_freed = false;
  1193. Object *src_obj = src->get_validated_object_with_check(was_freed);
  1194. if (!src_obj && was_freed) {
  1195. err_text = "Trying to assign invalid previously freed instance.";
  1196. OPCODE_BREAK;
  1197. }
  1198. if (src_obj && !ClassDB::is_parent_class(src_obj->get_class_name(), nc->get_name())) {
  1199. err_text = "Trying to assign value of type '" + src_obj->get_class_name() +
  1200. "' to a variable of type '" + nc->get_name() + "'.";
  1201. OPCODE_BREAK;
  1202. }
  1203. }
  1204. #endif // DEBUG_ENABLED
  1205. *dst = *src;
  1206. ip += 4;
  1207. }
  1208. DISPATCH_OPCODE;
  1209. OPCODE(OPCODE_ASSIGN_TYPED_SCRIPT) {
  1210. CHECK_SPACE(4);
  1211. GET_VARIANT_PTR(dst, 0);
  1212. GET_VARIANT_PTR(src, 1);
  1213. #ifdef DEBUG_ENABLED
  1214. GET_VARIANT_PTR(type, 2);
  1215. Script *base_type = Object::cast_to<Script>(type->operator Object *());
  1216. GD_ERR_BREAK(!base_type);
  1217. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  1218. err_text = "Trying to assign a non-object value to a variable of type '" + base_type->get_path().get_file() + "'.";
  1219. OPCODE_BREAK;
  1220. }
  1221. if (src->get_type() == Variant::OBJECT) {
  1222. bool was_freed = false;
  1223. Object *val_obj = src->get_validated_object_with_check(was_freed);
  1224. if (!val_obj && was_freed) {
  1225. err_text = "Trying to assign invalid previously freed instance.";
  1226. OPCODE_BREAK;
  1227. }
  1228. if (val_obj) { // src is not null
  1229. ScriptInstance *scr_inst = val_obj->get_script_instance();
  1230. if (!scr_inst) {
  1231. err_text = "Trying to assign value of type '" + val_obj->get_class_name() +
  1232. "' to a variable of type '" + base_type->get_path().get_file() + "'.";
  1233. OPCODE_BREAK;
  1234. }
  1235. Script *src_type = scr_inst->get_script().ptr();
  1236. bool valid = false;
  1237. while (src_type) {
  1238. if (src_type == base_type) {
  1239. valid = true;
  1240. break;
  1241. }
  1242. src_type = src_type->get_base_script().ptr();
  1243. }
  1244. if (!valid) {
  1245. err_text = "Trying to assign value of type '" + val_obj->get_script_instance()->get_script()->get_path().get_file() +
  1246. "' to a variable of type '" + base_type->get_path().get_file() + "'.";
  1247. OPCODE_BREAK;
  1248. }
  1249. }
  1250. }
  1251. #endif // DEBUG_ENABLED
  1252. *dst = *src;
  1253. ip += 4;
  1254. }
  1255. DISPATCH_OPCODE;
  1256. OPCODE(OPCODE_CAST_TO_BUILTIN) {
  1257. CHECK_SPACE(4);
  1258. GET_VARIANT_PTR(src, 0);
  1259. GET_VARIANT_PTR(dst, 1);
  1260. Variant::Type to_type = (Variant::Type)_code_ptr[ip + 3];
  1261. GD_ERR_BREAK(to_type < 0 || to_type >= Variant::VARIANT_MAX);
  1262. #ifdef DEBUG_ENABLED
  1263. if (src->operator Object *() && !src->get_validated_object()) {
  1264. err_text = "Trying to cast a freed object.";
  1265. OPCODE_BREAK;
  1266. }
  1267. #endif
  1268. Callable::CallError err;
  1269. Variant::construct(to_type, *dst, (const Variant **)&src, 1, err);
  1270. #ifdef DEBUG_ENABLED
  1271. if (err.error != Callable::CallError::CALL_OK) {
  1272. err_text = "Invalid cast: could not convert value to '" + Variant::get_type_name(to_type) + "'.";
  1273. OPCODE_BREAK;
  1274. }
  1275. #endif
  1276. ip += 4;
  1277. }
  1278. DISPATCH_OPCODE;
  1279. OPCODE(OPCODE_CAST_TO_NATIVE) {
  1280. CHECK_SPACE(4);
  1281. GET_VARIANT_PTR(src, 0);
  1282. GET_VARIANT_PTR(dst, 1);
  1283. GET_VARIANT_PTR(to_type, 2);
  1284. GDScriptNativeClass *nc = Object::cast_to<GDScriptNativeClass>(to_type->operator Object *());
  1285. GD_ERR_BREAK(!nc);
  1286. #ifdef DEBUG_ENABLED
  1287. if (src->operator Object *() && !src->get_validated_object()) {
  1288. err_text = "Trying to cast a freed object.";
  1289. OPCODE_BREAK;
  1290. }
  1291. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  1292. err_text = "Invalid cast: can't convert a non-object value to an object type.";
  1293. OPCODE_BREAK;
  1294. }
  1295. #endif
  1296. Object *src_obj = src->operator Object *();
  1297. if (src_obj && !ClassDB::is_parent_class(src_obj->get_class_name(), nc->get_name())) {
  1298. *dst = Variant(); // invalid cast, assign NULL
  1299. } else {
  1300. *dst = *src;
  1301. }
  1302. ip += 4;
  1303. }
  1304. DISPATCH_OPCODE;
  1305. OPCODE(OPCODE_CAST_TO_SCRIPT) {
  1306. CHECK_SPACE(4);
  1307. GET_VARIANT_PTR(src, 0);
  1308. GET_VARIANT_PTR(dst, 1);
  1309. GET_VARIANT_PTR(to_type, 2);
  1310. Script *base_type = Object::cast_to<Script>(to_type->operator Object *());
  1311. GD_ERR_BREAK(!base_type);
  1312. #ifdef DEBUG_ENABLED
  1313. if (src->operator Object *() && !src->get_validated_object()) {
  1314. err_text = "Trying to cast a freed object.";
  1315. OPCODE_BREAK;
  1316. }
  1317. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  1318. err_text = "Trying to assign a non-object value to a variable of type '" + base_type->get_path().get_file() + "'.";
  1319. OPCODE_BREAK;
  1320. }
  1321. #endif
  1322. bool valid = false;
  1323. if (src->get_type() != Variant::NIL && src->operator Object *() != nullptr) {
  1324. ScriptInstance *scr_inst = src->operator Object *()->get_script_instance();
  1325. if (scr_inst) {
  1326. Script *src_type = src->operator Object *()->get_script_instance()->get_script().ptr();
  1327. while (src_type) {
  1328. if (src_type == base_type) {
  1329. valid = true;
  1330. break;
  1331. }
  1332. src_type = src_type->get_base_script().ptr();
  1333. }
  1334. }
  1335. }
  1336. if (valid) {
  1337. *dst = *src; // Valid cast, copy the source object
  1338. } else {
  1339. *dst = Variant(); // invalid cast, assign NULL
  1340. }
  1341. ip += 4;
  1342. }
  1343. DISPATCH_OPCODE;
  1344. OPCODE(OPCODE_CONSTRUCT) {
  1345. LOAD_INSTRUCTION_ARGS
  1346. CHECK_SPACE(2 + instr_arg_count);
  1347. ip += instr_arg_count;
  1348. int argc = _code_ptr[ip + 1];
  1349. Variant::Type t = Variant::Type(_code_ptr[ip + 2]);
  1350. Variant **argptrs = instruction_args;
  1351. GET_INSTRUCTION_ARG(dst, argc);
  1352. Callable::CallError err;
  1353. Variant::construct(t, *dst, (const Variant **)argptrs, argc, err);
  1354. #ifdef DEBUG_ENABLED
  1355. if (err.error != Callable::CallError::CALL_OK) {
  1356. err_text = _get_call_error(err, "'" + Variant::get_type_name(t) + "' constructor", (const Variant **)argptrs);
  1357. OPCODE_BREAK;
  1358. }
  1359. #endif
  1360. ip += 3;
  1361. }
  1362. DISPATCH_OPCODE;
  1363. OPCODE(OPCODE_CONSTRUCT_VALIDATED) {
  1364. LOAD_INSTRUCTION_ARGS
  1365. CHECK_SPACE(2 + instr_arg_count);
  1366. ip += instr_arg_count;
  1367. int argc = _code_ptr[ip + 1];
  1368. int constructor_idx = _code_ptr[ip + 2];
  1369. GD_ERR_BREAK(constructor_idx < 0 || constructor_idx >= _constructors_count);
  1370. Variant::ValidatedConstructor constructor = _constructors_ptr[constructor_idx];
  1371. Variant **argptrs = instruction_args;
  1372. GET_INSTRUCTION_ARG(dst, argc);
  1373. constructor(dst, (const Variant **)argptrs);
  1374. ip += 3;
  1375. }
  1376. DISPATCH_OPCODE;
  1377. OPCODE(OPCODE_CONSTRUCT_ARRAY) {
  1378. LOAD_INSTRUCTION_ARGS
  1379. CHECK_SPACE(1 + instr_arg_count);
  1380. ip += instr_arg_count;
  1381. int argc = _code_ptr[ip + 1];
  1382. Array array;
  1383. array.resize(argc);
  1384. for (int i = 0; i < argc; i++) {
  1385. array[i] = *(instruction_args[i]);
  1386. }
  1387. GET_INSTRUCTION_ARG(dst, argc);
  1388. *dst = Variant(); // Clear potential previous typed array.
  1389. *dst = array;
  1390. ip += 2;
  1391. }
  1392. DISPATCH_OPCODE;
  1393. OPCODE(OPCODE_CONSTRUCT_TYPED_ARRAY) {
  1394. LOAD_INSTRUCTION_ARGS
  1395. CHECK_SPACE(3 + instr_arg_count);
  1396. ip += instr_arg_count;
  1397. int argc = _code_ptr[ip + 1];
  1398. GET_INSTRUCTION_ARG(script_type, argc + 1);
  1399. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 2];
  1400. int native_type_idx = _code_ptr[ip + 3];
  1401. GD_ERR_BREAK(native_type_idx < 0 || native_type_idx >= _global_names_count);
  1402. const StringName native_type = _global_names_ptr[native_type_idx];
  1403. Array array;
  1404. array.resize(argc);
  1405. for (int i = 0; i < argc; i++) {
  1406. array[i] = *(instruction_args[i]);
  1407. }
  1408. GET_INSTRUCTION_ARG(dst, argc);
  1409. *dst = Variant(); // Clear potential previous typed array.
  1410. *dst = Array(array, builtin_type, native_type, *script_type);
  1411. ip += 4;
  1412. }
  1413. DISPATCH_OPCODE;
  1414. OPCODE(OPCODE_CONSTRUCT_DICTIONARY) {
  1415. LOAD_INSTRUCTION_ARGS
  1416. CHECK_SPACE(2 + instr_arg_count);
  1417. ip += instr_arg_count;
  1418. int argc = _code_ptr[ip + 1];
  1419. Dictionary dict;
  1420. for (int i = 0; i < argc; i++) {
  1421. GET_INSTRUCTION_ARG(k, i * 2 + 0);
  1422. GET_INSTRUCTION_ARG(v, i * 2 + 1);
  1423. dict[*k] = *v;
  1424. }
  1425. GET_INSTRUCTION_ARG(dst, argc * 2);
  1426. *dst = dict;
  1427. ip += 2;
  1428. }
  1429. DISPATCH_OPCODE;
  1430. OPCODE(OPCODE_CALL_ASYNC)
  1431. OPCODE(OPCODE_CALL_RETURN)
  1432. OPCODE(OPCODE_CALL) {
  1433. bool call_ret = (_code_ptr[ip]) != OPCODE_CALL;
  1434. #ifdef DEBUG_ENABLED
  1435. bool call_async = (_code_ptr[ip]) == OPCODE_CALL_ASYNC;
  1436. #endif
  1437. LOAD_INSTRUCTION_ARGS
  1438. CHECK_SPACE(3 + instr_arg_count);
  1439. ip += instr_arg_count;
  1440. int argc = _code_ptr[ip + 1];
  1441. GD_ERR_BREAK(argc < 0);
  1442. int methodname_idx = _code_ptr[ip + 2];
  1443. GD_ERR_BREAK(methodname_idx < 0 || methodname_idx >= _global_names_count);
  1444. const StringName *methodname = &_global_names_ptr[methodname_idx];
  1445. GET_INSTRUCTION_ARG(base, argc);
  1446. Variant **argptrs = instruction_args;
  1447. #ifdef DEBUG_ENABLED
  1448. uint64_t call_time = 0;
  1449. if (GDScriptLanguage::get_singleton()->profiling) {
  1450. call_time = OS::get_singleton()->get_ticks_usec();
  1451. }
  1452. Variant::Type base_type = base->get_type();
  1453. Object *base_obj = base->get_validated_object();
  1454. StringName base_class = base_obj ? base_obj->get_class_name() : StringName();
  1455. #endif
  1456. Callable::CallError err;
  1457. if (call_ret) {
  1458. GET_INSTRUCTION_ARG(ret, argc + 1);
  1459. base->callp(*methodname, (const Variant **)argptrs, argc, *ret, err);
  1460. #ifdef DEBUG_ENABLED
  1461. if (ret->get_type() == Variant::NIL) {
  1462. if (base_type == Variant::OBJECT) {
  1463. if (base_obj) {
  1464. MethodBind *method = ClassDB::get_method(base_class, *methodname);
  1465. if (*methodname == CoreStringNames::get_singleton()->_free || (method && !method->has_return())) {
  1466. err_text = R"(Trying to get a return value of a method that returns "void")";
  1467. OPCODE_BREAK;
  1468. }
  1469. }
  1470. } else if (Variant::has_builtin_method(base_type, *methodname) && !Variant::has_builtin_method_return_value(base_type, *methodname)) {
  1471. err_text = R"(Trying to get a return value of a method that returns "void")";
  1472. OPCODE_BREAK;
  1473. }
  1474. }
  1475. if (!call_async && ret->get_type() == Variant::OBJECT) {
  1476. // Check if getting a function state without await.
  1477. bool was_freed = false;
  1478. Object *obj = ret->get_validated_object_with_check(was_freed);
  1479. if (obj && obj->is_class_ptr(GDScriptFunctionState::get_class_ptr_static())) {
  1480. err_text = R"(Trying to call an async function without "await".)";
  1481. OPCODE_BREAK;
  1482. }
  1483. }
  1484. #endif
  1485. } else {
  1486. Variant ret;
  1487. base->callp(*methodname, (const Variant **)argptrs, argc, ret, err);
  1488. }
  1489. #ifdef DEBUG_ENABLED
  1490. if (GDScriptLanguage::get_singleton()->profiling) {
  1491. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1492. if (GDScriptLanguage::get_singleton()->profile_native_calls && _profile_count_as_native(base_obj, *methodname)) {
  1493. _profile_native_call(t_taken, *methodname, base_class);
  1494. }
  1495. function_call_time += t_taken;
  1496. }
  1497. if (err.error != Callable::CallError::CALL_OK) {
  1498. String methodstr = *methodname;
  1499. String basestr = _get_var_type(base);
  1500. bool is_callable = false;
  1501. if (methodstr == "call") {
  1502. if (argc >= 1 && base->get_type() != Variant::CALLABLE) {
  1503. methodstr = String(*argptrs[0]) + " (via call)";
  1504. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  1505. err.argument += 1;
  1506. }
  1507. } else {
  1508. methodstr = base->operator String() + " (Callable)";
  1509. is_callable = true;
  1510. }
  1511. } else if (methodstr == "free") {
  1512. if (err.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  1513. if (base->is_ref_counted()) {
  1514. err_text = "Attempted to free a reference.";
  1515. OPCODE_BREAK;
  1516. } else if (base->get_type() == Variant::OBJECT) {
  1517. err_text = "Attempted to free a locked object (calling or emitting).";
  1518. OPCODE_BREAK;
  1519. }
  1520. }
  1521. } else if (methodstr == "call_recursive" && basestr == "TreeItem") {
  1522. if (argc >= 1) {
  1523. methodstr = String(*argptrs[0]) + " (via TreeItem.call_recursive)";
  1524. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  1525. err.argument += 1;
  1526. }
  1527. }
  1528. }
  1529. err_text = _get_call_error(err, "function '" + methodstr + (is_callable ? "" : "' in base '" + basestr) + "'", (const Variant **)argptrs);
  1530. OPCODE_BREAK;
  1531. }
  1532. #endif
  1533. ip += 3;
  1534. }
  1535. DISPATCH_OPCODE;
  1536. OPCODE(OPCODE_CALL_METHOD_BIND)
  1537. OPCODE(OPCODE_CALL_METHOD_BIND_RET) {
  1538. bool call_ret = (_code_ptr[ip]) == OPCODE_CALL_METHOD_BIND_RET;
  1539. LOAD_INSTRUCTION_ARGS
  1540. CHECK_SPACE(3 + instr_arg_count);
  1541. ip += instr_arg_count;
  1542. int argc = _code_ptr[ip + 1];
  1543. GD_ERR_BREAK(argc < 0);
  1544. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1545. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1546. GET_INSTRUCTION_ARG(base, argc);
  1547. #ifdef DEBUG_ENABLED
  1548. bool freed = false;
  1549. Object *base_obj = base->get_validated_object_with_check(freed);
  1550. if (freed) {
  1551. err_text = METHOD_CALL_ON_FREED_INSTANCE_ERROR(method);
  1552. OPCODE_BREAK;
  1553. } else if (!base_obj) {
  1554. err_text = METHOD_CALL_ON_NULL_VALUE_ERROR(method);
  1555. OPCODE_BREAK;
  1556. }
  1557. #else
  1558. Object *base_obj = base->operator Object *();
  1559. #endif
  1560. Variant **argptrs = instruction_args;
  1561. #ifdef DEBUG_ENABLED
  1562. uint64_t call_time = 0;
  1563. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1564. call_time = OS::get_singleton()->get_ticks_usec();
  1565. }
  1566. #endif
  1567. Callable::CallError err;
  1568. if (call_ret) {
  1569. GET_INSTRUCTION_ARG(ret, argc + 1);
  1570. *ret = method->call(base_obj, (const Variant **)argptrs, argc, err);
  1571. } else {
  1572. method->call(base_obj, (const Variant **)argptrs, argc, err);
  1573. }
  1574. #ifdef DEBUG_ENABLED
  1575. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1576. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1577. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1578. function_call_time += t_taken;
  1579. }
  1580. if (err.error != Callable::CallError::CALL_OK) {
  1581. String methodstr = method->get_name();
  1582. String basestr = _get_var_type(base);
  1583. if (methodstr == "call") {
  1584. if (argc >= 1) {
  1585. methodstr = String(*argptrs[0]) + " (via call)";
  1586. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  1587. err.argument += 1;
  1588. }
  1589. }
  1590. } else if (methodstr == "free") {
  1591. if (err.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  1592. if (base->is_ref_counted()) {
  1593. err_text = "Attempted to free a reference.";
  1594. OPCODE_BREAK;
  1595. } else if (base->get_type() == Variant::OBJECT) {
  1596. err_text = "Attempted to free a locked object (calling or emitting).";
  1597. OPCODE_BREAK;
  1598. }
  1599. }
  1600. }
  1601. err_text = _get_call_error(err, "function '" + methodstr + "' in base '" + basestr + "'", (const Variant **)argptrs);
  1602. OPCODE_BREAK;
  1603. }
  1604. #endif
  1605. ip += 3;
  1606. }
  1607. DISPATCH_OPCODE;
  1608. OPCODE(OPCODE_CALL_BUILTIN_STATIC) {
  1609. LOAD_INSTRUCTION_ARGS
  1610. CHECK_SPACE(4 + instr_arg_count);
  1611. ip += instr_arg_count;
  1612. GD_ERR_BREAK(_code_ptr[ip + 1] < 0 || _code_ptr[ip + 1] >= Variant::VARIANT_MAX);
  1613. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 1];
  1614. int methodname_idx = _code_ptr[ip + 2];
  1615. GD_ERR_BREAK(methodname_idx < 0 || methodname_idx >= _global_names_count);
  1616. const StringName *methodname = &_global_names_ptr[methodname_idx];
  1617. int argc = _code_ptr[ip + 3];
  1618. GD_ERR_BREAK(argc < 0);
  1619. GET_INSTRUCTION_ARG(ret, argc);
  1620. const Variant **argptrs = const_cast<const Variant **>(instruction_args);
  1621. Callable::CallError err;
  1622. Variant::call_static(builtin_type, *methodname, argptrs, argc, *ret, err);
  1623. #ifdef DEBUG_ENABLED
  1624. if (err.error != Callable::CallError::CALL_OK) {
  1625. err_text = _get_call_error(err, "static function '" + methodname->operator String() + "' in type '" + Variant::get_type_name(builtin_type) + "'", argptrs);
  1626. OPCODE_BREAK;
  1627. }
  1628. #endif
  1629. ip += 4;
  1630. }
  1631. DISPATCH_OPCODE;
  1632. OPCODE(OPCODE_CALL_NATIVE_STATIC) {
  1633. LOAD_INSTRUCTION_ARGS
  1634. CHECK_SPACE(3 + instr_arg_count);
  1635. ip += instr_arg_count;
  1636. GD_ERR_BREAK(_code_ptr[ip + 1] < 0 || _code_ptr[ip + 1] >= _methods_count);
  1637. MethodBind *method = _methods_ptr[_code_ptr[ip + 1]];
  1638. int argc = _code_ptr[ip + 2];
  1639. GD_ERR_BREAK(argc < 0);
  1640. GET_INSTRUCTION_ARG(ret, argc);
  1641. const Variant **argptrs = const_cast<const Variant **>(instruction_args);
  1642. #ifdef DEBUG_ENABLED
  1643. uint64_t call_time = 0;
  1644. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1645. call_time = OS::get_singleton()->get_ticks_usec();
  1646. }
  1647. #endif
  1648. Callable::CallError err;
  1649. *ret = method->call(nullptr, argptrs, argc, err);
  1650. #ifdef DEBUG_ENABLED
  1651. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1652. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1653. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1654. function_call_time += t_taken;
  1655. }
  1656. #endif
  1657. if (err.error != Callable::CallError::CALL_OK) {
  1658. err_text = _get_call_error(err, "static function '" + method->get_name().operator String() + "' in type '" + method->get_instance_class().operator String() + "'", argptrs);
  1659. OPCODE_BREAK;
  1660. }
  1661. ip += 3;
  1662. }
  1663. DISPATCH_OPCODE;
  1664. OPCODE(OPCODE_CALL_NATIVE_STATIC_VALIDATED_RETURN) {
  1665. LOAD_INSTRUCTION_ARGS
  1666. CHECK_SPACE(3 + instr_arg_count);
  1667. ip += instr_arg_count;
  1668. int argc = _code_ptr[ip + 1];
  1669. GD_ERR_BREAK(argc < 0);
  1670. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1671. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1672. Variant **argptrs = instruction_args;
  1673. #ifdef DEBUG_ENABLED
  1674. uint64_t call_time = 0;
  1675. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1676. call_time = OS::get_singleton()->get_ticks_usec();
  1677. }
  1678. #endif
  1679. GET_INSTRUCTION_ARG(ret, argc);
  1680. method->validated_call(nullptr, (const Variant **)argptrs, ret);
  1681. #ifdef DEBUG_ENABLED
  1682. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1683. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1684. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1685. function_call_time += t_taken;
  1686. }
  1687. #endif
  1688. ip += 3;
  1689. }
  1690. DISPATCH_OPCODE;
  1691. OPCODE(OPCODE_CALL_NATIVE_STATIC_VALIDATED_NO_RETURN) {
  1692. LOAD_INSTRUCTION_ARGS
  1693. CHECK_SPACE(3 + instr_arg_count);
  1694. ip += instr_arg_count;
  1695. int argc = _code_ptr[ip + 1];
  1696. GD_ERR_BREAK(argc < 0);
  1697. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1698. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1699. Variant **argptrs = instruction_args;
  1700. #ifdef DEBUG_ENABLED
  1701. uint64_t call_time = 0;
  1702. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1703. call_time = OS::get_singleton()->get_ticks_usec();
  1704. }
  1705. #endif
  1706. GET_INSTRUCTION_ARG(ret, argc);
  1707. VariantInternal::initialize(ret, Variant::NIL);
  1708. method->validated_call(nullptr, (const Variant **)argptrs, nullptr);
  1709. #ifdef DEBUG_ENABLED
  1710. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1711. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1712. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1713. function_call_time += t_taken;
  1714. }
  1715. #endif
  1716. ip += 3;
  1717. }
  1718. DISPATCH_OPCODE;
  1719. OPCODE(OPCODE_CALL_METHOD_BIND_VALIDATED_RETURN) {
  1720. LOAD_INSTRUCTION_ARGS
  1721. CHECK_SPACE(3 + instr_arg_count);
  1722. ip += instr_arg_count;
  1723. int argc = _code_ptr[ip + 1];
  1724. GD_ERR_BREAK(argc < 0);
  1725. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1726. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1727. GET_INSTRUCTION_ARG(base, argc);
  1728. #ifdef DEBUG_ENABLED
  1729. bool freed = false;
  1730. Object *base_obj = base->get_validated_object_with_check(freed);
  1731. if (freed) {
  1732. err_text = METHOD_CALL_ON_FREED_INSTANCE_ERROR(method);
  1733. OPCODE_BREAK;
  1734. } else if (!base_obj) {
  1735. err_text = METHOD_CALL_ON_NULL_VALUE_ERROR(method);
  1736. OPCODE_BREAK;
  1737. }
  1738. #else
  1739. Object *base_obj = *VariantInternal::get_object(base);
  1740. #endif
  1741. Variant **argptrs = instruction_args;
  1742. #ifdef DEBUG_ENABLED
  1743. uint64_t call_time = 0;
  1744. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1745. call_time = OS::get_singleton()->get_ticks_usec();
  1746. }
  1747. #endif
  1748. GET_INSTRUCTION_ARG(ret, argc + 1);
  1749. method->validated_call(base_obj, (const Variant **)argptrs, ret);
  1750. #ifdef DEBUG_ENABLED
  1751. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1752. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1753. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1754. function_call_time += t_taken;
  1755. }
  1756. #endif
  1757. ip += 3;
  1758. }
  1759. DISPATCH_OPCODE;
  1760. OPCODE(OPCODE_CALL_METHOD_BIND_VALIDATED_NO_RETURN) {
  1761. LOAD_INSTRUCTION_ARGS
  1762. CHECK_SPACE(3 + instr_arg_count);
  1763. ip += instr_arg_count;
  1764. int argc = _code_ptr[ip + 1];
  1765. GD_ERR_BREAK(argc < 0);
  1766. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1767. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1768. GET_INSTRUCTION_ARG(base, argc);
  1769. #ifdef DEBUG_ENABLED
  1770. bool freed = false;
  1771. Object *base_obj = base->get_validated_object_with_check(freed);
  1772. if (freed) {
  1773. err_text = METHOD_CALL_ON_FREED_INSTANCE_ERROR(method);
  1774. OPCODE_BREAK;
  1775. } else if (!base_obj) {
  1776. err_text = METHOD_CALL_ON_NULL_VALUE_ERROR(method);
  1777. OPCODE_BREAK;
  1778. }
  1779. #else
  1780. Object *base_obj = *VariantInternal::get_object(base);
  1781. #endif
  1782. Variant **argptrs = instruction_args;
  1783. #ifdef DEBUG_ENABLED
  1784. uint64_t call_time = 0;
  1785. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1786. call_time = OS::get_singleton()->get_ticks_usec();
  1787. }
  1788. #endif
  1789. GET_INSTRUCTION_ARG(ret, argc + 1);
  1790. VariantInternal::initialize(ret, Variant::NIL);
  1791. method->validated_call(base_obj, (const Variant **)argptrs, nullptr);
  1792. #ifdef DEBUG_ENABLED
  1793. if (GDScriptLanguage::get_singleton()->profiling && GDScriptLanguage::get_singleton()->profile_native_calls) {
  1794. uint64_t t_taken = OS::get_singleton()->get_ticks_usec() - call_time;
  1795. _profile_native_call(t_taken, method->get_name(), method->get_instance_class());
  1796. function_call_time += t_taken;
  1797. }
  1798. #endif
  1799. ip += 3;
  1800. }
  1801. DISPATCH_OPCODE;
  1802. OPCODE(OPCODE_CALL_BUILTIN_TYPE_VALIDATED) {
  1803. LOAD_INSTRUCTION_ARGS
  1804. CHECK_SPACE(3 + instr_arg_count);
  1805. ip += instr_arg_count;
  1806. int argc = _code_ptr[ip + 1];
  1807. GD_ERR_BREAK(argc < 0);
  1808. GET_INSTRUCTION_ARG(base, argc);
  1809. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _builtin_methods_count);
  1810. Variant::ValidatedBuiltInMethod method = _builtin_methods_ptr[_code_ptr[ip + 2]];
  1811. Variant **argptrs = instruction_args;
  1812. GET_INSTRUCTION_ARG(ret, argc + 1);
  1813. method(base, (const Variant **)argptrs, argc, ret);
  1814. ip += 3;
  1815. }
  1816. DISPATCH_OPCODE;
  1817. OPCODE(OPCODE_CALL_UTILITY) {
  1818. LOAD_INSTRUCTION_ARGS
  1819. CHECK_SPACE(3 + instr_arg_count);
  1820. ip += instr_arg_count;
  1821. int argc = _code_ptr[ip + 1];
  1822. GD_ERR_BREAK(argc < 0);
  1823. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _global_names_count);
  1824. StringName function = _global_names_ptr[_code_ptr[ip + 2]];
  1825. Variant **argptrs = instruction_args;
  1826. GET_INSTRUCTION_ARG(dst, argc);
  1827. Callable::CallError err;
  1828. Variant::call_utility_function(function, dst, (const Variant **)argptrs, argc, err);
  1829. #ifdef DEBUG_ENABLED
  1830. if (err.error != Callable::CallError::CALL_OK) {
  1831. String methodstr = function;
  1832. if (dst->get_type() == Variant::STRING && !dst->operator String().is_empty()) {
  1833. // Call provided error string.
  1834. err_text = vformat(R"*(Error calling utility function "%s()": %s)*", methodstr, *dst);
  1835. } else {
  1836. err_text = _get_call_error(err, vformat(R"*(utility function "%s()")*", methodstr), (const Variant **)argptrs);
  1837. }
  1838. OPCODE_BREAK;
  1839. }
  1840. #endif
  1841. ip += 3;
  1842. }
  1843. DISPATCH_OPCODE;
  1844. OPCODE(OPCODE_CALL_UTILITY_VALIDATED) {
  1845. LOAD_INSTRUCTION_ARGS
  1846. CHECK_SPACE(3 + instr_arg_count);
  1847. ip += instr_arg_count;
  1848. int argc = _code_ptr[ip + 1];
  1849. GD_ERR_BREAK(argc < 0);
  1850. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _utilities_count);
  1851. Variant::ValidatedUtilityFunction function = _utilities_ptr[_code_ptr[ip + 2]];
  1852. Variant **argptrs = instruction_args;
  1853. GET_INSTRUCTION_ARG(dst, argc);
  1854. function(dst, (const Variant **)argptrs, argc);
  1855. ip += 3;
  1856. }
  1857. DISPATCH_OPCODE;
  1858. OPCODE(OPCODE_CALL_GDSCRIPT_UTILITY) {
  1859. LOAD_INSTRUCTION_ARGS
  1860. CHECK_SPACE(3 + instr_arg_count);
  1861. ip += instr_arg_count;
  1862. int argc = _code_ptr[ip + 1];
  1863. GD_ERR_BREAK(argc < 0);
  1864. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _gds_utilities_count);
  1865. GDScriptUtilityFunctions::FunctionPtr function = _gds_utilities_ptr[_code_ptr[ip + 2]];
  1866. Variant **argptrs = instruction_args;
  1867. GET_INSTRUCTION_ARG(dst, argc);
  1868. Callable::CallError err;
  1869. function(dst, (const Variant **)argptrs, argc, err);
  1870. #ifdef DEBUG_ENABLED
  1871. if (err.error != Callable::CallError::CALL_OK) {
  1872. String methodstr = gds_utilities_names[_code_ptr[ip + 2]];
  1873. if (dst->get_type() == Variant::STRING && !dst->operator String().is_empty()) {
  1874. // Call provided error string.
  1875. err_text = vformat(R"*(Error calling GDScript utility function "%s()": %s)*", methodstr, *dst);
  1876. } else {
  1877. err_text = _get_call_error(err, vformat(R"*(GDScript utility function "%s()")*", methodstr), (const Variant **)argptrs);
  1878. }
  1879. OPCODE_BREAK;
  1880. }
  1881. #endif
  1882. ip += 3;
  1883. }
  1884. DISPATCH_OPCODE;
  1885. OPCODE(OPCODE_CALL_SELF_BASE) {
  1886. LOAD_INSTRUCTION_ARGS
  1887. CHECK_SPACE(3 + instr_arg_count);
  1888. ip += instr_arg_count;
  1889. int argc = _code_ptr[ip + 1];
  1890. GD_ERR_BREAK(argc < 0);
  1891. int self_fun = _code_ptr[ip + 2];
  1892. #ifdef DEBUG_ENABLED
  1893. if (self_fun < 0 || self_fun >= _global_names_count) {
  1894. err_text = "compiler bug, function name not found";
  1895. OPCODE_BREAK;
  1896. }
  1897. #endif
  1898. const StringName *methodname = &_global_names_ptr[self_fun];
  1899. Variant **argptrs = instruction_args;
  1900. GET_INSTRUCTION_ARG(dst, argc);
  1901. const GDScript *gds = _script;
  1902. HashMap<StringName, GDScriptFunction *>::ConstIterator E;
  1903. while (gds->base.ptr()) {
  1904. gds = gds->base.ptr();
  1905. E = gds->member_functions.find(*methodname);
  1906. if (E) {
  1907. break;
  1908. }
  1909. }
  1910. Callable::CallError err;
  1911. if (E) {
  1912. *dst = E->value->call(p_instance, (const Variant **)argptrs, argc, err);
  1913. } else if (gds->native.ptr()) {
  1914. if (*methodname != GDScriptLanguage::get_singleton()->strings._init) {
  1915. MethodBind *mb = ClassDB::get_method(gds->native->get_name(), *methodname);
  1916. if (!mb) {
  1917. err.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1918. } else {
  1919. *dst = mb->call(p_instance->owner, (const Variant **)argptrs, argc, err);
  1920. }
  1921. } else {
  1922. err.error = Callable::CallError::CALL_OK;
  1923. }
  1924. } else {
  1925. if (*methodname != GDScriptLanguage::get_singleton()->strings._init) {
  1926. err.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1927. } else {
  1928. err.error = Callable::CallError::CALL_OK;
  1929. }
  1930. }
  1931. if (err.error != Callable::CallError::CALL_OK) {
  1932. String methodstr = *methodname;
  1933. err_text = _get_call_error(err, "function '" + methodstr + "'", (const Variant **)argptrs);
  1934. OPCODE_BREAK;
  1935. }
  1936. ip += 3;
  1937. }
  1938. DISPATCH_OPCODE;
  1939. OPCODE(OPCODE_AWAIT) {
  1940. CHECK_SPACE(2);
  1941. // Do the one-shot connect.
  1942. GET_VARIANT_PTR(argobj, 0);
  1943. Signal sig;
  1944. bool is_signal = true;
  1945. {
  1946. Variant result = *argobj;
  1947. if (argobj->get_type() == Variant::OBJECT) {
  1948. bool was_freed = false;
  1949. Object *obj = argobj->get_validated_object_with_check(was_freed);
  1950. if (was_freed) {
  1951. err_text = "Trying to await on a freed object.";
  1952. OPCODE_BREAK;
  1953. }
  1954. // Is this even possible to be null at this point?
  1955. if (obj) {
  1956. if (obj->is_class_ptr(GDScriptFunctionState::get_class_ptr_static())) {
  1957. result = Signal(obj, "completed");
  1958. }
  1959. }
  1960. }
  1961. if (result.get_type() != Variant::SIGNAL) {
  1962. // Not async, return immediately using the target from OPCODE_AWAIT_RESUME.
  1963. GET_VARIANT_PTR(target, 2);
  1964. *target = result;
  1965. ip += 4; // Skip OPCODE_AWAIT_RESUME and its data.
  1966. is_signal = false;
  1967. } else {
  1968. sig = result;
  1969. }
  1970. }
  1971. if (is_signal) {
  1972. Ref<GDScriptFunctionState> gdfs = memnew(GDScriptFunctionState);
  1973. gdfs->function = this;
  1974. gdfs->state.stack.resize(alloca_size);
  1975. // First 3 stack addresses are special, so we just skip them here.
  1976. for (int i = 3; i < _stack_size; i++) {
  1977. memnew_placement(&gdfs->state.stack.write[sizeof(Variant) * i], Variant(stack[i]));
  1978. }
  1979. gdfs->state.stack_size = _stack_size;
  1980. gdfs->state.alloca_size = alloca_size;
  1981. gdfs->state.ip = ip + 2;
  1982. gdfs->state.line = line;
  1983. gdfs->state.script = _script;
  1984. {
  1985. MutexLock lock(GDScriptLanguage::get_singleton()->mutex);
  1986. _script->pending_func_states.add(&gdfs->scripts_list);
  1987. if (p_instance) {
  1988. gdfs->state.instance = p_instance;
  1989. p_instance->pending_func_states.add(&gdfs->instances_list);
  1990. } else {
  1991. gdfs->state.instance = nullptr;
  1992. }
  1993. }
  1994. #ifdef DEBUG_ENABLED
  1995. gdfs->state.function_name = name;
  1996. gdfs->state.script_path = _script->get_script_path();
  1997. #endif
  1998. gdfs->state.defarg = defarg;
  1999. gdfs->function = this;
  2000. retvalue = gdfs;
  2001. Error err = sig.connect(Callable(gdfs.ptr(), "_signal_callback").bind(retvalue), Object::CONNECT_ONE_SHOT);
  2002. if (err != OK) {
  2003. err_text = "Error connecting to signal: " + sig.get_name() + " during await.";
  2004. OPCODE_BREAK;
  2005. }
  2006. #ifdef DEBUG_ENABLED
  2007. exit_ok = true;
  2008. awaited = true;
  2009. #endif
  2010. OPCODE_BREAK;
  2011. }
  2012. }
  2013. DISPATCH_OPCODE; // Needed for synchronous calls (when result is immediately available).
  2014. OPCODE(OPCODE_AWAIT_RESUME) {
  2015. CHECK_SPACE(2);
  2016. #ifdef DEBUG_ENABLED
  2017. if (!p_state) {
  2018. err_text = ("Invalid Resume (bug?)");
  2019. OPCODE_BREAK;
  2020. }
  2021. #endif
  2022. GET_VARIANT_PTR(result, 0);
  2023. *result = p_state->result;
  2024. ip += 2;
  2025. }
  2026. DISPATCH_OPCODE;
  2027. OPCODE(OPCODE_CREATE_LAMBDA) {
  2028. LOAD_INSTRUCTION_ARGS
  2029. CHECK_SPACE(2 + instr_arg_count);
  2030. ip += instr_arg_count;
  2031. int captures_count = _code_ptr[ip + 1];
  2032. GD_ERR_BREAK(captures_count < 0);
  2033. int lambda_index = _code_ptr[ip + 2];
  2034. GD_ERR_BREAK(lambda_index < 0 || lambda_index >= _lambdas_count);
  2035. GDScriptFunction *lambda = _lambdas_ptr[lambda_index];
  2036. Vector<Variant> captures;
  2037. captures.resize(captures_count);
  2038. for (int i = 0; i < captures_count; i++) {
  2039. GET_INSTRUCTION_ARG(arg, i);
  2040. captures.write[i] = *arg;
  2041. }
  2042. GDScriptLambdaCallable *callable = memnew(GDScriptLambdaCallable(Ref<GDScript>(script), lambda, captures));
  2043. GET_INSTRUCTION_ARG(result, captures_count);
  2044. *result = Callable(callable);
  2045. ip += 3;
  2046. }
  2047. DISPATCH_OPCODE;
  2048. OPCODE(OPCODE_CREATE_SELF_LAMBDA) {
  2049. LOAD_INSTRUCTION_ARGS
  2050. CHECK_SPACE(2 + instr_arg_count);
  2051. GD_ERR_BREAK(p_instance == nullptr);
  2052. ip += instr_arg_count;
  2053. int captures_count = _code_ptr[ip + 1];
  2054. GD_ERR_BREAK(captures_count < 0);
  2055. int lambda_index = _code_ptr[ip + 2];
  2056. GD_ERR_BREAK(lambda_index < 0 || lambda_index >= _lambdas_count);
  2057. GDScriptFunction *lambda = _lambdas_ptr[lambda_index];
  2058. Vector<Variant> captures;
  2059. captures.resize(captures_count);
  2060. for (int i = 0; i < captures_count; i++) {
  2061. GET_INSTRUCTION_ARG(arg, i);
  2062. captures.write[i] = *arg;
  2063. }
  2064. GDScriptLambdaSelfCallable *callable;
  2065. if (Object::cast_to<RefCounted>(p_instance->owner)) {
  2066. callable = memnew(GDScriptLambdaSelfCallable(Ref<RefCounted>(Object::cast_to<RefCounted>(p_instance->owner)), lambda, captures));
  2067. } else {
  2068. callable = memnew(GDScriptLambdaSelfCallable(p_instance->owner, lambda, captures));
  2069. }
  2070. GET_INSTRUCTION_ARG(result, captures_count);
  2071. *result = Callable(callable);
  2072. ip += 3;
  2073. }
  2074. DISPATCH_OPCODE;
  2075. OPCODE(OPCODE_JUMP) {
  2076. CHECK_SPACE(2);
  2077. int to = _code_ptr[ip + 1];
  2078. GD_ERR_BREAK(to < 0 || to > _code_size);
  2079. ip = to;
  2080. }
  2081. DISPATCH_OPCODE;
  2082. OPCODE(OPCODE_JUMP_IF) {
  2083. CHECK_SPACE(3);
  2084. GET_VARIANT_PTR(test, 0);
  2085. bool result = test->booleanize();
  2086. if (result) {
  2087. int to = _code_ptr[ip + 2];
  2088. GD_ERR_BREAK(to < 0 || to > _code_size);
  2089. ip = to;
  2090. } else {
  2091. ip += 3;
  2092. }
  2093. }
  2094. DISPATCH_OPCODE;
  2095. OPCODE(OPCODE_JUMP_IF_NOT) {
  2096. CHECK_SPACE(3);
  2097. GET_VARIANT_PTR(test, 0);
  2098. bool result = test->booleanize();
  2099. if (!result) {
  2100. int to = _code_ptr[ip + 2];
  2101. GD_ERR_BREAK(to < 0 || to > _code_size);
  2102. ip = to;
  2103. } else {
  2104. ip += 3;
  2105. }
  2106. }
  2107. DISPATCH_OPCODE;
  2108. OPCODE(OPCODE_JUMP_TO_DEF_ARGUMENT) {
  2109. CHECK_SPACE(2);
  2110. ip = _default_arg_ptr[defarg];
  2111. }
  2112. DISPATCH_OPCODE;
  2113. OPCODE(OPCODE_JUMP_IF_SHARED) {
  2114. CHECK_SPACE(3);
  2115. GET_VARIANT_PTR(val, 0);
  2116. if (val->is_shared()) {
  2117. int to = _code_ptr[ip + 2];
  2118. GD_ERR_BREAK(to < 0 || to > _code_size);
  2119. ip = to;
  2120. } else {
  2121. ip += 3;
  2122. }
  2123. }
  2124. DISPATCH_OPCODE;
  2125. OPCODE(OPCODE_RETURN) {
  2126. CHECK_SPACE(2);
  2127. GET_VARIANT_PTR(r, 0);
  2128. retvalue = *r;
  2129. #ifdef DEBUG_ENABLED
  2130. exit_ok = true;
  2131. #endif
  2132. OPCODE_BREAK;
  2133. }
  2134. OPCODE(OPCODE_RETURN_TYPED_BUILTIN) {
  2135. CHECK_SPACE(3);
  2136. GET_VARIANT_PTR(r, 0);
  2137. Variant::Type ret_type = (Variant::Type)_code_ptr[ip + 2];
  2138. GD_ERR_BREAK(ret_type < 0 || ret_type >= Variant::VARIANT_MAX);
  2139. if (r->get_type() != ret_type) {
  2140. if (Variant::can_convert_strict(r->get_type(), ret_type)) {
  2141. Callable::CallError ce;
  2142. Variant::construct(ret_type, retvalue, const_cast<const Variant **>(&r), 1, ce);
  2143. } else {
  2144. #ifdef DEBUG_ENABLED
  2145. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "%s".)",
  2146. Variant::get_type_name(r->get_type()), Variant::get_type_name(ret_type));
  2147. #endif // DEBUG_ENABLED
  2148. // Construct a base type anyway so type constraints are met.
  2149. Callable::CallError ce;
  2150. Variant::construct(ret_type, retvalue, nullptr, 0, ce);
  2151. OPCODE_BREAK;
  2152. }
  2153. } else {
  2154. retvalue = *r;
  2155. }
  2156. #ifdef DEBUG_ENABLED
  2157. exit_ok = true;
  2158. #endif // DEBUG_ENABLED
  2159. OPCODE_BREAK;
  2160. }
  2161. OPCODE(OPCODE_RETURN_TYPED_ARRAY) {
  2162. CHECK_SPACE(5);
  2163. GET_VARIANT_PTR(r, 0);
  2164. GET_VARIANT_PTR(script_type, 1);
  2165. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 3];
  2166. int native_type_idx = _code_ptr[ip + 4];
  2167. GD_ERR_BREAK(native_type_idx < 0 || native_type_idx >= _global_names_count);
  2168. const StringName native_type = _global_names_ptr[native_type_idx];
  2169. if (r->get_type() != Variant::ARRAY) {
  2170. #ifdef DEBUG_ENABLED
  2171. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "Array[%s]".)",
  2172. Variant::get_type_name(r->get_type()), Variant::get_type_name(builtin_type));
  2173. #endif
  2174. OPCODE_BREAK;
  2175. }
  2176. Array *array = VariantInternal::get_array(r);
  2177. if (array->get_typed_builtin() != ((uint32_t)builtin_type) || array->get_typed_class_name() != native_type || array->get_typed_script() != *script_type) {
  2178. #ifdef DEBUG_ENABLED
  2179. err_text = vformat(R"(Trying to return an array of type "%s" where expected return type is "Array[%s]".)",
  2180. _get_var_type(r), _get_element_type(builtin_type, native_type, *script_type));
  2181. #endif // DEBUG_ENABLED
  2182. OPCODE_BREAK;
  2183. }
  2184. retvalue = *array;
  2185. #ifdef DEBUG_ENABLED
  2186. exit_ok = true;
  2187. #endif // DEBUG_ENABLED
  2188. OPCODE_BREAK;
  2189. }
  2190. OPCODE(OPCODE_RETURN_TYPED_NATIVE) {
  2191. CHECK_SPACE(3);
  2192. GET_VARIANT_PTR(r, 0);
  2193. GET_VARIANT_PTR(type, 1);
  2194. GDScriptNativeClass *nc = Object::cast_to<GDScriptNativeClass>(type->operator Object *());
  2195. GD_ERR_BREAK(!nc);
  2196. if (r->get_type() != Variant::OBJECT && r->get_type() != Variant::NIL) {
  2197. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "%s".)",
  2198. Variant::get_type_name(r->get_type()), nc->get_name());
  2199. OPCODE_BREAK;
  2200. }
  2201. #ifdef DEBUG_ENABLED
  2202. bool freed = false;
  2203. Object *ret_obj = r->get_validated_object_with_check(freed);
  2204. if (freed) {
  2205. err_text = "Trying to return a previously freed instance.";
  2206. OPCODE_BREAK;
  2207. }
  2208. #else
  2209. Object *ret_obj = r->operator Object *();
  2210. #endif // DEBUG_ENABLED
  2211. if (ret_obj && !ClassDB::is_parent_class(ret_obj->get_class_name(), nc->get_name())) {
  2212. #ifdef DEBUG_ENABLED
  2213. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "%s".)",
  2214. ret_obj->get_class_name(), nc->get_name());
  2215. #endif // DEBUG_ENABLED
  2216. OPCODE_BREAK;
  2217. }
  2218. retvalue = *r;
  2219. #ifdef DEBUG_ENABLED
  2220. exit_ok = true;
  2221. #endif // DEBUG_ENABLED
  2222. OPCODE_BREAK;
  2223. }
  2224. OPCODE(OPCODE_RETURN_TYPED_SCRIPT) {
  2225. CHECK_SPACE(3);
  2226. GET_VARIANT_PTR(r, 0);
  2227. GET_VARIANT_PTR(type, 1);
  2228. Script *base_type = Object::cast_to<Script>(type->operator Object *());
  2229. GD_ERR_BREAK(!base_type);
  2230. if (r->get_type() != Variant::OBJECT && r->get_type() != Variant::NIL) {
  2231. #ifdef DEBUG_ENABLED
  2232. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "%s".)",
  2233. Variant::get_type_name(r->get_type()), GDScript::debug_get_script_name(Ref<Script>(base_type)));
  2234. #endif // DEBUG_ENABLED
  2235. OPCODE_BREAK;
  2236. }
  2237. #ifdef DEBUG_ENABLED
  2238. bool freed = false;
  2239. Object *ret_obj = r->get_validated_object_with_check(freed);
  2240. if (freed) {
  2241. err_text = "Trying to return a previously freed instance.";
  2242. OPCODE_BREAK;
  2243. }
  2244. #else
  2245. Object *ret_obj = r->operator Object *();
  2246. #endif // DEBUG_ENABLED
  2247. if (ret_obj) {
  2248. ScriptInstance *ret_inst = ret_obj->get_script_instance();
  2249. if (!ret_inst) {
  2250. #ifdef DEBUG_ENABLED
  2251. err_text = vformat(R"(Trying to return value of type "%s" from a function whose return type is "%s".)",
  2252. ret_obj->get_class_name(), GDScript::debug_get_script_name(Ref<GDScript>(base_type)));
  2253. #endif // DEBUG_ENABLED
  2254. OPCODE_BREAK;
  2255. }
  2256. Script *ret_type = ret_obj->get_script_instance()->get_script().ptr();
  2257. bool valid = false;
  2258. while (ret_type) {
  2259. if (ret_type == base_type) {
  2260. valid = true;
  2261. break;
  2262. }
  2263. ret_type = ret_type->get_base_script().ptr();
  2264. }
  2265. if (!valid) {
  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. GDScript::debug_get_script_name(ret_obj->get_script_instance()->get_script()), GDScript::debug_get_script_name(Ref<GDScript>(base_type)));
  2269. #endif // DEBUG_ENABLED
  2270. OPCODE_BREAK;
  2271. }
  2272. }
  2273. retvalue = *r;
  2274. #ifdef DEBUG_ENABLED
  2275. exit_ok = true;
  2276. #endif // DEBUG_ENABLED
  2277. OPCODE_BREAK;
  2278. }
  2279. OPCODE(OPCODE_ITERATE_BEGIN) {
  2280. CHECK_SPACE(8); // Space for this and a regular iterate.
  2281. GET_VARIANT_PTR(counter, 0);
  2282. GET_VARIANT_PTR(container, 1);
  2283. bool valid;
  2284. if (!container->iter_init(*counter, valid)) {
  2285. #ifdef DEBUG_ENABLED
  2286. if (!valid) {
  2287. err_text = "Unable to iterate on object of type '" + Variant::get_type_name(container->get_type()) + "'.";
  2288. OPCODE_BREAK;
  2289. }
  2290. #endif
  2291. int jumpto = _code_ptr[ip + 4];
  2292. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2293. ip = jumpto;
  2294. } else {
  2295. GET_VARIANT_PTR(iterator, 2);
  2296. *iterator = container->iter_get(*counter, valid);
  2297. #ifdef DEBUG_ENABLED
  2298. if (!valid) {
  2299. err_text = "Unable to obtain iterator object of type '" + Variant::get_type_name(container->get_type()) + "'.";
  2300. OPCODE_BREAK;
  2301. }
  2302. #endif
  2303. ip += 5; // Skip regular iterate which is always next.
  2304. }
  2305. }
  2306. DISPATCH_OPCODE;
  2307. OPCODE(OPCODE_ITERATE_BEGIN_INT) {
  2308. CHECK_SPACE(8); // Check space for iterate instruction too.
  2309. GET_VARIANT_PTR(counter, 0);
  2310. GET_VARIANT_PTR(container, 1);
  2311. int64_t size = *VariantInternal::get_int(container);
  2312. VariantInternal::initialize(counter, Variant::INT);
  2313. *VariantInternal::get_int(counter) = 0;
  2314. if (size > 0) {
  2315. GET_VARIANT_PTR(iterator, 2);
  2316. VariantInternal::initialize(iterator, Variant::INT);
  2317. *VariantInternal::get_int(iterator) = 0;
  2318. // Skip regular iterate.
  2319. ip += 5;
  2320. } else {
  2321. // Jump to end of loop.
  2322. int jumpto = _code_ptr[ip + 4];
  2323. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2324. ip = jumpto;
  2325. }
  2326. }
  2327. DISPATCH_OPCODE;
  2328. OPCODE(OPCODE_ITERATE_BEGIN_FLOAT) {
  2329. CHECK_SPACE(8); // Check space for iterate instruction too.
  2330. GET_VARIANT_PTR(counter, 0);
  2331. GET_VARIANT_PTR(container, 1);
  2332. double size = *VariantInternal::get_float(container);
  2333. VariantInternal::initialize(counter, Variant::FLOAT);
  2334. *VariantInternal::get_float(counter) = 0.0;
  2335. if (size > 0) {
  2336. GET_VARIANT_PTR(iterator, 2);
  2337. VariantInternal::initialize(iterator, Variant::FLOAT);
  2338. *VariantInternal::get_float(iterator) = 0;
  2339. // Skip regular iterate.
  2340. ip += 5;
  2341. } else {
  2342. // Jump to end of loop.
  2343. int jumpto = _code_ptr[ip + 4];
  2344. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2345. ip = jumpto;
  2346. }
  2347. }
  2348. DISPATCH_OPCODE;
  2349. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR2) {
  2350. CHECK_SPACE(8); // Check space for iterate instruction too.
  2351. GET_VARIANT_PTR(counter, 0);
  2352. GET_VARIANT_PTR(container, 1);
  2353. Vector2 *bounds = VariantInternal::get_vector2(container);
  2354. VariantInternal::initialize(counter, Variant::FLOAT);
  2355. *VariantInternal::get_float(counter) = bounds->x;
  2356. if (bounds->x < bounds->y) {
  2357. GET_VARIANT_PTR(iterator, 2);
  2358. VariantInternal::initialize(iterator, Variant::FLOAT);
  2359. *VariantInternal::get_float(iterator) = bounds->x;
  2360. // Skip regular iterate.
  2361. ip += 5;
  2362. } else {
  2363. // Jump to end of loop.
  2364. int jumpto = _code_ptr[ip + 4];
  2365. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2366. ip = jumpto;
  2367. }
  2368. }
  2369. DISPATCH_OPCODE;
  2370. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR2I) {
  2371. CHECK_SPACE(8); // Check space for iterate instruction too.
  2372. GET_VARIANT_PTR(counter, 0);
  2373. GET_VARIANT_PTR(container, 1);
  2374. Vector2i *bounds = VariantInternal::get_vector2i(container);
  2375. VariantInternal::initialize(counter, Variant::FLOAT);
  2376. *VariantInternal::get_int(counter) = bounds->x;
  2377. if (bounds->x < bounds->y) {
  2378. GET_VARIANT_PTR(iterator, 2);
  2379. VariantInternal::initialize(iterator, Variant::INT);
  2380. *VariantInternal::get_int(iterator) = bounds->x;
  2381. // Skip regular iterate.
  2382. ip += 5;
  2383. } else {
  2384. // Jump to end of loop.
  2385. int jumpto = _code_ptr[ip + 4];
  2386. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2387. ip = jumpto;
  2388. }
  2389. }
  2390. DISPATCH_OPCODE;
  2391. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR3) {
  2392. CHECK_SPACE(8); // Check space for iterate instruction too.
  2393. GET_VARIANT_PTR(counter, 0);
  2394. GET_VARIANT_PTR(container, 1);
  2395. Vector3 *bounds = VariantInternal::get_vector3(container);
  2396. double from = bounds->x;
  2397. double to = bounds->y;
  2398. double step = bounds->z;
  2399. VariantInternal::initialize(counter, Variant::FLOAT);
  2400. *VariantInternal::get_float(counter) = from;
  2401. bool do_continue = from == to ? false : (from < to ? step > 0 : step < 0);
  2402. if (do_continue) {
  2403. GET_VARIANT_PTR(iterator, 2);
  2404. VariantInternal::initialize(iterator, Variant::FLOAT);
  2405. *VariantInternal::get_float(iterator) = from;
  2406. // Skip regular iterate.
  2407. ip += 5;
  2408. } else {
  2409. // Jump to end of loop.
  2410. int jumpto = _code_ptr[ip + 4];
  2411. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2412. ip = jumpto;
  2413. }
  2414. }
  2415. DISPATCH_OPCODE;
  2416. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR3I) {
  2417. CHECK_SPACE(8); // Check space for iterate instruction too.
  2418. GET_VARIANT_PTR(counter, 0);
  2419. GET_VARIANT_PTR(container, 1);
  2420. Vector3i *bounds = VariantInternal::get_vector3i(container);
  2421. int64_t from = bounds->x;
  2422. int64_t to = bounds->y;
  2423. int64_t step = bounds->z;
  2424. VariantInternal::initialize(counter, Variant::INT);
  2425. *VariantInternal::get_int(counter) = from;
  2426. bool do_continue = from == to ? false : (from < to ? step > 0 : step < 0);
  2427. if (do_continue) {
  2428. GET_VARIANT_PTR(iterator, 2);
  2429. VariantInternal::initialize(iterator, Variant::INT);
  2430. *VariantInternal::get_int(iterator) = from;
  2431. // Skip regular iterate.
  2432. ip += 5;
  2433. } else {
  2434. // Jump to end of loop.
  2435. int jumpto = _code_ptr[ip + 4];
  2436. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2437. ip = jumpto;
  2438. }
  2439. }
  2440. DISPATCH_OPCODE;
  2441. OPCODE(OPCODE_ITERATE_BEGIN_STRING) {
  2442. CHECK_SPACE(8); // Check space for iterate instruction too.
  2443. GET_VARIANT_PTR(counter, 0);
  2444. GET_VARIANT_PTR(container, 1);
  2445. String *str = VariantInternal::get_string(container);
  2446. VariantInternal::initialize(counter, Variant::INT);
  2447. *VariantInternal::get_int(counter) = 0;
  2448. if (!str->is_empty()) {
  2449. GET_VARIANT_PTR(iterator, 2);
  2450. VariantInternal::initialize(iterator, Variant::STRING);
  2451. *VariantInternal::get_string(iterator) = str->substr(0, 1);
  2452. // Skip regular iterate.
  2453. ip += 5;
  2454. } else {
  2455. // Jump to end of loop.
  2456. int jumpto = _code_ptr[ip + 4];
  2457. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2458. ip = jumpto;
  2459. }
  2460. }
  2461. DISPATCH_OPCODE;
  2462. OPCODE(OPCODE_ITERATE_BEGIN_DICTIONARY) {
  2463. CHECK_SPACE(8); // Check space for iterate instruction too.
  2464. GET_VARIANT_PTR(counter, 0);
  2465. GET_VARIANT_PTR(container, 1);
  2466. Dictionary *dict = VariantInternal::get_dictionary(container);
  2467. const Variant *next = dict->next(nullptr);
  2468. if (!dict->is_empty()) {
  2469. GET_VARIANT_PTR(iterator, 2);
  2470. *counter = *next;
  2471. *iterator = *next;
  2472. // Skip regular iterate.
  2473. ip += 5;
  2474. } else {
  2475. // Jump to end of loop.
  2476. int jumpto = _code_ptr[ip + 4];
  2477. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2478. ip = jumpto;
  2479. }
  2480. }
  2481. DISPATCH_OPCODE;
  2482. OPCODE(OPCODE_ITERATE_BEGIN_ARRAY) {
  2483. CHECK_SPACE(8); // Check space for iterate instruction too.
  2484. GET_VARIANT_PTR(counter, 0);
  2485. GET_VARIANT_PTR(container, 1);
  2486. Array *array = VariantInternal::get_array(container);
  2487. VariantInternal::initialize(counter, Variant::INT);
  2488. *VariantInternal::get_int(counter) = 0;
  2489. if (!array->is_empty()) {
  2490. GET_VARIANT_PTR(iterator, 2);
  2491. *iterator = array->get(0);
  2492. // Skip regular iterate.
  2493. ip += 5;
  2494. } else {
  2495. // Jump to end of loop.
  2496. int jumpto = _code_ptr[ip + 4];
  2497. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2498. ip = jumpto;
  2499. }
  2500. }
  2501. DISPATCH_OPCODE;
  2502. #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) \
  2503. OPCODE(OPCODE_ITERATE_BEGIN_PACKED_##m_var_type##_ARRAY) { \
  2504. CHECK_SPACE(8); \
  2505. GET_VARIANT_PTR(counter, 0); \
  2506. GET_VARIANT_PTR(container, 1); \
  2507. Vector<m_elem_type> *array = VariantInternal::m_get_func(container); \
  2508. VariantInternal::initialize(counter, Variant::INT); \
  2509. *VariantInternal::get_int(counter) = 0; \
  2510. if (!array->is_empty()) { \
  2511. GET_VARIANT_PTR(iterator, 2); \
  2512. VariantInternal::initialize(iterator, Variant::m_var_ret_type); \
  2513. m_ret_type *it = VariantInternal::m_ret_get_func(iterator); \
  2514. *it = array->get(0); \
  2515. ip += 5; \
  2516. } else { \
  2517. int jumpto = _code_ptr[ip + 4]; \
  2518. GD_ERR_BREAK(jumpto<0 || jumpto> _code_size); \
  2519. ip = jumpto; \
  2520. } \
  2521. } \
  2522. DISPATCH_OPCODE
  2523. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(BYTE, uint8_t, get_byte_array, INT, int64_t, get_int);
  2524. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(INT32, int32_t, get_int32_array, INT, int64_t, get_int);
  2525. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(INT64, int64_t, get_int64_array, INT, int64_t, get_int);
  2526. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(FLOAT32, float, get_float32_array, FLOAT, double, get_float);
  2527. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(FLOAT64, double, get_float64_array, FLOAT, double, get_float);
  2528. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(STRING, String, get_string_array, STRING, String, get_string);
  2529. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(VECTOR2, Vector2, get_vector2_array, VECTOR2, Vector2, get_vector2);
  2530. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(VECTOR3, Vector3, get_vector3_array, VECTOR3, Vector3, get_vector3);
  2531. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(COLOR, Color, get_color_array, COLOR, Color, get_color);
  2532. OPCODE(OPCODE_ITERATE_BEGIN_OBJECT) {
  2533. CHECK_SPACE(4);
  2534. GET_VARIANT_PTR(counter, 0);
  2535. GET_VARIANT_PTR(container, 1);
  2536. #ifdef DEBUG_ENABLED
  2537. bool freed = false;
  2538. Object *obj = container->get_validated_object_with_check(freed);
  2539. if (freed) {
  2540. err_text = "Trying to iterate on a previously freed object.";
  2541. OPCODE_BREAK;
  2542. } else if (!obj) {
  2543. err_text = "Trying to iterate on a null value.";
  2544. OPCODE_BREAK;
  2545. }
  2546. #else
  2547. Object *obj = *VariantInternal::get_object(container);
  2548. #endif
  2549. Array ref;
  2550. ref.push_back(*counter);
  2551. Variant vref;
  2552. VariantInternal::initialize(&vref, Variant::ARRAY);
  2553. *VariantInternal::get_array(&vref) = ref;
  2554. Variant **args = instruction_args; // Overriding an instruction argument, but we don't need access to that anymore.
  2555. args[0] = &vref;
  2556. Callable::CallError ce;
  2557. Variant has_next = obj->callp(CoreStringNames::get_singleton()->_iter_init, (const Variant **)args, 1, ce);
  2558. #ifdef DEBUG_ENABLED
  2559. if (ce.error != Callable::CallError::CALL_OK) {
  2560. err_text = vformat(R"(There was an error calling "_iter_next" on iterator object of type %s.)", *container);
  2561. OPCODE_BREAK;
  2562. }
  2563. #endif
  2564. if (!has_next.booleanize()) {
  2565. int jumpto = _code_ptr[ip + 4];
  2566. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2567. ip = jumpto;
  2568. } else {
  2569. GET_VARIANT_PTR(iterator, 2);
  2570. *iterator = obj->callp(CoreStringNames::get_singleton()->_iter_get, (const Variant **)args, 1, ce);
  2571. #ifdef DEBUG_ENABLED
  2572. if (ce.error != Callable::CallError::CALL_OK) {
  2573. err_text = vformat(R"(There was an error calling "_iter_get" on iterator object of type %s.)", *container);
  2574. OPCODE_BREAK;
  2575. }
  2576. #endif
  2577. ip += 5; // Loop again.
  2578. }
  2579. }
  2580. DISPATCH_OPCODE;
  2581. OPCODE(OPCODE_ITERATE) {
  2582. CHECK_SPACE(4);
  2583. GET_VARIANT_PTR(counter, 0);
  2584. GET_VARIANT_PTR(container, 1);
  2585. bool valid;
  2586. if (!container->iter_next(*counter, valid)) {
  2587. #ifdef DEBUG_ENABLED
  2588. if (!valid) {
  2589. err_text = "Unable to iterate on object of type '" + Variant::get_type_name(container->get_type()) + "' (type changed since first iteration?).";
  2590. OPCODE_BREAK;
  2591. }
  2592. #endif
  2593. int jumpto = _code_ptr[ip + 4];
  2594. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2595. ip = jumpto;
  2596. } else {
  2597. GET_VARIANT_PTR(iterator, 2);
  2598. *iterator = container->iter_get(*counter, valid);
  2599. #ifdef DEBUG_ENABLED
  2600. if (!valid) {
  2601. err_text = "Unable to obtain iterator object of type '" + Variant::get_type_name(container->get_type()) + "' (but was obtained on first iteration?).";
  2602. OPCODE_BREAK;
  2603. }
  2604. #endif
  2605. ip += 5; //loop again
  2606. }
  2607. }
  2608. DISPATCH_OPCODE;
  2609. OPCODE(OPCODE_ITERATE_INT) {
  2610. CHECK_SPACE(4);
  2611. GET_VARIANT_PTR(counter, 0);
  2612. GET_VARIANT_PTR(container, 1);
  2613. int64_t size = *VariantInternal::get_int(container);
  2614. int64_t *count = VariantInternal::get_int(counter);
  2615. (*count)++;
  2616. if (*count >= size) {
  2617. int jumpto = _code_ptr[ip + 4];
  2618. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2619. ip = jumpto;
  2620. } else {
  2621. GET_VARIANT_PTR(iterator, 2);
  2622. *VariantInternal::get_int(iterator) = *count;
  2623. ip += 5; // Loop again.
  2624. }
  2625. }
  2626. DISPATCH_OPCODE;
  2627. OPCODE(OPCODE_ITERATE_FLOAT) {
  2628. CHECK_SPACE(4);
  2629. GET_VARIANT_PTR(counter, 0);
  2630. GET_VARIANT_PTR(container, 1);
  2631. double size = *VariantInternal::get_float(container);
  2632. double *count = VariantInternal::get_float(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_float(iterator) = *count;
  2641. ip += 5; // Loop again.
  2642. }
  2643. }
  2644. DISPATCH_OPCODE;
  2645. OPCODE(OPCODE_ITERATE_VECTOR2) {
  2646. CHECK_SPACE(4);
  2647. GET_VARIANT_PTR(counter, 0);
  2648. GET_VARIANT_PTR(container, 1);
  2649. const Vector2 *bounds = VariantInternal::get_vector2((const Variant *)container);
  2650. double *count = VariantInternal::get_float(counter);
  2651. (*count)++;
  2652. if (*count >= bounds->y) {
  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_VECTOR2I) {
  2664. CHECK_SPACE(4);
  2665. GET_VARIANT_PTR(counter, 0);
  2666. GET_VARIANT_PTR(container, 1);
  2667. const Vector2i *bounds = VariantInternal::get_vector2i((const Variant *)container);
  2668. int64_t *count = VariantInternal::get_int(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_int(iterator) = *count;
  2677. ip += 5; // Loop again.
  2678. }
  2679. }
  2680. DISPATCH_OPCODE;
  2681. OPCODE(OPCODE_ITERATE_VECTOR3) {
  2682. CHECK_SPACE(4);
  2683. GET_VARIANT_PTR(counter, 0);
  2684. GET_VARIANT_PTR(container, 1);
  2685. const Vector3 *bounds = VariantInternal::get_vector3((const Variant *)container);
  2686. double *count = VariantInternal::get_float(counter);
  2687. *count += bounds->z;
  2688. if ((bounds->z < 0 && *count <= bounds->y) || (bounds->z > 0 && *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_float(iterator) = *count;
  2695. ip += 5; // Loop again.
  2696. }
  2697. }
  2698. DISPATCH_OPCODE;
  2699. OPCODE(OPCODE_ITERATE_VECTOR3I) {
  2700. CHECK_SPACE(4);
  2701. GET_VARIANT_PTR(counter, 0);
  2702. GET_VARIANT_PTR(container, 1);
  2703. const Vector3i *bounds = VariantInternal::get_vector3i((const Variant *)container);
  2704. int64_t *count = VariantInternal::get_int(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_int(iterator) = *count;
  2713. ip += 5; // Loop again.
  2714. }
  2715. }
  2716. DISPATCH_OPCODE;
  2717. OPCODE(OPCODE_ITERATE_STRING) {
  2718. CHECK_SPACE(4);
  2719. GET_VARIANT_PTR(counter, 0);
  2720. GET_VARIANT_PTR(container, 1);
  2721. const String *str = VariantInternal::get_string((const Variant *)container);
  2722. int64_t *idx = VariantInternal::get_int(counter);
  2723. (*idx)++;
  2724. if (*idx >= str->length()) {
  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_string(iterator) = str->substr(*idx, 1);
  2731. ip += 5; // Loop again.
  2732. }
  2733. }
  2734. DISPATCH_OPCODE;
  2735. OPCODE(OPCODE_ITERATE_DICTIONARY) {
  2736. CHECK_SPACE(4);
  2737. GET_VARIANT_PTR(counter, 0);
  2738. GET_VARIANT_PTR(container, 1);
  2739. const Dictionary *dict = VariantInternal::get_dictionary((const Variant *)container);
  2740. const Variant *next = dict->next(counter);
  2741. if (!next) {
  2742. int jumpto = _code_ptr[ip + 4];
  2743. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2744. ip = jumpto;
  2745. } else {
  2746. GET_VARIANT_PTR(iterator, 2);
  2747. *counter = *next;
  2748. *iterator = *next;
  2749. ip += 5; // Loop again.
  2750. }
  2751. }
  2752. DISPATCH_OPCODE;
  2753. OPCODE(OPCODE_ITERATE_ARRAY) {
  2754. CHECK_SPACE(4);
  2755. GET_VARIANT_PTR(counter, 0);
  2756. GET_VARIANT_PTR(container, 1);
  2757. const Array *array = VariantInternal::get_array((const Variant *)container);
  2758. int64_t *idx = VariantInternal::get_int(counter);
  2759. (*idx)++;
  2760. if (*idx >= array->size()) {
  2761. int jumpto = _code_ptr[ip + 4];
  2762. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2763. ip = jumpto;
  2764. } else {
  2765. GET_VARIANT_PTR(iterator, 2);
  2766. *iterator = array->get(*idx);
  2767. ip += 5; // Loop again.
  2768. }
  2769. }
  2770. DISPATCH_OPCODE;
  2771. #define OPCODE_ITERATE_PACKED_ARRAY(m_var_type, m_elem_type, m_get_func, m_ret_get_func) \
  2772. OPCODE(OPCODE_ITERATE_PACKED_##m_var_type##_ARRAY) { \
  2773. CHECK_SPACE(4); \
  2774. GET_VARIANT_PTR(counter, 0); \
  2775. GET_VARIANT_PTR(container, 1); \
  2776. const Vector<m_elem_type> *array = VariantInternal::m_get_func((const Variant *)container); \
  2777. int64_t *idx = VariantInternal::get_int(counter); \
  2778. (*idx)++; \
  2779. if (*idx >= array->size()) { \
  2780. int jumpto = _code_ptr[ip + 4]; \
  2781. GD_ERR_BREAK(jumpto<0 || jumpto> _code_size); \
  2782. ip = jumpto; \
  2783. } else { \
  2784. GET_VARIANT_PTR(iterator, 2); \
  2785. *VariantInternal::m_ret_get_func(iterator) = array->get(*idx); \
  2786. ip += 5; \
  2787. } \
  2788. } \
  2789. DISPATCH_OPCODE
  2790. OPCODE_ITERATE_PACKED_ARRAY(BYTE, uint8_t, get_byte_array, get_int);
  2791. OPCODE_ITERATE_PACKED_ARRAY(INT32, int32_t, get_int32_array, get_int);
  2792. OPCODE_ITERATE_PACKED_ARRAY(INT64, int64_t, get_int64_array, get_int);
  2793. OPCODE_ITERATE_PACKED_ARRAY(FLOAT32, float, get_float32_array, get_float);
  2794. OPCODE_ITERATE_PACKED_ARRAY(FLOAT64, double, get_float64_array, get_float);
  2795. OPCODE_ITERATE_PACKED_ARRAY(STRING, String, get_string_array, get_string);
  2796. OPCODE_ITERATE_PACKED_ARRAY(VECTOR2, Vector2, get_vector2_array, get_vector2);
  2797. OPCODE_ITERATE_PACKED_ARRAY(VECTOR3, Vector3, get_vector3_array, get_vector3);
  2798. OPCODE_ITERATE_PACKED_ARRAY(COLOR, Color, get_color_array, get_color);
  2799. OPCODE(OPCODE_ITERATE_OBJECT) {
  2800. CHECK_SPACE(4);
  2801. GET_VARIANT_PTR(counter, 0);
  2802. GET_VARIANT_PTR(container, 1);
  2803. #ifdef DEBUG_ENABLED
  2804. bool freed = false;
  2805. Object *obj = container->get_validated_object_with_check(freed);
  2806. if (freed) {
  2807. err_text = "Trying to iterate on a previously freed object.";
  2808. OPCODE_BREAK;
  2809. } else if (!obj) {
  2810. err_text = "Trying to iterate on a null value.";
  2811. OPCODE_BREAK;
  2812. }
  2813. #else
  2814. Object *obj = *VariantInternal::get_object(container);
  2815. #endif
  2816. Array ref;
  2817. ref.push_back(*counter);
  2818. Variant vref;
  2819. VariantInternal::initialize(&vref, Variant::ARRAY);
  2820. *VariantInternal::get_array(&vref) = ref;
  2821. Variant **args = instruction_args; // Overriding an instruction argument, but we don't need access to that anymore.
  2822. args[0] = &vref;
  2823. Callable::CallError ce;
  2824. Variant has_next = obj->callp(CoreStringNames::get_singleton()->_iter_next, (const Variant **)args, 1, ce);
  2825. #ifdef DEBUG_ENABLED
  2826. if (ce.error != Callable::CallError::CALL_OK) {
  2827. err_text = vformat(R"(There was an error calling "_iter_next" on iterator object of type %s.)", *container);
  2828. OPCODE_BREAK;
  2829. }
  2830. #endif
  2831. if (!has_next.booleanize()) {
  2832. int jumpto = _code_ptr[ip + 4];
  2833. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2834. ip = jumpto;
  2835. } else {
  2836. GET_VARIANT_PTR(iterator, 2);
  2837. *iterator = obj->callp(CoreStringNames::get_singleton()->_iter_get, (const Variant **)args, 1, ce);
  2838. #ifdef DEBUG_ENABLED
  2839. if (ce.error != Callable::CallError::CALL_OK) {
  2840. err_text = vformat(R"(There was an error calling "_iter_get" on iterator object of type %s.)", *container);
  2841. OPCODE_BREAK;
  2842. }
  2843. #endif
  2844. ip += 5; // Loop again.
  2845. }
  2846. }
  2847. DISPATCH_OPCODE;
  2848. OPCODE(OPCODE_STORE_GLOBAL) {
  2849. CHECK_SPACE(3);
  2850. int global_idx = _code_ptr[ip + 2];
  2851. GD_ERR_BREAK(global_idx < 0 || global_idx >= GDScriptLanguage::get_singleton()->get_global_array_size());
  2852. GET_VARIANT_PTR(dst, 0);
  2853. *dst = GDScriptLanguage::get_singleton()->get_global_array()[global_idx];
  2854. ip += 3;
  2855. }
  2856. DISPATCH_OPCODE;
  2857. OPCODE(OPCODE_STORE_NAMED_GLOBAL) {
  2858. CHECK_SPACE(3);
  2859. int globalname_idx = _code_ptr[ip + 2];
  2860. GD_ERR_BREAK(globalname_idx < 0 || globalname_idx >= _global_names_count);
  2861. const StringName *globalname = &_global_names_ptr[globalname_idx];
  2862. GD_ERR_BREAK(!GDScriptLanguage::get_singleton()->get_named_globals_map().has(*globalname));
  2863. GET_VARIANT_PTR(dst, 0);
  2864. *dst = GDScriptLanguage::get_singleton()->get_named_globals_map()[*globalname];
  2865. ip += 3;
  2866. }
  2867. DISPATCH_OPCODE;
  2868. #define OPCODE_TYPE_ADJUST(m_v_type, m_c_type) \
  2869. OPCODE(OPCODE_TYPE_ADJUST_##m_v_type) { \
  2870. CHECK_SPACE(2); \
  2871. GET_VARIANT_PTR(arg, 0); \
  2872. VariantTypeAdjust<m_c_type>::adjust(arg); \
  2873. ip += 2; \
  2874. } \
  2875. DISPATCH_OPCODE
  2876. OPCODE_TYPE_ADJUST(BOOL, bool);
  2877. OPCODE_TYPE_ADJUST(INT, int64_t);
  2878. OPCODE_TYPE_ADJUST(FLOAT, double);
  2879. OPCODE_TYPE_ADJUST(STRING, String);
  2880. OPCODE_TYPE_ADJUST(VECTOR2, Vector2);
  2881. OPCODE_TYPE_ADJUST(VECTOR2I, Vector2i);
  2882. OPCODE_TYPE_ADJUST(RECT2, Rect2);
  2883. OPCODE_TYPE_ADJUST(RECT2I, Rect2i);
  2884. OPCODE_TYPE_ADJUST(VECTOR3, Vector3);
  2885. OPCODE_TYPE_ADJUST(VECTOR3I, Vector3i);
  2886. OPCODE_TYPE_ADJUST(TRANSFORM2D, Transform2D);
  2887. OPCODE_TYPE_ADJUST(VECTOR4, Vector4);
  2888. OPCODE_TYPE_ADJUST(VECTOR4I, Vector4i);
  2889. OPCODE_TYPE_ADJUST(PLANE, Plane);
  2890. OPCODE_TYPE_ADJUST(QUATERNION, Quaternion);
  2891. OPCODE_TYPE_ADJUST(AABB, AABB);
  2892. OPCODE_TYPE_ADJUST(BASIS, Basis);
  2893. OPCODE_TYPE_ADJUST(TRANSFORM3D, Transform3D);
  2894. OPCODE_TYPE_ADJUST(PROJECTION, Projection);
  2895. OPCODE_TYPE_ADJUST(COLOR, Color);
  2896. OPCODE_TYPE_ADJUST(STRING_NAME, StringName);
  2897. OPCODE_TYPE_ADJUST(NODE_PATH, NodePath);
  2898. OPCODE_TYPE_ADJUST(RID, RID);
  2899. OPCODE_TYPE_ADJUST(OBJECT, Object *);
  2900. OPCODE_TYPE_ADJUST(CALLABLE, Callable);
  2901. OPCODE_TYPE_ADJUST(SIGNAL, Signal);
  2902. OPCODE_TYPE_ADJUST(DICTIONARY, Dictionary);
  2903. OPCODE_TYPE_ADJUST(ARRAY, Array);
  2904. OPCODE_TYPE_ADJUST(PACKED_BYTE_ARRAY, PackedByteArray);
  2905. OPCODE_TYPE_ADJUST(PACKED_INT32_ARRAY, PackedInt32Array);
  2906. OPCODE_TYPE_ADJUST(PACKED_INT64_ARRAY, PackedInt64Array);
  2907. OPCODE_TYPE_ADJUST(PACKED_FLOAT32_ARRAY, PackedFloat32Array);
  2908. OPCODE_TYPE_ADJUST(PACKED_FLOAT64_ARRAY, PackedFloat64Array);
  2909. OPCODE_TYPE_ADJUST(PACKED_STRING_ARRAY, PackedStringArray);
  2910. OPCODE_TYPE_ADJUST(PACKED_VECTOR2_ARRAY, PackedVector2Array);
  2911. OPCODE_TYPE_ADJUST(PACKED_VECTOR3_ARRAY, PackedVector3Array);
  2912. OPCODE_TYPE_ADJUST(PACKED_COLOR_ARRAY, PackedColorArray);
  2913. OPCODE(OPCODE_ASSERT) {
  2914. CHECK_SPACE(3);
  2915. #ifdef DEBUG_ENABLED
  2916. GET_VARIANT_PTR(test, 0);
  2917. bool result = test->booleanize();
  2918. if (!result) {
  2919. String message_str;
  2920. if (_code_ptr[ip + 2] != 0) {
  2921. GET_VARIANT_PTR(message, 1);
  2922. Variant message_var = *message;
  2923. if (message->get_type() != Variant::NIL) {
  2924. message_str = message_var;
  2925. }
  2926. }
  2927. if (message_str.is_empty()) {
  2928. err_text = "Assertion failed.";
  2929. } else {
  2930. err_text = "Assertion failed: " + message_str;
  2931. }
  2932. OPCODE_BREAK;
  2933. }
  2934. #endif
  2935. ip += 3;
  2936. }
  2937. DISPATCH_OPCODE;
  2938. OPCODE(OPCODE_BREAKPOINT) {
  2939. #ifdef DEBUG_ENABLED
  2940. if (EngineDebugger::is_active()) {
  2941. GDScriptLanguage::get_singleton()->debug_break("Breakpoint Statement", true);
  2942. }
  2943. #endif
  2944. ip += 1;
  2945. }
  2946. DISPATCH_OPCODE;
  2947. OPCODE(OPCODE_LINE) {
  2948. CHECK_SPACE(2);
  2949. line = _code_ptr[ip + 1];
  2950. ip += 2;
  2951. if (EngineDebugger::is_active()) {
  2952. // line
  2953. bool do_break = false;
  2954. if (unlikely(EngineDebugger::get_script_debugger()->get_lines_left() > 0)) {
  2955. if (EngineDebugger::get_script_debugger()->get_depth() <= 0) {
  2956. EngineDebugger::get_script_debugger()->set_lines_left(EngineDebugger::get_script_debugger()->get_lines_left() - 1);
  2957. }
  2958. if (EngineDebugger::get_script_debugger()->get_lines_left() <= 0) {
  2959. do_break = true;
  2960. }
  2961. }
  2962. if (EngineDebugger::get_script_debugger()->is_breakpoint(line, source)) {
  2963. do_break = true;
  2964. }
  2965. if (unlikely(do_break)) {
  2966. GDScriptLanguage::get_singleton()->debug_break("Breakpoint", true);
  2967. }
  2968. EngineDebugger::get_singleton()->line_poll();
  2969. }
  2970. }
  2971. DISPATCH_OPCODE;
  2972. OPCODE(OPCODE_END) {
  2973. #ifdef DEBUG_ENABLED
  2974. exit_ok = true;
  2975. #endif
  2976. OPCODE_BREAK;
  2977. }
  2978. #if 0 // Enable for debugging.
  2979. default: {
  2980. err_text = "Illegal opcode " + itos(_code_ptr[ip]) + " at address " + itos(ip);
  2981. OPCODE_BREAK;
  2982. }
  2983. #endif
  2984. }
  2985. OPCODES_END
  2986. #ifdef DEBUG_ENABLED
  2987. if (exit_ok) {
  2988. OPCODE_OUT;
  2989. }
  2990. //error
  2991. // function, file, line, error, explanation
  2992. String err_file;
  2993. bool instance_valid_with_script = p_instance && ObjectDB::get_instance(p_instance->owner_id) != nullptr && p_instance->script->is_valid();
  2994. if (instance_valid_with_script && !get_script()->path.is_empty()) {
  2995. err_file = get_script()->path;
  2996. } else if (script) {
  2997. err_file = script->path;
  2998. }
  2999. if (err_file.is_empty()) {
  3000. err_file = "<built-in>";
  3001. }
  3002. String err_func = name;
  3003. if (instance_valid_with_script && p_instance->script->local_name != StringName()) {
  3004. err_func = p_instance->script->local_name.operator String() + "." + err_func;
  3005. }
  3006. int err_line = line;
  3007. if (err_text.is_empty()) {
  3008. err_text = "Internal script error! Opcode: " + itos(last_opcode) + " (please report).";
  3009. }
  3010. if (!GDScriptLanguage::get_singleton()->debug_break(err_text, false)) {
  3011. // debugger break did not happen
  3012. _err_print_error(err_func.utf8().get_data(), err_file.utf8().get_data(), err_line, err_text.utf8().get_data(), false, ERR_HANDLER_SCRIPT);
  3013. }
  3014. // Get a default return type in case of failure
  3015. retvalue = _get_default_variant_for_data_type(return_type);
  3016. #endif
  3017. OPCODE_OUT;
  3018. }
  3019. OPCODES_OUT
  3020. #ifdef DEBUG_ENABLED
  3021. if (GDScriptLanguage::get_singleton()->profiling) {
  3022. uint64_t time_taken = OS::get_singleton()->get_ticks_usec() - function_start_time;
  3023. profile.total_time.add(time_taken);
  3024. profile.self_time.add(time_taken - function_call_time);
  3025. profile.frame_total_time.add(time_taken);
  3026. profile.frame_self_time.add(time_taken - function_call_time);
  3027. if (Thread::get_caller_id() == Thread::get_main_id()) {
  3028. GDScriptLanguage::get_singleton()->script_frame_time += time_taken - function_call_time;
  3029. }
  3030. }
  3031. // Check if this is not the last time it was interrupted by `await` or if it's the first time executing.
  3032. // If that is the case then we exit the function as normal. Otherwise we postpone it until the last `await` is completed.
  3033. // This ensures the call stack can be properly shown when using `await`, showing what resumed the function.
  3034. if (!p_state || awaited) {
  3035. if (EngineDebugger::is_active()) {
  3036. GDScriptLanguage::get_singleton()->exit_function();
  3037. }
  3038. #endif
  3039. // Free stack, except reserved addresses.
  3040. for (int i = FIXED_ADDRESSES_MAX; i < _stack_size; i++) {
  3041. stack[i].~Variant();
  3042. }
  3043. #ifdef DEBUG_ENABLED
  3044. }
  3045. #endif
  3046. // Always free reserved addresses, since they are never copied.
  3047. for (int i = 0; i < FIXED_ADDRESSES_MAX; i++) {
  3048. stack[i].~Variant();
  3049. }
  3050. call_depth--;
  3051. return retvalue;
  3052. }