gdscript_vm.cpp 122 KB

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