gdscript_vm.cpp 134 KB

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