d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
139 lines
9.5 KiB
C++
139 lines
9.5 KiB
C++
/**************************************************************************/
|
|
/* gdscript_analyzer.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. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef GDSCRIPT_ANALYZER_H
|
|
#define GDSCRIPT_ANALYZER_H
|
|
|
|
#include "core/object/object.h"
|
|
#include "core/object/ref_counted.h"
|
|
#include "core/templates/hash_set.h"
|
|
#include "gdscript_cache.h"
|
|
#include "gdscript_parser.h"
|
|
|
|
class GDScriptAnalyzer {
|
|
GDScriptParser *parser = nullptr;
|
|
HashMap<String, Ref<GDScriptParserRef>> depended_parsers;
|
|
|
|
const GDScriptParser::EnumNode *current_enum = nullptr;
|
|
List<GDScriptParser::LambdaNode *> lambda_stack;
|
|
|
|
// Tests for detecting invalid overloading of script members
|
|
static _FORCE_INLINE_ bool has_member_name_conflict_in_script_class(const StringName &p_name, const GDScriptParser::ClassNode *p_current_class_node, const GDScriptParser::Node *p_member);
|
|
static _FORCE_INLINE_ bool has_member_name_conflict_in_native_type(const StringName &p_name, const StringName &p_native_type_string);
|
|
Error check_native_member_name_conflict(const StringName &p_member_name, const GDScriptParser::Node *p_member_node, const StringName &p_native_type_string);
|
|
Error check_class_member_name_conflict(const GDScriptParser::ClassNode *p_class_node, const StringName &p_member_name, const GDScriptParser::Node *p_member_node);
|
|
|
|
void get_class_node_current_scope_classes(GDScriptParser::ClassNode *p_node, List<GDScriptParser::ClassNode *> *p_list);
|
|
|
|
Error resolve_class_inheritance(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source = nullptr);
|
|
Error resolve_class_inheritance(GDScriptParser::ClassNode *p_class, bool p_recursive);
|
|
GDScriptParser::DataType resolve_datatype(GDScriptParser::TypeNode *p_type);
|
|
|
|
void decide_suite_type(GDScriptParser::Node *p_suite, GDScriptParser::Node *p_statement);
|
|
|
|
void resolve_annotation(GDScriptParser::AnnotationNode *p_annotation);
|
|
void resolve_class_member(GDScriptParser::ClassNode *p_class, StringName p_name, const GDScriptParser::Node *p_source = nullptr);
|
|
void resolve_class_member(GDScriptParser::ClassNode *p_class, int p_index, const GDScriptParser::Node *p_source = nullptr);
|
|
void resolve_class_interface(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source = nullptr);
|
|
void resolve_class_interface(GDScriptParser::ClassNode *p_class, bool p_recursive);
|
|
void resolve_class_body(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source = nullptr);
|
|
void resolve_class_body(GDScriptParser::ClassNode *p_class, bool p_recursive);
|
|
void resolve_function_signature(GDScriptParser::FunctionNode *p_function, const GDScriptParser::Node *p_source = nullptr);
|
|
void resolve_function_body(GDScriptParser::FunctionNode *p_function);
|
|
void resolve_node(GDScriptParser::Node *p_node, bool p_is_root = true);
|
|
void resolve_suite(GDScriptParser::SuiteNode *p_suite);
|
|
void resolve_if(GDScriptParser::IfNode *p_if);
|
|
void resolve_for(GDScriptParser::ForNode *p_for);
|
|
void resolve_while(GDScriptParser::WhileNode *p_while);
|
|
void resolve_variable(GDScriptParser::VariableNode *p_variable);
|
|
void resolve_constant(GDScriptParser::ConstantNode *p_constant);
|
|
void resolve_assert(GDScriptParser::AssertNode *p_assert);
|
|
void resolve_match(GDScriptParser::MatchNode *p_match);
|
|
void resolve_match_branch(GDScriptParser::MatchBranchNode *p_match_branch, GDScriptParser::ExpressionNode *p_match_test);
|
|
void resolve_match_pattern(GDScriptParser::PatternNode *p_match_pattern, GDScriptParser::ExpressionNode *p_match_test);
|
|
void resolve_parameter(GDScriptParser::ParameterNode *p_parameter);
|
|
void resolve_return(GDScriptParser::ReturnNode *p_return);
|
|
|
|
// Reduction functions.
|
|
void reduce_expression(GDScriptParser::ExpressionNode *p_expression, bool p_is_root = false);
|
|
void reduce_array(GDScriptParser::ArrayNode *p_array);
|
|
void reduce_assignment(GDScriptParser::AssignmentNode *p_assignment);
|
|
void reduce_await(GDScriptParser::AwaitNode *p_await);
|
|
void reduce_binary_op(GDScriptParser::BinaryOpNode *p_binary_op);
|
|
void reduce_call(GDScriptParser::CallNode *p_call, bool p_is_await = false, bool p_is_root = false);
|
|
void reduce_cast(GDScriptParser::CastNode *p_cast);
|
|
void reduce_dictionary(GDScriptParser::DictionaryNode *p_dictionary);
|
|
void reduce_get_node(GDScriptParser::GetNodeNode *p_get_node);
|
|
void reduce_identifier(GDScriptParser::IdentifierNode *p_identifier, bool can_be_builtin = false);
|
|
void reduce_identifier_from_base(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType *p_base = nullptr);
|
|
void reduce_lambda(GDScriptParser::LambdaNode *p_lambda);
|
|
void reduce_literal(GDScriptParser::LiteralNode *p_literal);
|
|
void reduce_preload(GDScriptParser::PreloadNode *p_preload);
|
|
void reduce_self(GDScriptParser::SelfNode *p_self);
|
|
void reduce_subscript(GDScriptParser::SubscriptNode *p_subscript);
|
|
void reduce_ternary_op(GDScriptParser::TernaryOpNode *p_ternary_op);
|
|
void reduce_unary_op(GDScriptParser::UnaryOpNode *p_unary_op);
|
|
|
|
void const_fold_array(GDScriptParser::ArrayNode *p_array);
|
|
void const_fold_dictionary(GDScriptParser::DictionaryNode *p_dictionary);
|
|
|
|
// Helpers.
|
|
GDScriptParser::DataType type_from_variant(const Variant &p_value, const GDScriptParser::Node *p_source);
|
|
GDScriptParser::DataType type_from_metatype(const GDScriptParser::DataType &p_meta_type) const;
|
|
GDScriptParser::DataType type_from_property(const PropertyInfo &p_property) const;
|
|
GDScriptParser::DataType make_global_class_meta_type(const StringName &p_class_name, const GDScriptParser::Node *p_source);
|
|
bool get_function_signature(GDScriptParser::Node *p_source, bool p_is_constructor, GDScriptParser::DataType base_type, const StringName &p_function, GDScriptParser::DataType &r_return_type, List<GDScriptParser::DataType> &r_par_types, int &r_default_arg_count, bool &r_static, bool &r_vararg);
|
|
bool function_signature_from_info(const MethodInfo &p_info, GDScriptParser::DataType &r_return_type, List<GDScriptParser::DataType> &r_par_types, int &r_default_arg_count, bool &r_static, bool &r_vararg);
|
|
bool validate_call_arg(const List<GDScriptParser::DataType> &p_par_types, int p_default_args_count, bool p_is_vararg, const GDScriptParser::CallNode *p_call);
|
|
bool validate_call_arg(const MethodInfo &p_method, const GDScriptParser::CallNode *p_call);
|
|
GDScriptParser::DataType get_operation_type(Variant::Operator p_operation, const GDScriptParser::DataType &p_a, const GDScriptParser::DataType &p_b, bool &r_valid, const GDScriptParser::Node *p_source);
|
|
GDScriptParser::DataType get_operation_type(Variant::Operator p_operation, const GDScriptParser::DataType &p_a, bool &r_valid, const GDScriptParser::Node *p_source);
|
|
void update_array_literal_element_type(const GDScriptParser::DataType &p_base_type, GDScriptParser::ArrayNode *p_array_literal);
|
|
bool is_type_compatible(const GDScriptParser::DataType &p_target, const GDScriptParser::DataType &p_source, bool p_allow_implicit_conversion = false, const GDScriptParser::Node *p_source_node = nullptr);
|
|
void push_error(const String &p_message, const GDScriptParser::Node *p_origin = nullptr);
|
|
void mark_node_unsafe(const GDScriptParser::Node *p_node);
|
|
void mark_lambda_use_self();
|
|
bool class_exists(const StringName &p_class) const;
|
|
Ref<GDScriptParserRef> get_parser_for(const String &p_path);
|
|
#ifdef DEBUG_ENABLED
|
|
bool is_shadowing(GDScriptParser::IdentifierNode *p_local, const String &p_context);
|
|
#endif
|
|
|
|
public:
|
|
Error resolve_inheritance();
|
|
Error resolve_interface();
|
|
Error resolve_body();
|
|
Error resolve_dependencies();
|
|
Error analyze();
|
|
|
|
GDScriptAnalyzer(GDScriptParser *p_parser);
|
|
};
|
|
|
|
#endif // GDSCRIPT_ANALYZER_H
|