brighterscript 0.66.0-alpha.8 → 0.67.0

package/dist/files/BrsFile.d.ts

@@ -1,8 +1,8 @@
 import type { CodeWithSourceMap } from 'source-map';
 import type { CompletionItem, Position, Location, Diagnostic } from 'vscode-languageserver';
-import { DocumentSymbol, SymbolInformation } from 'vscode-languageserver';
+import type { Scope } from '../Scope';
 import { FunctionScope } from '../FunctionScope';
-import type { Callable, CommentFlag, FunctionCall, BsDiagnostic, FileReference, FileLink, SerializedCodeFile, NamespaceContainer } from '../interfaces';
+import type { Callable, CommentFlag, FunctionCall, BsDiagnostic, FileReference, FileLink, BscFile } from '../interfaces';
 import type { Token } from '../lexer/Token';
 import { TokenKind } from '../lexer/TokenKind';
 import { Parser, ParseMode } from '../parser/Parser';
@@ -10,54 +10,38 @@ import type { FunctionExpression } from '../parser/Expression';
 import type { ClassStatement, NamespaceStatement, MethodStatement } from '../parser/Statement';
 import type { Program } from '../Program';
 import type { DependencyGraph } from '../DependencyGraph';
-import type { AstNode } from '../parser/AstNode';
-import { type Expression } from '../parser/AstNode';
-import type { BscSymbol } from '../SymbolTable';
-import { SymbolTypeFlag } from '../SymbolTable';
-import type { File } from './File';
-import { Editor } from '../astUtils/Editor';
-import type { UnresolvedSymbol } from '../AstValidationSegmenter';
-import { AstValidationSegmenter } from '../AstValidationSegmenter';
-export declare type ProvidedSymbolMap = Map<SymbolTypeFlag, Map<string, BscSymbol>>;
-export declare type ChangedSymbolMap = Map<SymbolTypeFlag, Set<string>>;
-export interface ProvidedSymbolInfo {
-    symbolMap: ProvidedSymbolMap;
-    changes: ChangedSymbolMap;
-}
+import type { AstNode, Expression } from '../parser/AstNode';
 /**
  * Holds all details about this file within the scope of the whole program
  */
-export declare class BrsFile implements File {
-    constructor(options: {
-        /**
-         * The path to the file in its source location (where the source code lives in the file system)
-         */
-        srcPath: string;
-        /**
-         * The path to the file where it should exist in the program. This is similar to pkgPath, but retains its original file extensions from srcPath
-         */
-        destPath: string;
-        /**
-         * The final path in the zip. This has the extensions changed. Typically this is the same as destPath, but with file extensions changed for transpiled files.
-         */
-        pkgPath?: string;
-        program: Program;
-    });
-    type: string;
+export declare class BrsFile {
     srcPath: string;
-    destPath: string;
+    /**
+     * The full pkg path to this file
+     */
     pkgPath: string;
     program: Program;
+    constructor(srcPath: string, 
+    /**
+     * The full pkg path to this file
+     */
+    pkgPath: string, program: Program);
+    /**
+     * The absolute path to the source location for this file
+     * @deprecated use `srcPath` instead
+     */
+    get pathAbsolute(): string;
+    set pathAbsolute(value: string);
     /**
-     * An editor assigned during the build flow that manages edits that will be undone once the build process is complete.
+     * Will this file result in only comment or whitespace output? If so, it can be excluded from the output if that bsconfig setting is enabled.
      */
-    editor?: Editor;
+    get canBePruned(): boolean;
     /**
      * The parseMode used for the parser for this file
      */
     parseMode: ParseMode;
     /**
-     * The key used to identify this file in the dependency graph. This is set by the BrighterScript program and should not be set by plugins
+     * The key used to identify this file in the dependency graph
      */
     dependencyGraphKey: string;
     /**
@@ -73,12 +57,9 @@ export declare class BrsFile implements File {
      * A collection of diagnostics related to this file
      */
     diagnostics: BsDiagnostic[];
-    /**
-     * @deprecated use `.diagnostics` instead
-     */
     getDiagnostics(): BsDiagnostic[];
     addDiagnostic(diagnostic: Diagnostic & {
-        file?: File;
+        file?: BscFile;
     }): void;
     addDiagnostics(diagnostics: BsDiagnostic[]): void;
     commentFlags: CommentFlag[];
@@ -93,17 +74,12 @@ export declare class BrsFile implements File {
     get ownScriptImports(): FileReference[];
     /**
      * Does this file need to be transpiled?
-     * @deprecated use the `.editor` property to push changes to the file, which will force transpilation
      */
-    get needsTranspiled(): boolean;
-    set needsTranspiled(value: boolean);
-    _needsTranspiled: boolean;
+    needsTranspiled: boolean;
     /**
      * The AST for this file
      */
     get ast(): import("../parser/Statement").Body;
-    private documentSymbols;
-    private workspaceSymbols;
     /**
      * Get the token at the specified position
      */
@@ -132,26 +108,28 @@ export declare class BrsFile implements File {
      * A reference to the typedef file (if one exists)
      */
     typedefFile?: BrsFile;
+    /**
+     * An unsubscribe function for the dependencyGraph subscription
+     */
+    private unsubscribeFromDependencyGraph;
     /**
      * Find and set the typedef variables (if a matching typedef file exists)
      */
     private resolveTypedef;
-    onDependenciesChanged(): void;
     /**
      * Attach the file to the dependency graph so it can monitor changes.
      * Also notify the dependency graph of our current dependencies so other dependents can be notified.
-     * @deprecated this does nothing. This functionality is now handled by the file api and will be deleted in v1
      */
     attachDependencyGraph(dependencyGraph: DependencyGraph): void;
-    /**
-     * The list of files that this file depends on
-     */
-    get dependencies(): string[];
     /**
      * Calculate the AST for this file
      * @param fileContents the raw source code to parse
      */
     parse(fileContents: string): void;
+    /**
+     * @deprecated logic has moved into BrsFileValidator, this is now an empty function
+     */
+    validate(): void;
     /**
      * Find a class. This scans all scopes for this file, and returns the first matching class that is found.
      * Returns undefined if not found.
@@ -173,6 +151,8 @@ export declare class BrsFile implements File {
      * Create a scope for every function in this file
      */
     private createFunctionScopes;
+    private getBscTypeFromAssignment;
+    private getCallableByName;
     private findCallables;
     private findFunctionCalls;
     /**
@@ -185,15 +165,25 @@ export declare class BrsFile implements File {
      * Find the NamespaceStatement enclosing the given position
      */
     getNamespaceStatementForPosition(position: Position): NamespaceStatement;
-    private getNamespaceDefinitions;
+    /**
+     * Get completions available at the given cursor. This aggregates all values from this file and the current scope.
+     */
+    getCompletions(position: Position, scope?: Scope): CompletionItem[];
+    private getLabelCompletion;
+    private getClassMemberCompletions;
+    getClassFromMReference(position: Position, currentToken: Token, functionScope: FunctionScope): FileLink<ClassStatement> | undefined;
+    private getGlobalClassStatementCompletions;
+    private getNonNamespacedEnumStatementCompletions;
+    private getNonNamespacedConstStatementCompletions;
+    private getEnumMemberStatementCompletions;
+    private getNamespaceCompletions;
     /**
      * Given a current token, walk
      */
     getPartialVariableName(currentToken: Token, excludeTokens?: TokenKind[]): string;
     isPositionNextToTokenKind(position: Position, tokenKind: TokenKind): boolean;
-    isTokenNextToTokenKind(closestToken: Token, tokenKind: TokenKind): boolean;
-    getTokenBefore(currentToken: Token, tokenKind?: TokenKind): Token;
-    tokenFollows(currentToken: Token, tokenKind: TokenKind): boolean;
+    private getTokenBefore;
+    private tokenFollows;
     getTokensUntil(currentToken: Token, tokenKind: TokenKind, direction?: -1 | 1): any[];
     getPreviousToken(token: Token): Token;
     /**
@@ -204,55 +194,43 @@ export declare class BrsFile implements File {
     /**
      * Determine if the callee (i.e. function name) is a known function declared on the given namespace.
      */
-    calleeIsKnownNamespaceFunction(callee: Expression, namespaceName: string): boolean;
+    calleeIsKnownNamespaceFunction(callee: Expression, namespaceName: string | undefined): boolean;
     /**
      * Get the token closest to the position. if no token is found, the previous token is returned
      */
     getClosestToken(position: Position): Token;
     /**
      * Builds a list of document symbols for this file. Used by LanguageServer's onDocumentSymbol functionality
+     * @deprecated use `DocumentSymbolProvider.process()` instead
      */
-    getDocumentSymbols(): DocumentSymbol[];
+    getDocumentSymbols(): import("vscode-languageserver-types").DocumentSymbol[];
     /**
      * Builds a list of workspace symbols for this file. Used by LanguageServer's onWorkspaceSymbol functionality
      */
-    getWorkspaceSymbols(): SymbolInformation[];
-    /**
-     * Builds a single DocumentSymbol object for use by LanguageServer's onDocumentSymbol functionality
-     */
-    private getDocumentSymbol;
-    /**
-     * Builds a single SymbolInformation object for use by LanguageServer's onWorkspaceSymbol functionality
-     */
-    private generateWorkspaceSymbols;
+    getWorkspaceSymbols(): import("vscode-languageserver-types").WorkspaceSymbol[];
     /**
      * Given a position in a file, if the position is sitting on some type of identifier,
      * go to the definition of that identifier (where this thing was first defined)
+     * @deprecated use `DefinitionProvider.process()` instead
      */
     getDefinition(position: Position): Location[];
     getClassMemberDefinitions(textToSearchFor: string, file: BrsFile): Location[];
     getClassMethod(classStatement: ClassStatement, name: string, walkParents?: boolean): MethodStatement | undefined;
-    getReferences(position: Position): Location[];
     /**
-     * Generate the code, map, and typedef for this file
+     * Given a position in a file, if the position is sitting on some type of identifier,
+     * look up all references of that identifier (every place that identifier is used across the whole app)
+     * @deprecated use `ReferencesProvider.process()` instead
      */
-    serialize(): SerializedCodeFile;
+    getReferences(position: Position): Location[];
     /**
      * Convert the brightscript/brighterscript source code into valid brightscript
      */
     transpile(): CodeWithSourceMap;
-    validationSegmenter: AstValidationSegmenter;
-    processSymbolInformation(): void;
-    getValidationSegments(changedSymbols: Map<SymbolTypeFlag, Set<string>>): AstNode[];
-    get requiredSymbols(): UnresolvedSymbol[];
-    get providedSymbols(): {
-        symbolMap: Map<SymbolTypeFlag, Map<string, BscSymbol>>;
-        changes: Map<SymbolTypeFlag, Set<string>>;
-    };
-    private getProvidedSymbols;
-    markSegmentAsValidated(node: AstNode): void;
-    getNamespaceLookupObject(): Map<string, NamespaceContainer>;
-    private buildNamespaceLookup;
     getTypedef(): string;
     dispose(): void;
 }
+/**
+ * List of completions for all valid keywords/reserved words.
+ * Build this list once because it won't change for the lifetime of this process
+ */
+export declare const KeywordCompletions: CompletionItem[];