gdscript_vm.cpp 115 KB

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