Class DefaultCompletionProvider

Protected ReadonlyastReflection

Protected OptionalclientCapabilities

Protected ReadonlycompletionParser

Protected ReadonlydocumentationProvider

Protected ReadonlyfuzzyMatcher

Protected Readonlygrammar

Protected ReadonlygrammarConfig

Protected Readonlylexer

Protected ReadonlynameProvider

Protected ReadonlynodeKindProvider

Protected ReadonlyscopeProvider

ProtectedbacktrackToAnyToken

• backtrackToAnyToken(
      text: string,
      offset: number,
  ): 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: CompletionContext,
      label: string,
      newText: string,
  ): TextEdit | InsertReplaceEdit | undefined

  Parameters

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

  Returns TextEdit | InsertReplaceEdit | undefined

ProtectedbuildCompletionTextEditWithInsertReplace

• buildCompletionTextEditWithInsertReplace(
      context: CompletionContext,
      label: string,
      newText: string,
  ): InsertReplaceEdit | undefined

  Returns an InsertReplaceEdit to enable clients to pick either the insert TextEdit or the replace TextEdit, depending on the editor's insert/replace mode. Note that the token part to the left of the cursor will be overwritten in both modes.

  Parameters

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

  Returns InsertReplaceEdit | undefined

ProtectedbuildCompletionTextEditWithoutInsertReplace

• buildCompletionTextEditWithoutInsertReplace(
      context: CompletionContext,
      label: string,
      newText: string,
  ): TextEdit | undefined

  A TextEdit is returned for clients without insert/replace mode configuration. The range of a TextEdit ends at the cursor position, so the suffix of an identifier after the cursor (e.g. Pos|ition) is never replaced.

  Parameters

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

  Returns TextEdit | undefined

ProtectedbuildContexts

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

  Parameters

  • document: LangiumDocument
  • position: Position

  Returns IterableIterator<CompletionContext>

ProtectedbuildSyntheticEntryRuleCall

• buildSyntheticEntryRuleCall(rule: GrammarAST.ParserRule): NextFeature

  Parameters

  • rule: GrammarAST.ParserRule

  Returns NextFeature

ProtectedcompletionFor

• completionFor(
      context: CompletionContext,
      next: NextFeature,
      acceptor: CompletionAcceptor,
  ): MaybePromise<void>

  Parameters

  • context: CompletionContext
  • next: NextFeature
  • acceptor: CompletionAcceptor

  Returns MaybePromise<void>

ProtectedcompletionForCrossReference

• completionForCrossReference(
      context: CompletionContext,
      next: NextFeature<GrammarAST.CrossReference>,
      acceptor: CompletionAcceptor,
  ): MaybePromise<void>

  Parameters

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

  Returns MaybePromise<void>

ProtectedcompletionForKeyword

• completionForKeyword(
      context: CompletionContext,
      keyword: GrammarAST.Keyword,
      acceptor: CompletionAcceptor,
  ): MaybePromise<void>

  Parameters

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

  Returns MaybePromise<void>

ProtectedcontinueCompletion

• continueCompletion(items: CompletionItem[]): 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: AstNodeDescription,
      _refInfo: ReferenceInfo,
      _context: CompletionContext,
  ): 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

  • _refInfo: ReferenceInfo

    Information about the reference for which the candidate is proposed

  • _context: CompletionContext

    The completion context

  Returns CompletionValueItem

  A partial completion item

ProtecteddeduplicateItems

• deduplicateItems(items: CompletionItem[]): 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: CompletionContext,
      item: CompletionValueItem,
  ): CompletionItem | undefined

  Parameters

  • context: CompletionContext
  • item: CompletionValueItem

  Returns CompletionItem | undefined

ProtectedfilterKeyword

• filterKeyword(context: CompletionContext, keyword: GrammarAST.Keyword): boolean

  Parameters

  • context: CompletionContext
  • keyword: GrammarAST.Keyword

  Returns boolean

ProtectedfindDataTypeRuleStart

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

  Parameters

  • cst: CstNode
  • offset: number

  Returns [number, number] | undefined

ProtectedfindFeaturesAt

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

  Parameters

  • document: TextDocument
  • offset: number

  Returns NextFeature<GrammarAST.AbstractElement>[]

ProtectedgetKeywordCompletionItemKind

• getKeywordCompletionItemKind(_keyword: GrammarAST.Keyword): CompletionItemKind

  Parameters

  • _keyword: GrammarAST.Keyword

  Returns CompletionItemKind

ProtectedgetReferenceCandidates

• getReferenceCandidates(
      refInfo: ReferenceInfo,
      _context: CompletionContext,
  ): 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: AstNodeDescription,
  ): string | MarkupContent | undefined

  Parameters

  • nodeDescription: AstNodeDescription

  Returns string | MarkupContent | undefined

Protectedinitialize

• initialize(params: InitializeParams): void

  Parameters

  • params: InitializeParams

  Returns void

ProtectedperformNextTokenCompletion

• performNextTokenCompletion(
      document: LangiumDocument,
      text: string,
      _offset: number,
      _end: number,
  ): boolean

  Parameters

  • document: LangiumDocument
  • text: string
  • _offset: number
  • _end: number

  Returns boolean