Class FilenameCompletionProvider

FilenameCompletionProvider provides completions to the include<> and use<> statements.

Implements

CompletionProvider

Index

Constructors

Properties

exclusive textOnly

Methods

getExistingPath getSymbolsAtLocation shouldActivate

Constructors

constructor

new FilenameCompletionProvider(): FilenameCompletionProvider
Returns FilenameCompletionProvider

Properties

exclusive

exclusive: boolean = true

When set to true it means that no other completion source should activate when this one activates,

textOnly

textOnly: boolean = true

WHen set to true it means that this Completion source can work without an AST, for example when the file is syntactically invalid.

Methods

getExistingPath

getExistingPath(ast, loc): null | string
Obtains the part of the included path the user has already entered
Parameters
- ast: ASTNode
  the ast to search
- loc: CodeLocation
  the location where the user is typing
Returns null | string
the part of the included path the user has already entered
- Defined in src/semantic/FilenameCompletionProvider.ts:77

getSymbolsAtLocation

getSymbolsAtLocation(ast, locM): Promise<CompletionSymbol[]>
Parameters
- ast: ASTNode
- locM: CodeLocation
Returns Promise<CompletionSymbol[]>
Implementation of CompletionProvider.getSymbolsAtLocation
- Defined in src/semantic/FilenameCompletionProvider.ts:24

shouldActivate

shouldActivate(ast, loc): boolean
Determines whether we are in a include<> or use<> statement
Parameters
- ast: ASTNode
- loc: CodeLocation
Returns boolean
Implementation of CompletionProvider.shouldActivate
- Defined in src/semantic/FilenameCompletionProvider.ts:20