class LanguageServer::Protocol::Interface::SemanticTokensClientCapabilities

Attributes

attributes[R]

Public Class Methods

new(dynamic_registration: nil, requests:, token_types:, token_modifiers:, formats:, overlapping_token_support: nil, multiline_token_support: nil, server_cancel_support: nil, augments_syntax_tokens: nil) click to toggle source

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 5
def initialize(dynamic_registration: nil, requests:, token_types:, token_modifiers:, formats:, overlapping_token_support: nil, multiline_token_support: nil, server_cancel_support: nil, augments_syntax_tokens: nil)
  @attributes = {}

  @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
  @attributes[:requests] = requests
  @attributes[:tokenTypes] = token_types
  @attributes[:tokenModifiers] = token_modifiers
  @attributes[:formats] = formats
  @attributes[:overlappingTokenSupport] = overlapping_token_support if overlapping_token_support
  @attributes[:multilineTokenSupport] = multiline_token_support if multiline_token_support
  @attributes[:serverCancelSupport] = server_cancel_support if server_cancel_support
  @attributes[:augmentsSyntaxTokens] = augments_syntax_tokens if augments_syntax_tokens

  @attributes.freeze
end

Public Instance Methods

augments_syntax_tokens() click to toggle source

Whether the client uses semantic tokens to augment existing syntax tokens. If set to ‘true` client side created syntax tokens and semantic tokens are both used for colorization. If set to `false` the client only uses the returned semantic tokens for colorization.

If the value is ‘undefined` then the client behavior is not specified.

@return [boolean]

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 109
def augments_syntax_tokens
  attributes.fetch(:augmentsSyntaxTokens)
end

dynamic_registration() click to toggle source

Whether implementation supports dynamic registration. If this is set to ‘true` the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` return value for the corresponding server capability as well.

@return [boolean]

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 28
def dynamic_registration
  attributes.fetch(:dynamicRegistration)
end

formats() click to toggle source

The formats the clients supports.

@return [“relative”

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 67
def formats
  attributes.fetch(:formats)
end

multiline_token_support() click to toggle source

Whether the client supports tokens that can span multiple lines.

@return [boolean]

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 83
def multiline_token_support
  attributes.fetch(:multilineTokenSupport)
end

overlapping_token_support() click to toggle source

Whether the client supports tokens that can overlap each other.

@return [boolean]

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 75
def overlapping_token_support
  attributes.fetch(:overlappingTokenSupport)
end

requests() click to toggle source

Which requests the client supports and might send to the server depending on the server’s capability. Please note that clients might not show semantic tokens or degrade some of the user experience if a range or full request is advertised by the client but not provided by the server. If for example the client capability ‘requests.full` and `request.range` are both set to true but the server only provides a range provider the client might not render a minimap correctly or might even decide to not show any semantic tokens at all.

@return [{ range?: boolean | {}; full?: boolean | { delta?: boolean; }; }]

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 43
def requests
  attributes.fetch(:requests)
end

server_cancel_support() click to toggle source

Whether the client allows the server to actively cancel a semantic token request, e.g. supports returning ErrorCodes.ServerCancelled. If a server does the client needs to retrigger the request.

@return [boolean]

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 94
def server_cancel_support
  attributes.fetch(:serverCancelSupport)
end

to_hash() click to toggle source

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 115
def to_hash
  attributes
end

to_json(*args) click to toggle source

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 119
def to_json(*args)
  to_hash.to_json(*args)
end

token_modifiers() click to toggle source

The token modifiers that the client supports.

@return [string

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 59
def token_modifiers
  attributes.fetch(:tokenModifiers)
end

token_types() click to toggle source

The token types that the client supports.

@return [string

# File lib/language_server/protocol/interface/semantic_tokens_client_capabilities.rb, line 51
def token_types
  attributes.fetch(:tokenTypes)
end