gdscript_vm.cpp 120 KB

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