gdscript_vm.cpp 121 KB

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