gdscript_function.cpp 52 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886
  1. /*************************************************************************/
  2. /* gdscript_function.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, _named_globals_count, nullptr);
  103. #endif
  104. StringName id = _named_globals_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, \
  200. &&OPCODE_CALL_SELF_BASE, \
  201. &&OPCODE_AWAIT, \
  202. &&OPCODE_AWAIT_RESUME, \
  203. &&OPCODE_JUMP, \
  204. &&OPCODE_JUMP_IF, \
  205. &&OPCODE_JUMP_IF_NOT, \
  206. &&OPCODE_JUMP_TO_DEF_ARGUMENT, \
  207. &&OPCODE_RETURN, \
  208. &&OPCODE_ITERATE_BEGIN, \
  209. &&OPCODE_ITERATE, \
  210. &&OPCODE_ASSERT, \
  211. &&OPCODE_BREAKPOINT, \
  212. &&OPCODE_LINE, \
  213. &&OPCODE_END \
  214. }; \
  215. 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.");
  216. #define OPCODE(m_op) \
  217. m_op:
  218. #define OPCODE_WHILE(m_test)
  219. #define OPCODES_END \
  220. OPSEXIT:
  221. #define OPCODES_OUT \
  222. OPSOUT:
  223. #define DISPATCH_OPCODE goto *switch_table_ops[_code_ptr[ip]]
  224. #define OPCODE_SWITCH(m_test) DISPATCH_OPCODE;
  225. #define OPCODE_BREAK goto OPSEXIT
  226. #define OPCODE_OUT goto OPSOUT
  227. #else
  228. #define OPCODES_TABLE
  229. #define OPCODE(m_op) case m_op:
  230. #define OPCODE_WHILE(m_test) while (m_test)
  231. #define OPCODES_END
  232. #define OPCODES_OUT
  233. #define DISPATCH_OPCODE continue
  234. #define OPCODE_SWITCH(m_test) switch (m_test)
  235. #define OPCODE_BREAK break
  236. #define OPCODE_OUT break
  237. #endif
  238. Variant GDScriptFunction::call(GDScriptInstance *p_instance, const Variant **p_args, int p_argcount, Callable::CallError &r_err, CallState *p_state) {
  239. OPCODES_TABLE;
  240. if (!_code_ptr) {
  241. return Variant();
  242. }
  243. r_err.error = Callable::CallError::CALL_OK;
  244. Variant self;
  245. Variant static_ref;
  246. Variant retvalue;
  247. Variant *stack = nullptr;
  248. Variant **call_args;
  249. int defarg = 0;
  250. #ifdef DEBUG_ENABLED
  251. //GDScriptLanguage::get_singleton()->calls++;
  252. #endif
  253. uint32_t alloca_size = 0;
  254. GDScript *script;
  255. int ip = 0;
  256. int line = _initial_line;
  257. if (p_state) {
  258. //use existing (supplied) state (awaited)
  259. stack = (Variant *)p_state->stack.ptr();
  260. call_args = (Variant **)&p_state->stack.ptr()[sizeof(Variant) * p_state->stack_size]; //ptr() to avoid bounds check
  261. line = p_state->line;
  262. ip = p_state->ip;
  263. alloca_size = p_state->stack.size();
  264. script = p_state->script;
  265. p_instance = p_state->instance;
  266. defarg = p_state->defarg;
  267. self = p_state->self;
  268. } else {
  269. if (p_argcount != _argument_count) {
  270. if (p_argcount > _argument_count) {
  271. r_err.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  272. r_err.argument = _argument_count;
  273. return Variant();
  274. } else if (p_argcount < _argument_count - _default_arg_count) {
  275. r_err.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  276. r_err.argument = _argument_count - _default_arg_count;
  277. return Variant();
  278. } else {
  279. defarg = _argument_count - p_argcount;
  280. }
  281. }
  282. alloca_size = sizeof(Variant *) * _call_size + sizeof(Variant) * _stack_size;
  283. if (alloca_size) {
  284. uint8_t *aptr = (uint8_t *)alloca(alloca_size);
  285. if (_stack_size) {
  286. stack = (Variant *)aptr;
  287. for (int i = 0; i < p_argcount; i++) {
  288. if (!argument_types[i].has_type) {
  289. memnew_placement(&stack[i], Variant(*p_args[i]));
  290. continue;
  291. }
  292. if (!argument_types[i].is_type(*p_args[i], true)) {
  293. r_err.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  294. r_err.argument = i;
  295. r_err.expected = argument_types[i].kind == GDScriptDataType::BUILTIN ? argument_types[i].builtin_type : Variant::OBJECT;
  296. return Variant();
  297. }
  298. if (argument_types[i].kind == GDScriptDataType::BUILTIN) {
  299. Variant arg = Variant::construct(argument_types[i].builtin_type, &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. *dst = Variant::construct(var_type, 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. *dst = Variant::construct(to_type, (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. *dst = Variant::construct(t, (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_ptr(*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->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. base->call_ptr(*methodname, (const Variant **)argptrs, argc, nullptr, err);
  899. }
  900. #ifdef DEBUG_ENABLED
  901. if (GDScriptLanguage::get_singleton()->profiling) {
  902. function_call_time += OS::get_singleton()->get_ticks_usec() - call_time;
  903. }
  904. if (err.error != Callable::CallError::CALL_OK) {
  905. String methodstr = *methodname;
  906. String basestr = _get_var_type(base);
  907. if (methodstr == "call") {
  908. if (argc >= 1) {
  909. methodstr = String(*argptrs[0]) + " (via call)";
  910. if (err.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  911. err.argument += 1;
  912. }
  913. }
  914. } else if (methodstr == "free") {
  915. if (err.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  916. if (base->is_ref()) {
  917. err_text = "Attempted to free a reference.";
  918. OPCODE_BREAK;
  919. } else if (base->get_type() == Variant::OBJECT) {
  920. err_text = "Attempted to free a locked object (calling or emitting).";
  921. OPCODE_BREAK;
  922. }
  923. }
  924. }
  925. err_text = _get_call_error(err, "function '" + methodstr + "' in base '" + basestr + "'", (const Variant **)argptrs);
  926. OPCODE_BREAK;
  927. }
  928. #endif
  929. //_call_func(nullptr,base,*methodname,ip,argc,p_instance,stack);
  930. ip += argc + 1;
  931. }
  932. DISPATCH_OPCODE;
  933. OPCODE(OPCODE_CALL_BUILT_IN) {
  934. CHECK_SPACE(4);
  935. GDScriptFunctions::Function func = GDScriptFunctions::Function(_code_ptr[ip + 1]);
  936. int argc = _code_ptr[ip + 2];
  937. GD_ERR_BREAK(argc < 0);
  938. ip += 3;
  939. CHECK_SPACE(argc + 1);
  940. Variant **argptrs = call_args;
  941. for (int i = 0; i < argc; i++) {
  942. GET_VARIANT_PTR(v, i);
  943. argptrs[i] = v;
  944. }
  945. GET_VARIANT_PTR(dst, argc);
  946. Callable::CallError err;
  947. GDScriptFunctions::call(func, (const Variant **)argptrs, argc, *dst, err);
  948. #ifdef DEBUG_ENABLED
  949. if (err.error != Callable::CallError::CALL_OK) {
  950. String methodstr = GDScriptFunctions::get_func_name(func);
  951. if (dst->get_type() == Variant::STRING) {
  952. //call provided error string
  953. err_text = "Error calling built-in function '" + methodstr + "': " + String(*dst);
  954. } else {
  955. err_text = _get_call_error(err, "built-in function '" + methodstr + "'", (const Variant **)argptrs);
  956. }
  957. OPCODE_BREAK;
  958. }
  959. #endif
  960. ip += argc + 1;
  961. }
  962. DISPATCH_OPCODE;
  963. OPCODE(OPCODE_CALL_SELF) {
  964. OPCODE_BREAK;
  965. }
  966. OPCODE(OPCODE_CALL_SELF_BASE) {
  967. CHECK_SPACE(2);
  968. int self_fun = _code_ptr[ip + 1];
  969. #ifdef DEBUG_ENABLED
  970. if (self_fun < 0 || self_fun >= _global_names_count) {
  971. err_text = "compiler bug, function name not found";
  972. OPCODE_BREAK;
  973. }
  974. #endif
  975. const StringName *methodname = &_global_names_ptr[self_fun];
  976. int argc = _code_ptr[ip + 2];
  977. CHECK_SPACE(2 + argc + 1);
  978. Variant **argptrs = call_args;
  979. for (int i = 0; i < argc; i++) {
  980. GET_VARIANT_PTR(v, i + 3);
  981. argptrs[i] = v;
  982. }
  983. GET_VARIANT_PTR(dst, argc + 3);
  984. const GDScript *gds = _script;
  985. const Map<StringName, GDScriptFunction *>::Element *E = nullptr;
  986. while (gds->base.ptr()) {
  987. gds = gds->base.ptr();
  988. E = gds->member_functions.find(*methodname);
  989. if (E) {
  990. break;
  991. }
  992. }
  993. Callable::CallError err;
  994. if (E) {
  995. *dst = E->get()->call(p_instance, (const Variant **)argptrs, argc, err);
  996. } else if (gds->native.ptr()) {
  997. if (*methodname != GDScriptLanguage::get_singleton()->strings._init) {
  998. MethodBind *mb = ClassDB::get_method(gds->native->get_name(), *methodname);
  999. if (!mb) {
  1000. err.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1001. } else {
  1002. *dst = mb->call(p_instance->owner, (const Variant **)argptrs, argc, err);
  1003. }
  1004. } else {
  1005. err.error = Callable::CallError::CALL_OK;
  1006. }
  1007. } else {
  1008. if (*methodname != GDScriptLanguage::get_singleton()->strings._init) {
  1009. err.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1010. } else {
  1011. err.error = Callable::CallError::CALL_OK;
  1012. }
  1013. }
  1014. if (err.error != Callable::CallError::CALL_OK) {
  1015. String methodstr = *methodname;
  1016. err_text = _get_call_error(err, "function '" + methodstr + "'", (const Variant **)argptrs);
  1017. OPCODE_BREAK;
  1018. }
  1019. ip += 4 + argc;
  1020. }
  1021. DISPATCH_OPCODE;
  1022. OPCODE(OPCODE_AWAIT) {
  1023. int ipofs = 2;
  1024. CHECK_SPACE(3);
  1025. //do the oneshot connect
  1026. GET_VARIANT_PTR(argobj, 1);
  1027. Signal sig;
  1028. bool is_signal = true;
  1029. {
  1030. Variant result = *argobj;
  1031. if (argobj->get_type() == Variant::OBJECT) {
  1032. bool was_freed = false;
  1033. Object *obj = argobj->get_validated_object_with_check(was_freed);
  1034. if (was_freed) {
  1035. err_text = "Trying to await on a freed object.";
  1036. OPCODE_BREAK;
  1037. }
  1038. // Is this even possible to be null at this point?
  1039. if (obj) {
  1040. if (obj->is_class_ptr(GDScriptFunctionState::get_class_ptr_static())) {
  1041. static StringName completed = _scs_create("completed");
  1042. result = Signal(obj, completed);
  1043. }
  1044. }
  1045. }
  1046. if (result.get_type() != Variant::SIGNAL) {
  1047. ip += 4; // Skip OPCODE_AWAIT_RESUME and its data.
  1048. // The stack pointer should be the same, so we don't need to set a return value.
  1049. is_signal = false;
  1050. } else {
  1051. sig = result;
  1052. }
  1053. }
  1054. if (is_signal) {
  1055. Ref<GDScriptFunctionState> gdfs = memnew(GDScriptFunctionState);
  1056. gdfs->function = this;
  1057. gdfs->state.stack.resize(alloca_size);
  1058. //copy variant stack
  1059. for (int i = 0; i < _stack_size; i++) {
  1060. memnew_placement(&gdfs->state.stack.write[sizeof(Variant) * i], Variant(stack[i]));
  1061. }
  1062. gdfs->state.stack_size = _stack_size;
  1063. gdfs->state.self = self;
  1064. gdfs->state.alloca_size = alloca_size;
  1065. gdfs->state.ip = ip + ipofs;
  1066. gdfs->state.line = line;
  1067. gdfs->state.script = _script;
  1068. {
  1069. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1070. _script->pending_func_states.add(&gdfs->scripts_list);
  1071. if (p_instance) {
  1072. gdfs->state.instance = p_instance;
  1073. p_instance->pending_func_states.add(&gdfs->instances_list);
  1074. } else {
  1075. gdfs->state.instance = nullptr;
  1076. }
  1077. }
  1078. #ifdef DEBUG_ENABLED
  1079. gdfs->state.function_name = name;
  1080. gdfs->state.script_path = _script->get_path();
  1081. #endif
  1082. gdfs->state.defarg = defarg;
  1083. gdfs->function = this;
  1084. retvalue = gdfs;
  1085. Error err = sig.connect(Callable(gdfs.ptr(), "_signal_callback"), varray(gdfs), Object::CONNECT_ONESHOT);
  1086. if (err != OK) {
  1087. err_text = "Error connecting to signal: " + sig.get_name() + " during await.";
  1088. OPCODE_BREAK;
  1089. }
  1090. #ifdef DEBUG_ENABLED
  1091. exit_ok = true;
  1092. awaited = true;
  1093. #endif
  1094. OPCODE_BREAK;
  1095. }
  1096. }
  1097. DISPATCH_OPCODE; // Needed for synchronous calls (when result is immediately available).
  1098. OPCODE(OPCODE_AWAIT_RESUME) {
  1099. CHECK_SPACE(2);
  1100. #ifdef DEBUG_ENABLED
  1101. if (!p_state) {
  1102. err_text = ("Invalid Resume (bug?)");
  1103. OPCODE_BREAK;
  1104. }
  1105. #endif
  1106. GET_VARIANT_PTR(result, 1);
  1107. *result = p_state->result;
  1108. ip += 2;
  1109. }
  1110. DISPATCH_OPCODE;
  1111. OPCODE(OPCODE_JUMP) {
  1112. CHECK_SPACE(2);
  1113. int to = _code_ptr[ip + 1];
  1114. GD_ERR_BREAK(to < 0 || to > _code_size);
  1115. ip = to;
  1116. }
  1117. DISPATCH_OPCODE;
  1118. OPCODE(OPCODE_JUMP_IF) {
  1119. CHECK_SPACE(3);
  1120. GET_VARIANT_PTR(test, 1);
  1121. bool result = test->booleanize();
  1122. if (result) {
  1123. int to = _code_ptr[ip + 2];
  1124. GD_ERR_BREAK(to < 0 || to > _code_size);
  1125. ip = to;
  1126. } else {
  1127. ip += 3;
  1128. }
  1129. }
  1130. DISPATCH_OPCODE;
  1131. OPCODE(OPCODE_JUMP_IF_NOT) {
  1132. CHECK_SPACE(3);
  1133. GET_VARIANT_PTR(test, 1);
  1134. bool result = test->booleanize();
  1135. if (!result) {
  1136. int to = _code_ptr[ip + 2];
  1137. GD_ERR_BREAK(to < 0 || to > _code_size);
  1138. ip = to;
  1139. } else {
  1140. ip += 3;
  1141. }
  1142. }
  1143. DISPATCH_OPCODE;
  1144. OPCODE(OPCODE_JUMP_TO_DEF_ARGUMENT) {
  1145. CHECK_SPACE(2);
  1146. ip = _default_arg_ptr[defarg];
  1147. }
  1148. DISPATCH_OPCODE;
  1149. OPCODE(OPCODE_RETURN) {
  1150. CHECK_SPACE(2);
  1151. GET_VARIANT_PTR(r, 1);
  1152. retvalue = *r;
  1153. #ifdef DEBUG_ENABLED
  1154. exit_ok = true;
  1155. #endif
  1156. OPCODE_BREAK;
  1157. }
  1158. OPCODE(OPCODE_ITERATE_BEGIN) {
  1159. CHECK_SPACE(8); //space for this a regular iterate
  1160. GET_VARIANT_PTR(counter, 1);
  1161. GET_VARIANT_PTR(container, 2);
  1162. bool valid;
  1163. if (!container->iter_init(*counter, valid)) {
  1164. #ifdef DEBUG_ENABLED
  1165. if (!valid) {
  1166. err_text = "Unable to iterate on object of type '" + Variant::get_type_name(container->get_type()) + "'.";
  1167. OPCODE_BREAK;
  1168. }
  1169. #endif
  1170. int jumpto = _code_ptr[ip + 3];
  1171. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  1172. ip = jumpto;
  1173. } else {
  1174. GET_VARIANT_PTR(iterator, 4);
  1175. *iterator = container->iter_get(*counter, valid);
  1176. #ifdef DEBUG_ENABLED
  1177. if (!valid) {
  1178. err_text = "Unable to obtain iterator object of type '" + Variant::get_type_name(container->get_type()) + "'.";
  1179. OPCODE_BREAK;
  1180. }
  1181. #endif
  1182. ip += 5; //skip regular iterate which is always next
  1183. }
  1184. }
  1185. DISPATCH_OPCODE;
  1186. OPCODE(OPCODE_ITERATE) {
  1187. CHECK_SPACE(4);
  1188. GET_VARIANT_PTR(counter, 1);
  1189. GET_VARIANT_PTR(container, 2);
  1190. bool valid;
  1191. if (!container->iter_next(*counter, valid)) {
  1192. #ifdef DEBUG_ENABLED
  1193. if (!valid) {
  1194. err_text = "Unable to iterate on object of type '" + Variant::get_type_name(container->get_type()) + "' (type changed since first iteration?).";
  1195. OPCODE_BREAK;
  1196. }
  1197. #endif
  1198. int jumpto = _code_ptr[ip + 3];
  1199. GD_ERR_BREAK(jumpto < 0 || jumpto > _code_size);
  1200. ip = jumpto;
  1201. } else {
  1202. GET_VARIANT_PTR(iterator, 4);
  1203. *iterator = container->iter_get(*counter, valid);
  1204. #ifdef DEBUG_ENABLED
  1205. if (!valid) {
  1206. err_text = "Unable to obtain iterator object of type '" + Variant::get_type_name(container->get_type()) + "' (but was obtained on first iteration?).";
  1207. OPCODE_BREAK;
  1208. }
  1209. #endif
  1210. ip += 5; //loop again
  1211. }
  1212. }
  1213. DISPATCH_OPCODE;
  1214. OPCODE(OPCODE_ASSERT) {
  1215. CHECK_SPACE(3);
  1216. #ifdef DEBUG_ENABLED
  1217. GET_VARIANT_PTR(test, 1);
  1218. bool result = test->booleanize();
  1219. if (!result) {
  1220. String message_str;
  1221. if (_code_ptr[ip + 2] != 0) {
  1222. GET_VARIANT_PTR(message, 2);
  1223. message_str = *message;
  1224. }
  1225. if (message_str.empty()) {
  1226. err_text = "Assertion failed.";
  1227. } else {
  1228. err_text = "Assertion failed: " + message_str;
  1229. }
  1230. OPCODE_BREAK;
  1231. }
  1232. #endif
  1233. ip += 3;
  1234. }
  1235. DISPATCH_OPCODE;
  1236. OPCODE(OPCODE_BREAKPOINT) {
  1237. #ifdef DEBUG_ENABLED
  1238. if (EngineDebugger::is_active()) {
  1239. GDScriptLanguage::get_singleton()->debug_break("Breakpoint Statement", true);
  1240. }
  1241. #endif
  1242. ip += 1;
  1243. }
  1244. DISPATCH_OPCODE;
  1245. OPCODE(OPCODE_LINE) {
  1246. CHECK_SPACE(2);
  1247. line = _code_ptr[ip + 1];
  1248. ip += 2;
  1249. if (EngineDebugger::is_active()) {
  1250. // line
  1251. bool do_break = false;
  1252. if (EngineDebugger::get_script_debugger()->get_lines_left() > 0) {
  1253. if (EngineDebugger::get_script_debugger()->get_depth() <= 0) {
  1254. EngineDebugger::get_script_debugger()->set_lines_left(EngineDebugger::get_script_debugger()->get_lines_left() - 1);
  1255. }
  1256. if (EngineDebugger::get_script_debugger()->get_lines_left() <= 0) {
  1257. do_break = true;
  1258. }
  1259. }
  1260. if (EngineDebugger::get_script_debugger()->is_breakpoint(line, source)) {
  1261. do_break = true;
  1262. }
  1263. if (do_break) {
  1264. GDScriptLanguage::get_singleton()->debug_break("Breakpoint", true);
  1265. }
  1266. EngineDebugger::get_singleton()->line_poll();
  1267. }
  1268. }
  1269. DISPATCH_OPCODE;
  1270. OPCODE(OPCODE_END) {
  1271. #ifdef DEBUG_ENABLED
  1272. exit_ok = true;
  1273. #endif
  1274. OPCODE_BREAK;
  1275. }
  1276. #if 0 // Enable for debugging.
  1277. default: {
  1278. err_text = "Illegal opcode " + itos(_code_ptr[ip]) + " at address " + itos(ip);
  1279. OPCODE_BREAK;
  1280. }
  1281. #endif
  1282. }
  1283. OPCODES_END
  1284. #ifdef DEBUG_ENABLED
  1285. if (exit_ok) {
  1286. OPCODE_OUT;
  1287. }
  1288. //error
  1289. // function, file, line, error, explanation
  1290. String err_file;
  1291. if (p_instance && ObjectDB::get_instance(p_instance->owner_id) != nullptr && p_instance->script->is_valid() && p_instance->script->path != "") {
  1292. err_file = p_instance->script->path;
  1293. } else if (script) {
  1294. err_file = script->path;
  1295. }
  1296. if (err_file == "") {
  1297. err_file = "<built-in>";
  1298. }
  1299. String err_func = name;
  1300. if (p_instance && ObjectDB::get_instance(p_instance->owner_id) != nullptr && p_instance->script->is_valid() && p_instance->script->name != "") {
  1301. err_func = p_instance->script->name + "." + err_func;
  1302. }
  1303. int err_line = line;
  1304. if (err_text == "") {
  1305. err_text = "Internal Script Error! - opcode #" + itos(last_opcode) + " (report please).";
  1306. }
  1307. if (!GDScriptLanguage::get_singleton()->debug_break(err_text, false)) {
  1308. // debugger break did not happen
  1309. _err_print_error(err_func.utf8().get_data(), err_file.utf8().get_data(), err_line, err_text.utf8().get_data(), ERR_HANDLER_SCRIPT);
  1310. }
  1311. #endif
  1312. OPCODE_OUT;
  1313. }
  1314. OPCODES_OUT
  1315. #ifdef DEBUG_ENABLED
  1316. if (GDScriptLanguage::get_singleton()->profiling) {
  1317. uint64_t time_taken = OS::get_singleton()->get_ticks_usec() - function_start_time;
  1318. profile.total_time += time_taken;
  1319. profile.self_time += time_taken - function_call_time;
  1320. profile.frame_total_time += time_taken;
  1321. profile.frame_self_time += time_taken - function_call_time;
  1322. GDScriptLanguage::get_singleton()->script_frame_time += time_taken - function_call_time;
  1323. }
  1324. // Check if this is the last time the function is resuming from await
  1325. // Will be true if never awaited as well
  1326. // When it's the last resume it will postpone the exit from stack,
  1327. // so the debugger knows which function triggered the resume of the next function (if any)
  1328. if (!p_state || awaited) {
  1329. if (EngineDebugger::is_active()) {
  1330. GDScriptLanguage::get_singleton()->exit_function();
  1331. }
  1332. #endif
  1333. if (_stack_size) {
  1334. //free stack
  1335. for (int i = 0; i < _stack_size; i++) {
  1336. stack[i].~Variant();
  1337. }
  1338. }
  1339. #ifdef DEBUG_ENABLED
  1340. }
  1341. #endif
  1342. return retvalue;
  1343. }
  1344. const int *GDScriptFunction::get_code() const {
  1345. return _code_ptr;
  1346. }
  1347. int GDScriptFunction::get_code_size() const {
  1348. return _code_size;
  1349. }
  1350. Variant GDScriptFunction::get_constant(int p_idx) const {
  1351. ERR_FAIL_INDEX_V(p_idx, constants.size(), "<errconst>");
  1352. return constants[p_idx];
  1353. }
  1354. StringName GDScriptFunction::get_global_name(int p_idx) const {
  1355. ERR_FAIL_INDEX_V(p_idx, global_names.size(), "<errgname>");
  1356. return global_names[p_idx];
  1357. }
  1358. int GDScriptFunction::get_default_argument_count() const {
  1359. return _default_arg_count;
  1360. }
  1361. int GDScriptFunction::get_default_argument_addr(int p_idx) const {
  1362. ERR_FAIL_INDEX_V(p_idx, default_arguments.size(), -1);
  1363. return default_arguments[p_idx];
  1364. }
  1365. GDScriptDataType GDScriptFunction::get_return_type() const {
  1366. return return_type;
  1367. }
  1368. GDScriptDataType GDScriptFunction::get_argument_type(int p_idx) const {
  1369. ERR_FAIL_INDEX_V(p_idx, argument_types.size(), GDScriptDataType());
  1370. return argument_types[p_idx];
  1371. }
  1372. StringName GDScriptFunction::get_name() const {
  1373. return name;
  1374. }
  1375. int GDScriptFunction::get_max_stack_size() const {
  1376. return _stack_size;
  1377. }
  1378. struct _GDFKC {
  1379. int order;
  1380. List<int> pos;
  1381. };
  1382. struct _GDFKCS {
  1383. int order;
  1384. StringName id;
  1385. int pos;
  1386. bool operator<(const _GDFKCS &p_r) const {
  1387. return order < p_r.order;
  1388. }
  1389. };
  1390. void GDScriptFunction::debug_get_stack_member_state(int p_line, List<Pair<StringName, int>> *r_stackvars) const {
  1391. int oc = 0;
  1392. Map<StringName, _GDFKC> sdmap;
  1393. for (const List<StackDebug>::Element *E = stack_debug.front(); E; E = E->next()) {
  1394. const StackDebug &sd = E->get();
  1395. if (sd.line > p_line) {
  1396. break;
  1397. }
  1398. if (sd.added) {
  1399. if (!sdmap.has(sd.identifier)) {
  1400. _GDFKC d;
  1401. d.order = oc++;
  1402. d.pos.push_back(sd.pos);
  1403. sdmap[sd.identifier] = d;
  1404. } else {
  1405. sdmap[sd.identifier].pos.push_back(sd.pos);
  1406. }
  1407. } else {
  1408. ERR_CONTINUE(!sdmap.has(sd.identifier));
  1409. sdmap[sd.identifier].pos.pop_back();
  1410. if (sdmap[sd.identifier].pos.empty()) {
  1411. sdmap.erase(sd.identifier);
  1412. }
  1413. }
  1414. }
  1415. List<_GDFKCS> stackpositions;
  1416. for (Map<StringName, _GDFKC>::Element *E = sdmap.front(); E; E = E->next()) {
  1417. _GDFKCS spp;
  1418. spp.id = E->key();
  1419. spp.order = E->get().order;
  1420. spp.pos = E->get().pos.back()->get();
  1421. stackpositions.push_back(spp);
  1422. }
  1423. stackpositions.sort();
  1424. for (List<_GDFKCS>::Element *E = stackpositions.front(); E; E = E->next()) {
  1425. Pair<StringName, int> p;
  1426. p.first = E->get().id;
  1427. p.second = E->get().pos;
  1428. r_stackvars->push_back(p);
  1429. }
  1430. }
  1431. GDScriptFunction::GDScriptFunction() :
  1432. function_list(this) {
  1433. _stack_size = 0;
  1434. _call_size = 0;
  1435. rpc_mode = MultiplayerAPI::RPC_MODE_DISABLED;
  1436. name = "<anonymous>";
  1437. #ifdef DEBUG_ENABLED
  1438. _func_cname = nullptr;
  1439. {
  1440. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1441. GDScriptLanguage::get_singleton()->function_list.add(&function_list);
  1442. }
  1443. profile.call_count = 0;
  1444. profile.self_time = 0;
  1445. profile.total_time = 0;
  1446. profile.frame_call_count = 0;
  1447. profile.frame_self_time = 0;
  1448. profile.frame_total_time = 0;
  1449. profile.last_frame_call_count = 0;
  1450. profile.last_frame_self_time = 0;
  1451. profile.last_frame_total_time = 0;
  1452. #endif
  1453. }
  1454. GDScriptFunction::~GDScriptFunction() {
  1455. #ifdef DEBUG_ENABLED
  1456. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1457. GDScriptLanguage::get_singleton()->function_list.remove(&function_list);
  1458. #endif
  1459. }
  1460. /////////////////////
  1461. Variant GDScriptFunctionState::_signal_callback(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1462. Variant arg;
  1463. r_error.error = Callable::CallError::CALL_OK;
  1464. if (p_argcount == 0) {
  1465. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1466. r_error.argument = 1;
  1467. return Variant();
  1468. } else if (p_argcount == 1) {
  1469. //noooneee
  1470. } else if (p_argcount == 2) {
  1471. arg = *p_args[0];
  1472. } else {
  1473. Array extra_args;
  1474. for (int i = 0; i < p_argcount - 1; i++) {
  1475. extra_args.push_back(*p_args[i]);
  1476. }
  1477. arg = extra_args;
  1478. }
  1479. Ref<GDScriptFunctionState> self = *p_args[p_argcount - 1];
  1480. if (self.is_null()) {
  1481. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  1482. r_error.argument = p_argcount - 1;
  1483. r_error.expected = Variant::OBJECT;
  1484. return Variant();
  1485. }
  1486. return resume(arg);
  1487. }
  1488. bool GDScriptFunctionState::is_valid(bool p_extended_check) const {
  1489. if (function == nullptr) {
  1490. return false;
  1491. }
  1492. if (p_extended_check) {
  1493. MutexLock lock(GDScriptLanguage::get_singleton()->lock);
  1494. // Script gone?
  1495. if (!scripts_list.in_list()) {
  1496. return false;
  1497. }
  1498. // Class instance gone? (if not static function)
  1499. if (state.instance && !instances_list.in_list()) {
  1500. return false;
  1501. }
  1502. }
  1503. return true;
  1504. }
  1505. Variant GDScriptFunctionState::resume(const Variant &p_arg) {
  1506. ERR_FAIL_COND_V(!function, Variant());
  1507. {
  1508. MutexLock lock(GDScriptLanguage::singleton->lock);
  1509. if (!scripts_list.in_list()) {
  1510. #ifdef DEBUG_ENABLED
  1511. ERR_FAIL_V_MSG(Variant(), "Resumed function '" + state.function_name + "()' after await, but script is gone. At script: " + state.script_path + ":" + itos(state.line));
  1512. #else
  1513. return Variant();
  1514. #endif
  1515. }
  1516. if (state.instance && !instances_list.in_list()) {
  1517. #ifdef DEBUG_ENABLED
  1518. ERR_FAIL_V_MSG(Variant(), "Resumed function '" + state.function_name + "()' after await, but class instance is gone. At script: " + state.script_path + ":" + itos(state.line));
  1519. #else
  1520. return Variant();
  1521. #endif
  1522. }
  1523. // Do these now to avoid locking again after the call
  1524. scripts_list.remove_from_list();
  1525. instances_list.remove_from_list();
  1526. }
  1527. state.result = p_arg;
  1528. Callable::CallError err;
  1529. Variant ret = function->call(nullptr, nullptr, 0, err, &state);
  1530. bool completed = true;
  1531. // If the return value is a GDScriptFunctionState reference,
  1532. // then the function did awaited again after resuming.
  1533. if (ret.is_ref()) {
  1534. GDScriptFunctionState *gdfs = Object::cast_to<GDScriptFunctionState>(ret);
  1535. if (gdfs && gdfs->function == function) {
  1536. completed = false;
  1537. gdfs->first_state = first_state.is_valid() ? first_state : Ref<GDScriptFunctionState>(this);
  1538. }
  1539. }
  1540. function = nullptr; //cleaned up;
  1541. state.result = Variant();
  1542. if (completed) {
  1543. if (first_state.is_valid()) {
  1544. first_state->emit_signal("completed", ret);
  1545. } else {
  1546. emit_signal("completed", ret);
  1547. }
  1548. #ifdef DEBUG_ENABLED
  1549. if (EngineDebugger::is_active()) {
  1550. GDScriptLanguage::get_singleton()->exit_function();
  1551. }
  1552. #endif
  1553. }
  1554. return ret;
  1555. }
  1556. void GDScriptFunctionState::_clear_stack() {
  1557. if (state.stack_size) {
  1558. Variant *stack = (Variant *)state.stack.ptr();
  1559. for (int i = 0; i < state.stack_size; i++) {
  1560. stack[i].~Variant();
  1561. }
  1562. state.stack_size = 0;
  1563. }
  1564. }
  1565. void GDScriptFunctionState::_bind_methods() {
  1566. ClassDB::bind_method(D_METHOD("resume", "arg"), &GDScriptFunctionState::resume, DEFVAL(Variant()));
  1567. ClassDB::bind_method(D_METHOD("is_valid", "extended_check"), &GDScriptFunctionState::is_valid, DEFVAL(false));
  1568. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "_signal_callback", &GDScriptFunctionState::_signal_callback, MethodInfo("_signal_callback"));
  1569. ADD_SIGNAL(MethodInfo("completed", PropertyInfo(Variant::NIL, "result", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NIL_IS_VARIANT)));
  1570. }
  1571. GDScriptFunctionState::GDScriptFunctionState() :
  1572. scripts_list(this),
  1573. instances_list(this) {
  1574. function = nullptr;
  1575. }
  1576. GDScriptFunctionState::~GDScriptFunctionState() {
  1577. _clear_stack();
  1578. {
  1579. MutexLock lock(GDScriptLanguage::singleton->lock);
  1580. scripts_list.remove_from_list();
  1581. instances_list.remove_from_list();
  1582. }
  1583. }