2
0

gdscript_vm.cpp 131 KB

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