gdscript_vm.cpp 117 KB

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