gdscript_vm.cpp 130 KB

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