gdscript_vm.cpp 108 KB

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