gdscript_vm.cpp 121 KB

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