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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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



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

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)

Returns the value of attribute attributes.



59
60
61
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 59

def attributes
  @attributes
end

Instance Method Details

#active_signature_help ⇒ SignatureHelp

The currently active ‘SignatureHelp`.

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



55
56
57
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 55

def active_signature_help
  attributes.fetch(:activeSignatureHelp)
end

#is_retrigger ⇒ boolean

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

Retriggers occur 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.



44
45
46
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 44

def is_retrigger
  attributes.fetch(:isRetrigger)
end

#to_hash ⇒ Object 



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

def to_hash
  attributes
end

#to_json(*args) ⇒ Object 



65
66
67
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 65

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

#trigger_character ⇒ string

Character that caused signature help to be triggered.

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



33
34
35
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 33

def trigger_character
  attributes.fetch(:triggerCharacter)
end

#trigger_kind ⇒ CompletionTriggerKind

Action that caused signature help to be triggered.



23
24
25
 
# File 'lib/language_server/protocol/interface/signature_help_context.rb', line 23

def trigger_kind
  attributes.fetch(:triggerKind)
end