steep 1.4.0.dev.3 → 1.4.0.dev.4

data/sig/steep/services/completion_provider.rbs

@@ -1,6 +1,10 @@
+use RBS::Environment, RBS::TypeName
+use Steep::TypeInference::MethodCall
+
 module Steep
   module Services
     class CompletionProvider
+      # Cursor position
       class Position
         attr_reader line: Integer
 
@@ -40,7 +44,7 @@ module Steep
       end
 
       class ConstantItem
-        attr_reader env: RBS::Environment
+        attr_reader env: Environment
 
         attr_reader identifier: Symbol
 
@@ -48,36 +52,107 @@ module Steep
 
         attr_reader type: AST::Types::t
 
-        attr_reader full_name: RBS::TypeName
+        attr_reader full_name: TypeName
 
-        def initialize: (env: RBS::Environment, identifier: Symbol, range: Range, type: AST::Types::t, full_name: RBS::TypeName) -> void
+        def initialize: (env: Environment, identifier: Symbol, range: Range, type: AST::Types::t, full_name: TypeName) -> void
 
         def class?: () -> bool
 
         def module?: () -> bool
 
-        def comments: () -> Array[RBS::AST::Comment]
+        def comments: () -> Array[RBS::AST::Comment?]
+
+        type const_decl = RBS::AST::Declarations::Constant
+                        | RBS::AST::Declarations::Class
+                        | RBS::AST::Declarations::Module
+                        | RBS::AST::Declarations::ClassAlias
+                        | RBS::AST::Declarations::ModuleAlias
+
+        def decl: () -> const_decl
+      end
+
+      # Method name completion item with *simple* receiver type
+      #
+      # Instance type, Singleton type, Interface type is simple.
+      # The item may have multiple overloads, but must have single method definition source.
+      #
+      class SimpleMethodNameItem
+        attr_reader identifier: Symbol
+
+        attr_reader range: Range
+
+        attr_reader receiver_type: AST::Types::Name::Instance | AST::Types::Name::Interface | AST::Types::Name::Singleton
+
+        attr_reader method_types: Array[RBS::MethodType]
+
+        attr_reader method_name: method_name
+
+        attr_reader method_member: RBS::Definition::Method::method_member
+
+        def initialize: (
+          identifier: Symbol,
+          range: Range,
+          receiver_type: AST::Types::Name::Instance | AST::Types::Name::Interface | AST::Types::Name::Singleton,
+          method_name: method_name,
+          method_types: Array[RBS::MethodType],
+          method_member: RBS::Definition::Method::method_member
+        ) -> void
+
+        %a{pure} def comment: () -> RBS::AST::Comment?
       end
 
-      class MethodNameItem
+      # Method name completion item with *complex* receiver type
+      #
+      # The item may have multiple overloads and multiple method declarations.
+      #
+      class ComplexMethodNameItem
         attr_reader identifier: Symbol
 
         attr_reader range: Range
 
-        attr_reader receiver_type: AST::Types::t
+        attr_reader reeiver_type: AST::Types::t
+
+        attr_reader method_types: Array[RBS::MethodType]
+
+        attr_reader method_decls: Array[MethodCall::MethodDecl]
+
+        def initialize: (
+          identifier: Symbol,
+          range: Range,
+          method_types: Array[RBS::MethodType],
+          method_decls: Array[MethodCall::MethodDecl],
+          receiver_type: AST::Types::t
+        ) -> void
+
+        def method_names: () -> Array[method_name]
 
-        attr_reader method_type: untyped
+        def method_definitions: () -> Hash[method_name, RBS::Definition::Method::method_member]
 
-        attr_reader method_decls: Array[TypeInference::MethodCall::MethodDecl]
+        def defining_method_name: (TypeName, Symbol name, RBS::Definition::Method::method_member) -> method_name
+      end
+
+      # Method name completion item for generated methods, like `#first` in tuple types
+      #
+      # The generated methods doesn't have associated `MethodDecl`.
+      #
+      class GeneratedMethodNameItem
+        attr_reader identifier: Symbol
 
-        def initialize: (identifier: Symbol, range: Range, method_type: untyped, method_decls: Array[TypeInference::MethodCall::MethodDecl]) -> void
+        attr_reader range: Range
+
+        attr_reader reeiver_type: AST::Types::t
 
-        def comment: () -> RBS::AST::Comment?
+        attr_reader method_types: Array[RBS::MethodType]
 
-        def inherited?: () -> bool
+        def initialize: (
+          identifier: Symbol,
+          range: Range,
+          receiver_type: AST::Types::t,
+          method_types: Array[RBS::MethodType]
+        ) -> void
       end
 
-      type item = InstanceVariableItem | LocalVariableItem | ConstantItem | MethodNameItem
+      type item = InstanceVariableItem | LocalVariableItem | ConstantItem | SimpleMethodNameItem | ComplexMethodNameItem | GeneratedMethodNameItem
 
       attr_reader source_text: String
 
@@ -91,41 +166,42 @@ module Steep
 
       attr_reader typing: Typing
 
-      def initialize: (source_text: untyped, path: untyped, subtyping: untyped) -> void
+      def initialize: (source_text: String, path: Pathname, subtyping: Subtyping::Check) -> void
 
-      def type_check!: (untyped text, line: untyped, column: untyped) -> untyped
+      def type_check!: (String text, line: Integer, column: Integer) -> void
 
-      def env: () -> untyped
+      def env: () -> Environment
 
-      def run: (line: untyped, column: untyped) -> untyped
+      def run: (line: Integer, column: Integer) -> Array[item]
 
-      def range_from_loc: (untyped loc) -> untyped
+      def range_from_loc: (Parser::Source::Range loc) -> Range
 
-      def at_end?: (untyped pos, of: untyped) -> (untyped | nil)
+      def at_end?: (Position pos, of: Parser::Source::Map | Parser::Source::Range | nil) -> boolish
 
-      def range_for: (untyped position, ?prefix: ::String) -> untyped
+      def range_for: (Position position, ?prefix: ::String) -> Range
 
-      def items_for_trigger: (position: untyped) -> (::Array[untyped] | untyped)
+      def items_for_trigger: (position: Position) -> Array[item]
 
-      def items_for_dot: (position: Position) -> ::Array[MethodNameItem]
+      def items_for_dot: (position: Position) -> Array[item]
 
-      def items_for_colon2: (position: untyped) -> untyped
+      def items_for_colon2: (position: Position) -> Array[item]
 
-      def items_for_atmark: (position: untyped) -> (::Array[untyped] | untyped)
+      def items_for_atmark: (position: Position) -> Array[item]
 
-      def method_items_for_receiver_type: (untyped `type`, include_private: untyped, prefix: untyped, position: untyped, items: untyped) -> untyped
+      def method_items_for_receiver_type: (AST::Types::t, include_private: bool, prefix: String, position: Position, items: Array[item]) -> void
 
-      def word_name?: (String name) -> void
+      def word_name?: (String name) -> bool
 
-      def local_variable_items_for_context: (TypeInference::Context context, position: Position, prefix: String, items: Array[LocalVariableItem]) -> void
+      def local_variable_items_for_context: (TypeInference::Context context, position: Position, prefix: String, items: Array[item]) -> void
 
-      def constant_items_for_context: (TypeInference::Context context, position: Position, prefix: String, items: Array[ConstantItem], ?parent: Parser::AST::Node?) -> void
+      def constant_items_for_context: (TypeInference::Context context, position: Position, prefix: String, items: Array[item], ?parent: Parser::AST::Node?) -> void
 
-      def instance_variable_items_for_context: (TypeInference::Context context, position: Position, prefix: String, items: Array[InstanceVariableItem]) -> void
+      def instance_variable_items_for_context: (TypeInference::Context context, position: Position, prefix: String, items: Array[item]) -> void
 
-      def index_for: (untyped string, line: untyped, column: untyped) -> untyped
+      def index_for: (String, line: Integer, column: Integer) -> Integer
 
       def disallowed_method?: (Symbol name) -> bool
+
     end
   end
 end

data/sig/steep/services/hover_provider/rbs.rbs

@@ -1,31 +1,33 @@
+use RBS::Location, RBS::AST::Declarations, RBS::AST::Directives, RBS::TypeName, RBS::Environment
+
 module Steep
   module Services
     module HoverProvider
       class RBS
         class TypeAliasContent
-          attr_reader location: ::RBS::Location[untyped, untyped]
+          attr_reader location: Location[untyped, untyped]
 
-          attr_reader decl: ::RBS::AST::Declarations::TypeAlias
+          attr_reader decl: Declarations::TypeAlias
 
-          def initialize: (location: ::RBS::Location[untyped, untyped], decl: ::RBS::AST::Declarations::TypeAlias) -> void
+          def initialize: (location: Location[untyped, untyped], decl: Declarations::TypeAlias) -> void
         end
 
         class ClassContent
-          attr_reader location: ::RBS::Location[untyped, untyped]
+          attr_reader location: Location[untyped, untyped]
 
-          type decl = ::RBS::AST::Declarations::Class | ::RBS::AST::Declarations::Module | ::RBS::AST::Declarations::ClassAlias | ::RBS::AST::Declarations::ModuleAlias
+          type decl = Declarations::Class | Declarations::Module | Declarations::ClassAlias | Declarations::ModuleAlias
 
           attr_reader decl: decl
 
-          def initialize: (location: ::RBS::Location[untyped, untyped], decl: decl) -> void
+          def initialize: (location: Location[untyped, untyped], decl: decl) -> void
         end
 
         class InterfaceContent
-          attr_reader location: ::RBS::Location[untyped, untyped]
+          attr_reader location: Location[untyped, untyped]
 
-          attr_reader decl: ::RBS::AST::Declarations::Interface
+          attr_reader decl: Declarations::Interface
 
-          def initialize: (location: ::RBS::Location[untyped, untyped], decl: ::RBS::AST::Declarations::Interface) -> void
+          def initialize: (location: Location[untyped, untyped], decl: Declarations::Interface) -> void
         end
 
         type content = TypeAliasContent | ClassContent | InterfaceContent
@@ -37,6 +39,8 @@ module Steep
         def project: () -> Project
 
         def content_for: (target: Project::Target, path: Pathname, line: Integer, column: Integer) -> content?
+
+        def content_for_type_name: (TypeName, env: Environment, location: Location[untyped, untyped]) -> content?
       end
     end
   end

data/sig/steep/services/signature_help_provider.rbs

@@ -0,0 +1,39 @@
+use RBS::Environment
+
+module Steep
+  module Services
+    class SignatureHelpProvider
+      module MethodCall = TypeInference::MethodCall
+
+      class Item
+        attr_reader method_type: RBS::MethodType
+
+        attr_reader comment: RBS::AST::Comment?
+
+        def initialize: (RBS::MethodType, RBS::AST::Comment?) -> void
+      end
+
+      attr_reader source: Source
+
+      attr_reader path: Pathname
+
+      attr_reader subtyping: Subtyping::Check
+
+      attr_reader buffer: RBS::Buffer
+
+      def env: () -> Environment
+
+      def initialize: (source: Source, subtyping: Subtyping::Check) -> void
+
+      # 1-origin line, 0-origin column
+      #
+      def run: (line: Integer, column: Integer) -> [Array[Item], Integer?]?
+
+      private
+
+      def signature_help_for: (Parser::AST::Node, Typing) -> [Array[Item], Integer?]?
+
+      def type_check!: (line: Integer, column: Integer) -> Typing
+    end
+  end
+end

data/sig/steep/type_inference/method_call.rbs

@@ -1,6 +1,6 @@
 module Steep
   module TypeInference
-    class MethodCall
+    module MethodCall
       class MethodDecl
         attr_reader method_name: method_name
 

data/sig/steep/type_inference/send_args.rbs

@@ -52,7 +52,9 @@ module Steep
           include Equatable
         end
 
-        type arg = NodeParamPair | NodeTypePair | SplatArg | UnexpectedArg | MissingArg
+        type arg = NodeParamPair | NodeTypePair | SplatArg | error_arg
+
+        type error_arg = UnexpectedArg | MissingArg
 
         attr_reader args: Array[Parser::AST::Node]
 
@@ -134,7 +136,9 @@ module Steep
           def initialize: (keywords: Set[Symbol]) -> void
         end
 
-        type arg = ArgTypePairs | SplatArg | UnexpectedKeyword | MissingKeyword
+        type arg = ArgTypePairs | SplatArg | error_arg
+
+        type error_arg = UnexpectedKeyword | MissingKeyword
 
         attr_reader kwarg_nodes: Array[Parser::AST::Node]
 

data/sig/steep/typing.rbs

@@ -44,7 +44,7 @@ module Steep
 
     def type_of: (node: Parser::AST::Node) -> AST::Types::t
 
-    def call_of: (node: untyped) -> untyped
+    def call_of: (node: Parser::AST::Node) -> TypeInference::MethodCall::t
 
     def add_context_for_node: (untyped node, context: untyped) -> untyped
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steep
 version: !ruby/object:Gem::Version
-  version: 1.4.0.dev.3
+  version: 1.4.0.dev.4
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -343,6 +343,7 @@ files:
 - lib/steep/services/hover_provider/ruby.rb
 - lib/steep/services/hover_provider/singleton_methods.rb
 - lib/steep/services/path_assignment.rb
+- lib/steep/services/signature_help_provider.rb
 - lib/steep/services/signature_service.rb
 - lib/steep/services/stats_calculator.rb
 - lib/steep/services/type_check_service.rb
@@ -474,6 +475,7 @@ files:
 - sig/steep/services/hover_provider/ruby.rbs
 - sig/steep/services/hover_provider/singleton_methods.rbs
 - sig/steep/services/path_assignment.rbs
+- sig/steep/services/signature_help_provider.rbs
 - sig/steep/services/signature_service.rbs
 - sig/steep/services/stats_calculator.rbs
 - sig/steep/services/type_check_service.rbs