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