gdscript_vm.cpp 131 KB

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