gdscript_vm.cpp 118 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633
  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. if (src->get_type() == Variant::OBJECT) {
  1119. bool was_freed = false;
  1120. Object *src_obj = src->get_validated_object_with_check(was_freed);
  1121. if (!src_obj && was_freed) {
  1122. err_text = "Trying to assign invalid previously freed instance.";
  1123. OPCODE_BREAK;
  1124. }
  1125. if (src_obj && !ClassDB::is_parent_class(src_obj->get_class_name(), nc->get_name())) {
  1126. err_text = "Trying to assign value of type '" + src_obj->get_class_name() +
  1127. "' to a variable of type '" + nc->get_name() + "'.";
  1128. OPCODE_BREAK;
  1129. }
  1130. }
  1131. #endif // DEBUG_ENABLED
  1132. *dst = *src;
  1133. ip += 4;
  1134. }
  1135. DISPATCH_OPCODE;
  1136. OPCODE(OPCODE_ASSIGN_TYPED_SCRIPT) {
  1137. CHECK_SPACE(4);
  1138. GET_VARIANT_PTR(dst, 0);
  1139. GET_VARIANT_PTR(src, 1);
  1140. #ifdef DEBUG_ENABLED
  1141. GET_VARIANT_PTR(type, 2);
  1142. Script *base_type = Object::cast_to<Script>(type->operator Object *());
  1143. GD_ERR_BREAK(!base_type);
  1144. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  1145. err_text = "Trying to assign a non-object value to a variable of type '" + base_type->get_path().get_file() + "'.";
  1146. OPCODE_BREAK;
  1147. }
  1148. if (src->get_type() == Variant::OBJECT) {
  1149. bool was_freed = false;
  1150. Object *val_obj = src->get_validated_object_with_check(was_freed);
  1151. if (!val_obj && was_freed) {
  1152. err_text = "Trying to assign invalid previously freed instance.";
  1153. OPCODE_BREAK;
  1154. }
  1155. ScriptInstance *scr_inst = val_obj->get_script_instance();
  1156. if (!scr_inst) {
  1157. err_text = "Trying to assign value of type '" + val_obj->get_class_name() +
  1158. "' to a variable of type '" + base_type->get_path().get_file() + "'.";
  1159. OPCODE_BREAK;
  1160. }
  1161. Script *src_type = val_obj->get_script_instance()->get_script().ptr();
  1162. bool valid = false;
  1163. while (src_type) {
  1164. if (src_type == base_type) {
  1165. valid = true;
  1166. break;
  1167. }
  1168. src_type = src_type->get_base_script().ptr();
  1169. }
  1170. if (!valid) {
  1171. err_text = "Trying to assign value of type '" + val_obj->get_script_instance()->get_script()->get_path().get_file() +
  1172. "' to a variable of type '" + base_type->get_path().get_file() + "'.";
  1173. OPCODE_BREAK;
  1174. }
  1175. }
  1176. #endif // DEBUG_ENABLED
  1177. *dst = *src;
  1178. ip += 4;
  1179. }
  1180. DISPATCH_OPCODE;
  1181. OPCODE(OPCODE_CAST_TO_BUILTIN) {
  1182. CHECK_SPACE(4);
  1183. GET_VARIANT_PTR(src, 0);
  1184. GET_VARIANT_PTR(dst, 1);
  1185. Variant::Type to_type = (Variant::Type)_code_ptr[ip + 3];
  1186. GD_ERR_BREAK(to_type < 0 || to_type >= Variant::VARIANT_MAX);
  1187. #ifdef DEBUG_ENABLED
  1188. if (src->operator Object *() && !src->get_validated_object()) {
  1189. err_text = "Trying to cast a freed object.";
  1190. OPCODE_BREAK;
  1191. }
  1192. #endif
  1193. Callable::CallError err;
  1194. Variant::construct(to_type, *dst, (const Variant **)&src, 1, err);
  1195. #ifdef DEBUG_ENABLED
  1196. if (err.error != Callable::CallError::CALL_OK) {
  1197. err_text = "Invalid cast: could not convert value to '" + Variant::get_type_name(to_type) + "'.";
  1198. OPCODE_BREAK;
  1199. }
  1200. #endif
  1201. ip += 4;
  1202. }
  1203. DISPATCH_OPCODE;
  1204. OPCODE(OPCODE_CAST_TO_NATIVE) {
  1205. CHECK_SPACE(4);
  1206. GET_VARIANT_PTR(src, 0);
  1207. GET_VARIANT_PTR(dst, 1);
  1208. GET_VARIANT_PTR(to_type, 2);
  1209. GDScriptNativeClass *nc = Object::cast_to<GDScriptNativeClass>(to_type->operator Object *());
  1210. GD_ERR_BREAK(!nc);
  1211. #ifdef DEBUG_ENABLED
  1212. if (src->operator Object *() && !src->get_validated_object()) {
  1213. err_text = "Trying to cast a freed object.";
  1214. OPCODE_BREAK;
  1215. }
  1216. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  1217. err_text = "Invalid cast: can't convert a non-object value to an object type.";
  1218. OPCODE_BREAK;
  1219. }
  1220. #endif
  1221. Object *src_obj = src->operator Object *();
  1222. if (src_obj && !ClassDB::is_parent_class(src_obj->get_class_name(), nc->get_name())) {
  1223. *dst = Variant(); // invalid cast, assign NULL
  1224. } else {
  1225. *dst = *src;
  1226. }
  1227. ip += 4;
  1228. }
  1229. DISPATCH_OPCODE;
  1230. OPCODE(OPCODE_CAST_TO_SCRIPT) {
  1231. CHECK_SPACE(4);
  1232. GET_VARIANT_PTR(src, 0);
  1233. GET_VARIANT_PTR(dst, 1);
  1234. GET_VARIANT_PTR(to_type, 2);
  1235. Script *base_type = Object::cast_to<Script>(to_type->operator Object *());
  1236. GD_ERR_BREAK(!base_type);
  1237. #ifdef DEBUG_ENABLED
  1238. if (src->operator Object *() && !src->get_validated_object()) {
  1239. err_text = "Trying to cast a freed object.";
  1240. OPCODE_BREAK;
  1241. }
  1242. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  1243. err_text = "Trying to assign a non-object value to a variable of type '" + base_type->get_path().get_file() + "'.";
  1244. OPCODE_BREAK;
  1245. }
  1246. #endif
  1247. bool valid = false;
  1248. if (src->get_type() != Variant::NIL && src->operator Object *() != nullptr) {
  1249. ScriptInstance *scr_inst = src->operator Object *()->get_script_instance();
  1250. if (scr_inst) {
  1251. Script *src_type = src->operator Object *()->get_script_instance()->get_script().ptr();
  1252. while (src_type) {
  1253. if (src_type == base_type) {
  1254. valid = true;
  1255. break;
  1256. }
  1257. src_type = src_type->get_base_script().ptr();
  1258. }
  1259. }
  1260. }
  1261. if (valid) {
  1262. *dst = *src; // Valid cast, copy the source object
  1263. } else {
  1264. *dst = Variant(); // invalid cast, assign NULL
  1265. }
  1266. ip += 4;
  1267. }
  1268. DISPATCH_OPCODE;
  1269. OPCODE(OPCODE_CONSTRUCT) {
  1270. LOAD_INSTRUCTION_ARGS
  1271. CHECK_SPACE(2 + instr_arg_count);
  1272. ip += instr_arg_count;
  1273. int argc = _code_ptr[ip + 1];
  1274. Variant::Type t = Variant::Type(_code_ptr[ip + 2]);
  1275. Variant **argptrs = instruction_args;
  1276. GET_INSTRUCTION_ARG(dst, argc);
  1277. Callable::CallError err;
  1278. Variant::construct(t, *dst, (const Variant **)argptrs, argc, err);
  1279. #ifdef DEBUG_ENABLED
  1280. if (err.error != Callable::CallError::CALL_OK) {
  1281. err_text = _get_call_error(err, "'" + Variant::get_type_name(t) + "' constructor", (const Variant **)argptrs);
  1282. OPCODE_BREAK;
  1283. }
  1284. #endif
  1285. ip += 3;
  1286. }
  1287. DISPATCH_OPCODE;
  1288. OPCODE(OPCODE_CONSTRUCT_VALIDATED) {
  1289. LOAD_INSTRUCTION_ARGS
  1290. CHECK_SPACE(2 + instr_arg_count);
  1291. ip += instr_arg_count;
  1292. int argc = _code_ptr[ip + 1];
  1293. int constructor_idx = _code_ptr[ip + 2];
  1294. GD_ERR_BREAK(constructor_idx < 0 || constructor_idx >= _constructors_count);
  1295. Variant::ValidatedConstructor constructor = _constructors_ptr[constructor_idx];
  1296. Variant **argptrs = instruction_args;
  1297. GET_INSTRUCTION_ARG(dst, argc);
  1298. constructor(dst, (const Variant **)argptrs);
  1299. ip += 3;
  1300. }
  1301. DISPATCH_OPCODE;
  1302. OPCODE(OPCODE_CONSTRUCT_ARRAY) {
  1303. LOAD_INSTRUCTION_ARGS
  1304. CHECK_SPACE(1 + instr_arg_count);
  1305. ip += instr_arg_count;
  1306. int argc = _code_ptr[ip + 1];
  1307. Array array;
  1308. array.resize(argc);
  1309. for (int i = 0; i < argc; i++) {
  1310. array[i] = *(instruction_args[i]);
  1311. }
  1312. GET_INSTRUCTION_ARG(dst, argc);
  1313. *dst = Variant(); // Clear potential previous typed array.
  1314. *dst = array;
  1315. ip += 2;
  1316. }
  1317. DISPATCH_OPCODE;
  1318. OPCODE(OPCODE_CONSTRUCT_TYPED_ARRAY) {
  1319. LOAD_INSTRUCTION_ARGS
  1320. CHECK_SPACE(3 + instr_arg_count);
  1321. ip += instr_arg_count;
  1322. int argc = _code_ptr[ip + 1];
  1323. GET_INSTRUCTION_ARG(script_type, argc + 1);
  1324. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 2];
  1325. int native_type_idx = _code_ptr[ip + 3];
  1326. GD_ERR_BREAK(native_type_idx < 0 || native_type_idx >= _global_names_count);
  1327. const StringName native_type = _global_names_ptr[native_type_idx];
  1328. Array array;
  1329. array.resize(argc);
  1330. for (int i = 0; i < argc; i++) {
  1331. array[i] = *(instruction_args[i]);
  1332. }
  1333. GET_INSTRUCTION_ARG(dst, argc);
  1334. *dst = Variant(); // Clear potential previous typed array.
  1335. *dst = Array(array, builtin_type, native_type, *script_type);
  1336. ip += 4;
  1337. }
  1338. DISPATCH_OPCODE;
  1339. OPCODE(OPCODE_CONSTRUCT_DICTIONARY) {
  1340. LOAD_INSTRUCTION_ARGS
  1341. CHECK_SPACE(2 + instr_arg_count);
  1342. ip += instr_arg_count;
  1343. int argc = _code_ptr[ip + 1];
  1344. Dictionary dict;
  1345. for (int i = 0; i < argc; i++) {
  1346. GET_INSTRUCTION_ARG(k, i * 2 + 0);
  1347. GET_INSTRUCTION_ARG(v, i * 2 + 1);
  1348. dict[*k] = *v;
  1349. }
  1350. GET_INSTRUCTION_ARG(dst, argc * 2);
  1351. *dst = dict;
  1352. ip += 2;
  1353. }
  1354. DISPATCH_OPCODE;
  1355. OPCODE(OPCODE_CALL_ASYNC)
  1356. OPCODE(OPCODE_CALL_RETURN)
  1357. OPCODE(OPCODE_CALL) {
  1358. bool call_ret = (_code_ptr[ip]) != OPCODE_CALL;
  1359. #ifdef DEBUG_ENABLED
  1360. bool call_async = (_code_ptr[ip]) == OPCODE_CALL_ASYNC;
  1361. #endif
  1362. LOAD_INSTRUCTION_ARGS
  1363. CHECK_SPACE(3 + instr_arg_count);
  1364. ip += instr_arg_count;
  1365. int argc = _code_ptr[ip + 1];
  1366. GD_ERR_BREAK(argc < 0);
  1367. int methodname_idx = _code_ptr[ip + 2];
  1368. GD_ERR_BREAK(methodname_idx < 0 || methodname_idx >= _global_names_count);
  1369. const StringName *methodname = &_global_names_ptr[methodname_idx];
  1370. GET_INSTRUCTION_ARG(base, argc);
  1371. Variant **argptrs = instruction_args;
  1372. #ifdef DEBUG_ENABLED
  1373. uint64_t call_time = 0;
  1374. if (GDScriptLanguage::get_singleton()->profiling) {
  1375. call_time = OS::get_singleton()->get_ticks_usec();
  1376. }
  1377. #endif
  1378. Callable::CallError err;
  1379. if (call_ret) {
  1380. GET_INSTRUCTION_ARG(ret, argc + 1);
  1381. #ifdef DEBUG_ENABLED
  1382. Variant::Type base_type = base->get_type();
  1383. Object *base_obj = base->get_validated_object();
  1384. StringName base_class = base_obj ? base_obj->get_class_name() : StringName();
  1385. #endif
  1386. base->callp(*methodname, (const Variant **)argptrs, argc, *ret, err);
  1387. #ifdef DEBUG_ENABLED
  1388. if (ret->get_type() == Variant::NIL) {
  1389. if (base_type == Variant::OBJECT) {
  1390. if (base_obj) {
  1391. MethodBind *method = ClassDB::get_method(base_class, *methodname);
  1392. if (*methodname == CoreStringNames::get_singleton()->_free || (method && !method->has_return())) {
  1393. err_text = R"(Trying to get a return value of a method that returns "void")";
  1394. OPCODE_BREAK;
  1395. }
  1396. }
  1397. } else if (Variant::has_builtin_method(base_type, *methodname) && !Variant::has_builtin_method_return_value(base_type, *methodname)) {
  1398. err_text = R"(Trying to get a return value of a method that returns "void")";
  1399. OPCODE_BREAK;
  1400. }
  1401. }
  1402. if (!call_async && ret->get_type() == Variant::OBJECT) {
  1403. // Check if getting a function state without await.
  1404. bool was_freed = false;
  1405. Object *obj = ret->get_validated_object_with_check(was_freed);
  1406. if (was_freed) {
  1407. err_text = "Got a freed object as a result of the call.";
  1408. OPCODE_BREAK;
  1409. }
  1410. if (obj && obj->is_class_ptr(GDScriptFunctionState::get_class_ptr_static())) {
  1411. err_text = R"(Trying to call an async function without "await".)";
  1412. OPCODE_BREAK;
  1413. }
  1414. }
  1415. #endif
  1416. } else {
  1417. Variant ret;
  1418. base->callp(*methodname, (const Variant **)argptrs, argc, ret, err);
  1419. }
  1420. #ifdef DEBUG_ENABLED
  1421. if (GDScriptLanguage::get_singleton()->profiling) {
  1422. function_call_time += OS::get_singleton()->get_ticks_usec() - call_time;
  1423. }
  1424. if (err.error != Callable::CallError::CALL_OK) {
  1425. String methodstr = *methodname;
  1426. String basestr = _get_var_type(base);
  1427. bool is_callable = false;
  1428. if (methodstr == "call") {
  1429. if (argc >= 1 && base->get_type() != Variant::CALLABLE) {
  1430. methodstr = String(*argptrs[0]) + " (via call)";
  1431. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  1432. err.argument += 1;
  1433. }
  1434. } else {
  1435. methodstr = base->operator String() + " (Callable)";
  1436. is_callable = true;
  1437. }
  1438. } else if (methodstr == "free") {
  1439. if (err.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  1440. if (base->is_ref_counted()) {
  1441. err_text = "Attempted to free a reference.";
  1442. OPCODE_BREAK;
  1443. } else if (base->get_type() == Variant::OBJECT) {
  1444. err_text = "Attempted to free a locked object (calling or emitting).";
  1445. OPCODE_BREAK;
  1446. }
  1447. }
  1448. } else if (methodstr == "call_recursive" && basestr == "TreeItem") {
  1449. if (argc >= 1) {
  1450. methodstr = String(*argptrs[0]) + " (via TreeItem.call_recursive)";
  1451. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  1452. err.argument += 1;
  1453. }
  1454. }
  1455. }
  1456. err_text = _get_call_error(err, "function '" + methodstr + (is_callable ? "" : "' in base '" + basestr) + "'", (const Variant **)argptrs);
  1457. OPCODE_BREAK;
  1458. }
  1459. #endif
  1460. ip += 3;
  1461. }
  1462. DISPATCH_OPCODE;
  1463. OPCODE(OPCODE_CALL_METHOD_BIND)
  1464. OPCODE(OPCODE_CALL_METHOD_BIND_RET) {
  1465. bool call_ret = (_code_ptr[ip]) == OPCODE_CALL_METHOD_BIND_RET;
  1466. LOAD_INSTRUCTION_ARGS
  1467. CHECK_SPACE(3 + instr_arg_count);
  1468. ip += instr_arg_count;
  1469. int argc = _code_ptr[ip + 1];
  1470. GD_ERR_BREAK(argc < 0);
  1471. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1472. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1473. GET_INSTRUCTION_ARG(base, argc);
  1474. #ifdef DEBUG_ENABLED
  1475. bool freed = false;
  1476. Object *base_obj = base->get_validated_object_with_check(freed);
  1477. if (freed) {
  1478. err_text = METHOD_CALL_ON_FREED_INSTANCE_ERROR(method);
  1479. OPCODE_BREAK;
  1480. } else if (!base_obj) {
  1481. err_text = METHOD_CALL_ON_NULL_VALUE_ERROR(method);
  1482. OPCODE_BREAK;
  1483. }
  1484. #else
  1485. Object *base_obj = base->operator Object *();
  1486. #endif
  1487. Variant **argptrs = instruction_args;
  1488. #ifdef DEBUG_ENABLED
  1489. uint64_t call_time = 0;
  1490. if (GDScriptLanguage::get_singleton()->profiling) {
  1491. call_time = OS::get_singleton()->get_ticks_usec();
  1492. }
  1493. #endif
  1494. Callable::CallError err;
  1495. if (call_ret) {
  1496. GET_INSTRUCTION_ARG(ret, argc + 1);
  1497. *ret = method->call(base_obj, (const Variant **)argptrs, argc, err);
  1498. } else {
  1499. method->call(base_obj, (const Variant **)argptrs, argc, err);
  1500. }
  1501. #ifdef DEBUG_ENABLED
  1502. if (GDScriptLanguage::get_singleton()->profiling) {
  1503. function_call_time += OS::get_singleton()->get_ticks_usec() - call_time;
  1504. }
  1505. if (err.error != Callable::CallError::CALL_OK) {
  1506. String methodstr = method->get_name();
  1507. String basestr = _get_var_type(base);
  1508. if (methodstr == "call") {
  1509. if (argc >= 1) {
  1510. methodstr = String(*argptrs[0]) + " (via call)";
  1511. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  1512. err.argument += 1;
  1513. }
  1514. }
  1515. } else if (methodstr == "free") {
  1516. if (err.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  1517. if (base->is_ref_counted()) {
  1518. err_text = "Attempted to free a reference.";
  1519. OPCODE_BREAK;
  1520. } else if (base->get_type() == Variant::OBJECT) {
  1521. err_text = "Attempted to free a locked object (calling or emitting).";
  1522. OPCODE_BREAK;
  1523. }
  1524. }
  1525. }
  1526. err_text = _get_call_error(err, "function '" + methodstr + "' in base '" + basestr + "'", (const Variant **)argptrs);
  1527. OPCODE_BREAK;
  1528. }
  1529. #endif
  1530. ip += 3;
  1531. }
  1532. DISPATCH_OPCODE;
  1533. OPCODE(OPCODE_CALL_BUILTIN_STATIC) {
  1534. LOAD_INSTRUCTION_ARGS
  1535. CHECK_SPACE(4 + instr_arg_count);
  1536. ip += instr_arg_count;
  1537. GD_ERR_BREAK(_code_ptr[ip + 1] < 0 || _code_ptr[ip + 1] >= Variant::VARIANT_MAX);
  1538. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 1];
  1539. int methodname_idx = _code_ptr[ip + 2];
  1540. GD_ERR_BREAK(methodname_idx < 0 || methodname_idx >= _global_names_count);
  1541. const StringName *methodname = &_global_names_ptr[methodname_idx];
  1542. int argc = _code_ptr[ip + 3];
  1543. GD_ERR_BREAK(argc < 0);
  1544. GET_INSTRUCTION_ARG(ret, argc);
  1545. const Variant **argptrs = const_cast<const Variant **>(instruction_args);
  1546. #ifdef DEBUG_ENABLED
  1547. uint64_t call_time = 0;
  1548. if (GDScriptLanguage::get_singleton()->profiling) {
  1549. call_time = OS::get_singleton()->get_ticks_usec();
  1550. }
  1551. #endif
  1552. Callable::CallError err;
  1553. Variant::call_static(builtin_type, *methodname, argptrs, argc, *ret, err);
  1554. #ifdef DEBUG_ENABLED
  1555. if (GDScriptLanguage::get_singleton()->profiling) {
  1556. function_call_time += OS::get_singleton()->get_ticks_usec() - call_time;
  1557. }
  1558. if (err.error != Callable::CallError::CALL_OK) {
  1559. err_text = _get_call_error(err, "static function '" + methodname->operator String() + "' in type '" + Variant::get_type_name(builtin_type) + "'", argptrs);
  1560. OPCODE_BREAK;
  1561. }
  1562. #endif
  1563. ip += 4;
  1564. }
  1565. DISPATCH_OPCODE;
  1566. OPCODE(OPCODE_CALL_NATIVE_STATIC) {
  1567. LOAD_INSTRUCTION_ARGS
  1568. CHECK_SPACE(3 + instr_arg_count);
  1569. ip += instr_arg_count;
  1570. GD_ERR_BREAK(_code_ptr[ip + 1] < 0 || _code_ptr[ip + 1] >= _methods_count);
  1571. MethodBind *method = _methods_ptr[_code_ptr[ip + 1]];
  1572. int argc = _code_ptr[ip + 2];
  1573. GD_ERR_BREAK(argc < 0);
  1574. GET_INSTRUCTION_ARG(ret, argc);
  1575. const Variant **argptrs = const_cast<const Variant **>(instruction_args);
  1576. #ifdef DEBUG_ENABLED
  1577. uint64_t call_time = 0;
  1578. if (GDScriptLanguage::get_singleton()->profiling) {
  1579. call_time = OS::get_singleton()->get_ticks_usec();
  1580. }
  1581. #endif
  1582. Callable::CallError err;
  1583. *ret = method->call(nullptr, argptrs, argc, err);
  1584. #ifdef DEBUG_ENABLED
  1585. if (GDScriptLanguage::get_singleton()->profiling) {
  1586. function_call_time += OS::get_singleton()->get_ticks_usec() - call_time;
  1587. }
  1588. if (err.error != Callable::CallError::CALL_OK) {
  1589. err_text = _get_call_error(err, "static function '" + method->get_name().operator String() + "' in type '" + method->get_instance_class().operator String() + "'", argptrs);
  1590. OPCODE_BREAK;
  1591. }
  1592. #endif
  1593. ip += 3;
  1594. }
  1595. DISPATCH_OPCODE;
  1596. #ifdef DEBUG_ENABLED
  1597. #define OPCODE_CALL_PTR(m_type) \
  1598. OPCODE(OPCODE_CALL_PTRCALL_##m_type) { \
  1599. LOAD_INSTRUCTION_ARGS \
  1600. CHECK_SPACE(3 + instr_arg_count); \
  1601. ip += instr_arg_count; \
  1602. int argc = _code_ptr[ip + 1]; \
  1603. GD_ERR_BREAK(argc < 0); \
  1604. GET_INSTRUCTION_ARG(base, argc); \
  1605. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count); \
  1606. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]]; \
  1607. bool freed = false; \
  1608. Object *base_obj = base->get_validated_object_with_check(freed); \
  1609. if (freed) { \
  1610. err_text = METHOD_CALL_ON_FREED_INSTANCE_ERROR(method); \
  1611. OPCODE_BREAK; \
  1612. } else if (!base_obj) { \
  1613. err_text = METHOD_CALL_ON_NULL_VALUE_ERROR(method); \
  1614. OPCODE_BREAK; \
  1615. } \
  1616. const void **argptrs = call_args_ptr; \
  1617. for (int i = 0; i < argc; i++) { \
  1618. GET_INSTRUCTION_ARG(v, i); \
  1619. argptrs[i] = VariantInternal::get_opaque_pointer((const Variant *)v); \
  1620. } \
  1621. uint64_t call_time = 0; \
  1622. if (GDScriptLanguage::get_singleton()->profiling) { \
  1623. call_time = OS::get_singleton()->get_ticks_usec(); \
  1624. } \
  1625. GET_INSTRUCTION_ARG(ret, argc + 1); \
  1626. VariantInternal::initialize(ret, Variant::m_type); \
  1627. void *ret_opaque = VariantInternal::OP_GET_##m_type(ret); \
  1628. method->ptrcall(base_obj, argptrs, ret_opaque); \
  1629. if (GDScriptLanguage::get_singleton()->profiling) { \
  1630. function_call_time += OS::get_singleton()->get_ticks_usec() - call_time; \
  1631. } \
  1632. ip += 3; \
  1633. } \
  1634. DISPATCH_OPCODE
  1635. #else
  1636. #define OPCODE_CALL_PTR(m_type) \
  1637. OPCODE(OPCODE_CALL_PTRCALL_##m_type) { \
  1638. LOAD_INSTRUCTION_ARGS \
  1639. CHECK_SPACE(3 + instr_arg_count); \
  1640. ip += instr_arg_count; \
  1641. int argc = _code_ptr[ip + 1]; \
  1642. GET_INSTRUCTION_ARG(base, argc); \
  1643. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]]; \
  1644. Object *base_obj = *VariantInternal::get_object(base); \
  1645. const void **argptrs = call_args_ptr; \
  1646. for (int i = 0; i < argc; i++) { \
  1647. GET_INSTRUCTION_ARG(v, i); \
  1648. argptrs[i] = VariantInternal::get_opaque_pointer((const Variant *)v); \
  1649. } \
  1650. GET_INSTRUCTION_ARG(ret, argc + 1); \
  1651. VariantInternal::initialize(ret, Variant::m_type); \
  1652. void *ret_opaque = VariantInternal::OP_GET_##m_type(ret); \
  1653. method->ptrcall(base_obj, argptrs, ret_opaque); \
  1654. ip += 3; \
  1655. } \
  1656. DISPATCH_OPCODE
  1657. #endif
  1658. OPCODE_CALL_PTR(BOOL);
  1659. OPCODE_CALL_PTR(INT);
  1660. OPCODE_CALL_PTR(FLOAT);
  1661. OPCODE_CALL_PTR(STRING);
  1662. OPCODE_CALL_PTR(VECTOR2);
  1663. OPCODE_CALL_PTR(VECTOR2I);
  1664. OPCODE_CALL_PTR(RECT2);
  1665. OPCODE_CALL_PTR(RECT2I);
  1666. OPCODE_CALL_PTR(VECTOR3);
  1667. OPCODE_CALL_PTR(VECTOR3I);
  1668. OPCODE_CALL_PTR(TRANSFORM2D);
  1669. OPCODE_CALL_PTR(VECTOR4);
  1670. OPCODE_CALL_PTR(VECTOR4I);
  1671. OPCODE_CALL_PTR(PLANE);
  1672. OPCODE_CALL_PTR(QUATERNION);
  1673. OPCODE_CALL_PTR(AABB);
  1674. OPCODE_CALL_PTR(BASIS);
  1675. OPCODE_CALL_PTR(TRANSFORM3D);
  1676. OPCODE_CALL_PTR(PROJECTION);
  1677. OPCODE_CALL_PTR(COLOR);
  1678. OPCODE_CALL_PTR(STRING_NAME);
  1679. OPCODE_CALL_PTR(NODE_PATH);
  1680. OPCODE_CALL_PTR(RID);
  1681. OPCODE_CALL_PTR(CALLABLE);
  1682. OPCODE_CALL_PTR(SIGNAL);
  1683. OPCODE_CALL_PTR(DICTIONARY);
  1684. OPCODE_CALL_PTR(ARRAY);
  1685. OPCODE_CALL_PTR(PACKED_BYTE_ARRAY);
  1686. OPCODE_CALL_PTR(PACKED_INT32_ARRAY);
  1687. OPCODE_CALL_PTR(PACKED_INT64_ARRAY);
  1688. OPCODE_CALL_PTR(PACKED_FLOAT32_ARRAY);
  1689. OPCODE_CALL_PTR(PACKED_FLOAT64_ARRAY);
  1690. OPCODE_CALL_PTR(PACKED_STRING_ARRAY);
  1691. OPCODE_CALL_PTR(PACKED_VECTOR2_ARRAY);
  1692. OPCODE_CALL_PTR(PACKED_VECTOR3_ARRAY);
  1693. OPCODE_CALL_PTR(PACKED_COLOR_ARRAY);
  1694. OPCODE(OPCODE_CALL_PTRCALL_OBJECT) {
  1695. LOAD_INSTRUCTION_ARGS
  1696. CHECK_SPACE(3 + instr_arg_count);
  1697. ip += instr_arg_count;
  1698. int argc = _code_ptr[ip + 1];
  1699. GD_ERR_BREAK(argc < 0);
  1700. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1701. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1702. GET_INSTRUCTION_ARG(base, argc);
  1703. #ifdef DEBUG_ENABLED
  1704. bool freed = false;
  1705. Object *base_obj = base->get_validated_object_with_check(freed);
  1706. if (freed) {
  1707. err_text = METHOD_CALL_ON_FREED_INSTANCE_ERROR(method);
  1708. OPCODE_BREAK;
  1709. } else if (!base_obj) {
  1710. err_text = METHOD_CALL_ON_NULL_VALUE_ERROR(method);
  1711. OPCODE_BREAK;
  1712. }
  1713. #else
  1714. Object *base_obj = *VariantInternal::get_object(base);
  1715. #endif
  1716. const void **argptrs = call_args_ptr;
  1717. for (int i = 0; i < argc; i++) {
  1718. GET_INSTRUCTION_ARG(v, i);
  1719. argptrs[i] = VariantInternal::get_opaque_pointer((const Variant *)v);
  1720. }
  1721. #ifdef DEBUG_ENABLED
  1722. uint64_t call_time = 0;
  1723. if (GDScriptLanguage::get_singleton()->profiling) {
  1724. call_time = OS::get_singleton()->get_ticks_usec();
  1725. }
  1726. #endif
  1727. GET_INSTRUCTION_ARG(ret, argc + 1);
  1728. VariantInternal::initialize(ret, Variant::OBJECT);
  1729. Object **ret_opaque = VariantInternal::get_object(ret);
  1730. method->ptrcall(base_obj, argptrs, ret_opaque);
  1731. if (method->is_return_type_raw_object_ptr()) {
  1732. // The Variant has to participate in the ref count since the method returns a raw Object *.
  1733. VariantInternal::object_assign(ret, *ret_opaque);
  1734. } else {
  1735. // The method, in case it returns something, returns an already encapsulated object.
  1736. VariantInternal::update_object_id(ret);
  1737. }
  1738. #ifdef DEBUG_ENABLED
  1739. if (GDScriptLanguage::get_singleton()->profiling) {
  1740. function_call_time += OS::get_singleton()->get_ticks_usec() - call_time;
  1741. }
  1742. #endif
  1743. ip += 3;
  1744. }
  1745. DISPATCH_OPCODE;
  1746. OPCODE(OPCODE_CALL_PTRCALL_NO_RETURN) {
  1747. LOAD_INSTRUCTION_ARGS
  1748. CHECK_SPACE(3 + instr_arg_count);
  1749. ip += instr_arg_count;
  1750. int argc = _code_ptr[ip + 1];
  1751. GD_ERR_BREAK(argc < 0);
  1752. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _methods_count);
  1753. MethodBind *method = _methods_ptr[_code_ptr[ip + 2]];
  1754. GET_INSTRUCTION_ARG(base, argc);
  1755. #ifdef DEBUG_ENABLED
  1756. bool freed = false;
  1757. Object *base_obj = base->get_validated_object_with_check(freed);
  1758. if (freed) {
  1759. err_text = METHOD_CALL_ON_FREED_INSTANCE_ERROR(method);
  1760. OPCODE_BREAK;
  1761. } else if (!base_obj) {
  1762. err_text = METHOD_CALL_ON_NULL_VALUE_ERROR(method);
  1763. OPCODE_BREAK;
  1764. }
  1765. #else
  1766. Object *base_obj = *VariantInternal::get_object(base);
  1767. #endif
  1768. const void **argptrs = call_args_ptr;
  1769. for (int i = 0; i < argc; i++) {
  1770. GET_INSTRUCTION_ARG(v, i);
  1771. argptrs[i] = VariantInternal::get_opaque_pointer((const Variant *)v);
  1772. }
  1773. #ifdef DEBUG_ENABLED
  1774. uint64_t call_time = 0;
  1775. if (GDScriptLanguage::get_singleton()->profiling) {
  1776. call_time = OS::get_singleton()->get_ticks_usec();
  1777. }
  1778. #endif
  1779. GET_INSTRUCTION_ARG(ret, argc + 1);
  1780. VariantInternal::initialize(ret, Variant::NIL);
  1781. method->ptrcall(base_obj, argptrs, nullptr);
  1782. #ifdef DEBUG_ENABLED
  1783. if (GDScriptLanguage::get_singleton()->profiling) {
  1784. function_call_time += OS::get_singleton()->get_ticks_usec() - call_time;
  1785. }
  1786. #endif
  1787. ip += 3;
  1788. }
  1789. DISPATCH_OPCODE;
  1790. OPCODE(OPCODE_CALL_BUILTIN_TYPE_VALIDATED) {
  1791. LOAD_INSTRUCTION_ARGS
  1792. CHECK_SPACE(3 + instr_arg_count);
  1793. ip += instr_arg_count;
  1794. int argc = _code_ptr[ip + 1];
  1795. GD_ERR_BREAK(argc < 0);
  1796. GET_INSTRUCTION_ARG(base, argc);
  1797. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _builtin_methods_count);
  1798. Variant::ValidatedBuiltInMethod method = _builtin_methods_ptr[_code_ptr[ip + 2]];
  1799. Variant **argptrs = instruction_args;
  1800. #ifdef DEBUG_ENABLED
  1801. uint64_t call_time = 0;
  1802. if (GDScriptLanguage::get_singleton()->profiling) {
  1803. call_time = OS::get_singleton()->get_ticks_usec();
  1804. }
  1805. #endif
  1806. GET_INSTRUCTION_ARG(ret, argc + 1);
  1807. method(base, (const Variant **)argptrs, argc, ret);
  1808. #ifdef DEBUG_ENABLED
  1809. if (GDScriptLanguage::get_singleton()->profiling) {
  1810. function_call_time += OS::get_singleton()->get_ticks_usec() - call_time;
  1811. }
  1812. #endif
  1813. ip += 3;
  1814. }
  1815. DISPATCH_OPCODE;
  1816. OPCODE(OPCODE_CALL_UTILITY) {
  1817. LOAD_INSTRUCTION_ARGS
  1818. CHECK_SPACE(3 + instr_arg_count);
  1819. ip += instr_arg_count;
  1820. int argc = _code_ptr[ip + 1];
  1821. GD_ERR_BREAK(argc < 0);
  1822. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _global_names_count);
  1823. StringName function = _global_names_ptr[_code_ptr[ip + 2]];
  1824. Variant **argptrs = instruction_args;
  1825. GET_INSTRUCTION_ARG(dst, argc);
  1826. Callable::CallError err;
  1827. Variant::call_utility_function(function, dst, (const Variant **)argptrs, argc, err);
  1828. #ifdef DEBUG_ENABLED
  1829. if (err.error != Callable::CallError::CALL_OK) {
  1830. String methodstr = function;
  1831. if (dst->get_type() == Variant::STRING) {
  1832. // Call provided error string.
  1833. err_text = "Error calling utility function '" + methodstr + "': " + String(*dst);
  1834. } else {
  1835. err_text = _get_call_error(err, "utility function '" + methodstr + "'", (const Variant **)argptrs);
  1836. }
  1837. OPCODE_BREAK;
  1838. }
  1839. #endif
  1840. ip += 3;
  1841. }
  1842. DISPATCH_OPCODE;
  1843. OPCODE(OPCODE_CALL_UTILITY_VALIDATED) {
  1844. LOAD_INSTRUCTION_ARGS
  1845. CHECK_SPACE(3 + instr_arg_count);
  1846. ip += instr_arg_count;
  1847. int argc = _code_ptr[ip + 1];
  1848. GD_ERR_BREAK(argc < 0);
  1849. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _utilities_count);
  1850. Variant::ValidatedUtilityFunction function = _utilities_ptr[_code_ptr[ip + 2]];
  1851. Variant **argptrs = instruction_args;
  1852. GET_INSTRUCTION_ARG(dst, argc);
  1853. function(dst, (const Variant **)argptrs, argc);
  1854. ip += 3;
  1855. }
  1856. DISPATCH_OPCODE;
  1857. OPCODE(OPCODE_CALL_GDSCRIPT_UTILITY) {
  1858. LOAD_INSTRUCTION_ARGS
  1859. CHECK_SPACE(3 + instr_arg_count);
  1860. ip += instr_arg_count;
  1861. int argc = _code_ptr[ip + 1];
  1862. GD_ERR_BREAK(argc < 0);
  1863. GD_ERR_BREAK(_code_ptr[ip + 2] < 0 || _code_ptr[ip + 2] >= _gds_utilities_count);
  1864. GDScriptUtilityFunctions::FunctionPtr function = _gds_utilities_ptr[_code_ptr[ip + 2]];
  1865. Variant **argptrs = instruction_args;
  1866. GET_INSTRUCTION_ARG(dst, argc);
  1867. Callable::CallError err;
  1868. function(dst, (const Variant **)argptrs, argc, err);
  1869. #ifdef DEBUG_ENABLED
  1870. if (err.error != Callable::CallError::CALL_OK) {
  1871. // TODO: Add this information in debug.
  1872. String methodstr = "<unknown function>";
  1873. if (dst->get_type() == Variant::STRING) {
  1874. // Call provided error string.
  1875. err_text = "Error calling GDScript utility function '" + methodstr + "': " + String(*dst);
  1876. } else {
  1877. err_text = _get_call_error(err, "GDScript utility function '" + methodstr + "'", (const Variant **)argptrs);
  1878. }
  1879. OPCODE_BREAK;
  1880. }
  1881. #endif
  1882. ip += 3;
  1883. }
  1884. DISPATCH_OPCODE;
  1885. OPCODE(OPCODE_CALL_SELF_BASE) {
  1886. LOAD_INSTRUCTION_ARGS
  1887. CHECK_SPACE(3 + instr_arg_count);
  1888. ip += instr_arg_count;
  1889. int argc = _code_ptr[ip + 1];
  1890. GD_ERR_BREAK(argc < 0);
  1891. int self_fun = _code_ptr[ip + 2];
  1892. #ifdef DEBUG_ENABLED
  1893. if (self_fun < 0 || self_fun >= _global_names_count) {
  1894. err_text = "compiler bug, function name not found";
  1895. OPCODE_BREAK;
  1896. }
  1897. #endif
  1898. const StringName *methodname = &_global_names_ptr[self_fun];
  1899. Variant **argptrs = instruction_args;
  1900. GET_INSTRUCTION_ARG(dst, argc);
  1901. const GDScript *gds = _script;
  1902. HashMap<StringName, GDScriptFunction *>::ConstIterator E;
  1903. while (gds->base.ptr()) {
  1904. gds = gds->base.ptr();
  1905. E = gds->member_functions.find(*methodname);
  1906. if (E) {
  1907. break;
  1908. }
  1909. }
  1910. Callable::CallError err;
  1911. if (E) {
  1912. *dst = E->value->call(p_instance, (const Variant **)argptrs, argc, err);
  1913. } else if (gds->native.ptr()) {
  1914. if (*methodname != GDScriptLanguage::get_singleton()->strings._init) {
  1915. MethodBind *mb = ClassDB::get_method(gds->native->get_name(), *methodname);
  1916. if (!mb) {
  1917. err.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1918. } else {
  1919. *dst = mb->call(p_instance->owner, (const Variant **)argptrs, argc, err);
  1920. }
  1921. } else {
  1922. err.error = Callable::CallError::CALL_OK;
  1923. }
  1924. } else {
  1925. if (*methodname != GDScriptLanguage::get_singleton()->strings._init) {
  1926. err.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1927. } else {
  1928. err.error = Callable::CallError::CALL_OK;
  1929. }
  1930. }
  1931. if (err.error != Callable::CallError::CALL_OK) {
  1932. String methodstr = *methodname;
  1933. err_text = _get_call_error(err, "function '" + methodstr + "'", (const Variant **)argptrs);
  1934. OPCODE_BREAK;
  1935. }
  1936. ip += 3;
  1937. }
  1938. DISPATCH_OPCODE;
  1939. OPCODE(OPCODE_AWAIT) {
  1940. CHECK_SPACE(2);
  1941. // Do the one-shot connect.
  1942. GET_VARIANT_PTR(argobj, 0);
  1943. Signal sig;
  1944. bool is_signal = true;
  1945. {
  1946. Variant result = *argobj;
  1947. if (argobj->get_type() == Variant::OBJECT) {
  1948. bool was_freed = false;
  1949. Object *obj = argobj->get_validated_object_with_check(was_freed);
  1950. if (was_freed) {
  1951. err_text = "Trying to await on a freed object.";
  1952. OPCODE_BREAK;
  1953. }
  1954. // Is this even possible to be null at this point?
  1955. if (obj) {
  1956. if (obj->is_class_ptr(GDScriptFunctionState::get_class_ptr_static())) {
  1957. result = Signal(obj, "completed");
  1958. }
  1959. }
  1960. }
  1961. if (result.get_type() != Variant::SIGNAL) {
  1962. // Not async, return immediately using the target from OPCODE_AWAIT_RESUME.
  1963. GET_VARIANT_PTR(target, 2);
  1964. *target = result;
  1965. ip += 4; // Skip OPCODE_AWAIT_RESUME and its data.
  1966. is_signal = false;
  1967. } else {
  1968. sig = result;
  1969. }
  1970. }
  1971. if (is_signal) {
  1972. Ref<GDScriptFunctionState> gdfs = memnew(GDScriptFunctionState);
  1973. gdfs->function = this;
  1974. gdfs->state.stack.resize(alloca_size);
  1975. // First 3 stack addresses are special, so we just skip them here.
  1976. for (int i = 3; i < _stack_size; i++) {
  1977. memnew_placement(&gdfs->state.stack.write[sizeof(Variant) * i], Variant(stack[i]));
  1978. }
  1979. gdfs->state.stack_size = _stack_size;
  1980. gdfs->state.alloca_size = alloca_size;
  1981. gdfs->state.ip = ip + 2;
  1982. gdfs->state.line = line;
  1983. gdfs->state.script = _script;
  1984. {
  1985. MutexLock lock(GDScriptLanguage::get_singleton()->mutex);
  1986. _script->pending_func_states.add(&gdfs->scripts_list);
  1987. if (p_instance) {
  1988. gdfs->state.instance = p_instance;
  1989. p_instance->pending_func_states.add(&gdfs->instances_list);
  1990. } else {
  1991. gdfs->state.instance = nullptr;
  1992. }
  1993. }
  1994. #ifdef DEBUG_ENABLED
  1995. gdfs->state.function_name = name;
  1996. gdfs->state.script_path = _script->get_script_path();
  1997. #endif
  1998. gdfs->state.defarg = defarg;
  1999. gdfs->function = this;
  2000. retvalue = gdfs;
  2001. Error err = sig.connect(Callable(gdfs.ptr(), "_signal_callback").bind(retvalue), Object::CONNECT_ONE_SHOT);
  2002. if (err != OK) {
  2003. err_text = "Error connecting to signal: " + sig.get_name() + " during await.";
  2004. OPCODE_BREAK;
  2005. }
  2006. #ifdef DEBUG_ENABLED
  2007. exit_ok = true;
  2008. awaited = true;
  2009. #endif
  2010. OPCODE_BREAK;
  2011. }
  2012. }
  2013. DISPATCH_OPCODE; // Needed for synchronous calls (when result is immediately available).
  2014. OPCODE(OPCODE_AWAIT_RESUME) {
  2015. CHECK_SPACE(2);
  2016. #ifdef DEBUG_ENABLED
  2017. if (!p_state) {
  2018. err_text = ("Invalid Resume (bug?)");
  2019. OPCODE_BREAK;
  2020. }
  2021. #endif
  2022. GET_VARIANT_PTR(result, 0);
  2023. *result = p_state->result;
  2024. ip += 2;
  2025. }
  2026. DISPATCH_OPCODE;
  2027. OPCODE(OPCODE_CREATE_LAMBDA) {
  2028. LOAD_INSTRUCTION_ARGS
  2029. CHECK_SPACE(2 + instr_arg_count);
  2030. ip += instr_arg_count;
  2031. int captures_count = _code_ptr[ip + 1];
  2032. GD_ERR_BREAK(captures_count < 0);
  2033. int lambda_index = _code_ptr[ip + 2];
  2034. GD_ERR_BREAK(lambda_index < 0 || lambda_index >= _lambdas_count);
  2035. GDScriptFunction *lambda = _lambdas_ptr[lambda_index];
  2036. Vector<Variant> captures;
  2037. captures.resize(captures_count);
  2038. for (int i = 0; i < captures_count; i++) {
  2039. GET_INSTRUCTION_ARG(arg, i);
  2040. captures.write[i] = *arg;
  2041. }
  2042. GDScriptLambdaCallable *callable = memnew(GDScriptLambdaCallable(Ref<GDScript>(script), lambda, captures));
  2043. GET_INSTRUCTION_ARG(result, captures_count);
  2044. *result = Callable(callable);
  2045. ip += 3;
  2046. }
  2047. DISPATCH_OPCODE;
  2048. OPCODE(OPCODE_CREATE_SELF_LAMBDA) {
  2049. LOAD_INSTRUCTION_ARGS
  2050. CHECK_SPACE(2 + instr_arg_count);
  2051. GD_ERR_BREAK(p_instance == nullptr);
  2052. ip += instr_arg_count;
  2053. int captures_count = _code_ptr[ip + 1];
  2054. GD_ERR_BREAK(captures_count < 0);
  2055. int lambda_index = _code_ptr[ip + 2];
  2056. GD_ERR_BREAK(lambda_index < 0 || lambda_index >= _lambdas_count);
  2057. GDScriptFunction *lambda = _lambdas_ptr[lambda_index];
  2058. Vector<Variant> captures;
  2059. captures.resize(captures_count);
  2060. for (int i = 0; i < captures_count; i++) {
  2061. GET_INSTRUCTION_ARG(arg, i);
  2062. captures.write[i] = *arg;
  2063. }
  2064. GDScriptLambdaSelfCallable *callable;
  2065. if (Object::cast_to<RefCounted>(p_instance->owner)) {
  2066. callable = memnew(GDScriptLambdaSelfCallable(Ref<RefCounted>(Object::cast_to<RefCounted>(p_instance->owner)), lambda, captures));
  2067. } else {
  2068. callable = memnew(GDScriptLambdaSelfCallable(p_instance->owner, lambda, captures));
  2069. }
  2070. GET_INSTRUCTION_ARG(result, captures_count);
  2071. *result = Callable(callable);
  2072. ip += 3;
  2073. }
  2074. DISPATCH_OPCODE;
  2075. OPCODE(OPCODE_JUMP) {
  2076. CHECK_SPACE(2);
  2077. int to = _code_ptr[ip + 1];
  2078. GD_ERR_BREAK(to < 0 || to > _code_size);
  2079. ip = to;
  2080. }
  2081. DISPATCH_OPCODE;
  2082. OPCODE(OPCODE_JUMP_IF) {
  2083. CHECK_SPACE(3);
  2084. GET_VARIANT_PTR(test, 0);
  2085. bool result = test->booleanize();
  2086. if (result) {
  2087. int to = _code_ptr[ip + 2];
  2088. GD_ERR_BREAK(to < 0 || to > _code_size);
  2089. ip = to;
  2090. } else {
  2091. ip += 3;
  2092. }
  2093. }
  2094. DISPATCH_OPCODE;
  2095. OPCODE(OPCODE_JUMP_IF_NOT) {
  2096. CHECK_SPACE(3);
  2097. GET_VARIANT_PTR(test, 0);
  2098. bool result = test->booleanize();
  2099. if (!result) {
  2100. int to = _code_ptr[ip + 2];
  2101. GD_ERR_BREAK(to < 0 || to > _code_size);
  2102. ip = to;
  2103. } else {
  2104. ip += 3;
  2105. }
  2106. }
  2107. DISPATCH_OPCODE;
  2108. OPCODE(OPCODE_JUMP_TO_DEF_ARGUMENT) {
  2109. CHECK_SPACE(2);
  2110. ip = _default_arg_ptr[defarg];
  2111. }
  2112. DISPATCH_OPCODE;
  2113. OPCODE(OPCODE_JUMP_IF_SHARED) {
  2114. CHECK_SPACE(3);
  2115. GET_VARIANT_PTR(val, 0);
  2116. if (val->is_shared()) {
  2117. int to = _code_ptr[ip + 2];
  2118. GD_ERR_BREAK(to < 0 || to > _code_size);
  2119. ip = to;
  2120. } else {
  2121. ip += 3;
  2122. }
  2123. }
  2124. DISPATCH_OPCODE;
  2125. OPCODE(OPCODE_RETURN) {
  2126. CHECK_SPACE(2);
  2127. GET_VARIANT_PTR(r, 0);
  2128. retvalue = *r;
  2129. #ifdef DEBUG_ENABLED
  2130. exit_ok = true;
  2131. #endif
  2132. OPCODE_BREAK;
  2133. }
  2134. OPCODE(OPCODE_RETURN_TYPED_BUILTIN) {
  2135. CHECK_SPACE(3);
  2136. GET_VARIANT_PTR(r, 0);
  2137. Variant::Type ret_type = (Variant::Type)_code_ptr[ip + 2];
  2138. GD_ERR_BREAK(ret_type < 0 || ret_type >= Variant::VARIANT_MAX);
  2139. if (r->get_type() != ret_type) {
  2140. if (Variant::can_convert_strict(r->get_type(), ret_type)) {
  2141. Callable::CallError ce;
  2142. Variant::construct(ret_type, retvalue, const_cast<const Variant **>(&r), 1, ce);
  2143. } else {
  2144. #ifdef DEBUG_ENABLED
  2145. err_text = vformat(R"(Trying to return value of type "%s" from a function which the return type is "%s".)",
  2146. Variant::get_type_name(r->get_type()), Variant::get_type_name(ret_type));
  2147. #endif // DEBUG_ENABLED
  2148. // Construct a base type anyway so type constraints are met.
  2149. Callable::CallError ce;
  2150. Variant::construct(ret_type, retvalue, nullptr, 0, ce);
  2151. OPCODE_BREAK;
  2152. }
  2153. } else {
  2154. retvalue = *r;
  2155. }
  2156. #ifdef DEBUG_ENABLED
  2157. exit_ok = true;
  2158. #endif // DEBUG_ENABLED
  2159. OPCODE_BREAK;
  2160. }
  2161. OPCODE(OPCODE_RETURN_TYPED_ARRAY) {
  2162. CHECK_SPACE(5);
  2163. GET_VARIANT_PTR(r, 0);
  2164. GET_VARIANT_PTR(script_type, 1);
  2165. Variant::Type builtin_type = (Variant::Type)_code_ptr[ip + 3];
  2166. int native_type_idx = _code_ptr[ip + 4];
  2167. GD_ERR_BREAK(native_type_idx < 0 || native_type_idx >= _global_names_count);
  2168. const StringName native_type = _global_names_ptr[native_type_idx];
  2169. if (r->get_type() != Variant::ARRAY) {
  2170. #ifdef DEBUG_ENABLED
  2171. err_text = vformat(R"(Trying to return a value of type "%s" where expected return type is "Array[%s]".)",
  2172. _get_var_type(r), _get_element_type(builtin_type, native_type, *script_type));
  2173. #endif // DEBUG_ENABLED
  2174. OPCODE_BREAK;
  2175. }
  2176. Array *array = VariantInternal::get_array(r);
  2177. 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) {
  2178. #ifdef DEBUG_ENABLED
  2179. err_text = vformat(R"(Trying to return an array of type "%s" where expected return type is "Array[%s]".)",
  2180. _get_var_type(r), _get_element_type(builtin_type, native_type, *script_type));
  2181. #endif // DEBUG_ENABLED
  2182. OPCODE_BREAK;
  2183. }
  2184. retvalue = *array;
  2185. #ifdef DEBUG_ENABLED
  2186. exit_ok = true;
  2187. #endif // DEBUG_ENABLED
  2188. OPCODE_BREAK;
  2189. }
  2190. OPCODE(OPCODE_RETURN_TYPED_NATIVE) {
  2191. CHECK_SPACE(3);
  2192. GET_VARIANT_PTR(r, 0);
  2193. GET_VARIANT_PTR(type, 1);
  2194. GDScriptNativeClass *nc = Object::cast_to<GDScriptNativeClass>(type->operator Object *());
  2195. GD_ERR_BREAK(!nc);
  2196. if (r->get_type() != Variant::OBJECT && r->get_type() != Variant::NIL) {
  2197. err_text = vformat(R"(Trying to return value of type "%s" from a function which the return type is "%s".)",
  2198. Variant::get_type_name(r->get_type()), nc->get_name());
  2199. OPCODE_BREAK;
  2200. }
  2201. #ifdef DEBUG_ENABLED
  2202. bool freed = false;
  2203. Object *ret_obj = r->get_validated_object_with_check(freed);
  2204. if (freed) {
  2205. err_text = "Trying to return a previously freed instance.";
  2206. OPCODE_BREAK;
  2207. }
  2208. #else
  2209. Object *ret_obj = r->operator Object *();
  2210. #endif // DEBUG_ENABLED
  2211. if (ret_obj && !ClassDB::is_parent_class(ret_obj->get_class_name(), nc->get_name())) {
  2212. #ifdef DEBUG_ENABLED
  2213. err_text = vformat(R"(Trying to return value of type "%s" from a function which the return type is "%s".)",
  2214. ret_obj->get_class_name(), nc->get_name());
  2215. #endif // DEBUG_ENABLED
  2216. OPCODE_BREAK;
  2217. }
  2218. retvalue = *r;
  2219. #ifdef DEBUG_ENABLED
  2220. exit_ok = true;
  2221. #endif // DEBUG_ENABLED
  2222. OPCODE_BREAK;
  2223. }
  2224. OPCODE(OPCODE_RETURN_TYPED_SCRIPT) {
  2225. CHECK_SPACE(3);
  2226. GET_VARIANT_PTR(r, 0);
  2227. GET_VARIANT_PTR(type, 1);
  2228. Script *base_type = Object::cast_to<Script>(type->operator Object *());
  2229. GD_ERR_BREAK(!base_type);
  2230. if (r->get_type() != Variant::OBJECT && r->get_type() != Variant::NIL) {
  2231. #ifdef DEBUG_ENABLED
  2232. err_text = vformat(R"(Trying to return value of type "%s" from a function which the return type is "%s".)",
  2233. Variant::get_type_name(r->get_type()), _get_script_name(Ref<Script>(base_type)));
  2234. #endif // DEBUG_ENABLED
  2235. OPCODE_BREAK;
  2236. }
  2237. #ifdef DEBUG_ENABLED
  2238. bool freed = false;
  2239. Object *ret_obj = r->get_validated_object_with_check(freed);
  2240. if (freed) {
  2241. err_text = "Trying to return a previously freed instance.";
  2242. OPCODE_BREAK;
  2243. }
  2244. #else
  2245. Object *ret_obj = r->operator Object *();
  2246. #endif // DEBUG_ENABLED
  2247. if (ret_obj) {
  2248. ScriptInstance *ret_inst = ret_obj->get_script_instance();
  2249. if (!ret_inst) {
  2250. #ifdef DEBUG_ENABLED
  2251. err_text = vformat(R"(Trying to return value of type "%s" from a function which the return type is "%s".)",
  2252. ret_obj->get_class_name(), _get_script_name(Ref<GDScript>(base_type)));
  2253. #endif // DEBUG_ENABLED
  2254. OPCODE_BREAK;
  2255. }
  2256. Script *ret_type = ret_obj->get_script_instance()->get_script().ptr();
  2257. bool valid = false;
  2258. while (ret_type) {
  2259. if (ret_type == base_type) {
  2260. valid = true;
  2261. break;
  2262. }
  2263. ret_type = ret_type->get_base_script().ptr();
  2264. }
  2265. if (!valid) {
  2266. #ifdef DEBUG_ENABLED
  2267. err_text = vformat(R"(Trying to return value of type "%s" from a function which the return type is "%s".)",
  2268. _get_script_name(ret_obj->get_script_instance()->get_script()), _get_script_name(Ref<GDScript>(base_type)));
  2269. #endif // DEBUG_ENABLED
  2270. OPCODE_BREAK;
  2271. }
  2272. }
  2273. retvalue = *r;
  2274. #ifdef DEBUG_ENABLED
  2275. exit_ok = true;
  2276. #endif // DEBUG_ENABLED
  2277. OPCODE_BREAK;
  2278. }
  2279. OPCODE(OPCODE_ITERATE_BEGIN) {
  2280. CHECK_SPACE(8); // Space for this and a regular iterate.
  2281. GET_VARIANT_PTR(counter, 0);
  2282. GET_VARIANT_PTR(container, 1);
  2283. bool valid;
  2284. if (!container->iter_init(*counter, valid)) {
  2285. #ifdef DEBUG_ENABLED
  2286. if (!valid) {
  2287. err_text = "Unable to iterate on object of type '" + Variant::get_type_name(container->get_type()) + "'.";
  2288. OPCODE_BREAK;
  2289. }
  2290. #endif
  2291. int jumpto = _code_ptr[ip + 4];
  2292. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2293. ip = jumpto;
  2294. } else {
  2295. GET_VARIANT_PTR(iterator, 2);
  2296. *iterator = container->iter_get(*counter, valid);
  2297. #ifdef DEBUG_ENABLED
  2298. if (!valid) {
  2299. err_text = "Unable to obtain iterator object of type '" + Variant::get_type_name(container->get_type()) + "'.";
  2300. OPCODE_BREAK;
  2301. }
  2302. #endif
  2303. ip += 5; // Skip regular iterate which is always next.
  2304. }
  2305. }
  2306. DISPATCH_OPCODE;
  2307. OPCODE(OPCODE_ITERATE_BEGIN_INT) {
  2308. CHECK_SPACE(8); // Check space for iterate instruction too.
  2309. GET_VARIANT_PTR(counter, 0);
  2310. GET_VARIANT_PTR(container, 1);
  2311. int64_t size = *VariantInternal::get_int(container);
  2312. VariantInternal::initialize(counter, Variant::INT);
  2313. *VariantInternal::get_int(counter) = 0;
  2314. if (size > 0) {
  2315. GET_VARIANT_PTR(iterator, 2);
  2316. VariantInternal::initialize(iterator, Variant::INT);
  2317. *VariantInternal::get_int(iterator) = 0;
  2318. // Skip regular iterate.
  2319. ip += 5;
  2320. } else {
  2321. // Jump to end of loop.
  2322. int jumpto = _code_ptr[ip + 4];
  2323. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2324. ip = jumpto;
  2325. }
  2326. }
  2327. DISPATCH_OPCODE;
  2328. OPCODE(OPCODE_ITERATE_BEGIN_FLOAT) {
  2329. CHECK_SPACE(8); // Check space for iterate instruction too.
  2330. GET_VARIANT_PTR(counter, 0);
  2331. GET_VARIANT_PTR(container, 1);
  2332. double size = *VariantInternal::get_float(container);
  2333. VariantInternal::initialize(counter, Variant::FLOAT);
  2334. *VariantInternal::get_float(counter) = 0.0;
  2335. if (size > 0) {
  2336. GET_VARIANT_PTR(iterator, 2);
  2337. VariantInternal::initialize(iterator, Variant::FLOAT);
  2338. *VariantInternal::get_float(iterator) = 0;
  2339. // Skip regular iterate.
  2340. ip += 5;
  2341. } else {
  2342. // Jump to end of loop.
  2343. int jumpto = _code_ptr[ip + 4];
  2344. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2345. ip = jumpto;
  2346. }
  2347. }
  2348. DISPATCH_OPCODE;
  2349. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR2) {
  2350. CHECK_SPACE(8); // Check space for iterate instruction too.
  2351. GET_VARIANT_PTR(counter, 0);
  2352. GET_VARIANT_PTR(container, 1);
  2353. Vector2 *bounds = VariantInternal::get_vector2(container);
  2354. VariantInternal::initialize(counter, Variant::FLOAT);
  2355. *VariantInternal::get_float(counter) = bounds->x;
  2356. if (bounds->x < bounds->y) {
  2357. GET_VARIANT_PTR(iterator, 2);
  2358. VariantInternal::initialize(iterator, Variant::FLOAT);
  2359. *VariantInternal::get_float(iterator) = bounds->x;
  2360. // Skip regular iterate.
  2361. ip += 5;
  2362. } else {
  2363. // Jump to end of loop.
  2364. int jumpto = _code_ptr[ip + 4];
  2365. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2366. ip = jumpto;
  2367. }
  2368. }
  2369. DISPATCH_OPCODE;
  2370. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR2I) {
  2371. CHECK_SPACE(8); // Check space for iterate instruction too.
  2372. GET_VARIANT_PTR(counter, 0);
  2373. GET_VARIANT_PTR(container, 1);
  2374. Vector2i *bounds = VariantInternal::get_vector2i(container);
  2375. VariantInternal::initialize(counter, Variant::FLOAT);
  2376. *VariantInternal::get_int(counter) = bounds->x;
  2377. if (bounds->x < bounds->y) {
  2378. GET_VARIANT_PTR(iterator, 2);
  2379. VariantInternal::initialize(iterator, Variant::INT);
  2380. *VariantInternal::get_int(iterator) = bounds->x;
  2381. // Skip regular iterate.
  2382. ip += 5;
  2383. } else {
  2384. // Jump to end of loop.
  2385. int jumpto = _code_ptr[ip + 4];
  2386. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2387. ip = jumpto;
  2388. }
  2389. }
  2390. DISPATCH_OPCODE;
  2391. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR3) {
  2392. CHECK_SPACE(8); // Check space for iterate instruction too.
  2393. GET_VARIANT_PTR(counter, 0);
  2394. GET_VARIANT_PTR(container, 1);
  2395. Vector3 *bounds = VariantInternal::get_vector3(container);
  2396. double from = bounds->x;
  2397. double to = bounds->y;
  2398. double step = bounds->z;
  2399. VariantInternal::initialize(counter, Variant::FLOAT);
  2400. *VariantInternal::get_float(counter) = from;
  2401. bool do_continue = from == to ? false : (from < to ? step > 0 : step < 0);
  2402. if (do_continue) {
  2403. GET_VARIANT_PTR(iterator, 2);
  2404. VariantInternal::initialize(iterator, Variant::FLOAT);
  2405. *VariantInternal::get_float(iterator) = from;
  2406. // Skip regular iterate.
  2407. ip += 5;
  2408. } else {
  2409. // Jump to end of loop.
  2410. int jumpto = _code_ptr[ip + 4];
  2411. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2412. ip = jumpto;
  2413. }
  2414. }
  2415. DISPATCH_OPCODE;
  2416. OPCODE(OPCODE_ITERATE_BEGIN_VECTOR3I) {
  2417. CHECK_SPACE(8); // Check space for iterate instruction too.
  2418. GET_VARIANT_PTR(counter, 0);
  2419. GET_VARIANT_PTR(container, 1);
  2420. Vector3i *bounds = VariantInternal::get_vector3i(container);
  2421. int64_t from = bounds->x;
  2422. int64_t to = bounds->y;
  2423. int64_t step = bounds->z;
  2424. VariantInternal::initialize(counter, Variant::INT);
  2425. *VariantInternal::get_int(counter) = from;
  2426. bool do_continue = from == to ? false : (from < to ? step > 0 : step < 0);
  2427. if (do_continue) {
  2428. GET_VARIANT_PTR(iterator, 2);
  2429. VariantInternal::initialize(iterator, Variant::INT);
  2430. *VariantInternal::get_int(iterator) = from;
  2431. // Skip regular iterate.
  2432. ip += 5;
  2433. } else {
  2434. // Jump to end of loop.
  2435. int jumpto = _code_ptr[ip + 4];
  2436. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2437. ip = jumpto;
  2438. }
  2439. }
  2440. DISPATCH_OPCODE;
  2441. OPCODE(OPCODE_ITERATE_BEGIN_STRING) {
  2442. CHECK_SPACE(8); // Check space for iterate instruction too.
  2443. GET_VARIANT_PTR(counter, 0);
  2444. GET_VARIANT_PTR(container, 1);
  2445. String *str = VariantInternal::get_string(container);
  2446. VariantInternal::initialize(counter, Variant::INT);
  2447. *VariantInternal::get_int(counter) = 0;
  2448. if (!str->is_empty()) {
  2449. GET_VARIANT_PTR(iterator, 2);
  2450. VariantInternal::initialize(iterator, Variant::STRING);
  2451. *VariantInternal::get_string(iterator) = str->substr(0, 1);
  2452. // Skip regular iterate.
  2453. ip += 5;
  2454. } else {
  2455. // Jump to end of loop.
  2456. int jumpto = _code_ptr[ip + 4];
  2457. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2458. ip = jumpto;
  2459. }
  2460. }
  2461. DISPATCH_OPCODE;
  2462. OPCODE(OPCODE_ITERATE_BEGIN_DICTIONARY) {
  2463. CHECK_SPACE(8); // Check space for iterate instruction too.
  2464. GET_VARIANT_PTR(counter, 0);
  2465. GET_VARIANT_PTR(container, 1);
  2466. Dictionary *dict = VariantInternal::get_dictionary(container);
  2467. const Variant *next = dict->next(nullptr);
  2468. if (!dict->is_empty()) {
  2469. GET_VARIANT_PTR(iterator, 2);
  2470. *counter = *next;
  2471. *iterator = *next;
  2472. // Skip regular iterate.
  2473. ip += 5;
  2474. } else {
  2475. // Jump to end of loop.
  2476. int jumpto = _code_ptr[ip + 4];
  2477. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2478. ip = jumpto;
  2479. }
  2480. }
  2481. DISPATCH_OPCODE;
  2482. OPCODE(OPCODE_ITERATE_BEGIN_ARRAY) {
  2483. CHECK_SPACE(8); // Check space for iterate instruction too.
  2484. GET_VARIANT_PTR(counter, 0);
  2485. GET_VARIANT_PTR(container, 1);
  2486. Array *array = VariantInternal::get_array(container);
  2487. VariantInternal::initialize(counter, Variant::INT);
  2488. *VariantInternal::get_int(counter) = 0;
  2489. if (!array->is_empty()) {
  2490. GET_VARIANT_PTR(iterator, 2);
  2491. *iterator = array->get(0);
  2492. // Skip regular iterate.
  2493. ip += 5;
  2494. } else {
  2495. // Jump to end of loop.
  2496. int jumpto = _code_ptr[ip + 4];
  2497. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2498. ip = jumpto;
  2499. }
  2500. }
  2501. DISPATCH_OPCODE;
  2502. #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) \
  2503. OPCODE(OPCODE_ITERATE_BEGIN_PACKED_##m_var_type##_ARRAY) { \
  2504. CHECK_SPACE(8); \
  2505. GET_VARIANT_PTR(counter, 0); \
  2506. GET_VARIANT_PTR(container, 1); \
  2507. Vector<m_elem_type> *array = VariantInternal::m_get_func(container); \
  2508. VariantInternal::initialize(counter, Variant::INT); \
  2509. *VariantInternal::get_int(counter) = 0; \
  2510. if (!array->is_empty()) { \
  2511. GET_VARIANT_PTR(iterator, 2); \
  2512. VariantInternal::initialize(iterator, Variant::m_var_ret_type); \
  2513. m_ret_type *it = VariantInternal::m_ret_get_func(iterator); \
  2514. *it = array->get(0); \
  2515. ip += 5; \
  2516. } else { \
  2517. int jumpto = _code_ptr[ip + 4]; \
  2518. GD_ERR_BREAK(jumpto<0 || jumpto> _code_size); \
  2519. ip = jumpto; \
  2520. } \
  2521. } \
  2522. DISPATCH_OPCODE
  2523. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(BYTE, uint8_t, get_byte_array, INT, int64_t, get_int);
  2524. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(INT32, int32_t, get_int32_array, INT, int64_t, get_int);
  2525. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(INT64, int64_t, get_int64_array, INT, int64_t, get_int);
  2526. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(FLOAT32, float, get_float32_array, FLOAT, double, get_float);
  2527. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(FLOAT64, double, get_float64_array, FLOAT, double, get_float);
  2528. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(STRING, String, get_string_array, STRING, String, get_string);
  2529. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(VECTOR2, Vector2, get_vector2_array, VECTOR2, Vector2, get_vector2);
  2530. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(VECTOR3, Vector3, get_vector3_array, VECTOR3, Vector3, get_vector3);
  2531. OPCODE_ITERATE_BEGIN_PACKED_ARRAY(COLOR, Color, get_color_array, COLOR, Color, get_color);
  2532. OPCODE(OPCODE_ITERATE_BEGIN_OBJECT) {
  2533. CHECK_SPACE(4);
  2534. GET_VARIANT_PTR(counter, 0);
  2535. GET_VARIANT_PTR(container, 1);
  2536. #ifdef DEBUG_ENABLED
  2537. bool freed = false;
  2538. Object *obj = container->get_validated_object_with_check(freed);
  2539. if (freed) {
  2540. err_text = "Trying to iterate on a previously freed object.";
  2541. OPCODE_BREAK;
  2542. } else if (!obj) {
  2543. err_text = "Trying to iterate on a null value.";
  2544. OPCODE_BREAK;
  2545. }
  2546. #else
  2547. Object *obj = *VariantInternal::get_object(container);
  2548. #endif
  2549. Array ref;
  2550. ref.push_back(*counter);
  2551. Variant vref;
  2552. VariantInternal::initialize(&vref, Variant::ARRAY);
  2553. *VariantInternal::get_array(&vref) = ref;
  2554. Variant **args = instruction_args; // Overriding an instruction argument, but we don't need access to that anymore.
  2555. args[0] = &vref;
  2556. Callable::CallError ce;
  2557. Variant has_next = obj->callp(CoreStringNames::get_singleton()->_iter_init, (const Variant **)args, 1, ce);
  2558. #ifdef DEBUG_ENABLED
  2559. if (ce.error != Callable::CallError::CALL_OK) {
  2560. err_text = vformat(R"(There was an error calling "_iter_next" on iterator object of type %s.)", *container);
  2561. OPCODE_BREAK;
  2562. }
  2563. #endif
  2564. if (!has_next.booleanize()) {
  2565. int jumpto = _code_ptr[ip + 4];
  2566. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2567. ip = jumpto;
  2568. } else {
  2569. GET_VARIANT_PTR(iterator, 2);
  2570. *iterator = obj->callp(CoreStringNames::get_singleton()->_iter_get, (const Variant **)args, 1, ce);
  2571. #ifdef DEBUG_ENABLED
  2572. if (ce.error != Callable::CallError::CALL_OK) {
  2573. err_text = vformat(R"(There was an error calling "_iter_get" on iterator object of type %s.)", *container);
  2574. OPCODE_BREAK;
  2575. }
  2576. #endif
  2577. ip += 5; // Loop again.
  2578. }
  2579. }
  2580. DISPATCH_OPCODE;
  2581. OPCODE(OPCODE_ITERATE) {
  2582. CHECK_SPACE(4);
  2583. GET_VARIANT_PTR(counter, 0);
  2584. GET_VARIANT_PTR(container, 1);
  2585. bool valid;
  2586. if (!container->iter_next(*counter, valid)) {
  2587. #ifdef DEBUG_ENABLED
  2588. if (!valid) {
  2589. err_text = "Unable to iterate on object of type '" + Variant::get_type_name(container->get_type()) + "' (type changed since first iteration?).";
  2590. OPCODE_BREAK;
  2591. }
  2592. #endif
  2593. int jumpto = _code_ptr[ip + 4];
  2594. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2595. ip = jumpto;
  2596. } else {
  2597. GET_VARIANT_PTR(iterator, 2);
  2598. *iterator = container->iter_get(*counter, valid);
  2599. #ifdef DEBUG_ENABLED
  2600. if (!valid) {
  2601. err_text = "Unable to obtain iterator object of type '" + Variant::get_type_name(container->get_type()) + "' (but was obtained on first iteration?).";
  2602. OPCODE_BREAK;
  2603. }
  2604. #endif
  2605. ip += 5; //loop again
  2606. }
  2607. }
  2608. DISPATCH_OPCODE;
  2609. OPCODE(OPCODE_ITERATE_INT) {
  2610. CHECK_SPACE(4);
  2611. GET_VARIANT_PTR(counter, 0);
  2612. GET_VARIANT_PTR(container, 1);
  2613. int64_t size = *VariantInternal::get_int(container);
  2614. int64_t *count = VariantInternal::get_int(counter);
  2615. (*count)++;
  2616. if (*count >= size) {
  2617. int jumpto = _code_ptr[ip + 4];
  2618. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2619. ip = jumpto;
  2620. } else {
  2621. GET_VARIANT_PTR(iterator, 2);
  2622. *VariantInternal::get_int(iterator) = *count;
  2623. ip += 5; // Loop again.
  2624. }
  2625. }
  2626. DISPATCH_OPCODE;
  2627. OPCODE(OPCODE_ITERATE_FLOAT) {
  2628. CHECK_SPACE(4);
  2629. GET_VARIANT_PTR(counter, 0);
  2630. GET_VARIANT_PTR(container, 1);
  2631. double size = *VariantInternal::get_float(container);
  2632. double *count = VariantInternal::get_float(counter);
  2633. (*count)++;
  2634. if (*count >= size) {
  2635. int jumpto = _code_ptr[ip + 4];
  2636. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2637. ip = jumpto;
  2638. } else {
  2639. GET_VARIANT_PTR(iterator, 2);
  2640. *VariantInternal::get_float(iterator) = *count;
  2641. ip += 5; // Loop again.
  2642. }
  2643. }
  2644. DISPATCH_OPCODE;
  2645. OPCODE(OPCODE_ITERATE_VECTOR2) {
  2646. CHECK_SPACE(4);
  2647. GET_VARIANT_PTR(counter, 0);
  2648. GET_VARIANT_PTR(container, 1);
  2649. const Vector2 *bounds = VariantInternal::get_vector2((const Variant *)container);
  2650. double *count = VariantInternal::get_float(counter);
  2651. (*count)++;
  2652. if (*count >= bounds->y) {
  2653. int jumpto = _code_ptr[ip + 4];
  2654. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2655. ip = jumpto;
  2656. } else {
  2657. GET_VARIANT_PTR(iterator, 2);
  2658. *VariantInternal::get_float(iterator) = *count;
  2659. ip += 5; // Loop again.
  2660. }
  2661. }
  2662. DISPATCH_OPCODE;
  2663. OPCODE(OPCODE_ITERATE_VECTOR2I) {
  2664. CHECK_SPACE(4);
  2665. GET_VARIANT_PTR(counter, 0);
  2666. GET_VARIANT_PTR(container, 1);
  2667. const Vector2i *bounds = VariantInternal::get_vector2i((const Variant *)container);
  2668. int64_t *count = VariantInternal::get_int(counter);
  2669. (*count)++;
  2670. if (*count >= bounds->y) {
  2671. int jumpto = _code_ptr[ip + 4];
  2672. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2673. ip = jumpto;
  2674. } else {
  2675. GET_VARIANT_PTR(iterator, 2);
  2676. *VariantInternal::get_int(iterator) = *count;
  2677. ip += 5; // Loop again.
  2678. }
  2679. }
  2680. DISPATCH_OPCODE;
  2681. OPCODE(OPCODE_ITERATE_VECTOR3) {
  2682. CHECK_SPACE(4);
  2683. GET_VARIANT_PTR(counter, 0);
  2684. GET_VARIANT_PTR(container, 1);
  2685. const Vector3 *bounds = VariantInternal::get_vector3((const Variant *)container);
  2686. double *count = VariantInternal::get_float(counter);
  2687. *count += bounds->z;
  2688. if ((bounds->z < 0 && *count <= bounds->y) || (bounds->z > 0 && *count >= bounds->y)) {
  2689. int jumpto = _code_ptr[ip + 4];
  2690. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2691. ip = jumpto;
  2692. } else {
  2693. GET_VARIANT_PTR(iterator, 2);
  2694. *VariantInternal::get_float(iterator) = *count;
  2695. ip += 5; // Loop again.
  2696. }
  2697. }
  2698. DISPATCH_OPCODE;
  2699. OPCODE(OPCODE_ITERATE_VECTOR3I) {
  2700. CHECK_SPACE(4);
  2701. GET_VARIANT_PTR(counter, 0);
  2702. GET_VARIANT_PTR(container, 1);
  2703. const Vector3i *bounds = VariantInternal::get_vector3i((const Variant *)container);
  2704. int64_t *count = VariantInternal::get_int(counter);
  2705. *count += bounds->z;
  2706. if ((bounds->z < 0 && *count <= bounds->y) || (bounds->z > 0 && *count >= bounds->y)) {
  2707. int jumpto = _code_ptr[ip + 4];
  2708. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2709. ip = jumpto;
  2710. } else {
  2711. GET_VARIANT_PTR(iterator, 2);
  2712. *VariantInternal::get_int(iterator) = *count;
  2713. ip += 5; // Loop again.
  2714. }
  2715. }
  2716. DISPATCH_OPCODE;
  2717. OPCODE(OPCODE_ITERATE_STRING) {
  2718. CHECK_SPACE(4);
  2719. GET_VARIANT_PTR(counter, 0);
  2720. GET_VARIANT_PTR(container, 1);
  2721. const String *str = VariantInternal::get_string((const Variant *)container);
  2722. int64_t *idx = VariantInternal::get_int(counter);
  2723. (*idx)++;
  2724. if (*idx >= str->length()) {
  2725. int jumpto = _code_ptr[ip + 4];
  2726. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2727. ip = jumpto;
  2728. } else {
  2729. GET_VARIANT_PTR(iterator, 2);
  2730. *VariantInternal::get_string(iterator) = str->substr(*idx, 1);
  2731. ip += 5; // Loop again.
  2732. }
  2733. }
  2734. DISPATCH_OPCODE;
  2735. OPCODE(OPCODE_ITERATE_DICTIONARY) {
  2736. CHECK_SPACE(4);
  2737. GET_VARIANT_PTR(counter, 0);
  2738. GET_VARIANT_PTR(container, 1);
  2739. const Dictionary *dict = VariantInternal::get_dictionary((const Variant *)container);
  2740. const Variant *next = dict->next(counter);
  2741. if (!next) {
  2742. int jumpto = _code_ptr[ip + 4];
  2743. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2744. ip = jumpto;
  2745. } else {
  2746. GET_VARIANT_PTR(iterator, 2);
  2747. *counter = *next;
  2748. *iterator = *next;
  2749. ip += 5; // Loop again.
  2750. }
  2751. }
  2752. DISPATCH_OPCODE;
  2753. OPCODE(OPCODE_ITERATE_ARRAY) {
  2754. CHECK_SPACE(4);
  2755. GET_VARIANT_PTR(counter, 0);
  2756. GET_VARIANT_PTR(container, 1);
  2757. const Array *array = VariantInternal::get_array((const Variant *)container);
  2758. int64_t *idx = VariantInternal::get_int(counter);
  2759. (*idx)++;
  2760. if (*idx >= array->size()) {
  2761. int jumpto = _code_ptr[ip + 4];
  2762. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2763. ip = jumpto;
  2764. } else {
  2765. GET_VARIANT_PTR(iterator, 2);
  2766. *iterator = array->get(*idx);
  2767. ip += 5; // Loop again.
  2768. }
  2769. }
  2770. DISPATCH_OPCODE;
  2771. #define OPCODE_ITERATE_PACKED_ARRAY(m_var_type, m_elem_type, m_get_func, m_ret_get_func) \
  2772. OPCODE(OPCODE_ITERATE_PACKED_##m_var_type##_ARRAY) { \
  2773. CHECK_SPACE(4); \
  2774. GET_VARIANT_PTR(counter, 0); \
  2775. GET_VARIANT_PTR(container, 1); \
  2776. const Vector<m_elem_type> *array = VariantInternal::m_get_func((const Variant *)container); \
  2777. int64_t *idx = VariantInternal::get_int(counter); \
  2778. (*idx)++; \
  2779. if (*idx >= array->size()) { \
  2780. int jumpto = _code_ptr[ip + 4]; \
  2781. GD_ERR_BREAK(jumpto<0 || jumpto> _code_size); \
  2782. ip = jumpto; \
  2783. } else { \
  2784. GET_VARIANT_PTR(iterator, 2); \
  2785. *VariantInternal::m_ret_get_func(iterator) = array->get(*idx); \
  2786. ip += 5; \
  2787. } \
  2788. } \
  2789. DISPATCH_OPCODE
  2790. OPCODE_ITERATE_PACKED_ARRAY(BYTE, uint8_t, get_byte_array, get_int);
  2791. OPCODE_ITERATE_PACKED_ARRAY(INT32, int32_t, get_int32_array, get_int);
  2792. OPCODE_ITERATE_PACKED_ARRAY(INT64, int64_t, get_int64_array, get_int);
  2793. OPCODE_ITERATE_PACKED_ARRAY(FLOAT32, float, get_float32_array, get_float);
  2794. OPCODE_ITERATE_PACKED_ARRAY(FLOAT64, double, get_float64_array, get_float);
  2795. OPCODE_ITERATE_PACKED_ARRAY(STRING, String, get_string_array, get_string);
  2796. OPCODE_ITERATE_PACKED_ARRAY(VECTOR2, Vector2, get_vector2_array, get_vector2);
  2797. OPCODE_ITERATE_PACKED_ARRAY(VECTOR3, Vector3, get_vector3_array, get_vector3);
  2798. OPCODE_ITERATE_PACKED_ARRAY(COLOR, Color, get_color_array, get_color);
  2799. OPCODE(OPCODE_ITERATE_OBJECT) {
  2800. CHECK_SPACE(4);
  2801. GET_VARIANT_PTR(counter, 0);
  2802. GET_VARIANT_PTR(container, 1);
  2803. #ifdef DEBUG_ENABLED
  2804. bool freed = false;
  2805. Object *obj = container->get_validated_object_with_check(freed);
  2806. if (freed) {
  2807. err_text = "Trying to iterate on a previously freed object.";
  2808. OPCODE_BREAK;
  2809. } else if (!obj) {
  2810. err_text = "Trying to iterate on a null value.";
  2811. OPCODE_BREAK;
  2812. }
  2813. #else
  2814. Object *obj = *VariantInternal::get_object(container);
  2815. #endif
  2816. Array ref;
  2817. ref.push_back(*counter);
  2818. Variant vref;
  2819. VariantInternal::initialize(&vref, Variant::ARRAY);
  2820. *VariantInternal::get_array(&vref) = ref;
  2821. Variant **args = instruction_args; // Overriding an instruction argument, but we don't need access to that anymore.
  2822. args[0] = &vref;
  2823. Callable::CallError ce;
  2824. Variant has_next = obj->callp(CoreStringNames::get_singleton()->_iter_next, (const Variant **)args, 1, ce);
  2825. #ifdef DEBUG_ENABLED
  2826. if (ce.error != Callable::CallError::CALL_OK) {
  2827. err_text = vformat(R"(There was an error calling "_iter_next" on iterator object of type %s.)", *container);
  2828. OPCODE_BREAK;
  2829. }
  2830. #endif
  2831. if (!has_next.booleanize()) {
  2832. int jumpto = _code_ptr[ip + 4];
  2833. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  2834. ip = jumpto;
  2835. } else {
  2836. GET_VARIANT_PTR(iterator, 2);
  2837. *iterator = obj->callp(CoreStringNames::get_singleton()->_iter_get, (const Variant **)args, 1, ce);
  2838. #ifdef DEBUG_ENABLED
  2839. if (ce.error != Callable::CallError::CALL_OK) {
  2840. err_text = vformat(R"(There was an error calling "_iter_get" on iterator object of type %s.)", *container);
  2841. OPCODE_BREAK;
  2842. }
  2843. #endif
  2844. ip += 5; // Loop again.
  2845. }
  2846. }
  2847. DISPATCH_OPCODE;
  2848. OPCODE(OPCODE_STORE_GLOBAL) {
  2849. CHECK_SPACE(3);
  2850. int global_idx = _code_ptr[ip + 2];
  2851. GD_ERR_BREAK(global_idx < 0 || global_idx >= GDScriptLanguage::get_singleton()->get_global_array_size());
  2852. GET_VARIANT_PTR(dst, 0);
  2853. *dst = GDScriptLanguage::get_singleton()->get_global_array()[global_idx];
  2854. ip += 3;
  2855. }
  2856. DISPATCH_OPCODE;
  2857. OPCODE(OPCODE_STORE_NAMED_GLOBAL) {
  2858. CHECK_SPACE(3);
  2859. int globalname_idx = _code_ptr[ip + 2];
  2860. GD_ERR_BREAK(globalname_idx < 0 || globalname_idx >= _global_names_count);
  2861. const StringName *globalname = &_global_names_ptr[globalname_idx];
  2862. GD_ERR_BREAK(!GDScriptLanguage::get_singleton()->get_named_globals_map().has(*globalname));
  2863. GET_VARIANT_PTR(dst, 0);
  2864. *dst = GDScriptLanguage::get_singleton()->get_named_globals_map()[*globalname];
  2865. ip += 3;
  2866. }
  2867. DISPATCH_OPCODE;
  2868. #define OPCODE_TYPE_ADJUST(m_v_type, m_c_type) \
  2869. OPCODE(OPCODE_TYPE_ADJUST_##m_v_type) { \
  2870. CHECK_SPACE(2); \
  2871. GET_VARIANT_PTR(arg, 0); \
  2872. VariantTypeAdjust<m_c_type>::adjust(arg); \
  2873. ip += 2; \
  2874. } \
  2875. DISPATCH_OPCODE
  2876. OPCODE_TYPE_ADJUST(BOOL, bool);
  2877. OPCODE_TYPE_ADJUST(INT, int64_t);
  2878. OPCODE_TYPE_ADJUST(FLOAT, double);
  2879. OPCODE_TYPE_ADJUST(STRING, String);
  2880. OPCODE_TYPE_ADJUST(VECTOR2, Vector2);
  2881. OPCODE_TYPE_ADJUST(VECTOR2I, Vector2i);
  2882. OPCODE_TYPE_ADJUST(RECT2, Rect2);
  2883. OPCODE_TYPE_ADJUST(RECT2I, Rect2i);
  2884. OPCODE_TYPE_ADJUST(VECTOR3, Vector3);
  2885. OPCODE_TYPE_ADJUST(VECTOR3I, Vector3i);
  2886. OPCODE_TYPE_ADJUST(TRANSFORM2D, Transform2D);
  2887. OPCODE_TYPE_ADJUST(VECTOR4, Vector4);
  2888. OPCODE_TYPE_ADJUST(VECTOR4I, Vector4i);
  2889. OPCODE_TYPE_ADJUST(PLANE, Plane);
  2890. OPCODE_TYPE_ADJUST(QUATERNION, Quaternion);
  2891. OPCODE_TYPE_ADJUST(AABB, AABB);
  2892. OPCODE_TYPE_ADJUST(BASIS, Basis);
  2893. OPCODE_TYPE_ADJUST(TRANSFORM3D, Transform3D);
  2894. OPCODE_TYPE_ADJUST(PROJECTION, Projection);
  2895. OPCODE_TYPE_ADJUST(COLOR, Color);
  2896. OPCODE_TYPE_ADJUST(STRING_NAME, StringName);
  2897. OPCODE_TYPE_ADJUST(NODE_PATH, NodePath);
  2898. OPCODE_TYPE_ADJUST(RID, RID);
  2899. OPCODE_TYPE_ADJUST(OBJECT, Object *);
  2900. OPCODE_TYPE_ADJUST(CALLABLE, Callable);
  2901. OPCODE_TYPE_ADJUST(SIGNAL, Signal);
  2902. OPCODE_TYPE_ADJUST(DICTIONARY, Dictionary);
  2903. OPCODE_TYPE_ADJUST(ARRAY, Array);
  2904. OPCODE_TYPE_ADJUST(PACKED_BYTE_ARRAY, PackedByteArray);
  2905. OPCODE_TYPE_ADJUST(PACKED_INT32_ARRAY, PackedInt32Array);
  2906. OPCODE_TYPE_ADJUST(PACKED_INT64_ARRAY, PackedInt64Array);
  2907. OPCODE_TYPE_ADJUST(PACKED_FLOAT32_ARRAY, PackedFloat32Array);
  2908. OPCODE_TYPE_ADJUST(PACKED_FLOAT64_ARRAY, PackedFloat64Array);
  2909. OPCODE_TYPE_ADJUST(PACKED_STRING_ARRAY, PackedStringArray);
  2910. OPCODE_TYPE_ADJUST(PACKED_VECTOR2_ARRAY, PackedVector2Array);
  2911. OPCODE_TYPE_ADJUST(PACKED_VECTOR3_ARRAY, PackedVector3Array);
  2912. OPCODE_TYPE_ADJUST(PACKED_COLOR_ARRAY, PackedColorArray);
  2913. OPCODE(OPCODE_ASSERT) {
  2914. CHECK_SPACE(3);
  2915. #ifdef DEBUG_ENABLED
  2916. GET_VARIANT_PTR(test, 0);
  2917. bool result = test->booleanize();
  2918. if (!result) {
  2919. String message_str;
  2920. if (_code_ptr[ip + 2] != 0) {
  2921. GET_VARIANT_PTR(message, 1);
  2922. Variant message_var = *message;
  2923. if (message->get_type() != Variant::NIL) {
  2924. message_str = message_var;
  2925. }
  2926. }
  2927. if (message_str.is_empty()) {
  2928. err_text = "Assertion failed.";
  2929. } else {
  2930. err_text = "Assertion failed: " + message_str;
  2931. }
  2932. OPCODE_BREAK;
  2933. }
  2934. #endif
  2935. ip += 3;
  2936. }
  2937. DISPATCH_OPCODE;
  2938. OPCODE(OPCODE_BREAKPOINT) {
  2939. #ifdef DEBUG_ENABLED
  2940. if (EngineDebugger::is_active()) {
  2941. GDScriptLanguage::get_singleton()->debug_break("Breakpoint Statement", true);
  2942. }
  2943. #endif
  2944. ip += 1;
  2945. }
  2946. DISPATCH_OPCODE;
  2947. OPCODE(OPCODE_LINE) {
  2948. CHECK_SPACE(2);
  2949. line = _code_ptr[ip + 1];
  2950. ip += 2;
  2951. if (EngineDebugger::is_active()) {
  2952. // line
  2953. bool do_break = false;
  2954. if (EngineDebugger::get_script_debugger()->get_lines_left() > 0) {
  2955. if (EngineDebugger::get_script_debugger()->get_depth() <= 0) {
  2956. EngineDebugger::get_script_debugger()->set_lines_left(EngineDebugger::get_script_debugger()->get_lines_left() - 1);
  2957. }
  2958. if (EngineDebugger::get_script_debugger()->get_lines_left() <= 0) {
  2959. do_break = true;
  2960. }
  2961. }
  2962. if (EngineDebugger::get_script_debugger()->is_breakpoint(line, source)) {
  2963. do_break = true;
  2964. }
  2965. if (do_break) {
  2966. GDScriptLanguage::get_singleton()->debug_break("Breakpoint", true);
  2967. }
  2968. EngineDebugger::get_singleton()->line_poll();
  2969. }
  2970. }
  2971. DISPATCH_OPCODE;
  2972. OPCODE(OPCODE_END) {
  2973. #ifdef DEBUG_ENABLED
  2974. exit_ok = true;
  2975. #endif
  2976. OPCODE_BREAK;
  2977. }
  2978. #if 0 // Enable for debugging.
  2979. default: {
  2980. err_text = "Illegal opcode " + itos(_code_ptr[ip]) + " at address " + itos(ip);
  2981. OPCODE_BREAK;
  2982. }
  2983. #endif
  2984. }
  2985. OPCODES_END
  2986. #ifdef DEBUG_ENABLED
  2987. if (exit_ok) {
  2988. OPCODE_OUT;
  2989. }
  2990. //error
  2991. // function, file, line, error, explanation
  2992. String err_file;
  2993. if (p_instance && ObjectDB::get_instance(p_instance->owner_id) != nullptr && p_instance->script->is_valid() && !p_instance->script->path.is_empty()) {
  2994. err_file = p_instance->script->path;
  2995. } else if (script) {
  2996. err_file = script->path;
  2997. }
  2998. if (err_file.is_empty()) {
  2999. err_file = "<built-in>";
  3000. }
  3001. String err_func = name;
  3002. if (p_instance && ObjectDB::get_instance(p_instance->owner_id) != nullptr && p_instance->script->is_valid() && !p_instance->script->name.is_empty()) {
  3003. err_func = p_instance->script->name + "." + err_func;
  3004. }
  3005. int err_line = line;
  3006. if (err_text.is_empty()) {
  3007. err_text = "Internal script error! Opcode: " + itos(last_opcode) + " (please report).";
  3008. }
  3009. if (!GDScriptLanguage::get_singleton()->debug_break(err_text, false)) {
  3010. // debugger break did not happen
  3011. _err_print_error(err_func.utf8().get_data(), err_file.utf8().get_data(), err_line, err_text.utf8().get_data(), false, ERR_HANDLER_SCRIPT);
  3012. }
  3013. // Get a default return type in case of failure
  3014. retvalue = _get_default_variant_for_data_type(return_type);
  3015. #endif
  3016. OPCODE_OUT;
  3017. }
  3018. OPCODES_OUT
  3019. #ifdef DEBUG_ENABLED
  3020. if (GDScriptLanguage::get_singleton()->profiling) {
  3021. uint64_t time_taken = OS::get_singleton()->get_ticks_usec() - function_start_time;
  3022. profile.total_time += time_taken;
  3023. profile.self_time += time_taken - function_call_time;
  3024. profile.frame_total_time += time_taken;
  3025. profile.frame_self_time += time_taken - function_call_time;
  3026. GDScriptLanguage::get_singleton()->script_frame_time += time_taken - function_call_time;
  3027. }
  3028. // Check if this is not the last time it was interrupted by `await` or if it's the first time executing.
  3029. // If that is the case then we exit the function as normal. Otherwise we postpone it until the last `await` is completed.
  3030. // This ensures the call stack can be properly shown when using `await`, showing what resumed the function.
  3031. if (!p_state || awaited) {
  3032. if (EngineDebugger::is_active()) {
  3033. GDScriptLanguage::get_singleton()->exit_function();
  3034. }
  3035. #endif
  3036. // Free stack, except reserved addresses.
  3037. for (int i = 3; i < _stack_size; i++) {
  3038. stack[i].~Variant();
  3039. }
  3040. #ifdef DEBUG_ENABLED
  3041. }
  3042. #endif
  3043. // Always free reserved addresses, since they are never copied.
  3044. for (int i = 0; i < 3; i++) {
  3045. stack[i].~Variant();
  3046. }
  3047. call_depth--;
  3048. return retvalue;
  3049. }