brighterscript 0.57.2 → 0.58.0

package/dist/parser/AstNode.d.ts

@@ -0,0 +1,65 @@
+import type { WalkVisitor, WalkOptions } from '../astUtils/visitors';
+import type { Position, Range } from 'vscode-languageserver';
+import { InternalWalkMode } from '../astUtils/visitors';
+import type { SymbolTable } from '../SymbolTable';
+import type { BrsTranspileState } from './BrsTranspileState';
+import type { TranspileResult } from '../interfaces';
+import type { AnnotationExpression } from './Expression';
+/**
+ * A BrightScript AST node
+ */
+export declare abstract class AstNode {
+    /**
+     *  The starting and ending location of the node.
+     **/
+    abstract range: Range;
+    abstract transpile(state: BrsTranspileState): TranspileResult;
+    /**
+     * When being considered by the walk visitor, this describes what type of element the current class is.
+     */
+    visitMode: InternalWalkMode;
+    abstract walk(visitor: WalkVisitor, options: WalkOptions): any;
+    /**
+     * The parent node for this statement. This is set dynamically during `onFileValidate`, and should not be set directly.
+     */
+    parent?: AstNode;
+    /**
+     * Certain expressions or statements can have a symbol table (such as blocks, functions, namespace bodies, etc).
+     * If you're interested in getting the closest SymbolTable, use `getSymbolTable` instead.
+     */
+    symbolTable?: SymbolTable;
+    /**
+     * Get the closest symbol table for this node. Should be overridden in children that directly contain a symbol table
+     */
+    getSymbolTable(): SymbolTable;
+    /**
+     * Walk upward and return the first node that results in `true` from the matcher
+     */
+    findAncestor<TNode extends AstNode = AstNode>(matcher: (node: AstNode) => boolean | undefined): TNode;
+    /**
+     * Find the first child where the matcher evaluates to true.
+     * @param matcher a function called for each node. If you return true, this function returns the specified node. If you return a node, that node is returned. all other return values continue the loop
+     */
+    findChild<TNodeType extends AstNode = AstNode>(matcher: (node: AstNode) => boolean | AstNode, options?: WalkOptions): TNodeType;
+    /**
+     * FInd the deepest child that includes the given position
+     */
+    findChildAtPosition<TNodeType extends AstNode = AstNode>(position: Position, options?: WalkOptions): TNodeType;
+}
+export declare abstract class Statement extends AstNode {
+    /**
+     * When being considered by the walk visitor, this describes what type of element the current class is.
+     */
+    visitMode: InternalWalkMode;
+    /**
+     * Annotations for this statement
+     */
+    annotations: AnnotationExpression[];
+}
+/** A BrightScript expression */
+export declare abstract class Expression extends AstNode {
+    /**
+     * When being considered by the walk visitor, this describes what type of element the current class is.
+     */
+    visitMode: InternalWalkMode;
+}

package/dist/parser/AstNode.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Expression = exports.Statement = exports.AstNode = void 0;
+const visitors_1 = require("../astUtils/visitors");
+const vscode_languageserver_1 = require("vscode-languageserver");
+const visitors_2 = require("../astUtils/visitors");
+const util_1 = require("../util");
+/**
+ * A BrightScript AST node
+ */
+class AstNode {
+    constructor() {
+        /**
+         * When being considered by the walk visitor, this describes what type of element the current class is.
+         */
+        this.visitMode = visitors_2.InternalWalkMode.visitStatements;
+    }
+    /**
+     * Get the closest symbol table for this node. Should be overridden in children that directly contain a symbol table
+     */
+    getSymbolTable() {
+        var _a;
+        if (this.symbolTable) {
+            return this.symbolTable;
+        }
+        else {
+            return (_a = this.parent) === null || _a === void 0 ? void 0 : _a.getSymbolTable();
+        }
+    }
+    /**
+     * Walk upward and return the first node that results in `true` from the matcher
+     */
+    findAncestor(matcher) {
+        let node = this.parent;
+        while (node) {
+            if (matcher(node)) {
+                return node;
+            }
+            node = node.parent;
+        }
+    }
+    /**
+     * Find the first child where the matcher evaluates to true.
+     * @param matcher a function called for each node. If you return true, this function returns the specified node. If you return a node, that node is returned. all other return values continue the loop
+     */
+    findChild(matcher, options) {
+        const cancel = new vscode_languageserver_1.CancellationTokenSource();
+        let result;
+        this.walk((node) => {
+            const matcherValue = matcher(node);
+            if (matcherValue) {
+                cancel.cancel();
+                result = matcherValue === true ? node : matcherValue;
+            }
+        }, Object.assign(Object.assign({ walkMode: visitors_1.WalkMode.visitAllRecursive }, options !== null && options !== void 0 ? options : {}), { cancel: cancel.token }));
+        return result;
+    }
+    /**
+     * FInd the deepest child that includes the given position
+     */
+    findChildAtPosition(position, options) {
+        return this.findChild((node) => {
+            var _a;
+            //if the current node includes this range, keep that node
+            if (util_1.default.rangeContains(node.range, position)) {
+                return (_a = node.findChildAtPosition(position, options)) !== null && _a !== void 0 ? _a : node;
+            }
+        }, options);
+    }
+}
+exports.AstNode = AstNode;
+class Statement extends AstNode {
+    constructor() {
+        super(...arguments);
+        /**
+         * When being considered by the walk visitor, this describes what type of element the current class is.
+         */
+        this.visitMode = visitors_2.InternalWalkMode.visitStatements;
+    }
+}
+exports.Statement = Statement;
+/** A BrightScript expression */
+class Expression extends AstNode {
+    constructor() {
+        super(...arguments);
+        /**
+         * When being considered by the walk visitor, this describes what type of element the current class is.
+         */
+        this.visitMode = visitors_2.InternalWalkMode.visitExpressions;
+    }
+}
+exports.Expression = Expression;
+//# sourceMappingURL=AstNode.js.map

package/dist/parser/AstNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AstNode.js","sourceRoot":"","sources":["../../src/parser/AstNode.ts"],"names":[],"mappings":";;;AACA,mDAAgD;AAEhD,iEAAgE;AAChE,mDAAwD;AAKxD,kCAA2B;AAE3B;;GAEG;AACH,MAAsB,OAAO;IAA7B;QAQI;;WAEG;QACI,cAAS,GAAG,2BAAgB,CAAC,eAAe,CAAC;IAuExD,CAAC;IAxDG;;OAEG;IACI,cAAc;;QACjB,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,OAAO,IAAI,CAAC,WAAW,CAAC;SAC3B;aAAM;YACH,OAAO,MAAA,IAAI,CAAC,MAAM,0CAAE,cAAc,EAAE,CAAC;SACxC;IACL,CAAC;IAED;;OAEG;IACI,YAAY,CAAkC,OAA+C;QAChG,IAAI,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACvB,OAAO,IAAI,EAAE;YACT,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;gBACf,OAAO,IAAa,CAAC;aACxB;YACD,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;SACtB;IACL,CAAC;IAED;;;OAGG;IACI,SAAS,CAAsC,OAA6C,EAAE,OAAqB;QACtH,MAAM,MAAM,GAAG,IAAI,+CAAuB,EAAE,CAAC;QAC7C,IAAI,MAAe,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACf,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YACnC,IAAI,YAAY,EAAE;gBACd,MAAM,CAAC,MAAM,EAAE,CAAC;gBAChB,MAAM,GAAG,YAAY,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC;aACxD;QACL,CAAC,gCACG,QAAQ,EAAE,mBAAQ,CAAC,iBAAiB,IACjC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,KAChB,MAAM,EAAE,MAAM,CAAC,KAAK,IACtB,CAAC;QACH,OAAO,MAAmB,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAsC,QAAkB,EAAE,OAAqB;QACrG,OAAO,IAAI,CAAC,SAAS,CAAY,CAAC,IAAI,EAAE,EAAE;;YACtC,yDAAyD;YACzD,IAAI,cAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE;gBAC1C,OAAO,MAAA,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,mCAAI,IAAI,CAAC;aAC9D;QACL,CAAC,EAAE,OAAO,CAAC,CAAC;IAChB,CAAC;CACJ;AAlFD,0BAkFC;AAED,MAAsB,SAAU,SAAQ,OAAO;IAA/C;;QACI;;WAEG;QACI,cAAS,GAAG,2BAAgB,CAAC,eAAe,CAAC;IAKxD,CAAC;CAAA;AATD,8BASC;AAGD,gCAAgC;AAChC,MAAsB,UAAW,SAAQ,OAAO;IAAhD;;QACI;;WAEG;QACI,cAAS,GAAG,2BAAgB,CAAC,gBAAgB,CAAC;IACzD,CAAC;CAAA;AALD,gCAKC"}

package/dist/parser/AstNode.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/parser/AstNode.spec.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../util");
+const fsExtra = require("fs-extra");
+const Program_1 = require("../Program");
+const chai_1 = require("chai");
+const testHelpers_spec_1 = require("../testHelpers.spec");
+let tempDir = (0, util_1.standardizePath) `${process.cwd()}/.tmp`;
+let rootDir = (0, util_1.standardizePath) `${tempDir}/rootDir`;
+let stagingDir = (0, util_1.standardizePath) `${tempDir}/staging`;
+describe('Program', () => {
+    let program;
+    beforeEach(() => {
+        fsExtra.emptyDirSync(tempDir);
+        program = new Program_1.Program({
+            rootDir: rootDir,
+            stagingFolderPath: stagingDir
+        });
+        program.createSourceScope(); //ensure source scope is created
+    });
+    afterEach(() => {
+        fsExtra.emptyDirSync(tempDir);
+        program.dispose();
+    });
+    describe('AstNode', () => {
+        describe('findNodeAtPosition', () => {
+            it('finds deepest AstNode that matches the position', () => {
+                const file = program.setFile('source/main.brs', `
+                    sub main()
+                        alpha = invalid
+                        print alpha.beta.charlie.delta(alpha.echo.foxtrot())
+                    end sub
+                `);
+                program.validate();
+                (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+                const delta = file.ast.findChildAtPosition(util_1.util.createPosition(3, 52));
+                (0, chai_1.expect)(delta.name.text).to.eql('delta');
+                const foxtrot = file.ast.findChildAtPosition(util_1.util.createPosition(3, 71));
+                (0, chai_1.expect)(foxtrot.name.text).to.eql('foxtrot');
+            });
+        });
+    });
+});
+//# sourceMappingURL=AstNode.spec.js.map

package/dist/parser/AstNode.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AstNode.spec.js","sourceRoot":"","sources":["../../src/parser/AstNode.spec.ts"],"names":[],"mappings":";;AAAA,kCAAqD;AACrD,oCAAoC;AACpC,wCAAqC;AAErC,+BAA8B;AAE9B,0DAA4D;AAE5D,IAAI,OAAO,GAAG,IAAA,sBAAC,EAAA,GAAG,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC;AACvC,IAAI,OAAO,GAAG,IAAA,sBAAC,EAAA,GAAG,OAAO,UAAU,CAAC;AACpC,IAAI,UAAU,GAAG,IAAA,sBAAC,EAAA,GAAG,OAAO,UAAU,CAAC;AAEvC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACrB,IAAI,OAAgB,CAAC;IAErB,UAAU,CAAC,GAAG,EAAE;QACZ,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,GAAG,IAAI,iBAAO,CAAC;YAClB,OAAO,EAAE,OAAO;YAChB,iBAAiB,EAAE,UAAU;SAChC,CAAC,CAAC;QACH,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC,gCAAgC;IACjE,CAAC,CAAC,CAAC;IACH,SAAS,CAAC,GAAG,EAAE;QACX,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACrB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAChC,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;gBACvD,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAU,iBAAiB,EAAE;;;;;iBAKxD,CAAC,CAAC;gBACH,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACnB,IAAA,wCAAqB,EAAC,OAAO,CAAC,CAAC;gBAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAsB,WAAI,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;gBAC5F,IAAA,aAAM,EAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAExC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAsB,WAAI,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;gBAC9F,IAAA,aAAM,EAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAChD,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/parser/Expression.d.ts

@@ -1,36 +1,14 @@
 import type { Token, Identifier } from '../lexer/Token';
-import type { Block, CommentStatement, FunctionStatement, Statement } from './Statement';
+import type { Block, CommentStatement, FunctionStatement } from './Statement';
 import type { Range } from 'vscode-languageserver';
 import type { BrsTranspileState } from './BrsTranspileState';
 import { ParseMode } from './Parser';
 import type { WalkOptions, WalkVisitor } from '../astUtils/visitors';
-import { InternalWalkMode } from '../astUtils/visitors';
 import type { TranspileResult, TypedefProvider } from '../interfaces';
 import type { BscType } from '../types/BscType';
 import { FunctionType } from '../types/FunctionType';
-import { SymbolTable } from '../SymbolTable';
+import { Expression } from './AstNode';
 export declare type ExpressionVisitor = (expression: Expression, parent: Expression) => void;
-/** A BrightScript expression */
-export declare abstract class Expression {
-    /**
-     * The starting and ending location of the expression.
-     */
-    abstract range: Range;
-    abstract transpile(state: BrsTranspileState): TranspileResult;
-    /**
-     * When being considered by the walk visitor, this describes what type of element the current class is.
-     */
-    visitMode: InternalWalkMode;
-    abstract walk(visitor: WalkVisitor, options: WalkOptions): any;
-    /**
-     * The parent node for this expression. This is set dynamically during `onFileValidate`, and should not be set directly.
-     */
-    parent?: Statement | Expression;
-    /**
-     * Get the closest symbol table for this node. Should be overridden in children that directly contain a symbol table
-     */
-    getSymbolTable(): SymbolTable;
-}
 export declare class BinaryExpression extends Expression {
     left: Expression;
     operator: Token;
@@ -48,20 +26,12 @@ export declare class CallExpression extends Expression {
     readonly openingParen: Token;
     readonly closingParen: Token;
     readonly args: Expression[];
-    /**
-     * The namespace that currently wraps this call expression. This is NOT the namespace of the callee...that will be represented in the callee expression itself.
-     */
-    readonly namespaceName: NamespacedVariableNameExpression;
     static MaximumArguments: number;
     constructor(callee: Expression, 
     /**
      * Can either be `(`, or `?(` for optional chaining
      */
-    openingParen: Token, closingParen: Token, args: Expression[], 
-    /**
-     * The namespace that currently wraps this call expression. This is NOT the namespace of the callee...that will be represented in the callee expression itself.
-     */
-    namespaceName: NamespacedVariableNameExpression);
+    openingParen: Token, closingParen: Token, args: Expression[]);
     readonly range: Range;
     transpile(state: BrsTranspileState, nameOverride?: string): any[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;
@@ -79,15 +49,11 @@ export declare class FunctionExpression extends Expression implements TypedefPro
      * If this function is enclosed within another function, this will reference that parent function
      */
     readonly parentFunction?: FunctionExpression;
-    readonly namespaceName?: NamespacedVariableNameExpression;
-    readonly parentSymbolTable?: SymbolTable;
     constructor(parameters: FunctionParameterExpression[], body: Block, functionType: Token | null, end: Token, leftParen: Token, rightParen: Token, asToken?: Token, returnTypeToken?: Token, 
     /**
      * If this function is enclosed within another function, this will reference that parent function
      */
-    parentFunction?: FunctionExpression, namespaceName?: NamespacedVariableNameExpression, parentSymbolTable?: SymbolTable);
-    symbolTable: SymbolTable;
-    getSymbolTable(): SymbolTable;
+    parentFunction?: FunctionExpression);
     /**
      * The type this function returns
      */
@@ -120,8 +86,7 @@ export declare class FunctionParameterExpression extends Expression {
     typeToken?: Token;
     defaultValue?: Expression;
     asToken?: Token;
-    readonly namespaceName?: NamespacedVariableNameExpression;
-    constructor(name: Identifier, typeToken?: Token, defaultValue?: Expression, asToken?: Token, namespaceName?: NamespacedVariableNameExpression);
+    constructor(name: Identifier, typeToken?: Token, defaultValue?: Expression, asToken?: Token);
     type: BscType;
     get range(): Range;
     transpile(state: BrsTranspileState): any[];
@@ -268,8 +233,7 @@ export declare class UnaryExpression extends Expression {
 }
 export declare class VariableExpression extends Expression {
     readonly name: Identifier;
-    readonly namespaceName: NamespacedVariableNameExpression;
-    constructor(name: Identifier, namespaceName: NamespacedVariableNameExpression);
+    constructor(name: Identifier);
     readonly range: Range;
     getName(parseMode: ParseMode): string;
     transpile(state: BrsTranspileState): any[];
@@ -296,7 +260,6 @@ export declare class NewExpression extends Expression {
      * The name of the class to initialize (with optional namespace prefixed)
      */
     get className(): NamespacedVariableNameExpression;
-    get namespaceName(): NamespacedVariableNameExpression;
     readonly range: Range;
     transpile(state: BrsTranspileState): any[];
     walk(visitor: WalkVisitor, options: WalkOptions): void;