gdscript_vm.cpp 119 KB

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