gdscript_byte_codegen.cpp 58 KB

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