brighterscript 1.0.0-alpha.5 → 1.0.0-alpha.51

package/dist/files/XmlFile.d.ts

@@ -1,52 +1,93 @@
 import type { CodeWithSourceMap } from 'source-map';
-import type { CompletionItem, Hover, Location, Position, Range } from 'vscode-languageserver';
-import type { Callable, BsDiagnostic, FileReference, FunctionCall, CommentFlag, BscFile } from '../interfaces';
+import type { Location, Position, Range } from 'vscode-languageserver';
+import type { Callable, FileReference, CommentFlag, SerializedCodeFile } from '../interfaces';
 import type { Program } from '../Program';
 import SGParser from '../parser/SGParser';
-import type { DependencyGraph } from '../DependencyGraph';
-import type { SGAst, SGToken } from '../parser/SGTypes';
+import type { DependencyChangedEvent, DependencyGraph } from '../DependencyGraph';
+import type { SGToken } from '../parser/SGTypes';
 import type { IToken, TokenType } from 'chevrotain';
-import type { FunctionExpression } from '../parser/Expression';
-export declare class XmlFile {
+import type { BscFile } from './BscFile';
+import type { Editor } from '../astUtils/Editor';
+import type { FunctionScope } from '../FunctionScope';
+import { SymbolTypeFlag } from '../SymbolTypeFlag';
+export interface UnresolvedXMLSymbol {
+    flags: SymbolTypeFlag;
+    name: string;
+    file: XmlFile;
+}
+export declare class XmlFile implements BscFile {
+    /**
+     * Create a new instance of BrsFile
+     */
+    constructor(options: {
+        /**
+         * The absolute path to the source file on disk (e.g. '/usr/you/projects/RokuApp/source/main.brs' or 'c:/projects/RokuApp/source/main.brs').
+         */
+        srcPath: string;
+        /**
+         * The absolute path to the file on-device (i.e. 'source/main.brs') without the leading `pkg:/`
+         */
+        destPath: string;
+        pkgPath?: string;
+        program: Program;
+    });
+    type: string;
     /**
      * The absolute path to the source file on disk (e.g. '/usr/you/projects/RokuApp/source/main.brs' or 'c:/projects/RokuApp/source/main.brs').
      */
     srcPath: string;
     /**
-     * The full pkg path (i.e. `pkg:/path/to/file.brs`)
+     * The absolute path to the file on-device (i.e. 'source/main.brs') without the leading `pkg:/`
      */
+    destPath: string;
     pkgPath: string;
     program: Program;
-    constructor(
     /**
-     * The absolute path to the source file on disk (e.g. '/usr/you/projects/RokuApp/source/main.brs' or 'c:/projects/RokuApp/source/main.brs').
+     * An editor assigned during the build flow that manages edits that will be undone once the build process is complete.
      */
-    srcPath: string, 
+    editor?: Editor;
     /**
-     * The full pkg path (i.e. `pkg:/path/to/file.brs`)
+     * The absolute path to the source location for this file
+     * @deprecated use `srcPath` instead
      */
-    pkgPath: string, program: Program);
+    get pathAbsolute(): string;
+    set pathAbsolute(value: string);
     private cache;
     /**
      * The list of possible autoImport codebehind pkg paths.
+     * @deprecated use `possibleCodebehindDestPaths` instead.
      */
-    private possibleCodebehindPkgPaths;
+    get possibleCodebehindPkgPaths(): string[];
+    set possibleCodebehindPkgPaths(value: string[]);
+    /**
+     * The list of possible autoImport codebehind destPath values
+     */
+    possibleCodebehindDestPaths: string[];
     /**
      * An unsubscribe function for the dependencyGraph subscription
      */
     private unsubscribeFromDependencyGraph;
+    /**
+     * Indicates whether this file needs to be validated.
+     * Files are only ever validated a single time
+     */
+    isValidated: boolean;
     /**
      * The extension for this file
      */
     extension: string;
     commentFlags: CommentFlag[];
+    /**
+     * 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.
+     */
+    readonly canBePruned = false;
     /**
      * The list of script imports delcared in the XML of this file.
      * This excludes parent imports and auto codebehind imports
      */
     get scriptTagImports(): FileReference[];
     /**
-     * List of all pkgPaths to scripts that this XmlFile depends, regardless of whether they are loaded in the program or not.
+     * List of all `destPath` values pointing to scripts that this XmlFile depends on, regardless of whether they are loaded in the program or not.
      * This includes own dependencies and all parent compoent dependencies
      * coming from:
      *  - script tags
@@ -55,7 +96,7 @@ export declare class XmlFile {
      */
     getAllDependencies(): string[];
     /**
-     * List of all pkgPaths to scripts that this XmlFile depends on directly, regardless of whether they are loaded in the program or not.
+     * List of all destPaths to scripts that this XmlFile depends on directly, regardless of whether they are loaded in the program or not.
      * This does not account for parent component scripts
      * coming from:
      *  - script tags
@@ -64,7 +105,7 @@ export declare class XmlFile {
      */
     getOwnDependencies(): string[];
     /**
-     * List of all pkgPaths to scripts that this XmlFile depends on that are actually loaded into the program.
+     * List of all destPaths to scripts that this XmlFile depends on that are actually loaded into the program.
      * This does not account for parent component scripts.
      * coming from:
      *  - script tags
@@ -72,16 +113,14 @@ export declare class XmlFile {
      *  - import statements from imported scripts or their descendants
      */
     getAvailableScriptImports(): string[];
-    getDiagnostics(): BsDiagnostic[];
-    addDiagnostics(diagnostics: BsDiagnostic[]): void;
+    get requiredSymbols(): UnresolvedXMLSymbol[];
     /**
      * The range of the entire file
      */
     fileRange: Range;
-    diagnostics: BsDiagnostic[];
     parser: SGParser;
     callables: Callable[];
-    functionCalls: FunctionCall[];
+    functionScopes: FunctionScope[];
     /**
      * The name of the component that this component extends.
      * Available after `parse()`
@@ -94,39 +133,46 @@ export declare class XmlFile {
     get componentName(): SGToken;
     /**
      * Does this file need to be transpiled?
+     * @deprecated use the `.editor` property to push changes to the file, which will force transpilation
      */
-    needsTranspiled: boolean;
+    get needsTranspiled(): boolean;
+    set needsTranspiled(value: boolean);
+    _needsTranspiled: boolean;
     /**
      * The AST for this file
      */
-    get ast(): SGAst;
+    get ast(): import("../parser/SGTypes").SGAst;
     /**
      * The full file contents
      */
     fileContents: string;
-    /**
-     * Indicates whether this file needs to be validated.
-     */
-    isValidated: boolean;
     /**
      * Calculate the AST for this file
-     * @param fileContents
+     * @param fileContents the xml source code to parse
      */
     parse(fileContents: string): void;
+    /**
+     * Generate the code, map, and typedef for this file
+     */
+    serialize(): SerializedCodeFile;
     /**
      * Collect all bs: comment flags
      */
     getCommentFlags(tokens: Array<IToken & {
         tokenType: TokenType;
     }>): void;
-    validate(): void;
-    private validateComponent;
     private dependencyGraph;
+    onDependenciesChanged(event: DependencyChangedEvent): 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[];
     /**
      * A slight hack. Gives the Program a way to support multiple components with the same name
      * without causing major issues. A value of 0 will be ignored as part of the dependency graph key.
@@ -138,9 +184,10 @@ export declare class XmlFile {
     /**
      * The key used in the dependency graph for this file.
      * If we have a component name, we will use that so we can be discoverable by child components.
-     * If we don't have a component name, use the pkgPath so at least we can self-validate
+     * If we don't have a component name, use the destPath so at least we can self-validate
      */
     get dependencyGraphKey(): string;
+    set dependencyGraphKey(value: string);
     /**
      * The key used in the dependency graph for this component's parent.
      * If we have aparent, we will use that. If we don't, this will return undefined
@@ -148,26 +195,18 @@ export declare class XmlFile {
     get parentComponentDependencyGraphKey(): string;
     /**
      * Determines if this xml file has a reference to the specified file (or if it's itself)
-     * @param file
      */
     doesReferenceFile(file: BscFile): boolean;
-    /**
-     * Get all available completions for the specified position
-     * @param lineIndex
-     * @param columnIndex
-     */
-    getCompletions(position: Position): CompletionItem[];
     /**
      * Get the parent component (the component this component extends)
      */
     get parentComponent(): XmlFile;
-    getHover(position: Position): Hover;
     getReferences(position: Position): Promise<Location[]>;
-    getFunctionExpressionAtPosition(position: Position, functionExpressions?: FunctionExpression[]): FunctionExpression;
+    getFunctionScopeAtPosition(position: Position, functionScopes?: FunctionScope[]): FunctionScope;
     /**
      * Walk up the ancestor chain and aggregate all of the script tag imports
      */
-    getAncestorScriptTagImports(): any[];
+    getAncestorScriptTagImports(): FileReference[];
     /**
      * Remove this file from the dependency graph as a node
      */
@@ -178,7 +217,7 @@ export declare class XmlFile {
      * and only includes the ones that are not found on the parent.
      * If no parent is found, all imports are returned
      */
-    private getMissingImportsForTranspile;
+    getMissingImportsForTranspile(): string[];
     private logDebug;
     /**
      * Convert the brightscript/brighterscript source code into valid brightscript