gdscript_byte_codegen.cpp 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701
  1. /**************************************************************************/
  2. /* gdscript_byte_codegen.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "gdscript_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::VECTOR4:
  79. case Variant::VECTOR4I:
  80. case Variant::PLANE:
  81. case Variant::QUATERNION:
  82. case Variant::AABB:
  83. case Variant::BASIS:
  84. case Variant::TRANSFORM3D:
  85. case Variant::PROJECTION:
  86. case Variant::COLOR:
  87. case Variant::STRING_NAME:
  88. case Variant::NODE_PATH:
  89. case Variant::RID:
  90. case Variant::OBJECT:
  91. case Variant::CALLABLE:
  92. case Variant::SIGNAL:
  93. case Variant::DICTIONARY:
  94. case Variant::ARRAY:
  95. temp_type = p_type.builtin_type;
  96. break;
  97. case Variant::PACKED_BYTE_ARRAY:
  98. case Variant::PACKED_INT32_ARRAY:
  99. case Variant::PACKED_INT64_ARRAY:
  100. case Variant::PACKED_FLOAT32_ARRAY:
  101. case Variant::PACKED_FLOAT64_ARRAY:
  102. case Variant::PACKED_STRING_ARRAY:
  103. case Variant::PACKED_VECTOR2_ARRAY:
  104. case Variant::PACKED_VECTOR3_ARRAY:
  105. case Variant::PACKED_COLOR_ARRAY:
  106. case Variant::VARIANT_MAX:
  107. // Packed arrays are reference counted, so we don't use the pool for them.
  108. temp_type = Variant::NIL;
  109. break;
  110. }
  111. } else {
  112. temp_type = Variant::OBJECT;
  113. }
  114. }
  115. if (!temporaries_pool.has(temp_type)) {
  116. temporaries_pool[temp_type] = List<int>();
  117. }
  118. List<int> &pool = temporaries_pool[temp_type];
  119. if (pool.is_empty()) {
  120. StackSlot new_temp(temp_type);
  121. int idx = temporaries.size();
  122. pool.push_back(idx);
  123. temporaries.push_back(new_temp);
  124. }
  125. int slot = pool.front()->get();
  126. pool.pop_front();
  127. used_temporaries.push_back(slot);
  128. return slot;
  129. }
  130. void GDScriptByteCodeGenerator::pop_temporary() {
  131. ERR_FAIL_COND(used_temporaries.is_empty());
  132. int slot_idx = used_temporaries.back()->get();
  133. const StackSlot &slot = temporaries[slot_idx];
  134. temporaries_pool[slot.type].push_back(slot_idx);
  135. used_temporaries.pop_back();
  136. }
  137. void GDScriptByteCodeGenerator::start_parameters() {
  138. if (function->_default_arg_count > 0) {
  139. append(GDScriptFunction::OPCODE_JUMP_TO_DEF_ARGUMENT);
  140. function->default_arguments.push_back(opcodes.size());
  141. }
  142. }
  143. void GDScriptByteCodeGenerator::end_parameters() {
  144. function->default_arguments.reverse();
  145. }
  146. void GDScriptByteCodeGenerator::write_start(GDScript *p_script, const StringName &p_function_name, bool p_static, Variant p_rpc_config, const GDScriptDataType &p_return_type) {
  147. function = memnew(GDScriptFunction);
  148. debug_stack = EngineDebugger::is_active();
  149. function->name = p_function_name;
  150. function->_script = p_script;
  151. function->source = p_script->get_script_path();
  152. #ifdef DEBUG_ENABLED
  153. function->func_cname = (String(function->source) + " - " + String(p_function_name)).utf8();
  154. function->_func_cname = function->func_cname.get_data();
  155. #endif
  156. function->_static = p_static;
  157. function->return_type = p_return_type;
  158. function->rpc_config = p_rpc_config;
  159. function->_argument_count = 0;
  160. }
  161. GDScriptFunction *GDScriptByteCodeGenerator::write_end() {
  162. #ifdef DEBUG_ENABLED
  163. if (!used_temporaries.is_empty()) {
  164. ERR_PRINT("Non-zero temporary variables at end of function: " + itos(used_temporaries.size()));
  165. }
  166. #endif
  167. append_opcode(GDScriptFunction::OPCODE_END);
  168. for (int i = 0; i < temporaries.size(); i++) {
  169. int stack_index = i + max_locals + RESERVED_STACK;
  170. for (int j = 0; j < temporaries[i].bytecode_indices.size(); j++) {
  171. opcodes.write[temporaries[i].bytecode_indices[j]] = stack_index | (GDScriptFunction::ADDR_TYPE_STACK << GDScriptFunction::ADDR_BITS);
  172. }
  173. if (temporaries[i].type != Variant::NIL) {
  174. function->temporary_slots[stack_index] = temporaries[i].type;
  175. }
  176. }
  177. if (constant_map.size()) {
  178. function->_constant_count = constant_map.size();
  179. function->constants.resize(constant_map.size());
  180. function->_constants_ptr = function->constants.ptrw();
  181. for (const KeyValue<Variant, int> &K : constant_map) {
  182. function->constants.write[K.value] = K.key;
  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 (const KeyValue<StringName, int> &E : name_map) {
  192. function->global_names.write[E.value] = 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 KeyValue<Variant::ValidatedOperatorEvaluator, int> &E : operator_func_map) {
  219. function->operator_funcs.write[E.value] = 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 KeyValue<Variant::ValidatedSetter, int> &E : setters_map) {
  230. function->setters.write[E.value] = 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 KeyValue<Variant::ValidatedGetter, int> &E : getters_map) {
  241. function->getters.write[E.value] = 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 KeyValue<Variant::ValidatedKeyedSetter, int> &E : keyed_setters_map) {
  252. function->keyed_setters.write[E.value] = 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 KeyValue<Variant::ValidatedKeyedGetter, int> &E : keyed_getters_map) {
  263. function->keyed_getters.write[E.value] = 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 KeyValue<Variant::ValidatedIndexedSetter, int> &E : indexed_setters_map) {
  274. function->indexed_setters.write[E.value] = 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 KeyValue<Variant::ValidatedIndexedGetter, int> &E : indexed_getters_map) {
  285. function->indexed_getters.write[E.value] = 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 KeyValue<Variant::ValidatedBuiltInMethod, int> &E : builtin_method_map) {
  296. function->builtin_methods.write[E.value] = 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 KeyValue<Variant::ValidatedConstructor, int> &E : constructors_map) {
  307. function->constructors.write[E.value] = 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 KeyValue<Variant::ValidatedUtilityFunction, int> &E : utilities_map) {
  318. function->utilities.write[E.value] = 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 KeyValue<GDScriptUtilityFunctions::FunctionPtr, int> &E : gds_utilities_map) {
  329. function->gds_utilities.write[E.value] = 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 KeyValue<MethodBind *, int> &E : method_bind_map) {
  340. function->methods.write[E.value] = 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 KeyValue<GDScriptFunction *, int> &E : lambdas_map) {
  351. function->lambdas.write[E.value] = 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. #ifdef DEBUG_ENABLED
  364. function->operator_names = operator_names;
  365. function->setter_names = setter_names;
  366. function->getter_names = getter_names;
  367. function->builtin_methods_names = builtin_methods_names;
  368. function->constructors_names = constructors_names;
  369. function->utilities_names = utilities_names;
  370. function->gds_utilities_names = gds_utilities_names;
  371. #endif
  372. ended = true;
  373. return function;
  374. }
  375. #ifdef DEBUG_ENABLED
  376. void GDScriptByteCodeGenerator::set_signature(const String &p_signature) {
  377. function->profile.signature = p_signature;
  378. }
  379. #endif
  380. void GDScriptByteCodeGenerator::set_initial_line(int p_line) {
  381. function->_initial_line = p_line;
  382. }
  383. #define HAS_BUILTIN_TYPE(m_var) \
  384. (m_var.type.has_type && m_var.type.kind == GDScriptDataType::BUILTIN)
  385. #define IS_BUILTIN_TYPE(m_var, m_type) \
  386. (m_var.type.has_type && m_var.type.kind == GDScriptDataType::BUILTIN && m_var.type.builtin_type == m_type)
  387. void GDScriptByteCodeGenerator::write_type_adjust(const Address &p_target, Variant::Type p_new_type) {
  388. switch (p_new_type) {
  389. case Variant::BOOL:
  390. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_BOOL);
  391. break;
  392. case Variant::INT:
  393. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_INT);
  394. break;
  395. case Variant::FLOAT:
  396. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_FLOAT);
  397. break;
  398. case Variant::STRING:
  399. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_STRING);
  400. break;
  401. case Variant::VECTOR2:
  402. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR2);
  403. break;
  404. case Variant::VECTOR2I:
  405. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR2I);
  406. break;
  407. case Variant::RECT2:
  408. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_RECT2);
  409. break;
  410. case Variant::RECT2I:
  411. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_RECT2I);
  412. break;
  413. case Variant::VECTOR3:
  414. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3);
  415. break;
  416. case Variant::VECTOR3I:
  417. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3I);
  418. break;
  419. case Variant::TRANSFORM2D:
  420. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_TRANSFORM2D);
  421. break;
  422. case Variant::VECTOR4:
  423. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3);
  424. break;
  425. case Variant::VECTOR4I:
  426. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3I);
  427. break;
  428. case Variant::PLANE:
  429. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PLANE);
  430. break;
  431. case Variant::QUATERNION:
  432. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_QUATERNION);
  433. break;
  434. case Variant::AABB:
  435. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_AABB);
  436. break;
  437. case Variant::BASIS:
  438. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_BASIS);
  439. break;
  440. case Variant::TRANSFORM3D:
  441. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_TRANSFORM3D);
  442. break;
  443. case Variant::PROJECTION:
  444. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PROJECTION);
  445. break;
  446. case Variant::COLOR:
  447. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_COLOR);
  448. break;
  449. case Variant::STRING_NAME:
  450. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_STRING_NAME);
  451. break;
  452. case Variant::NODE_PATH:
  453. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_NODE_PATH);
  454. break;
  455. case Variant::RID:
  456. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_RID);
  457. break;
  458. case Variant::OBJECT:
  459. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_OBJECT);
  460. break;
  461. case Variant::CALLABLE:
  462. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_CALLABLE);
  463. break;
  464. case Variant::SIGNAL:
  465. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_SIGNAL);
  466. break;
  467. case Variant::DICTIONARY:
  468. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_DICTIONARY);
  469. break;
  470. case Variant::ARRAY:
  471. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_ARRAY);
  472. break;
  473. case Variant::PACKED_BYTE_ARRAY:
  474. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_BYTE_ARRAY);
  475. break;
  476. case Variant::PACKED_INT32_ARRAY:
  477. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_INT32_ARRAY);
  478. break;
  479. case Variant::PACKED_INT64_ARRAY:
  480. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_INT64_ARRAY);
  481. break;
  482. case Variant::PACKED_FLOAT32_ARRAY:
  483. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_FLOAT32_ARRAY);
  484. break;
  485. case Variant::PACKED_FLOAT64_ARRAY:
  486. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_FLOAT64_ARRAY);
  487. break;
  488. case Variant::PACKED_STRING_ARRAY:
  489. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_STRING_ARRAY);
  490. break;
  491. case Variant::PACKED_VECTOR2_ARRAY:
  492. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_VECTOR2_ARRAY);
  493. break;
  494. case Variant::PACKED_VECTOR3_ARRAY:
  495. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_VECTOR3_ARRAY);
  496. break;
  497. case Variant::PACKED_COLOR_ARRAY:
  498. append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_COLOR_ARRAY);
  499. break;
  500. case Variant::NIL:
  501. case Variant::VARIANT_MAX:
  502. return;
  503. }
  504. append(p_target);
  505. }
  506. void GDScriptByteCodeGenerator::write_unary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand) {
  507. if (HAS_BUILTIN_TYPE(p_left_operand)) {
  508. // Gather specific operator.
  509. Variant::ValidatedOperatorEvaluator op_func = Variant::get_validated_operator_evaluator(p_operator, p_left_operand.type.builtin_type, Variant::NIL);
  510. append_opcode(GDScriptFunction::OPCODE_OPERATOR_VALIDATED);
  511. append(p_left_operand);
  512. append(Address());
  513. append(p_target);
  514. append(op_func);
  515. #ifdef DEBUG_ENABLED
  516. add_debug_name(operator_names, get_operation_pos(op_func), Variant::get_operator_name(p_operator));
  517. #endif
  518. return;
  519. }
  520. // No specific types, perform variant evaluation.
  521. append_opcode(GDScriptFunction::OPCODE_OPERATOR);
  522. append(p_left_operand);
  523. append(Address());
  524. append(p_target);
  525. append(p_operator);
  526. }
  527. void GDScriptByteCodeGenerator::write_binary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand, const Address &p_right_operand) {
  528. if (HAS_BUILTIN_TYPE(p_left_operand) && HAS_BUILTIN_TYPE(p_right_operand)) {
  529. if (p_target.mode == Address::TEMPORARY) {
  530. Variant::Type result_type = Variant::get_operator_return_type(p_operator, p_left_operand.type.builtin_type, p_right_operand.type.builtin_type);
  531. Variant::Type temp_type = temporaries[p_target.address].type;
  532. if (result_type != temp_type) {
  533. write_type_adjust(p_target, result_type);
  534. }
  535. }
  536. // Gather specific operator.
  537. Variant::ValidatedOperatorEvaluator op_func = Variant::get_validated_operator_evaluator(p_operator, p_left_operand.type.builtin_type, p_right_operand.type.builtin_type);
  538. append_opcode(GDScriptFunction::OPCODE_OPERATOR_VALIDATED);
  539. append(p_left_operand);
  540. append(p_right_operand);
  541. append(p_target);
  542. append(op_func);
  543. #ifdef DEBUG_ENABLED
  544. add_debug_name(operator_names, get_operation_pos(op_func), Variant::get_operator_name(p_operator));
  545. #endif
  546. return;
  547. }
  548. // No specific types, perform variant evaluation.
  549. append_opcode(GDScriptFunction::OPCODE_OPERATOR);
  550. append(p_left_operand);
  551. append(p_right_operand);
  552. append(p_target);
  553. append(p_operator);
  554. }
  555. void GDScriptByteCodeGenerator::write_type_test(const Address &p_target, const Address &p_source, const Address &p_type) {
  556. append_opcode(GDScriptFunction::OPCODE_EXTENDS_TEST);
  557. append(p_source);
  558. append(p_type);
  559. append(p_target);
  560. }
  561. void GDScriptByteCodeGenerator::write_type_test_builtin(const Address &p_target, const Address &p_source, Variant::Type p_type) {
  562. append_opcode(GDScriptFunction::OPCODE_IS_BUILTIN);
  563. append(p_source);
  564. append(p_target);
  565. append(p_type);
  566. }
  567. void GDScriptByteCodeGenerator::write_and_left_operand(const Address &p_left_operand) {
  568. append_opcode(GDScriptFunction::OPCODE_JUMP_IF_NOT);
  569. append(p_left_operand);
  570. logic_op_jump_pos1.push_back(opcodes.size());
  571. append(0); // Jump target, will be patched.
  572. }
  573. void GDScriptByteCodeGenerator::write_and_right_operand(const Address &p_right_operand) {
  574. append_opcode(GDScriptFunction::OPCODE_JUMP_IF_NOT);
  575. append(p_right_operand);
  576. logic_op_jump_pos2.push_back(opcodes.size());
  577. append(0); // Jump target, will be patched.
  578. }
  579. void GDScriptByteCodeGenerator::write_end_and(const Address &p_target) {
  580. // If here means both operands are true.
  581. append_opcode(GDScriptFunction::OPCODE_ASSIGN_TRUE);
  582. append(p_target);
  583. // Jump away from the fail condition.
  584. append_opcode(GDScriptFunction::OPCODE_JUMP);
  585. append(opcodes.size() + 3);
  586. // Here it means one of operands is false.
  587. patch_jump(logic_op_jump_pos1.back()->get());
  588. patch_jump(logic_op_jump_pos2.back()->get());
  589. logic_op_jump_pos1.pop_back();
  590. logic_op_jump_pos2.pop_back();
  591. append_opcode(GDScriptFunction::OPCODE_ASSIGN_FALSE);
  592. append(p_target);
  593. }
  594. void GDScriptByteCodeGenerator::write_or_left_operand(const Address &p_left_operand) {
  595. append_opcode(GDScriptFunction::OPCODE_JUMP_IF);
  596. append(p_left_operand);
  597. logic_op_jump_pos1.push_back(opcodes.size());
  598. append(0); // Jump target, will be patched.
  599. }
  600. void GDScriptByteCodeGenerator::write_or_right_operand(const Address &p_right_operand) {
  601. append_opcode(GDScriptFunction::OPCODE_JUMP_IF);
  602. append(p_right_operand);
  603. logic_op_jump_pos2.push_back(opcodes.size());
  604. append(0); // Jump target, will be patched.
  605. }
  606. void GDScriptByteCodeGenerator::write_end_or(const Address &p_target) {
  607. // If here means both operands are false.
  608. append_opcode(GDScriptFunction::OPCODE_ASSIGN_FALSE);
  609. append(p_target);
  610. // Jump away from the success condition.
  611. append_opcode(GDScriptFunction::OPCODE_JUMP);
  612. append(opcodes.size() + 3);
  613. // Here it means one of operands is true.
  614. patch_jump(logic_op_jump_pos1.back()->get());
  615. patch_jump(logic_op_jump_pos2.back()->get());
  616. logic_op_jump_pos1.pop_back();
  617. logic_op_jump_pos2.pop_back();
  618. append_opcode(GDScriptFunction::OPCODE_ASSIGN_TRUE);
  619. append(p_target);
  620. }
  621. void GDScriptByteCodeGenerator::write_start_ternary(const Address &p_target) {
  622. ternary_result.push_back(p_target);
  623. }
  624. void GDScriptByteCodeGenerator::write_ternary_condition(const Address &p_condition) {
  625. append_opcode(GDScriptFunction::OPCODE_JUMP_IF_NOT);
  626. append(p_condition);
  627. ternary_jump_fail_pos.push_back(opcodes.size());
  628. append(0); // Jump target, will be patched.
  629. }
  630. void GDScriptByteCodeGenerator::write_ternary_true_expr(const Address &p_expr) {
  631. append_opcode(GDScriptFunction::OPCODE_ASSIGN);
  632. append(ternary_result.back()->get());
  633. append(p_expr);
  634. // Jump away from the false path.
  635. append_opcode(GDScriptFunction::OPCODE_JUMP);
  636. ternary_jump_skip_pos.push_back(opcodes.size());
  637. append(0);
  638. // Fail must jump here.
  639. patch_jump(ternary_jump_fail_pos.back()->get());
  640. ternary_jump_fail_pos.pop_back();
  641. }
  642. void GDScriptByteCodeGenerator::write_ternary_false_expr(const Address &p_expr) {
  643. append_opcode(GDScriptFunction::OPCODE_ASSIGN);
  644. append(ternary_result.back()->get());
  645. append(p_expr);
  646. }
  647. void GDScriptByteCodeGenerator::write_end_ternary() {
  648. patch_jump(ternary_jump_skip_pos.back()->get());
  649. ternary_jump_skip_pos.pop_back();
  650. ternary_result.pop_back();
  651. }
  652. void GDScriptByteCodeGenerator::write_set(const Address &p_target, const Address &p_index, const Address &p_source) {
  653. if (HAS_BUILTIN_TYPE(p_target)) {
  654. if (IS_BUILTIN_TYPE(p_index, Variant::INT) && Variant::get_member_validated_indexed_setter(p_target.type.builtin_type) &&
  655. IS_BUILTIN_TYPE(p_source, Variant::get_indexed_element_type(p_target.type.builtin_type))) {
  656. // Use indexed setter instead.
  657. Variant::ValidatedIndexedSetter setter = Variant::get_member_validated_indexed_setter(p_target.type.builtin_type);
  658. append_opcode(GDScriptFunction::OPCODE_SET_INDEXED_VALIDATED);
  659. append(p_target);
  660. append(p_index);
  661. append(p_source);
  662. append(setter);
  663. return;
  664. } else if (Variant::get_member_validated_keyed_setter(p_target.type.builtin_type)) {
  665. Variant::ValidatedKeyedSetter setter = Variant::get_member_validated_keyed_setter(p_target.type.builtin_type);
  666. append_opcode(GDScriptFunction::OPCODE_SET_KEYED_VALIDATED);
  667. append(p_target);
  668. append(p_index);
  669. append(p_source);
  670. append(setter);
  671. return;
  672. }
  673. }
  674. append_opcode(GDScriptFunction::OPCODE_SET_KEYED);
  675. append(p_target);
  676. append(p_index);
  677. append(p_source);
  678. }
  679. void GDScriptByteCodeGenerator::write_get(const Address &p_target, const Address &p_index, const Address &p_source) {
  680. if (HAS_BUILTIN_TYPE(p_source)) {
  681. if (IS_BUILTIN_TYPE(p_index, Variant::INT) && Variant::get_member_validated_indexed_getter(p_source.type.builtin_type)) {
  682. // Use indexed getter instead.
  683. Variant::ValidatedIndexedGetter getter = Variant::get_member_validated_indexed_getter(p_source.type.builtin_type);
  684. append_opcode(GDScriptFunction::OPCODE_GET_INDEXED_VALIDATED);
  685. append(p_source);
  686. append(p_index);
  687. append(p_target);
  688. append(getter);
  689. return;
  690. } else if (Variant::get_member_validated_keyed_getter(p_source.type.builtin_type)) {
  691. Variant::ValidatedKeyedGetter getter = Variant::get_member_validated_keyed_getter(p_source.type.builtin_type);
  692. append_opcode(GDScriptFunction::OPCODE_GET_KEYED_VALIDATED);
  693. append(p_source);
  694. append(p_index);
  695. append(p_target);
  696. append(getter);
  697. return;
  698. }
  699. }
  700. append_opcode(GDScriptFunction::OPCODE_GET_KEYED);
  701. append(p_source);
  702. append(p_index);
  703. append(p_target);
  704. }
  705. void GDScriptByteCodeGenerator::write_set_named(const Address &p_target, const StringName &p_name, const Address &p_source) {
  706. if (HAS_BUILTIN_TYPE(p_target) && Variant::get_member_validated_setter(p_target.type.builtin_type, p_name) &&
  707. IS_BUILTIN_TYPE(p_source, Variant::get_member_type(p_target.type.builtin_type, p_name))) {
  708. Variant::ValidatedSetter setter = Variant::get_member_validated_setter(p_target.type.builtin_type, p_name);
  709. append_opcode(GDScriptFunction::OPCODE_SET_NAMED_VALIDATED);
  710. append(p_target);
  711. append(p_source);
  712. append(setter);
  713. #ifdef DEBUG_ENABLED
  714. add_debug_name(setter_names, get_setter_pos(setter), p_name);
  715. #endif
  716. return;
  717. }
  718. append_opcode(GDScriptFunction::OPCODE_SET_NAMED);
  719. append(p_target);
  720. append(p_source);
  721. append(p_name);
  722. }
  723. void GDScriptByteCodeGenerator::write_get_named(const Address &p_target, const StringName &p_name, const Address &p_source) {
  724. if (HAS_BUILTIN_TYPE(p_source) && Variant::get_member_validated_getter(p_source.type.builtin_type, p_name)) {
  725. Variant::ValidatedGetter getter = Variant::get_member_validated_getter(p_source.type.builtin_type, p_name);
  726. append_opcode(GDScriptFunction::OPCODE_GET_NAMED_VALIDATED);
  727. append(p_source);
  728. append(p_target);
  729. append(getter);
  730. #ifdef DEBUG_ENABLED
  731. add_debug_name(getter_names, get_getter_pos(getter), p_name);
  732. #endif
  733. return;
  734. }
  735. append_opcode(GDScriptFunction::OPCODE_GET_NAMED);
  736. append(p_source);
  737. append(p_target);
  738. append(p_name);
  739. }
  740. void GDScriptByteCodeGenerator::write_set_member(const Address &p_value, const StringName &p_name) {
  741. append_opcode(GDScriptFunction::OPCODE_SET_MEMBER);
  742. append(p_value);
  743. append(p_name);
  744. }
  745. void GDScriptByteCodeGenerator::write_get_member(const Address &p_target, const StringName &p_name) {
  746. append_opcode(GDScriptFunction::OPCODE_GET_MEMBER);
  747. append(p_target);
  748. append(p_name);
  749. }
  750. void GDScriptByteCodeGenerator::write_assign_with_conversion(const Address &p_target, const Address &p_source) {
  751. switch (p_target.type.kind) {
  752. case GDScriptDataType::BUILTIN: {
  753. if (p_target.type.builtin_type == Variant::ARRAY && p_target.type.has_container_element_type()) {
  754. append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_ARRAY);
  755. append(p_target);
  756. append(p_source);
  757. } else {
  758. append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_BUILTIN);
  759. append(p_target);
  760. append(p_source);
  761. append(p_target.type.builtin_type);
  762. }
  763. } break;
  764. case GDScriptDataType::NATIVE: {
  765. int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[p_target.type.native_type];
  766. Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
  767. class_idx = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  768. append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_NATIVE);
  769. append(p_target);
  770. append(p_source);
  771. append(class_idx);
  772. } break;
  773. case GDScriptDataType::SCRIPT:
  774. case GDScriptDataType::GDSCRIPT: {
  775. Variant script = p_target.type.script_type;
  776. int idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  777. append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_SCRIPT);
  778. append(p_target);
  779. append(p_source);
  780. append(idx);
  781. } break;
  782. default: {
  783. ERR_PRINT("Compiler bug: unresolved assign.");
  784. // Shouldn't get here, but fail-safe to a regular assignment
  785. append_opcode(GDScriptFunction::OPCODE_ASSIGN);
  786. append(p_target);
  787. append(p_source);
  788. }
  789. }
  790. }
  791. void GDScriptByteCodeGenerator::write_assign(const Address &p_target, const Address &p_source) {
  792. if (p_target.type.kind == GDScriptDataType::BUILTIN && p_target.type.builtin_type == Variant::ARRAY && p_target.type.has_container_element_type()) {
  793. append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_ARRAY);
  794. append(p_target);
  795. append(p_source);
  796. } else if (p_target.type.kind == GDScriptDataType::BUILTIN && p_source.type.kind == GDScriptDataType::BUILTIN && p_target.type.builtin_type != p_source.type.builtin_type) {
  797. // Need conversion.
  798. append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_BUILTIN);
  799. append(p_target);
  800. append(p_source);
  801. append(p_target.type.builtin_type);
  802. } else {
  803. append_opcode(GDScriptFunction::OPCODE_ASSIGN);
  804. append(p_target);
  805. append(p_source);
  806. }
  807. }
  808. void GDScriptByteCodeGenerator::write_assign_true(const Address &p_target) {
  809. append_opcode(GDScriptFunction::OPCODE_ASSIGN_TRUE);
  810. append(p_target);
  811. }
  812. void GDScriptByteCodeGenerator::write_assign_false(const Address &p_target) {
  813. append_opcode(GDScriptFunction::OPCODE_ASSIGN_FALSE);
  814. append(p_target);
  815. }
  816. void GDScriptByteCodeGenerator::write_assign_default_parameter(const Address &p_dst, const Address &p_src, bool p_use_conversion) {
  817. if (p_use_conversion) {
  818. write_assign_with_conversion(p_dst, p_src);
  819. } else {
  820. write_assign(p_dst, p_src);
  821. }
  822. function->default_arguments.push_back(opcodes.size());
  823. }
  824. void GDScriptByteCodeGenerator::write_store_global(const Address &p_dst, int p_global_index) {
  825. append_opcode(GDScriptFunction::OPCODE_STORE_GLOBAL);
  826. append(p_dst);
  827. append(p_global_index);
  828. }
  829. void GDScriptByteCodeGenerator::write_store_named_global(const Address &p_dst, const StringName &p_global) {
  830. append_opcode(GDScriptFunction::OPCODE_STORE_NAMED_GLOBAL);
  831. append(p_dst);
  832. append(p_global);
  833. }
  834. void GDScriptByteCodeGenerator::write_cast(const Address &p_target, const Address &p_source, const GDScriptDataType &p_type) {
  835. int index = 0;
  836. switch (p_type.kind) {
  837. case GDScriptDataType::BUILTIN: {
  838. append_opcode(GDScriptFunction::OPCODE_CAST_TO_BUILTIN);
  839. index = p_type.builtin_type;
  840. } break;
  841. case GDScriptDataType::NATIVE: {
  842. int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[p_type.native_type];
  843. Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
  844. append_opcode(GDScriptFunction::OPCODE_CAST_TO_NATIVE);
  845. index = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  846. } break;
  847. case GDScriptDataType::SCRIPT:
  848. case GDScriptDataType::GDSCRIPT: {
  849. Variant script = p_type.script_type;
  850. int idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  851. append_opcode(GDScriptFunction::OPCODE_CAST_TO_SCRIPT);
  852. index = idx;
  853. } break;
  854. default: {
  855. return;
  856. }
  857. }
  858. append(p_source);
  859. append(p_target);
  860. append(index);
  861. }
  862. GDScriptCodeGenerator::Address GDScriptByteCodeGenerator::get_call_target(const GDScriptCodeGenerator::Address &p_target, Variant::Type p_type) {
  863. if (p_target.mode == Address::NIL) {
  864. GDScriptDataType type;
  865. if (p_type != Variant::NIL) {
  866. type.has_type = true;
  867. type.kind = GDScriptDataType::BUILTIN;
  868. type.builtin_type = p_type;
  869. }
  870. uint32_t addr = add_temporary(type);
  871. pop_temporary();
  872. return Address(Address::TEMPORARY, addr, type);
  873. } else {
  874. return p_target;
  875. }
  876. }
  877. void GDScriptByteCodeGenerator::write_call(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  878. append_opcode_and_argcount(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
  879. for (int i = 0; i < p_arguments.size(); i++) {
  880. append(p_arguments[i]);
  881. }
  882. append(p_base);
  883. append(get_call_target(p_target));
  884. append(p_arguments.size());
  885. append(p_function_name);
  886. }
  887. void GDScriptByteCodeGenerator::write_super_call(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  888. append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_SELF_BASE, 1 + p_arguments.size());
  889. for (int i = 0; i < p_arguments.size(); i++) {
  890. append(p_arguments[i]);
  891. }
  892. append(get_call_target(p_target));
  893. append(p_arguments.size());
  894. append(p_function_name);
  895. }
  896. void GDScriptByteCodeGenerator::write_call_async(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  897. append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_ASYNC, 2 + p_arguments.size());
  898. for (int i = 0; i < p_arguments.size(); i++) {
  899. append(p_arguments[i]);
  900. }
  901. append(p_base);
  902. append(get_call_target(p_target));
  903. append(p_arguments.size());
  904. append(p_function_name);
  905. }
  906. void GDScriptByteCodeGenerator::write_call_gdscript_utility(const Address &p_target, const StringName &p_function, const Vector<Address> &p_arguments) {
  907. append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_GDSCRIPT_UTILITY, 1 + p_arguments.size());
  908. GDScriptUtilityFunctions::FunctionPtr gds_function = GDScriptUtilityFunctions::get_function(p_function);
  909. for (int i = 0; i < p_arguments.size(); i++) {
  910. append(p_arguments[i]);
  911. }
  912. append(get_call_target(p_target));
  913. append(p_arguments.size());
  914. append(gds_function);
  915. #ifdef DEBUG_ENABLED
  916. add_debug_name(gds_utilities_names, get_gds_utility_pos(gds_function), p_function);
  917. #endif
  918. }
  919. void GDScriptByteCodeGenerator::write_call_utility(const Address &p_target, const StringName &p_function, const Vector<Address> &p_arguments) {
  920. bool is_validated = true;
  921. if (Variant::is_utility_function_vararg(p_function)) {
  922. is_validated = true; // Vararg works fine with any argument, since they can be any type.
  923. } else if (p_arguments.size() == Variant::get_utility_function_argument_count(p_function)) {
  924. bool all_types_exact = true;
  925. for (int i = 0; i < p_arguments.size(); i++) {
  926. if (!IS_BUILTIN_TYPE(p_arguments[i], Variant::get_utility_function_argument_type(p_function, i))) {
  927. all_types_exact = false;
  928. break;
  929. }
  930. }
  931. is_validated = all_types_exact;
  932. }
  933. if (is_validated) {
  934. Variant::Type result_type = Variant::has_utility_function_return_value(p_function) ? Variant::get_utility_function_return_type(p_function) : Variant::NIL;
  935. Address target = get_call_target(p_target, result_type);
  936. Variant::Type temp_type = temporaries[target.address].type;
  937. if (result_type != temp_type) {
  938. write_type_adjust(target, result_type);
  939. }
  940. append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_UTILITY_VALIDATED, 1 + p_arguments.size());
  941. for (int i = 0; i < p_arguments.size(); i++) {
  942. append(p_arguments[i]);
  943. }
  944. append(target);
  945. append(p_arguments.size());
  946. append(Variant::get_validated_utility_function(p_function));
  947. #ifdef DEBUG_ENABLED
  948. add_debug_name(utilities_names, get_utility_pos(Variant::get_validated_utility_function(p_function)), p_function);
  949. #endif
  950. } else {
  951. append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_UTILITY, 1 + p_arguments.size());
  952. for (int i = 0; i < p_arguments.size(); i++) {
  953. append(p_arguments[i]);
  954. }
  955. append(get_call_target(p_target));
  956. append(p_arguments.size());
  957. append(p_function);
  958. }
  959. }
  960. void GDScriptByteCodeGenerator::write_call_builtin_type(const Address &p_target, const Address &p_base, Variant::Type p_type, const StringName &p_method, bool p_is_static, const Vector<Address> &p_arguments) {
  961. bool is_validated = false;
  962. // Check if all types are correct.
  963. if (Variant::is_builtin_method_vararg(p_type, p_method)) {
  964. is_validated = true; // Vararg works fine with any argument, since they can be any type.
  965. } else if (p_arguments.size() == Variant::get_builtin_method_argument_count(p_type, p_method)) {
  966. bool all_types_exact = true;
  967. for (int i = 0; i < p_arguments.size(); i++) {
  968. if (!IS_BUILTIN_TYPE(p_arguments[i], Variant::get_builtin_method_argument_type(p_type, p_method, i))) {
  969. all_types_exact = false;
  970. break;
  971. }
  972. }
  973. is_validated = all_types_exact;
  974. }
  975. if (!is_validated) {
  976. // Perform regular call.
  977. if (p_is_static) {
  978. append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_BUILTIN_STATIC, p_arguments.size() + 1);
  979. for (int i = 0; i < p_arguments.size(); i++) {
  980. append(p_arguments[i]);
  981. }
  982. append(get_call_target(p_target));
  983. append(p_type);
  984. append(p_method);
  985. append(p_arguments.size());
  986. } else {
  987. write_call(p_target, p_base, p_method, p_arguments);
  988. }
  989. return;
  990. }
  991. Variant::Type result_type = Variant::get_builtin_method_return_type(p_type, p_method);
  992. Address target = get_call_target(p_target, result_type);
  993. Variant::Type temp_type = temporaries[target.address].type;
  994. if (result_type != temp_type) {
  995. write_type_adjust(target, result_type);
  996. }
  997. append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_BUILTIN_TYPE_VALIDATED, 2 + p_arguments.size());
  998. for (int i = 0; i < p_arguments.size(); i++) {
  999. append(p_arguments[i]);
  1000. }
  1001. append(p_base);
  1002. append(target);
  1003. append(p_arguments.size());
  1004. append(Variant::get_validated_builtin_method(p_type, p_method));
  1005. #ifdef DEBUG_ENABLED
  1006. add_debug_name(builtin_methods_names, get_builtin_method_pos(Variant::get_validated_builtin_method(p_type, p_method)), p_method);
  1007. #endif
  1008. }
  1009. 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) {
  1010. write_call_builtin_type(p_target, p_base, p_type, p_method, false, p_arguments);
  1011. }
  1012. void GDScriptByteCodeGenerator::write_call_builtin_type_static(const Address &p_target, Variant::Type p_type, const StringName &p_method, const Vector<Address> &p_arguments) {
  1013. write_call_builtin_type(p_target, Address(), p_type, p_method, true, p_arguments);
  1014. }
  1015. void GDScriptByteCodeGenerator::write_call_native_static(const Address &p_target, const StringName &p_class, const StringName &p_method, const Vector<Address> &p_arguments) {
  1016. bool is_validated = false;
  1017. MethodBind *method = ClassDB::get_method(p_class, p_method);
  1018. if (!is_validated) {
  1019. // Perform regular call.
  1020. append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_NATIVE_STATIC, p_arguments.size() + 1);
  1021. for (int i = 0; i < p_arguments.size(); i++) {
  1022. append(p_arguments[i]);
  1023. }
  1024. append(get_call_target(p_target));
  1025. append(method);
  1026. append(p_arguments.size());
  1027. return;
  1028. }
  1029. }
  1030. void GDScriptByteCodeGenerator::write_call_method_bind(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) {
  1031. append_opcode_and_argcount(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL_METHOD_BIND : GDScriptFunction::OPCODE_CALL_METHOD_BIND_RET, 2 + p_arguments.size());
  1032. for (int i = 0; i < p_arguments.size(); i++) {
  1033. append(p_arguments[i]);
  1034. }
  1035. append(p_base);
  1036. append(get_call_target(p_target));
  1037. append(p_arguments.size());
  1038. append(p_method);
  1039. }
  1040. void GDScriptByteCodeGenerator::write_call_ptrcall(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) {
  1041. #define CASE_TYPE(m_type) \
  1042. case Variant::m_type: \
  1043. append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_PTRCALL_##m_type, 2 + p_arguments.size()); \
  1044. break
  1045. bool is_ptrcall = true;
  1046. if (p_method->has_return()) {
  1047. MethodInfo info;
  1048. ClassDB::get_method_info(p_method->get_instance_class(), p_method->get_name(), &info);
  1049. switch (info.return_val.type) {
  1050. CASE_TYPE(BOOL);
  1051. CASE_TYPE(INT);
  1052. CASE_TYPE(FLOAT);
  1053. CASE_TYPE(STRING);
  1054. CASE_TYPE(VECTOR2);
  1055. CASE_TYPE(VECTOR2I);
  1056. CASE_TYPE(RECT2);
  1057. CASE_TYPE(RECT2I);
  1058. CASE_TYPE(VECTOR3);
  1059. CASE_TYPE(VECTOR3I);
  1060. CASE_TYPE(TRANSFORM2D);
  1061. CASE_TYPE(PLANE);
  1062. CASE_TYPE(AABB);
  1063. CASE_TYPE(BASIS);
  1064. CASE_TYPE(TRANSFORM3D);
  1065. CASE_TYPE(COLOR);
  1066. CASE_TYPE(STRING_NAME);
  1067. CASE_TYPE(NODE_PATH);
  1068. CASE_TYPE(RID);
  1069. CASE_TYPE(QUATERNION);
  1070. CASE_TYPE(OBJECT);
  1071. CASE_TYPE(CALLABLE);
  1072. CASE_TYPE(SIGNAL);
  1073. CASE_TYPE(DICTIONARY);
  1074. CASE_TYPE(ARRAY);
  1075. CASE_TYPE(PACKED_BYTE_ARRAY);
  1076. CASE_TYPE(PACKED_INT32_ARRAY);
  1077. CASE_TYPE(PACKED_INT64_ARRAY);
  1078. CASE_TYPE(PACKED_FLOAT32_ARRAY);
  1079. CASE_TYPE(PACKED_FLOAT64_ARRAY);
  1080. CASE_TYPE(PACKED_STRING_ARRAY);
  1081. CASE_TYPE(PACKED_VECTOR2_ARRAY);
  1082. CASE_TYPE(PACKED_VECTOR3_ARRAY);
  1083. CASE_TYPE(PACKED_COLOR_ARRAY);
  1084. default:
  1085. append_opcode_and_argcount(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL_METHOD_BIND : GDScriptFunction::OPCODE_CALL_METHOD_BIND_RET, 2 + p_arguments.size());
  1086. is_ptrcall = false;
  1087. break;
  1088. }
  1089. } else {
  1090. append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_PTRCALL_NO_RETURN, 2 + p_arguments.size());
  1091. }
  1092. for (int i = 0; i < p_arguments.size(); i++) {
  1093. append(p_arguments[i]);
  1094. }
  1095. append(p_base);
  1096. append(get_call_target(p_target));
  1097. append(p_arguments.size());
  1098. append(p_method);
  1099. if (is_ptrcall) {
  1100. alloc_ptrcall(p_arguments.size());
  1101. }
  1102. #undef CASE_TYPE
  1103. }
  1104. void GDScriptByteCodeGenerator::write_call_self(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  1105. append_opcode_and_argcount(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
  1106. for (int i = 0; i < p_arguments.size(); i++) {
  1107. append(p_arguments[i]);
  1108. }
  1109. append(GDScriptFunction::ADDR_TYPE_STACK << GDScriptFunction::ADDR_BITS);
  1110. append(get_call_target(p_target));
  1111. append(p_arguments.size());
  1112. append(p_function_name);
  1113. }
  1114. void GDScriptByteCodeGenerator::write_call_self_async(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  1115. append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_ASYNC, 2 + p_arguments.size());
  1116. for (int i = 0; i < p_arguments.size(); i++) {
  1117. append(p_arguments[i]);
  1118. }
  1119. append(GDScriptFunction::ADDR_SELF);
  1120. append(get_call_target(p_target));
  1121. append(p_arguments.size());
  1122. append(p_function_name);
  1123. }
  1124. void GDScriptByteCodeGenerator::write_call_script_function(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  1125. append_opcode_and_argcount(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
  1126. for (int i = 0; i < p_arguments.size(); i++) {
  1127. append(p_arguments[i]);
  1128. }
  1129. append(p_base);
  1130. append(get_call_target(p_target));
  1131. append(p_arguments.size());
  1132. append(p_function_name);
  1133. }
  1134. void GDScriptByteCodeGenerator::write_lambda(const Address &p_target, GDScriptFunction *p_function, const Vector<Address> &p_captures, bool p_use_self) {
  1135. append_opcode_and_argcount(p_use_self ? GDScriptFunction::OPCODE_CREATE_SELF_LAMBDA : GDScriptFunction::OPCODE_CREATE_LAMBDA, 1 + p_captures.size());
  1136. for (int i = 0; i < p_captures.size(); i++) {
  1137. append(p_captures[i]);
  1138. }
  1139. append(get_call_target(p_target));
  1140. append(p_captures.size());
  1141. append(p_function);
  1142. }
  1143. void GDScriptByteCodeGenerator::write_construct(const Address &p_target, Variant::Type p_type, const Vector<Address> &p_arguments) {
  1144. // Try to find an appropriate constructor.
  1145. bool all_have_type = true;
  1146. Vector<Variant::Type> arg_types;
  1147. for (int i = 0; i < p_arguments.size(); i++) {
  1148. if (!HAS_BUILTIN_TYPE(p_arguments[i])) {
  1149. all_have_type = false;
  1150. break;
  1151. }
  1152. arg_types.push_back(p_arguments[i].type.builtin_type);
  1153. }
  1154. if (all_have_type) {
  1155. int valid_constructor = -1;
  1156. for (int i = 0; i < Variant::get_constructor_count(p_type); i++) {
  1157. if (Variant::get_constructor_argument_count(p_type, i) != p_arguments.size()) {
  1158. continue;
  1159. }
  1160. int types_correct = true;
  1161. for (int j = 0; j < arg_types.size(); j++) {
  1162. if (arg_types[j] != Variant::get_constructor_argument_type(p_type, i, j)) {
  1163. types_correct = false;
  1164. break;
  1165. }
  1166. }
  1167. if (types_correct) {
  1168. valid_constructor = i;
  1169. break;
  1170. }
  1171. }
  1172. if (valid_constructor >= 0) {
  1173. append_opcode_and_argcount(GDScriptFunction::OPCODE_CONSTRUCT_VALIDATED, 1 + p_arguments.size());
  1174. for (int i = 0; i < p_arguments.size(); i++) {
  1175. append(p_arguments[i]);
  1176. }
  1177. append(get_call_target(p_target));
  1178. append(p_arguments.size());
  1179. append(Variant::get_validated_constructor(p_type, valid_constructor));
  1180. #ifdef DEBUG_ENABLED
  1181. add_debug_name(constructors_names, get_constructor_pos(Variant::get_validated_constructor(p_type, valid_constructor)), Variant::get_type_name(p_type));
  1182. #endif
  1183. return;
  1184. }
  1185. }
  1186. append_opcode_and_argcount(GDScriptFunction::OPCODE_CONSTRUCT, 1 + p_arguments.size());
  1187. for (int i = 0; i < p_arguments.size(); i++) {
  1188. append(p_arguments[i]);
  1189. }
  1190. append(get_call_target(p_target));
  1191. append(p_arguments.size());
  1192. append(p_type);
  1193. }
  1194. void GDScriptByteCodeGenerator::write_construct_array(const Address &p_target, const Vector<Address> &p_arguments) {
  1195. append_opcode_and_argcount(GDScriptFunction::OPCODE_CONSTRUCT_ARRAY, 1 + p_arguments.size());
  1196. for (int i = 0; i < p_arguments.size(); i++) {
  1197. append(p_arguments[i]);
  1198. }
  1199. append(get_call_target(p_target));
  1200. append(p_arguments.size());
  1201. }
  1202. void GDScriptByteCodeGenerator::write_construct_typed_array(const Address &p_target, const GDScriptDataType &p_element_type, const Vector<Address> &p_arguments) {
  1203. append_opcode_and_argcount(GDScriptFunction::OPCODE_CONSTRUCT_TYPED_ARRAY, 2 + p_arguments.size());
  1204. for (int i = 0; i < p_arguments.size(); i++) {
  1205. append(p_arguments[i]);
  1206. }
  1207. append(get_call_target(p_target));
  1208. if (p_element_type.script_type) {
  1209. Variant script_type = Ref<Script>(p_element_type.script_type);
  1210. int addr = get_constant_pos(script_type);
  1211. addr |= GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS;
  1212. append(addr);
  1213. } else {
  1214. append(Address()); // null.
  1215. }
  1216. append(p_arguments.size());
  1217. append(p_element_type.builtin_type);
  1218. append(p_element_type.native_type);
  1219. }
  1220. void GDScriptByteCodeGenerator::write_construct_dictionary(const Address &p_target, const Vector<Address> &p_arguments) {
  1221. append_opcode_and_argcount(GDScriptFunction::OPCODE_CONSTRUCT_DICTIONARY, 1 + p_arguments.size());
  1222. for (int i = 0; i < p_arguments.size(); i++) {
  1223. append(p_arguments[i]);
  1224. }
  1225. append(get_call_target(p_target));
  1226. append(p_arguments.size() / 2); // This is number of key-value pairs, so only half of actual arguments.
  1227. }
  1228. void GDScriptByteCodeGenerator::write_await(const Address &p_target, const Address &p_operand) {
  1229. append_opcode(GDScriptFunction::OPCODE_AWAIT);
  1230. append(p_operand);
  1231. append_opcode(GDScriptFunction::OPCODE_AWAIT_RESUME);
  1232. append(p_target);
  1233. }
  1234. void GDScriptByteCodeGenerator::write_if(const Address &p_condition) {
  1235. append_opcode(GDScriptFunction::OPCODE_JUMP_IF_NOT);
  1236. append(p_condition);
  1237. if_jmp_addrs.push_back(opcodes.size());
  1238. append(0); // Jump destination, will be patched.
  1239. }
  1240. void GDScriptByteCodeGenerator::write_else() {
  1241. append_opcode(GDScriptFunction::OPCODE_JUMP); // Jump from true if block;
  1242. int else_jmp_addr = opcodes.size();
  1243. append(0); // Jump destination, will be patched.
  1244. patch_jump(if_jmp_addrs.back()->get());
  1245. if_jmp_addrs.pop_back();
  1246. if_jmp_addrs.push_back(else_jmp_addr);
  1247. }
  1248. void GDScriptByteCodeGenerator::write_endif() {
  1249. patch_jump(if_jmp_addrs.back()->get());
  1250. if_jmp_addrs.pop_back();
  1251. }
  1252. void GDScriptByteCodeGenerator::write_jump_if_shared(const Address &p_value) {
  1253. append_opcode(GDScriptFunction::OPCODE_JUMP_IF_SHARED);
  1254. append(p_value);
  1255. if_jmp_addrs.push_back(opcodes.size());
  1256. append(0); // Jump destination, will be patched.
  1257. }
  1258. void GDScriptByteCodeGenerator::write_end_jump_if_shared() {
  1259. patch_jump(if_jmp_addrs.back()->get());
  1260. if_jmp_addrs.pop_back();
  1261. }
  1262. void GDScriptByteCodeGenerator::start_for(const GDScriptDataType &p_iterator_type, const GDScriptDataType &p_list_type) {
  1263. Address counter(Address::LOCAL_VARIABLE, add_local("@counter_pos", p_iterator_type), p_iterator_type);
  1264. Address container(Address::LOCAL_VARIABLE, add_local("@container_pos", p_list_type), p_list_type);
  1265. // Store state.
  1266. for_counter_variables.push_back(counter);
  1267. for_container_variables.push_back(container);
  1268. }
  1269. void GDScriptByteCodeGenerator::write_for_assignment(const Address &p_variable, const Address &p_list) {
  1270. const Address &container = for_container_variables.back()->get();
  1271. // Assign container.
  1272. append_opcode(GDScriptFunction::OPCODE_ASSIGN);
  1273. append(container);
  1274. append(p_list);
  1275. for_iterator_variables.push_back(p_variable);
  1276. }
  1277. void GDScriptByteCodeGenerator::write_for() {
  1278. const Address &iterator = for_iterator_variables.back()->get();
  1279. const Address &counter = for_counter_variables.back()->get();
  1280. const Address &container = for_container_variables.back()->get();
  1281. current_breaks_to_patch.push_back(List<int>());
  1282. GDScriptFunction::Opcode begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN;
  1283. GDScriptFunction::Opcode iterate_opcode = GDScriptFunction::OPCODE_ITERATE;
  1284. if (container.type.has_type) {
  1285. if (container.type.kind == GDScriptDataType::BUILTIN) {
  1286. switch (container.type.builtin_type) {
  1287. case Variant::INT:
  1288. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_INT;
  1289. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_INT;
  1290. break;
  1291. case Variant::FLOAT:
  1292. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_FLOAT;
  1293. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_FLOAT;
  1294. break;
  1295. case Variant::VECTOR2:
  1296. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR2;
  1297. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR2;
  1298. break;
  1299. case Variant::VECTOR2I:
  1300. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR2I;
  1301. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR2I;
  1302. break;
  1303. case Variant::VECTOR3:
  1304. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR3;
  1305. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR3;
  1306. break;
  1307. case Variant::VECTOR3I:
  1308. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR3I;
  1309. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR3I;
  1310. break;
  1311. case Variant::STRING:
  1312. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_STRING;
  1313. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_STRING;
  1314. break;
  1315. case Variant::DICTIONARY:
  1316. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_DICTIONARY;
  1317. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_DICTIONARY;
  1318. break;
  1319. case Variant::ARRAY:
  1320. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_ARRAY;
  1321. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_ARRAY;
  1322. break;
  1323. case Variant::PACKED_BYTE_ARRAY:
  1324. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_BYTE_ARRAY;
  1325. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_BYTE_ARRAY;
  1326. break;
  1327. case Variant::PACKED_INT32_ARRAY:
  1328. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_INT32_ARRAY;
  1329. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_INT32_ARRAY;
  1330. break;
  1331. case Variant::PACKED_INT64_ARRAY:
  1332. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_INT64_ARRAY;
  1333. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_INT64_ARRAY;
  1334. break;
  1335. case Variant::PACKED_FLOAT32_ARRAY:
  1336. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_FLOAT32_ARRAY;
  1337. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_FLOAT32_ARRAY;
  1338. break;
  1339. case Variant::PACKED_FLOAT64_ARRAY:
  1340. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_FLOAT64_ARRAY;
  1341. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_FLOAT64_ARRAY;
  1342. break;
  1343. case Variant::PACKED_STRING_ARRAY:
  1344. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_STRING_ARRAY;
  1345. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_STRING_ARRAY;
  1346. break;
  1347. case Variant::PACKED_VECTOR2_ARRAY:
  1348. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_VECTOR2_ARRAY;
  1349. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_VECTOR2_ARRAY;
  1350. break;
  1351. case Variant::PACKED_VECTOR3_ARRAY:
  1352. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_VECTOR3_ARRAY;
  1353. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_VECTOR3_ARRAY;
  1354. break;
  1355. case Variant::PACKED_COLOR_ARRAY:
  1356. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_COLOR_ARRAY;
  1357. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_COLOR_ARRAY;
  1358. break;
  1359. default:
  1360. break;
  1361. }
  1362. } else {
  1363. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_OBJECT;
  1364. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_OBJECT;
  1365. }
  1366. }
  1367. // Begin loop.
  1368. append_opcode(begin_opcode);
  1369. append(counter);
  1370. append(container);
  1371. append(iterator);
  1372. for_jmp_addrs.push_back(opcodes.size());
  1373. append(0); // End of loop address, will be patched.
  1374. append_opcode(GDScriptFunction::OPCODE_JUMP);
  1375. append(opcodes.size() + 6); // Skip over 'continue' code.
  1376. // Next iteration.
  1377. int continue_addr = opcodes.size();
  1378. continue_addrs.push_back(continue_addr);
  1379. append_opcode(iterate_opcode);
  1380. append(counter);
  1381. append(container);
  1382. append(iterator);
  1383. for_jmp_addrs.push_back(opcodes.size());
  1384. append(0); // Jump destination, will be patched.
  1385. }
  1386. void GDScriptByteCodeGenerator::write_endfor() {
  1387. // Jump back to loop check.
  1388. append_opcode(GDScriptFunction::OPCODE_JUMP);
  1389. append(continue_addrs.back()->get());
  1390. continue_addrs.pop_back();
  1391. // Patch end jumps (two of them).
  1392. for (int i = 0; i < 2; i++) {
  1393. patch_jump(for_jmp_addrs.back()->get());
  1394. for_jmp_addrs.pop_back();
  1395. }
  1396. // Patch break statements.
  1397. for (const int &E : current_breaks_to_patch.back()->get()) {
  1398. patch_jump(E);
  1399. }
  1400. current_breaks_to_patch.pop_back();
  1401. // Pop state.
  1402. for_iterator_variables.pop_back();
  1403. for_counter_variables.pop_back();
  1404. for_container_variables.pop_back();
  1405. }
  1406. void GDScriptByteCodeGenerator::start_while_condition() {
  1407. current_breaks_to_patch.push_back(List<int>());
  1408. continue_addrs.push_back(opcodes.size());
  1409. }
  1410. void GDScriptByteCodeGenerator::write_while(const Address &p_condition) {
  1411. // Condition check.
  1412. append_opcode(GDScriptFunction::OPCODE_JUMP_IF_NOT);
  1413. append(p_condition);
  1414. while_jmp_addrs.push_back(opcodes.size());
  1415. append(0); // End of loop address, will be patched.
  1416. }
  1417. void GDScriptByteCodeGenerator::write_endwhile() {
  1418. // Jump back to loop check.
  1419. append_opcode(GDScriptFunction::OPCODE_JUMP);
  1420. append(continue_addrs.back()->get());
  1421. continue_addrs.pop_back();
  1422. // Patch end jump.
  1423. patch_jump(while_jmp_addrs.back()->get());
  1424. while_jmp_addrs.pop_back();
  1425. // Patch break statements.
  1426. for (const int &E : current_breaks_to_patch.back()->get()) {
  1427. patch_jump(E);
  1428. }
  1429. current_breaks_to_patch.pop_back();
  1430. }
  1431. void GDScriptByteCodeGenerator::write_break() {
  1432. append_opcode(GDScriptFunction::OPCODE_JUMP);
  1433. current_breaks_to_patch.back()->get().push_back(opcodes.size());
  1434. append(0);
  1435. }
  1436. void GDScriptByteCodeGenerator::write_continue() {
  1437. append_opcode(GDScriptFunction::OPCODE_JUMP);
  1438. append(continue_addrs.back()->get());
  1439. }
  1440. void GDScriptByteCodeGenerator::write_breakpoint() {
  1441. append_opcode(GDScriptFunction::OPCODE_BREAKPOINT);
  1442. }
  1443. void GDScriptByteCodeGenerator::write_newline(int p_line) {
  1444. append_opcode(GDScriptFunction::OPCODE_LINE);
  1445. append(p_line);
  1446. current_line = p_line;
  1447. }
  1448. void GDScriptByteCodeGenerator::write_return(const Address &p_return_value) {
  1449. if (!function->return_type.has_type || p_return_value.type.has_type) {
  1450. // Either the function is untyped or the return value is also typed.
  1451. // If this is a typed function, then we need to check for potential conversions.
  1452. if (function->return_type.has_type) {
  1453. if (function->return_type.kind == GDScriptDataType::BUILTIN && function->return_type.builtin_type == Variant::ARRAY && function->return_type.has_container_element_type()) {
  1454. // Typed array.
  1455. const GDScriptDataType &element_type = function->return_type.get_container_element_type();
  1456. Variant script = element_type.script_type;
  1457. int script_idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1458. append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_ARRAY);
  1459. append(p_return_value);
  1460. append(script_idx);
  1461. append(element_type.kind == GDScriptDataType::BUILTIN ? element_type.builtin_type : Variant::OBJECT);
  1462. append(element_type.native_type);
  1463. } 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) {
  1464. // Add conversion.
  1465. append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_BUILTIN);
  1466. append(p_return_value);
  1467. append(function->return_type.builtin_type);
  1468. } else {
  1469. // Just assign.
  1470. append_opcode(GDScriptFunction::OPCODE_RETURN);
  1471. append(p_return_value);
  1472. }
  1473. } else {
  1474. append_opcode(GDScriptFunction::OPCODE_RETURN);
  1475. append(p_return_value);
  1476. }
  1477. } else {
  1478. switch (function->return_type.kind) {
  1479. case GDScriptDataType::BUILTIN: {
  1480. if (function->return_type.builtin_type == Variant::ARRAY && function->return_type.has_container_element_type()) {
  1481. const GDScriptDataType &element_type = function->return_type.get_container_element_type();
  1482. Variant script = function->return_type.script_type;
  1483. int script_idx = get_constant_pos(script);
  1484. script_idx |= (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1485. append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_ARRAY);
  1486. append(p_return_value);
  1487. append(script_idx);
  1488. append(element_type.kind == GDScriptDataType::BUILTIN ? element_type.builtin_type : Variant::OBJECT);
  1489. append(element_type.native_type);
  1490. } else {
  1491. append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_BUILTIN);
  1492. append(p_return_value);
  1493. append(function->return_type.builtin_type);
  1494. }
  1495. } break;
  1496. case GDScriptDataType::NATIVE: {
  1497. append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_NATIVE);
  1498. append(p_return_value);
  1499. int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[function->return_type.native_type];
  1500. Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
  1501. class_idx = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1502. append(class_idx);
  1503. } break;
  1504. case GDScriptDataType::GDSCRIPT:
  1505. case GDScriptDataType::SCRIPT: {
  1506. Variant script = function->return_type.script_type;
  1507. int script_idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1508. append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_SCRIPT);
  1509. append(p_return_value);
  1510. append(script_idx);
  1511. } break;
  1512. default: {
  1513. ERR_PRINT("Compiler bug: unresolved return.");
  1514. // Shouldn't get here, but fail-safe to a regular return;
  1515. append_opcode(GDScriptFunction::OPCODE_RETURN);
  1516. append(p_return_value);
  1517. } break;
  1518. }
  1519. }
  1520. }
  1521. void GDScriptByteCodeGenerator::write_assert(const Address &p_test, const Address &p_message) {
  1522. append_opcode(GDScriptFunction::OPCODE_ASSERT);
  1523. append(p_test);
  1524. append(p_message);
  1525. }
  1526. void GDScriptByteCodeGenerator::start_block() {
  1527. push_stack_identifiers();
  1528. }
  1529. void GDScriptByteCodeGenerator::end_block() {
  1530. pop_stack_identifiers();
  1531. }
  1532. GDScriptByteCodeGenerator::~GDScriptByteCodeGenerator() {
  1533. if (!ended && function != nullptr) {
  1534. memdelete(function);
  1535. }
  1536. }