gdscript_vm.cpp 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596
  1. /*************************************************************************/
  2. /* gdscript_vm.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
  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/os/os.h"
  32. #include "gdscript.h"
  33. #include "gdscript_functions.h"
  34. Variant *GDScriptFunction::_get_variant(int p_address, GDScriptInstance *p_instance, GDScript *p_script, Variant &self, Variant &static_ref, Variant *p_stack, String &r_error) const {
  35. int address = p_address & ADDR_MASK;
  36. //sequential table (jump table generated by compiler)
  37. switch ((p_address & ADDR_TYPE_MASK) >> ADDR_BITS) {
  38. case ADDR_TYPE_SELF: {
  39. #ifdef DEBUG_ENABLED
  40. if (unlikely(!p_instance)) {
  41. r_error = "Cannot access self without instance.";
  42. return nullptr;
  43. }
  44. #endif
  45. return &self;
  46. } break;
  47. case ADDR_TYPE_CLASS: {
  48. return &static_ref;
  49. } break;
  50. case ADDR_TYPE_MEMBER: {
  51. #ifdef DEBUG_ENABLED
  52. if (unlikely(!p_instance)) {
  53. r_error = "Cannot access member without instance.";
  54. return nullptr;
  55. }
  56. #endif
  57. //member indexing is O(1)
  58. return &p_instance->members.write[address];
  59. } break;
  60. case ADDR_TYPE_CLASS_CONSTANT: {
  61. //todo change to index!
  62. GDScript *s = p_script;
  63. #ifdef DEBUG_ENABLED
  64. ERR_FAIL_INDEX_V(address, _global_names_count, nullptr);
  65. #endif
  66. const StringName *sn = &_global_names_ptr[address];
  67. while (s) {
  68. GDScript *o = s;
  69. while (o) {
  70. Map<StringName, Variant>::Element *E = o->constants.find(*sn);
  71. if (E) {
  72. return &E->get();
  73. }
  74. o = o->_owner;
  75. }
  76. s = s->_base;
  77. }
  78. ERR_FAIL_V_MSG(nullptr, "GDScriptCompiler bug.");
  79. } break;
  80. case ADDR_TYPE_LOCAL_CONSTANT: {
  81. #ifdef DEBUG_ENABLED
  82. ERR_FAIL_INDEX_V(address, _constant_count, nullptr);
  83. #endif
  84. return &_constants_ptr[address];
  85. } break;
  86. case ADDR_TYPE_STACK:
  87. case ADDR_TYPE_STACK_VARIABLE: {
  88. #ifdef DEBUG_ENABLED
  89. ERR_FAIL_INDEX_V(address, _stack_size, nullptr);
  90. #endif
  91. return &p_stack[address];
  92. } break;
  93. case ADDR_TYPE_GLOBAL: {
  94. #ifdef DEBUG_ENABLED
  95. ERR_FAIL_INDEX_V(address, GDScriptLanguage::get_singleton()->get_global_array_size(), nullptr);
  96. #endif
  97. return &GDScriptLanguage::get_singleton()->get_global_array()[address];
  98. } break;
  99. #ifdef TOOLS_ENABLED
  100. case ADDR_TYPE_NAMED_GLOBAL: {
  101. #ifdef DEBUG_ENABLED
  102. ERR_FAIL_INDEX_V(address, _global_names_count, nullptr);
  103. #endif
  104. StringName id = _global_names_ptr[address];
  105. if (GDScriptLanguage::get_singleton()->get_named_globals_map().has(id)) {
  106. return (Variant *)&GDScriptLanguage::get_singleton()->get_named_globals_map()[id];
  107. } else {
  108. r_error = "Autoload singleton '" + String(id) + "' has been removed.";
  109. return nullptr;
  110. }
  111. } break;
  112. #endif
  113. case ADDR_TYPE_NIL: {
  114. return &nil;
  115. } break;
  116. }
  117. ERR_FAIL_V_MSG(nullptr, "Bad code! (unknown addressing mode).");
  118. return nullptr;
  119. }
  120. #ifdef DEBUG_ENABLED
  121. static String _get_var_type(const Variant *p_var) {
  122. String basestr;
  123. if (p_var->get_type() == Variant::OBJECT) {
  124. bool was_freed;
  125. Object *bobj = p_var->get_validated_object_with_check(was_freed);
  126. if (!bobj) {
  127. if (was_freed) {
  128. basestr = "null instance";
  129. } else {
  130. basestr = "previously freed";
  131. }
  132. } else {
  133. if (bobj->get_script_instance()) {
  134. basestr = bobj->get_class() + " (" + bobj->get_script_instance()->get_script()->get_path().get_file() + ")";
  135. } else {
  136. basestr = bobj->get_class();
  137. }
  138. }
  139. } else {
  140. basestr = Variant::get_type_name(p_var->get_type());
  141. }
  142. return basestr;
  143. }
  144. #endif // DEBUG_ENABLED
  145. String GDScriptFunction::_get_call_error(const Callable::CallError &p_err, const String &p_where, const Variant **argptrs) const {
  146. String err_text;
  147. if (p_err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  148. int errorarg = p_err.argument;
  149. // Handle the Object to Object case separately as we don't have further class details.
  150. #ifdef DEBUG_ENABLED
  151. if (p_err.expected == Variant::OBJECT && argptrs[errorarg]->get_type() == p_err.expected) {
  152. 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.";
  153. } else
  154. #endif // DEBUG_ENABLED
  155. {
  156. 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)) + ".";
  157. }
  158. } else if (p_err.error == Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS) {
  159. err_text = "Invalid call to " + p_where + ". Expected " + itos(p_err.argument) + " arguments.";
  160. } else if (p_err.error == Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS) {
  161. err_text = "Invalid call to " + p_where + ". Expected " + itos(p_err.argument) + " arguments.";
  162. } else if (p_err.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  163. err_text = "Invalid call. Nonexistent " + p_where + ".";
  164. } else if (p_err.error == Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL) {
  165. err_text = "Attempt to call " + p_where + " on a null instance.";
  166. } else {
  167. err_text = "Bug, call error: #" + itos(p_err.error);
  168. }
  169. return err_text;
  170. }
  171. #if defined(__GNUC__)
  172. #define OPCODES_TABLE \
  173. static const void *switch_table_ops[] = { \
  174. &&OPCODE_OPERATOR, \
  175. &&OPCODE_EXTENDS_TEST, \
  176. &&OPCODE_IS_BUILTIN, \
  177. &&OPCODE_SET, \
  178. &&OPCODE_GET, \
  179. &&OPCODE_SET_NAMED, \
  180. &&OPCODE_GET_NAMED, \
  181. &&OPCODE_SET_MEMBER, \
  182. &&OPCODE_GET_MEMBER, \
  183. &&OPCODE_ASSIGN, \
  184. &&OPCODE_ASSIGN_TRUE, \
  185. &&OPCODE_ASSIGN_FALSE, \
  186. &&OPCODE_ASSIGN_TYPED_BUILTIN, \
  187. &&OPCODE_ASSIGN_TYPED_NATIVE, \
  188. &&OPCODE_ASSIGN_TYPED_SCRIPT, \
  189. &&OPCODE_CAST_TO_BUILTIN, \
  190. &&OPCODE_CAST_TO_NATIVE, \
  191. &&OPCODE_CAST_TO_SCRIPT, \
  192. &&OPCODE_CONSTRUCT, \
  193. &&OPCODE_CONSTRUCT_ARRAY, \
  194. &&OPCODE_CONSTRUCT_DICTIONARY, \
  195. &&OPCODE_CALL, \
  196. &&OPCODE_CALL_RETURN, \
  197. &&OPCODE_CALL_ASYNC, \
  198. &&OPCODE_CALL_BUILT_IN, \
  199. &&OPCODE_CALL_SELF_BASE, \
  200. &&OPCODE_AWAIT, \
  201. &&OPCODE_AWAIT_RESUME, \
  202. &&OPCODE_JUMP, \
  203. &&OPCODE_JUMP_IF, \
  204. &&OPCODE_JUMP_IF_NOT, \
  205. &&OPCODE_JUMP_TO_DEF_ARGUMENT, \
  206. &&OPCODE_RETURN, \
  207. &&OPCODE_ITERATE_BEGIN, \
  208. &&OPCODE_ITERATE, \
  209. &&OPCODE_ASSERT, \
  210. &&OPCODE_BREAKPOINT, \
  211. &&OPCODE_LINE, \
  212. &&OPCODE_END \
  213. }; \
  214. 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.");
  215. #define OPCODE(m_op) \
  216. m_op:
  217. #define OPCODE_WHILE(m_test)
  218. #define OPCODES_END \
  219. OPSEXIT:
  220. #define OPCODES_OUT \
  221. OPSOUT:
  222. #define DISPATCH_OPCODE goto *switch_table_ops[_code_ptr[ip]]
  223. #define OPCODE_SWITCH(m_test) DISPATCH_OPCODE;
  224. #define OPCODE_BREAK goto OPSEXIT
  225. #define OPCODE_OUT goto OPSOUT
  226. #else
  227. #define OPCODES_TABLE
  228. #define OPCODE(m_op) case m_op:
  229. #define OPCODE_WHILE(m_test) while (m_test)
  230. #define OPCODES_END
  231. #define OPCODES_OUT
  232. #define DISPATCH_OPCODE continue
  233. #define OPCODE_SWITCH(m_test) switch (m_test)
  234. #define OPCODE_BREAK break
  235. #define OPCODE_OUT break
  236. #endif
  237. Variant GDScriptFunction::call(GDScriptInstance *p_instance, const Variant **p_args, int p_argcount, Callable::CallError &r_err, CallState *p_state) {
  238. OPCODES_TABLE;
  239. if (!_code_ptr) {
  240. return Variant();
  241. }
  242. r_err.error = Callable::CallError::CALL_OK;
  243. Variant self;
  244. Variant static_ref;
  245. Variant retvalue;
  246. Variant *stack = nullptr;
  247. Variant **call_args;
  248. int defarg = 0;
  249. #ifdef DEBUG_ENABLED
  250. //GDScriptLanguage::get_singleton()->calls++;
  251. #endif
  252. uint32_t alloca_size = 0;
  253. GDScript *script;
  254. int ip = 0;
  255. int line = _initial_line;
  256. if (p_state) {
  257. //use existing (supplied) state (awaited)
  258. stack = (Variant *)p_state->stack.ptr();
  259. call_args = (Variant **)&p_state->stack.ptr()[sizeof(Variant) * p_state->stack_size]; //ptr() to avoid bounds check
  260. line = p_state->line;
  261. ip = p_state->ip;
  262. alloca_size = p_state->stack.size();
  263. script = p_state->script;
  264. p_instance = p_state->instance;
  265. defarg = p_state->defarg;
  266. self = p_state->self;
  267. } else {
  268. if (p_argcount != _argument_count) {
  269. if (p_argcount > _argument_count) {
  270. r_err.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  271. r_err.argument = _argument_count;
  272. return Variant();
  273. } else if (p_argcount < _argument_count - _default_arg_count) {
  274. r_err.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  275. r_err.argument = _argument_count - _default_arg_count;
  276. return Variant();
  277. } else {
  278. defarg = _argument_count - p_argcount;
  279. }
  280. }
  281. alloca_size = sizeof(Variant *) * _call_size + sizeof(Variant) * _stack_size;
  282. if (alloca_size) {
  283. uint8_t *aptr = (uint8_t *)alloca(alloca_size);
  284. if (_stack_size) {
  285. stack = (Variant *)aptr;
  286. for (int i = 0; i < p_argcount; i++) {
  287. if (!argument_types[i].has_type) {
  288. memnew_placement(&stack[i], Variant(*p_args[i]));
  289. continue;
  290. }
  291. if (!argument_types[i].is_type(*p_args[i], true)) {
  292. r_err.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  293. r_err.argument = i;
  294. r_err.expected = argument_types[i].kind == GDScriptDataType::BUILTIN ? argument_types[i].builtin_type : Variant::OBJECT;
  295. return Variant();
  296. }
  297. if (argument_types[i].kind == GDScriptDataType::BUILTIN) {
  298. Variant arg;
  299. Variant::construct(argument_types[i].builtin_type, arg, &p_args[i], 1, r_err);
  300. memnew_placement(&stack[i], Variant(arg));
  301. } else {
  302. memnew_placement(&stack[i], Variant(*p_args[i]));
  303. }
  304. }
  305. for (int i = p_argcount; i < _stack_size; i++) {
  306. memnew_placement(&stack[i], Variant);
  307. }
  308. } else {
  309. stack = nullptr;
  310. }
  311. if (_call_size) {
  312. call_args = (Variant **)&aptr[sizeof(Variant) * _stack_size];
  313. } else {
  314. call_args = nullptr;
  315. }
  316. } else {
  317. stack = nullptr;
  318. call_args = nullptr;
  319. }
  320. if (p_instance) {
  321. if (p_instance->base_ref && static_cast<Reference *>(p_instance->owner)->is_referenced()) {
  322. self = REF(static_cast<Reference *>(p_instance->owner));
  323. } else {
  324. self = p_instance->owner;
  325. }
  326. script = p_instance->script.ptr();
  327. } else {
  328. script = _script;
  329. }
  330. }
  331. static_ref = script;
  332. String err_text;
  333. #ifdef DEBUG_ENABLED
  334. if (EngineDebugger::is_active()) {
  335. GDScriptLanguage::get_singleton()->enter_function(p_instance, this, stack, &ip, &line);
  336. }
  337. #define GD_ERR_BREAK(m_cond) \
  338. { \
  339. if (unlikely(m_cond)) { \
  340. _err_print_error(FUNCTION_STR, __FILE__, __LINE__, "Condition ' " _STR(m_cond) " ' is true. Breaking..:"); \
  341. OPCODE_BREAK; \
  342. } \
  343. }
  344. #define CHECK_SPACE(m_space) \
  345. GD_ERR_BREAK((ip + m_space) > _code_size)
  346. #define GET_VARIANT_PTR(m_v, m_code_ofs) \
  347. Variant *m_v; \
  348. m_v = _get_variant(_code_ptr[ip + m_code_ofs], p_instance, script, self, static_ref, stack, err_text); \
  349. if (unlikely(!m_v)) \
  350. OPCODE_BREAK;
  351. #else
  352. #define GD_ERR_BREAK(m_cond)
  353. #define CHECK_SPACE(m_space)
  354. #define GET_VARIANT_PTR(m_v, m_code_ofs) \
  355. Variant *m_v; \
  356. m_v = _get_variant(_code_ptr[ip + m_code_ofs], p_instance, script, self, static_ref, stack, err_text);
  357. #endif
  358. #ifdef DEBUG_ENABLED
  359. uint64_t function_start_time = 0;
  360. uint64_t function_call_time = 0;
  361. if (GDScriptLanguage::get_singleton()->profiling) {
  362. function_start_time = OS::get_singleton()->get_ticks_usec();
  363. function_call_time = 0;
  364. profile.call_count++;
  365. profile.frame_call_count++;
  366. }
  367. bool exit_ok = false;
  368. bool awaited = false;
  369. #endif
  370. #ifdef DEBUG_ENABLED
  371. OPCODE_WHILE(ip < _code_size) {
  372. int last_opcode = _code_ptr[ip];
  373. #else
  374. OPCODE_WHILE(true) {
  375. #endif
  376. OPCODE_SWITCH(_code_ptr[ip]) {
  377. OPCODE(OPCODE_OPERATOR) {
  378. CHECK_SPACE(5);
  379. bool valid;
  380. Variant::Operator op = (Variant::Operator)_code_ptr[ip + 1];
  381. GD_ERR_BREAK(op >= Variant::OP_MAX);
  382. GET_VARIANT_PTR(a, 2);
  383. GET_VARIANT_PTR(b, 3);
  384. GET_VARIANT_PTR(dst, 4);
  385. #ifdef DEBUG_ENABLED
  386. Variant ret;
  387. Variant::evaluate(op, *a, *b, ret, valid);
  388. #else
  389. Variant::evaluate(op, *a, *b, *dst, valid);
  390. #endif
  391. #ifdef DEBUG_ENABLED
  392. if (!valid) {
  393. if (ret.get_type() == Variant::STRING) {
  394. //return a string when invalid with the error
  395. err_text = ret;
  396. err_text += " in operator '" + Variant::get_operator_name(op) + "'.";
  397. } else {
  398. 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) + "'.";
  399. }
  400. OPCODE_BREAK;
  401. }
  402. *dst = ret;
  403. #endif
  404. ip += 5;
  405. }
  406. DISPATCH_OPCODE;
  407. OPCODE(OPCODE_EXTENDS_TEST) {
  408. CHECK_SPACE(4);
  409. GET_VARIANT_PTR(a, 1);
  410. GET_VARIANT_PTR(b, 2);
  411. GET_VARIANT_PTR(dst, 3);
  412. #ifdef DEBUG_ENABLED
  413. if (b->get_type() != Variant::OBJECT || b->operator Object *() == nullptr) {
  414. err_text = "Right operand of 'is' is not a class.";
  415. OPCODE_BREAK;
  416. }
  417. #endif
  418. bool extends_ok = false;
  419. if (a->get_type() == Variant::OBJECT && a->operator Object *() != nullptr) {
  420. #ifdef DEBUG_ENABLED
  421. bool was_freed;
  422. Object *obj_A = a->get_validated_object_with_check(was_freed);
  423. if (was_freed) {
  424. err_text = "Left operand of 'is' is a previously freed instance.";
  425. OPCODE_BREAK;
  426. }
  427. Object *obj_B = b->get_validated_object_with_check(was_freed);
  428. if (was_freed) {
  429. err_text = "Right operand of 'is' is a previously freed instance.";
  430. OPCODE_BREAK;
  431. }
  432. #else
  433. Object *obj_A = *a;
  434. Object *obj_B = *b;
  435. #endif // DEBUG_ENABLED
  436. GDScript *scr_B = Object::cast_to<GDScript>(obj_B);
  437. if (scr_B) {
  438. //if B is a script, the only valid condition is that A has an instance which inherits from the script
  439. //in other situation, this shoul return false.
  440. if (obj_A->get_script_instance() && obj_A->get_script_instance()->get_language() == GDScriptLanguage::get_singleton()) {
  441. GDScript *cmp = static_cast<GDScript *>(obj_A->get_script_instance()->get_script().ptr());
  442. //bool found=false;
  443. while (cmp) {
  444. if (cmp == scr_B) {
  445. //inherits from script, all ok
  446. extends_ok = true;
  447. break;
  448. }
  449. cmp = cmp->_base;
  450. }
  451. }
  452. } else {
  453. GDScriptNativeClass *nc = Object::cast_to<GDScriptNativeClass>(obj_B);
  454. #ifdef DEBUG_ENABLED
  455. if (!nc) {
  456. err_text = "Right operand of 'is' is not a class (type: '" + obj_B->get_class() + "').";
  457. OPCODE_BREAK;
  458. }
  459. #endif
  460. extends_ok = ClassDB::is_parent_class(obj_A->get_class_name(), nc->get_name());
  461. }
  462. }
  463. *dst = extends_ok;
  464. ip += 4;
  465. }
  466. DISPATCH_OPCODE;
  467. OPCODE(OPCODE_IS_BUILTIN) {
  468. CHECK_SPACE(4);
  469. GET_VARIANT_PTR(value, 1);
  470. Variant::Type var_type = (Variant::Type)_code_ptr[ip + 2];
  471. GET_VARIANT_PTR(dst, 3);
  472. GD_ERR_BREAK(var_type < 0 || var_type >= Variant::VARIANT_MAX);
  473. *dst = value->get_type() == var_type;
  474. ip += 4;
  475. }
  476. DISPATCH_OPCODE;
  477. OPCODE(OPCODE_SET) {
  478. CHECK_SPACE(3);
  479. GET_VARIANT_PTR(dst, 1);
  480. GET_VARIANT_PTR(index, 2);
  481. GET_VARIANT_PTR(value, 3);
  482. bool valid;
  483. dst->set(*index, *value, &valid);
  484. #ifdef DEBUG_ENABLED
  485. if (!valid) {
  486. String v = index->operator String();
  487. if (v != "") {
  488. v = "'" + v + "'";
  489. } else {
  490. v = "of type '" + _get_var_type(index) + "'";
  491. }
  492. err_text = "Invalid set index " + v + " (on base: '" + _get_var_type(dst) + "') with value of type '" + _get_var_type(value) + "'";
  493. OPCODE_BREAK;
  494. }
  495. #endif
  496. ip += 4;
  497. }
  498. DISPATCH_OPCODE;
  499. OPCODE(OPCODE_GET) {
  500. CHECK_SPACE(3);
  501. GET_VARIANT_PTR(src, 1);
  502. GET_VARIANT_PTR(index, 2);
  503. GET_VARIANT_PTR(dst, 3);
  504. bool valid;
  505. #ifdef DEBUG_ENABLED
  506. //allow better error message in cases where src and dst are the same stack position
  507. Variant ret = src->get(*index, &valid);
  508. #else
  509. *dst = src->get(*index, &valid);
  510. #endif
  511. #ifdef DEBUG_ENABLED
  512. if (!valid) {
  513. String v = index->operator String();
  514. if (v != "") {
  515. v = "'" + v + "'";
  516. } else {
  517. v = "of type '" + _get_var_type(index) + "'";
  518. }
  519. err_text = "Invalid get index " + v + " (on base: '" + _get_var_type(src) + "').";
  520. OPCODE_BREAK;
  521. }
  522. *dst = ret;
  523. #endif
  524. ip += 4;
  525. }
  526. DISPATCH_OPCODE;
  527. OPCODE(OPCODE_SET_NAMED) {
  528. CHECK_SPACE(3);
  529. GET_VARIANT_PTR(dst, 1);
  530. GET_VARIANT_PTR(value, 3);
  531. int indexname = _code_ptr[ip + 2];
  532. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  533. const StringName *index = &_global_names_ptr[indexname];
  534. bool valid;
  535. dst->set_named(*index, *value, valid);
  536. #ifdef DEBUG_ENABLED
  537. if (!valid) {
  538. String err_type;
  539. err_text = "Invalid set index '" + String(*index) + "' (on base: '" + _get_var_type(dst) + "') with value of type '" + _get_var_type(value) + "'.";
  540. OPCODE_BREAK;
  541. }
  542. #endif
  543. ip += 4;
  544. }
  545. DISPATCH_OPCODE;
  546. OPCODE(OPCODE_GET_NAMED) {
  547. CHECK_SPACE(4);
  548. GET_VARIANT_PTR(src, 1);
  549. GET_VARIANT_PTR(dst, 3);
  550. int indexname = _code_ptr[ip + 2];
  551. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  552. const StringName *index = &_global_names_ptr[indexname];
  553. bool valid;
  554. #ifdef DEBUG_ENABLED
  555. //allow better error message in cases where src and dst are the same stack position
  556. Variant ret = src->get_named(*index, valid);
  557. #else
  558. *dst = src->get_named(*index, valid);
  559. #endif
  560. #ifdef DEBUG_ENABLED
  561. if (!valid) {
  562. if (src->has_method(*index)) {
  563. err_text = "Invalid get index '" + index->operator String() + "' (on base: '" + _get_var_type(src) + "'). Did you mean '." + index->operator String() + "()' or funcref(obj, \"" + index->operator String() + "\") ?";
  564. } else {
  565. err_text = "Invalid get index '" + index->operator String() + "' (on base: '" + _get_var_type(src) + "').";
  566. }
  567. OPCODE_BREAK;
  568. }
  569. *dst = ret;
  570. #endif
  571. ip += 4;
  572. }
  573. DISPATCH_OPCODE;
  574. OPCODE(OPCODE_SET_MEMBER) {
  575. CHECK_SPACE(3);
  576. int indexname = _code_ptr[ip + 1];
  577. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  578. const StringName *index = &_global_names_ptr[indexname];
  579. GET_VARIANT_PTR(src, 2);
  580. bool valid;
  581. #ifndef DEBUG_ENABLED
  582. ClassDB::set_property(p_instance->owner, *index, *src, &valid);
  583. #else
  584. bool ok = ClassDB::set_property(p_instance->owner, *index, *src, &valid);
  585. if (!ok) {
  586. err_text = "Internal error setting property: " + String(*index);
  587. OPCODE_BREAK;
  588. } else if (!valid) {
  589. err_text = "Error setting property '" + String(*index) + "' with value of type " + Variant::get_type_name(src->get_type()) + ".";
  590. OPCODE_BREAK;
  591. }
  592. #endif
  593. ip += 3;
  594. }
  595. DISPATCH_OPCODE;
  596. OPCODE(OPCODE_GET_MEMBER) {
  597. CHECK_SPACE(3);
  598. int indexname = _code_ptr[ip + 1];
  599. GD_ERR_BREAK(indexname < 0 || indexname >= _global_names_count);
  600. const StringName *index = &_global_names_ptr[indexname];
  601. GET_VARIANT_PTR(dst, 2);
  602. #ifndef DEBUG_ENABLED
  603. ClassDB::get_property(p_instance->owner, *index, *dst);
  604. #else
  605. bool ok = ClassDB::get_property(p_instance->owner, *index, *dst);
  606. if (!ok) {
  607. err_text = "Internal error getting property: " + String(*index);
  608. OPCODE_BREAK;
  609. }
  610. #endif
  611. ip += 3;
  612. }
  613. DISPATCH_OPCODE;
  614. OPCODE(OPCODE_ASSIGN) {
  615. CHECK_SPACE(3);
  616. GET_VARIANT_PTR(dst, 1);
  617. GET_VARIANT_PTR(src, 2);
  618. *dst = *src;
  619. ip += 3;
  620. }
  621. DISPATCH_OPCODE;
  622. OPCODE(OPCODE_ASSIGN_TRUE) {
  623. CHECK_SPACE(2);
  624. GET_VARIANT_PTR(dst, 1);
  625. *dst = true;
  626. ip += 2;
  627. }
  628. DISPATCH_OPCODE;
  629. OPCODE(OPCODE_ASSIGN_FALSE) {
  630. CHECK_SPACE(2);
  631. GET_VARIANT_PTR(dst, 1);
  632. *dst = false;
  633. ip += 2;
  634. }
  635. DISPATCH_OPCODE;
  636. OPCODE(OPCODE_ASSIGN_TYPED_BUILTIN) {
  637. CHECK_SPACE(4);
  638. GET_VARIANT_PTR(dst, 2);
  639. GET_VARIANT_PTR(src, 3);
  640. Variant::Type var_type = (Variant::Type)_code_ptr[ip + 1];
  641. GD_ERR_BREAK(var_type < 0 || var_type >= Variant::VARIANT_MAX);
  642. if (src->get_type() != var_type) {
  643. #ifdef DEBUG_ENABLED
  644. if (Variant::can_convert_strict(src->get_type(), var_type)) {
  645. #endif // DEBUG_ENABLED
  646. Callable::CallError ce;
  647. Variant::construct(var_type, *dst, const_cast<const Variant **>(&src), 1, ce);
  648. } else {
  649. #ifdef DEBUG_ENABLED
  650. err_text = "Trying to assign value of type '" + Variant::get_type_name(src->get_type()) +
  651. "' to a variable of type '" + Variant::get_type_name(var_type) + "'.";
  652. OPCODE_BREAK;
  653. }
  654. } else {
  655. #endif // DEBUG_ENABLED
  656. *dst = *src;
  657. }
  658. ip += 4;
  659. }
  660. DISPATCH_OPCODE;
  661. OPCODE(OPCODE_ASSIGN_TYPED_NATIVE) {
  662. CHECK_SPACE(4);
  663. GET_VARIANT_PTR(dst, 2);
  664. GET_VARIANT_PTR(src, 3);
  665. #ifdef DEBUG_ENABLED
  666. GET_VARIANT_PTR(type, 1);
  667. GDScriptNativeClass *nc = Object::cast_to<GDScriptNativeClass>(type->operator Object *());
  668. GD_ERR_BREAK(!nc);
  669. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  670. err_text = "Trying to assign value of type '" + Variant::get_type_name(src->get_type()) +
  671. "' to a variable of type '" + nc->get_name() + "'.";
  672. OPCODE_BREAK;
  673. }
  674. Object *src_obj = src->operator Object *();
  675. if (src_obj && !ClassDB::is_parent_class(src_obj->get_class_name(), nc->get_name())) {
  676. err_text = "Trying to assign value of type '" + src_obj->get_class_name() +
  677. "' to a variable of type '" + nc->get_name() + "'.";
  678. OPCODE_BREAK;
  679. }
  680. #endif // DEBUG_ENABLED
  681. *dst = *src;
  682. ip += 4;
  683. }
  684. DISPATCH_OPCODE;
  685. OPCODE(OPCODE_ASSIGN_TYPED_SCRIPT) {
  686. CHECK_SPACE(4);
  687. GET_VARIANT_PTR(dst, 2);
  688. GET_VARIANT_PTR(src, 3);
  689. #ifdef DEBUG_ENABLED
  690. GET_VARIANT_PTR(type, 1);
  691. Script *base_type = Object::cast_to<Script>(type->operator Object *());
  692. GD_ERR_BREAK(!base_type);
  693. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  694. err_text = "Trying to assign a non-object value to a variable of type '" + base_type->get_path().get_file() + "'.";
  695. OPCODE_BREAK;
  696. }
  697. if (src->get_type() != Variant::NIL && src->operator Object *() != nullptr) {
  698. ScriptInstance *scr_inst = src->operator Object *()->get_script_instance();
  699. if (!scr_inst) {
  700. err_text = "Trying to assign value of type '" + src->operator Object *()->get_class_name() +
  701. "' to a variable of type '" + base_type->get_path().get_file() + "'.";
  702. OPCODE_BREAK;
  703. }
  704. Script *src_type = src->operator Object *()->get_script_instance()->get_script().ptr();
  705. bool valid = false;
  706. while (src_type) {
  707. if (src_type == base_type) {
  708. valid = true;
  709. break;
  710. }
  711. src_type = src_type->get_base_script().ptr();
  712. }
  713. if (!valid) {
  714. err_text = "Trying to assign value of type '" + src->operator Object *()->get_script_instance()->get_script()->get_path().get_file() +
  715. "' to a variable of type '" + base_type->get_path().get_file() + "'.";
  716. OPCODE_BREAK;
  717. }
  718. }
  719. #endif // DEBUG_ENABLED
  720. *dst = *src;
  721. ip += 4;
  722. }
  723. DISPATCH_OPCODE;
  724. OPCODE(OPCODE_CAST_TO_BUILTIN) {
  725. CHECK_SPACE(4);
  726. Variant::Type to_type = (Variant::Type)_code_ptr[ip + 1];
  727. GET_VARIANT_PTR(src, 2);
  728. GET_VARIANT_PTR(dst, 3);
  729. GD_ERR_BREAK(to_type < 0 || to_type >= Variant::VARIANT_MAX);
  730. Callable::CallError err;
  731. Variant::construct(to_type, *dst, (const Variant **)&src, 1, err);
  732. #ifdef DEBUG_ENABLED
  733. if (err.error != Callable::CallError::CALL_OK) {
  734. err_text = "Invalid cast: could not convert value to '" + Variant::get_type_name(to_type) + "'.";
  735. OPCODE_BREAK;
  736. }
  737. #endif
  738. ip += 4;
  739. }
  740. DISPATCH_OPCODE;
  741. OPCODE(OPCODE_CAST_TO_NATIVE) {
  742. CHECK_SPACE(4);
  743. GET_VARIANT_PTR(to_type, 1);
  744. GET_VARIANT_PTR(src, 2);
  745. GET_VARIANT_PTR(dst, 3);
  746. GDScriptNativeClass *nc = Object::cast_to<GDScriptNativeClass>(to_type->operator Object *());
  747. GD_ERR_BREAK(!nc);
  748. #ifdef DEBUG_ENABLED
  749. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  750. err_text = "Invalid cast: can't convert a non-object value to an object type.";
  751. OPCODE_BREAK;
  752. }
  753. #endif
  754. Object *src_obj = src->operator Object *();
  755. if (src_obj && !ClassDB::is_parent_class(src_obj->get_class_name(), nc->get_name())) {
  756. *dst = Variant(); // invalid cast, assign NULL
  757. } else {
  758. *dst = *src;
  759. }
  760. ip += 4;
  761. }
  762. DISPATCH_OPCODE;
  763. OPCODE(OPCODE_CAST_TO_SCRIPT) {
  764. CHECK_SPACE(4);
  765. GET_VARIANT_PTR(to_type, 1);
  766. GET_VARIANT_PTR(src, 2);
  767. GET_VARIANT_PTR(dst, 3);
  768. Script *base_type = Object::cast_to<Script>(to_type->operator Object *());
  769. GD_ERR_BREAK(!base_type);
  770. #ifdef DEBUG_ENABLED
  771. if (src->get_type() != Variant::OBJECT && src->get_type() != Variant::NIL) {
  772. err_text = "Trying to assign a non-object value to a variable of type '" + base_type->get_path().get_file() + "'.";
  773. OPCODE_BREAK;
  774. }
  775. #endif
  776. bool valid = false;
  777. if (src->get_type() != Variant::NIL && src->operator Object *() != nullptr) {
  778. ScriptInstance *scr_inst = src->operator Object *()->get_script_instance();
  779. if (scr_inst) {
  780. Script *src_type = src->operator Object *()->get_script_instance()->get_script().ptr();
  781. while (src_type) {
  782. if (src_type == base_type) {
  783. valid = true;
  784. break;
  785. }
  786. src_type = src_type->get_base_script().ptr();
  787. }
  788. }
  789. }
  790. if (valid) {
  791. *dst = *src; // Valid cast, copy the source object
  792. } else {
  793. *dst = Variant(); // invalid cast, assign NULL
  794. }
  795. ip += 4;
  796. }
  797. DISPATCH_OPCODE;
  798. OPCODE(OPCODE_CONSTRUCT) {
  799. CHECK_SPACE(2);
  800. Variant::Type t = Variant::Type(_code_ptr[ip + 1]);
  801. int argc = _code_ptr[ip + 2];
  802. CHECK_SPACE(argc + 2);
  803. Variant **argptrs = call_args;
  804. for (int i = 0; i < argc; i++) {
  805. GET_VARIANT_PTR(v, 3 + i);
  806. argptrs[i] = v;
  807. }
  808. GET_VARIANT_PTR(dst, 3 + argc);
  809. Callable::CallError err;
  810. Variant::construct(t, *dst, (const Variant **)argptrs, argc, err);
  811. #ifdef DEBUG_ENABLED
  812. if (err.error != Callable::CallError::CALL_OK) {
  813. err_text = _get_call_error(err, "'" + Variant::get_type_name(t) + "' constructor", (const Variant **)argptrs);
  814. OPCODE_BREAK;
  815. }
  816. #endif
  817. ip += 4 + argc;
  818. //construct a basic type
  819. }
  820. DISPATCH_OPCODE;
  821. OPCODE(OPCODE_CONSTRUCT_ARRAY) {
  822. CHECK_SPACE(1);
  823. int argc = _code_ptr[ip + 1];
  824. Array array; //arrays are always shared
  825. array.resize(argc);
  826. CHECK_SPACE(argc + 2);
  827. for (int i = 0; i < argc; i++) {
  828. GET_VARIANT_PTR(v, 2 + i);
  829. array[i] = *v;
  830. }
  831. GET_VARIANT_PTR(dst, 2 + argc);
  832. *dst = array;
  833. ip += 3 + argc;
  834. }
  835. DISPATCH_OPCODE;
  836. OPCODE(OPCODE_CONSTRUCT_DICTIONARY) {
  837. CHECK_SPACE(1);
  838. int argc = _code_ptr[ip + 1];
  839. Dictionary dict; //arrays are always shared
  840. CHECK_SPACE(argc * 2 + 2);
  841. for (int i = 0; i < argc; i++) {
  842. GET_VARIANT_PTR(k, 2 + i * 2 + 0);
  843. GET_VARIANT_PTR(v, 2 + i * 2 + 1);
  844. dict[*k] = *v;
  845. }
  846. GET_VARIANT_PTR(dst, 2 + argc * 2);
  847. *dst = dict;
  848. ip += 3 + argc * 2;
  849. }
  850. DISPATCH_OPCODE;
  851. OPCODE(OPCODE_CALL_ASYNC)
  852. OPCODE(OPCODE_CALL_RETURN)
  853. OPCODE(OPCODE_CALL) {
  854. CHECK_SPACE(4);
  855. bool call_ret = _code_ptr[ip] != OPCODE_CALL;
  856. #ifdef DEBUG_ENABLED
  857. bool call_async = _code_ptr[ip] == OPCODE_CALL_ASYNC;
  858. #endif
  859. int argc = _code_ptr[ip + 1];
  860. GET_VARIANT_PTR(base, 2);
  861. int nameg = _code_ptr[ip + 3];
  862. GD_ERR_BREAK(nameg < 0 || nameg >= _global_names_count);
  863. const StringName *methodname = &_global_names_ptr[nameg];
  864. GD_ERR_BREAK(argc < 0);
  865. ip += 4;
  866. CHECK_SPACE(argc + 1);
  867. Variant **argptrs = call_args;
  868. for (int i = 0; i < argc; i++) {
  869. GET_VARIANT_PTR(v, i);
  870. argptrs[i] = v;
  871. }
  872. #ifdef DEBUG_ENABLED
  873. uint64_t call_time = 0;
  874. if (GDScriptLanguage::get_singleton()->profiling) {
  875. call_time = OS::get_singleton()->get_ticks_usec();
  876. }
  877. #endif
  878. Callable::CallError err;
  879. if (call_ret) {
  880. GET_VARIANT_PTR(ret, argc);
  881. base->call(*methodname, (const Variant **)argptrs, argc, *ret, err);
  882. #ifdef DEBUG_ENABLED
  883. if (!call_async && ret->get_type() == Variant::OBJECT) {
  884. // Check if getting a function state without await.
  885. bool was_freed = false;
  886. Object *obj = ret->get_validated_object_with_check(was_freed);
  887. if (was_freed) {
  888. err_text = "Got a freed object as a result of the call.";
  889. OPCODE_BREAK;
  890. }
  891. if (obj && obj->is_class_ptr(GDScriptFunctionState::get_class_ptr_static())) {
  892. err_text = R"(Trying to call an async function without "await".)";
  893. OPCODE_BREAK;
  894. }
  895. }
  896. #endif
  897. } else {
  898. Variant ret;
  899. base->call(*methodname, (const Variant **)argptrs, argc, ret, err);
  900. }
  901. #ifdef DEBUG_ENABLED
  902. if (GDScriptLanguage::get_singleton()->profiling) {
  903. function_call_time += OS::get_singleton()->get_ticks_usec() - call_time;
  904. }
  905. if (err.error != Callable::CallError::CALL_OK) {
  906. String methodstr = *methodname;
  907. String basestr = _get_var_type(base);
  908. if (methodstr == "call") {
  909. if (argc >= 1) {
  910. methodstr = String(*argptrs[0]) + " (via call)";
  911. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  912. err.argument += 1;
  913. }
  914. }
  915. } else if (methodstr == "free") {
  916. if (err.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  917. if (base->is_ref()) {
  918. err_text = "Attempted to free a reference.";
  919. OPCODE_BREAK;
  920. } else if (base->get_type() == Variant::OBJECT) {
  921. err_text = "Attempted to free a locked object (calling or emitting).";
  922. OPCODE_BREAK;
  923. }
  924. }
  925. } else if (methodstr == "call_recursive" && basestr == "TreeItem") {
  926. if (argc >= 1) {
  927. methodstr = String(*argptrs[0]) + " (via TreeItem.call_recursive)";
  928. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  929. err.argument += 1;
  930. }
  931. }
  932. }
  933. err_text = _get_call_error(err, "function '" + methodstr + "' in base '" + basestr + "'", (const Variant **)argptrs);
  934. OPCODE_BREAK;
  935. }
  936. #endif
  937. //_call_func(nullptr,base,*methodname,ip,argc,p_instance,stack);
  938. ip += argc + 1;
  939. }
  940. DISPATCH_OPCODE;
  941. OPCODE(OPCODE_CALL_BUILT_IN) {
  942. CHECK_SPACE(4);
  943. GDScriptFunctions::Function func = GDScriptFunctions::Function(_code_ptr[ip + 1]);
  944. int argc = _code_ptr[ip + 2];
  945. GD_ERR_BREAK(argc < 0);
  946. ip += 3;
  947. CHECK_SPACE(argc + 1);
  948. Variant **argptrs = call_args;
  949. for (int i = 0; i < argc; i++) {
  950. GET_VARIANT_PTR(v, i);
  951. argptrs[i] = v;
  952. }
  953. GET_VARIANT_PTR(dst, argc);
  954. Callable::CallError err;
  955. GDScriptFunctions::call(func, (const Variant **)argptrs, argc, *dst, err);
  956. #ifdef DEBUG_ENABLED
  957. if (err.error != Callable::CallError::CALL_OK) {
  958. String methodstr = GDScriptFunctions::get_func_name(func);
  959. if (dst->get_type() == Variant::STRING) {
  960. //call provided error string
  961. err_text = "Error calling built-in function '" + methodstr + "': " + String(*dst);
  962. } else {
  963. err_text = _get_call_error(err, "built-in function '" + methodstr + "'", (const Variant **)argptrs);
  964. }
  965. OPCODE_BREAK;
  966. }
  967. #endif
  968. ip += argc + 1;
  969. }
  970. DISPATCH_OPCODE;
  971. OPCODE(OPCODE_CALL_SELF_BASE) {
  972. CHECK_SPACE(2);
  973. int self_fun = _code_ptr[ip + 1];
  974. #ifdef DEBUG_ENABLED
  975. if (self_fun < 0 || self_fun >= _global_names_count) {
  976. err_text = "compiler bug, function name not found";
  977. OPCODE_BREAK;
  978. }
  979. #endif
  980. const StringName *methodname = &_global_names_ptr[self_fun];
  981. int argc = _code_ptr[ip + 2];
  982. CHECK_SPACE(2 + argc + 1);
  983. Variant **argptrs = call_args;
  984. for (int i = 0; i < argc; i++) {
  985. GET_VARIANT_PTR(v, i + 3);
  986. argptrs[i] = v;
  987. }
  988. GET_VARIANT_PTR(dst, argc + 3);
  989. const GDScript *gds = _script;
  990. const Map<StringName, GDScriptFunction *>::Element *E = nullptr;
  991. while (gds->base.ptr()) {
  992. gds = gds->base.ptr();
  993. E = gds->member_functions.find(*methodname);
  994. if (E) {
  995. break;
  996. }
  997. }
  998. Callable::CallError err;
  999. if (E) {
  1000. *dst = E->get()->call(p_instance, (const Variant **)argptrs, argc, err);
  1001. } else if (gds->native.ptr()) {
  1002. if (*methodname != GDScriptLanguage::get_singleton()->strings._init) {
  1003. MethodBind *mb = ClassDB::get_method(gds->native->get_name(), *methodname);
  1004. if (!mb) {
  1005. err.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1006. } else {
  1007. *dst = mb->call(p_instance->owner, (const Variant **)argptrs, argc, err);
  1008. }
  1009. } else {
  1010. err.error = Callable::CallError::CALL_OK;
  1011. }
  1012. } else {
  1013. if (*methodname != GDScriptLanguage::get_singleton()->strings._init) {
  1014. err.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1015. } else {
  1016. err.error = Callable::CallError::CALL_OK;
  1017. }
  1018. }
  1019. if (err.error != Callable::CallError::CALL_OK) {
  1020. String methodstr = *methodname;
  1021. err_text = _get_call_error(err, "function '" + methodstr + "'", (const Variant **)argptrs);
  1022. OPCODE_BREAK;
  1023. }
  1024. ip += 4 + argc;
  1025. }
  1026. DISPATCH_OPCODE;
  1027. OPCODE(OPCODE_AWAIT) {
  1028. CHECK_SPACE(2);
  1029. //do the oneshot connect
  1030. GET_VARIANT_PTR(argobj, 1);
  1031. Signal sig;
  1032. bool is_signal = true;
  1033. {
  1034. Variant result = *argobj;
  1035. if (argobj->get_type() == Variant::OBJECT) {
  1036. bool was_freed = false;
  1037. Object *obj = argobj->get_validated_object_with_check(was_freed);
  1038. if (was_freed) {
  1039. err_text = "Trying to await on a freed object.";
  1040. OPCODE_BREAK;
  1041. }
  1042. // Is this even possible to be null at this point?
  1043. if (obj) {
  1044. if (obj->is_class_ptr(GDScriptFunctionState::get_class_ptr_static())) {
  1045. static StringName completed = _scs_create("completed");
  1046. result = Signal(obj, completed);
  1047. }
  1048. }
  1049. }
  1050. if (result.get_type() != Variant::SIGNAL) {
  1051. ip += 4; // Skip OPCODE_AWAIT_RESUME and its data.
  1052. // The stack pointer should be the same, so we don't need to set a return value.
  1053. is_signal = false;
  1054. } else {
  1055. sig = result;
  1056. }
  1057. }
  1058. if (is_signal) {
  1059. Ref<GDScriptFunctionState> gdfs = memnew(GDScriptFunctionState);
  1060. gdfs->function = this;
  1061. gdfs->state.stack.resize(alloca_size);
  1062. //copy variant stack
  1063. for (int i = 0; i < _stack_size; i++) {
  1064. memnew_placement(&gdfs->state.stack.write[sizeof(Variant) * i], Variant(stack[i]));
  1065. }
  1066. gdfs->state.stack_size = _stack_size;
  1067. gdfs->state.self = self;
  1068. gdfs->state.alloca_size = alloca_size;
  1069. gdfs->state.ip = ip + 2;
  1070. gdfs->state.line = line;
  1071. gdfs->state.script = _script;
  1072. {
  1073. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1074. _script->pending_func_states.add(&gdfs->scripts_list);
  1075. if (p_instance) {
  1076. gdfs->state.instance = p_instance;
  1077. p_instance->pending_func_states.add(&gdfs->instances_list);
  1078. } else {
  1079. gdfs->state.instance = nullptr;
  1080. }
  1081. }
  1082. #ifdef DEBUG_ENABLED
  1083. gdfs->state.function_name = name;
  1084. gdfs->state.script_path = _script->get_path();
  1085. #endif
  1086. gdfs->state.defarg = defarg;
  1087. gdfs->function = this;
  1088. retvalue = gdfs;
  1089. Error err = sig.connect(Callable(gdfs.ptr(), "_signal_callback"), varray(gdfs), Object::CONNECT_ONESHOT);
  1090. if (err != OK) {
  1091. err_text = "Error connecting to signal: " + sig.get_name() + " during await.";
  1092. OPCODE_BREAK;
  1093. }
  1094. #ifdef DEBUG_ENABLED
  1095. exit_ok = true;
  1096. awaited = true;
  1097. #endif
  1098. OPCODE_BREAK;
  1099. }
  1100. }
  1101. DISPATCH_OPCODE; // Needed for synchronous calls (when result is immediately available).
  1102. OPCODE(OPCODE_AWAIT_RESUME) {
  1103. CHECK_SPACE(2);
  1104. #ifdef DEBUG_ENABLED
  1105. if (!p_state) {
  1106. err_text = ("Invalid Resume (bug?)");
  1107. OPCODE_BREAK;
  1108. }
  1109. #endif
  1110. GET_VARIANT_PTR(result, 1);
  1111. *result = p_state->result;
  1112. ip += 2;
  1113. }
  1114. DISPATCH_OPCODE;
  1115. OPCODE(OPCODE_JUMP) {
  1116. CHECK_SPACE(2);
  1117. int to = _code_ptr[ip + 1];
  1118. GD_ERR_BREAK(to < 0 || to > _code_size);
  1119. ip = to;
  1120. }
  1121. DISPATCH_OPCODE;
  1122. OPCODE(OPCODE_JUMP_IF) {
  1123. CHECK_SPACE(3);
  1124. GET_VARIANT_PTR(test, 1);
  1125. bool result = test->booleanize();
  1126. if (result) {
  1127. int to = _code_ptr[ip + 2];
  1128. GD_ERR_BREAK(to < 0 || to > _code_size);
  1129. ip = to;
  1130. } else {
  1131. ip += 3;
  1132. }
  1133. }
  1134. DISPATCH_OPCODE;
  1135. OPCODE(OPCODE_JUMP_IF_NOT) {
  1136. CHECK_SPACE(3);
  1137. GET_VARIANT_PTR(test, 1);
  1138. bool result = test->booleanize();
  1139. if (!result) {
  1140. int to = _code_ptr[ip + 2];
  1141. GD_ERR_BREAK(to < 0 || to > _code_size);
  1142. ip = to;
  1143. } else {
  1144. ip += 3;
  1145. }
  1146. }
  1147. DISPATCH_OPCODE;
  1148. OPCODE(OPCODE_JUMP_TO_DEF_ARGUMENT) {
  1149. CHECK_SPACE(2);
  1150. ip = _default_arg_ptr[defarg];
  1151. }
  1152. DISPATCH_OPCODE;
  1153. OPCODE(OPCODE_RETURN) {
  1154. CHECK_SPACE(2);
  1155. GET_VARIANT_PTR(r, 1);
  1156. retvalue = *r;
  1157. #ifdef DEBUG_ENABLED
  1158. exit_ok = true;
  1159. #endif
  1160. OPCODE_BREAK;
  1161. }
  1162. OPCODE(OPCODE_ITERATE_BEGIN) {
  1163. CHECK_SPACE(8); //space for this a regular iterate
  1164. GET_VARIANT_PTR(counter, 1);
  1165. GET_VARIANT_PTR(container, 2);
  1166. bool valid;
  1167. if (!container->iter_init(*counter, valid)) {
  1168. #ifdef DEBUG_ENABLED
  1169. if (!valid) {
  1170. err_text = "Unable to iterate on object of type '" + Variant::get_type_name(container->get_type()) + "'.";
  1171. OPCODE_BREAK;
  1172. }
  1173. #endif
  1174. int jumpto = _code_ptr[ip + 3];
  1175. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  1176. ip = jumpto;
  1177. } else {
  1178. GET_VARIANT_PTR(iterator, 4);
  1179. *iterator = container->iter_get(*counter, valid);
  1180. #ifdef DEBUG_ENABLED
  1181. if (!valid) {
  1182. err_text = "Unable to obtain iterator object of type '" + Variant::get_type_name(container->get_type()) + "'.";
  1183. OPCODE_BREAK;
  1184. }
  1185. #endif
  1186. ip += 5; //skip regular iterate which is always next
  1187. }
  1188. }
  1189. DISPATCH_OPCODE;
  1190. OPCODE(OPCODE_ITERATE) {
  1191. CHECK_SPACE(4);
  1192. GET_VARIANT_PTR(counter, 1);
  1193. GET_VARIANT_PTR(container, 2);
  1194. bool valid;
  1195. if (!container->iter_next(*counter, valid)) {
  1196. #ifdef DEBUG_ENABLED
  1197. if (!valid) {
  1198. err_text = "Unable to iterate on object of type '" + Variant::get_type_name(container->get_type()) + "' (type changed since first iteration?).";
  1199. OPCODE_BREAK;
  1200. }
  1201. #endif
  1202. int jumpto = _code_ptr[ip + 3];
  1203. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  1204. ip = jumpto;
  1205. } else {
  1206. GET_VARIANT_PTR(iterator, 4);
  1207. *iterator = container->iter_get(*counter, valid);
  1208. #ifdef DEBUG_ENABLED
  1209. if (!valid) {
  1210. err_text = "Unable to obtain iterator object of type '" + Variant::get_type_name(container->get_type()) + "' (but was obtained on first iteration?).";
  1211. OPCODE_BREAK;
  1212. }
  1213. #endif
  1214. ip += 5; //loop again
  1215. }
  1216. }
  1217. DISPATCH_OPCODE;
  1218. OPCODE(OPCODE_ASSERT) {
  1219. CHECK_SPACE(3);
  1220. #ifdef DEBUG_ENABLED
  1221. GET_VARIANT_PTR(test, 1);
  1222. bool result = test->booleanize();
  1223. if (!result) {
  1224. String message_str;
  1225. if (_code_ptr[ip + 2] != 0) {
  1226. GET_VARIANT_PTR(message, 2);
  1227. message_str = *message;
  1228. }
  1229. if (message_str.empty()) {
  1230. err_text = "Assertion failed.";
  1231. } else {
  1232. err_text = "Assertion failed: " + message_str;
  1233. }
  1234. OPCODE_BREAK;
  1235. }
  1236. #endif
  1237. ip += 3;
  1238. }
  1239. DISPATCH_OPCODE;
  1240. OPCODE(OPCODE_BREAKPOINT) {
  1241. #ifdef DEBUG_ENABLED
  1242. if (EngineDebugger::is_active()) {
  1243. GDScriptLanguage::get_singleton()->debug_break("Breakpoint Statement", true);
  1244. }
  1245. #endif
  1246. ip += 1;
  1247. }
  1248. DISPATCH_OPCODE;
  1249. OPCODE(OPCODE_LINE) {
  1250. CHECK_SPACE(2);
  1251. line = _code_ptr[ip + 1];
  1252. ip += 2;
  1253. if (EngineDebugger::is_active()) {
  1254. // line
  1255. bool do_break = false;
  1256. if (EngineDebugger::get_script_debugger()->get_lines_left() > 0) {
  1257. if (EngineDebugger::get_script_debugger()->get_depth() <= 0) {
  1258. EngineDebugger::get_script_debugger()->set_lines_left(EngineDebugger::get_script_debugger()->get_lines_left() - 1);
  1259. }
  1260. if (EngineDebugger::get_script_debugger()->get_lines_left() <= 0) {
  1261. do_break = true;
  1262. }
  1263. }
  1264. if (EngineDebugger::get_script_debugger()->is_breakpoint(line, source)) {
  1265. do_break = true;
  1266. }
  1267. if (do_break) {
  1268. GDScriptLanguage::get_singleton()->debug_break("Breakpoint", true);
  1269. }
  1270. EngineDebugger::get_singleton()->line_poll();
  1271. }
  1272. }
  1273. DISPATCH_OPCODE;
  1274. OPCODE(OPCODE_END) {
  1275. #ifdef DEBUG_ENABLED
  1276. exit_ok = true;
  1277. #endif
  1278. OPCODE_BREAK;
  1279. }
  1280. #if 0 // Enable for debugging.
  1281. default: {
  1282. err_text = "Illegal opcode " + itos(_code_ptr[ip]) + " at address " + itos(ip);
  1283. OPCODE_BREAK;
  1284. }
  1285. #endif
  1286. }
  1287. OPCODES_END
  1288. #ifdef DEBUG_ENABLED
  1289. if (exit_ok) {
  1290. OPCODE_OUT;
  1291. }
  1292. //error
  1293. // function, file, line, error, explanation
  1294. String err_file;
  1295. if (p_instance && ObjectDB::get_instance(p_instance->owner_id) != nullptr && p_instance->script->is_valid() && p_instance->script->path != "") {
  1296. err_file = p_instance->script->path;
  1297. } else if (script) {
  1298. err_file = script->path;
  1299. }
  1300. if (err_file == "") {
  1301. err_file = "<built-in>";
  1302. }
  1303. String err_func = name;
  1304. if (p_instance && ObjectDB::get_instance(p_instance->owner_id) != nullptr && p_instance->script->is_valid() && p_instance->script->name != "") {
  1305. err_func = p_instance->script->name + "." + err_func;
  1306. }
  1307. int err_line = line;
  1308. if (err_text == "") {
  1309. err_text = "Internal Script Error! - opcode #" + itos(last_opcode) + " (report please).";
  1310. }
  1311. if (!GDScriptLanguage::get_singleton()->debug_break(err_text, false)) {
  1312. // debugger break did not happen
  1313. _err_print_error(err_func.utf8().get_data(), err_file.utf8().get_data(), err_line, err_text.utf8().get_data(), ERR_HANDLER_SCRIPT);
  1314. }
  1315. #endif
  1316. OPCODE_OUT;
  1317. }
  1318. OPCODES_OUT
  1319. #ifdef DEBUG_ENABLED
  1320. if (GDScriptLanguage::get_singleton()->profiling) {
  1321. uint64_t time_taken = OS::get_singleton()->get_ticks_usec() - function_start_time;
  1322. profile.total_time += time_taken;
  1323. profile.self_time += time_taken - function_call_time;
  1324. profile.frame_total_time += time_taken;
  1325. profile.frame_self_time += time_taken - function_call_time;
  1326. GDScriptLanguage::get_singleton()->script_frame_time += time_taken - function_call_time;
  1327. }
  1328. // Check if this is the last time the function is resuming from await
  1329. // Will be true if never awaited as well
  1330. // When it's the last resume it will postpone the exit from stack,
  1331. // so the debugger knows which function triggered the resume of the next function (if any)
  1332. if (!p_state || awaited) {
  1333. if (EngineDebugger::is_active()) {
  1334. GDScriptLanguage::get_singleton()->exit_function();
  1335. }
  1336. #endif
  1337. if (_stack_size) {
  1338. //free stack
  1339. for (int i = 0; i < _stack_size; i++) {
  1340. stack[i].~Variant();
  1341. }
  1342. }
  1343. #ifdef DEBUG_ENABLED
  1344. }
  1345. #endif
  1346. return retvalue;
  1347. }