gdscript_analyzer.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  1. /**************************************************************************/
  2. /* gdscript_analyzer.h */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #ifndef GDSCRIPT_ANALYZER_H
  31. #define GDSCRIPT_ANALYZER_H
  32. #include "gdscript_cache.h"
  33. #include "gdscript_parser.h"
  34. #include "core/object/object.h"
  35. #include "core/object/ref_counted.h"
  36. class GDScriptAnalyzer {
  37. GDScriptParser *parser = nullptr;
  38. template <typename Fn>
  39. class Finally {
  40. Fn fn;
  41. public:
  42. Finally(Fn p_fn) :
  43. fn(p_fn) {}
  44. ~Finally() {
  45. fn();
  46. }
  47. };
  48. const GDScriptParser::EnumNode *current_enum = nullptr;
  49. GDScriptParser::LambdaNode *current_lambda = nullptr;
  50. List<GDScriptParser::LambdaNode *> pending_body_resolution_lambdas;
  51. HashMap<const GDScriptParser::ClassNode *, Ref<GDScriptParserRef>> external_class_parser_cache;
  52. bool static_context = false;
  53. // Tests for detecting invalid overloading of script members
  54. 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);
  55. static _FORCE_INLINE_ bool has_member_name_conflict_in_native_type(const StringName &p_name, const StringName &p_native_type_string);
  56. Error check_native_member_name_conflict(const StringName &p_member_name, const GDScriptParser::Node *p_member_node, const StringName &p_native_type_string);
  57. Error check_class_member_name_conflict(const GDScriptParser::ClassNode *p_class_node, const StringName &p_member_name, const GDScriptParser::Node *p_member_node);
  58. void get_class_node_current_scope_classes(GDScriptParser::ClassNode *p_node, List<GDScriptParser::ClassNode *> *p_list, GDScriptParser::Node *p_source);
  59. Error resolve_class_inheritance(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source = nullptr);
  60. Error resolve_class_inheritance(GDScriptParser::ClassNode *p_class, bool p_recursive);
  61. GDScriptParser::DataType resolve_datatype(GDScriptParser::TypeNode *p_type);
  62. void decide_suite_type(GDScriptParser::Node *p_suite, GDScriptParser::Node *p_statement);
  63. void resolve_annotation(GDScriptParser::AnnotationNode *p_annotation);
  64. void resolve_class_member(GDScriptParser::ClassNode *p_class, const StringName &p_name, const GDScriptParser::Node *p_source = nullptr);
  65. void resolve_class_member(GDScriptParser::ClassNode *p_class, int p_index, const GDScriptParser::Node *p_source = nullptr);
  66. void resolve_class_interface(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source = nullptr);
  67. void resolve_class_interface(GDScriptParser::ClassNode *p_class, bool p_recursive);
  68. void resolve_class_body(GDScriptParser::ClassNode *p_class, const GDScriptParser::Node *p_source = nullptr);
  69. void resolve_class_body(GDScriptParser::ClassNode *p_class, bool p_recursive);
  70. void resolve_function_signature(GDScriptParser::FunctionNode *p_function, const GDScriptParser::Node *p_source = nullptr, bool p_is_lambda = false);
  71. void resolve_function_body(GDScriptParser::FunctionNode *p_function, bool p_is_lambda = false);
  72. void resolve_node(GDScriptParser::Node *p_node, bool p_is_root = true);
  73. void resolve_suite(GDScriptParser::SuiteNode *p_suite);
  74. void resolve_assignable(GDScriptParser::AssignableNode *p_assignable, const char *p_kind);
  75. void resolve_variable(GDScriptParser::VariableNode *p_variable, bool p_is_local);
  76. void resolve_constant(GDScriptParser::ConstantNode *p_constant, bool p_is_local);
  77. void resolve_parameter(GDScriptParser::ParameterNode *p_parameter);
  78. void resolve_if(GDScriptParser::IfNode *p_if);
  79. void resolve_for(GDScriptParser::ForNode *p_for);
  80. void resolve_while(GDScriptParser::WhileNode *p_while);
  81. void resolve_assert(GDScriptParser::AssertNode *p_assert);
  82. void resolve_match(GDScriptParser::MatchNode *p_match);
  83. void resolve_match_branch(GDScriptParser::MatchBranchNode *p_match_branch, GDScriptParser::ExpressionNode *p_match_test);
  84. void resolve_match_pattern(GDScriptParser::PatternNode *p_match_pattern, GDScriptParser::ExpressionNode *p_match_test);
  85. void resolve_return(GDScriptParser::ReturnNode *p_return);
  86. // Reduction functions.
  87. void reduce_expression(GDScriptParser::ExpressionNode *p_expression, bool p_is_root = false);
  88. void reduce_array(GDScriptParser::ArrayNode *p_array);
  89. void reduce_assignment(GDScriptParser::AssignmentNode *p_assignment);
  90. void reduce_await(GDScriptParser::AwaitNode *p_await);
  91. void reduce_binary_op(GDScriptParser::BinaryOpNode *p_binary_op);
  92. void reduce_call(GDScriptParser::CallNode *p_call, bool p_is_await = false, bool p_is_root = false);
  93. void reduce_cast(GDScriptParser::CastNode *p_cast);
  94. void reduce_dictionary(GDScriptParser::DictionaryNode *p_dictionary);
  95. void reduce_get_node(GDScriptParser::GetNodeNode *p_get_node);
  96. void reduce_identifier(GDScriptParser::IdentifierNode *p_identifier, bool can_be_builtin = false);
  97. void reduce_identifier_from_base(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType *p_base = nullptr);
  98. void reduce_lambda(GDScriptParser::LambdaNode *p_lambda);
  99. void reduce_literal(GDScriptParser::LiteralNode *p_literal);
  100. void reduce_preload(GDScriptParser::PreloadNode *p_preload);
  101. void reduce_self(GDScriptParser::SelfNode *p_self);
  102. void reduce_subscript(GDScriptParser::SubscriptNode *p_subscript, bool p_can_be_pseudo_type = false);
  103. void reduce_ternary_op(GDScriptParser::TernaryOpNode *p_ternary_op, bool p_is_root = false);
  104. void reduce_type_test(GDScriptParser::TypeTestNode *p_type_test);
  105. void reduce_unary_op(GDScriptParser::UnaryOpNode *p_unary_op);
  106. Variant make_expression_reduced_value(GDScriptParser::ExpressionNode *p_expression, bool &is_reduced);
  107. Variant make_array_reduced_value(GDScriptParser::ArrayNode *p_array, bool &is_reduced);
  108. Variant make_dictionary_reduced_value(GDScriptParser::DictionaryNode *p_dictionary, bool &is_reduced);
  109. Variant make_subscript_reduced_value(GDScriptParser::SubscriptNode *p_subscript, bool &is_reduced);
  110. // Helpers.
  111. Array make_array_from_element_datatype(const GDScriptParser::DataType &p_element_datatype, const GDScriptParser::Node *p_source_node = nullptr);
  112. Dictionary make_dictionary_from_element_datatype(const GDScriptParser::DataType &p_key_element_datatype, const GDScriptParser::DataType &p_value_element_datatype, const GDScriptParser::Node *p_source_node = nullptr);
  113. GDScriptParser::DataType type_from_variant(const Variant &p_value, const GDScriptParser::Node *p_source);
  114. GDScriptParser::DataType type_from_property(const PropertyInfo &p_property, bool p_is_arg = false, bool p_is_readonly = false) const;
  115. GDScriptParser::DataType make_global_class_meta_type(const StringName &p_class_name, const GDScriptParser::Node *p_source);
  116. 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, BitField<MethodFlags> &r_method_flags, StringName *r_native_class = nullptr);
  117. 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, BitField<MethodFlags> &r_method_flags);
  118. void validate_call_arg(const List<GDScriptParser::DataType> &p_par_types, int p_default_args_count, bool p_is_vararg, const GDScriptParser::CallNode *p_call);
  119. void validate_call_arg(const MethodInfo &p_method, const GDScriptParser::CallNode *p_call);
  120. 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);
  121. GDScriptParser::DataType get_operation_type(Variant::Operator p_operation, const GDScriptParser::DataType &p_a, bool &r_valid, const GDScriptParser::Node *p_source);
  122. void update_const_expression_builtin_type(GDScriptParser::ExpressionNode *p_expression, const GDScriptParser::DataType &p_type, const char *p_usage, bool p_is_cast = false);
  123. void update_array_literal_element_type(GDScriptParser::ArrayNode *p_array, const GDScriptParser::DataType &p_element_type);
  124. void update_dictionary_literal_element_type(GDScriptParser::DictionaryNode *p_dictionary, const GDScriptParser::DataType &p_key_element_type, const GDScriptParser::DataType &p_value_element_type);
  125. 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);
  126. void push_error(const String &p_message, const GDScriptParser::Node *p_origin = nullptr);
  127. void mark_node_unsafe(const GDScriptParser::Node *p_node);
  128. void downgrade_node_type_source(GDScriptParser::Node *p_node);
  129. void mark_lambda_use_self();
  130. void resolve_pending_lambda_bodies();
  131. bool class_exists(const StringName &p_class) const;
  132. void reduce_identifier_from_base_set_class(GDScriptParser::IdentifierNode *p_identifier, GDScriptParser::DataType p_identifier_datatype);
  133. Ref<GDScriptParserRef> ensure_cached_external_parser_for_class(const GDScriptParser::ClassNode *p_class, const GDScriptParser::ClassNode *p_from_class, const char *p_context, const GDScriptParser::Node *p_source);
  134. Ref<GDScriptParserRef> find_cached_external_parser_for_class(const GDScriptParser::ClassNode *p_class, const Ref<GDScriptParserRef> &p_dependant_parser);
  135. Ref<GDScriptParserRef> find_cached_external_parser_for_class(const GDScriptParser::ClassNode *p_class, GDScriptParser *p_dependant_parser);
  136. Ref<GDScript> get_depended_shallow_script(const String &p_path, Error &r_error);
  137. #ifdef DEBUG_ENABLED
  138. void is_shadowing(GDScriptParser::IdentifierNode *p_identifier, const String &p_context, const bool p_in_local_scope);
  139. #endif
  140. public:
  141. Error resolve_inheritance();
  142. Error resolve_interface();
  143. Error resolve_body();
  144. Error resolve_dependencies();
  145. Error analyze();
  146. Variant make_variable_default_value(GDScriptParser::VariableNode *p_variable);
  147. static bool check_type_compatibility(const GDScriptParser::DataType &p_target, const GDScriptParser::DataType &p_source, bool p_allow_implicit_conversion = false, const GDScriptParser::Node *p_source_node = nullptr);
  148. static GDScriptParser::DataType type_from_metatype(const GDScriptParser::DataType &p_meta_type);
  149. GDScriptAnalyzer(GDScriptParser *p_parser);
  150. };
  151. #endif // GDSCRIPT_ANALYZER_H