Class: LanguageServer::Protocol::Interface::SignatureHelpContext

Inherits:
Object
  • Object
show all
Defined in:
lib/language_server/protocol/interface/signature_help_context.rb

Overview

Additional information about the context in which a signature help request was triggered.

Since:

  • 3.15.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(trigger_kind:, trigger_character: nil, is_retrigger:, active_signature_help: nil) ⇒ SignatureHelpContext

Returns a new instance of SignatureHelpContext.

Since:

  • 3.15.0



10
11
12
13
14
15
16
17
18
19
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 10

def initialize(trigger_kind:, trigger_character: nil, is_retrigger:, active_signature_help: nil)
  @attributes = {}

  @attributes[:triggerKind] = trigger_kind
  @attributes[:triggerCharacter] = trigger_character if trigger_character
  @attributes[:isRetrigger] = is_retrigger
  @attributes[:activeSignatureHelp] = active_signature_help if active_signature_help

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Since:

  • 3.15.0



61
62
63
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 61

def attributes
  @attributes
end

Instance Method Details

#active_signature_help ⇒ SignatureHelp | nil

The currently active SignatureHelp.

The activeSignatureHelp has its SignatureHelp.activeSignature field updated based on the user navigating through available signatures.

Since:

  • 3.15.0



57
58
59
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 57

def active_signature_help
  attributes.fetch(:activeSignatureHelp)
end

#is_retrigger ⇒ boolean

true if signature help was already showing when it was triggered.

Retriggers occurs when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

Since:

  • 3.15.0



46
47
48
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 46

def is_retrigger
  attributes.fetch(:isRetrigger)
end

#to_hash ⇒ Object

Since:

  • 3.15.0



63
64
65
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 63

def to_hash
  attributes
end

#to_json(*args) ⇒ Object

Since:

  • 3.15.0



67
68
69
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 67

def to_json(*args)
  to_hash.to_json(*args)
end

#trigger_character ⇒ string | nil

Character that caused signature help to be triggered.

This is undefined when ‘triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`

Since:

  • 3.15.0



35
36
37
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 35

def trigger_character
  attributes.fetch(:triggerCharacter)
end

#trigger_kind ⇒ SignatureHelpTriggerKind

Action that caused signature help to be triggered.

Since:

  • 3.15.0



25
26
27
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 25

def trigger_kind
  attributes.fetch(:triggerKind)
end