gdscript_vm.cpp 116 KB

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