Class AbstractSemanticTokenProvider`Abstract`

A basic super class for providing semantic token data. Users of Langium should extend this class to create their own SemanticTokenProvider.

The entry method for generating semantic tokens based on an AstNode is the highlightElement method.

Hierarchy (View Summary)

AbstractSemanticTokenProvider
- LangiumGrammarSemanticTokenProvider

Implements

SemanticTokenProvider

Constructors

constructor

new AbstractSemanticTokenProvider(
services: LangiumServices,
): AbstractSemanticTokenProvider
Parameters
- services: LangiumServices
Returns AbstractSemanticTokenProvider
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:247

Properties

`Protected` `Optional`clientCapabilities

clientCapabilities?: SemanticTokensClientCapabilities

`Protected` `Optional`currentDocument

currentDocument?: LangiumDocument<AstNode>

`Protected` `Optional`currentRange

currentRange?: Range

`Protected` `Optional`currentTokensBuilder

currentTokensBuilder?: SemanticTokensBuilder

`Protected`tokensBuilders

tokensBuilders: Map<string, SemanticTokensBuilder> = ...

Store a token builder for each open document.

Accessors

semanticTokensOptions

get semanticTokensOptions(): SemanticTokensOptions
Returns SemanticTokensOptions
Implementation of SemanticTokenProvider.semanticTokensOptions
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:269

tokenModifiers

get tokenModifiers(): Record<string, number>
Returns Record<string, number>
Implementation of SemanticTokenProvider.tokenModifiers
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:265

tokenTypes

get tokenTypes(): Record<string, number>
Returns Record<string, number>
Implementation of SemanticTokenProvider.tokenTypes
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:261

Methods

`Protected` `Abstract`highlightElement

highlightElement(
node: AstNode,
acceptor: SemanticTokenAcceptor,
): undefined | void | "prune"
Parameters
- node: AstNode
- acceptor: SemanticTokenAcceptor
Returns undefined | void | "prune"
'prune' to skip the children of this element, nothing otherwise.
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:375

`Protected`highlightKeyword

highlightKeyword(options: SemanticTokenKeywordOptions): void
Parameters
- options: SemanticTokenKeywordOptions
Returns void
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:468

`Protected`highlightNode

highlightNode(options: SemanticTokenNodeOptions): void
Parameters
- options: SemanticTokenNodeOptions
Returns void
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:488

`Protected`highlightProperty

highlightProperty<N extends AstNode>(
options: SemanticTokenPropertyOptions<N>,
): void
Type Parameters
- N extends AstNode
Parameters
- options: SemanticTokenPropertyOptions<N>
Returns void
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:448

`Protected`highlightToken

highlightToken(options: SemanticTokenRangeOptions): void
Parameters
- options: SemanticTokenRangeOptions
Returns void
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:377

initialize

initialize(clientCapabilities?: SemanticTokensClientCapabilities): void
Parameters
- OptionalclientCapabilities: SemanticTokensClientCapabilities
Returns void
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:257

semanticHighlight

semanticHighlight(
    document: LangiumDocument,
    _params: SemanticTokensParams,
    cancelToken?: Cancellation.CancellationToken,
): Promise<SemanticTokens>
Parameters
- document: LangiumDocument
- _params: SemanticTokensParams
- cancelToken: Cancellation.CancellationToken = CancellationToken.None
Returns Promise<SemanticTokens>
Implementation of SemanticTokenProvider.semanticHighlight
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:285

semanticHighlightDelta

semanticHighlightDelta(
    document: LangiumDocument,
    params: SemanticTokensDeltaParams,
    cancelToken?: Cancellation.CancellationToken,
): Promise<SemanticTokens | SemanticTokensDelta>
Parameters
- document: LangiumDocument
- params: SemanticTokensDeltaParams
- cancelToken: Cancellation.CancellationToken = CancellationToken.None
Returns Promise<SemanticTokens | SemanticTokensDelta>
Implementation of SemanticTokenProvider.semanticHighlightDelta
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:303

semanticHighlightRange

semanticHighlightRange(
    document: LangiumDocument,
    params: SemanticTokensRangeParams,
    cancelToken?: Cancellation.CancellationToken,
): Promise<SemanticTokens>
Parameters
- document: LangiumDocument
- params: SemanticTokensRangeParams
- cancelToken: Cancellation.CancellationToken = CancellationToken.None
Returns Promise<SemanticTokens>
Implementation of SemanticTokenProvider.semanticHighlightRange
- Defined in packages/langium/src/lsp/semantic-token-provider.ts:294

Class AbstractSemanticTokenProviderAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AbstractSemanticTokenProvider

Properties

Protected OptionalclientCapabilities

Protected OptionalcurrentDocument

Protected OptionalcurrentRange

Protected OptionalcurrentTokensBuilder

ProtectedtokensBuilders

Accessors

semanticTokensOptions

Returns SemanticTokensOptions

tokenModifiers

Returns Record<string, number>

tokenTypes

Returns Record<string, number>

Methods

ProtectedcomputeHighlighting

Parameters

Returns Promise<void>

ProtectedcreateAcceptor

Returns SemanticTokenAcceptor

ProtectedgetDocumentTokensBuilder

Parameters

Returns SemanticTokensBuilder

Protected AbstracthighlightElement

Parameters

Returns undefined | void | "prune"

ProtectedhighlightKeyword

Parameters

Returns void

ProtectedhighlightNode

Parameters

Returns void

ProtectedhighlightProperty

Type Parameters

Parameters

Returns void

ProtectedhighlightToken

Parameters

Returns void

initialize

Parameters

Returns void

semanticHighlight

Parameters

Returns Promise<SemanticTokens>

semanticHighlightDelta

Parameters

Returns Promise<SemanticTokens | SemanticTokensDelta>

semanticHighlightRange

Parameters

Returns Promise<SemanticTokens>

Settings

On This Page

Class AbstractSemanticTokenProvider`Abstract`

`Protected` `Optional`clientCapabilities

`Protected` `Optional`currentDocument

`Protected` `Optional`currentRange

`Protected` `Optional`currentTokensBuilder

`Protected`tokensBuilders

`Protected`computeHighlighting

`Protected`createAcceptor

`Protected`getDocumentTokensBuilder

`Protected` `Abstract`highlightElement

`Protected`highlightKeyword

`Protected`highlightNode

`Protected`highlightProperty

`Protected`highlightToken