definition_builder.rbs in rbs-3.0.0.dev.1

- old
+ new

@@ -1,114 +1,43 @@
 module RBS
   # DefinitionBuilder translates TypeName to Definition of the type
   #
-  # The translation goes three steps:
+  # It also provides semantic utilities that depends on Environment.
   #
-  # 1. Calculate _ancestors_ of the type with AncestorBuilder
-  # 2. Calculate _partial_ definitions of each ancestor
-  # 3. Merge _partial_ definitions
-  #
-  # A _partial_ definition is a definition of one type name, in terms of it doesn't have methods of super classes nor included modules.
-  #
-  #
   class DefinitionBuilder
     attr_reader env: Environment
     attr_reader type_name_resolver: TypeNameResolver
     attr_reader ancestor_builder: AncestorBuilder
     attr_reader method_builder: MethodBuilder
 
-    attr_reader instance_cache: Hash[[TypeName, bool], Definition | false | nil]
+    attr_reader instance_cache: Hash[TypeName, Definition | false | nil]
     attr_reader singleton_cache: Hash[TypeName, Definition | false | nil]
     attr_reader singleton0_cache: Hash[TypeName, Definition | false | nil]
     attr_reader interface_cache: Hash[TypeName, Definition | false | nil]
 
     def initialize: (env: Environment, ?ancestor_builder: AncestorBuilder?, ?method_builder: MethodBuilder?) -> void
 
+    # Returns a Definition of a interface
+    #
     def build_interface: (TypeName) -> Definition
 
-    # Returns a Definition of a instance of given type name.
+    # Returns a Definition of an instance type
     #
     # If TypeName is a module and `no_self_types` is `true`, it won't have methods of _self type constraints_.
     # This typically happens when definition is being calculated for mixin.
     #
-    def build_instance: (TypeName, ?no_self_types: bool) -> Definition
+    def build_instance: (TypeName) -> Definition
 
+    # Returns a Definition of a singleton type
     def build_singleton: (TypeName) -> Definition
 
-    def validate_super_class!: (TypeName, Environment::ClassEntry) -> void
-
-    def ensure_namespace!: (Namespace, location: Location[untyped, untyped]?) -> void
-
-    def build_singleton0: (TypeName) -> Definition
-
-    def merge_definition: (src: Definition, dest: Definition, subst: Substitution, ?implemented_in: :keep | TypeName | nil, ?keep_super: bool) -> void
-
-    def merge_method: (TypeName, Hash[Symbol, Definition::Method], Symbol, Definition::Method, Substitution, ?implemented_in: :keep | TypeName | nil, ?keep_super: bool) -> void
-
-    def merge_variable: (Hash[Symbol, Definition::Variable], Symbol, Definition::Variable, Substitution, ?keep_super: bool) -> void
-
-    def try_cache: (TypeName, cache: Hash[TypeName, Definition | false | nil]) { () -> Definition } -> Definition
-                 | [A] (TypeName, cache: Hash[A, Definition | false | nil], key: A) { () -> Definition } -> Definition
-
-    def validate_params_with: (Array[AST::TypeParam], result: VarianceCalculator::Result) { (AST::TypeParam) -> void } -> void
-
-    def validate_type_params: (Definition, ancestors: AncestorBuilder::OneAncestors, methods: MethodBuilder::Methods) -> void
-
-    def source_location: (Definition::Ancestor::Instance::source, AST::Declarations::t) -> Location[untyped, untyped]?
-
-    def insert_variable: (TypeName, Hash[Symbol, Definition::Variable], name: Symbol, type: Types::t) -> void
-
-    # Add methods from `methods` to Definition
+    # Validates the given Namespace and its ancestor namespaces exists
     #
-    # * `methods`:
-    # * `interface_methods`: Methods of interfaces mixed into the type
-    # * `self_constraints_methods`: Methods of the self constraints methods
-    # * `super_interface_method`: `true` to have super method of existing method (`true` is the Definition is the target module)
+    # Raises NoTypeFoundError
     #
-    def define_methods: (
-      Definition,
-      methods: MethodBuilder::Methods,
-      interface_methods: Hash[Symbol, Definition::Method],
-      methods_with_self: Hash[Symbol, Definition::Method]?,
-      super_interface_method: bool
-    ) -> void
+    def ensure_namespace!: (Namespace, location: Location[untyped, untyped]?) -> void
 
-    # Define methods on singleton type
-    #
-    def define_methods_singleton: (
-      Definition,
-      methods: MethodBuilder::Methods,
-      interface_methods: Hash[Symbol, Definition::Method]
-    ) -> void
-
-    # Define methods on instance type
-    #
-    def define_methods_instance: (
-      Definition,
-      methods: MethodBuilder::Methods,
-      interface_methods: Hash[Symbol, Definition::Method]
-    ) -> void
-
-    # Define methods on module instance type
-    #
-    # * Pass `nil` to `module_self_methods:` to build a module instance type that will be mixed in to other modules/classes
-    # * Pass methods from self-type-constraints to build a module instance type alone (to type check itself)
-    #
-    def define_methods_module_instance: (
-      Definition,
-      methods: MethodBuilder::Methods,
-      interface_methods: Hash[Symbol, Definition::Method],
-      module_self_methods: Hash[Symbol, Definition::Method]?
-    ) -> void
-
-    # Validates presence of type names recursively.
-    # Assumes the type names are already resolved.
-    #
-    def validate_type_presence: (Types::t) -> void
-
-    def validate_type_name: (TypeName, Location[untyped, untyped]?) -> void
-
     # Expand a type alias of given name without type arguments.
     # Raises an error if the type alias requires arguments.
     #
     # Assume `type foo[T] = [T, T]`:
     #
@@ -136,8 +65,92 @@
     # expand_alias2("::foo", ["::Integer"])   # => [::Integer, ::Integer]
     # ```
     #
     def expand_alias2: (TypeName, Array[Types::t] args) -> Types::t
 
+    # Validates presence of type names recursively
+    #
+    # Assumes the type names are already resolved.
+    # Raises NoTypeFoundError in case of failure.
+    #
+    def validate_type_presence: (Types::t) -> void
+
+    # Validates presence of an absolute type name
+    #
+    # Raises NoTypeFoundError in case of error.
+    #
+    def validate_type_name: (TypeName, Location[untyped, untyped]?) -> void
+
+    # Returns a new DefinitionBuilder with updated Environment, AncestorBuilder, and exceptions
+    #
     def update: (env: Environment, ancestor_builder: AncestorBuilder, except: _Each[TypeName]) -> DefinitionBuilder
+
+    private
+
+    def validate_super_class!: (TypeName, Environment::ClassEntry) -> void
+
+    def build_singleton0: (TypeName) -> Definition
+
+    # Returns `interface_methods` from given array of interface ancestors
+    #
+    def interface_methods: (Array[Definition::Ancestor::Instance] interface_ancestors) -> interface_methods
+
+    def try_cache: (TypeName, cache: Hash[TypeName, Definition | false | nil]) { () -> Definition } -> Definition
+
+    def validate_params_with: (Array[AST::TypeParam], result: VarianceCalculator::Result) { (AST::TypeParam) -> void } -> void
+
+    def validate_type_params: (Definition, ancestors: AncestorBuilder::OneAncestors, methods: MethodBuilder::Methods) -> void
+
+    def source_location: (Definition::Ancestor::Instance::source, AST::Declarations::t) -> Location[untyped, untyped]?
+
+    def insert_variable: (TypeName, Hash[Symbol, Definition::Variable], name: Symbol, type: Types::t) -> void
+
+    # Add method definition to `methods`, which will be merged to `class_definition` after defining all methods at this *level* -- class, module, or interface
+    #
+    # `class_definition` is a definition of given type, but it has definitions of prior levels.
+    #
+    def define_method: (
+      Hash[Symbol, Definition::Method] methods,
+      Definition class_definition,
+      MethodBuilder::Methods::Definition method_definition,
+      Substitution subst,
+      defined_in: TypeName,
+      ?implemented_in: TypeName?
+    ) -> void
+
+    # The `interface_methods` type describes the association between the interface name to its name and the *mixin* to a module
+    #
+    type interface_methods = Hash[
+      Definition::Ancestor::Instance,
+      [MethodBuilder::Methods, AST::Members::Include | AST::Members::Extend]
+    ]
+
+    # Add method definitions from `module_methods` to `definition`
+    #
+    # It also processes interface mixins, with duplication detection.
+    # It doesn't process module mixins.
+    #
+    def import_methods: (
+      Definition definition,
+      TypeName module_name,
+      MethodBuilder::Methods module_methods,
+      interface_methods interface_methods,
+      Substitution subst
+    ) -> void
+
+    # Updates `definition` with methods and variables of `type_name` that can be a module or a class
+    #
+    # It processes includes and prepends recursively.
+    #
+    def define_instance: (Definition definition, TypeName type_name, Substitution subst) -> void
+
+    def define_interface: (Definition definition, TypeName type_name, Substitution subst) -> void
+
+    # Returns a substitution that corresponds to type application
+    #
+    # ```
+    # tapp_subst(`::Array`, [`::Integer`]) # => Subsitution.build([:Elem], [`::Integer`])
+    # ```
+    #
+    def tapp_subst: (TypeName, Array[Types::t]) -> Substitution
   end
 end