gdscript_vm.cpp 120 KB

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