gdscript_byte_codegen.cpp 56 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597
  1. /*************************************************************************/
  2. /* gdscript_byte_codegen.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 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_byte_codegen.h"
  31. #include "core/debugger/engine_debugger.h"
  32. #include "gdscript.h"
  33. uint32_t GDScriptByteCodeGenerator::add_parameter(const StringName &p_name, bool p_is_optional, const GDScriptDataType &p_type) {
  34. #ifdef TOOLS_ENABLED
  35. function->arg_names.push_back(p_name);
  36. #endif
  37. function->_argument_count++;
  38. function->argument_types.push_back(p_type);
  39. if (p_is_optional) {
  40. function->_default_arg_count++;
  41. }
  42. return add_local(p_name, p_type);
  43. }
  44. uint32_t GDScriptByteCodeGenerator::add_local(const StringName &p_name, const GDScriptDataType &p_type) {
  45. int stack_pos = locals.size() + RESERVED_STACK;
  46. locals.push_back(StackSlot(p_type.builtin_type));
  47. add_stack_identifier(p_name, stack_pos);
  48. return stack_pos;
  49. }
  50. uint32_t GDScriptByteCodeGenerator::add_local_constant(const StringName &p_name, const Variant &p_constant) {
  51. int index = add_or_get_constant(p_constant);
  52. local_constants[p_name] = index;
  53. return index;
  54. }
  55. uint32_t GDScriptByteCodeGenerator::add_or_get_constant(const Variant &p_constant) {
  56. return get_constant_pos(p_constant);
  57. }
  58. uint32_t GDScriptByteCodeGenerator::add_or_get_name(const StringName &p_name) {
  59. return get_name_map_pos(p_name);
  60. }
  61. uint32_t GDScriptByteCodeGenerator::add_temporary(const GDScriptDataType &p_type) {
  62. Variant::Type temp_type = Variant::NIL;
  63. if (p_type.has_type) {
  64. if (p_type.kind == GDScriptDataType::BUILTIN) {
  65. switch (p_type.builtin_type) {
  66. case Variant::NIL:
  67. case Variant::BOOL:
  68. case Variant::INT:
  69. case Variant::FLOAT:
  70. case Variant::STRING:
  71. case Variant::VECTOR2:
  72. case Variant::VECTOR2I:
  73. case Variant::RECT2:
  74. case Variant::RECT2I:
  75. case Variant::VECTOR3:
  76. case Variant::VECTOR3I:
  77. case Variant::TRANSFORM2D:
  78. case Variant::PLANE:
  79. case Variant::QUAT:
  80. case Variant::AABB:
  81. case Variant::BASIS:
  82. case Variant::TRANSFORM:
  83. case Variant::COLOR:
  84. case Variant::STRING_NAME:
  85. case Variant::NODE_PATH:
  86. case Variant::RID:
  87. case Variant::OBJECT:
  88. case Variant::CALLABLE:
  89. case Variant::SIGNAL:
  90. case Variant::DICTIONARY:
  91. case Variant::ARRAY:
  92. temp_type = p_type.builtin_type;
  93. break;
  94. case Variant::PACKED_BYTE_ARRAY:
  95. case Variant::PACKED_INT32_ARRAY:
  96. case Variant::PACKED_INT64_ARRAY:
  97. case Variant::PACKED_FLOAT32_ARRAY:
  98. case Variant::PACKED_FLOAT64_ARRAY:
  99. case Variant::PACKED_STRING_ARRAY:
  100. case Variant::PACKED_VECTOR2_ARRAY:
  101. case Variant::PACKED_VECTOR3_ARRAY:
  102. case Variant::PACKED_COLOR_ARRAY:
  103. case Variant::VARIANT_MAX:
  104. // Packed arrays are reference counted, so we don't use the pool for them.
  105. temp_type = Variant::NIL;
  106. break;
  107. }
  108. } else {
  109. temp_type = Variant::OBJECT;
  110. }
  111. }
  112. if (!temporaries_pool.has(temp_type)) {
  113. temporaries_pool[temp_type] = List<int>();
  114. }
  115. List<int> &pool = temporaries_pool[temp_type];
  116. if (pool.is_empty()) {
  117. StackSlot new_temp(temp_type);
  118. int idx = temporaries.size();
  119. pool.push_back(idx);
  120. temporaries.push_back(new_temp);
  121. // First time using this, so adjust to the proper type.
  122. if (temp_type != Variant::NIL) {
  123. Address addr(Address::TEMPORARY, idx, p_type);
  124. write_type_adjust(addr, temp_type);
  125. }
  126. }
  127. int slot = pool.front()->get();
  128. pool.pop_front();
  129. used_temporaries.push_back(slot);
  130. return slot;
  131. }
  132. void GDScriptByteCodeGenerator::pop_temporary() {
  133. ERR_FAIL_COND(used_temporaries.is_empty());
  134. int slot_idx = used_temporaries.back()->get();
  135. const StackSlot &slot = temporaries[slot_idx];
  136. temporaries_pool[slot.type].push_back(slot_idx);
  137. used_temporaries.pop_back();
  138. }
  139. void GDScriptByteCodeGenerator::start_parameters() {
  140. if (function->_default_arg_count > 0) {
  141. append(GDScriptFunction::OPCODE_JUMP_TO_DEF_ARGUMENT);
  142. function->default_arguments.push_back(opcodes.size());
  143. }
  144. }
  145. void GDScriptByteCodeGenerator::end_parameters() {
  146. function->default_arguments.reverse();
  147. }
  148. void GDScriptByteCodeGenerator::write_start(GDScript *p_script, const StringName &p_function_name, bool p_static, MultiplayerAPI::RPCMode p_rpc_mode, const GDScriptDataType &p_return_type) {
  149. function = memnew(GDScriptFunction);
  150. debug_stack = EngineDebugger::is_active();
  151. function->name = p_function_name;
  152. function->_script = p_script;
  153. function->source = p_script->get_path();
  154. #ifdef DEBUG_ENABLED
  155. function->func_cname = (String(function->source) + " - " + String(p_function_name)).utf8();
  156. function->_func_cname = function->func_cname.get_data();
  157. #endif
  158. function->_static = p_static;
  159. function->return_type = p_return_type;
  160. function->rpc_mode = p_rpc_mode;
  161. function->_argument_count = 0;
  162. }
  163. GDScriptFunction *GDScriptByteCodeGenerator::write_end() {
  164. #ifdef DEBUG_ENABLED
  165. if (!used_temporaries.is_empty()) {
  166. ERR_PRINT("Non-zero temporary variables at end of function: " + itos(used_temporaries.size()));
  167. }
  168. #endif
  169. append(GDScriptFunction::OPCODE_END, 0);
  170. for (int i = 0; i < temporaries.size(); i++) {
  171. for (int j = 0; j < temporaries[i].bytecode_indices.size(); j++) {
  172. opcodes.write[temporaries[i].bytecode_indices[j]] = (i + max_locals + RESERVED_STACK) | (GDScriptFunction::ADDR_TYPE_STACK << GDScriptFunction::ADDR_BITS);
  173. }
  174. }
  175. if (constant_map.size()) {
  176. function->_constant_count = constant_map.size();
  177. function->constants.resize(constant_map.size());
  178. function->_constants_ptr = function->constants.ptrw();
  179. const Variant *K = nullptr;
  180. while ((K = constant_map.next(K))) {
  181. int idx = constant_map[*K];
  182. function->constants.write[idx] = *K;
  183. }
  184. } else {
  185. function->_constants_ptr = nullptr;
  186. function->_constant_count = 0;
  187. }
  188. if (name_map.size()) {
  189. function->global_names.resize(name_map.size());
  190. function->_global_names_ptr = &function->global_names[0];
  191. for (Map<StringName, int>::Element *E = name_map.front(); E; E = E->next()) {
  192. function->global_names.write[E->get()] = E->key();
  193. }
  194. function->_global_names_count = function->global_names.size();
  195. } else {
  196. function->_global_names_ptr = nullptr;
  197. function->_global_names_count = 0;
  198. }
  199. if (opcodes.size()) {
  200. function->code = opcodes;
  201. function->_code_ptr = &function->code[0];
  202. function->_code_size = opcodes.size();
  203. } else {
  204. function->_code_ptr = nullptr;
  205. function->_code_size = 0;
  206. }
  207. if (function->default_arguments.size()) {
  208. function->_default_arg_count = function->default_arguments.size() - 1;
  209. function->_default_arg_ptr = &function->default_arguments[0];
  210. } else {
  211. function->_default_arg_count = 0;
  212. function->_default_arg_ptr = nullptr;
  213. }
  214. if (operator_func_map.size()) {
  215. function->operator_funcs.resize(operator_func_map.size());
  216. function->_operator_funcs_count = function->operator_funcs.size();
  217. function->_operator_funcs_ptr = function->operator_funcs.ptr();
  218. for (const Map<Variant::ValidatedOperatorEvaluator, int>::Element *E = operator_func_map.front(); E; E = E->next()) {
  219. function->operator_funcs.write[E->get()] = E->key();
  220. }
  221. } else {
  222. function->_operator_funcs_count = 0;
  223. function->_operator_funcs_ptr = nullptr;
  224. }
  225. if (setters_map.size()) {
  226. function->setters.resize(setters_map.size());
  227. function->_setters_count = function->setters.size();
  228. function->_setters_ptr = function->setters.ptr();
  229. for (const Map<Variant::ValidatedSetter, int>::Element *E = setters_map.front(); E; E = E->next()) {
  230. function->setters.write[E->get()] = E->key();
  231. }
  232. } else {
  233. function->_setters_count = 0;
  234. function->_setters_ptr = nullptr;
  235. }
  236. if (getters_map.size()) {
  237. function->getters.resize(getters_map.size());
  238. function->_getters_count = function->getters.size();
  239. function->_getters_ptr = function->getters.ptr();
  240. for (const Map<Variant::ValidatedGetter, int>::Element *E = getters_map.front(); E; E = E->next()) {
  241. function->getters.write[E->get()] = E->key();
  242. }
  243. } else {
  244. function->_getters_count = 0;
  245. function->_getters_ptr = nullptr;
  246. }
  247. if (keyed_setters_map.size()) {
  248. function->keyed_setters.resize(keyed_setters_map.size());
  249. function->_keyed_setters_count = function->keyed_setters.size();
  250. function->_keyed_setters_ptr = function->keyed_setters.ptr();
  251. for (const Map<Variant::ValidatedKeyedSetter, int>::Element *E = keyed_setters_map.front(); E; E = E->next()) {
  252. function->keyed_setters.write[E->get()] = E->key();
  253. }
  254. } else {
  255. function->_keyed_setters_count = 0;
  256. function->_keyed_setters_ptr = nullptr;
  257. }
  258. if (keyed_getters_map.size()) {
  259. function->keyed_getters.resize(keyed_getters_map.size());
  260. function->_keyed_getters_count = function->keyed_getters.size();
  261. function->_keyed_getters_ptr = function->keyed_getters.ptr();
  262. for (const Map<Variant::ValidatedKeyedGetter, int>::Element *E = keyed_getters_map.front(); E; E = E->next()) {
  263. function->keyed_getters.write[E->get()] = E->key();
  264. }
  265. } else {
  266. function->_keyed_getters_count = 0;
  267. function->_keyed_getters_ptr = nullptr;
  268. }
  269. if (indexed_setters_map.size()) {
  270. function->indexed_setters.resize(indexed_setters_map.size());
  271. function->_indexed_setters_count = function->indexed_setters.size();
  272. function->_indexed_setters_ptr = function->indexed_setters.ptr();
  273. for (const Map<Variant::ValidatedIndexedSetter, int>::Element *E = indexed_setters_map.front(); E; E = E->next()) {
  274. function->indexed_setters.write[E->get()] = E->key();
  275. }
  276. } else {
  277. function->_indexed_setters_count = 0;
  278. function->_indexed_setters_ptr = nullptr;
  279. }
  280. if (indexed_getters_map.size()) {
  281. function->indexed_getters.resize(indexed_getters_map.size());
  282. function->_indexed_getters_count = function->indexed_getters.size();
  283. function->_indexed_getters_ptr = function->indexed_getters.ptr();
  284. for (const Map<Variant::ValidatedIndexedGetter, int>::Element *E = indexed_getters_map.front(); E; E = E->next()) {
  285. function->indexed_getters.write[E->get()] = E->key();
  286. }
  287. } else {
  288. function->_indexed_getters_count = 0;
  289. function->_indexed_getters_ptr = nullptr;
  290. }
  291. if (builtin_method_map.size()) {
  292. function->builtin_methods.resize(builtin_method_map.size());
  293. function->_builtin_methods_ptr = function->builtin_methods.ptr();
  294. function->_builtin_methods_count = builtin_method_map.size();
  295. for (const Map<Variant::ValidatedBuiltInMethod, int>::Element *E = builtin_method_map.front(); E; E = E->next()) {
  296. function->builtin_methods.write[E->get()] = E->key();
  297. }
  298. } else {
  299. function->_builtin_methods_ptr = nullptr;
  300. function->_builtin_methods_count = 0;
  301. }
  302. if (constructors_map.size()) {
  303. function->constructors.resize(constructors_map.size());
  304. function->_constructors_ptr = function->constructors.ptr();
  305. function->_constructors_count = constructors_map.size();
  306. for (const Map<Variant::ValidatedConstructor, int>::Element *E = constructors_map.front(); E; E = E->next()) {
  307. function->constructors.write[E->get()] = E->key();
  308. }
  309. } else {
  310. function->_constructors_ptr = nullptr;
  311. function->_constructors_count = 0;
  312. }
  313. if (utilities_map.size()) {
  314. function->utilities.resize(utilities_map.size());
  315. function->_utilities_ptr = function->utilities.ptr();
  316. function->_utilities_count = utilities_map.size();
  317. for (const Map<Variant::ValidatedUtilityFunction, int>::Element *E = utilities_map.front(); E; E = E->next()) {
  318. function->utilities.write[E->get()] = E->key();
  319. }
  320. } else {
  321. function->_utilities_ptr = nullptr;
  322. function->_utilities_count = 0;
  323. }
  324. if (gds_utilities_map.size()) {
  325. function->gds_utilities.resize(gds_utilities_map.size());
  326. function->_gds_utilities_ptr = function->gds_utilities.ptr();
  327. function->_gds_utilities_count = gds_utilities_map.size();
  328. for (const Map<GDScriptUtilityFunctions::FunctionPtr, int>::Element *E = gds_utilities_map.front(); E; E = E->next()) {
  329. function->gds_utilities.write[E->get()] = E->key();
  330. }
  331. } else {
  332. function->_gds_utilities_ptr = nullptr;
  333. function->_gds_utilities_count = 0;
  334. }
  335. if (method_bind_map.size()) {
  336. function->methods.resize(method_bind_map.size());
  337. function->_methods_ptr = function->methods.ptrw();
  338. function->_methods_count = method_bind_map.size();
  339. for (const Map<MethodBind *, int>::Element *E = method_bind_map.front(); E; E = E->next()) {
  340. function->methods.write[E->get()] = E->key();
  341. }
  342. } else {
  343. function->_methods_ptr = nullptr;
  344. function->_methods_count = 0;
  345. }
  346. if (lambdas_map.size()) {
  347. function->lambdas.resize(lambdas_map.size());
  348. function->_lambdas_ptr = function->lambdas.ptrw();
  349. function->_lambdas_count = lambdas_map.size();
  350. for (const Map<GDScriptFunction *, int>::Element *E = lambdas_map.front(); E; E = E->next()) {
  351. function->lambdas.write[E->get()] = E->key();
  352. }
  353. } else {
  354. function->_lambdas_ptr = nullptr;
  355. function->_lambdas_count = 0;
  356. }
  357. if (debug_stack) {
  358. function->stack_debug = stack_debug;
  359. }
  360. function->_stack_size = RESERVED_STACK + max_locals + temporaries.size();
  361. function->_instruction_args_size = instr_args_max;
  362. function->_ptrcall_args_size = ptrcall_max;
  363. ended = true;
  364. return function;
  365. }
  366. #ifdef DEBUG_ENABLED
  367. void GDScriptByteCodeGenerator::set_signature(const String &p_signature) {
  368. function->profile.signature = p_signature;
  369. }
  370. #endif
  371. void GDScriptByteCodeGenerator::set_initial_line(int p_line) {
  372. function->_initial_line = p_line;
  373. }
  374. #define HAS_BUILTIN_TYPE(m_var) \
  375. (m_var.type.has_type && m_var.type.kind == GDScriptDataType::BUILTIN)
  376. #define IS_BUILTIN_TYPE(m_var, m_type) \
  377. (m_var.type.has_type && m_var.type.kind == GDScriptDataType::BUILTIN && m_var.type.builtin_type == m_type)
  378. void GDScriptByteCodeGenerator::write_type_adjust(const Address &p_target, Variant::Type p_new_type) {
  379. switch (p_new_type) {
  380. case Variant::BOOL:
  381. append(GDScriptFunction::OPCODE_TYPE_ADJUST_BOOL, 1);
  382. break;
  383. case Variant::INT:
  384. append(GDScriptFunction::OPCODE_TYPE_ADJUST_INT, 1);
  385. break;
  386. case Variant::FLOAT:
  387. append(GDScriptFunction::OPCODE_TYPE_ADJUST_FLOAT, 1);
  388. break;
  389. case Variant::STRING:
  390. append(GDScriptFunction::OPCODE_TYPE_ADJUST_STRING, 1);
  391. break;
  392. case Variant::VECTOR2:
  393. append(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR2, 1);
  394. break;
  395. case Variant::VECTOR2I:
  396. append(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR2I, 1);
  397. break;
  398. case Variant::RECT2:
  399. append(GDScriptFunction::OPCODE_TYPE_ADJUST_RECT2, 1);
  400. break;
  401. case Variant::RECT2I:
  402. append(GDScriptFunction::OPCODE_TYPE_ADJUST_RECT2I, 1);
  403. break;
  404. case Variant::VECTOR3:
  405. append(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3, 1);
  406. break;
  407. case Variant::VECTOR3I:
  408. append(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3I, 1);
  409. break;
  410. case Variant::TRANSFORM2D:
  411. append(GDScriptFunction::OPCODE_TYPE_ADJUST_TRANSFORM2D, 1);
  412. break;
  413. case Variant::PLANE:
  414. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PLANE, 1);
  415. break;
  416. case Variant::QUAT:
  417. append(GDScriptFunction::OPCODE_TYPE_ADJUST_QUAT, 1);
  418. break;
  419. case Variant::AABB:
  420. append(GDScriptFunction::OPCODE_TYPE_ADJUST_AABB, 1);
  421. break;
  422. case Variant::BASIS:
  423. append(GDScriptFunction::OPCODE_TYPE_ADJUST_BASIS, 1);
  424. break;
  425. case Variant::TRANSFORM:
  426. append(GDScriptFunction::OPCODE_TYPE_ADJUST_TRANSFORM, 1);
  427. break;
  428. case Variant::COLOR:
  429. append(GDScriptFunction::OPCODE_TYPE_ADJUST_COLOR, 1);
  430. break;
  431. case Variant::STRING_NAME:
  432. append(GDScriptFunction::OPCODE_TYPE_ADJUST_STRING_NAME, 1);
  433. break;
  434. case Variant::NODE_PATH:
  435. append(GDScriptFunction::OPCODE_TYPE_ADJUST_NODE_PATH, 1);
  436. break;
  437. case Variant::RID:
  438. append(GDScriptFunction::OPCODE_TYPE_ADJUST_RID, 1);
  439. break;
  440. case Variant::OBJECT:
  441. append(GDScriptFunction::OPCODE_TYPE_ADJUST_OBJECT, 1);
  442. break;
  443. case Variant::CALLABLE:
  444. append(GDScriptFunction::OPCODE_TYPE_ADJUST_CALLABLE, 1);
  445. break;
  446. case Variant::SIGNAL:
  447. append(GDScriptFunction::OPCODE_TYPE_ADJUST_SIGNAL, 1);
  448. break;
  449. case Variant::DICTIONARY:
  450. append(GDScriptFunction::OPCODE_TYPE_ADJUST_DICTIONARY, 1);
  451. break;
  452. case Variant::ARRAY:
  453. append(GDScriptFunction::OPCODE_TYPE_ADJUST_ARRAY, 1);
  454. break;
  455. case Variant::PACKED_BYTE_ARRAY:
  456. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_BYTE_ARRAY, 1);
  457. break;
  458. case Variant::PACKED_INT32_ARRAY:
  459. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_INT32_ARRAY, 1);
  460. break;
  461. case Variant::PACKED_INT64_ARRAY:
  462. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_INT64_ARRAY, 1);
  463. break;
  464. case Variant::PACKED_FLOAT32_ARRAY:
  465. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_FLOAT32_ARRAY, 1);
  466. break;
  467. case Variant::PACKED_FLOAT64_ARRAY:
  468. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_FLOAT64_ARRAY, 1);
  469. break;
  470. case Variant::PACKED_STRING_ARRAY:
  471. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_STRING_ARRAY, 1);
  472. break;
  473. case Variant::PACKED_VECTOR2_ARRAY:
  474. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_VECTOR2_ARRAY, 1);
  475. break;
  476. case Variant::PACKED_VECTOR3_ARRAY:
  477. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_VECTOR3_ARRAY, 1);
  478. break;
  479. case Variant::PACKED_COLOR_ARRAY:
  480. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_COLOR_ARRAY, 1);
  481. break;
  482. case Variant::NIL:
  483. case Variant::VARIANT_MAX:
  484. return;
  485. }
  486. append(p_target);
  487. }
  488. void GDScriptByteCodeGenerator::write_unary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand) {
  489. if (HAS_BUILTIN_TYPE(p_left_operand)) {
  490. // Gather specific operator.
  491. Variant::ValidatedOperatorEvaluator op_func = Variant::get_validated_operator_evaluator(p_operator, p_left_operand.type.builtin_type, Variant::NIL);
  492. append(GDScriptFunction::OPCODE_OPERATOR_VALIDATED, 3);
  493. append(p_left_operand);
  494. append(Address());
  495. append(p_target);
  496. append(op_func);
  497. return;
  498. }
  499. // No specific types, perform variant evaluation.
  500. append(GDScriptFunction::OPCODE_OPERATOR, 3);
  501. append(p_left_operand);
  502. append(Address());
  503. append(p_target);
  504. append(p_operator);
  505. }
  506. void GDScriptByteCodeGenerator::write_binary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand, const Address &p_right_operand) {
  507. if (HAS_BUILTIN_TYPE(p_left_operand) && HAS_BUILTIN_TYPE(p_right_operand)) {
  508. // Gather specific operator.
  509. Variant::ValidatedOperatorEvaluator op_func = Variant::get_validated_operator_evaluator(p_operator, p_left_operand.type.builtin_type, p_right_operand.type.builtin_type);
  510. append(GDScriptFunction::OPCODE_OPERATOR_VALIDATED, 3);
  511. append(p_left_operand);
  512. append(p_right_operand);
  513. append(p_target);
  514. append(op_func);
  515. return;
  516. }
  517. // No specific types, perform variant evaluation.
  518. append(GDScriptFunction::OPCODE_OPERATOR, 3);
  519. append(p_left_operand);
  520. append(p_right_operand);
  521. append(p_target);
  522. append(p_operator);
  523. }
  524. void GDScriptByteCodeGenerator::write_type_test(const Address &p_target, const Address &p_source, const Address &p_type) {
  525. append(GDScriptFunction::OPCODE_EXTENDS_TEST, 3);
  526. append(p_source);
  527. append(p_type);
  528. append(p_target);
  529. }
  530. void GDScriptByteCodeGenerator::write_type_test_builtin(const Address &p_target, const Address &p_source, Variant::Type p_type) {
  531. append(GDScriptFunction::OPCODE_IS_BUILTIN, 2);
  532. append(p_source);
  533. append(p_target);
  534. append(p_type);
  535. }
  536. void GDScriptByteCodeGenerator::write_and_left_operand(const Address &p_left_operand) {
  537. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  538. append(p_left_operand);
  539. logic_op_jump_pos1.push_back(opcodes.size());
  540. append(0); // Jump target, will be patched.
  541. }
  542. void GDScriptByteCodeGenerator::write_and_right_operand(const Address &p_right_operand) {
  543. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  544. append(p_right_operand);
  545. logic_op_jump_pos2.push_back(opcodes.size());
  546. append(0); // Jump target, will be patched.
  547. }
  548. void GDScriptByteCodeGenerator::write_end_and(const Address &p_target) {
  549. // If here means both operands are true.
  550. append(GDScriptFunction::OPCODE_ASSIGN_TRUE, 1);
  551. append(p_target);
  552. // Jump away from the fail condition.
  553. append(GDScriptFunction::OPCODE_JUMP, 0);
  554. append(opcodes.size() + 3);
  555. // Here it means one of operands is false.
  556. patch_jump(logic_op_jump_pos1.back()->get());
  557. patch_jump(logic_op_jump_pos2.back()->get());
  558. logic_op_jump_pos1.pop_back();
  559. logic_op_jump_pos2.pop_back();
  560. append(GDScriptFunction::OPCODE_ASSIGN_FALSE, 1);
  561. append(p_target);
  562. }
  563. void GDScriptByteCodeGenerator::write_or_left_operand(const Address &p_left_operand) {
  564. append(GDScriptFunction::OPCODE_JUMP_IF, 1);
  565. append(p_left_operand);
  566. logic_op_jump_pos1.push_back(opcodes.size());
  567. append(0); // Jump target, will be patched.
  568. }
  569. void GDScriptByteCodeGenerator::write_or_right_operand(const Address &p_right_operand) {
  570. append(GDScriptFunction::OPCODE_JUMP_IF, 1);
  571. append(p_right_operand);
  572. logic_op_jump_pos2.push_back(opcodes.size());
  573. append(0); // Jump target, will be patched.
  574. }
  575. void GDScriptByteCodeGenerator::write_end_or(const Address &p_target) {
  576. // If here means both operands are false.
  577. append(GDScriptFunction::OPCODE_ASSIGN_FALSE, 1);
  578. append(p_target);
  579. // Jump away from the success condition.
  580. append(GDScriptFunction::OPCODE_JUMP, 0);
  581. append(opcodes.size() + 3);
  582. // Here it means one of operands is true.
  583. patch_jump(logic_op_jump_pos1.back()->get());
  584. patch_jump(logic_op_jump_pos2.back()->get());
  585. logic_op_jump_pos1.pop_back();
  586. logic_op_jump_pos2.pop_back();
  587. append(GDScriptFunction::OPCODE_ASSIGN_TRUE, 1);
  588. append(p_target);
  589. }
  590. void GDScriptByteCodeGenerator::write_start_ternary(const Address &p_target) {
  591. ternary_result.push_back(p_target);
  592. }
  593. void GDScriptByteCodeGenerator::write_ternary_condition(const Address &p_condition) {
  594. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  595. append(p_condition);
  596. ternary_jump_fail_pos.push_back(opcodes.size());
  597. append(0); // Jump target, will be patched.
  598. }
  599. void GDScriptByteCodeGenerator::write_ternary_true_expr(const Address &p_expr) {
  600. append(GDScriptFunction::OPCODE_ASSIGN, 2);
  601. append(ternary_result.back()->get());
  602. append(p_expr);
  603. // Jump away from the false path.
  604. append(GDScriptFunction::OPCODE_JUMP, 0);
  605. ternary_jump_skip_pos.push_back(opcodes.size());
  606. append(0);
  607. // Fail must jump here.
  608. patch_jump(ternary_jump_fail_pos.back()->get());
  609. ternary_jump_fail_pos.pop_back();
  610. }
  611. void GDScriptByteCodeGenerator::write_ternary_false_expr(const Address &p_expr) {
  612. append(GDScriptFunction::OPCODE_ASSIGN, 2);
  613. append(ternary_result.back()->get());
  614. append(p_expr);
  615. }
  616. void GDScriptByteCodeGenerator::write_end_ternary() {
  617. patch_jump(ternary_jump_skip_pos.back()->get());
  618. ternary_jump_skip_pos.pop_back();
  619. }
  620. void GDScriptByteCodeGenerator::write_set(const Address &p_target, const Address &p_index, const Address &p_source) {
  621. if (HAS_BUILTIN_TYPE(p_target)) {
  622. if (IS_BUILTIN_TYPE(p_index, Variant::INT) && Variant::get_member_validated_indexed_setter(p_target.type.builtin_type)) {
  623. // Use indexed setter instead.
  624. Variant::ValidatedIndexedSetter setter = Variant::get_member_validated_indexed_setter(p_target.type.builtin_type);
  625. append(GDScriptFunction::OPCODE_SET_INDEXED_VALIDATED, 3);
  626. append(p_target);
  627. append(p_index);
  628. append(p_source);
  629. append(setter);
  630. return;
  631. } else if (Variant::get_member_validated_keyed_setter(p_target.type.builtin_type)) {
  632. Variant::ValidatedKeyedSetter setter = Variant::get_member_validated_keyed_setter(p_target.type.builtin_type);
  633. append(GDScriptFunction::OPCODE_SET_KEYED_VALIDATED, 3);
  634. append(p_target);
  635. append(p_index);
  636. append(p_source);
  637. append(setter);
  638. return;
  639. }
  640. }
  641. append(GDScriptFunction::OPCODE_SET_KEYED, 3);
  642. append(p_target);
  643. append(p_index);
  644. append(p_source);
  645. }
  646. void GDScriptByteCodeGenerator::write_get(const Address &p_target, const Address &p_index, const Address &p_source) {
  647. if (HAS_BUILTIN_TYPE(p_source)) {
  648. if (IS_BUILTIN_TYPE(p_index, Variant::INT) && Variant::get_member_validated_indexed_getter(p_source.type.builtin_type)) {
  649. // Use indexed getter instead.
  650. Variant::ValidatedIndexedGetter getter = Variant::get_member_validated_indexed_getter(p_source.type.builtin_type);
  651. append(GDScriptFunction::OPCODE_GET_INDEXED_VALIDATED, 3);
  652. append(p_source);
  653. append(p_index);
  654. append(p_target);
  655. append(getter);
  656. return;
  657. } else if (Variant::get_member_validated_keyed_getter(p_source.type.builtin_type)) {
  658. Variant::ValidatedKeyedGetter getter = Variant::get_member_validated_keyed_getter(p_source.type.builtin_type);
  659. append(GDScriptFunction::OPCODE_GET_KEYED_VALIDATED, 3);
  660. append(p_source);
  661. append(p_index);
  662. append(p_target);
  663. append(getter);
  664. return;
  665. }
  666. }
  667. append(GDScriptFunction::OPCODE_GET_KEYED, 3);
  668. append(p_source);
  669. append(p_index);
  670. append(p_target);
  671. }
  672. void GDScriptByteCodeGenerator::write_set_named(const Address &p_target, const StringName &p_name, const Address &p_source) {
  673. if (HAS_BUILTIN_TYPE(p_target) && Variant::get_member_validated_setter(p_target.type.builtin_type, p_name)) {
  674. Variant::ValidatedSetter setter = Variant::get_member_validated_setter(p_target.type.builtin_type, p_name);
  675. append(GDScriptFunction::OPCODE_SET_NAMED_VALIDATED, 2);
  676. append(p_target);
  677. append(p_source);
  678. append(setter);
  679. return;
  680. }
  681. append(GDScriptFunction::OPCODE_SET_NAMED, 2);
  682. append(p_target);
  683. append(p_source);
  684. append(p_name);
  685. }
  686. void GDScriptByteCodeGenerator::write_get_named(const Address &p_target, const StringName &p_name, const Address &p_source) {
  687. if (HAS_BUILTIN_TYPE(p_source) && Variant::get_member_validated_getter(p_source.type.builtin_type, p_name)) {
  688. Variant::ValidatedGetter getter = Variant::get_member_validated_getter(p_source.type.builtin_type, p_name);
  689. append(GDScriptFunction::OPCODE_GET_NAMED_VALIDATED, 2);
  690. append(p_source);
  691. append(p_target);
  692. append(getter);
  693. return;
  694. }
  695. append(GDScriptFunction::OPCODE_GET_NAMED, 2);
  696. append(p_source);
  697. append(p_target);
  698. append(p_name);
  699. }
  700. void GDScriptByteCodeGenerator::write_set_member(const Address &p_value, const StringName &p_name) {
  701. append(GDScriptFunction::OPCODE_SET_MEMBER, 1);
  702. append(p_value);
  703. append(p_name);
  704. }
  705. void GDScriptByteCodeGenerator::write_get_member(const Address &p_target, const StringName &p_name) {
  706. append(GDScriptFunction::OPCODE_GET_MEMBER, 1);
  707. append(p_target);
  708. append(p_name);
  709. }
  710. void GDScriptByteCodeGenerator::write_assign(const Address &p_target, const Address &p_source) {
  711. if (p_target.type.has_type && !p_source.type.has_type) {
  712. // Typed assignment.
  713. switch (p_target.type.kind) {
  714. case GDScriptDataType::BUILTIN: {
  715. if (p_target.type.builtin_type == Variant::ARRAY && p_target.type.has_container_element_type()) {
  716. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_ARRAY, 2);
  717. append(p_target);
  718. append(p_source);
  719. } else {
  720. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_BUILTIN, 2);
  721. append(p_target);
  722. append(p_source);
  723. append(p_target.type.builtin_type);
  724. }
  725. } break;
  726. case GDScriptDataType::NATIVE: {
  727. int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[p_target.type.native_type];
  728. Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
  729. class_idx = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  730. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_NATIVE, 3);
  731. append(p_target);
  732. append(p_source);
  733. append(class_idx);
  734. } break;
  735. case GDScriptDataType::SCRIPT:
  736. case GDScriptDataType::GDSCRIPT: {
  737. Variant script = p_target.type.script_type;
  738. int idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  739. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_SCRIPT, 3);
  740. append(p_target);
  741. append(p_source);
  742. append(idx);
  743. } break;
  744. default: {
  745. ERR_PRINT("Compiler bug: unresolved assign.");
  746. // Shouldn't get here, but fail-safe to a regular assignment
  747. append(GDScriptFunction::OPCODE_ASSIGN, 2);
  748. append(p_target);
  749. append(p_source);
  750. }
  751. }
  752. } else {
  753. if (p_target.type.kind == GDScriptDataType::BUILTIN && p_target.type.builtin_type == Variant::ARRAY && p_target.type.has_container_element_type()) {
  754. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_ARRAY, 2);
  755. append(p_target);
  756. append(p_source);
  757. } else if (p_target.type.kind == GDScriptDataType::BUILTIN && p_source.type.kind == GDScriptDataType::BUILTIN && p_target.type.builtin_type != p_source.type.builtin_type) {
  758. // Need conversion..
  759. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_BUILTIN, 2);
  760. append(p_target);
  761. append(p_source);
  762. append(p_target.type.builtin_type);
  763. } else {
  764. // Either untyped assignment or already type-checked by the parser
  765. append(GDScriptFunction::OPCODE_ASSIGN, 2);
  766. append(p_target);
  767. append(p_source);
  768. }
  769. }
  770. }
  771. void GDScriptByteCodeGenerator::write_assign_true(const Address &p_target) {
  772. append(GDScriptFunction::OPCODE_ASSIGN_TRUE, 1);
  773. append(p_target);
  774. }
  775. void GDScriptByteCodeGenerator::write_assign_false(const Address &p_target) {
  776. append(GDScriptFunction::OPCODE_ASSIGN_FALSE, 1);
  777. append(p_target);
  778. }
  779. void GDScriptByteCodeGenerator::write_assign_default_parameter(const Address &p_dst, const Address &p_src) {
  780. write_assign(p_dst, p_src);
  781. function->default_arguments.push_back(opcodes.size());
  782. }
  783. void GDScriptByteCodeGenerator::write_store_named_global(const Address &p_dst, const StringName &p_global) {
  784. append(GDScriptFunction::OPCODE_STORE_NAMED_GLOBAL, 1);
  785. append(p_dst);
  786. append(p_global);
  787. }
  788. void GDScriptByteCodeGenerator::write_cast(const Address &p_target, const Address &p_source, const GDScriptDataType &p_type) {
  789. int index = 0;
  790. switch (p_type.kind) {
  791. case GDScriptDataType::BUILTIN: {
  792. append(GDScriptFunction::OPCODE_CAST_TO_BUILTIN, 2);
  793. index = p_type.builtin_type;
  794. } break;
  795. case GDScriptDataType::NATIVE: {
  796. int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[p_type.native_type];
  797. Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
  798. append(GDScriptFunction::OPCODE_CAST_TO_NATIVE, 3);
  799. index = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  800. } break;
  801. case GDScriptDataType::SCRIPT:
  802. case GDScriptDataType::GDSCRIPT: {
  803. Variant script = p_type.script_type;
  804. int idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  805. append(GDScriptFunction::OPCODE_CAST_TO_SCRIPT, 3);
  806. index = idx;
  807. } break;
  808. default: {
  809. return;
  810. }
  811. }
  812. append(p_source);
  813. append(p_target);
  814. append(index);
  815. }
  816. void GDScriptByteCodeGenerator::write_call(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  817. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
  818. for (int i = 0; i < p_arguments.size(); i++) {
  819. append(p_arguments[i]);
  820. }
  821. append(p_base);
  822. append(p_target);
  823. append(p_arguments.size());
  824. append(p_function_name);
  825. }
  826. void GDScriptByteCodeGenerator::write_super_call(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  827. append(GDScriptFunction::OPCODE_CALL_SELF_BASE, 1 + p_arguments.size());
  828. for (int i = 0; i < p_arguments.size(); i++) {
  829. append(p_arguments[i]);
  830. }
  831. append(p_target);
  832. append(p_arguments.size());
  833. append(p_function_name);
  834. }
  835. void GDScriptByteCodeGenerator::write_call_async(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  836. append(GDScriptFunction::OPCODE_CALL_ASYNC, 2 + p_arguments.size());
  837. for (int i = 0; i < p_arguments.size(); i++) {
  838. append(p_arguments[i]);
  839. }
  840. append(p_base);
  841. append(p_target);
  842. append(p_arguments.size());
  843. append(p_function_name);
  844. }
  845. void GDScriptByteCodeGenerator::write_call_gdscript_utility(const Address &p_target, GDScriptUtilityFunctions::FunctionPtr p_function, const Vector<Address> &p_arguments) {
  846. append(GDScriptFunction::OPCODE_CALL_GDSCRIPT_UTILITY, 1 + p_arguments.size());
  847. for (int i = 0; i < p_arguments.size(); i++) {
  848. append(p_arguments[i]);
  849. }
  850. append(p_target);
  851. append(p_arguments.size());
  852. append(p_function);
  853. }
  854. void GDScriptByteCodeGenerator::write_call_utility(const Address &p_target, const StringName &p_function, const Vector<Address> &p_arguments) {
  855. bool is_validated = true;
  856. if (Variant::is_utility_function_vararg(p_function)) {
  857. is_validated = true; // Vararg works fine with any argument, since they can be any type.
  858. } else if (p_arguments.size() == Variant::get_utility_function_argument_count(p_function)) {
  859. bool all_types_exact = true;
  860. for (int i = 0; i < p_arguments.size(); i++) {
  861. if (!IS_BUILTIN_TYPE(p_arguments[i], Variant::get_utility_function_argument_type(p_function, i))) {
  862. all_types_exact = false;
  863. break;
  864. }
  865. }
  866. is_validated = all_types_exact;
  867. }
  868. if (is_validated) {
  869. append(GDScriptFunction::OPCODE_CALL_UTILITY_VALIDATED, 1 + p_arguments.size());
  870. for (int i = 0; i < p_arguments.size(); i++) {
  871. append(p_arguments[i]);
  872. }
  873. append(p_target);
  874. append(p_arguments.size());
  875. append(Variant::get_validated_utility_function(p_function));
  876. } else {
  877. append(GDScriptFunction::OPCODE_CALL_UTILITY, 1 + p_arguments.size());
  878. for (int i = 0; i < p_arguments.size(); i++) {
  879. append(p_arguments[i]);
  880. }
  881. append(p_target);
  882. append(p_arguments.size());
  883. append(p_function);
  884. }
  885. }
  886. void GDScriptByteCodeGenerator::write_call_builtin_type(const Address &p_target, const Address &p_base, Variant::Type p_type, const StringName &p_method, const Vector<Address> &p_arguments) {
  887. bool is_validated = false;
  888. // Check if all types are correct.
  889. if (Variant::is_builtin_method_vararg(p_type, p_method)) {
  890. is_validated = true; // Vararg works fine with any argument, since they can be any type.
  891. } else if (p_arguments.size() == Variant::get_builtin_method_argument_count(p_type, p_method)) {
  892. bool all_types_exact = true;
  893. for (int i = 0; i < p_arguments.size(); i++) {
  894. if (!IS_BUILTIN_TYPE(p_arguments[i], Variant::get_builtin_method_argument_type(p_type, p_method, i))) {
  895. all_types_exact = false;
  896. break;
  897. }
  898. }
  899. is_validated = all_types_exact;
  900. }
  901. if (!is_validated) {
  902. // Perform regular call.
  903. write_call(p_target, p_base, p_method, p_arguments);
  904. return;
  905. }
  906. if (p_target.mode == Address::TEMPORARY) {
  907. Variant::Type result_type = Variant::get_builtin_method_return_type(p_type, p_method);
  908. Variant::Type temp_type = temporaries[p_target.address].type;
  909. if (result_type != temp_type) {
  910. write_type_adjust(p_target, result_type);
  911. }
  912. }
  913. append(GDScriptFunction::OPCODE_CALL_BUILTIN_TYPE_VALIDATED, 2 + p_arguments.size());
  914. for (int i = 0; i < p_arguments.size(); i++) {
  915. append(p_arguments[i]);
  916. }
  917. append(p_base);
  918. append(p_target);
  919. append(p_arguments.size());
  920. append(Variant::get_validated_builtin_method(p_type, p_method));
  921. }
  922. void GDScriptByteCodeGenerator::write_call_method_bind(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) {
  923. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL_METHOD_BIND : GDScriptFunction::OPCODE_CALL_METHOD_BIND_RET, 2 + p_arguments.size());
  924. for (int i = 0; i < p_arguments.size(); i++) {
  925. append(p_arguments[i]);
  926. }
  927. append(p_base);
  928. append(p_target);
  929. append(p_arguments.size());
  930. append(p_method);
  931. }
  932. void GDScriptByteCodeGenerator::write_call_ptrcall(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) {
  933. #define CASE_TYPE(m_type) \
  934. case Variant::m_type: \
  935. append(GDScriptFunction::OPCODE_CALL_PTRCALL_##m_type, 2 + p_arguments.size()); \
  936. break
  937. bool is_ptrcall = true;
  938. if (p_method->has_return()) {
  939. MethodInfo info;
  940. ClassDB::get_method_info(p_method->get_instance_class(), p_method->get_name(), &info);
  941. switch (info.return_val.type) {
  942. CASE_TYPE(BOOL);
  943. CASE_TYPE(INT);
  944. CASE_TYPE(FLOAT);
  945. CASE_TYPE(STRING);
  946. CASE_TYPE(VECTOR2);
  947. CASE_TYPE(VECTOR2I);
  948. CASE_TYPE(RECT2);
  949. CASE_TYPE(RECT2I);
  950. CASE_TYPE(VECTOR3);
  951. CASE_TYPE(VECTOR3I);
  952. CASE_TYPE(TRANSFORM2D);
  953. CASE_TYPE(PLANE);
  954. CASE_TYPE(AABB);
  955. CASE_TYPE(BASIS);
  956. CASE_TYPE(TRANSFORM);
  957. CASE_TYPE(COLOR);
  958. CASE_TYPE(STRING_NAME);
  959. CASE_TYPE(NODE_PATH);
  960. CASE_TYPE(RID);
  961. CASE_TYPE(QUAT);
  962. CASE_TYPE(OBJECT);
  963. CASE_TYPE(CALLABLE);
  964. CASE_TYPE(SIGNAL);
  965. CASE_TYPE(DICTIONARY);
  966. CASE_TYPE(ARRAY);
  967. CASE_TYPE(PACKED_BYTE_ARRAY);
  968. CASE_TYPE(PACKED_INT32_ARRAY);
  969. CASE_TYPE(PACKED_INT64_ARRAY);
  970. CASE_TYPE(PACKED_FLOAT32_ARRAY);
  971. CASE_TYPE(PACKED_FLOAT64_ARRAY);
  972. CASE_TYPE(PACKED_STRING_ARRAY);
  973. CASE_TYPE(PACKED_VECTOR2_ARRAY);
  974. CASE_TYPE(PACKED_VECTOR3_ARRAY);
  975. CASE_TYPE(PACKED_COLOR_ARRAY);
  976. default:
  977. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL_METHOD_BIND : GDScriptFunction::OPCODE_CALL_METHOD_BIND_RET, 2 + p_arguments.size());
  978. is_ptrcall = false;
  979. break;
  980. }
  981. } else {
  982. append(GDScriptFunction::OPCODE_CALL_PTRCALL_NO_RETURN, 2 + p_arguments.size());
  983. }
  984. for (int i = 0; i < p_arguments.size(); i++) {
  985. append(p_arguments[i]);
  986. }
  987. append(p_base);
  988. append(p_target);
  989. append(p_arguments.size());
  990. append(p_method);
  991. if (is_ptrcall) {
  992. alloc_ptrcall(p_arguments.size());
  993. }
  994. #undef CASE_TYPE
  995. }
  996. void GDScriptByteCodeGenerator::write_call_self(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  997. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
  998. for (int i = 0; i < p_arguments.size(); i++) {
  999. append(p_arguments[i]);
  1000. }
  1001. append(GDScriptFunction::ADDR_TYPE_STACK << GDScriptFunction::ADDR_BITS);
  1002. append(p_target);
  1003. append(p_arguments.size());
  1004. append(p_function_name);
  1005. }
  1006. void GDScriptByteCodeGenerator::write_call_self_async(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  1007. append(GDScriptFunction::OPCODE_CALL_ASYNC, 2 + p_arguments.size());
  1008. for (int i = 0; i < p_arguments.size(); i++) {
  1009. append(p_arguments[i]);
  1010. }
  1011. append(GDScriptFunction::ADDR_SELF);
  1012. append(p_target);
  1013. append(p_arguments.size());
  1014. append(p_function_name);
  1015. }
  1016. void GDScriptByteCodeGenerator::write_call_script_function(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  1017. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
  1018. for (int i = 0; i < p_arguments.size(); i++) {
  1019. append(p_arguments[i]);
  1020. }
  1021. append(p_base);
  1022. append(p_target);
  1023. append(p_arguments.size());
  1024. append(p_function_name);
  1025. }
  1026. void GDScriptByteCodeGenerator::write_lambda(const Address &p_target, GDScriptFunction *p_function, const Vector<Address> &p_captures) {
  1027. append(GDScriptFunction::OPCODE_CREATE_LAMBDA, 1 + p_captures.size());
  1028. for (int i = 0; i < p_captures.size(); i++) {
  1029. append(p_captures[i]);
  1030. }
  1031. append(p_target);
  1032. append(p_captures.size());
  1033. append(p_function);
  1034. }
  1035. void GDScriptByteCodeGenerator::write_construct(const Address &p_target, Variant::Type p_type, const Vector<Address> &p_arguments) {
  1036. // Try to find an appropriate constructor.
  1037. bool all_have_type = true;
  1038. Vector<Variant::Type> arg_types;
  1039. for (int i = 0; i < p_arguments.size(); i++) {
  1040. if (!HAS_BUILTIN_TYPE(p_arguments[i])) {
  1041. all_have_type = false;
  1042. break;
  1043. }
  1044. arg_types.push_back(p_arguments[i].type.builtin_type);
  1045. }
  1046. if (all_have_type) {
  1047. int valid_constructor = -1;
  1048. for (int i = 0; i < Variant::get_constructor_count(p_type); i++) {
  1049. if (Variant::get_constructor_argument_count(p_type, i) != p_arguments.size()) {
  1050. continue;
  1051. }
  1052. int types_correct = true;
  1053. for (int j = 0; j < arg_types.size(); j++) {
  1054. if (arg_types[j] != Variant::get_constructor_argument_type(p_type, i, j)) {
  1055. types_correct = false;
  1056. break;
  1057. }
  1058. }
  1059. if (types_correct) {
  1060. valid_constructor = i;
  1061. break;
  1062. }
  1063. }
  1064. if (valid_constructor >= 0) {
  1065. append(GDScriptFunction::OPCODE_CONSTRUCT_VALIDATED, 1 + p_arguments.size());
  1066. for (int i = 0; i < p_arguments.size(); i++) {
  1067. append(p_arguments[i]);
  1068. }
  1069. append(p_target);
  1070. append(p_arguments.size());
  1071. append(Variant::get_validated_constructor(p_type, valid_constructor));
  1072. return;
  1073. }
  1074. }
  1075. append(GDScriptFunction::OPCODE_CONSTRUCT, 1 + p_arguments.size());
  1076. for (int i = 0; i < p_arguments.size(); i++) {
  1077. append(p_arguments[i]);
  1078. }
  1079. append(p_target);
  1080. append(p_arguments.size());
  1081. append(p_type);
  1082. }
  1083. void GDScriptByteCodeGenerator::write_construct_array(const Address &p_target, const Vector<Address> &p_arguments) {
  1084. append(GDScriptFunction::OPCODE_CONSTRUCT_ARRAY, 1 + p_arguments.size());
  1085. for (int i = 0; i < p_arguments.size(); i++) {
  1086. append(p_arguments[i]);
  1087. }
  1088. append(p_target);
  1089. append(p_arguments.size());
  1090. }
  1091. void GDScriptByteCodeGenerator::write_construct_typed_array(const Address &p_target, const GDScriptDataType &p_element_type, const Vector<Address> &p_arguments) {
  1092. append(GDScriptFunction::OPCODE_CONSTRUCT_TYPED_ARRAY, 2 + p_arguments.size());
  1093. for (int i = 0; i < p_arguments.size(); i++) {
  1094. append(p_arguments[i]);
  1095. }
  1096. append(p_target);
  1097. if (p_element_type.script_type) {
  1098. Variant script_type = Ref<Script>(p_element_type.script_type);
  1099. int addr = get_constant_pos(script_type);
  1100. addr |= GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS;
  1101. append(addr);
  1102. } else {
  1103. append(Address()); // null.
  1104. }
  1105. append(p_arguments.size());
  1106. append(p_element_type.builtin_type);
  1107. append(p_element_type.native_type);
  1108. }
  1109. void GDScriptByteCodeGenerator::write_construct_dictionary(const Address &p_target, const Vector<Address> &p_arguments) {
  1110. append(GDScriptFunction::OPCODE_CONSTRUCT_DICTIONARY, 1 + p_arguments.size());
  1111. for (int i = 0; i < p_arguments.size(); i++) {
  1112. append(p_arguments[i]);
  1113. }
  1114. append(p_target);
  1115. append(p_arguments.size() / 2); // This is number of key-value pairs, so only half of actual arguments.
  1116. }
  1117. void GDScriptByteCodeGenerator::write_await(const Address &p_target, const Address &p_operand) {
  1118. append(GDScriptFunction::OPCODE_AWAIT, 1);
  1119. append(p_operand);
  1120. append(GDScriptFunction::OPCODE_AWAIT_RESUME, 1);
  1121. append(p_target);
  1122. }
  1123. void GDScriptByteCodeGenerator::write_if(const Address &p_condition) {
  1124. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  1125. append(p_condition);
  1126. if_jmp_addrs.push_back(opcodes.size());
  1127. append(0); // Jump destination, will be patched.
  1128. }
  1129. void GDScriptByteCodeGenerator::write_else() {
  1130. append(GDScriptFunction::OPCODE_JUMP, 0); // Jump from true if block;
  1131. int else_jmp_addr = opcodes.size();
  1132. append(0); // Jump destination, will be patched.
  1133. patch_jump(if_jmp_addrs.back()->get());
  1134. if_jmp_addrs.pop_back();
  1135. if_jmp_addrs.push_back(else_jmp_addr);
  1136. }
  1137. void GDScriptByteCodeGenerator::write_endif() {
  1138. patch_jump(if_jmp_addrs.back()->get());
  1139. if_jmp_addrs.pop_back();
  1140. }
  1141. void GDScriptByteCodeGenerator::start_for(const GDScriptDataType &p_iterator_type, const GDScriptDataType &p_list_type) {
  1142. Address counter(Address::LOCAL_VARIABLE, add_local("@counter_pos", p_iterator_type), p_iterator_type);
  1143. Address container(Address::LOCAL_VARIABLE, add_local("@container_pos", p_list_type), p_list_type);
  1144. // Store state.
  1145. for_counter_variables.push_back(counter);
  1146. for_container_variables.push_back(container);
  1147. }
  1148. void GDScriptByteCodeGenerator::write_for_assignment(const Address &p_variable, const Address &p_list) {
  1149. const Address &container = for_container_variables.back()->get();
  1150. // Assign container.
  1151. append(GDScriptFunction::OPCODE_ASSIGN, 2);
  1152. append(container);
  1153. append(p_list);
  1154. for_iterator_variables.push_back(p_variable);
  1155. }
  1156. void GDScriptByteCodeGenerator::write_for() {
  1157. const Address &iterator = for_iterator_variables.back()->get();
  1158. const Address &counter = for_counter_variables.back()->get();
  1159. const Address &container = for_container_variables.back()->get();
  1160. current_breaks_to_patch.push_back(List<int>());
  1161. GDScriptFunction::Opcode begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN;
  1162. GDScriptFunction::Opcode iterate_opcode = GDScriptFunction::OPCODE_ITERATE;
  1163. if (container.type.has_type) {
  1164. if (container.type.kind == GDScriptDataType::BUILTIN) {
  1165. switch (container.type.builtin_type) {
  1166. case Variant::INT:
  1167. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_INT;
  1168. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_INT;
  1169. break;
  1170. case Variant::FLOAT:
  1171. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_FLOAT;
  1172. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_FLOAT;
  1173. break;
  1174. case Variant::VECTOR2:
  1175. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR2;
  1176. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR2;
  1177. break;
  1178. case Variant::VECTOR2I:
  1179. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR2I;
  1180. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR2I;
  1181. break;
  1182. case Variant::VECTOR3:
  1183. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR3;
  1184. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR3;
  1185. break;
  1186. case Variant::VECTOR3I:
  1187. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR3I;
  1188. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR3I;
  1189. break;
  1190. case Variant::STRING:
  1191. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_STRING;
  1192. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_STRING;
  1193. break;
  1194. case Variant::DICTIONARY:
  1195. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_DICTIONARY;
  1196. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_DICTIONARY;
  1197. break;
  1198. case Variant::ARRAY:
  1199. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_ARRAY;
  1200. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_ARRAY;
  1201. break;
  1202. case Variant::PACKED_BYTE_ARRAY:
  1203. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_BYTE_ARRAY;
  1204. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_BYTE_ARRAY;
  1205. break;
  1206. case Variant::PACKED_INT32_ARRAY:
  1207. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_INT32_ARRAY;
  1208. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_INT32_ARRAY;
  1209. break;
  1210. case Variant::PACKED_INT64_ARRAY:
  1211. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_INT64_ARRAY;
  1212. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_INT64_ARRAY;
  1213. break;
  1214. case Variant::PACKED_FLOAT32_ARRAY:
  1215. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_FLOAT32_ARRAY;
  1216. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_FLOAT32_ARRAY;
  1217. break;
  1218. case Variant::PACKED_FLOAT64_ARRAY:
  1219. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_FLOAT64_ARRAY;
  1220. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_FLOAT64_ARRAY;
  1221. break;
  1222. case Variant::PACKED_STRING_ARRAY:
  1223. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_STRING_ARRAY;
  1224. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_STRING_ARRAY;
  1225. break;
  1226. case Variant::PACKED_VECTOR2_ARRAY:
  1227. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_VECTOR2_ARRAY;
  1228. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_VECTOR2_ARRAY;
  1229. break;
  1230. case Variant::PACKED_VECTOR3_ARRAY:
  1231. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_VECTOR3_ARRAY;
  1232. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_VECTOR3_ARRAY;
  1233. break;
  1234. case Variant::PACKED_COLOR_ARRAY:
  1235. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_COLOR_ARRAY;
  1236. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_COLOR_ARRAY;
  1237. break;
  1238. default:
  1239. break;
  1240. }
  1241. } else {
  1242. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_OBJECT;
  1243. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_OBJECT;
  1244. }
  1245. }
  1246. // Begin loop.
  1247. append(begin_opcode, 3);
  1248. append(counter);
  1249. append(container);
  1250. append(iterator);
  1251. for_jmp_addrs.push_back(opcodes.size());
  1252. append(0); // End of loop address, will be patched.
  1253. append(GDScriptFunction::OPCODE_JUMP, 0);
  1254. append(opcodes.size() + 6); // Skip over 'continue' code.
  1255. // Next iteration.
  1256. int continue_addr = opcodes.size();
  1257. continue_addrs.push_back(continue_addr);
  1258. append(iterate_opcode, 3);
  1259. append(counter);
  1260. append(container);
  1261. append(iterator);
  1262. for_jmp_addrs.push_back(opcodes.size());
  1263. append(0); // Jump destination, will be patched.
  1264. }
  1265. void GDScriptByteCodeGenerator::write_endfor() {
  1266. // Jump back to loop check.
  1267. append(GDScriptFunction::OPCODE_JUMP, 0);
  1268. append(continue_addrs.back()->get());
  1269. continue_addrs.pop_back();
  1270. // Patch end jumps (two of them).
  1271. for (int i = 0; i < 2; i++) {
  1272. patch_jump(for_jmp_addrs.back()->get());
  1273. for_jmp_addrs.pop_back();
  1274. }
  1275. // Patch break statements.
  1276. for (const List<int>::Element *E = current_breaks_to_patch.back()->get().front(); E; E = E->next()) {
  1277. patch_jump(E->get());
  1278. }
  1279. current_breaks_to_patch.pop_back();
  1280. // Pop state.
  1281. for_iterator_variables.pop_back();
  1282. for_counter_variables.pop_back();
  1283. for_container_variables.pop_back();
  1284. }
  1285. void GDScriptByteCodeGenerator::start_while_condition() {
  1286. current_breaks_to_patch.push_back(List<int>());
  1287. continue_addrs.push_back(opcodes.size());
  1288. }
  1289. void GDScriptByteCodeGenerator::write_while(const Address &p_condition) {
  1290. // Condition check.
  1291. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  1292. append(p_condition);
  1293. while_jmp_addrs.push_back(opcodes.size());
  1294. append(0); // End of loop address, will be patched.
  1295. }
  1296. void GDScriptByteCodeGenerator::write_endwhile() {
  1297. // Jump back to loop check.
  1298. append(GDScriptFunction::OPCODE_JUMP, 0);
  1299. append(continue_addrs.back()->get());
  1300. continue_addrs.pop_back();
  1301. // Patch end jump.
  1302. patch_jump(while_jmp_addrs.back()->get());
  1303. while_jmp_addrs.pop_back();
  1304. // Patch break statements.
  1305. for (const List<int>::Element *E = current_breaks_to_patch.back()->get().front(); E; E = E->next()) {
  1306. patch_jump(E->get());
  1307. }
  1308. current_breaks_to_patch.pop_back();
  1309. }
  1310. void GDScriptByteCodeGenerator::start_match() {
  1311. match_continues_to_patch.push_back(List<int>());
  1312. }
  1313. void GDScriptByteCodeGenerator::start_match_branch() {
  1314. // Patch continue statements.
  1315. for (const List<int>::Element *E = match_continues_to_patch.back()->get().front(); E; E = E->next()) {
  1316. patch_jump(E->get());
  1317. }
  1318. match_continues_to_patch.pop_back();
  1319. // Start a new list for next branch.
  1320. match_continues_to_patch.push_back(List<int>());
  1321. }
  1322. void GDScriptByteCodeGenerator::end_match() {
  1323. // Patch continue statements.
  1324. for (const List<int>::Element *E = match_continues_to_patch.back()->get().front(); E; E = E->next()) {
  1325. patch_jump(E->get());
  1326. }
  1327. match_continues_to_patch.pop_back();
  1328. }
  1329. void GDScriptByteCodeGenerator::write_break() {
  1330. append(GDScriptFunction::OPCODE_JUMP, 0);
  1331. current_breaks_to_patch.back()->get().push_back(opcodes.size());
  1332. append(0);
  1333. }
  1334. void GDScriptByteCodeGenerator::write_continue() {
  1335. append(GDScriptFunction::OPCODE_JUMP, 0);
  1336. append(continue_addrs.back()->get());
  1337. }
  1338. void GDScriptByteCodeGenerator::write_continue_match() {
  1339. append(GDScriptFunction::OPCODE_JUMP, 0);
  1340. match_continues_to_patch.back()->get().push_back(opcodes.size());
  1341. append(0);
  1342. }
  1343. void GDScriptByteCodeGenerator::write_breakpoint() {
  1344. append(GDScriptFunction::OPCODE_BREAKPOINT, 0);
  1345. }
  1346. void GDScriptByteCodeGenerator::write_newline(int p_line) {
  1347. append(GDScriptFunction::OPCODE_LINE, 0);
  1348. append(p_line);
  1349. current_line = p_line;
  1350. }
  1351. void GDScriptByteCodeGenerator::write_return(const Address &p_return_value) {
  1352. if (!function->return_type.has_type || p_return_value.type.has_type) {
  1353. // Either the function is untyped or the return value is also typed.
  1354. // If this is a typed function, then we need to check for potential conversions.
  1355. if (function->return_type.has_type) {
  1356. if (function->return_type.kind == GDScriptDataType::BUILTIN && function->return_type.builtin_type == Variant::ARRAY && function->return_type.has_container_element_type()) {
  1357. // Typed array.
  1358. const GDScriptDataType &element_type = function->return_type.get_container_element_type();
  1359. Variant script = function->return_type.script_type;
  1360. int script_idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1361. append(GDScriptFunction::OPCODE_RETURN_TYPED_ARRAY, 2);
  1362. append(p_return_value);
  1363. append(script_idx);
  1364. append(element_type.kind == GDScriptDataType::BUILTIN ? element_type.builtin_type : Variant::OBJECT);
  1365. append(element_type.native_type);
  1366. } else if (function->return_type.kind == GDScriptDataType::BUILTIN && p_return_value.type.kind == GDScriptDataType::BUILTIN && function->return_type.builtin_type != p_return_value.type.builtin_type) {
  1367. // Add conversion.
  1368. append(GDScriptFunction::OPCODE_RETURN_TYPED_BUILTIN, 1);
  1369. append(p_return_value);
  1370. append(function->return_type.builtin_type);
  1371. } else {
  1372. // Just assign.
  1373. append(GDScriptFunction::OPCODE_RETURN, 1);
  1374. append(p_return_value);
  1375. }
  1376. } else {
  1377. append(GDScriptFunction::OPCODE_RETURN, 1);
  1378. append(p_return_value);
  1379. }
  1380. } else {
  1381. switch (function->return_type.kind) {
  1382. case GDScriptDataType::BUILTIN: {
  1383. if (function->return_type.builtin_type == Variant::ARRAY && function->return_type.has_container_element_type()) {
  1384. const GDScriptDataType &element_type = function->return_type.get_container_element_type();
  1385. Variant script = function->return_type.script_type;
  1386. int script_idx = get_constant_pos(script);
  1387. script_idx |= (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1388. append(GDScriptFunction::OPCODE_RETURN_TYPED_ARRAY, 2);
  1389. append(p_return_value);
  1390. append(script_idx);
  1391. append(element_type.kind == GDScriptDataType::BUILTIN ? element_type.builtin_type : Variant::OBJECT);
  1392. append(element_type.native_type);
  1393. } else {
  1394. append(GDScriptFunction::OPCODE_RETURN_TYPED_BUILTIN, 1);
  1395. append(p_return_value);
  1396. append(function->return_type.builtin_type);
  1397. }
  1398. } break;
  1399. case GDScriptDataType::NATIVE: {
  1400. append(GDScriptFunction::OPCODE_RETURN_TYPED_NATIVE, 2);
  1401. append(p_return_value);
  1402. int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[function->return_type.native_type];
  1403. Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
  1404. class_idx = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1405. append(class_idx);
  1406. } break;
  1407. case GDScriptDataType::GDSCRIPT:
  1408. case GDScriptDataType::SCRIPT: {
  1409. Variant script = function->return_type.script_type;
  1410. int script_idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1411. append(GDScriptFunction::OPCODE_RETURN_TYPED_SCRIPT, 2);
  1412. append(p_return_value);
  1413. append(script_idx);
  1414. } break;
  1415. default: {
  1416. ERR_PRINT("Compiler bug: unresolved return.");
  1417. // Shouldn't get here, but fail-safe to a regular return;
  1418. append(GDScriptFunction::OPCODE_RETURN, 1);
  1419. append(p_return_value);
  1420. } break;
  1421. }
  1422. }
  1423. }
  1424. void GDScriptByteCodeGenerator::write_assert(const Address &p_test, const Address &p_message) {
  1425. append(GDScriptFunction::OPCODE_ASSERT, 2);
  1426. append(p_test);
  1427. append(p_message);
  1428. }
  1429. void GDScriptByteCodeGenerator::start_block() {
  1430. push_stack_identifiers();
  1431. }
  1432. void GDScriptByteCodeGenerator::end_block() {
  1433. pop_stack_identifiers();
  1434. }
  1435. GDScriptByteCodeGenerator::~GDScriptByteCodeGenerator() {
  1436. if (!ended && function != nullptr) {
  1437. memdelete(function);
  1438. }
  1439. }