gdscript_vm.cpp 134 KB

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