SemanticTokensClientCapabilities
in package
Table of Contents
Properties
- $augmentsSyntaxTokens : bool|null
- 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.
- $dynamicRegistration : bool|null
- 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.
- $formats : array<string|int, string>
- The formats the clients supports.
- $multilineTokenSupport : bool|null
- Whether the client supports tokens that can span multiple lines.
- $overlappingTokenSupport : bool|null
- Whether the client supports tokens that can overlap each other.
- $requests : SemanticTokensClientCapabilitiesRequests
- 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.
- $serverCancelSupport : bool|null
- 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.
- $tokenModifiers : array<string|int, string>
- The token modifiers that the client supports.
- $tokenTypes : array<string|int, string>
- The token types that the client supports.
Methods
- __construct() : mixed
- Undocumented function
Properties
$augmentsSyntaxTokens
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.
public
bool|null
$augmentsSyntaxTokens
If the value is undefined then the client behavior is not
specified.
Tags
$dynamicRegistration
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.
public
bool|null
$dynamicRegistration
$formats
The formats the clients supports.
public
array<string|int, string>
$formats
Tags
$multilineTokenSupport
Whether the client supports tokens that can span multiple lines.
public
bool|null
$multilineTokenSupport
$overlappingTokenSupport
Whether the client supports tokens that can overlap each other.
public
bool|null
$overlappingTokenSupport
$requests
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.
public
SemanticTokensClientCapabilitiesRequests
$requests
$serverCancelSupport
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.
public
bool|null
$serverCancelSupport
Tags
$tokenModifiers
The token modifiers that the client supports.
public
array<string|int, string>
$tokenModifiers
$tokenTypes
The token types that the client supports.
public
array<string|int, string>
$tokenTypes
Methods
__construct()
Undocumented function
public
__construct([SemanticTokensClientCapabilitiesRequests|null $requests = null ][, array<string|int, string>|null $tokenTypes = null ][, array<string|int, string>|null $tokenModifiers = null ][, array<string|int, string>|null $formats = null ][, bool|null $dynamicRegistration = null ][, bool|null $overlappingTokenSupport = null ][, bool|null $multilineTokenSupport = null ][, bool|null $serverCancelSupport = null ][, bool|null $augmentsSyntaxTokens = null ]) : mixed
Parameters
- $requests : SemanticTokensClientCapabilitiesRequests|null = null
- $tokenTypes : array<string|int, string>|null = null
- $tokenModifiers : array<string|int, string>|null = null
- $formats : array<string|int, string>|null = null
- $dynamicRegistration : bool|null = null
- $overlappingTokenSupport : bool|null = null
- $multilineTokenSupport : bool|null = null
- $serverCancelSupport : bool|null = null
- $augmentsSyntaxTokens : bool|null = null