gdscript_vm.cpp 130 KB

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