File: signature_help_context.rb

package info (click to toggle)
ruby-language-server-protocol 3.17.0.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,636 kB
  • sloc: ruby: 10,741; makefile: 4
file content (74 lines) | stat: -rw-r--r-- 2,152 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
module LanguageServer
  module Protocol
    module Interface
      #
      # Additional information about the context in which a signature help request
      # was triggered.
      #
      class SignatureHelpContext
        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

        #
        # Action that caused signature help to be triggered.
        #
        # @return [SignatureHelpTriggerKind]
        def trigger_kind
          attributes.fetch(:triggerKind)
        end

        #
        # Character that caused signature help to be triggered.
        #
        # This is undefined when triggerKind !==
        # SignatureHelpTriggerKind.TriggerCharacter
        #
        # @return [string]
        def trigger_character
          attributes.fetch(:triggerCharacter)
        end

        #
        # `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.
        #
        # @return [boolean]
        def is_retrigger
          attributes.fetch(:isRetrigger)
        end

        #
        # The currently active `SignatureHelp`.
        #
        # The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field
        # updated based on the user navigating through available signatures.
        #
        # @return [SignatureHelp]
        def active_signature_help
          attributes.fetch(:activeSignatureHelp)
        end

        attr_reader :attributes

        def to_hash
          attributes
        end

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