123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941 |
- /**************************************************************************/
- /* gdscript_byte_codegen.cpp */
- /**************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /**************************************************************************/
- /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
- /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
- /* */
- /* Permission is hereby granted, free of charge, to any person obtaining */
- /* a copy of this software and associated documentation files (the */
- /* "Software"), to deal in the Software without restriction, including */
- /* without limitation the rights to use, copy, modify, merge, publish, */
- /* distribute, sublicense, and/or sell copies of the Software, and to */
- /* permit persons to whom the Software is furnished to do so, subject to */
- /* the following conditions: */
- /* */
- /* The above copyright notice and this permission notice shall be */
- /* included in all copies or substantial portions of the Software. */
- /* */
- /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
- /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
- /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
- /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
- /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
- /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
- /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
- /**************************************************************************/
- #include "gdscript_byte_codegen.h"
- #include "gdscript.h"
- #include "core/debugger/engine_debugger.h"
- uint32_t GDScriptByteCodeGenerator::add_parameter(const StringName &p_name, bool p_is_optional, const GDScriptDataType &p_type) {
- function->_argument_count++;
- function->argument_types.push_back(p_type);
- if (p_is_optional) {
- function->_default_arg_count++;
- }
- return add_local(p_name, p_type);
- }
- uint32_t GDScriptByteCodeGenerator::add_local(const StringName &p_name, const GDScriptDataType &p_type) {
- int stack_pos = locals.size() + GDScriptFunction::FIXED_ADDRESSES_MAX;
- locals.push_back(StackSlot(p_type.builtin_type, p_type.can_contain_object()));
- add_stack_identifier(p_name, stack_pos);
- return stack_pos;
- }
- uint32_t GDScriptByteCodeGenerator::add_local_constant(const StringName &p_name, const Variant &p_constant) {
- int index = add_or_get_constant(p_constant);
- local_constants[p_name] = index;
- return index;
- }
- uint32_t GDScriptByteCodeGenerator::add_or_get_constant(const Variant &p_constant) {
- return get_constant_pos(p_constant);
- }
- uint32_t GDScriptByteCodeGenerator::add_or_get_name(const StringName &p_name) {
- return get_name_map_pos(p_name);
- }
- uint32_t GDScriptByteCodeGenerator::add_temporary(const GDScriptDataType &p_type) {
- Variant::Type temp_type = Variant::NIL;
- if (p_type.has_type && p_type.kind == GDScriptDataType::BUILTIN) {
- switch (p_type.builtin_type) {
- case Variant::NIL:
- case Variant::BOOL:
- case Variant::INT:
- case Variant::FLOAT:
- case Variant::STRING:
- case Variant::VECTOR2:
- case Variant::VECTOR2I:
- case Variant::RECT2:
- case Variant::RECT2I:
- case Variant::VECTOR3:
- case Variant::VECTOR3I:
- case Variant::TRANSFORM2D:
- case Variant::VECTOR4:
- case Variant::VECTOR4I:
- case Variant::PLANE:
- case Variant::QUATERNION:
- case Variant::AABB:
- case Variant::BASIS:
- case Variant::TRANSFORM3D:
- case Variant::PROJECTION:
- case Variant::COLOR:
- case Variant::STRING_NAME:
- case Variant::NODE_PATH:
- case Variant::RID:
- case Variant::CALLABLE:
- case Variant::SIGNAL:
- temp_type = p_type.builtin_type;
- break;
- case Variant::OBJECT:
- case Variant::DICTIONARY:
- case Variant::ARRAY:
- case Variant::PACKED_BYTE_ARRAY:
- case Variant::PACKED_INT32_ARRAY:
- case Variant::PACKED_INT64_ARRAY:
- case Variant::PACKED_FLOAT32_ARRAY:
- case Variant::PACKED_FLOAT64_ARRAY:
- case Variant::PACKED_STRING_ARRAY:
- case Variant::PACKED_VECTOR2_ARRAY:
- case Variant::PACKED_VECTOR3_ARRAY:
- case Variant::PACKED_COLOR_ARRAY:
- case Variant::PACKED_VECTOR4_ARRAY:
- case Variant::VARIANT_MAX:
- // Arrays, dictionaries, and objects are reference counted, so we don't use the pool for them.
- temp_type = Variant::NIL;
- break;
- }
- }
- if (!temporaries_pool.has(temp_type)) {
- temporaries_pool[temp_type] = List<int>();
- }
- List<int> &pool = temporaries_pool[temp_type];
- if (pool.is_empty()) {
- StackSlot new_temp(temp_type, p_type.can_contain_object());
- int idx = temporaries.size();
- pool.push_back(idx);
- temporaries.push_back(new_temp);
- }
- int slot = pool.front()->get();
- pool.pop_front();
- used_temporaries.push_back(slot);
- return slot;
- }
- void GDScriptByteCodeGenerator::pop_temporary() {
- ERR_FAIL_COND(used_temporaries.is_empty());
- int slot_idx = used_temporaries.back()->get();
- if (temporaries[slot_idx].can_contain_object) {
- // Avoid keeping in the stack long-lived references to objects,
- // which may prevent `RefCounted` objects from being freed.
- // However, the cleanup will be performed an the end of the
- // statement, to allow object references to survive chaining.
- temporaries_pending_clear.insert(slot_idx);
- }
- temporaries_pool[temporaries[slot_idx].type].push_back(slot_idx);
- used_temporaries.pop_back();
- }
- void GDScriptByteCodeGenerator::start_parameters() {
- if (function->_default_arg_count > 0) {
- append(GDScriptFunction::OPCODE_JUMP_TO_DEF_ARGUMENT);
- function->default_arguments.push_back(opcodes.size());
- }
- }
- void GDScriptByteCodeGenerator::end_parameters() {
- function->default_arguments.reverse();
- }
- void GDScriptByteCodeGenerator::write_start(GDScript *p_script, const StringName &p_function_name, bool p_static, Variant p_rpc_config, const GDScriptDataType &p_return_type) {
- function = memnew(GDScriptFunction);
- debug_stack = GDScriptLanguage::get_singleton()->should_track_locals();
- function->name = p_function_name;
- function->_script = p_script;
- function->source = p_script->get_script_path();
- #ifdef DEBUG_ENABLED
- function->func_cname = (String(function->source) + " - " + String(p_function_name)).utf8();
- function->_func_cname = function->func_cname.get_data();
- #endif
- function->_static = p_static;
- function->return_type = p_return_type;
- function->rpc_config = p_rpc_config;
- function->_argument_count = 0;
- }
- GDScriptFunction *GDScriptByteCodeGenerator::write_end() {
- #ifdef DEBUG_ENABLED
- if (!used_temporaries.is_empty()) {
- ERR_PRINT("Non-zero temporary variables at end of function: " + itos(used_temporaries.size()));
- }
- #endif
- append_opcode(GDScriptFunction::OPCODE_END);
- for (int i = 0; i < temporaries.size(); i++) {
- int stack_index = i + max_locals + GDScriptFunction::FIXED_ADDRESSES_MAX;
- for (int j = 0; j < temporaries[i].bytecode_indices.size(); j++) {
- opcodes.write[temporaries[i].bytecode_indices[j]] = stack_index | (GDScriptFunction::ADDR_TYPE_STACK << GDScriptFunction::ADDR_BITS);
- }
- if (temporaries[i].type != Variant::NIL) {
- function->temporary_slots[stack_index] = temporaries[i].type;
- }
- }
- if (constant_map.size()) {
- function->_constant_count = constant_map.size();
- function->constants.resize(constant_map.size());
- function->_constants_ptr = function->constants.ptrw();
- for (const KeyValue<Variant, int> &K : constant_map) {
- function->constants.write[K.value] = K.key;
- }
- } else {
- function->_constants_ptr = nullptr;
- function->_constant_count = 0;
- }
- if (name_map.size()) {
- function->global_names.resize(name_map.size());
- function->_global_names_ptr = &function->global_names[0];
- for (const KeyValue<StringName, int> &E : name_map) {
- function->global_names.write[E.value] = E.key;
- }
- function->_global_names_count = function->global_names.size();
- } else {
- function->_global_names_ptr = nullptr;
- function->_global_names_count = 0;
- }
- if (opcodes.size()) {
- function->code = opcodes;
- function->_code_ptr = &function->code.write[0];
- function->_code_size = opcodes.size();
- } else {
- function->_code_ptr = nullptr;
- function->_code_size = 0;
- }
- if (function->default_arguments.size()) {
- function->_default_arg_count = function->default_arguments.size() - 1;
- function->_default_arg_ptr = &function->default_arguments[0];
- } else {
- function->_default_arg_count = 0;
- function->_default_arg_ptr = nullptr;
- }
- if (operator_func_map.size()) {
- function->operator_funcs.resize(operator_func_map.size());
- function->_operator_funcs_count = function->operator_funcs.size();
- function->_operator_funcs_ptr = function->operator_funcs.ptr();
- for (const KeyValue<Variant::ValidatedOperatorEvaluator, int> &E : operator_func_map) {
- function->operator_funcs.write[E.value] = E.key;
- }
- } else {
- function->_operator_funcs_count = 0;
- function->_operator_funcs_ptr = nullptr;
- }
- if (setters_map.size()) {
- function->setters.resize(setters_map.size());
- function->_setters_count = function->setters.size();
- function->_setters_ptr = function->setters.ptr();
- for (const KeyValue<Variant::ValidatedSetter, int> &E : setters_map) {
- function->setters.write[E.value] = E.key;
- }
- } else {
- function->_setters_count = 0;
- function->_setters_ptr = nullptr;
- }
- if (getters_map.size()) {
- function->getters.resize(getters_map.size());
- function->_getters_count = function->getters.size();
- function->_getters_ptr = function->getters.ptr();
- for (const KeyValue<Variant::ValidatedGetter, int> &E : getters_map) {
- function->getters.write[E.value] = E.key;
- }
- } else {
- function->_getters_count = 0;
- function->_getters_ptr = nullptr;
- }
- if (keyed_setters_map.size()) {
- function->keyed_setters.resize(keyed_setters_map.size());
- function->_keyed_setters_count = function->keyed_setters.size();
- function->_keyed_setters_ptr = function->keyed_setters.ptr();
- for (const KeyValue<Variant::ValidatedKeyedSetter, int> &E : keyed_setters_map) {
- function->keyed_setters.write[E.value] = E.key;
- }
- } else {
- function->_keyed_setters_count = 0;
- function->_keyed_setters_ptr = nullptr;
- }
- if (keyed_getters_map.size()) {
- function->keyed_getters.resize(keyed_getters_map.size());
- function->_keyed_getters_count = function->keyed_getters.size();
- function->_keyed_getters_ptr = function->keyed_getters.ptr();
- for (const KeyValue<Variant::ValidatedKeyedGetter, int> &E : keyed_getters_map) {
- function->keyed_getters.write[E.value] = E.key;
- }
- } else {
- function->_keyed_getters_count = 0;
- function->_keyed_getters_ptr = nullptr;
- }
- if (indexed_setters_map.size()) {
- function->indexed_setters.resize(indexed_setters_map.size());
- function->_indexed_setters_count = function->indexed_setters.size();
- function->_indexed_setters_ptr = function->indexed_setters.ptr();
- for (const KeyValue<Variant::ValidatedIndexedSetter, int> &E : indexed_setters_map) {
- function->indexed_setters.write[E.value] = E.key;
- }
- } else {
- function->_indexed_setters_count = 0;
- function->_indexed_setters_ptr = nullptr;
- }
- if (indexed_getters_map.size()) {
- function->indexed_getters.resize(indexed_getters_map.size());
- function->_indexed_getters_count = function->indexed_getters.size();
- function->_indexed_getters_ptr = function->indexed_getters.ptr();
- for (const KeyValue<Variant::ValidatedIndexedGetter, int> &E : indexed_getters_map) {
- function->indexed_getters.write[E.value] = E.key;
- }
- } else {
- function->_indexed_getters_count = 0;
- function->_indexed_getters_ptr = nullptr;
- }
- if (builtin_method_map.size()) {
- function->builtin_methods.resize(builtin_method_map.size());
- function->_builtin_methods_ptr = function->builtin_methods.ptr();
- function->_builtin_methods_count = builtin_method_map.size();
- for (const KeyValue<Variant::ValidatedBuiltInMethod, int> &E : builtin_method_map) {
- function->builtin_methods.write[E.value] = E.key;
- }
- } else {
- function->_builtin_methods_ptr = nullptr;
- function->_builtin_methods_count = 0;
- }
- if (constructors_map.size()) {
- function->constructors.resize(constructors_map.size());
- function->_constructors_ptr = function->constructors.ptr();
- function->_constructors_count = constructors_map.size();
- for (const KeyValue<Variant::ValidatedConstructor, int> &E : constructors_map) {
- function->constructors.write[E.value] = E.key;
- }
- } else {
- function->_constructors_ptr = nullptr;
- function->_constructors_count = 0;
- }
- if (utilities_map.size()) {
- function->utilities.resize(utilities_map.size());
- function->_utilities_ptr = function->utilities.ptr();
- function->_utilities_count = utilities_map.size();
- for (const KeyValue<Variant::ValidatedUtilityFunction, int> &E : utilities_map) {
- function->utilities.write[E.value] = E.key;
- }
- } else {
- function->_utilities_ptr = nullptr;
- function->_utilities_count = 0;
- }
- if (gds_utilities_map.size()) {
- function->gds_utilities.resize(gds_utilities_map.size());
- function->_gds_utilities_ptr = function->gds_utilities.ptr();
- function->_gds_utilities_count = gds_utilities_map.size();
- for (const KeyValue<GDScriptUtilityFunctions::FunctionPtr, int> &E : gds_utilities_map) {
- function->gds_utilities.write[E.value] = E.key;
- }
- } else {
- function->_gds_utilities_ptr = nullptr;
- function->_gds_utilities_count = 0;
- }
- if (method_bind_map.size()) {
- function->methods.resize(method_bind_map.size());
- function->_methods_ptr = function->methods.ptrw();
- function->_methods_count = method_bind_map.size();
- for (const KeyValue<MethodBind *, int> &E : method_bind_map) {
- function->methods.write[E.value] = E.key;
- }
- } else {
- function->_methods_ptr = nullptr;
- function->_methods_count = 0;
- }
- if (lambdas_map.size()) {
- function->lambdas.resize(lambdas_map.size());
- function->_lambdas_ptr = function->lambdas.ptrw();
- function->_lambdas_count = lambdas_map.size();
- for (const KeyValue<GDScriptFunction *, int> &E : lambdas_map) {
- function->lambdas.write[E.value] = E.key;
- }
- } else {
- function->_lambdas_ptr = nullptr;
- function->_lambdas_count = 0;
- }
- if (debug_stack) {
- function->stack_debug = stack_debug;
- }
- function->_stack_size = GDScriptFunction::FIXED_ADDRESSES_MAX + max_locals + temporaries.size();
- function->_instruction_args_size = instr_args_max;
- #ifdef DEBUG_ENABLED
- function->operator_names = operator_names;
- function->setter_names = setter_names;
- function->getter_names = getter_names;
- function->builtin_methods_names = builtin_methods_names;
- function->constructors_names = constructors_names;
- function->utilities_names = utilities_names;
- function->gds_utilities_names = gds_utilities_names;
- #endif
- ended = true;
- return function;
- }
- #ifdef DEBUG_ENABLED
- void GDScriptByteCodeGenerator::set_signature(const String &p_signature) {
- function->profile.signature = p_signature;
- }
- #endif
- void GDScriptByteCodeGenerator::set_initial_line(int p_line) {
- function->_initial_line = p_line;
- }
- #define HAS_BUILTIN_TYPE(m_var) \
- (m_var.type.has_type && m_var.type.kind == GDScriptDataType::BUILTIN)
- #define IS_BUILTIN_TYPE(m_var, m_type) \
- (m_var.type.has_type && m_var.type.kind == GDScriptDataType::BUILTIN && m_var.type.builtin_type == m_type && m_type != Variant::NIL)
- void GDScriptByteCodeGenerator::write_type_adjust(const Address &p_target, Variant::Type p_new_type) {
- switch (p_new_type) {
- case Variant::BOOL:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_BOOL);
- break;
- case Variant::INT:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_INT);
- break;
- case Variant::FLOAT:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_FLOAT);
- break;
- case Variant::STRING:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_STRING);
- break;
- case Variant::VECTOR2:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR2);
- break;
- case Variant::VECTOR2I:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR2I);
- break;
- case Variant::RECT2:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_RECT2);
- break;
- case Variant::RECT2I:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_RECT2I);
- break;
- case Variant::VECTOR3:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3);
- break;
- case Variant::VECTOR3I:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3I);
- break;
- case Variant::TRANSFORM2D:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_TRANSFORM2D);
- break;
- case Variant::VECTOR4:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3);
- break;
- case Variant::VECTOR4I:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_VECTOR3I);
- break;
- case Variant::PLANE:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PLANE);
- break;
- case Variant::QUATERNION:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_QUATERNION);
- break;
- case Variant::AABB:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_AABB);
- break;
- case Variant::BASIS:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_BASIS);
- break;
- case Variant::TRANSFORM3D:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_TRANSFORM3D);
- break;
- case Variant::PROJECTION:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PROJECTION);
- break;
- case Variant::COLOR:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_COLOR);
- break;
- case Variant::STRING_NAME:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_STRING_NAME);
- break;
- case Variant::NODE_PATH:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_NODE_PATH);
- break;
- case Variant::RID:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_RID);
- break;
- case Variant::OBJECT:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_OBJECT);
- break;
- case Variant::CALLABLE:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_CALLABLE);
- break;
- case Variant::SIGNAL:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_SIGNAL);
- break;
- case Variant::DICTIONARY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_DICTIONARY);
- break;
- case Variant::ARRAY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_ARRAY);
- break;
- case Variant::PACKED_BYTE_ARRAY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_BYTE_ARRAY);
- break;
- case Variant::PACKED_INT32_ARRAY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_INT32_ARRAY);
- break;
- case Variant::PACKED_INT64_ARRAY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_INT64_ARRAY);
- break;
- case Variant::PACKED_FLOAT32_ARRAY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_FLOAT32_ARRAY);
- break;
- case Variant::PACKED_FLOAT64_ARRAY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_FLOAT64_ARRAY);
- break;
- case Variant::PACKED_STRING_ARRAY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_STRING_ARRAY);
- break;
- case Variant::PACKED_VECTOR2_ARRAY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_VECTOR2_ARRAY);
- break;
- case Variant::PACKED_VECTOR3_ARRAY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_VECTOR3_ARRAY);
- break;
- case Variant::PACKED_COLOR_ARRAY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_COLOR_ARRAY);
- break;
- case Variant::PACKED_VECTOR4_ARRAY:
- append_opcode(GDScriptFunction::OPCODE_TYPE_ADJUST_PACKED_VECTOR4_ARRAY);
- break;
- case Variant::NIL:
- case Variant::VARIANT_MAX:
- return;
- }
- append(p_target);
- }
- void GDScriptByteCodeGenerator::write_unary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand) {
- if (HAS_BUILTIN_TYPE(p_left_operand)) {
- // Gather specific operator.
- Variant::ValidatedOperatorEvaluator op_func = Variant::get_validated_operator_evaluator(p_operator, p_left_operand.type.builtin_type, Variant::NIL);
- append_opcode(GDScriptFunction::OPCODE_OPERATOR_VALIDATED);
- append(p_left_operand);
- append(Address());
- append(p_target);
- append(op_func);
- #ifdef DEBUG_ENABLED
- add_debug_name(operator_names, get_operation_pos(op_func), Variant::get_operator_name(p_operator));
- #endif
- return;
- }
- // No specific types, perform variant evaluation.
- append_opcode(GDScriptFunction::OPCODE_OPERATOR);
- append(p_left_operand);
- append(Address());
- append(p_target);
- append(p_operator);
- append(0); // Signature storage.
- append(0); // Return type storage.
- constexpr int _pointer_size = sizeof(Variant::ValidatedOperatorEvaluator) / sizeof(*(opcodes.ptr()));
- for (int i = 0; i < _pointer_size; i++) {
- append(0); // Space for function pointer.
- }
- }
- void GDScriptByteCodeGenerator::write_binary_operator(const Address &p_target, Variant::Operator p_operator, const Address &p_left_operand, const Address &p_right_operand) {
- bool valid = HAS_BUILTIN_TYPE(p_left_operand) && HAS_BUILTIN_TYPE(p_right_operand);
- // Avoid validated evaluator for modulo and division when operands are int or integer vector, since there's no check for division by zero.
- if (valid && (p_operator == Variant::OP_DIVIDE || p_operator == Variant::OP_MODULE)) {
- switch (p_left_operand.type.builtin_type) {
- case Variant::INT:
- valid = p_right_operand.type.builtin_type != Variant::INT;
- break;
- case Variant::VECTOR2I:
- case Variant::VECTOR3I:
- case Variant::VECTOR4I:
- valid = p_right_operand.type.builtin_type != Variant::INT && p_right_operand.type.builtin_type != p_left_operand.type.builtin_type;
- break;
- default:
- break;
- }
- }
- if (valid) {
- if (p_target.mode == Address::TEMPORARY) {
- Variant::Type result_type = Variant::get_operator_return_type(p_operator, p_left_operand.type.builtin_type, p_right_operand.type.builtin_type);
- Variant::Type temp_type = temporaries[p_target.address].type;
- if (result_type != temp_type) {
- write_type_adjust(p_target, result_type);
- }
- }
- // Gather specific operator.
- Variant::ValidatedOperatorEvaluator op_func = Variant::get_validated_operator_evaluator(p_operator, p_left_operand.type.builtin_type, p_right_operand.type.builtin_type);
- append_opcode(GDScriptFunction::OPCODE_OPERATOR_VALIDATED);
- append(p_left_operand);
- append(p_right_operand);
- append(p_target);
- append(op_func);
- #ifdef DEBUG_ENABLED
- add_debug_name(operator_names, get_operation_pos(op_func), Variant::get_operator_name(p_operator));
- #endif
- return;
- }
- // No specific types, perform variant evaluation.
- append_opcode(GDScriptFunction::OPCODE_OPERATOR);
- append(p_left_operand);
- append(p_right_operand);
- append(p_target);
- append(p_operator);
- append(0); // Signature storage.
- append(0); // Return type storage.
- constexpr int _pointer_size = sizeof(Variant::ValidatedOperatorEvaluator) / sizeof(*(opcodes.ptr()));
- for (int i = 0; i < _pointer_size; i++) {
- append(0); // Space for function pointer.
- }
- }
- void GDScriptByteCodeGenerator::write_type_test(const Address &p_target, const Address &p_source, const GDScriptDataType &p_type) {
- switch (p_type.kind) {
- case GDScriptDataType::BUILTIN: {
- if (p_type.builtin_type == Variant::ARRAY && p_type.has_container_element_type(0)) {
- const GDScriptDataType &element_type = p_type.get_container_element_type(0);
- append_opcode(GDScriptFunction::OPCODE_TYPE_TEST_ARRAY);
- append(p_target);
- append(p_source);
- append(get_constant_pos(element_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(element_type.builtin_type);
- append(element_type.native_type);
- } else if (p_type.builtin_type == Variant::DICTIONARY && p_type.has_container_element_types()) {
- const GDScriptDataType &key_element_type = p_type.get_container_element_type_or_variant(0);
- const GDScriptDataType &value_element_type = p_type.get_container_element_type_or_variant(1);
- append_opcode(GDScriptFunction::OPCODE_TYPE_TEST_DICTIONARY);
- append(p_target);
- append(p_source);
- append(get_constant_pos(key_element_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(get_constant_pos(value_element_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(key_element_type.builtin_type);
- append(key_element_type.native_type);
- append(value_element_type.builtin_type);
- append(value_element_type.native_type);
- } else {
- append_opcode(GDScriptFunction::OPCODE_TYPE_TEST_BUILTIN);
- append(p_target);
- append(p_source);
- append(p_type.builtin_type);
- }
- } break;
- case GDScriptDataType::NATIVE: {
- append_opcode(GDScriptFunction::OPCODE_TYPE_TEST_NATIVE);
- append(p_target);
- append(p_source);
- append(p_type.native_type);
- } break;
- case GDScriptDataType::SCRIPT:
- case GDScriptDataType::GDSCRIPT: {
- const Variant &script = p_type.script_type;
- append_opcode(GDScriptFunction::OPCODE_TYPE_TEST_SCRIPT);
- append(p_target);
- append(p_source);
- append(get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- } break;
- default: {
- ERR_PRINT("Compiler bug: unresolved type in type test.");
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_FALSE);
- append(p_target);
- }
- }
- }
- void GDScriptByteCodeGenerator::write_and_left_operand(const Address &p_left_operand) {
- append_opcode(GDScriptFunction::OPCODE_JUMP_IF_NOT);
- append(p_left_operand);
- logic_op_jump_pos1.push_back(opcodes.size());
- append(0); // Jump target, will be patched.
- }
- void GDScriptByteCodeGenerator::write_and_right_operand(const Address &p_right_operand) {
- append_opcode(GDScriptFunction::OPCODE_JUMP_IF_NOT);
- append(p_right_operand);
- logic_op_jump_pos2.push_back(opcodes.size());
- append(0); // Jump target, will be patched.
- }
- void GDScriptByteCodeGenerator::write_end_and(const Address &p_target) {
- // If here means both operands are true.
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_TRUE);
- append(p_target);
- // Jump away from the fail condition.
- append_opcode(GDScriptFunction::OPCODE_JUMP);
- append(opcodes.size() + 3);
- // Here it means one of operands is false.
- patch_jump(logic_op_jump_pos1.back()->get());
- patch_jump(logic_op_jump_pos2.back()->get());
- logic_op_jump_pos1.pop_back();
- logic_op_jump_pos2.pop_back();
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_FALSE);
- append(p_target);
- }
- void GDScriptByteCodeGenerator::write_or_left_operand(const Address &p_left_operand) {
- append_opcode(GDScriptFunction::OPCODE_JUMP_IF);
- append(p_left_operand);
- logic_op_jump_pos1.push_back(opcodes.size());
- append(0); // Jump target, will be patched.
- }
- void GDScriptByteCodeGenerator::write_or_right_operand(const Address &p_right_operand) {
- append_opcode(GDScriptFunction::OPCODE_JUMP_IF);
- append(p_right_operand);
- logic_op_jump_pos2.push_back(opcodes.size());
- append(0); // Jump target, will be patched.
- }
- void GDScriptByteCodeGenerator::write_end_or(const Address &p_target) {
- // If here means both operands are false.
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_FALSE);
- append(p_target);
- // Jump away from the success condition.
- append_opcode(GDScriptFunction::OPCODE_JUMP);
- append(opcodes.size() + 3);
- // Here it means one of operands is true.
- patch_jump(logic_op_jump_pos1.back()->get());
- patch_jump(logic_op_jump_pos2.back()->get());
- logic_op_jump_pos1.pop_back();
- logic_op_jump_pos2.pop_back();
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_TRUE);
- append(p_target);
- }
- void GDScriptByteCodeGenerator::write_start_ternary(const Address &p_target) {
- ternary_result.push_back(p_target);
- }
- void GDScriptByteCodeGenerator::write_ternary_condition(const Address &p_condition) {
- append_opcode(GDScriptFunction::OPCODE_JUMP_IF_NOT);
- append(p_condition);
- ternary_jump_fail_pos.push_back(opcodes.size());
- append(0); // Jump target, will be patched.
- }
- void GDScriptByteCodeGenerator::write_ternary_true_expr(const Address &p_expr) {
- append_opcode(GDScriptFunction::OPCODE_ASSIGN);
- append(ternary_result.back()->get());
- append(p_expr);
- // Jump away from the false path.
- append_opcode(GDScriptFunction::OPCODE_JUMP);
- ternary_jump_skip_pos.push_back(opcodes.size());
- append(0);
- // Fail must jump here.
- patch_jump(ternary_jump_fail_pos.back()->get());
- ternary_jump_fail_pos.pop_back();
- }
- void GDScriptByteCodeGenerator::write_ternary_false_expr(const Address &p_expr) {
- append_opcode(GDScriptFunction::OPCODE_ASSIGN);
- append(ternary_result.back()->get());
- append(p_expr);
- }
- void GDScriptByteCodeGenerator::write_end_ternary() {
- patch_jump(ternary_jump_skip_pos.back()->get());
- ternary_jump_skip_pos.pop_back();
- ternary_result.pop_back();
- }
- void GDScriptByteCodeGenerator::write_set(const Address &p_target, const Address &p_index, const Address &p_source) {
- if (HAS_BUILTIN_TYPE(p_target)) {
- if (IS_BUILTIN_TYPE(p_index, Variant::INT) && Variant::get_member_validated_indexed_setter(p_target.type.builtin_type) &&
- IS_BUILTIN_TYPE(p_source, Variant::get_indexed_element_type(p_target.type.builtin_type))) {
- // Use indexed setter instead.
- Variant::ValidatedIndexedSetter setter = Variant::get_member_validated_indexed_setter(p_target.type.builtin_type);
- append_opcode(GDScriptFunction::OPCODE_SET_INDEXED_VALIDATED);
- append(p_target);
- append(p_index);
- append(p_source);
- append(setter);
- return;
- } else if (Variant::get_member_validated_keyed_setter(p_target.type.builtin_type)) {
- Variant::ValidatedKeyedSetter setter = Variant::get_member_validated_keyed_setter(p_target.type.builtin_type);
- append_opcode(GDScriptFunction::OPCODE_SET_KEYED_VALIDATED);
- append(p_target);
- append(p_index);
- append(p_source);
- append(setter);
- return;
- }
- }
- append_opcode(GDScriptFunction::OPCODE_SET_KEYED);
- append(p_target);
- append(p_index);
- append(p_source);
- }
- void GDScriptByteCodeGenerator::write_get(const Address &p_target, const Address &p_index, const Address &p_source) {
- if (HAS_BUILTIN_TYPE(p_source)) {
- if (IS_BUILTIN_TYPE(p_index, Variant::INT) && Variant::get_member_validated_indexed_getter(p_source.type.builtin_type)) {
- // Use indexed getter instead.
- Variant::ValidatedIndexedGetter getter = Variant::get_member_validated_indexed_getter(p_source.type.builtin_type);
- append_opcode(GDScriptFunction::OPCODE_GET_INDEXED_VALIDATED);
- append(p_source);
- append(p_index);
- append(p_target);
- append(getter);
- return;
- } else if (Variant::get_member_validated_keyed_getter(p_source.type.builtin_type)) {
- Variant::ValidatedKeyedGetter getter = Variant::get_member_validated_keyed_getter(p_source.type.builtin_type);
- append_opcode(GDScriptFunction::OPCODE_GET_KEYED_VALIDATED);
- append(p_source);
- append(p_index);
- append(p_target);
- append(getter);
- return;
- }
- }
- append_opcode(GDScriptFunction::OPCODE_GET_KEYED);
- append(p_source);
- append(p_index);
- append(p_target);
- }
- void GDScriptByteCodeGenerator::write_set_named(const Address &p_target, const StringName &p_name, const Address &p_source) {
- if (HAS_BUILTIN_TYPE(p_target) && Variant::get_member_validated_setter(p_target.type.builtin_type, p_name) &&
- IS_BUILTIN_TYPE(p_source, Variant::get_member_type(p_target.type.builtin_type, p_name))) {
- Variant::ValidatedSetter setter = Variant::get_member_validated_setter(p_target.type.builtin_type, p_name);
- append_opcode(GDScriptFunction::OPCODE_SET_NAMED_VALIDATED);
- append(p_target);
- append(p_source);
- append(setter);
- #ifdef DEBUG_ENABLED
- add_debug_name(setter_names, get_setter_pos(setter), p_name);
- #endif
- return;
- }
- append_opcode(GDScriptFunction::OPCODE_SET_NAMED);
- append(p_target);
- append(p_source);
- append(p_name);
- }
- void GDScriptByteCodeGenerator::write_get_named(const Address &p_target, const StringName &p_name, const Address &p_source) {
- if (HAS_BUILTIN_TYPE(p_source) && Variant::get_member_validated_getter(p_source.type.builtin_type, p_name)) {
- Variant::ValidatedGetter getter = Variant::get_member_validated_getter(p_source.type.builtin_type, p_name);
- append_opcode(GDScriptFunction::OPCODE_GET_NAMED_VALIDATED);
- append(p_source);
- append(p_target);
- append(getter);
- #ifdef DEBUG_ENABLED
- add_debug_name(getter_names, get_getter_pos(getter), p_name);
- #endif
- return;
- }
- append_opcode(GDScriptFunction::OPCODE_GET_NAMED);
- append(p_source);
- append(p_target);
- append(p_name);
- }
- void GDScriptByteCodeGenerator::write_set_member(const Address &p_value, const StringName &p_name) {
- append_opcode(GDScriptFunction::OPCODE_SET_MEMBER);
- append(p_value);
- append(p_name);
- }
- void GDScriptByteCodeGenerator::write_get_member(const Address &p_target, const StringName &p_name) {
- append_opcode(GDScriptFunction::OPCODE_GET_MEMBER);
- append(p_target);
- append(p_name);
- }
- void GDScriptByteCodeGenerator::write_set_static_variable(const Address &p_value, const Address &p_class, int p_index) {
- append_opcode(GDScriptFunction::OPCODE_SET_STATIC_VARIABLE);
- append(p_value);
- append(p_class);
- append(p_index);
- }
- void GDScriptByteCodeGenerator::write_get_static_variable(const Address &p_target, const Address &p_class, int p_index) {
- append_opcode(GDScriptFunction::OPCODE_GET_STATIC_VARIABLE);
- append(p_target);
- append(p_class);
- append(p_index);
- }
- void GDScriptByteCodeGenerator::write_assign_with_conversion(const Address &p_target, const Address &p_source) {
- switch (p_target.type.kind) {
- case GDScriptDataType::BUILTIN: {
- if (p_target.type.builtin_type == Variant::ARRAY && p_target.type.has_container_element_type(0)) {
- const GDScriptDataType &element_type = p_target.type.get_container_element_type(0);
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_ARRAY);
- append(p_target);
- append(p_source);
- append(get_constant_pos(element_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(element_type.builtin_type);
- append(element_type.native_type);
- } else if (p_target.type.builtin_type == Variant::DICTIONARY && p_target.type.has_container_element_types()) {
- const GDScriptDataType &key_type = p_target.type.get_container_element_type_or_variant(0);
- const GDScriptDataType &value_type = p_target.type.get_container_element_type_or_variant(1);
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_DICTIONARY);
- append(p_target);
- append(p_source);
- append(get_constant_pos(key_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(get_constant_pos(value_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(key_type.builtin_type);
- append(key_type.native_type);
- append(value_type.builtin_type);
- append(value_type.native_type);
- } else {
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_BUILTIN);
- append(p_target);
- append(p_source);
- append(p_target.type.builtin_type);
- }
- } break;
- case GDScriptDataType::NATIVE: {
- int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[p_target.type.native_type];
- Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
- class_idx = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_NATIVE);
- append(p_target);
- append(p_source);
- append(class_idx);
- } break;
- case GDScriptDataType::SCRIPT:
- case GDScriptDataType::GDSCRIPT: {
- Variant script = p_target.type.script_type;
- int idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_SCRIPT);
- append(p_target);
- append(p_source);
- append(idx);
- } break;
- default: {
- ERR_PRINT("Compiler bug: unresolved assign.");
- // Shouldn't get here, but fail-safe to a regular assignment
- append_opcode(GDScriptFunction::OPCODE_ASSIGN);
- append(p_target);
- append(p_source);
- }
- }
- }
- void GDScriptByteCodeGenerator::write_assign(const Address &p_target, const Address &p_source) {
- if (p_target.type.kind == GDScriptDataType::BUILTIN && p_target.type.builtin_type == Variant::ARRAY && p_target.type.has_container_element_type(0)) {
- const GDScriptDataType &element_type = p_target.type.get_container_element_type(0);
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_ARRAY);
- append(p_target);
- append(p_source);
- append(get_constant_pos(element_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(element_type.builtin_type);
- append(element_type.native_type);
- } else if (p_target.type.kind == GDScriptDataType::BUILTIN && p_target.type.builtin_type == Variant::DICTIONARY && p_target.type.has_container_element_types()) {
- const GDScriptDataType &key_type = p_target.type.get_container_element_type_or_variant(0);
- const GDScriptDataType &value_type = p_target.type.get_container_element_type_or_variant(1);
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_DICTIONARY);
- append(p_target);
- append(p_source);
- append(get_constant_pos(key_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(get_constant_pos(value_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(key_type.builtin_type);
- append(key_type.native_type);
- append(value_type.builtin_type);
- append(value_type.native_type);
- } else if (p_target.type.kind == GDScriptDataType::BUILTIN && p_source.type.kind == GDScriptDataType::BUILTIN && p_target.type.builtin_type != p_source.type.builtin_type) {
- // Need conversion.
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_TYPED_BUILTIN);
- append(p_target);
- append(p_source);
- append(p_target.type.builtin_type);
- } else {
- append_opcode(GDScriptFunction::OPCODE_ASSIGN);
- append(p_target);
- append(p_source);
- }
- }
- void GDScriptByteCodeGenerator::write_assign_null(const Address &p_target) {
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_NULL);
- append(p_target);
- }
- void GDScriptByteCodeGenerator::write_assign_true(const Address &p_target) {
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_TRUE);
- append(p_target);
- }
- void GDScriptByteCodeGenerator::write_assign_false(const Address &p_target) {
- append_opcode(GDScriptFunction::OPCODE_ASSIGN_FALSE);
- append(p_target);
- }
- void GDScriptByteCodeGenerator::write_assign_default_parameter(const Address &p_dst, const Address &p_src, bool p_use_conversion) {
- if (p_use_conversion) {
- write_assign_with_conversion(p_dst, p_src);
- } else {
- write_assign(p_dst, p_src);
- }
- function->default_arguments.push_back(opcodes.size());
- }
- void GDScriptByteCodeGenerator::write_store_global(const Address &p_dst, int p_global_index) {
- append_opcode(GDScriptFunction::OPCODE_STORE_GLOBAL);
- append(p_dst);
- append(p_global_index);
- }
- void GDScriptByteCodeGenerator::write_store_named_global(const Address &p_dst, const StringName &p_global) {
- append_opcode(GDScriptFunction::OPCODE_STORE_NAMED_GLOBAL);
- append(p_dst);
- append(p_global);
- }
- void GDScriptByteCodeGenerator::write_cast(const Address &p_target, const Address &p_source, const GDScriptDataType &p_type) {
- int index = 0;
- switch (p_type.kind) {
- case GDScriptDataType::BUILTIN: {
- append_opcode(GDScriptFunction::OPCODE_CAST_TO_BUILTIN);
- index = p_type.builtin_type;
- } break;
- case GDScriptDataType::NATIVE: {
- int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[p_type.native_type];
- Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
- append_opcode(GDScriptFunction::OPCODE_CAST_TO_NATIVE);
- index = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
- } break;
- case GDScriptDataType::SCRIPT:
- case GDScriptDataType::GDSCRIPT: {
- Variant script = p_type.script_type;
- int idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
- append_opcode(GDScriptFunction::OPCODE_CAST_TO_SCRIPT);
- index = idx;
- } break;
- default: {
- return;
- }
- }
- append(p_source);
- append(p_target);
- append(index);
- }
- GDScriptByteCodeGenerator::CallTarget GDScriptByteCodeGenerator::get_call_target(const GDScriptCodeGenerator::Address &p_target, Variant::Type p_type) {
- if (p_target.mode == Address::NIL) {
- GDScriptDataType type;
- if (p_type != Variant::NIL) {
- type.has_type = true;
- type.kind = GDScriptDataType::BUILTIN;
- type.builtin_type = p_type;
- }
- uint32_t addr = add_temporary(type);
- return CallTarget(Address(Address::TEMPORARY, addr, type), true, this);
- } else {
- return CallTarget(p_target, false, this);
- }
- }
- void GDScriptByteCodeGenerator::write_call(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- append(p_base);
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size());
- append(p_function_name);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_super_call(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_SELF_BASE, 1 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size());
- append(p_function_name);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_call_async(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_ASYNC, 2 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- append(p_base);
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size());
- append(p_function_name);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_call_gdscript_utility(const Address &p_target, const StringName &p_function, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_GDSCRIPT_UTILITY, 1 + p_arguments.size());
- GDScriptUtilityFunctions::FunctionPtr gds_function = GDScriptUtilityFunctions::get_function(p_function);
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size());
- append(gds_function);
- ct.cleanup();
- #ifdef DEBUG_ENABLED
- add_debug_name(gds_utilities_names, get_gds_utility_pos(gds_function), p_function);
- #endif
- }
- void GDScriptByteCodeGenerator::write_call_utility(const Address &p_target, const StringName &p_function, const Vector<Address> &p_arguments) {
- bool is_validated = true;
- if (Variant::is_utility_function_vararg(p_function)) {
- is_validated = false; // Vararg needs runtime checks, can't use validated call.
- } else if (p_arguments.size() == Variant::get_utility_function_argument_count(p_function)) {
- bool all_types_exact = true;
- for (int i = 0; i < p_arguments.size(); i++) {
- if (!IS_BUILTIN_TYPE(p_arguments[i], Variant::get_utility_function_argument_type(p_function, i))) {
- all_types_exact = false;
- break;
- }
- }
- is_validated = all_types_exact;
- }
- if (is_validated) {
- Variant::Type result_type = Variant::has_utility_function_return_value(p_function) ? Variant::get_utility_function_return_type(p_function) : Variant::NIL;
- CallTarget ct = get_call_target(p_target, result_type);
- Variant::Type temp_type = temporaries[ct.target.address].type;
- if (result_type != temp_type) {
- write_type_adjust(ct.target, result_type);
- }
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_UTILITY_VALIDATED, 1 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- append(ct.target);
- append(p_arguments.size());
- append(Variant::get_validated_utility_function(p_function));
- ct.cleanup();
- #ifdef DEBUG_ENABLED
- add_debug_name(utilities_names, get_utility_pos(Variant::get_validated_utility_function(p_function)), p_function);
- #endif
- } else {
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_UTILITY, 1 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size());
- append(p_function);
- ct.cleanup();
- }
- }
- void GDScriptByteCodeGenerator::write_call_builtin_type(const Address &p_target, const Address &p_base, Variant::Type p_type, const StringName &p_method, bool p_is_static, const Vector<Address> &p_arguments) {
- bool is_validated = false;
- // Check if all types are correct.
- if (Variant::is_builtin_method_vararg(p_type, p_method)) {
- is_validated = false; // Vararg needs runtime checks, can't use validated call.
- } else if (p_arguments.size() == Variant::get_builtin_method_argument_count(p_type, p_method)) {
- bool all_types_exact = true;
- for (int i = 0; i < p_arguments.size(); i++) {
- if (!IS_BUILTIN_TYPE(p_arguments[i], Variant::get_builtin_method_argument_type(p_type, p_method, i))) {
- all_types_exact = false;
- break;
- }
- }
- is_validated = all_types_exact;
- }
- if (!is_validated) {
- // Perform regular call.
- if (p_is_static) {
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_BUILTIN_STATIC, p_arguments.size() + 1);
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_type);
- append(p_method);
- append(p_arguments.size());
- ct.cleanup();
- } else {
- write_call(p_target, p_base, p_method, p_arguments);
- }
- return;
- }
- Variant::Type result_type = Variant::get_builtin_method_return_type(p_type, p_method);
- CallTarget ct = get_call_target(p_target, result_type);
- Variant::Type temp_type = temporaries[ct.target.address].type;
- if (result_type != temp_type) {
- write_type_adjust(ct.target, result_type);
- }
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_BUILTIN_TYPE_VALIDATED, 2 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- append(p_base);
- append(ct.target);
- append(p_arguments.size());
- append(Variant::get_validated_builtin_method(p_type, p_method));
- ct.cleanup();
- #ifdef DEBUG_ENABLED
- add_debug_name(builtin_methods_names, get_builtin_method_pos(Variant::get_validated_builtin_method(p_type, p_method)), p_method);
- #endif
- }
- 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) {
- write_call_builtin_type(p_target, p_base, p_type, p_method, false, p_arguments);
- }
- void GDScriptByteCodeGenerator::write_call_builtin_type_static(const Address &p_target, Variant::Type p_type, const StringName &p_method, const Vector<Address> &p_arguments) {
- write_call_builtin_type(p_target, Address(), p_type, p_method, true, p_arguments);
- }
- void GDScriptByteCodeGenerator::write_call_native_static(const Address &p_target, const StringName &p_class, const StringName &p_method, const Vector<Address> &p_arguments) {
- MethodBind *method = ClassDB::get_method(p_class, p_method);
- // Perform regular call.
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_NATIVE_STATIC, p_arguments.size() + 1);
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(method);
- append(p_arguments.size());
- ct.cleanup();
- return;
- }
- void GDScriptByteCodeGenerator::write_call_native_static_validated(const GDScriptCodeGenerator::Address &p_target, MethodBind *p_method, const Vector<GDScriptCodeGenerator::Address> &p_arguments) {
- Variant::Type return_type = Variant::NIL;
- bool has_return = p_method->has_return();
- if (has_return) {
- PropertyInfo return_info = p_method->get_return_info();
- return_type = return_info.type;
- }
- CallTarget ct = get_call_target(p_target, return_type);
- if (has_return) {
- Variant::Type temp_type = temporaries[ct.target.address].type;
- if (temp_type != return_type) {
- write_type_adjust(ct.target, return_type);
- }
- }
- GDScriptFunction::Opcode code = p_method->has_return() ? GDScriptFunction::OPCODE_CALL_NATIVE_STATIC_VALIDATED_RETURN : GDScriptFunction::OPCODE_CALL_NATIVE_STATIC_VALIDATED_NO_RETURN;
- append_opcode_and_argcount(code, 1 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- append(ct.target);
- append(p_arguments.size());
- append(p_method);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_call_method_bind(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL_METHOD_BIND : GDScriptFunction::OPCODE_CALL_METHOD_BIND_RET, 2 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(p_base);
- append(ct.target);
- append(p_arguments.size());
- append(p_method);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_call_method_bind_validated(const Address &p_target, const Address &p_base, MethodBind *p_method, const Vector<Address> &p_arguments) {
- Variant::Type return_type = Variant::NIL;
- bool has_return = p_method->has_return();
- if (has_return) {
- PropertyInfo return_info = p_method->get_return_info();
- return_type = return_info.type;
- }
- CallTarget ct = get_call_target(p_target, return_type);
- if (has_return) {
- Variant::Type temp_type = temporaries[ct.target.address].type;
- if (temp_type != return_type) {
- write_type_adjust(ct.target, return_type);
- }
- }
- GDScriptFunction::Opcode code = p_method->has_return() ? GDScriptFunction::OPCODE_CALL_METHOD_BIND_VALIDATED_RETURN : GDScriptFunction::OPCODE_CALL_METHOD_BIND_VALIDATED_NO_RETURN;
- append_opcode_and_argcount(code, 2 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- append(p_base);
- append(ct.target);
- append(p_arguments.size());
- append(p_method);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_call_self(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- append(GDScriptFunction::ADDR_TYPE_STACK << GDScriptFunction::ADDR_BITS);
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size());
- append(p_function_name);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_call_self_async(const Address &p_target, const StringName &p_function_name, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CALL_ASYNC, 2 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- append(GDScriptFunction::ADDR_SELF);
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size());
- append(p_function_name);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_call_script_function(const Address &p_target, const Address &p_base, const StringName &p_function_name, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(p_target.mode == Address::NIL ? GDScriptFunction::OPCODE_CALL : GDScriptFunction::OPCODE_CALL_RETURN, 2 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- append(p_base);
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size());
- append(p_function_name);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_lambda(const Address &p_target, GDScriptFunction *p_function, const Vector<Address> &p_captures, bool p_use_self) {
- append_opcode_and_argcount(p_use_self ? GDScriptFunction::OPCODE_CREATE_SELF_LAMBDA : GDScriptFunction::OPCODE_CREATE_LAMBDA, 1 + p_captures.size());
- for (int i = 0; i < p_captures.size(); i++) {
- append(p_captures[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_captures.size());
- append(p_function);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_construct(const Address &p_target, Variant::Type p_type, const Vector<Address> &p_arguments) {
- // Try to find an appropriate constructor.
- bool all_have_type = true;
- Vector<Variant::Type> arg_types;
- for (int i = 0; i < p_arguments.size(); i++) {
- if (!HAS_BUILTIN_TYPE(p_arguments[i])) {
- all_have_type = false;
- break;
- }
- arg_types.push_back(p_arguments[i].type.builtin_type);
- }
- if (all_have_type) {
- int valid_constructor = -1;
- for (int i = 0; i < Variant::get_constructor_count(p_type); i++) {
- if (Variant::get_constructor_argument_count(p_type, i) != p_arguments.size()) {
- continue;
- }
- int types_correct = true;
- for (int j = 0; j < arg_types.size(); j++) {
- if (arg_types[j] != Variant::get_constructor_argument_type(p_type, i, j)) {
- types_correct = false;
- break;
- }
- }
- if (types_correct) {
- valid_constructor = i;
- break;
- }
- }
- if (valid_constructor >= 0) {
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CONSTRUCT_VALIDATED, 1 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size());
- append(Variant::get_validated_constructor(p_type, valid_constructor));
- ct.cleanup();
- #ifdef DEBUG_ENABLED
- add_debug_name(constructors_names, get_constructor_pos(Variant::get_validated_constructor(p_type, valid_constructor)), Variant::get_type_name(p_type));
- #endif
- return;
- }
- }
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CONSTRUCT, 1 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size());
- append(p_type);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_construct_array(const Address &p_target, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CONSTRUCT_ARRAY, 1 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size());
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_construct_typed_array(const Address &p_target, const GDScriptDataType &p_element_type, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CONSTRUCT_TYPED_ARRAY, 2 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(get_constant_pos(p_element_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(p_arguments.size());
- append(p_element_type.builtin_type);
- append(p_element_type.native_type);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_construct_dictionary(const Address &p_target, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CONSTRUCT_DICTIONARY, 1 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(p_arguments.size() / 2); // This is number of key-value pairs, so only half of actual arguments.
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_construct_typed_dictionary(const Address &p_target, const GDScriptDataType &p_key_type, const GDScriptDataType &p_value_type, const Vector<Address> &p_arguments) {
- append_opcode_and_argcount(GDScriptFunction::OPCODE_CONSTRUCT_TYPED_DICTIONARY, 3 + p_arguments.size());
- for (int i = 0; i < p_arguments.size(); i++) {
- append(p_arguments[i]);
- }
- CallTarget ct = get_call_target(p_target);
- append(ct.target);
- append(get_constant_pos(p_key_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(get_constant_pos(p_value_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(p_arguments.size() / 2); // This is number of key-value pairs, so only half of actual arguments.
- append(p_key_type.builtin_type);
- append(p_key_type.native_type);
- append(p_value_type.builtin_type);
- append(p_value_type.native_type);
- ct.cleanup();
- }
- void GDScriptByteCodeGenerator::write_await(const Address &p_target, const Address &p_operand) {
- append_opcode(GDScriptFunction::OPCODE_AWAIT);
- append(p_operand);
- append_opcode(GDScriptFunction::OPCODE_AWAIT_RESUME);
- append(p_target);
- }
- void GDScriptByteCodeGenerator::write_if(const Address &p_condition) {
- append_opcode(GDScriptFunction::OPCODE_JUMP_IF_NOT);
- append(p_condition);
- if_jmp_addrs.push_back(opcodes.size());
- append(0); // Jump destination, will be patched.
- }
- void GDScriptByteCodeGenerator::write_else() {
- append_opcode(GDScriptFunction::OPCODE_JUMP); // Jump from true if block;
- int else_jmp_addr = opcodes.size();
- append(0); // Jump destination, will be patched.
- patch_jump(if_jmp_addrs.back()->get());
- if_jmp_addrs.pop_back();
- if_jmp_addrs.push_back(else_jmp_addr);
- }
- void GDScriptByteCodeGenerator::write_endif() {
- patch_jump(if_jmp_addrs.back()->get());
- if_jmp_addrs.pop_back();
- }
- void GDScriptByteCodeGenerator::write_jump_if_shared(const Address &p_value) {
- append_opcode(GDScriptFunction::OPCODE_JUMP_IF_SHARED);
- append(p_value);
- if_jmp_addrs.push_back(opcodes.size());
- append(0); // Jump destination, will be patched.
- }
- void GDScriptByteCodeGenerator::write_end_jump_if_shared() {
- patch_jump(if_jmp_addrs.back()->get());
- if_jmp_addrs.pop_back();
- }
- void GDScriptByteCodeGenerator::start_for(const GDScriptDataType &p_iterator_type, const GDScriptDataType &p_list_type) {
- Address counter(Address::LOCAL_VARIABLE, add_local("@counter_pos", p_iterator_type), p_iterator_type);
- Address container(Address::LOCAL_VARIABLE, add_local("@container_pos", p_list_type), p_list_type);
- // Store state.
- for_counter_variables.push_back(counter);
- for_container_variables.push_back(container);
- }
- void GDScriptByteCodeGenerator::write_for_assignment(const Address &p_list) {
- const Address &container = for_container_variables.back()->get();
- // Assign container.
- append_opcode(GDScriptFunction::OPCODE_ASSIGN);
- append(container);
- append(p_list);
- }
- void GDScriptByteCodeGenerator::write_for(const Address &p_variable, bool p_use_conversion) {
- const Address &counter = for_counter_variables.back()->get();
- const Address &container = for_container_variables.back()->get();
- current_breaks_to_patch.push_back(List<int>());
- GDScriptFunction::Opcode begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN;
- GDScriptFunction::Opcode iterate_opcode = GDScriptFunction::OPCODE_ITERATE;
- if (container.type.has_type) {
- if (container.type.kind == GDScriptDataType::BUILTIN) {
- switch (container.type.builtin_type) {
- case Variant::INT:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_INT;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_INT;
- break;
- case Variant::FLOAT:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_FLOAT;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_FLOAT;
- break;
- case Variant::VECTOR2:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR2;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR2;
- break;
- case Variant::VECTOR2I:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR2I;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR2I;
- break;
- case Variant::VECTOR3:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR3;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR3;
- break;
- case Variant::VECTOR3I:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_VECTOR3I;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_VECTOR3I;
- break;
- case Variant::STRING:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_STRING;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_STRING;
- break;
- case Variant::DICTIONARY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_DICTIONARY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_DICTIONARY;
- break;
- case Variant::ARRAY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_ARRAY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_ARRAY;
- break;
- case Variant::PACKED_BYTE_ARRAY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_BYTE_ARRAY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_BYTE_ARRAY;
- break;
- case Variant::PACKED_INT32_ARRAY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_INT32_ARRAY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_INT32_ARRAY;
- break;
- case Variant::PACKED_INT64_ARRAY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_INT64_ARRAY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_INT64_ARRAY;
- break;
- case Variant::PACKED_FLOAT32_ARRAY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_FLOAT32_ARRAY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_FLOAT32_ARRAY;
- break;
- case Variant::PACKED_FLOAT64_ARRAY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_FLOAT64_ARRAY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_FLOAT64_ARRAY;
- break;
- case Variant::PACKED_STRING_ARRAY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_STRING_ARRAY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_STRING_ARRAY;
- break;
- case Variant::PACKED_VECTOR2_ARRAY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_VECTOR2_ARRAY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_VECTOR2_ARRAY;
- break;
- case Variant::PACKED_VECTOR3_ARRAY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_VECTOR3_ARRAY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_VECTOR3_ARRAY;
- break;
- case Variant::PACKED_COLOR_ARRAY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_COLOR_ARRAY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_COLOR_ARRAY;
- break;
- case Variant::PACKED_VECTOR4_ARRAY:
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_PACKED_VECTOR4_ARRAY;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_PACKED_VECTOR4_ARRAY;
- break;
- default:
- break;
- }
- } else {
- begin_opcode = GDScriptFunction::OPCODE_ITERATE_BEGIN_OBJECT;
- iterate_opcode = GDScriptFunction::OPCODE_ITERATE_OBJECT;
- }
- }
- Address temp;
- if (p_use_conversion) {
- temp = Address(Address::LOCAL_VARIABLE, add_local("@iterator_temp", GDScriptDataType()));
- }
- // Begin loop.
- append_opcode(begin_opcode);
- append(counter);
- append(container);
- append(p_use_conversion ? temp : p_variable);
- for_jmp_addrs.push_back(opcodes.size());
- append(0); // End of loop address, will be patched.
- append_opcode(GDScriptFunction::OPCODE_JUMP);
- append(opcodes.size() + 6); // Skip over 'continue' code.
- // Next iteration.
- int continue_addr = opcodes.size();
- continue_addrs.push_back(continue_addr);
- append_opcode(iterate_opcode);
- append(counter);
- append(container);
- append(p_use_conversion ? temp : p_variable);
- for_jmp_addrs.push_back(opcodes.size());
- append(0); // Jump destination, will be patched.
- if (p_use_conversion) {
- write_assign_with_conversion(p_variable, temp);
- if (p_variable.type.can_contain_object()) {
- clear_address(temp); // Can contain `RefCounted`, so clear it.
- }
- }
- }
- void GDScriptByteCodeGenerator::write_endfor() {
- // Jump back to loop check.
- append_opcode(GDScriptFunction::OPCODE_JUMP);
- append(continue_addrs.back()->get());
- continue_addrs.pop_back();
- // Patch end jumps (two of them).
- for (int i = 0; i < 2; i++) {
- patch_jump(for_jmp_addrs.back()->get());
- for_jmp_addrs.pop_back();
- }
- // Patch break statements.
- for (const int &E : current_breaks_to_patch.back()->get()) {
- patch_jump(E);
- }
- current_breaks_to_patch.pop_back();
- // Pop state.
- for_counter_variables.pop_back();
- for_container_variables.pop_back();
- }
- void GDScriptByteCodeGenerator::start_while_condition() {
- current_breaks_to_patch.push_back(List<int>());
- continue_addrs.push_back(opcodes.size());
- }
- void GDScriptByteCodeGenerator::write_while(const Address &p_condition) {
- // Condition check.
- append_opcode(GDScriptFunction::OPCODE_JUMP_IF_NOT);
- append(p_condition);
- while_jmp_addrs.push_back(opcodes.size());
- append(0); // End of loop address, will be patched.
- }
- void GDScriptByteCodeGenerator::write_endwhile() {
- // Jump back to loop check.
- append_opcode(GDScriptFunction::OPCODE_JUMP);
- append(continue_addrs.back()->get());
- continue_addrs.pop_back();
- // Patch end jump.
- patch_jump(while_jmp_addrs.back()->get());
- while_jmp_addrs.pop_back();
- // Patch break statements.
- for (const int &E : current_breaks_to_patch.back()->get()) {
- patch_jump(E);
- }
- current_breaks_to_patch.pop_back();
- }
- void GDScriptByteCodeGenerator::write_break() {
- append_opcode(GDScriptFunction::OPCODE_JUMP);
- current_breaks_to_patch.back()->get().push_back(opcodes.size());
- append(0);
- }
- void GDScriptByteCodeGenerator::write_continue() {
- append_opcode(GDScriptFunction::OPCODE_JUMP);
- append(continue_addrs.back()->get());
- }
- void GDScriptByteCodeGenerator::write_breakpoint() {
- append_opcode(GDScriptFunction::OPCODE_BREAKPOINT);
- }
- void GDScriptByteCodeGenerator::write_newline(int p_line) {
- append_opcode(GDScriptFunction::OPCODE_LINE);
- append(p_line);
- current_line = p_line;
- }
- void GDScriptByteCodeGenerator::write_return(const Address &p_return_value) {
- if (!function->return_type.has_type || p_return_value.type.has_type) {
- // Either the function is untyped or the return value is also typed.
- // If this is a typed function, then we need to check for potential conversions.
- if (function->return_type.has_type) {
- if (function->return_type.kind == GDScriptDataType::BUILTIN && function->return_type.builtin_type == Variant::ARRAY && function->return_type.has_container_element_type(0)) {
- // Typed array.
- const GDScriptDataType &element_type = function->return_type.get_container_element_type(0);
- append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_ARRAY);
- append(p_return_value);
- append(get_constant_pos(element_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(element_type.builtin_type);
- append(element_type.native_type);
- } else if (function->return_type.kind == GDScriptDataType::BUILTIN && function->return_type.builtin_type == Variant::DICTIONARY &&
- function->return_type.has_container_element_types()) {
- // Typed dictionary.
- const GDScriptDataType &key_type = function->return_type.get_container_element_type_or_variant(0);
- const GDScriptDataType &value_type = function->return_type.get_container_element_type_or_variant(1);
- append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_DICTIONARY);
- append(p_return_value);
- append(get_constant_pos(key_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(get_constant_pos(value_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(key_type.builtin_type);
- append(key_type.native_type);
- append(value_type.builtin_type);
- append(value_type.native_type);
- } 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) {
- // Add conversion.
- append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_BUILTIN);
- append(p_return_value);
- append(function->return_type.builtin_type);
- } else {
- // Just assign.
- append_opcode(GDScriptFunction::OPCODE_RETURN);
- append(p_return_value);
- }
- } else {
- append_opcode(GDScriptFunction::OPCODE_RETURN);
- append(p_return_value);
- }
- } else {
- switch (function->return_type.kind) {
- case GDScriptDataType::BUILTIN: {
- if (function->return_type.builtin_type == Variant::ARRAY && function->return_type.has_container_element_type(0)) {
- const GDScriptDataType &element_type = function->return_type.get_container_element_type(0);
- append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_ARRAY);
- append(p_return_value);
- append(get_constant_pos(element_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(element_type.builtin_type);
- append(element_type.native_type);
- } else if (function->return_type.builtin_type == Variant::DICTIONARY && function->return_type.has_container_element_types()) {
- const GDScriptDataType &key_type = function->return_type.get_container_element_type_or_variant(0);
- const GDScriptDataType &value_type = function->return_type.get_container_element_type_or_variant(1);
- append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_DICTIONARY);
- append(p_return_value);
- append(get_constant_pos(key_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(get_constant_pos(value_type.script_type) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS));
- append(key_type.builtin_type);
- append(key_type.native_type);
- append(value_type.builtin_type);
- append(value_type.native_type);
- } else {
- append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_BUILTIN);
- append(p_return_value);
- append(function->return_type.builtin_type);
- }
- } break;
- case GDScriptDataType::NATIVE: {
- append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_NATIVE);
- append(p_return_value);
- int class_idx = GDScriptLanguage::get_singleton()->get_global_map()[function->return_type.native_type];
- Variant nc = GDScriptLanguage::get_singleton()->get_global_array()[class_idx];
- class_idx = get_constant_pos(nc) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
- append(class_idx);
- } break;
- case GDScriptDataType::GDSCRIPT:
- case GDScriptDataType::SCRIPT: {
- Variant script = function->return_type.script_type;
- int script_idx = get_constant_pos(script) | (GDScriptFunction::ADDR_TYPE_CONSTANT << GDScriptFunction::ADDR_BITS);
- append_opcode(GDScriptFunction::OPCODE_RETURN_TYPED_SCRIPT);
- append(p_return_value);
- append(script_idx);
- } break;
- default: {
- ERR_PRINT("Compiler bug: unresolved return.");
- // Shouldn't get here, but fail-safe to a regular return;
- append_opcode(GDScriptFunction::OPCODE_RETURN);
- append(p_return_value);
- } break;
- }
- }
- }
- void GDScriptByteCodeGenerator::write_assert(const Address &p_test, const Address &p_message) {
- append_opcode(GDScriptFunction::OPCODE_ASSERT);
- append(p_test);
- append(p_message);
- }
- void GDScriptByteCodeGenerator::start_block() {
- push_stack_identifiers();
- }
- void GDScriptByteCodeGenerator::end_block() {
- pop_stack_identifiers();
- }
- void GDScriptByteCodeGenerator::clear_temporaries() {
- for (int slot_idx : temporaries_pending_clear) {
- // The temporary may have been reused as something else since it was added to the list.
- // In that case, there's **no** need to clear it.
- if (temporaries[slot_idx].can_contain_object) {
- clear_address(Address(Address::TEMPORARY, slot_idx)); // Can contain `RefCounted`, so clear it.
- }
- }
- temporaries_pending_clear.clear();
- }
- void GDScriptByteCodeGenerator::clear_address(const Address &p_address) {
- // Do not check `is_local_dirty()` here! Always clear the address since the codegen doesn't track the compiler.
- // Also, this method is used to initialize local variables of built-in types, since they cannot be `null`.
- if (p_address.type.has_type && p_address.type.kind == GDScriptDataType::BUILTIN) {
- switch (p_address.type.builtin_type) {
- case Variant::BOOL:
- write_assign_false(p_address);
- break;
- case Variant::DICTIONARY:
- if (p_address.type.has_container_element_types()) {
- write_construct_typed_dictionary(p_address, p_address.type.get_container_element_type_or_variant(0), p_address.type.get_container_element_type_or_variant(1), Vector<GDScriptCodeGenerator::Address>());
- } else {
- write_construct(p_address, p_address.type.builtin_type, Vector<GDScriptCodeGenerator::Address>());
- }
- break;
- case Variant::ARRAY:
- if (p_address.type.has_container_element_type(0)) {
- write_construct_typed_array(p_address, p_address.type.get_container_element_type(0), Vector<GDScriptCodeGenerator::Address>());
- } else {
- write_construct(p_address, p_address.type.builtin_type, Vector<GDScriptCodeGenerator::Address>());
- }
- break;
- case Variant::NIL:
- case Variant::OBJECT:
- write_assign_null(p_address);
- break;
- default:
- write_construct(p_address, p_address.type.builtin_type, Vector<GDScriptCodeGenerator::Address>());
- break;
- }
- } else {
- write_assign_null(p_address);
- }
- if (p_address.mode == Address::LOCAL_VARIABLE) {
- dirty_locals.erase(p_address.address);
- }
- }
- // Returns `true` if the local has been reused and not cleaned up with `clear_address()`.
- bool GDScriptByteCodeGenerator::is_local_dirty(const Address &p_address) const {
- ERR_FAIL_COND_V(p_address.mode != Address::LOCAL_VARIABLE, false);
- return dirty_locals.has(p_address.address);
- }
- GDScriptByteCodeGenerator::~GDScriptByteCodeGenerator() {
- if (!ended && function != nullptr) {
- memdelete(function);
- }
- }
|