gdscript_vm.cpp 121 KB

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