2023-01-05 12:25:55 +00:00
|
|
|
/**************************************************************************/
|
|
|
|
/* gdscript_compiler.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* 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. */
|
|
|
|
/**************************************************************************/
|
2018-01-04 23:50:27 +00:00
|
|
|
|
2017-11-16 17:38:18 +00:00
|
|
|
#ifndef GDSCRIPT_COMPILER_H
|
|
|
|
#define GDSCRIPT_COMPILER_H
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2017-11-16 17:38:18 +00:00
|
|
|
#include "gdscript.h"
|
2020-08-07 17:51:56 +00:00
|
|
|
#include "gdscript_codegen.h"
|
2020-05-01 22:14:56 +00:00
|
|
|
#include "gdscript_function.h"
|
2017-11-16 17:38:18 +00:00
|
|
|
#include "gdscript_parser.h"
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2023-06-13 14:56:21 +00:00
|
|
|
#include "core/templates/hash_set.h"
|
|
|
|
|
2017-11-16 17:38:18 +00:00
|
|
|
class GDScriptCompiler {
|
2020-08-07 17:51:56 +00:00
|
|
|
const GDScriptParser *parser = nullptr;
|
2022-05-19 15:00:06 +00:00
|
|
|
HashSet<GDScript *> parsed_classes;
|
|
|
|
HashSet<GDScript *> parsing_classes;
|
2020-08-07 17:51:56 +00:00
|
|
|
GDScript *main_script = nullptr;
|
|
|
|
|
2023-09-13 07:40:48 +00:00
|
|
|
struct FunctionLambdaInfo {
|
2023-12-27 20:05:20 +00:00
|
|
|
GDScriptFunction *function = nullptr;
|
|
|
|
GDScriptFunction *parent = nullptr;
|
|
|
|
GDScript *script = nullptr;
|
2023-09-13 07:40:48 +00:00
|
|
|
StringName name;
|
2023-12-27 20:05:20 +00:00
|
|
|
int line = 0;
|
|
|
|
int index = 0;
|
|
|
|
int depth = 0;
|
2023-09-13 07:40:48 +00:00
|
|
|
//uint64_t code_hash;
|
|
|
|
//int code_size;
|
2023-12-27 20:05:20 +00:00
|
|
|
int capture_count = 0;
|
|
|
|
bool use_self = false;
|
|
|
|
int arg_count = 0;
|
|
|
|
int default_arg_count = 0;
|
2023-09-13 07:40:48 +00:00
|
|
|
//Vector<GDScriptDataType> argument_types;
|
|
|
|
//GDScriptDataType return_type;
|
|
|
|
Vector<FunctionLambdaInfo> sublambdas;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ScriptLambdaInfo {
|
|
|
|
Vector<FunctionLambdaInfo> implicit_initializer_info;
|
|
|
|
Vector<FunctionLambdaInfo> implicit_ready_info;
|
|
|
|
Vector<FunctionLambdaInfo> static_initializer_info;
|
|
|
|
HashMap<StringName, Vector<FunctionLambdaInfo>> member_function_infos;
|
|
|
|
Vector<FunctionLambdaInfo> other_function_infos;
|
|
|
|
HashMap<StringName, ScriptLambdaInfo> subclass_info;
|
|
|
|
};
|
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
struct CodeGen {
|
2020-08-07 17:51:56 +00:00
|
|
|
GDScript *script = nullptr;
|
|
|
|
const GDScriptParser::ClassNode *class_node = nullptr;
|
|
|
|
const GDScriptParser::FunctionNode *function_node = nullptr;
|
2020-06-01 19:41:05 +00:00
|
|
|
StringName function_name;
|
2020-08-07 17:51:56 +00:00
|
|
|
GDScriptCodeGenerator *generator = nullptr;
|
2022-05-13 13:04:37 +00:00
|
|
|
HashMap<StringName, GDScriptCodeGenerator::Address> parameters;
|
|
|
|
HashMap<StringName, GDScriptCodeGenerator::Address> locals;
|
|
|
|
List<HashMap<StringName, GDScriptCodeGenerator::Address>> locals_stack;
|
2023-04-19 14:10:35 +00:00
|
|
|
bool is_static = false;
|
2020-08-07 17:51:56 +00:00
|
|
|
|
|
|
|
GDScriptCodeGenerator::Address add_local(const StringName &p_name, const GDScriptDataType &p_type) {
|
|
|
|
uint32_t addr = generator->add_local(p_name, p_type);
|
|
|
|
locals[p_name] = GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::LOCAL_VARIABLE, addr, p_type);
|
|
|
|
return locals[p_name];
|
2017-03-05 15:44:50 +00:00
|
|
|
}
|
2015-01-14 15:37:24 +00:00
|
|
|
|
2020-08-07 17:51:56 +00:00
|
|
|
GDScriptCodeGenerator::Address add_local_constant(const StringName &p_name, const Variant &p_value) {
|
|
|
|
uint32_t addr = generator->add_local_constant(p_name, p_value);
|
2021-04-08 14:55:24 +00:00
|
|
|
locals[p_name] = GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::CONSTANT, addr);
|
2020-08-07 17:51:56 +00:00
|
|
|
return locals[p_name];
|
2017-03-05 15:44:50 +00:00
|
|
|
}
|
|
|
|
|
2020-08-07 17:51:56 +00:00
|
|
|
GDScriptCodeGenerator::Address add_temporary(const GDScriptDataType &p_type = GDScriptDataType()) {
|
2021-04-14 17:35:51 +00:00
|
|
|
uint32_t addr = generator->add_temporary(p_type);
|
2020-08-07 17:51:56 +00:00
|
|
|
return GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::TEMPORARY, addr, p_type);
|
2017-03-05 15:44:50 +00:00
|
|
|
}
|
2015-01-14 15:37:24 +00:00
|
|
|
|
2020-08-07 17:51:56 +00:00
|
|
|
GDScriptCodeGenerator::Address add_constant(const Variant &p_constant) {
|
|
|
|
GDScriptDataType type;
|
|
|
|
type.has_type = true;
|
|
|
|
type.kind = GDScriptDataType::BUILTIN;
|
|
|
|
type.builtin_type = p_constant.get_type();
|
|
|
|
if (type.builtin_type == Variant::OBJECT) {
|
|
|
|
Object *obj = p_constant;
|
|
|
|
if (obj) {
|
|
|
|
type.kind = GDScriptDataType::NATIVE;
|
|
|
|
type.native_type = obj->get_class_name();
|
|
|
|
|
2022-09-29 09:53:28 +00:00
|
|
|
Ref<Script> scr = obj->get_script();
|
|
|
|
if (scr.is_valid()) {
|
|
|
|
type.script_type = scr.ptr();
|
|
|
|
Ref<GDScript> gdscript = scr;
|
2020-08-07 17:51:56 +00:00
|
|
|
if (gdscript.is_valid()) {
|
|
|
|
type.kind = GDScriptDataType::GDSCRIPT;
|
|
|
|
} else {
|
|
|
|
type.kind = GDScriptDataType::SCRIPT;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
type.builtin_type = Variant::NIL;
|
|
|
|
}
|
2014-02-10 01:10:30 +00:00
|
|
|
}
|
|
|
|
|
2020-08-07 17:51:56 +00:00
|
|
|
uint32_t addr = generator->add_or_get_constant(p_constant);
|
|
|
|
return GDScriptCodeGenerator::Address(GDScriptCodeGenerator::Address::CONSTANT, addr, type);
|
2014-02-10 01:10:30 +00:00
|
|
|
}
|
|
|
|
|
2020-08-07 17:51:56 +00:00
|
|
|
void start_block() {
|
2022-05-13 13:04:37 +00:00
|
|
|
HashMap<StringName, GDScriptCodeGenerator::Address> old_locals = locals;
|
2020-10-20 17:34:14 +00:00
|
|
|
locals_stack.push_back(old_locals);
|
2020-08-07 17:51:56 +00:00
|
|
|
generator->start_block();
|
2017-03-05 15:44:50 +00:00
|
|
|
}
|
2020-08-07 17:51:56 +00:00
|
|
|
|
|
|
|
void end_block() {
|
2020-10-20 17:34:14 +00:00
|
|
|
locals = locals_stack.back()->get();
|
|
|
|
locals_stack.pop_back();
|
2020-08-07 17:51:56 +00:00
|
|
|
generator->end_block();
|
2017-03-05 15:44:50 +00:00
|
|
|
}
|
2014-02-10 01:10:30 +00:00
|
|
|
};
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
bool _is_class_member_property(CodeGen &codegen, const StringName &p_name);
|
|
|
|
bool _is_class_member_property(GDScript *owner, const StringName &p_name);
|
2022-12-05 18:24:11 +00:00
|
|
|
bool _is_local_or_parameter(CodeGen &codegen, const StringName &p_name);
|
2017-01-04 20:37:45 +00:00
|
|
|
|
2017-11-16 17:38:18 +00:00
|
|
|
void _set_error(const String &p_error, const GDScriptParser::Node *p_node);
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2023-09-12 18:55:55 +00:00
|
|
|
GDScriptDataType _gdtype_from_datatype(const GDScriptParser::DataType &p_datatype, GDScript *p_owner, bool p_handle_metatype = true);
|
2018-05-30 02:16:57 +00:00
|
|
|
|
2024-02-27 10:25:33 +00:00
|
|
|
GDScriptCodeGenerator::Address _parse_expression(CodeGen &codegen, Error &r_error, const GDScriptParser::ExpressionNode *p_expression, bool p_root = false, bool p_initializer = false);
|
2020-08-07 17:51:56 +00:00
|
|
|
GDScriptCodeGenerator::Address _parse_match_pattern(CodeGen &codegen, Error &r_error, const GDScriptParser::PatternNode *p_pattern, const GDScriptCodeGenerator::Address &p_value_addr, const GDScriptCodeGenerator::Address &p_type_addr, const GDScriptCodeGenerator::Address &p_previous_test, bool p_is_first, bool p_is_nested);
|
2023-06-01 18:46:37 +00:00
|
|
|
List<GDScriptCodeGenerator::Address> _add_locals_in_block(CodeGen &codegen, const GDScriptParser::SuiteNode *p_block);
|
|
|
|
void _clear_addresses(CodeGen &codegen, const List<GDScriptCodeGenerator::Address> &p_addresses);
|
|
|
|
Error _parse_block(CodeGen &codegen, const GDScriptParser::SuiteNode *p_block, bool p_add_locals = true, bool p_reset_locals = true);
|
2021-03-28 14:03:13 +00:00
|
|
|
GDScriptFunction *_parse_function(Error &r_error, GDScript *p_script, const GDScriptParser::ClassNode *p_class, const GDScriptParser::FunctionNode *p_func, bool p_for_ready = false, bool p_for_lambda = false);
|
2023-04-19 14:10:35 +00:00
|
|
|
GDScriptFunction *_make_static_initializer(Error &r_error, GDScript *p_script, const GDScriptParser::ClassNode *p_class);
|
2020-06-01 19:41:05 +00:00
|
|
|
Error _parse_setter_getter(GDScript *p_script, const GDScriptParser::ClassNode *p_class, const GDScriptParser::VariableNode *p_variable, bool p_is_setter);
|
2023-08-31 17:49:04 +00:00
|
|
|
Error _prepare_compilation(GDScript *p_script, const GDScriptParser::ClassNode *p_class, bool p_keep_state);
|
2022-11-08 11:51:20 +00:00
|
|
|
Error _compile_class(GDScript *p_script, const GDScriptParser::ClassNode *p_class, bool p_keep_state);
|
2023-09-13 07:40:48 +00:00
|
|
|
FunctionLambdaInfo _get_function_replacement_info(GDScriptFunction *p_func, int p_index = -1, int p_depth = 0, GDScriptFunction *p_parent_func = nullptr);
|
|
|
|
Vector<FunctionLambdaInfo> _get_function_lambda_replacement_info(GDScriptFunction *p_func, int p_depth = 0, GDScriptFunction *p_parent_func = nullptr);
|
|
|
|
ScriptLambdaInfo _get_script_lambda_replacement_info(GDScript *p_script);
|
|
|
|
bool _do_function_infos_match(const FunctionLambdaInfo &p_old_info, const FunctionLambdaInfo *p_new_info);
|
|
|
|
void _get_function_ptr_replacements(HashMap<GDScriptFunction *, GDScriptFunction *> &r_replacements, const FunctionLambdaInfo &p_old_info, const FunctionLambdaInfo *p_new_info);
|
|
|
|
void _get_function_ptr_replacements(HashMap<GDScriptFunction *, GDScriptFunction *> &r_replacements, const Vector<FunctionLambdaInfo> &p_old_infos, const Vector<FunctionLambdaInfo> *p_new_infos);
|
|
|
|
void _get_function_ptr_replacements(HashMap<GDScriptFunction *, GDScriptFunction *> &r_replacements, const ScriptLambdaInfo &p_old_info, const ScriptLambdaInfo *p_new_info);
|
2021-02-08 09:57:18 +00:00
|
|
|
int err_line = 0;
|
|
|
|
int err_column = 0;
|
2014-02-10 01:10:30 +00:00
|
|
|
StringName source;
|
|
|
|
String error;
|
2023-03-01 06:47:09 +00:00
|
|
|
GDScriptParser::ExpressionNode *awaited_node = nullptr;
|
2023-04-19 14:10:35 +00:00
|
|
|
bool has_static_data = false;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
public:
|
2022-11-30 21:14:24 +00:00
|
|
|
static void convert_to_initializer_type(Variant &p_variant, const GDScriptParser::VariableNode *p_node);
|
2022-11-08 11:51:20 +00:00
|
|
|
static void make_scripts(GDScript *p_script, const GDScriptParser::ClassNode *p_class, bool p_keep_state);
|
2018-11-24 22:46:13 +00:00
|
|
|
Error compile(const GDScriptParser *p_parser, GDScript *p_script, bool p_keep_state = false);
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
String get_error() const;
|
|
|
|
int get_error_line() const;
|
|
|
|
int get_error_column() const;
|
|
|
|
|
2017-11-16 17:38:18 +00:00
|
|
|
GDScriptCompiler();
|
2014-02-10 01:10:30 +00:00
|
|
|
};
|
|
|
|
|
2017-11-16 17:38:18 +00:00
|
|
|
#endif // GDSCRIPT_COMPILER_H
|