gdscript_vm.cpp 115 KB

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