gdscript_byte_codegen.cpp 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647
  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_builtin_type_static(const Address &p_target, Variant::Type p_type, const StringName &p_method, const Vector<Address> &p_arguments) {
  923. bool is_validated = false;
  924. // Check if all types are correct.
  925. if (Variant::is_builtin_method_vararg(p_type, p_method)) {
  926. is_validated = true; // Vararg works fine with any argument, since they can be any type.
  927. } else if (p_arguments.size() == Variant::get_builtin_method_argument_count(p_type, p_method)) {
  928. bool all_types_exact = true;
  929. for (int i = 0; i < p_arguments.size(); i++) {
  930. if (!IS_BUILTIN_TYPE(p_arguments[i], Variant::get_builtin_method_argument_type(p_type, p_method, i))) {
  931. all_types_exact = false;
  932. break;
  933. }
  934. }
  935. is_validated = all_types_exact;
  936. }
  937. if (!is_validated) {
  938. // Perform regular call.
  939. append(GDScriptFunction::OPCODE_CALL_BUILTIN_STATIC, p_arguments.size() + 1);
  940. for (int i = 0; i < p_arguments.size(); i++) {
  941. append(p_arguments[i]);
  942. }
  943. append(p_target);
  944. append(p_type);
  945. append(p_method);
  946. append(p_arguments.size());
  947. return;
  948. }
  949. if (p_target.mode == Address::TEMPORARY) {
  950. Variant::Type result_type = Variant::get_builtin_method_return_type(p_type, p_method);
  951. Variant::Type temp_type = temporaries[p_target.address].type;
  952. if (result_type != temp_type) {
  953. write_type_adjust(p_target, result_type);
  954. }
  955. }
  956. append(GDScriptFunction::OPCODE_CALL_BUILTIN_TYPE_VALIDATED, 2 + p_arguments.size());
  957. for (int i = 0; i < p_arguments.size(); i++) {
  958. append(p_arguments[i]);
  959. }
  960. append(Address()); // No base since it's static.
  961. append(p_target);
  962. append(p_arguments.size());
  963. append(Variant::get_validated_builtin_method(p_type, p_method));
  964. }
  965. void GDScriptByteCodeGenerator::write_call_method_bind(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) {
  966. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL_METHOD_BIND : GDScriptFunction::OPCODE_CALL_METHOD_BIND_RET, 2 + p_arguments.size());
  967. for (int i = 0; i < p_arguments.size(); i++) {
  968. append(p_arguments[i]);
  969. }
  970. append(p_base);
  971. append(p_target);
  972. append(p_arguments.size());
  973. append(p_method);
  974. }
  975. void GDScriptByteCodeGenerator::write_call_ptrcall(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) {
  976. #define CASE_TYPE(m_type) \
  977. case Variant::m_type: \
  978. append(GDScriptFunction::OPCODE_CALL_PTRCALL_##m_type, 2 + p_arguments.size()); \
  979. break
  980. bool is_ptrcall = true;
  981. if (p_method->has_return()) {
  982. MethodInfo info;
  983. ClassDB::get_method_info(p_method->get_instance_class(), p_method->get_name(), &info);
  984. switch (info.return_val.type) {
  985. CASE_TYPE(BOOL);
  986. CASE_TYPE(INT);
  987. CASE_TYPE(FLOAT);
  988. CASE_TYPE(STRING);
  989. CASE_TYPE(VECTOR2);
  990. CASE_TYPE(VECTOR2I);
  991. CASE_TYPE(RECT2);
  992. CASE_TYPE(RECT2I);
  993. CASE_TYPE(VECTOR3);
  994. CASE_TYPE(VECTOR3I);
  995. CASE_TYPE(TRANSFORM2D);
  996. CASE_TYPE(PLANE);
  997. CASE_TYPE(AABB);
  998. CASE_TYPE(BASIS);
  999. CASE_TYPE(TRANSFORM);
  1000. CASE_TYPE(COLOR);
  1001. CASE_TYPE(STRING_NAME);
  1002. CASE_TYPE(NODE_PATH);
  1003. CASE_TYPE(RID);
  1004. CASE_TYPE(QUAT);
  1005. CASE_TYPE(OBJECT);
  1006. CASE_TYPE(CALLABLE);
  1007. CASE_TYPE(SIGNAL);
  1008. CASE_TYPE(DICTIONARY);
  1009. CASE_TYPE(ARRAY);
  1010. CASE_TYPE(PACKED_BYTE_ARRAY);
  1011. CASE_TYPE(PACKED_INT32_ARRAY);
  1012. CASE_TYPE(PACKED_INT64_ARRAY);
  1013. CASE_TYPE(PACKED_FLOAT32_ARRAY);
  1014. CASE_TYPE(PACKED_FLOAT64_ARRAY);
  1015. CASE_TYPE(PACKED_STRING_ARRAY);
  1016. CASE_TYPE(PACKED_VECTOR2_ARRAY);
  1017. CASE_TYPE(PACKED_VECTOR3_ARRAY);
  1018. CASE_TYPE(PACKED_COLOR_ARRAY);
  1019. default:
  1020. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL_METHOD_BIND : GDScriptFunction::OPCODE_CALL_METHOD_BIND_RET, 2 + p_arguments.size());
  1021. is_ptrcall = false;
  1022. break;
  1023. }
  1024. } else {
  1025. append(GDScriptFunction::OPCODE_CALL_PTRCALL_NO_RETURN, 2 + p_arguments.size());
  1026. }
  1027. for (int i = 0; i < p_arguments.size(); i++) {
  1028. append(p_arguments[i]);
  1029. }
  1030. append(p_base);
  1031. append(p_target);
  1032. append(p_arguments.size());
  1033. append(p_method);
  1034. if (is_ptrcall) {
  1035. alloc_ptrcall(p_arguments.size());
  1036. }
  1037. #undef CASE_TYPE
  1038. }
  1039. void GDScriptByteCodeGenerator::write_call_self(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  1040. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
  1041. for (int i = 0; i < p_arguments.size(); i++) {
  1042. append(p_arguments[i]);
  1043. }
  1044. append(GDScriptFunction::ADDR_TYPE_STACK << GDScriptFunction::ADDR_BITS);
  1045. append(p_target);
  1046. append(p_arguments.size());
  1047. append(p_function_name);
  1048. }
  1049. void GDScriptByteCodeGenerator::write_call_self_async(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  1050. append(GDScriptFunction::OPCODE_CALL_ASYNC, 2 + p_arguments.size());
  1051. for (int i = 0; i < p_arguments.size(); i++) {
  1052. append(p_arguments[i]);
  1053. }
  1054. append(GDScriptFunction::ADDR_SELF);
  1055. append(p_target);
  1056. append(p_arguments.size());
  1057. append(p_function_name);
  1058. }
  1059. void GDScriptByteCodeGenerator::write_call_script_function(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  1060. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
  1061. for (int i = 0; i < p_arguments.size(); i++) {
  1062. append(p_arguments[i]);
  1063. }
  1064. append(p_base);
  1065. append(p_target);
  1066. append(p_arguments.size());
  1067. append(p_function_name);
  1068. }
  1069. void GDScriptByteCodeGenerator::write_lambda(const Address &p_target, GDScriptFunction *p_function, const Vector<Address> &p_captures) {
  1070. append(GDScriptFunction::OPCODE_CREATE_LAMBDA, 1 + p_captures.size());
  1071. for (int i = 0; i < p_captures.size(); i++) {
  1072. append(p_captures[i]);
  1073. }
  1074. append(p_target);
  1075. append(p_captures.size());
  1076. append(p_function);
  1077. }
  1078. void GDScriptByteCodeGenerator::write_construct(const Address &p_target, Variant::Type p_type, const Vector<Address> &p_arguments) {
  1079. // Try to find an appropriate constructor.
  1080. bool all_have_type = true;
  1081. Vector<Variant::Type> arg_types;
  1082. for (int i = 0; i < p_arguments.size(); i++) {
  1083. if (!HAS_BUILTIN_TYPE(p_arguments[i])) {
  1084. all_have_type = false;
  1085. break;
  1086. }
  1087. arg_types.push_back(p_arguments[i].type.builtin_type);
  1088. }
  1089. if (all_have_type) {
  1090. int valid_constructor = -1;
  1091. for (int i = 0; i < Variant::get_constructor_count(p_type); i++) {
  1092. if (Variant::get_constructor_argument_count(p_type, i) != p_arguments.size()) {
  1093. continue;
  1094. }
  1095. int types_correct = true;
  1096. for (int j = 0; j < arg_types.size(); j++) {
  1097. if (arg_types[j] != Variant::get_constructor_argument_type(p_type, i, j)) {
  1098. types_correct = false;
  1099. break;
  1100. }
  1101. }
  1102. if (types_correct) {
  1103. valid_constructor = i;
  1104. break;
  1105. }
  1106. }
  1107. if (valid_constructor >= 0) {
  1108. append(GDScriptFunction::OPCODE_CONSTRUCT_VALIDATED, 1 + p_arguments.size());
  1109. for (int i = 0; i < p_arguments.size(); i++) {
  1110. append(p_arguments[i]);
  1111. }
  1112. append(p_target);
  1113. append(p_arguments.size());
  1114. append(Variant::get_validated_constructor(p_type, valid_constructor));
  1115. return;
  1116. }
  1117. }
  1118. append(GDScriptFunction::OPCODE_CONSTRUCT, 1 + p_arguments.size());
  1119. for (int i = 0; i < p_arguments.size(); i++) {
  1120. append(p_arguments[i]);
  1121. }
  1122. append(p_target);
  1123. append(p_arguments.size());
  1124. append(p_type);
  1125. }
  1126. void GDScriptByteCodeGenerator::write_construct_array(const Address &p_target, const Vector<Address> &p_arguments) {
  1127. append(GDScriptFunction::OPCODE_CONSTRUCT_ARRAY, 1 + p_arguments.size());
  1128. for (int i = 0; i < p_arguments.size(); i++) {
  1129. append(p_arguments[i]);
  1130. }
  1131. append(p_target);
  1132. append(p_arguments.size());
  1133. }
  1134. void GDScriptByteCodeGenerator::write_construct_typed_array(const Address &p_target, const GDScriptDataType &p_element_type, const Vector<Address> &p_arguments) {
  1135. append(GDScriptFunction::OPCODE_CONSTRUCT_TYPED_ARRAY, 2 + p_arguments.size());
  1136. for (int i = 0; i < p_arguments.size(); i++) {
  1137. append(p_arguments[i]);
  1138. }
  1139. append(p_target);
  1140. if (p_element_type.script_type) {
  1141. Variant script_type = Ref<Script>(p_element_type.script_type);
  1142. int addr = get_constant_pos(script_type);
  1143. addr |= GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS;
  1144. append(addr);
  1145. } else {
  1146. append(Address()); // null.
  1147. }
  1148. append(p_arguments.size());
  1149. append(p_element_type.builtin_type);
  1150. append(p_element_type.native_type);
  1151. }
  1152. void GDScriptByteCodeGenerator::write_construct_dictionary(const Address &p_target, const Vector<Address> &p_arguments) {
  1153. append(GDScriptFunction::OPCODE_CONSTRUCT_DICTIONARY, 1 + p_arguments.size());
  1154. for (int i = 0; i < p_arguments.size(); i++) {
  1155. append(p_arguments[i]);
  1156. }
  1157. append(p_target);
  1158. append(p_arguments.size() / 2); // This is number of key-value pairs, so only half of actual arguments.
  1159. }
  1160. void GDScriptByteCodeGenerator::write_await(const Address &p_target, const Address &p_operand) {
  1161. append(GDScriptFunction::OPCODE_AWAIT, 1);
  1162. append(p_operand);
  1163. append(GDScriptFunction::OPCODE_AWAIT_RESUME, 1);
  1164. append(p_target);
  1165. }
  1166. void GDScriptByteCodeGenerator::write_if(const Address &p_condition) {
  1167. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  1168. append(p_condition);
  1169. if_jmp_addrs.push_back(opcodes.size());
  1170. append(0); // Jump destination, will be patched.
  1171. }
  1172. void GDScriptByteCodeGenerator::write_else() {
  1173. append(GDScriptFunction::OPCODE_JUMP, 0); // Jump from true if block;
  1174. int else_jmp_addr = opcodes.size();
  1175. append(0); // Jump destination, will be patched.
  1176. patch_jump(if_jmp_addrs.back()->get());
  1177. if_jmp_addrs.pop_back();
  1178. if_jmp_addrs.push_back(else_jmp_addr);
  1179. }
  1180. void GDScriptByteCodeGenerator::write_endif() {
  1181. patch_jump(if_jmp_addrs.back()->get());
  1182. if_jmp_addrs.pop_back();
  1183. }
  1184. void GDScriptByteCodeGenerator::start_for(const GDScriptDataType &p_iterator_type, const GDScriptDataType &p_list_type) {
  1185. Address counter(Address::LOCAL_VARIABLE, add_local("@counter_pos", p_iterator_type), p_iterator_type);
  1186. Address container(Address::LOCAL_VARIABLE, add_local("@container_pos", p_list_type), p_list_type);
  1187. // Store state.
  1188. for_counter_variables.push_back(counter);
  1189. for_container_variables.push_back(container);
  1190. }
  1191. void GDScriptByteCodeGenerator::write_for_assignment(const Address &p_variable, const Address &p_list) {
  1192. const Address &container = for_container_variables.back()->get();
  1193. // Assign container.
  1194. append(GDScriptFunction::OPCODE_ASSIGN, 2);
  1195. append(container);
  1196. append(p_list);
  1197. for_iterator_variables.push_back(p_variable);
  1198. }
  1199. void GDScriptByteCodeGenerator::write_for() {
  1200. const Address &iterator = for_iterator_variables.back()->get();
  1201. const Address &counter = for_counter_variables.back()->get();
  1202. const Address &container = for_container_variables.back()->get();
  1203. current_breaks_to_patch.push_back(List<int>());
  1204. GDScriptFunction::Opcode begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN;
  1205. GDScriptFunction::Opcode iterate_opcode = GDScriptFunction::OPCODE_ITERATE;
  1206. if (container.type.has_type) {
  1207. if (container.type.kind == GDScriptDataType::BUILTIN) {
  1208. switch (container.type.builtin_type) {
  1209. case Variant::INT:
  1210. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_INT;
  1211. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_INT;
  1212. break;
  1213. case Variant::FLOAT:
  1214. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_FLOAT;
  1215. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_FLOAT;
  1216. break;
  1217. case Variant::VECTOR2:
  1218. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR2;
  1219. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR2;
  1220. break;
  1221. case Variant::VECTOR2I:
  1222. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR2I;
  1223. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR2I;
  1224. break;
  1225. case Variant::VECTOR3:
  1226. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR3;
  1227. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR3;
  1228. break;
  1229. case Variant::VECTOR3I:
  1230. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR3I;
  1231. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR3I;
  1232. break;
  1233. case Variant::STRING:
  1234. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_STRING;
  1235. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_STRING;
  1236. break;
  1237. case Variant::DICTIONARY:
  1238. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_DICTIONARY;
  1239. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_DICTIONARY;
  1240. break;
  1241. case Variant::ARRAY:
  1242. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_ARRAY;
  1243. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_ARRAY;
  1244. break;
  1245. case Variant::PACKED_BYTE_ARRAY:
  1246. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_BYTE_ARRAY;
  1247. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_BYTE_ARRAY;
  1248. break;
  1249. case Variant::PACKED_INT32_ARRAY:
  1250. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_INT32_ARRAY;
  1251. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_INT32_ARRAY;
  1252. break;
  1253. case Variant::PACKED_INT64_ARRAY:
  1254. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_INT64_ARRAY;
  1255. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_INT64_ARRAY;
  1256. break;
  1257. case Variant::PACKED_FLOAT32_ARRAY:
  1258. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_FLOAT32_ARRAY;
  1259. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_FLOAT32_ARRAY;
  1260. break;
  1261. case Variant::PACKED_FLOAT64_ARRAY:
  1262. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_FLOAT64_ARRAY;
  1263. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_FLOAT64_ARRAY;
  1264. break;
  1265. case Variant::PACKED_STRING_ARRAY:
  1266. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_STRING_ARRAY;
  1267. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_STRING_ARRAY;
  1268. break;
  1269. case Variant::PACKED_VECTOR2_ARRAY:
  1270. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_VECTOR2_ARRAY;
  1271. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_VECTOR2_ARRAY;
  1272. break;
  1273. case Variant::PACKED_VECTOR3_ARRAY:
  1274. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_VECTOR3_ARRAY;
  1275. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_VECTOR3_ARRAY;
  1276. break;
  1277. case Variant::PACKED_COLOR_ARRAY:
  1278. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_COLOR_ARRAY;
  1279. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_COLOR_ARRAY;
  1280. break;
  1281. default:
  1282. break;
  1283. }
  1284. } else {
  1285. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_OBJECT;
  1286. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_OBJECT;
  1287. }
  1288. }
  1289. // Begin loop.
  1290. append(begin_opcode, 3);
  1291. append(counter);
  1292. append(container);
  1293. append(iterator);
  1294. for_jmp_addrs.push_back(opcodes.size());
  1295. append(0); // End of loop address, will be patched.
  1296. append(GDScriptFunction::OPCODE_JUMP, 0);
  1297. append(opcodes.size() + 6); // Skip over 'continue' code.
  1298. // Next iteration.
  1299. int continue_addr = opcodes.size();
  1300. continue_addrs.push_back(continue_addr);
  1301. append(iterate_opcode, 3);
  1302. append(counter);
  1303. append(container);
  1304. append(iterator);
  1305. for_jmp_addrs.push_back(opcodes.size());
  1306. append(0); // Jump destination, will be patched.
  1307. }
  1308. void GDScriptByteCodeGenerator::write_endfor() {
  1309. // Jump back to loop check.
  1310. append(GDScriptFunction::OPCODE_JUMP, 0);
  1311. append(continue_addrs.back()->get());
  1312. continue_addrs.pop_back();
  1313. // Patch end jumps (two of them).
  1314. for (int i = 0; i < 2; i++) {
  1315. patch_jump(for_jmp_addrs.back()->get());
  1316. for_jmp_addrs.pop_back();
  1317. }
  1318. // Patch break statements.
  1319. for (const List<int>::Element *E = current_breaks_to_patch.back()->get().front(); E; E = E->next()) {
  1320. patch_jump(E->get());
  1321. }
  1322. current_breaks_to_patch.pop_back();
  1323. // Pop state.
  1324. for_iterator_variables.pop_back();
  1325. for_counter_variables.pop_back();
  1326. for_container_variables.pop_back();
  1327. }
  1328. void GDScriptByteCodeGenerator::start_while_condition() {
  1329. current_breaks_to_patch.push_back(List<int>());
  1330. continue_addrs.push_back(opcodes.size());
  1331. }
  1332. void GDScriptByteCodeGenerator::write_while(const Address &p_condition) {
  1333. // Condition check.
  1334. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  1335. append(p_condition);
  1336. while_jmp_addrs.push_back(opcodes.size());
  1337. append(0); // End of loop address, will be patched.
  1338. }
  1339. void GDScriptByteCodeGenerator::write_endwhile() {
  1340. // Jump back to loop check.
  1341. append(GDScriptFunction::OPCODE_JUMP, 0);
  1342. append(continue_addrs.back()->get());
  1343. continue_addrs.pop_back();
  1344. // Patch end jump.
  1345. patch_jump(while_jmp_addrs.back()->get());
  1346. while_jmp_addrs.pop_back();
  1347. // Patch break statements.
  1348. for (const List<int>::Element *E = current_breaks_to_patch.back()->get().front(); E; E = E->next()) {
  1349. patch_jump(E->get());
  1350. }
  1351. current_breaks_to_patch.pop_back();
  1352. }
  1353. void GDScriptByteCodeGenerator::start_match() {
  1354. match_continues_to_patch.push_back(List<int>());
  1355. }
  1356. void GDScriptByteCodeGenerator::start_match_branch() {
  1357. // Patch continue statements.
  1358. for (const List<int>::Element *E = match_continues_to_patch.back()->get().front(); E; E = E->next()) {
  1359. patch_jump(E->get());
  1360. }
  1361. match_continues_to_patch.pop_back();
  1362. // Start a new list for next branch.
  1363. match_continues_to_patch.push_back(List<int>());
  1364. }
  1365. void GDScriptByteCodeGenerator::end_match() {
  1366. // Patch continue statements.
  1367. for (const List<int>::Element *E = match_continues_to_patch.back()->get().front(); E; E = E->next()) {
  1368. patch_jump(E->get());
  1369. }
  1370. match_continues_to_patch.pop_back();
  1371. }
  1372. void GDScriptByteCodeGenerator::write_break() {
  1373. append(GDScriptFunction::OPCODE_JUMP, 0);
  1374. current_breaks_to_patch.back()->get().push_back(opcodes.size());
  1375. append(0);
  1376. }
  1377. void GDScriptByteCodeGenerator::write_continue() {
  1378. append(GDScriptFunction::OPCODE_JUMP, 0);
  1379. append(continue_addrs.back()->get());
  1380. }
  1381. void GDScriptByteCodeGenerator::write_continue_match() {
  1382. append(GDScriptFunction::OPCODE_JUMP, 0);
  1383. match_continues_to_patch.back()->get().push_back(opcodes.size());
  1384. append(0);
  1385. }
  1386. void GDScriptByteCodeGenerator::write_breakpoint() {
  1387. append(GDScriptFunction::OPCODE_BREAKPOINT, 0);
  1388. }
  1389. void GDScriptByteCodeGenerator::write_newline(int p_line) {
  1390. append(GDScriptFunction::OPCODE_LINE, 0);
  1391. append(p_line);
  1392. current_line = p_line;
  1393. }
  1394. void GDScriptByteCodeGenerator::write_return(const Address &p_return_value) {
  1395. if (!function->return_type.has_type || p_return_value.type.has_type) {
  1396. // Either the function is untyped or the return value is also typed.
  1397. // If this is a typed function, then we need to check for potential conversions.
  1398. if (function->return_type.has_type) {
  1399. if (function->return_type.kind == GDScriptDataType::BUILTIN && function->return_type.builtin_type == Variant::ARRAY && function->return_type.has_container_element_type()) {
  1400. // Typed array.
  1401. const GDScriptDataType &element_type = function->return_type.get_container_element_type();
  1402. Variant script = function->return_type.script_type;
  1403. int script_idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1404. append(GDScriptFunction::OPCODE_RETURN_TYPED_ARRAY, 2);
  1405. append(p_return_value);
  1406. append(script_idx);
  1407. append(element_type.kind == GDScriptDataType::BUILTIN ? element_type.builtin_type : Variant::OBJECT);
  1408. append(element_type.native_type);
  1409. } 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) {
  1410. // Add conversion.
  1411. append(GDScriptFunction::OPCODE_RETURN_TYPED_BUILTIN, 1);
  1412. append(p_return_value);
  1413. append(function->return_type.builtin_type);
  1414. } else {
  1415. // Just assign.
  1416. append(GDScriptFunction::OPCODE_RETURN, 1);
  1417. append(p_return_value);
  1418. }
  1419. } else {
  1420. append(GDScriptFunction::OPCODE_RETURN, 1);
  1421. append(p_return_value);
  1422. }
  1423. } else {
  1424. switch (function->return_type.kind) {
  1425. case GDScriptDataType::BUILTIN: {
  1426. if (function->return_type.builtin_type == Variant::ARRAY && function->return_type.has_container_element_type()) {
  1427. const GDScriptDataType &element_type = function->return_type.get_container_element_type();
  1428. Variant script = function->return_type.script_type;
  1429. int script_idx = get_constant_pos(script);
  1430. script_idx |= (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1431. append(GDScriptFunction::OPCODE_RETURN_TYPED_ARRAY, 2);
  1432. append(p_return_value);
  1433. append(script_idx);
  1434. append(element_type.kind == GDScriptDataType::BUILTIN ? element_type.builtin_type : Variant::OBJECT);
  1435. append(element_type.native_type);
  1436. } else {
  1437. append(GDScriptFunction::OPCODE_RETURN_TYPED_BUILTIN, 1);
  1438. append(p_return_value);
  1439. append(function->return_type.builtin_type);
  1440. }
  1441. } break;
  1442. case GDScriptDataType::NATIVE: {
  1443. append(GDScriptFunction::OPCODE_RETURN_TYPED_NATIVE, 2);
  1444. append(p_return_value);
  1445. int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[function->return_type.native_type];
  1446. Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
  1447. class_idx = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1448. append(class_idx);
  1449. } break;
  1450. case GDScriptDataType::GDSCRIPT:
  1451. case GDScriptDataType::SCRIPT: {
  1452. Variant script = function->return_type.script_type;
  1453. int script_idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1454. append(GDScriptFunction::OPCODE_RETURN_TYPED_SCRIPT, 2);
  1455. append(p_return_value);
  1456. append(script_idx);
  1457. } break;
  1458. default: {
  1459. ERR_PRINT("Compiler bug: unresolved return.");
  1460. // Shouldn't get here, but fail-safe to a regular return;
  1461. append(GDScriptFunction::OPCODE_RETURN, 1);
  1462. append(p_return_value);
  1463. } break;
  1464. }
  1465. }
  1466. }
  1467. void GDScriptByteCodeGenerator::write_assert(const Address &p_test, const Address &p_message) {
  1468. append(GDScriptFunction::OPCODE_ASSERT, 2);
  1469. append(p_test);
  1470. append(p_message);
  1471. }
  1472. void GDScriptByteCodeGenerator::start_block() {
  1473. push_stack_identifiers();
  1474. }
  1475. void GDScriptByteCodeGenerator::end_block() {
  1476. pop_stack_identifiers();
  1477. }
  1478. GDScriptByteCodeGenerator::~GDScriptByteCodeGenerator() {
  1479. if (!ended && function != nullptr) {
  1480. memdelete(function);
  1481. }
  1482. }