brighterscript 1.0.0-alpha.27 → 1.0.0-alpha.29

package/dist/parser/Expression.d.ts

@@ -1,5 +1,5 @@
 import type { Token, Identifier } from '../lexer/Token';
-import type { Block, CommentStatement, FunctionStatement } from './Statement';
+import type { Block, FunctionStatement } from './Statement';
 import type { Range } from 'vscode-languageserver';
 import type { BrsTranspileState } from './BrsTranspileState';
 import { ParseMode } from './Parser';
@@ -8,11 +8,12 @@ import type { GetTypeOptions, TranspileResult, TypedefProvider } from '../interf
 import { VoidType } from '../types/VoidType';
 import { DynamicType } from '../types/DynamicType';
 import type { BscType } from '../types/BscType';
-import { TypedFunctionType } from '../types/TypedFunctionType';
 import { AstNodeKind, Expression } from './AstNode';
 import { SourceNode } from 'source-map';
 import type { TranspileState } from './TranspileState';
 import { StringType } from '../types/StringType';
+import { TypedFunctionType } from '../types';
+import { FunctionType } from '../types/FunctionType';
 export declare type ExpressionVisitor = (expression: Expression, parent: Expression) => void;
 export declare class BinaryExpression extends Expression {
     constructor(options: {
@@ -26,12 +27,19 @@ export declare class BinaryExpression extends Expression {
     readonly left: Expression;
     readonly right: Expression;
     readonly kind = AstNodeKind.BinaryExpression;
-    readonly range: Range;
-    transpile(state: BrsTranspileState): (string | SourceNode)[];
+    readonly range: Range | undefined;
+    transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): BscType;
+    getLeadingTrivia(): Token[];
 }
 export declare class CallExpression extends Expression {
+    /**
+     * Number of parameters that can be defined on a function
+     *
+     * Prior to Roku OS 11.5, this was 32
+     * As of Roku OS 11.5, this is 63
+     */
     static MaximumArguments: number;
     constructor(options: {
         callee: Expression;
@@ -49,10 +57,11 @@ export declare class CallExpression extends Expression {
         readonly closingParen?: Token;
     };
     readonly kind = AstNodeKind.CallExpression;
-    readonly range: Range;
-    transpile(state: BrsTranspileState, nameOverride?: string): (string | SourceNode)[];
+    readonly range: Range | undefined;
+    transpile(state: BrsTranspileState, nameOverride?: string): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): any;
+    getLeadingTrivia(): Token[];
 }
 export declare class FunctionExpression extends Expression implements TypedefProvider {
     constructor(options: {
@@ -86,7 +95,7 @@ export declare class FunctionExpression extends Expression implements TypedefPro
      * and ending with the last n' in 'end function' or 'b' in 'end sub'
      */
     get range(): Range;
-    transpile(state: BrsTranspileState, name?: Identifier, includeBody?: boolean): any[];
+    transpile(state: BrsTranspileState, name?: Identifier, includeBody?: boolean): TranspileResult;
     getTypedef(state: BrsTranspileState): SourceNode[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): TypedFunctionType;
@@ -108,10 +117,11 @@ export declare class FunctionParameterExpression extends Expression {
     readonly defaultValue?: Expression;
     readonly typeExpression?: TypeExpression;
     getType(options: GetTypeOptions): BscType;
-    get range(): Range;
-    transpile(state: BrsTranspileState): any[];
+    get range(): Range | undefined;
+    transpile(state: BrsTranspileState): TranspileResult;
     getTypedef(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
+    getLeadingTrivia(): Token[];
 }
 export declare class DottedGetExpression extends Expression {
     constructor(options: {
@@ -128,11 +138,12 @@ export declare class DottedGetExpression extends Expression {
     };
     readonly obj: Expression;
     readonly kind = AstNodeKind.DottedGetExpression;
-    readonly range: Range;
-    transpile(state: BrsTranspileState): (string | SourceNode)[];
+    readonly range: Range | undefined;
+    transpile(state: BrsTranspileState): (string | SourceNode | TranspileResult)[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): BscType;
     getName(parseMode: ParseMode): string;
+    getLeadingTrivia(): Token[];
 }
 export declare class XmlAttributeGetExpression extends Expression {
     constructor(options: {
@@ -149,9 +160,10 @@ export declare class XmlAttributeGetExpression extends Expression {
         at?: Token;
     };
     readonly obj: Expression;
-    readonly range: Range;
-    transpile(state: BrsTranspileState): (string | SourceNode)[];
+    readonly range: Range | undefined;
+    transpile(state: BrsTranspileState): (string | SourceNode | TranspileResult)[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
+    getLeadingTrivia(): Token[];
 }
 export declare class IndexedGetExpression extends Expression {
     constructor(options: {
@@ -175,10 +187,11 @@ export declare class IndexedGetExpression extends Expression {
         readonly closingSquare?: Token;
         readonly questionDot?: Token;
     };
-    readonly range: Range;
+    readonly range: Range | undefined;
     transpile(state: BrsTranspileState): any[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): BscType;
+    getLeadingTrivia(): Token[];
 }
 export declare class GroupingExpression extends Expression {
     constructor(options: {
@@ -192,10 +205,11 @@ export declare class GroupingExpression extends Expression {
     };
     readonly expression: Expression;
     readonly kind = AstNodeKind.GroupingExpression;
-    readonly range: Range;
+    readonly range: Range | undefined;
     transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): BscType;
+    getLeadingTrivia(): Token[];
 }
 export declare class LiteralExpression extends Expression {
     constructor(options: {
@@ -206,9 +220,10 @@ export declare class LiteralExpression extends Expression {
     };
     readonly kind = AstNodeKind.LiteralExpression;
     get range(): Range;
-    getType(options?: GetTypeOptions): DynamicType | import("..").ObjectType | StringType | import("..").IntegerType | import("..").BooleanType | import("..").FloatType | import("..").DoubleType | import("..").LongIntegerType | VoidType | import("../types/FunctionType").FunctionType;
-    transpile(state: BrsTranspileState): SourceNode[];
+    getType(options?: GetTypeOptions): DynamicType | import("../types").ObjectType | StringType | import("../types").IntegerType | import("../types").BooleanType | import("../types").FloatType | import("../types").DoubleType | import("../types").LongIntegerType | VoidType | FunctionType;
+    transpile(state: BrsTranspileState): TranspileResult[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
+    getLeadingTrivia(): Token[];
 }
 /**
  * This is a special expression only used within template strings. It exists so we can prevent producing lots of empty strings
@@ -232,20 +247,21 @@ export declare class EscapedCharCodeLiteralExpression extends Expression {
 }
 export declare class ArrayLiteralExpression extends Expression {
     constructor(options: {
-        elements: Array<Expression | CommentStatement>;
+        elements: Array<Expression>;
         open?: Token;
         close?: Token;
     });
-    readonly elements: Array<Expression | CommentStatement>;
+    readonly elements: Array<Expression>;
     readonly tokens: {
         readonly open?: Token;
         readonly close?: Token;
     };
     readonly kind = AstNodeKind.ArrayLiteralExpression;
-    readonly range: Range;
-    transpile(state: BrsTranspileState): any[];
+    readonly range: Range | undefined;
+    transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): BscType;
+    getLeadingTrivia(): Token[];
 }
 export declare class AAMemberExpression extends Expression {
     constructor(options: {
@@ -256,7 +272,7 @@ export declare class AAMemberExpression extends Expression {
         comma?: Token;
     });
     readonly kind = AstNodeKind.AAMemberExpression;
-    readonly range: Range;
+    readonly range: Range | undefined;
     readonly tokens: {
         readonly key: Token;
         readonly colon?: Token;
@@ -267,23 +283,25 @@ export declare class AAMemberExpression extends Expression {
     transpile(state: BrsTranspileState): any[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): BscType;
+    getLeadingTrivia(): Token[];
 }
 export declare class AALiteralExpression extends Expression {
     constructor(options: {
-        elements: Array<AAMemberExpression | CommentStatement>;
+        elements: Array<AAMemberExpression>;
         open?: Token;
         close?: Token;
     });
-    readonly elements: Array<AAMemberExpression | CommentStatement>;
+    readonly elements: Array<AAMemberExpression>;
     readonly tokens: {
         readonly open?: Token;
         readonly close?: Token;
     };
     readonly kind = AstNodeKind.AALiteralExpression;
-    readonly range: Range;
-    transpile(state: BrsTranspileState): any[];
+    readonly range: Range | undefined;
+    transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): BscType;
+    getLeadingTrivia(): Token[];
 }
 export declare class UnaryExpression extends Expression {
     constructor(options: {
@@ -291,14 +309,15 @@ export declare class UnaryExpression extends Expression {
         right: Expression;
     });
     readonly kind = AstNodeKind.UnaryExpression;
-    readonly range: Range;
+    readonly range: Range | undefined;
     readonly tokens: {
         readonly operator: Token;
     };
     readonly right: Expression;
-    transpile(state: BrsTranspileState): (string | SourceNode)[];
+    transpile(state: BrsTranspileState): (string | SourceNode | TranspileResult)[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): BscType;
+    getLeadingTrivia(): Token[];
 }
 export declare class VariableExpression extends Expression {
     constructor(options: {
@@ -310,9 +329,10 @@ export declare class VariableExpression extends Expression {
     readonly kind = AstNodeKind.VariableExpression;
     readonly range: Range;
     getName(parseMode?: ParseMode): string;
-    transpile(state: BrsTranspileState): any[];
+    transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): BscType;
+    getLeadingTrivia(): Token[];
 }
 export declare class SourceLiteralExpression extends Expression {
     constructor(options: {
@@ -328,8 +348,13 @@ export declare class SourceLiteralExpression extends Expression {
      */
     private findFunctionIndex;
     private getFunctionName;
+    /**
+     * Get the line number from our token or from the closest ancestor that has a range
+     */
+    private getClosestLineNumber;
     transpile(state: BrsTranspileState): SourceNode[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
+    getLeadingTrivia(): Token[];
 }
 /**
  * This expression transpiles and acts exactly like a CallExpression,
@@ -342,7 +367,7 @@ export declare class NewExpression extends Expression {
         call: CallExpression;
     });
     readonly kind = AstNodeKind.NewExpression;
-    readonly range: Range;
+    readonly range: Range | undefined;
     readonly tokens: {
         readonly new?: Token;
     };
@@ -351,9 +376,10 @@ export declare class NewExpression extends Expression {
      * The name of the class to initialize (with optional namespace prefixed)
      */
     get className(): DottedGetExpression | VariableExpression;
-    transpile(state: BrsTranspileState): (string | SourceNode)[];
+    transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): any;
+    getLeadingTrivia(): Token[];
 }
 export declare class CallfuncExpression extends Expression {
     constructor(options: {
@@ -373,10 +399,11 @@ export declare class CallfuncExpression extends Expression {
         readonly closingParen?: Token;
     };
     readonly kind = AstNodeKind.CallfuncExpression;
-    readonly range: Range;
-    transpile(state: BrsTranspileState): any[];
+    readonly range: Range | undefined;
+    transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): BscType;
+    getLeadingTrivia(): Token[];
 }
 /**
  * Since template strings can contain newlines, we need to concatenate multiple strings together with chr() calls.
@@ -388,8 +415,8 @@ export declare class TemplateStringQuasiExpression extends Expression {
     });
     readonly expressions: Array<LiteralExpression | EscapedCharCodeLiteralExpression>;
     readonly kind = AstNodeKind.TemplateStringQuasiExpression;
-    readonly range: Range;
-    transpile(state: BrsTranspileState, skipEmptyStrings?: boolean): any[];
+    readonly range: Range | undefined;
+    transpile(state: BrsTranspileState, skipEmptyStrings?: boolean): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class TemplateStringExpression extends Expression {
@@ -406,9 +433,9 @@ export declare class TemplateStringExpression extends Expression {
     };
     readonly quasis: TemplateStringQuasiExpression[];
     readonly expressions: Expression[];
-    readonly range: Range;
+    readonly range: Range | undefined;
     getType(options: GetTypeOptions): StringType;
-    transpile(state: BrsTranspileState): any[];
+    transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class TaggedTemplateStringExpression extends Expression {
@@ -427,8 +454,8 @@ export declare class TaggedTemplateStringExpression extends Expression {
     };
     readonly quasis: TemplateStringQuasiExpression[];
     readonly expressions: Expression[];
-    readonly range: Range;
-    transpile(state: BrsTranspileState): any[];
+    readonly range: Range | undefined;
+    transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
 }
 export declare class AnnotationExpression extends Expression {
@@ -442,7 +469,7 @@ export declare class AnnotationExpression extends Expression {
         readonly at: Token;
         readonly name: Token;
     };
-    get range(): Range;
+    get range(): Range | undefined;
     readonly name: string;
     call: CallExpression;
     /**
@@ -453,7 +480,7 @@ export declare class AnnotationExpression extends Expression {
     getLeadingTrivia(): Token[];
     transpile(state: BrsTranspileState): any[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
-    getTypedef(state: BrsTranspileState): (string | SourceNode)[];
+    getTypedef(state: BrsTranspileState): (string | SourceNode | TranspileResult)[];
 }
 export declare class TernaryExpression extends Expression {
     constructor(options: {
@@ -464,7 +491,7 @@ export declare class TernaryExpression extends Expression {
         alternate?: Expression;
     });
     readonly kind = AstNodeKind.TernaryExpression;
-    readonly range: Range;
+    readonly range: Range | undefined;
     readonly tokens: {
         readonly questionMark?: Token;
         readonly colon?: Token;
@@ -472,8 +499,9 @@ export declare class TernaryExpression extends Expression {
     readonly test: Expression;
     readonly consequent?: Expression;
     readonly alternate?: Expression;
-    transpile(state: BrsTranspileState): any[];
+    transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
+    getLeadingTrivia(): Token[];
 }
 export declare class NullCoalescingExpression extends Expression {
     constructor(options: {
@@ -482,14 +510,15 @@ export declare class NullCoalescingExpression extends Expression {
         alternate: Expression;
     });
     readonly kind = AstNodeKind.NullCoalescingExpression;
-    readonly range: Range;
+    readonly range: Range | undefined;
     readonly tokens: {
         readonly questionQuestion?: Token;
     };
     readonly consequent: Expression;
     readonly alternate: Expression;
-    transpile(state: BrsTranspileState): any[];
+    transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
+    getLeadingTrivia(): Token[];
 }
 export declare class RegexLiteralExpression extends Expression {
     constructor(options: {
@@ -502,10 +531,11 @@ export declare class RegexLiteralExpression extends Expression {
     get range(): Range;
     transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
+    getLeadingTrivia(): Token[];
 }
 declare type ExpressionValue = string | number | boolean | Expression | ExpressionValue[] | {
     [key: string]: ExpressionValue;
-};
+} | null;
 export declare class TypeExpression extends Expression implements TypedefProvider {
     constructor(options: {
         /**
@@ -522,7 +552,7 @@ export declare class TypeExpression extends Expression implements TypedefProvide
     transpile(state: BrsTranspileState): TranspileResult;
     walk(visitor: WalkVisitor, options: WalkOptions): void;
     getType(options: GetTypeOptions): BscType;
-    getTypedef(state: TranspileState): (string | SourceNode)[];
+    getTypedef(state: TranspileState): TranspileResult;
     getName(parseMode?: ParseMode): string;
     getNameParts(): string[];
 }