gdscript_vm.cpp 118 KB

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