brighterscript 1.0.0-alpha.2 → 1.0.0-alpha.20

package/dist/parser/Statement.d.ts

@@ -1,13 +1,18 @@
-import type { Token, Identifier } from '../lexer';
-import { TokenKind } from '../lexer';
-import type { Expression, NamespacedVariableNameExpression, FunctionExpression, AnnotationExpression } from './Expression';
+import type { Token, Identifier } from '../lexer/Token';
+import { TokenKind } from '../lexer/TokenKind';
+import type { Expression, NamespacedVariableNameExpression, FunctionExpression, AnnotationExpression, TypeExpression } from './Expression';
 import type { Range } from 'vscode-languageserver';
 import type { BrsTranspileState } from './BrsTranspileState';
 import { ParseMode } from './Parser';
 import type { WalkVisitor, WalkOptions } from '../astUtils/visitors';
 import { InternalWalkMode } from '../astUtils/visitors';
-import type { TranspileResult, TypedefProvider } from '../interfaces';
+import type { TranspileResult, TypedefProvider, MemberSymbolTableProvider, InheritableStatement } from '../interfaces';
+import { DynamicType } from '../types/DynamicType';
+import type { SourceNode } from 'source-map';
+import type { TranspileState } from './TranspileState';
 import { SymbolTable } from '../SymbolTable';
+import { CustomType } from '../types/CustomType';
+import { InterfaceType } from '../types/InterfaceType';
 /**
  * A BrightScript statement
  */
@@ -15,7 +20,7 @@ export declare abstract class Statement {
     /**
      *  The starting and ending location of the statement.
      **/
-    abstract range: Range;
+    abstract readonly range: Range;
     /**
      * Statement annotations
      */
@@ -46,7 +51,7 @@ export declare class EmptyStatement extends Statement {
 export declare class Body extends Statement implements TypedefProvider {
     statements: Statement[];
     constructor(statements?: Statement[]);
-    get range(): Range;
+    readonly range: Range;
     transpile(state: BrsTranspileState): TranspileResult;
     getTypedef(state: BrsTranspileState): any[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
@@ -79,10 +84,10 @@ export declare class ExpressionStatement extends Statement {
 export declare class CommentStatement extends Statement implements Expression, TypedefProvider {
     comments: Token[];
     constructor(comments: Token[]);
-    range: Range;
+    readonly range: Range;
     get text(): string;
     transpile(state: BrsTranspileState): any[];
-    getTypedef(state: BrsTranspileState): any[];
+    getTypedef(state: TranspileState): any[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class ExitForStatement extends Statement {
@@ -93,7 +98,7 @@ export declare class ExitForStatement extends Statement {
         exitFor: Token;
     });
     readonly range: Range;
-    transpile(state: BrsTranspileState): (string | import("source-map").SourceNode)[];
+    transpile(state: BrsTranspileState): SourceNode[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class ExitWhileStatement extends Statement {
@@ -104,7 +109,7 @@ export declare class ExitWhileStatement extends Statement {
         exitWhile: Token;
     });
     readonly range: Range;
-    transpile(state: BrsTranspileState): (string | import("source-map").SourceNode)[];
+    transpile(state: BrsTranspileState): SourceNode[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class FunctionStatement extends Statement implements TypedefProvider {
@@ -112,7 +117,9 @@ export declare class FunctionStatement extends Statement implements TypedefProvi
     func: FunctionExpression;
     namespaceName: NamespacedVariableNameExpression;
     constructor(name: Identifier, func: FunctionExpression, namespaceName: NamespacedVariableNameExpression);
-    readonly range: Range;
+    get range(): Range;
+    cacheRange(): Range;
+    protected _range: Range;
     /**
      * Get the name of this expression based on the parse mode
      */
@@ -147,7 +154,7 @@ export declare class IncrementStatement extends Statement {
     readonly operator: Token;
     constructor(value: Expression, operator: Token);
     readonly range: Range;
-    transpile(state: BrsTranspileState): (string | import("source-map").SourceNode)[];
+    transpile(state: BrsTranspileState): (string | SourceNode)[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 /** Used to indent the current `print` position to the next 16-character-width output zone. */
@@ -175,7 +182,7 @@ export declare class PrintStatement extends Statement {
         print: Token;
     }, expressions: Array<Expression | PrintSeparatorTab | PrintSeparatorSpace>);
     readonly range: Range;
-    transpile(state: BrsTranspileState): (string | import("source-map").SourceNode)[];
+    transpile(state: BrsTranspileState): (string | SourceNode)[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class DimStatement extends Statement {
@@ -185,8 +192,8 @@ export declare class DimStatement extends Statement {
     dimensions?: Expression[];
     closingSquare?: Token;
     constructor(dimToken: Token, identifier?: Identifier, openingSquare?: Token, dimensions?: Expression[], closingSquare?: Token);
-    range: Range;
-    transpile(state: BrsTranspileState): (string | import("source-map").SourceNode)[];
+    readonly range: Range;
+    transpile(state: BrsTranspileState): (string | SourceNode)[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class GotoStatement extends Statement {
@@ -199,7 +206,7 @@ export declare class GotoStatement extends Statement {
         label: Token;
     });
     readonly range: Range;
-    transpile(state: BrsTranspileState): (string | import("source-map").SourceNode)[];
+    transpile(state: BrsTranspileState): (string | SourceNode)[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class LabelStatement extends Statement {
@@ -212,7 +219,7 @@ export declare class LabelStatement extends Statement {
         colon: Token;
     });
     readonly range: Range;
-    transpile(state: BrsTranspileState): (string | import("source-map").SourceNode)[];
+    transpile(state: BrsTranspileState): SourceNode[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class ReturnStatement extends Statement {
@@ -235,7 +242,7 @@ export declare class EndStatement extends Statement {
         end: Token;
     });
     readonly range: Range;
-    transpile(state: BrsTranspileState): (string | import("source-map").SourceNode)[];
+    transpile(state: BrsTranspileState): SourceNode[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class StopStatement extends Statement {
@@ -246,7 +253,7 @@ export declare class StopStatement extends Statement {
         stop: Token;
     });
     readonly range: Range;
-    transpile(state: BrsTranspileState): (string | import("source-map").SourceNode)[];
+    transpile(state: BrsTranspileState): SourceNode[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class ForStatement extends Statement {
@@ -294,7 +301,9 @@ export declare class DottedSetStatement extends Statement {
     readonly obj: Expression;
     readonly name: Identifier;
     readonly value: Expression;
-    constructor(obj: Expression, name: Identifier, value: Expression);
+    dot: Token;
+    operator: Token;
+    constructor(obj: Expression, name: Identifier, value: Expression, dot: Token, operator: Token);
     readonly range: Range;
     transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
@@ -305,7 +314,8 @@ export declare class IndexedSetStatement extends Statement {
     readonly value: Expression;
     readonly openingSquare: Token;
     readonly closingSquare: Token;
-    constructor(obj: Expression, index: Expression, value: Expression, openingSquare: Token, closingSquare: Token);
+    operator: Token;
+    constructor(obj: Expression, index: Expression, value: Expression, openingSquare: Token, closingSquare: Token, operator: Token);
     readonly range: Range;
     transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
@@ -332,11 +342,13 @@ export declare class NamespaceStatement extends Statement implements TypedefProv
     readonly parentSymbolTable?: SymbolTable;
     readonly symbolTable: SymbolTable;
     constructor(keyword: Token, nameExpression: NamespacedVariableNameExpression, body: Body, endKeyword: Token, parentSymbolTable?: SymbolTable);
+    get range(): Range;
+    cacheRange(): Range;
+    private _range;
     /**
      * The string name for this namespace
      */
     name: string;
-    get range(): Range;
     getName(parseMode: ParseMode): string;
     transpile(state: BrsTranspileState): TranspileResult;
     getTypedef(state: BrsTranspileState): string[];
@@ -347,15 +359,69 @@ export declare class ImportStatement extends Statement implements TypedefProvide
     readonly filePathToken: Token;
     constructor(importToken: Token, filePathToken: Token);
     filePath: string;
-    range: Range;
-    transpile(state: BrsTranspileState): (string | import("source-map").SourceNode)[];
+    readonly range: Range;
+    transpile(state: BrsTranspileState): (string | SourceNode)[];
     /**
      * Get the typedef for this statement
      */
     getTypedef(state: BrsTranspileState): string[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
-export declare class ClassStatement extends Statement implements TypedefProvider {
+export declare class InterfaceStatement extends Statement implements TypedefProvider, MemberSymbolTableProvider {
+    name: Identifier;
+    parentInterfaceName: NamespacedVariableNameExpression;
+    body: Statement[];
+    namespaceName: NamespacedVariableNameExpression;
+    readonly memberTable: SymbolTable;
+    constructor(interfaceToken: Token, name: Identifier, extendsToken: Token, parentInterfaceName: NamespacedVariableNameExpression, body: Statement[], endInterfaceToken: Token, namespaceName: NamespacedVariableNameExpression);
+    tokens: {
+        interface: Token;
+        name: Identifier;
+        extends: Token;
+        endInterface: Token;
+    };
+    readonly range: Range;
+    memberMap: Record<string, InterfaceMemberStatement>;
+    methods: InterfaceMethodStatement[];
+    fields: InterfaceFieldStatement[];
+    /**
+     * The name of the interface WITH its leading namespace (if applicable)
+     */
+    getName(parseMode: ParseMode): string;
+    buildSymbolTable(parentIface?: InheritableStatement): void;
+    hasParent(): boolean;
+    getParentName(): boolean;
+    /**
+     * Gets an array of possible parent interface names, taking into account the namespace this interface was created under
+     * @returns array of possible parent interface names
+     */
+    getPossibleFullParentNames(): string[];
+    getThisBscType(): InterfaceType;
+    transpile(state: BrsTranspileState): TranspileResult;
+    getTypedef(state: BrsTranspileState): TranspileResult;
+    walk(visitor: WalkVisitor, options: WalkOptions): void;
+}
+export declare class InterfaceFieldStatement extends Statement implements TypedefProvider {
+    type?: TypeExpression;
+    namespaceName?: NamespacedVariableNameExpression;
+    transpile(state: BrsTranspileState): TranspileResult;
+    constructor(nameToken: Identifier, asToken: Token, type?: TypeExpression, namespaceName?: NamespacedVariableNameExpression);
+    readonly range: Range;
+    tokens: {
+        name: Identifier;
+        as: Token;
+    };
+    getType(): import("../types/BscType").BscType;
+    get name(): Identifier;
+    walk(visitor: WalkVisitor, options: WalkOptions): void;
+    getTypedef(state: BrsTranspileState): (string | SourceNode)[];
+}
+export declare class InterfaceMethodStatement extends FunctionStatement implements TypedefProvider {
+    transpile(state: BrsTranspileState): TranspileResult;
+    constructor(name: Identifier, func: FunctionExpression);
+    walk(visitor: WalkVisitor, options: WalkOptions): void;
+}
+export declare class ClassStatement extends Statement implements TypedefProvider, MemberSymbolTableProvider {
     readonly classKeyword: Token;
     /**
      * The name of the class (without namespace prefix)
@@ -366,16 +432,22 @@ export declare class ClassStatement extends Statement implements TypedefProvider
     readonly extendsKeyword?: Token;
     readonly parentClassName?: NamespacedVariableNameExpression;
     readonly namespaceName?: NamespacedVariableNameExpression;
+    readonly currentSymbolTable?: SymbolTable;
+    readonly symbolTable: SymbolTable;
+    readonly memberTable: SymbolTable;
     constructor(classKeyword: Token, 
     /**
      * The name of the class (without namespace prefix)
      */
-    name: Identifier, body: Statement[], end: Token, extendsKeyword?: Token, parentClassName?: NamespacedVariableNameExpression, namespaceName?: NamespacedVariableNameExpression);
+    name: Identifier, body: Statement[], end: Token, extendsKeyword?: Token, parentClassName?: NamespacedVariableNameExpression, namespaceName?: NamespacedVariableNameExpression, currentSymbolTable?: SymbolTable);
     getName(parseMode: ParseMode): string;
     memberMap: Record<string, ClassMemberStatement>;
     methods: ClassMethodStatement[];
     fields: ClassFieldStatement[];
     readonly range: Range;
+    getThisBscType(): CustomType;
+    getConstructorFunctionType(): import("../types/TypedFunctionType").TypedFunctionType;
+    buildSymbolTable(parentClass?: InheritableStatement): void;
     transpile(state: BrsTranspileState): any[];
     getTypedef(state: BrsTranspileState): TranspileResult;
     /**
@@ -384,7 +456,12 @@ export declare class ClassStatement extends Statement implements TypedefProvider
      * The base class is index 0, its child is index 1, and so on.
      */
     getParentClassIndex(state: BrsTranspileState): number;
-    hasParentClass(): boolean;
+    hasParent(): boolean;
+    /**
+     * Gets an array of possible parent class names, taking into account the namespace this class was created under
+     * @returns array of possible parent class names
+     */
+    getPossibleFullParentNames(): string[];
     /**
      * Get all ancestor classes, in closest-to-furthest order (i.e. 0 is parent, 1 is grandparent, etc...).
      * This will return an empty array if no ancestors were found
@@ -396,6 +473,10 @@ export declare class ClassStatement extends Statement implements TypedefProvider
      */
     private getConstructorFunction;
     private getEmptyNewFunction;
+    /**
+     * Create an empty `new` function if class is missing it (simplifies transpile logic)
+     */
+    private ensureConstructorFunctionExists;
     /**
      * Determine if the specified field was declared in one of the ancestor classes
      */
@@ -415,10 +496,11 @@ export declare class ClassStatement extends Statement implements TypedefProvider
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class ClassMethodStatement extends FunctionStatement {
-    readonly accessModifier: Token;
-    readonly override: Token;
+    accessModifier: Token;
+    override: Token;
     constructor(accessModifier: Token, name: Identifier, func: FunctionExpression, override: Token);
-    readonly range: Range;
+    get range(): Range;
+    cacheRange(): Range;
     transpile(state: BrsTranspileState): any[];
     getTypedef(state: BrsTranspileState): string[];
     /**
@@ -436,29 +518,49 @@ export declare class ClassFieldStatement extends Statement implements TypedefPro
     readonly accessModifier?: Token;
     readonly name?: Identifier;
     readonly as?: Token;
-    readonly type?: Token;
+    readonly type?: TypeExpression;
     readonly equal?: Token;
     readonly initialValue?: Expression;
-    constructor(accessModifier?: Token, name?: Identifier, as?: Token, type?: Token, equal?: Token, initialValue?: Expression);
+    readonly namespaceName?: NamespacedVariableNameExpression;
+    constructor(accessModifier?: Token, name?: Identifier, as?: Token, type?: TypeExpression, equal?: Token, initialValue?: Expression, namespaceName?: NamespacedVariableNameExpression);
+    readonly range: Range;
     /**
      * Derive a ValueKind from the type token, or the initial value.
      * Defaults to `DynamicType`
      */
-    getType(): import("../types/ObjectType").ObjectType | import("../types/BooleanType").BooleanType | import("../types/InvalidType").InvalidType | import("../types/StringType").StringType | import("../types/VoidType").VoidType;
-    readonly range: Range;
+    getType(parseMode?: ParseMode): DynamicType | import("../types/BscType").BscType;
     transpile(state: BrsTranspileState): TranspileResult;
     getTypedef(state: BrsTranspileState): any[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare type ClassMemberStatement = ClassFieldStatement | ClassMethodStatement;
+export declare type InterfaceMemberStatement = InterfaceFieldStatement | InterfaceMethodStatement;
+export declare type MemberFieldStatement = ClassFieldStatement | InterfaceFieldStatement;
+export declare type MemberMethodStatement = ClassMethodStatement | InterfaceMethodStatement;
 export declare class TryCatchStatement extends Statement {
-    tryToken: Token;
+    tokens: {
+        try: Token;
+        endTry?: Token;
+    };
     tryBranch?: Block;
-    catchToken?: Token;
+    catchStatement?: CatchStatement;
+    constructor(tokens: {
+        try: Token;
+        endTry?: Token;
+    }, tryBranch?: Block, catchStatement?: CatchStatement);
+    readonly range: Range;
+    transpile(state: BrsTranspileState): TranspileResult;
+    walk(visitor: WalkVisitor, options: WalkOptions): void;
+}
+export declare class CatchStatement extends Statement {
+    tokens: {
+        catch: Token;
+    };
     exceptionVariable?: Identifier;
     catchBranch?: Block;
-    endTryToken?: Token;
-    constructor(tryToken: Token, tryBranch?: Block, catchToken?: Token, exceptionVariable?: Identifier, catchBranch?: Block, endTryToken?: Token);
+    constructor(tokens: {
+        catch: Token;
+    }, exceptionVariable?: Identifier, catchBranch?: Block);
     get range(): Range;
     transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
@@ -467,7 +569,59 @@ export declare class ThrowStatement extends Statement {
     throwToken: Token;
     expression?: Expression;
     constructor(throwToken: Token, expression?: Expression);
-    range: Range;
-    transpile(state: BrsTranspileState): (string | import("source-map").SourceNode)[];
+    readonly range: Range;
+    transpile(state: BrsTranspileState): (string | SourceNode)[];
+    walk(visitor: WalkVisitor, options: WalkOptions): void;
+}
+export declare class EnumStatement extends Statement implements TypedefProvider {
+    tokens: {
+        enum: Token;
+        name: Identifier;
+        endEnum: Token;
+    };
+    body: Array<EnumMemberStatement | CommentStatement>;
+    namespaceName?: NamespacedVariableNameExpression;
+    constructor(tokens: {
+        enum: Token;
+        name: Identifier;
+        endEnum: Token;
+    }, body: Array<EnumMemberStatement | CommentStatement>, namespaceName?: NamespacedVariableNameExpression);
+    readonly range: Range;
+    getMembers(): EnumMemberStatement[];
+    /**
+     * Get a map of member names and their values.
+     * All values are stored as their AST LiteralExpression representation (i.e. string enum values include the wrapping quotes)
+     */
+    getMemberValueMap(): Map<string, string>;
+    getMemberValue(name: string): string;
+    /**
+     * The name of the enum (without the namespace prefix)
+     */
+    get name(): string;
+    /**
+     * The name of the enum WITH its leading namespace (if applicable)
+     */
+    get fullName(): string;
+    transpile(state: BrsTranspileState): any[];
+    getTypedef(state: BrsTranspileState): TranspileResult;
+    walk(visitor: WalkVisitor, options: WalkOptions): void;
+}
+export declare class EnumMemberStatement extends Statement implements TypedefProvider {
+    tokens: {
+        name: Identifier;
+        equal?: Token;
+    };
+    value?: Expression;
+    constructor(tokens: {
+        name: Identifier;
+        equal?: Token;
+    }, value?: Expression);
+    readonly range: Range;
+    /**
+     * The name of the member
+     */
+    get name(): string;
+    transpile(state: BrsTranspileState): TranspileResult;
+    getTypedef(state: BrsTranspileState): (string | SourceNode)[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }