gdscript_vm.cpp 116 KB

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