gdscript_vm.cpp 119 KB

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