gdscript_vm.cpp 131 KB

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