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

package/dist/parser/AstNode.d.ts

@@ -0,0 +1,205 @@
+import type { WalkVisitor, WalkOptions } from '../astUtils/visitors';
+import type { Location, Position } from 'vscode-languageserver';
+import { CancellationTokenSource } from 'vscode-languageserver';
+import { InternalWalkMode } from '../astUtils/visitors';
+import type { SymbolTable } from '../SymbolTable';
+import type { BrsTranspileState } from './BrsTranspileState';
+import type { GetTypeOptions, TranspileResult } from '../interfaces';
+import type { AnnotationExpression } from './Expression';
+import type { BscType } from '../types/BscType';
+import type { Token } from '../lexer/Token';
+/**
+ * A BrightScript AST node
+ */
+export declare abstract class AstNode {
+    abstract kind: AstNodeKind;
+    /**
+     *  The starting and ending location of the node.
+     */
+    abstract location?: Location | undefined;
+    abstract transpile(state: BrsTranspileState): TranspileResult;
+    /**
+     * Optional property, set at the top level with a map of conditional compile consts and their values
+     */
+    bsConsts?: Map<string, boolean>;
+    /**
+     * Get the typedef for this node. (defaults to transpiling the node, should be overridden by subclasses if there's a more specific typedef requirement)
+     */
+    getTypedef(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 `validateFile`, 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
+     */
+    getSymbolTable(): SymbolTable;
+    /**
+     * Walk upward and return the first node that results in `true` from the matcher.
+     * @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
+     *                The function's second parameter is a cancellation token. If you'd like to short-circuit the walk, call `cancellationToken.cancel()`, then this function will return `undefined`
+     */
+    findAncestor<TNode extends AstNode = AstNode>(matcher: (node: AstNode, cancellationToken: CancellationTokenSource) => boolean | AstNode | undefined | void): TNode | undefined;
+    /**
+     * 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<TNode = AstNode>(matcher: (node: AstNode, cancellationSource: any) => boolean | AstNode | undefined | void, options?: WalkOptions): TNode | undefined;
+    /**
+     * Find a list of all children first child where the matcher evaluates to true.
+     * @param matcher a function called for each node. If you return true, the specified node is included in the results. If you return a node,
+     * that node is returned. all other return values exclude that value and continue the loop
+     */
+    findChildren<TNode extends AstNode = AstNode>(matcher: (node: AstNode, cancellationSource: CancellationTokenSource) => boolean | AstNode | undefined | void, options?: WalkOptions): Array<TNode>;
+    /**
+     * FInd the deepest child that includes the given position
+     */
+    findChildAtPosition<TNodeType extends AstNode = AstNode>(position: Position, options?: WalkOptions): TNodeType | undefined;
+    /**
+     * Get the BscType of this node.
+     */
+    getType(options: GetTypeOptions): BscType;
+    /**
+     * Links all child nodes to their parent AstNode, and the same with symbol tables. This performs a full AST walk, so you should use this sparingly
+     */
+    link(): void;
+    /**
+     * Walk upward and return the root node
+     */
+    getRoot(): AstNode;
+    /**
+     * Gets all the trivia (comments, whitespace) that is directly before the start of this node
+     * Note: this includes all trivia that might start on the line of the previous node
+     */
+    get leadingTrivia(): Token[];
+    /**
+     * Gets any trivia that is directly before the end of the node
+     * For example, this would return all trivia before a `end function` token of a FunctionExpression
+     */
+    get endTrivia(): Token[];
+    getBsConsts(): any;
+    /**
+     * Clone this node and all of its children. This creates a completely detached and identical copy of the AST.
+     * All tokens, statements, expressions, range, and location are cloned.
+     */
+    abstract clone(): any;
+    /**
+     * Helper function for creating a clone. This will clone any attached annotations, as well as reparent the cloned node's children to the clone
+     */
+    protected finalizeClone<T extends AstNode>(clone: T, propsToReparent?: Array<{
+        [K in keyof T]: T[K] extends AstNode | AstNode[] ? K : never;
+    }[keyof T]>): T;
+    /**
+     * The index of the statement containing this node (or in the case of a statement, itself) within the containing block.
+     */
+    get statementIndex(): number;
+}
+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[] | undefined;
+}
+/** 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;
+}
+export declare enum AstNodeKind {
+    Body = "Body",
+    BinaryExpression = "BinaryExpression",
+    CallExpression = "CallExpression",
+    FunctionExpression = "FunctionExpression",
+    FunctionParameterExpression = "FunctionParameterExpression",
+    NamespacedVariableNameExpression = "NamespacedVariableNameExpression",
+    DottedGetExpression = "DottedGetExpression",
+    XmlAttributeGetExpression = "XmlAttributeGetExpression",
+    IndexedGetExpression = "IndexedGetExpression",
+    GroupingExpression = "GroupingExpression",
+    LiteralExpression = "LiteralExpression",
+    EscapedCharCodeLiteralExpression = "EscapedCharCodeLiteralExpression",
+    ArrayLiteralExpression = "ArrayLiteralExpression",
+    AAMemberExpression = "AAMemberExpression",
+    AALiteralExpression = "AALiteralExpression",
+    AAIndexedMemberExpression = "AAIndexedMemberExpression",
+    UnaryExpression = "UnaryExpression",
+    VariableExpression = "VariableExpression",
+    SourceLiteralExpression = "SourceLiteralExpression",
+    NewExpression = "NewExpression",
+    CallfuncExpression = "CallfuncExpression",
+    TemplateStringQuasiExpression = "TemplateStringQuasiExpression",
+    TemplateStringExpression = "TemplateStringExpression",
+    TaggedTemplateStringExpression = "TaggedTemplateStringExpression",
+    AnnotationExpression = "AnnotationExpression",
+    TernaryExpression = "TernaryExpression",
+    NullCoalescingExpression = "NullCoalescingExpression",
+    RegexLiteralExpression = "RegexLiteralExpression",
+    EmptyStatement = "EmptyStatement",
+    AssignmentStatement = "AssignmentStatement",
+    ExpressionStatement = "ExpressionStatement",
+    ExitStatement = "ExitStatement",
+    FunctionStatement = "FunctionStatement",
+    IfStatement = "IfStatement",
+    IncrementStatement = "IncrementStatement",
+    PrintStatement = "PrintStatement",
+    DimStatement = "DimStatement",
+    GotoStatement = "GotoStatement",
+    LabelStatement = "LabelStatement",
+    ReturnStatement = "ReturnStatement",
+    EndStatement = "EndStatement",
+    StopStatement = "StopStatement",
+    ForStatement = "ForStatement",
+    ForEachStatement = "ForEachStatement",
+    WhileStatement = "WhileStatement",
+    DottedSetStatement = "DottedSetStatement",
+    IndexedSetStatement = "IndexedSetStatement",
+    LibraryStatement = "LibraryStatement",
+    NamespaceStatement = "NamespaceStatement",
+    ImportStatement = "ImportStatement",
+    InterfaceStatement = "InterfaceStatement",
+    InterfaceFieldStatement = "InterfaceFieldStatement",
+    InterfaceMethodStatement = "InterfaceMethodStatement",
+    ClassStatement = "ClassStatement",
+    MethodStatement = "MethodStatement",
+    ClassMethodStatement = "ClassMethodStatement",
+    FieldStatement = "FieldStatement",
+    ClassFieldStatement = "ClassFieldStatement",
+    TryCatchStatement = "TryCatchStatement",
+    CatchStatement = "CatchStatement",
+    ThrowStatement = "ThrowStatement",
+    EnumStatement = "EnumStatement",
+    EnumMemberStatement = "EnumMemberStatement",
+    ConstStatement = "ConstStatement",
+    ContinueStatement = "ContinueStatement",
+    Block = "Block",
+    TypeExpression = "TypeExpression",
+    TypecastExpression = "TypecastExpression",
+    TypedArrayExpression = "TypedArrayExpression",
+    TypecastStatement = "TypecastStatement",
+    AliasStatement = "AliasStatement",
+    ConditionalCompileStatement = "ConditionalCompileStatement",
+    ConditionalCompileConstStatement = "ConditionalCompileConstStatement",
+    ConditionalCompileErrorStatement = "ConditionalCompileErrorStatement",
+    AugmentedAssignmentStatement = "AugmentedAssignmentStatement",
+    PrintSeparatorExpression = "PrintSeparatorExpression",
+    InlineInterfaceExpression = "InlineInterfaceExpression",
+    InlineInterfaceMemberExpression = "InlineInterfaceMemberExpression",
+    TypeStatement = "TypeStatement",
+    TypedFunctionTypeExpression = "TypedFunctionTypeExpression"
+}

package/dist/parser/AstNode.js

@@ -0,0 +1,305 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AstNodeKind = 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");
+const DynamicType_1 = require("../types/DynamicType");
+const reflection_1 = require("../astUtils/reflection");
+/**
+ * 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 typedef for this node. (defaults to transpiling the node, should be overridden by subclasses if there's a more specific typedef requirement)
+     */
+    getTypedef(state) {
+        return this.transpile(state);
+    }
+    /**
+     * Get the closest symbol table for this node
+     */
+    getSymbolTable() {
+        let node = this;
+        while (node) {
+            if (node.symbolTable) {
+                return node.symbolTable;
+            }
+            node = node.parent;
+        }
+        //justification: we are following a chain of nodes until we get to one with a SymbolTable,
+        //and the top-level node will always have a SymbolTable. So we'll never hit this undefined,
+        //but it is not so easy to convince the typechecker of this.
+        return undefined;
+    }
+    /**
+     * Walk upward and return the first node that results in `true` from the matcher.
+     * @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
+     *                The function's second parameter is a cancellation token. If you'd like to short-circuit the walk, call `cancellationToken.cancel()`, then this function will return `undefined`
+     */
+    findAncestor(matcher) {
+        let node = this.parent;
+        const cancel = new vscode_languageserver_1.CancellationTokenSource();
+        while (node) {
+            let matcherValue = matcher(node, cancel);
+            if (cancel.token.isCancellationRequested) {
+                return;
+            }
+            if (matcherValue) {
+                cancel.cancel();
+                return (matcherValue === true ? node : matcherValue);
+            }
+            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, cancel);
+            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 a list of all children first child where the matcher evaluates to true.
+     * @param matcher a function called for each node. If you return true, the specified node is included in the results. If you return a node,
+     * that node is returned. all other return values exclude that value and continue the loop
+     */
+    findChildren(matcher, options) {
+        const cancel = new vscode_languageserver_1.CancellationTokenSource();
+        let result = [];
+        this.walk((node) => {
+            const matcherValue = matcher(node, cancel);
+            if (matcherValue) {
+                result.push(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 === null || node === void 0 ? void 0 : node.location.range, position)) {
+                return (_a = node.findChildAtPosition(position, options)) !== null && _a !== void 0 ? _a : node;
+            }
+        }, options);
+    }
+    /**
+     * Get the BscType of this node.
+     */
+    getType(options) {
+        return DynamicType_1.DynamicType.instance;
+    }
+    /**
+     * Links all child nodes to their parent AstNode, and the same with symbol tables. This performs a full AST walk, so you should use this sparingly
+     */
+    link() {
+        //the act of walking causes the nodes to be linked
+        this.walk(() => { }, {
+            // eslint-disable-next-line no-bitwise
+            walkMode: visitors_1.WalkMode.visitAllRecursive | visitors_2.InternalWalkMode.visitFalseConditionalCompilationBlocks
+        });
+    }
+    /**
+     * Walk upward and return the root node
+     */
+    getRoot() {
+        let node = this;
+        while (node) {
+            if (!node.parent) {
+                return node;
+            }
+            node = node.parent;
+        }
+    }
+    /**
+     * Gets all the trivia (comments, whitespace) that is directly before the start of this node
+     * Note: this includes all trivia that might start on the line of the previous node
+     */
+    get leadingTrivia() {
+        return [];
+    }
+    /**
+     * Gets any trivia that is directly before the end of the node
+     * For example, this would return all trivia before a `end function` token of a FunctionExpression
+     */
+    get endTrivia() {
+        return [];
+    }
+    getBsConsts() {
+        var _a, _b, _c;
+        return (_a = this.bsConsts) !== null && _a !== void 0 ? _a : (_c = (_b = this.parent) === null || _b === void 0 ? void 0 : _b.getBsConsts) === null || _c === void 0 ? void 0 : _c.call(_b);
+    }
+    /**
+     * Helper function for creating a clone. This will clone any attached annotations, as well as reparent the cloned node's children to the clone
+     */
+    finalizeClone(clone, propsToReparent) {
+        var _a;
+        //clone the annotations if they exist
+        if (Array.isArray(this.annotations)) {
+            clone.annotations = (_a = this.annotations) === null || _a === void 0 ? void 0 : _a.map(x => x.clone());
+        }
+        //reparent all of the supplied props
+        for (let key of propsToReparent !== null && propsToReparent !== void 0 ? propsToReparent : []) {
+            const children = (Array.isArray(clone === null || clone === void 0 ? void 0 : clone[key]) ? clone[key] : [clone === null || clone === void 0 ? void 0 : clone[key]]);
+            for (let child of children !== null && children !== void 0 ? children : []) {
+                if (child) {
+                    clone[key].parent = clone;
+                }
+            }
+        }
+        //reapply the location if we have one but the clone doesn't
+        if (!clone.location && this.location) {
+            clone.location = util_1.default.cloneLocation(this.location);
+        }
+        return clone;
+    }
+    /**
+     * The index of the statement containing this node (or in the case of a statement, itself) within the containing block.
+     */
+    get statementIndex() {
+        if ((0, reflection_1.isBody)(this)) {
+            return 0;
+        }
+        if (!this.parent) {
+            return -1;
+        }
+        let currentNode = this;
+        if ((0, reflection_1.isFunctionParameterExpression)(currentNode)) {
+            // function parameters are not part of statement lists
+            return -1;
+        }
+        while (currentNode && !((0, reflection_1.isBlock)(currentNode === null || currentNode === void 0 ? void 0 : currentNode.parent) || (0, reflection_1.isBody)(currentNode === null || currentNode === void 0 ? void 0 : currentNode.parent))) {
+            currentNode = currentNode.parent;
+        }
+        if ((0, reflection_1.isBlock)(currentNode === null || currentNode === void 0 ? void 0 : currentNode.parent) || (0, reflection_1.isBody)(currentNode === null || currentNode === void 0 ? void 0 : currentNode.parent)) {
+            return currentNode.parent.statements.indexOf(currentNode);
+        }
+        return -1;
+    }
+}
+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;
+var AstNodeKind;
+(function (AstNodeKind) {
+    AstNodeKind["Body"] = "Body";
+    AstNodeKind["BinaryExpression"] = "BinaryExpression";
+    AstNodeKind["CallExpression"] = "CallExpression";
+    AstNodeKind["FunctionExpression"] = "FunctionExpression";
+    AstNodeKind["FunctionParameterExpression"] = "FunctionParameterExpression";
+    AstNodeKind["NamespacedVariableNameExpression"] = "NamespacedVariableNameExpression";
+    AstNodeKind["DottedGetExpression"] = "DottedGetExpression";
+    AstNodeKind["XmlAttributeGetExpression"] = "XmlAttributeGetExpression";
+    AstNodeKind["IndexedGetExpression"] = "IndexedGetExpression";
+    AstNodeKind["GroupingExpression"] = "GroupingExpression";
+    AstNodeKind["LiteralExpression"] = "LiteralExpression";
+    AstNodeKind["EscapedCharCodeLiteralExpression"] = "EscapedCharCodeLiteralExpression";
+    AstNodeKind["ArrayLiteralExpression"] = "ArrayLiteralExpression";
+    AstNodeKind["AAMemberExpression"] = "AAMemberExpression";
+    AstNodeKind["AALiteralExpression"] = "AALiteralExpression";
+    AstNodeKind["AAIndexedMemberExpression"] = "AAIndexedMemberExpression";
+    AstNodeKind["UnaryExpression"] = "UnaryExpression";
+    AstNodeKind["VariableExpression"] = "VariableExpression";
+    AstNodeKind["SourceLiteralExpression"] = "SourceLiteralExpression";
+    AstNodeKind["NewExpression"] = "NewExpression";
+    AstNodeKind["CallfuncExpression"] = "CallfuncExpression";
+    AstNodeKind["TemplateStringQuasiExpression"] = "TemplateStringQuasiExpression";
+    AstNodeKind["TemplateStringExpression"] = "TemplateStringExpression";
+    AstNodeKind["TaggedTemplateStringExpression"] = "TaggedTemplateStringExpression";
+    AstNodeKind["AnnotationExpression"] = "AnnotationExpression";
+    AstNodeKind["TernaryExpression"] = "TernaryExpression";
+    AstNodeKind["NullCoalescingExpression"] = "NullCoalescingExpression";
+    AstNodeKind["RegexLiteralExpression"] = "RegexLiteralExpression";
+    AstNodeKind["EmptyStatement"] = "EmptyStatement";
+    AstNodeKind["AssignmentStatement"] = "AssignmentStatement";
+    AstNodeKind["ExpressionStatement"] = "ExpressionStatement";
+    AstNodeKind["ExitStatement"] = "ExitStatement";
+    AstNodeKind["FunctionStatement"] = "FunctionStatement";
+    AstNodeKind["IfStatement"] = "IfStatement";
+    AstNodeKind["IncrementStatement"] = "IncrementStatement";
+    AstNodeKind["PrintStatement"] = "PrintStatement";
+    AstNodeKind["DimStatement"] = "DimStatement";
+    AstNodeKind["GotoStatement"] = "GotoStatement";
+    AstNodeKind["LabelStatement"] = "LabelStatement";
+    AstNodeKind["ReturnStatement"] = "ReturnStatement";
+    AstNodeKind["EndStatement"] = "EndStatement";
+    AstNodeKind["StopStatement"] = "StopStatement";
+    AstNodeKind["ForStatement"] = "ForStatement";
+    AstNodeKind["ForEachStatement"] = "ForEachStatement";
+    AstNodeKind["WhileStatement"] = "WhileStatement";
+    AstNodeKind["DottedSetStatement"] = "DottedSetStatement";
+    AstNodeKind["IndexedSetStatement"] = "IndexedSetStatement";
+    AstNodeKind["LibraryStatement"] = "LibraryStatement";
+    AstNodeKind["NamespaceStatement"] = "NamespaceStatement";
+    AstNodeKind["ImportStatement"] = "ImportStatement";
+    AstNodeKind["InterfaceStatement"] = "InterfaceStatement";
+    AstNodeKind["InterfaceFieldStatement"] = "InterfaceFieldStatement";
+    AstNodeKind["InterfaceMethodStatement"] = "InterfaceMethodStatement";
+    AstNodeKind["ClassStatement"] = "ClassStatement";
+    AstNodeKind["MethodStatement"] = "MethodStatement";
+    AstNodeKind["ClassMethodStatement"] = "ClassMethodStatement";
+    AstNodeKind["FieldStatement"] = "FieldStatement";
+    AstNodeKind["ClassFieldStatement"] = "ClassFieldStatement";
+    AstNodeKind["TryCatchStatement"] = "TryCatchStatement";
+    AstNodeKind["CatchStatement"] = "CatchStatement";
+    AstNodeKind["ThrowStatement"] = "ThrowStatement";
+    AstNodeKind["EnumStatement"] = "EnumStatement";
+    AstNodeKind["EnumMemberStatement"] = "EnumMemberStatement";
+    AstNodeKind["ConstStatement"] = "ConstStatement";
+    AstNodeKind["ContinueStatement"] = "ContinueStatement";
+    AstNodeKind["Block"] = "Block";
+    AstNodeKind["TypeExpression"] = "TypeExpression";
+    AstNodeKind["TypecastExpression"] = "TypecastExpression";
+    AstNodeKind["TypedArrayExpression"] = "TypedArrayExpression";
+    AstNodeKind["TypecastStatement"] = "TypecastStatement";
+    AstNodeKind["AliasStatement"] = "AliasStatement";
+    AstNodeKind["ConditionalCompileStatement"] = "ConditionalCompileStatement";
+    AstNodeKind["ConditionalCompileConstStatement"] = "ConditionalCompileConstStatement";
+    AstNodeKind["ConditionalCompileErrorStatement"] = "ConditionalCompileErrorStatement";
+    AstNodeKind["AugmentedAssignmentStatement"] = "AugmentedAssignmentStatement";
+    AstNodeKind["PrintSeparatorExpression"] = "PrintSeparatorExpression";
+    AstNodeKind["InlineInterfaceExpression"] = "InlineInterfaceExpression";
+    AstNodeKind["InlineInterfaceMemberExpression"] = "InlineInterfaceMemberExpression";
+    AstNodeKind["TypeStatement"] = "TypeStatement";
+    AstNodeKind["TypedFunctionTypeExpression"] = "TypedFunctionTypeExpression";
+})(AstNodeKind = exports.AstNodeKind || (exports.AstNodeKind = {}));
+//# 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;AAC3B,sDAAmD;AAGnD,uDAAwF;AAExF;;GAEG;AACH,MAAsB,OAAO;IAA7B;QAqBI;;WAEG;QACI,cAAS,GAAG,2BAAgB,CAAC,eAAe,CAAC;IA6NxD,CAAC;IAvOG;;OAEG;IACI,UAAU,CAAC,KAAwB;QACtC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAoBD;;OAEG;IACI,cAAc;QACjB,IAAI,IAAI,GAAY,IAAI,CAAC;QACzB,OAAO,IAAI,EAAE;YACT,IAAI,IAAI,CAAC,WAAW,EAAE;gBAClB,OAAO,IAAI,CAAC,WAAW,CAAC;aAC3B;YACD,IAAI,GAAG,IAAI,CAAC,MAAO,CAAC;SACvB;QAED,0FAA0F;QAC1F,2FAA2F;QAC3F,4DAA4D;QAC5D,OAAO,SAAgB,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAkC,OAA4G;QAC7J,IAAI,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QAEvB,MAAM,MAAM,GAAG,IAAI,+CAAuB,EAAE,CAAC;QAC7C,OAAO,IAAI,EAAE;YACT,IAAI,YAAY,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACzC,IAAI,MAAM,CAAC,KAAK,CAAC,uBAAuB,EAAE;gBACtC,OAAO;aACV;YACD,IAAI,YAAY,EAAE;gBACd,MAAM,CAAC,MAAM,EAAE,CAAC;gBAChB,OAAO,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAU,CAAC;aAEjE;YACD,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;SACtB;IACL,CAAC;IAED;;;OAGG;IACI,SAAS,CAAkB,OAAoF,EAAE,OAAqB;QACzI,MAAM,MAAM,GAAG,IAAI,+CAAuB,EAAE,CAAC;QAC7C,IAAI,MAA2B,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACf,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC3C,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,MAA0B,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAkC,OAA6G,EAAE,OAAqB;QACrL,MAAM,MAAM,GAAG,IAAI,+CAAuB,EAAE,CAAC;QAC7C,IAAI,MAAM,GAAmB,EAAE,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACf,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC3C,IAAI,YAAY,EAAE;gBACd,MAAM,CAAC,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;aAC5D;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,MAAiB,CAAC;IAC7B,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,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE;gBACpD,OAAO,MAAA,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,mCAAI,IAAI,CAAC;aAC9D;QACL,CAAC,EAAE,OAAO,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,OAAuB;QAClC,OAAO,yBAAW,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,IAAI;QACP,kDAAkD;QAClD,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE;YACjB,sCAAsC;YACtC,QAAQ,EAAE,mBAAQ,CAAC,iBAAiB,GAAG,2BAAgB,CAAC,sCAAsC;SACjG,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,OAAO;QACV,IAAI,IAAI,GAAG,IAAe,CAAC;QAE3B,OAAO,IAAI,EAAE;YACT,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACd,OAAO,IAAI,CAAC;aACf;YACD,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;SACtB;IACL,CAAC;IAGD;;;OAGG;IACH,IAAW,aAAa;QACpB,OAAO,EAAE,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,IAAW,SAAS;QAChB,OAAO,EAAE,CAAC;IACd,CAAC;IAEM,WAAW;;QACd,OAAO,MAAA,IAAI,CAAC,QAAQ,mCAAI,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,WAAW,kDAAI,CAAC;IACzD,CAAC;IAQD;;OAEG;IACO,aAAa,CACnB,KAAQ,EACR,eAAkG;;QAElG,qCAAqC;QACrC,IAAI,KAAK,CAAC,OAAO,CAAE,IAA6B,CAAC,WAAW,CAAC,EAAE;YAC1D,KAA8B,CAAC,WAAW,GAAG,MAAC,IAA6B,CAAC,WAAW,0CAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;SACjH;QACD,oCAAoC;QACpC,KAAK,IAAI,GAAG,IAAI,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,EAAE,EAAE;YACnC,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAG,GAAG,CAAC,CAAC,CAAU,CAAC;YACtF,KAAK,IAAI,KAAK,IAAI,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,EAAE;gBAC9B,IAAI,KAAK,EAAE;oBACN,KAAK,CAAC,GAAU,CAAa,CAAC,MAAM,GAAG,KAAK,CAAC;iBACjD;aACJ;SACJ;QAED,2DAA2D;QAC3D,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE;YAClC,KAAK,CAAC,QAAQ,GAAG,cAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACtD;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACrB,IAAI,IAAA,mBAAM,EAAC,IAAI,CAAC,EAAE;YACd,OAAO,CAAC,CAAC;SACZ;QACD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACd,OAAO,CAAC,CAAC,CAAC;SACb;QACD,IAAI,WAAW,GAAY,IAAI,CAAC;QAChC,IAAI,IAAA,0CAA6B,EAAC,WAAW,CAAC,EAAE;YAC5C,sDAAsD;YACtD,OAAO,CAAC,CAAC,CAAC;SACb;QACD,OAAO,WAAW,IAAI,CAAC,CAAC,IAAA,oBAAO,EAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAC,IAAI,IAAA,mBAAM,EAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAC,CAAC,EAAE;YAClF,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC;SAEpC;QACD,IAAI,IAAA,oBAAO,EAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAC,IAAI,IAAA,mBAAM,EAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAC,EAAE;YAC7D,OAAO,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SAC7D;QACD,OAAO,CAAC,CAAC,CAAC;IACd,CAAC;CACJ;AArPD,0BAqPC;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;AAED,IAAY,WAiFX;AAjFD,WAAY,WAAW;IACnB,4BAAa,CAAA;IACb,oDAAqC,CAAA;IACrC,gDAAiC,CAAA;IACjC,wDAAyC,CAAA;IACzC,0EAA2D,CAAA;IAC3D,oFAAqE,CAAA;IACrE,0DAA2C,CAAA;IAC3C,sEAAuD,CAAA;IACvD,4DAA6C,CAAA;IAC7C,wDAAyC,CAAA;IACzC,sDAAuC,CAAA;IACvC,oFAAqE,CAAA;IACrE,gEAAiD,CAAA;IACjD,wDAAyC,CAAA;IACzC,0DAA2C,CAAA;IAC3C,sEAAuD,CAAA;IACvD,kDAAmC,CAAA;IACnC,wDAAyC,CAAA;IACzC,kEAAmD,CAAA;IACnD,8CAA+B,CAAA;IAC/B,wDAAyC,CAAA;IACzC,8EAA+D,CAAA;IAC/D,oEAAqD,CAAA;IACrD,gFAAiE,CAAA;IACjE,4DAA6C,CAAA;IAC7C,sDAAuC,CAAA;IACvC,oEAAqD,CAAA;IACrD,gEAAiD,CAAA;IACjD,gDAAiC,CAAA;IACjC,0DAA2C,CAAA;IAC3C,0DAA2C,CAAA;IAC3C,8CAA+B,CAAA;IAC/B,sDAAuC,CAAA;IACvC,0CAA2B,CAAA;IAC3B,wDAAyC,CAAA;IACzC,gDAAiC,CAAA;IACjC,4CAA6B,CAAA;IAC7B,8CAA+B,CAAA;IAC/B,gDAAiC,CAAA;IACjC,kDAAmC,CAAA;IACnC,4CAA6B,CAAA;IAC7B,8CAA+B,CAAA;IAC/B,4CAA6B,CAAA;IAC7B,oDAAqC,CAAA;IACrC,gDAAiC,CAAA;IACjC,wDAAyC,CAAA;IACzC,0DAA2C,CAAA;IAC3C,oDAAqC,CAAA;IACrC,wDAAyC,CAAA;IACzC,kDAAmC,CAAA;IACnC,wDAAyC,CAAA;IACzC,kEAAmD,CAAA;IACnD,oEAAqD,CAAA;IACrD,gDAAiC,CAAA;IACjC,kDAAmC,CAAA;IACnC,4DAA6C,CAAA;IAC7C,gDAAiC,CAAA;IACjC,0DAA2C,CAAA;IAC3C,sDAAuC,CAAA;IACvC,gDAAiC,CAAA;IACjC,gDAAiC,CAAA;IACjC,8CAA+B,CAAA;IAC/B,0DAA2C,CAAA;IAC3C,gDAAiC,CAAA;IACjC,sDAAuC,CAAA;IACvC,8BAAe,CAAA;IACf,gDAAiC,CAAA;IACjC,wDAAyC,CAAA;IACzC,4DAA6C,CAAA;IAC7C,sDAAuC,CAAA;IACvC,gDAAiC,CAAA;IACjC,0EAA2D,CAAA;IAC3D,oFAAqE,CAAA;IACrE,oFAAqE,CAAA;IACrE,4EAA6D,CAAA;IAC7D,oEAAqD,CAAA;IACrD,sEAAuD,CAAA;IACvD,kFAAmE,CAAA;IACnE,8CAA+B,CAAA;IAC/B,0EAA2D,CAAA;AAC/D,CAAC,EAjFW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAiFtB"}

package/dist/parser/BrightScriptDocParser.d.ts

@@ -0,0 +1,56 @@
+import type { GetSymbolTypeOptions } from '../SymbolTable';
+import type { AstNode, Expression } from './AstNode';
+import type { Location } from 'vscode-languageserver';
+import type { Token } from '../lexer/Token';
+export declare enum BrsDocTagKind {
+    Description = "description",
+    Param = "param",
+    Return = "return",
+    Type = "type"
+}
+export declare class BrightScriptDocParser {
+    parseNode(node: AstNode): BrightScriptDoc;
+    parse(documentation: string, matchingTokens?: Token[]): BrightScriptDoc;
+    getTypeLocationFromToken(token: Token): Location;
+    private parseLine;
+    private parseParam;
+    private parseReturn;
+    private parseType;
+    private getTypeExpressionFromTypeString;
+}
+export declare class BrightScriptDoc {
+    readonly documentation: string;
+    protected _description: string;
+    tags: BrsDocTag[];
+    constructor(documentation: string);
+    set description(value: string);
+    get description(): string;
+    getParam(name: string): BrsDocParamTag;
+    getReturn(): BrsDocWithDescription;
+    getTypeTag(): BrsDocWithType;
+    getTypeTagByName(name: string): BrsDocWithType;
+    getTag(tagName: string): BrsDocTag;
+    getAllTags(tagName: string): BrsDocTag[];
+    getParamBscType(name: string, options?: GetSymbolTypeOptions): import("..").BscType;
+    getReturnBscType(options?: GetSymbolTypeOptions): import("..").BscType;
+    getTypeTagBscType(options?: GetSymbolTypeOptions): import("..").BscType;
+}
+export interface BrsDocTag {
+    tagName: string;
+    detail?: string;
+    location?: Location;
+    token?: Token;
+}
+export interface BrsDocWithType extends BrsDocTag {
+    typeString?: string;
+    typeExpression?: Expression;
+}
+export interface BrsDocWithDescription extends BrsDocWithType {
+    description?: string;
+}
+export interface BrsDocParamTag extends BrsDocWithDescription {
+    name: string;
+    optional?: boolean;
+}
+export declare let brsDocParser: BrightScriptDocParser;
+export default brsDocParser;