gdscript_vm.cpp 117 KB

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