gdscript_byte_codegen.cpp 59 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700
  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-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 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::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_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(GDScriptFunction::OPCODE_END, 0);
  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. 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::VECTOR4:
  414. append(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3, 1);
  415. break;
  416. case Variant::VECTOR4I:
  417. append(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3I, 1);
  418. break;
  419. case Variant::PLANE:
  420. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PLANE, 1);
  421. break;
  422. case Variant::QUATERNION:
  423. append(GDScriptFunction::OPCODE_TYPE_ADJUST_QUATERNION, 1);
  424. break;
  425. case Variant::AABB:
  426. append(GDScriptFunction::OPCODE_TYPE_ADJUST_AABB, 1);
  427. break;
  428. case Variant::BASIS:
  429. append(GDScriptFunction::OPCODE_TYPE_ADJUST_BASIS, 1);
  430. break;
  431. case Variant::TRANSFORM3D:
  432. append(GDScriptFunction::OPCODE_TYPE_ADJUST_TRANSFORM3D, 1);
  433. break;
  434. case Variant::PROJECTION:
  435. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PROJECTION, 1);
  436. break;
  437. case Variant::COLOR:
  438. append(GDScriptFunction::OPCODE_TYPE_ADJUST_COLOR, 1);
  439. break;
  440. case Variant::STRING_NAME:
  441. append(GDScriptFunction::OPCODE_TYPE_ADJUST_STRING_NAME, 1);
  442. break;
  443. case Variant::NODE_PATH:
  444. append(GDScriptFunction::OPCODE_TYPE_ADJUST_NODE_PATH, 1);
  445. break;
  446. case Variant::RID:
  447. append(GDScriptFunction::OPCODE_TYPE_ADJUST_RID, 1);
  448. break;
  449. case Variant::OBJECT:
  450. append(GDScriptFunction::OPCODE_TYPE_ADJUST_OBJECT, 1);
  451. break;
  452. case Variant::CALLABLE:
  453. append(GDScriptFunction::OPCODE_TYPE_ADJUST_CALLABLE, 1);
  454. break;
  455. case Variant::SIGNAL:
  456. append(GDScriptFunction::OPCODE_TYPE_ADJUST_SIGNAL, 1);
  457. break;
  458. case Variant::DICTIONARY:
  459. append(GDScriptFunction::OPCODE_TYPE_ADJUST_DICTIONARY, 1);
  460. break;
  461. case Variant::ARRAY:
  462. append(GDScriptFunction::OPCODE_TYPE_ADJUST_ARRAY, 1);
  463. break;
  464. case Variant::PACKED_BYTE_ARRAY:
  465. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_BYTE_ARRAY, 1);
  466. break;
  467. case Variant::PACKED_INT32_ARRAY:
  468. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_INT32_ARRAY, 1);
  469. break;
  470. case Variant::PACKED_INT64_ARRAY:
  471. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_INT64_ARRAY, 1);
  472. break;
  473. case Variant::PACKED_FLOAT32_ARRAY:
  474. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_FLOAT32_ARRAY, 1);
  475. break;
  476. case Variant::PACKED_FLOAT64_ARRAY:
  477. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_FLOAT64_ARRAY, 1);
  478. break;
  479. case Variant::PACKED_STRING_ARRAY:
  480. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_STRING_ARRAY, 1);
  481. break;
  482. case Variant::PACKED_VECTOR2_ARRAY:
  483. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_VECTOR2_ARRAY, 1);
  484. break;
  485. case Variant::PACKED_VECTOR3_ARRAY:
  486. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_VECTOR3_ARRAY, 1);
  487. break;
  488. case Variant::PACKED_COLOR_ARRAY:
  489. append(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_COLOR_ARRAY, 1);
  490. break;
  491. case Variant::NIL:
  492. case Variant::VARIANT_MAX:
  493. return;
  494. }
  495. append(p_target);
  496. }
  497. void GDScriptByteCodeGenerator::write_unary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand) {
  498. if (HAS_BUILTIN_TYPE(p_left_operand)) {
  499. // Gather specific operator.
  500. Variant::ValidatedOperatorEvaluator op_func = Variant::get_validated_operator_evaluator(p_operator, p_left_operand.type.builtin_type, Variant::NIL);
  501. append(GDScriptFunction::OPCODE_OPERATOR_VALIDATED, 3);
  502. append(p_left_operand);
  503. append(Address());
  504. append(p_target);
  505. append(op_func);
  506. return;
  507. }
  508. // No specific types, perform variant evaluation.
  509. append(GDScriptFunction::OPCODE_OPERATOR, 3);
  510. append(p_left_operand);
  511. append(Address());
  512. append(p_target);
  513. append(p_operator);
  514. }
  515. void GDScriptByteCodeGenerator::write_binary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand, const Address &p_right_operand) {
  516. if (HAS_BUILTIN_TYPE(p_left_operand) && HAS_BUILTIN_TYPE(p_right_operand)) {
  517. if (p_target.mode == Address::TEMPORARY) {
  518. Variant::Type result_type = Variant::get_operator_return_type(p_operator, p_left_operand.type.builtin_type, p_right_operand.type.builtin_type);
  519. Variant::Type temp_type = temporaries[p_target.address].type;
  520. if (result_type != temp_type) {
  521. write_type_adjust(p_target, result_type);
  522. }
  523. }
  524. // Gather specific operator.
  525. Variant::ValidatedOperatorEvaluator op_func = Variant::get_validated_operator_evaluator(p_operator, p_left_operand.type.builtin_type, p_right_operand.type.builtin_type);
  526. append(GDScriptFunction::OPCODE_OPERATOR_VALIDATED, 3);
  527. append(p_left_operand);
  528. append(p_right_operand);
  529. append(p_target);
  530. append(op_func);
  531. return;
  532. }
  533. // No specific types, perform variant evaluation.
  534. append(GDScriptFunction::OPCODE_OPERATOR, 3);
  535. append(p_left_operand);
  536. append(p_right_operand);
  537. append(p_target);
  538. append(p_operator);
  539. }
  540. void GDScriptByteCodeGenerator::write_type_test(const Address &p_target, const Address &p_source, const Address &p_type) {
  541. append(GDScriptFunction::OPCODE_EXTENDS_TEST, 3);
  542. append(p_source);
  543. append(p_type);
  544. append(p_target);
  545. }
  546. void GDScriptByteCodeGenerator::write_type_test_builtin(const Address &p_target, const Address &p_source, Variant::Type p_type) {
  547. append(GDScriptFunction::OPCODE_IS_BUILTIN, 2);
  548. append(p_source);
  549. append(p_target);
  550. append(p_type);
  551. }
  552. void GDScriptByteCodeGenerator::write_and_left_operand(const Address &p_left_operand) {
  553. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  554. append(p_left_operand);
  555. logic_op_jump_pos1.push_back(opcodes.size());
  556. append(0); // Jump target, will be patched.
  557. }
  558. void GDScriptByteCodeGenerator::write_and_right_operand(const Address &p_right_operand) {
  559. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  560. append(p_right_operand);
  561. logic_op_jump_pos2.push_back(opcodes.size());
  562. append(0); // Jump target, will be patched.
  563. }
  564. void GDScriptByteCodeGenerator::write_end_and(const Address &p_target) {
  565. // If here means both operands are true.
  566. append(GDScriptFunction::OPCODE_ASSIGN_TRUE, 1);
  567. append(p_target);
  568. // Jump away from the fail condition.
  569. append(GDScriptFunction::OPCODE_JUMP, 0);
  570. append(opcodes.size() + 3);
  571. // Here it means one of operands is false.
  572. patch_jump(logic_op_jump_pos1.back()->get());
  573. patch_jump(logic_op_jump_pos2.back()->get());
  574. logic_op_jump_pos1.pop_back();
  575. logic_op_jump_pos2.pop_back();
  576. append(GDScriptFunction::OPCODE_ASSIGN_FALSE, 1);
  577. append(p_target);
  578. }
  579. void GDScriptByteCodeGenerator::write_or_left_operand(const Address &p_left_operand) {
  580. append(GDScriptFunction::OPCODE_JUMP_IF, 1);
  581. append(p_left_operand);
  582. logic_op_jump_pos1.push_back(opcodes.size());
  583. append(0); // Jump target, will be patched.
  584. }
  585. void GDScriptByteCodeGenerator::write_or_right_operand(const Address &p_right_operand) {
  586. append(GDScriptFunction::OPCODE_JUMP_IF, 1);
  587. append(p_right_operand);
  588. logic_op_jump_pos2.push_back(opcodes.size());
  589. append(0); // Jump target, will be patched.
  590. }
  591. void GDScriptByteCodeGenerator::write_end_or(const Address &p_target) {
  592. // If here means both operands are false.
  593. append(GDScriptFunction::OPCODE_ASSIGN_FALSE, 1);
  594. append(p_target);
  595. // Jump away from the success condition.
  596. append(GDScriptFunction::OPCODE_JUMP, 0);
  597. append(opcodes.size() + 3);
  598. // Here it means one of operands is true.
  599. patch_jump(logic_op_jump_pos1.back()->get());
  600. patch_jump(logic_op_jump_pos2.back()->get());
  601. logic_op_jump_pos1.pop_back();
  602. logic_op_jump_pos2.pop_back();
  603. append(GDScriptFunction::OPCODE_ASSIGN_TRUE, 1);
  604. append(p_target);
  605. }
  606. void GDScriptByteCodeGenerator::write_start_ternary(const Address &p_target) {
  607. ternary_result.push_back(p_target);
  608. }
  609. void GDScriptByteCodeGenerator::write_ternary_condition(const Address &p_condition) {
  610. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  611. append(p_condition);
  612. ternary_jump_fail_pos.push_back(opcodes.size());
  613. append(0); // Jump target, will be patched.
  614. }
  615. void GDScriptByteCodeGenerator::write_ternary_true_expr(const Address &p_expr) {
  616. append(GDScriptFunction::OPCODE_ASSIGN, 2);
  617. append(ternary_result.back()->get());
  618. append(p_expr);
  619. // Jump away from the false path.
  620. append(GDScriptFunction::OPCODE_JUMP, 0);
  621. ternary_jump_skip_pos.push_back(opcodes.size());
  622. append(0);
  623. // Fail must jump here.
  624. patch_jump(ternary_jump_fail_pos.back()->get());
  625. ternary_jump_fail_pos.pop_back();
  626. }
  627. void GDScriptByteCodeGenerator::write_ternary_false_expr(const Address &p_expr) {
  628. append(GDScriptFunction::OPCODE_ASSIGN, 2);
  629. append(ternary_result.back()->get());
  630. append(p_expr);
  631. }
  632. void GDScriptByteCodeGenerator::write_end_ternary() {
  633. patch_jump(ternary_jump_skip_pos.back()->get());
  634. ternary_jump_skip_pos.pop_back();
  635. ternary_result.pop_back();
  636. }
  637. void GDScriptByteCodeGenerator::write_set(const Address &p_target, const Address &p_index, const Address &p_source) {
  638. if (HAS_BUILTIN_TYPE(p_target)) {
  639. if (IS_BUILTIN_TYPE(p_index, Variant::INT) && Variant::get_member_validated_indexed_setter(p_target.type.builtin_type) &&
  640. IS_BUILTIN_TYPE(p_source, Variant::get_indexed_element_type(p_target.type.builtin_type))) {
  641. // Use indexed setter instead.
  642. Variant::ValidatedIndexedSetter setter = Variant::get_member_validated_indexed_setter(p_target.type.builtin_type);
  643. append(GDScriptFunction::OPCODE_SET_INDEXED_VALIDATED, 3);
  644. append(p_target);
  645. append(p_index);
  646. append(p_source);
  647. append(setter);
  648. return;
  649. } else if (Variant::get_member_validated_keyed_setter(p_target.type.builtin_type)) {
  650. Variant::ValidatedKeyedSetter setter = Variant::get_member_validated_keyed_setter(p_target.type.builtin_type);
  651. append(GDScriptFunction::OPCODE_SET_KEYED_VALIDATED, 3);
  652. append(p_target);
  653. append(p_index);
  654. append(p_source);
  655. append(setter);
  656. return;
  657. }
  658. }
  659. append(GDScriptFunction::OPCODE_SET_KEYED, 3);
  660. append(p_target);
  661. append(p_index);
  662. append(p_source);
  663. }
  664. void GDScriptByteCodeGenerator::write_get(const Address &p_target, const Address &p_index, const Address &p_source) {
  665. if (HAS_BUILTIN_TYPE(p_source)) {
  666. if (IS_BUILTIN_TYPE(p_index, Variant::INT) && Variant::get_member_validated_indexed_getter(p_source.type.builtin_type)) {
  667. // Use indexed getter instead.
  668. Variant::ValidatedIndexedGetter getter = Variant::get_member_validated_indexed_getter(p_source.type.builtin_type);
  669. append(GDScriptFunction::OPCODE_GET_INDEXED_VALIDATED, 3);
  670. append(p_source);
  671. append(p_index);
  672. append(p_target);
  673. append(getter);
  674. return;
  675. } else if (Variant::get_member_validated_keyed_getter(p_source.type.builtin_type)) {
  676. Variant::ValidatedKeyedGetter getter = Variant::get_member_validated_keyed_getter(p_source.type.builtin_type);
  677. append(GDScriptFunction::OPCODE_GET_KEYED_VALIDATED, 3);
  678. append(p_source);
  679. append(p_index);
  680. append(p_target);
  681. append(getter);
  682. return;
  683. }
  684. }
  685. append(GDScriptFunction::OPCODE_GET_KEYED, 3);
  686. append(p_source);
  687. append(p_index);
  688. append(p_target);
  689. }
  690. void GDScriptByteCodeGenerator::write_set_named(const Address &p_target, const StringName &p_name, const Address &p_source) {
  691. if (HAS_BUILTIN_TYPE(p_target) && Variant::get_member_validated_setter(p_target.type.builtin_type, p_name) &&
  692. IS_BUILTIN_TYPE(p_source, Variant::get_member_type(p_target.type.builtin_type, p_name))) {
  693. Variant::ValidatedSetter setter = Variant::get_member_validated_setter(p_target.type.builtin_type, p_name);
  694. append(GDScriptFunction::OPCODE_SET_NAMED_VALIDATED, 2);
  695. append(p_target);
  696. append(p_source);
  697. append(setter);
  698. return;
  699. }
  700. append(GDScriptFunction::OPCODE_SET_NAMED, 2);
  701. append(p_target);
  702. append(p_source);
  703. append(p_name);
  704. }
  705. void GDScriptByteCodeGenerator::write_get_named(const Address &p_target, const StringName &p_name, const Address &p_source) {
  706. if (HAS_BUILTIN_TYPE(p_source) && Variant::get_member_validated_getter(p_source.type.builtin_type, p_name)) {
  707. Variant::ValidatedGetter getter = Variant::get_member_validated_getter(p_source.type.builtin_type, p_name);
  708. append(GDScriptFunction::OPCODE_GET_NAMED_VALIDATED, 2);
  709. append(p_source);
  710. append(p_target);
  711. append(getter);
  712. return;
  713. }
  714. append(GDScriptFunction::OPCODE_GET_NAMED, 2);
  715. append(p_source);
  716. append(p_target);
  717. append(p_name);
  718. }
  719. void GDScriptByteCodeGenerator::write_set_member(const Address &p_value, const StringName &p_name) {
  720. append(GDScriptFunction::OPCODE_SET_MEMBER, 1);
  721. append(p_value);
  722. append(p_name);
  723. }
  724. void GDScriptByteCodeGenerator::write_get_member(const Address &p_target, const StringName &p_name) {
  725. append(GDScriptFunction::OPCODE_GET_MEMBER, 1);
  726. append(p_target);
  727. append(p_name);
  728. }
  729. void GDScriptByteCodeGenerator::write_assign_with_conversion(const Address &p_target, const Address &p_source) {
  730. switch (p_target.type.kind) {
  731. case GDScriptDataType::BUILTIN: {
  732. if (p_target.type.builtin_type == Variant::ARRAY && p_target.type.has_container_element_type()) {
  733. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_ARRAY, 2);
  734. append(p_target);
  735. append(p_source);
  736. } else {
  737. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_BUILTIN, 2);
  738. append(p_target);
  739. append(p_source);
  740. append(p_target.type.builtin_type);
  741. }
  742. } break;
  743. case GDScriptDataType::NATIVE: {
  744. int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[p_target.type.native_type];
  745. Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
  746. class_idx = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  747. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_NATIVE, 3);
  748. append(p_target);
  749. append(p_source);
  750. append(class_idx);
  751. } break;
  752. case GDScriptDataType::SCRIPT:
  753. case GDScriptDataType::GDSCRIPT: {
  754. Variant script = p_target.type.script_type;
  755. int idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  756. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_SCRIPT, 3);
  757. append(p_target);
  758. append(p_source);
  759. append(idx);
  760. } break;
  761. default: {
  762. ERR_PRINT("Compiler bug: unresolved assign.");
  763. // Shouldn't get here, but fail-safe to a regular assignment
  764. append(GDScriptFunction::OPCODE_ASSIGN, 2);
  765. append(p_target);
  766. append(p_source);
  767. }
  768. }
  769. }
  770. void GDScriptByteCodeGenerator::write_assign(const Address &p_target, const Address &p_source) {
  771. if (p_target.type.kind == GDScriptDataType::BUILTIN && p_target.type.builtin_type == Variant::ARRAY && p_target.type.has_container_element_type()) {
  772. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_ARRAY, 2);
  773. append(p_target);
  774. append(p_source);
  775. } else if (p_target.type.kind == GDScriptDataType::BUILTIN && p_source.type.kind == GDScriptDataType::BUILTIN && p_target.type.builtin_type != p_source.type.builtin_type) {
  776. // Need conversion.
  777. append(GDScriptFunction::OPCODE_ASSIGN_TYPED_BUILTIN, 2);
  778. append(p_target);
  779. append(p_source);
  780. append(p_target.type.builtin_type);
  781. } else {
  782. append(GDScriptFunction::OPCODE_ASSIGN, 2);
  783. append(p_target);
  784. append(p_source);
  785. }
  786. }
  787. void GDScriptByteCodeGenerator::write_assign_true(const Address &p_target) {
  788. append(GDScriptFunction::OPCODE_ASSIGN_TRUE, 1);
  789. append(p_target);
  790. }
  791. void GDScriptByteCodeGenerator::write_assign_false(const Address &p_target) {
  792. append(GDScriptFunction::OPCODE_ASSIGN_FALSE, 1);
  793. append(p_target);
  794. }
  795. void GDScriptByteCodeGenerator::write_assign_default_parameter(const Address &p_dst, const Address &p_src) {
  796. write_assign(p_dst, p_src);
  797. function->default_arguments.push_back(opcodes.size());
  798. }
  799. void GDScriptByteCodeGenerator::write_store_global(const Address &p_dst, int p_global_index) {
  800. append(GDScriptFunction::OPCODE_STORE_GLOBAL, 1);
  801. append(p_dst);
  802. append(p_global_index);
  803. }
  804. void GDScriptByteCodeGenerator::write_store_named_global(const Address &p_dst, const StringName &p_global) {
  805. append(GDScriptFunction::OPCODE_STORE_NAMED_GLOBAL, 1);
  806. append(p_dst);
  807. append(p_global);
  808. }
  809. void GDScriptByteCodeGenerator::write_cast(const Address &p_target, const Address &p_source, const GDScriptDataType &p_type) {
  810. int index = 0;
  811. switch (p_type.kind) {
  812. case GDScriptDataType::BUILTIN: {
  813. append(GDScriptFunction::OPCODE_CAST_TO_BUILTIN, 2);
  814. index = p_type.builtin_type;
  815. } break;
  816. case GDScriptDataType::NATIVE: {
  817. int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[p_type.native_type];
  818. Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
  819. append(GDScriptFunction::OPCODE_CAST_TO_NATIVE, 3);
  820. index = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  821. } break;
  822. case GDScriptDataType::SCRIPT:
  823. case GDScriptDataType::GDSCRIPT: {
  824. Variant script = p_type.script_type;
  825. int idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  826. append(GDScriptFunction::OPCODE_CAST_TO_SCRIPT, 3);
  827. index = idx;
  828. } break;
  829. default: {
  830. return;
  831. }
  832. }
  833. append(p_source);
  834. append(p_target);
  835. append(index);
  836. }
  837. void GDScriptByteCodeGenerator::write_call(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  838. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
  839. for (int i = 0; i < p_arguments.size(); i++) {
  840. append(p_arguments[i]);
  841. }
  842. append(p_base);
  843. append(p_target);
  844. append(p_arguments.size());
  845. append(p_function_name);
  846. }
  847. void GDScriptByteCodeGenerator::write_super_call(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  848. append(GDScriptFunction::OPCODE_CALL_SELF_BASE, 1 + p_arguments.size());
  849. for (int i = 0; i < p_arguments.size(); i++) {
  850. append(p_arguments[i]);
  851. }
  852. append(p_target);
  853. append(p_arguments.size());
  854. append(p_function_name);
  855. }
  856. void GDScriptByteCodeGenerator::write_call_async(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  857. append(GDScriptFunction::OPCODE_CALL_ASYNC, 2 + p_arguments.size());
  858. for (int i = 0; i < p_arguments.size(); i++) {
  859. append(p_arguments[i]);
  860. }
  861. append(p_base);
  862. append(p_target);
  863. append(p_arguments.size());
  864. append(p_function_name);
  865. }
  866. void GDScriptByteCodeGenerator::write_call_gdscript_utility(const Address &p_target, GDScriptUtilityFunctions::FunctionPtr p_function, const Vector<Address> &p_arguments) {
  867. append(GDScriptFunction::OPCODE_CALL_GDSCRIPT_UTILITY, 1 + p_arguments.size());
  868. for (int i = 0; i < p_arguments.size(); i++) {
  869. append(p_arguments[i]);
  870. }
  871. append(p_target);
  872. append(p_arguments.size());
  873. append(p_function);
  874. }
  875. void GDScriptByteCodeGenerator::write_call_utility(const Address &p_target, const StringName &p_function, const Vector<Address> &p_arguments) {
  876. bool is_validated = true;
  877. if (Variant::is_utility_function_vararg(p_function)) {
  878. is_validated = true; // Vararg works fine with any argument, since they can be any type.
  879. } else if (p_arguments.size() == Variant::get_utility_function_argument_count(p_function)) {
  880. bool all_types_exact = true;
  881. for (int i = 0; i < p_arguments.size(); i++) {
  882. if (!IS_BUILTIN_TYPE(p_arguments[i], Variant::get_utility_function_argument_type(p_function, i))) {
  883. all_types_exact = false;
  884. break;
  885. }
  886. }
  887. is_validated = all_types_exact;
  888. }
  889. if (is_validated) {
  890. append(GDScriptFunction::OPCODE_CALL_UTILITY_VALIDATED, 1 + p_arguments.size());
  891. for (int i = 0; i < p_arguments.size(); i++) {
  892. append(p_arguments[i]);
  893. }
  894. append(p_target);
  895. append(p_arguments.size());
  896. append(Variant::get_validated_utility_function(p_function));
  897. } else {
  898. append(GDScriptFunction::OPCODE_CALL_UTILITY, 1 + p_arguments.size());
  899. for (int i = 0; i < p_arguments.size(); i++) {
  900. append(p_arguments[i]);
  901. }
  902. append(p_target);
  903. append(p_arguments.size());
  904. append(p_function);
  905. }
  906. }
  907. 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) {
  908. bool is_validated = false;
  909. // Check if all types are correct.
  910. if (Variant::is_builtin_method_vararg(p_type, p_method)) {
  911. is_validated = true; // Vararg works fine with any argument, since they can be any type.
  912. } else if (p_arguments.size() == Variant::get_builtin_method_argument_count(p_type, p_method)) {
  913. bool all_types_exact = true;
  914. for (int i = 0; i < p_arguments.size(); i++) {
  915. if (!IS_BUILTIN_TYPE(p_arguments[i], Variant::get_builtin_method_argument_type(p_type, p_method, i))) {
  916. all_types_exact = false;
  917. break;
  918. }
  919. }
  920. is_validated = all_types_exact;
  921. }
  922. if (!is_validated) {
  923. // Perform regular call.
  924. write_call(p_target, p_base, p_method, p_arguments);
  925. return;
  926. }
  927. if (p_target.mode == Address::TEMPORARY) {
  928. Variant::Type result_type = Variant::get_builtin_method_return_type(p_type, p_method);
  929. Variant::Type temp_type = temporaries[p_target.address].type;
  930. if (result_type != temp_type) {
  931. write_type_adjust(p_target, result_type);
  932. }
  933. }
  934. append(GDScriptFunction::OPCODE_CALL_BUILTIN_TYPE_VALIDATED, 2 + p_arguments.size());
  935. for (int i = 0; i < p_arguments.size(); i++) {
  936. append(p_arguments[i]);
  937. }
  938. append(p_base);
  939. append(p_target);
  940. append(p_arguments.size());
  941. append(Variant::get_validated_builtin_method(p_type, p_method));
  942. }
  943. void GDScriptByteCodeGenerator::write_call_builtin_type_static(const Address &p_target, Variant::Type p_type, const StringName &p_method, const Vector<Address> &p_arguments) {
  944. bool is_validated = false;
  945. // Check if all types are correct.
  946. if (Variant::is_builtin_method_vararg(p_type, p_method)) {
  947. is_validated = true; // Vararg works fine with any argument, since they can be any type.
  948. } else if (p_arguments.size() == Variant::get_builtin_method_argument_count(p_type, p_method)) {
  949. bool all_types_exact = true;
  950. for (int i = 0; i < p_arguments.size(); i++) {
  951. if (!IS_BUILTIN_TYPE(p_arguments[i], Variant::get_builtin_method_argument_type(p_type, p_method, i))) {
  952. all_types_exact = false;
  953. break;
  954. }
  955. }
  956. is_validated = all_types_exact;
  957. }
  958. if (!is_validated) {
  959. // Perform regular call.
  960. append(GDScriptFunction::OPCODE_CALL_BUILTIN_STATIC, p_arguments.size() + 1);
  961. for (int i = 0; i < p_arguments.size(); i++) {
  962. append(p_arguments[i]);
  963. }
  964. append(p_target);
  965. append(p_type);
  966. append(p_method);
  967. append(p_arguments.size());
  968. return;
  969. }
  970. if (p_target.mode == Address::TEMPORARY) {
  971. Variant::Type result_type = Variant::get_builtin_method_return_type(p_type, p_method);
  972. Variant::Type temp_type = temporaries[p_target.address].type;
  973. if (result_type != temp_type) {
  974. write_type_adjust(p_target, result_type);
  975. }
  976. }
  977. append(GDScriptFunction::OPCODE_CALL_BUILTIN_TYPE_VALIDATED, 2 + p_arguments.size());
  978. for (int i = 0; i < p_arguments.size(); i++) {
  979. append(p_arguments[i]);
  980. }
  981. append(Address()); // No base since it's static.
  982. append(p_target);
  983. append(p_arguments.size());
  984. append(Variant::get_validated_builtin_method(p_type, p_method));
  985. }
  986. void GDScriptByteCodeGenerator::write_call_native_static(const Address &p_target, const StringName &p_class, const StringName &p_method, const Vector<Address> &p_arguments) {
  987. bool is_validated = false;
  988. MethodBind *method = ClassDB::get_method(p_class, p_method);
  989. if (!is_validated) {
  990. // Perform regular call.
  991. append(GDScriptFunction::OPCODE_CALL_NATIVE_STATIC, p_arguments.size() + 1);
  992. for (int i = 0; i < p_arguments.size(); i++) {
  993. append(p_arguments[i]);
  994. }
  995. append(p_target);
  996. append(method);
  997. append(p_arguments.size());
  998. return;
  999. }
  1000. }
  1001. void GDScriptByteCodeGenerator::write_call_method_bind(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) {
  1002. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL_METHOD_BIND : GDScriptFunction::OPCODE_CALL_METHOD_BIND_RET, 2 + p_arguments.size());
  1003. for (int i = 0; i < p_arguments.size(); i++) {
  1004. append(p_arguments[i]);
  1005. }
  1006. append(p_base);
  1007. append(p_target);
  1008. append(p_arguments.size());
  1009. append(p_method);
  1010. }
  1011. void GDScriptByteCodeGenerator::write_call_ptrcall(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) {
  1012. #define CASE_TYPE(m_type) \
  1013. case Variant::m_type: \
  1014. append(GDScriptFunction::OPCODE_CALL_PTRCALL_##m_type, 2 + p_arguments.size()); \
  1015. break
  1016. bool is_ptrcall = true;
  1017. if (p_method->has_return()) {
  1018. MethodInfo info;
  1019. ClassDB::get_method_info(p_method->get_instance_class(), p_method->get_name(), &info);
  1020. switch (info.return_val.type) {
  1021. CASE_TYPE(BOOL);
  1022. CASE_TYPE(INT);
  1023. CASE_TYPE(FLOAT);
  1024. CASE_TYPE(STRING);
  1025. CASE_TYPE(VECTOR2);
  1026. CASE_TYPE(VECTOR2I);
  1027. CASE_TYPE(RECT2);
  1028. CASE_TYPE(RECT2I);
  1029. CASE_TYPE(VECTOR3);
  1030. CASE_TYPE(VECTOR3I);
  1031. CASE_TYPE(TRANSFORM2D);
  1032. CASE_TYPE(PLANE);
  1033. CASE_TYPE(AABB);
  1034. CASE_TYPE(BASIS);
  1035. CASE_TYPE(TRANSFORM3D);
  1036. CASE_TYPE(COLOR);
  1037. CASE_TYPE(STRING_NAME);
  1038. CASE_TYPE(NODE_PATH);
  1039. CASE_TYPE(RID);
  1040. CASE_TYPE(QUATERNION);
  1041. CASE_TYPE(OBJECT);
  1042. CASE_TYPE(CALLABLE);
  1043. CASE_TYPE(SIGNAL);
  1044. CASE_TYPE(DICTIONARY);
  1045. CASE_TYPE(ARRAY);
  1046. CASE_TYPE(PACKED_BYTE_ARRAY);
  1047. CASE_TYPE(PACKED_INT32_ARRAY);
  1048. CASE_TYPE(PACKED_INT64_ARRAY);
  1049. CASE_TYPE(PACKED_FLOAT32_ARRAY);
  1050. CASE_TYPE(PACKED_FLOAT64_ARRAY);
  1051. CASE_TYPE(PACKED_STRING_ARRAY);
  1052. CASE_TYPE(PACKED_VECTOR2_ARRAY);
  1053. CASE_TYPE(PACKED_VECTOR3_ARRAY);
  1054. CASE_TYPE(PACKED_COLOR_ARRAY);
  1055. default:
  1056. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL_METHOD_BIND : GDScriptFunction::OPCODE_CALL_METHOD_BIND_RET, 2 + p_arguments.size());
  1057. is_ptrcall = false;
  1058. break;
  1059. }
  1060. } else {
  1061. append(GDScriptFunction::OPCODE_CALL_PTRCALL_NO_RETURN, 2 + p_arguments.size());
  1062. }
  1063. for (int i = 0; i < p_arguments.size(); i++) {
  1064. append(p_arguments[i]);
  1065. }
  1066. append(p_base);
  1067. append(p_target);
  1068. append(p_arguments.size());
  1069. append(p_method);
  1070. if (is_ptrcall) {
  1071. alloc_ptrcall(p_arguments.size());
  1072. }
  1073. #undef CASE_TYPE
  1074. }
  1075. void GDScriptByteCodeGenerator::write_call_self(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  1076. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
  1077. for (int i = 0; i < p_arguments.size(); i++) {
  1078. append(p_arguments[i]);
  1079. }
  1080. append(GDScriptFunction::ADDR_TYPE_STACK << GDScriptFunction::ADDR_BITS);
  1081. append(p_target);
  1082. append(p_arguments.size());
  1083. append(p_function_name);
  1084. }
  1085. void GDScriptByteCodeGenerator::write_call_self_async(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  1086. append(GDScriptFunction::OPCODE_CALL_ASYNC, 2 + p_arguments.size());
  1087. for (int i = 0; i < p_arguments.size(); i++) {
  1088. append(p_arguments[i]);
  1089. }
  1090. append(GDScriptFunction::ADDR_SELF);
  1091. append(p_target);
  1092. append(p_arguments.size());
  1093. append(p_function_name);
  1094. }
  1095. void GDScriptByteCodeGenerator::write_call_script_function(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
  1096. append(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
  1097. for (int i = 0; i < p_arguments.size(); i++) {
  1098. append(p_arguments[i]);
  1099. }
  1100. append(p_base);
  1101. append(p_target);
  1102. append(p_arguments.size());
  1103. append(p_function_name);
  1104. }
  1105. void GDScriptByteCodeGenerator::write_lambda(const Address &p_target, GDScriptFunction *p_function, const Vector<Address> &p_captures, bool p_use_self) {
  1106. append(p_use_self ? GDScriptFunction::OPCODE_CREATE_SELF_LAMBDA : GDScriptFunction::OPCODE_CREATE_LAMBDA, 1 + p_captures.size());
  1107. for (int i = 0; i < p_captures.size(); i++) {
  1108. append(p_captures[i]);
  1109. }
  1110. append(p_target);
  1111. append(p_captures.size());
  1112. append(p_function);
  1113. }
  1114. void GDScriptByteCodeGenerator::write_construct(const Address &p_target, Variant::Type p_type, const Vector<Address> &p_arguments) {
  1115. // Try to find an appropriate constructor.
  1116. bool all_have_type = true;
  1117. Vector<Variant::Type> arg_types;
  1118. for (int i = 0; i < p_arguments.size(); i++) {
  1119. if (!HAS_BUILTIN_TYPE(p_arguments[i])) {
  1120. all_have_type = false;
  1121. break;
  1122. }
  1123. arg_types.push_back(p_arguments[i].type.builtin_type);
  1124. }
  1125. if (all_have_type) {
  1126. int valid_constructor = -1;
  1127. for (int i = 0; i < Variant::get_constructor_count(p_type); i++) {
  1128. if (Variant::get_constructor_argument_count(p_type, i) != p_arguments.size()) {
  1129. continue;
  1130. }
  1131. int types_correct = true;
  1132. for (int j = 0; j < arg_types.size(); j++) {
  1133. if (arg_types[j] != Variant::get_constructor_argument_type(p_type, i, j)) {
  1134. types_correct = false;
  1135. break;
  1136. }
  1137. }
  1138. if (types_correct) {
  1139. valid_constructor = i;
  1140. break;
  1141. }
  1142. }
  1143. if (valid_constructor >= 0) {
  1144. append(GDScriptFunction::OPCODE_CONSTRUCT_VALIDATED, 1 + p_arguments.size());
  1145. for (int i = 0; i < p_arguments.size(); i++) {
  1146. append(p_arguments[i]);
  1147. }
  1148. append(p_target);
  1149. append(p_arguments.size());
  1150. append(Variant::get_validated_constructor(p_type, valid_constructor));
  1151. return;
  1152. }
  1153. }
  1154. append(GDScriptFunction::OPCODE_CONSTRUCT, 1 + p_arguments.size());
  1155. for (int i = 0; i < p_arguments.size(); i++) {
  1156. append(p_arguments[i]);
  1157. }
  1158. append(p_target);
  1159. append(p_arguments.size());
  1160. append(p_type);
  1161. }
  1162. void GDScriptByteCodeGenerator::write_construct_array(const Address &p_target, const Vector<Address> &p_arguments) {
  1163. append(GDScriptFunction::OPCODE_CONSTRUCT_ARRAY, 1 + p_arguments.size());
  1164. for (int i = 0; i < p_arguments.size(); i++) {
  1165. append(p_arguments[i]);
  1166. }
  1167. append(p_target);
  1168. append(p_arguments.size());
  1169. }
  1170. void GDScriptByteCodeGenerator::write_construct_typed_array(const Address &p_target, const GDScriptDataType &p_element_type, const Vector<Address> &p_arguments) {
  1171. append(GDScriptFunction::OPCODE_CONSTRUCT_TYPED_ARRAY, 2 + p_arguments.size());
  1172. for (int i = 0; i < p_arguments.size(); i++) {
  1173. append(p_arguments[i]);
  1174. }
  1175. append(p_target);
  1176. if (p_element_type.script_type) {
  1177. Variant script_type = Ref<Script>(p_element_type.script_type);
  1178. int addr = get_constant_pos(script_type);
  1179. addr |= GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS;
  1180. append(addr);
  1181. } else {
  1182. append(Address()); // null.
  1183. }
  1184. append(p_arguments.size());
  1185. append(p_element_type.builtin_type);
  1186. append(p_element_type.native_type);
  1187. }
  1188. void GDScriptByteCodeGenerator::write_construct_dictionary(const Address &p_target, const Vector<Address> &p_arguments) {
  1189. append(GDScriptFunction::OPCODE_CONSTRUCT_DICTIONARY, 1 + p_arguments.size());
  1190. for (int i = 0; i < p_arguments.size(); i++) {
  1191. append(p_arguments[i]);
  1192. }
  1193. append(p_target);
  1194. append(p_arguments.size() / 2); // This is number of key-value pairs, so only half of actual arguments.
  1195. }
  1196. void GDScriptByteCodeGenerator::write_await(const Address &p_target, const Address &p_operand) {
  1197. append(GDScriptFunction::OPCODE_AWAIT, 1);
  1198. append(p_operand);
  1199. append(GDScriptFunction::OPCODE_AWAIT_RESUME, 1);
  1200. append(p_target);
  1201. }
  1202. void GDScriptByteCodeGenerator::write_if(const Address &p_condition) {
  1203. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  1204. append(p_condition);
  1205. if_jmp_addrs.push_back(opcodes.size());
  1206. append(0); // Jump destination, will be patched.
  1207. }
  1208. void GDScriptByteCodeGenerator::write_else() {
  1209. append(GDScriptFunction::OPCODE_JUMP, 0); // Jump from true if block;
  1210. int else_jmp_addr = opcodes.size();
  1211. append(0); // Jump destination, will be patched.
  1212. patch_jump(if_jmp_addrs.back()->get());
  1213. if_jmp_addrs.pop_back();
  1214. if_jmp_addrs.push_back(else_jmp_addr);
  1215. }
  1216. void GDScriptByteCodeGenerator::write_endif() {
  1217. patch_jump(if_jmp_addrs.back()->get());
  1218. if_jmp_addrs.pop_back();
  1219. }
  1220. void GDScriptByteCodeGenerator::write_jump_if_shared(const Address &p_value) {
  1221. append(GDScriptFunction::OPCODE_JUMP_IF_SHARED, 1);
  1222. append(p_value);
  1223. if_jmp_addrs.push_back(opcodes.size());
  1224. append(0); // Jump destination, will be patched.
  1225. }
  1226. void GDScriptByteCodeGenerator::write_end_jump_if_shared() {
  1227. patch_jump(if_jmp_addrs.back()->get());
  1228. if_jmp_addrs.pop_back();
  1229. }
  1230. void GDScriptByteCodeGenerator::start_for(const GDScriptDataType &p_iterator_type, const GDScriptDataType &p_list_type) {
  1231. Address counter(Address::LOCAL_VARIABLE, add_local("@counter_pos", p_iterator_type), p_iterator_type);
  1232. Address container(Address::LOCAL_VARIABLE, add_local("@container_pos", p_list_type), p_list_type);
  1233. // Store state.
  1234. for_counter_variables.push_back(counter);
  1235. for_container_variables.push_back(container);
  1236. }
  1237. void GDScriptByteCodeGenerator::write_for_assignment(const Address &p_variable, const Address &p_list) {
  1238. const Address &container = for_container_variables.back()->get();
  1239. // Assign container.
  1240. append(GDScriptFunction::OPCODE_ASSIGN, 2);
  1241. append(container);
  1242. append(p_list);
  1243. for_iterator_variables.push_back(p_variable);
  1244. }
  1245. void GDScriptByteCodeGenerator::write_for() {
  1246. const Address &iterator = for_iterator_variables.back()->get();
  1247. const Address &counter = for_counter_variables.back()->get();
  1248. const Address &container = for_container_variables.back()->get();
  1249. current_breaks_to_patch.push_back(List<int>());
  1250. GDScriptFunction::Opcode begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN;
  1251. GDScriptFunction::Opcode iterate_opcode = GDScriptFunction::OPCODE_ITERATE;
  1252. if (container.type.has_type) {
  1253. if (container.type.kind == GDScriptDataType::BUILTIN) {
  1254. switch (container.type.builtin_type) {
  1255. case Variant::INT:
  1256. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_INT;
  1257. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_INT;
  1258. break;
  1259. case Variant::FLOAT:
  1260. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_FLOAT;
  1261. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_FLOAT;
  1262. break;
  1263. case Variant::VECTOR2:
  1264. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR2;
  1265. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR2;
  1266. break;
  1267. case Variant::VECTOR2I:
  1268. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR2I;
  1269. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR2I;
  1270. break;
  1271. case Variant::VECTOR3:
  1272. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR3;
  1273. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR3;
  1274. break;
  1275. case Variant::VECTOR3I:
  1276. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR3I;
  1277. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR3I;
  1278. break;
  1279. case Variant::STRING:
  1280. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_STRING;
  1281. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_STRING;
  1282. break;
  1283. case Variant::DICTIONARY:
  1284. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_DICTIONARY;
  1285. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_DICTIONARY;
  1286. break;
  1287. case Variant::ARRAY:
  1288. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_ARRAY;
  1289. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_ARRAY;
  1290. break;
  1291. case Variant::PACKED_BYTE_ARRAY:
  1292. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_BYTE_ARRAY;
  1293. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_BYTE_ARRAY;
  1294. break;
  1295. case Variant::PACKED_INT32_ARRAY:
  1296. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_INT32_ARRAY;
  1297. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_INT32_ARRAY;
  1298. break;
  1299. case Variant::PACKED_INT64_ARRAY:
  1300. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_INT64_ARRAY;
  1301. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_INT64_ARRAY;
  1302. break;
  1303. case Variant::PACKED_FLOAT32_ARRAY:
  1304. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_FLOAT32_ARRAY;
  1305. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_FLOAT32_ARRAY;
  1306. break;
  1307. case Variant::PACKED_FLOAT64_ARRAY:
  1308. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_FLOAT64_ARRAY;
  1309. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_FLOAT64_ARRAY;
  1310. break;
  1311. case Variant::PACKED_STRING_ARRAY:
  1312. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_STRING_ARRAY;
  1313. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_STRING_ARRAY;
  1314. break;
  1315. case Variant::PACKED_VECTOR2_ARRAY:
  1316. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_VECTOR2_ARRAY;
  1317. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_VECTOR2_ARRAY;
  1318. break;
  1319. case Variant::PACKED_VECTOR3_ARRAY:
  1320. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_VECTOR3_ARRAY;
  1321. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_VECTOR3_ARRAY;
  1322. break;
  1323. case Variant::PACKED_COLOR_ARRAY:
  1324. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_COLOR_ARRAY;
  1325. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_COLOR_ARRAY;
  1326. break;
  1327. default:
  1328. break;
  1329. }
  1330. } else {
  1331. begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_OBJECT;
  1332. iterate_opcode = GDScriptFunction::OPCODE_ITERATE_OBJECT;
  1333. }
  1334. }
  1335. // Begin loop.
  1336. append(begin_opcode, 3);
  1337. append(counter);
  1338. append(container);
  1339. append(iterator);
  1340. for_jmp_addrs.push_back(opcodes.size());
  1341. append(0); // End of loop address, will be patched.
  1342. append(GDScriptFunction::OPCODE_JUMP, 0);
  1343. append(opcodes.size() + 6); // Skip over 'continue' code.
  1344. // Next iteration.
  1345. int continue_addr = opcodes.size();
  1346. continue_addrs.push_back(continue_addr);
  1347. append(iterate_opcode, 3);
  1348. append(counter);
  1349. append(container);
  1350. append(iterator);
  1351. for_jmp_addrs.push_back(opcodes.size());
  1352. append(0); // Jump destination, will be patched.
  1353. }
  1354. void GDScriptByteCodeGenerator::write_endfor() {
  1355. // Jump back to loop check.
  1356. append(GDScriptFunction::OPCODE_JUMP, 0);
  1357. append(continue_addrs.back()->get());
  1358. continue_addrs.pop_back();
  1359. // Patch end jumps (two of them).
  1360. for (int i = 0; i < 2; i++) {
  1361. patch_jump(for_jmp_addrs.back()->get());
  1362. for_jmp_addrs.pop_back();
  1363. }
  1364. // Patch break statements.
  1365. for (const int &E : current_breaks_to_patch.back()->get()) {
  1366. patch_jump(E);
  1367. }
  1368. current_breaks_to_patch.pop_back();
  1369. // Pop state.
  1370. for_iterator_variables.pop_back();
  1371. for_counter_variables.pop_back();
  1372. for_container_variables.pop_back();
  1373. }
  1374. void GDScriptByteCodeGenerator::start_while_condition() {
  1375. current_breaks_to_patch.push_back(List<int>());
  1376. continue_addrs.push_back(opcodes.size());
  1377. }
  1378. void GDScriptByteCodeGenerator::write_while(const Address &p_condition) {
  1379. // Condition check.
  1380. append(GDScriptFunction::OPCODE_JUMP_IF_NOT, 1);
  1381. append(p_condition);
  1382. while_jmp_addrs.push_back(opcodes.size());
  1383. append(0); // End of loop address, will be patched.
  1384. }
  1385. void GDScriptByteCodeGenerator::write_endwhile() {
  1386. // Jump back to loop check.
  1387. append(GDScriptFunction::OPCODE_JUMP, 0);
  1388. append(continue_addrs.back()->get());
  1389. continue_addrs.pop_back();
  1390. // Patch end jump.
  1391. patch_jump(while_jmp_addrs.back()->get());
  1392. while_jmp_addrs.pop_back();
  1393. // Patch break statements.
  1394. for (const int &E : current_breaks_to_patch.back()->get()) {
  1395. patch_jump(E);
  1396. }
  1397. current_breaks_to_patch.pop_back();
  1398. }
  1399. void GDScriptByteCodeGenerator::start_match() {
  1400. match_continues_to_patch.push_back(List<int>());
  1401. }
  1402. void GDScriptByteCodeGenerator::start_match_branch() {
  1403. // Patch continue statements.
  1404. for (const int &E : match_continues_to_patch.back()->get()) {
  1405. patch_jump(E);
  1406. }
  1407. match_continues_to_patch.pop_back();
  1408. // Start a new list for next branch.
  1409. match_continues_to_patch.push_back(List<int>());
  1410. }
  1411. void GDScriptByteCodeGenerator::end_match() {
  1412. // Patch continue statements.
  1413. for (const int &E : match_continues_to_patch.back()->get()) {
  1414. patch_jump(E);
  1415. }
  1416. match_continues_to_patch.pop_back();
  1417. }
  1418. void GDScriptByteCodeGenerator::write_break() {
  1419. append(GDScriptFunction::OPCODE_JUMP, 0);
  1420. current_breaks_to_patch.back()->get().push_back(opcodes.size());
  1421. append(0);
  1422. }
  1423. void GDScriptByteCodeGenerator::write_continue() {
  1424. append(GDScriptFunction::OPCODE_JUMP, 0);
  1425. append(continue_addrs.back()->get());
  1426. }
  1427. void GDScriptByteCodeGenerator::write_continue_match() {
  1428. append(GDScriptFunction::OPCODE_JUMP, 0);
  1429. match_continues_to_patch.back()->get().push_back(opcodes.size());
  1430. append(0);
  1431. }
  1432. void GDScriptByteCodeGenerator::write_breakpoint() {
  1433. append(GDScriptFunction::OPCODE_BREAKPOINT, 0);
  1434. }
  1435. void GDScriptByteCodeGenerator::write_newline(int p_line) {
  1436. append(GDScriptFunction::OPCODE_LINE, 0);
  1437. append(p_line);
  1438. current_line = p_line;
  1439. }
  1440. void GDScriptByteCodeGenerator::write_return(const Address &p_return_value) {
  1441. if (!function->return_type.has_type || p_return_value.type.has_type) {
  1442. // Either the function is untyped or the return value is also typed.
  1443. // If this is a typed function, then we need to check for potential conversions.
  1444. if (function->return_type.has_type) {
  1445. if (function->return_type.kind == GDScriptDataType::BUILTIN && function->return_type.builtin_type == Variant::ARRAY && function->return_type.has_container_element_type()) {
  1446. // Typed array.
  1447. const GDScriptDataType &element_type = function->return_type.get_container_element_type();
  1448. Variant script = element_type.script_type;
  1449. int script_idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1450. append(GDScriptFunction::OPCODE_RETURN_TYPED_ARRAY, 2);
  1451. append(p_return_value);
  1452. append(script_idx);
  1453. append(element_type.kind == GDScriptDataType::BUILTIN ? element_type.builtin_type : Variant::OBJECT);
  1454. append(element_type.native_type);
  1455. } 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) {
  1456. // Add conversion.
  1457. append(GDScriptFunction::OPCODE_RETURN_TYPED_BUILTIN, 1);
  1458. append(p_return_value);
  1459. append(function->return_type.builtin_type);
  1460. } else {
  1461. // Just assign.
  1462. append(GDScriptFunction::OPCODE_RETURN, 1);
  1463. append(p_return_value);
  1464. }
  1465. } else {
  1466. append(GDScriptFunction::OPCODE_RETURN, 1);
  1467. append(p_return_value);
  1468. }
  1469. } else {
  1470. switch (function->return_type.kind) {
  1471. case GDScriptDataType::BUILTIN: {
  1472. if (function->return_type.builtin_type == Variant::ARRAY && function->return_type.has_container_element_type()) {
  1473. const GDScriptDataType &element_type = function->return_type.get_container_element_type();
  1474. Variant script = function->return_type.script_type;
  1475. int script_idx = get_constant_pos(script);
  1476. script_idx |= (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1477. append(GDScriptFunction::OPCODE_RETURN_TYPED_ARRAY, 2);
  1478. append(p_return_value);
  1479. append(script_idx);
  1480. append(element_type.kind == GDScriptDataType::BUILTIN ? element_type.builtin_type : Variant::OBJECT);
  1481. append(element_type.native_type);
  1482. } else {
  1483. append(GDScriptFunction::OPCODE_RETURN_TYPED_BUILTIN, 1);
  1484. append(p_return_value);
  1485. append(function->return_type.builtin_type);
  1486. }
  1487. } break;
  1488. case GDScriptDataType::NATIVE: {
  1489. append(GDScriptFunction::OPCODE_RETURN_TYPED_NATIVE, 2);
  1490. append(p_return_value);
  1491. int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[function->return_type.native_type];
  1492. Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
  1493. class_idx = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1494. append(class_idx);
  1495. } break;
  1496. case GDScriptDataType::GDSCRIPT:
  1497. case GDScriptDataType::SCRIPT: {
  1498. Variant script = function->return_type.script_type;
  1499. int script_idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
  1500. append(GDScriptFunction::OPCODE_RETURN_TYPED_SCRIPT, 2);
  1501. append(p_return_value);
  1502. append(script_idx);
  1503. } break;
  1504. default: {
  1505. ERR_PRINT("Compiler bug: unresolved return.");
  1506. // Shouldn't get here, but fail-safe to a regular return;
  1507. append(GDScriptFunction::OPCODE_RETURN, 1);
  1508. append(p_return_value);
  1509. } break;
  1510. }
  1511. }
  1512. }
  1513. void GDScriptByteCodeGenerator::write_assert(const Address &p_test, const Address &p_message) {
  1514. append(GDScriptFunction::OPCODE_ASSERT, 2);
  1515. append(p_test);
  1516. append(p_message);
  1517. }
  1518. void GDScriptByteCodeGenerator::start_block() {
  1519. push_stack_identifiers();
  1520. }
  1521. void GDScriptByteCodeGenerator::end_block() {
  1522. pop_stack_identifiers();
  1523. }
  1524. GDScriptByteCodeGenerator::~GDScriptByteCodeGenerator() {
  1525. if (!ended && function != nullptr) {
  1526. memdelete(function);
  1527. }
  1528. }