Class LangiumGrammarCompletionProvider

Protected ReadonlyastReflection

Protected ReadonlycompletionParser

Protected ReadonlydocumentationProvider

Protected ReadonlyfuzzyMatcher

Protected Readonlygrammar

Protected ReadonlygrammarConfig

Protected Readonlylexer

Protected ReadonlynameProvider

Protected ReadonlynodeKindProvider

Protected ReadonlyscopeProvider

ProtectedbacktrackToAnyToken

• backtrackToAnyToken(text, offset): CompletionBacktrackingInformation

• This method returns two sets of token offset information.

  The nextToken* offsets are related to the token at the cursor position. If there is none, both offsets are simply set to offset.

  The previousToken* offsets are related to the last token before the current token at the cursor position. They are undefined, if there is no token before the cursor position.

  Parameters

  • text: string
  • offset: number

  Returns CompletionBacktrackingInformation

ProtectedbuildCompletionTextEdit

• buildCompletionTextEdit(context, label, newText): undefined | TextEdit

• Parameters

  • context: CompletionContext
  • label: string
  • newText: string

  Returns undefined | TextEdit

ProtectedbuildContexts

• buildContexts(document, position): IterableIterator<CompletionContext>

• Parameters

  • document: LangiumDocument<AstNode>
  • position: Position

  Returns IterableIterator<CompletionContext>

ProtectedcompletionForCrossReference

• completionForCrossReference(context, next, acceptor): MaybePromise<void>

• Parameters

  • context: CompletionContext
  • next: NextFeature<GrammarAST.CrossReference>
  • acceptor: CompletionAcceptor

  Returns MaybePromise<void>

ProtectedcompletionForKeyword

• completionForKeyword(context, keyword, acceptor): MaybePromise<void>

• Parameters

  • context: CompletionContext
  • keyword: GrammarAST.Keyword
  • acceptor: CompletionAcceptor

  Returns MaybePromise<void>

ProtectedcontinueCompletion

• continueCompletion(items): boolean

• Indicates whether the completion should continue to process the next completion context.

  The default implementation continues the completion only if there are currently no proposed completion items.

  Parameters

  • items: CompletionItem[]

  Returns boolean

ProtectedcreateReferenceCompletionItem

• createReferenceCompletionItem(nodeDescription): CompletionValueItem

• Override this method to change how reference completion items are created.

  To change the kind of a completion item, override the NodeKindProvider service instead. To change the documentation, override the DocumentationProvider service instead.

  Parameters

  • nodeDescription: AstNodeDescription

    The description of a reference candidate

  Returns CompletionValueItem

  A partial completion item

ProtecteddeduplicateItems

• deduplicateItems(items): CompletionItem[]

• The completion algorithm could yield the same reference/keyword multiple times.

  This methods deduplicates these items afterwards before returning to the client. Unique items are identified as a combination of kind, label and detail.

  Parameters

  • items: CompletionItem[]

  Returns CompletionItem[]

ProtectedfillCompletionItem

• fillCompletionItem(context, item): undefined | CompletionItem

• Parameters

  • context: CompletionContext
  • item: CompletionValueItem

  Returns undefined | CompletionItem

ProtectedfilterKeyword

• filterKeyword(context, keyword): boolean

• Parameters

  • context: CompletionContext
  • keyword: GrammarAST.Keyword

  Returns boolean

ProtectedfindDataTypeRuleStart

• findDataTypeRuleStart(cst, offset): undefined | [number, number]

• Parameters

  • cst: CstNode
  • offset: number

  Returns undefined | [number, number]

ProtectedfindFeaturesAt

• findFeaturesAt(document, offset): NextFeature<GrammarAST.AbstractElement>[]

• Parameters

  • document: TextDocument
  • offset: number

  Returns NextFeature<GrammarAST.AbstractElement>[]

ProtectedgetKeywordCompletionItemKind

• getKeywordCompletionItemKind(_keyword): CompletionItemKind

• Parameters

  • _keyword: GrammarAST.Keyword

  Returns CompletionItemKind

ProtectedgetReferenceCandidates

• getReferenceCandidates(refInfo, _context): Stream<AstNodeDescription>

• Override this method to change how the stream of candidates is determined for a reference. This way completion-specific modifications and refinements can be added to the proposals computation beyond the rules being implemented in the scope provider, e.g. filtering.

  Parameters

  • refInfo: ReferenceInfo

    Information about the reference for which the candidates are requested.
  • _context: CompletionContext

    Information about the completion request including document, cursor position, token under cursor, etc.

  Returns Stream<AstNodeDescription>

  A stream of all elements being valid for the given reference.

ProtectedgetReferenceDocumentation

• getReferenceDocumentation(nodeDescription): undefined | string | MarkupContent

• Parameters

  • nodeDescription: AstNodeDescription

  Returns undefined | string | MarkupContent

ProtectedperformNextTokenCompletion

• performNextTokenCompletion(document, text, _offset, _end): boolean

• Parameters

  • document: LangiumDocument<AstNode>
  • text: string
  • _offset: number
  • _end: number

  Returns boolean