gdscript_vm.cpp 118 KB

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