Class: RubyLsp::Listeners::SignatureHelp

Inherits:
Object
  • Object
show all
Includes:
Requests::Support::Common
Defined in:
lib/ruby_lsp/listeners/signature_help.rb

Instance Method Summary collapse

Methods included from Requests::Support::Common

#categorized_markdown_from_index_entries, #constant_name, #create_code_lens, #each_constant_path_part, #kind_for_entry, #markdown_from_index_entries, #namespace_constant_name, #not_in_dependencies?, #range_from_location, #range_from_node, #self_receiver?

Constructor Details

#initialize(response_builder, global_state, node_context, dispatcher, sorbet_level) ⇒ SignatureHelp

: (ResponseBuilders::SignatureHelp response_builder, GlobalState global_state, NodeContext node_context, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void



10
11
12
13
14
15
16
17
18
 
# File 'lib/ruby_lsp/listeners/signature_help.rb', line 10

def initialize(response_builder, global_state, node_context, dispatcher, sorbet_level)
  @sorbet_level = sorbet_level
  @response_builder = response_builder
  @global_state = global_state
  @index = global_state.index #: RubyIndexer::Index
  @type_inferrer = global_state.type_inferrer #: TypeInferrer
  @node_context = node_context
  dispatcher.register(self, :on_call_node_enter)
end

Instance Method Details

#on_call_node_enter(node) ⇒ Object

: (Prism::CallNode node) -> void



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/ruby_lsp/listeners/signature_help.rb', line 21

def on_call_node_enter(node)
  return if @sorbet_level.true_or_higher?

  message = node.message
  return unless message

  type = @type_inferrer.infer_receiver_type(@node_context)
  return unless type

  methods = @index.resolve_method(message, type.name)
  return unless methods

  target_method = methods.first
  return unless target_method

  signatures = target_method.signatures

  # If the method doesn't have any parameters, there's no need to show signature help
  return if signatures.empty?

  name = target_method.name
  title = +""

  extra_links = if type.is_a?(TypeInferrer::GuessedType)
    title << "\n\nGuessed receiver: #{type.name}"
    "[Learn more about guessed types](#{GUESSED_TYPES_URL})"
  end

  active_signature, active_parameter = determine_active_signature_and_parameter(node, signatures)

  signature_help = Interface::SignatureHelp.new(
    signatures: generate_signatures(signatures, name, methods, title, extra_links),
    active_signature: active_signature,
    active_parameter: active_parameter,
  )
  @response_builder.replace(signature_help)
end