gdscript_vm.cpp 114 KB

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