2
0

gdscript_vm.cpp 114 KB

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