brighterscript 1.0.0-alpha.14 → 1.0.0-alpha.17

package/dist/parser/Expression.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegexLiteralExpression = exports.NullCoalescingExpression = exports.TernaryExpression = exports.AnnotationExpression = exports.TaggedTemplateStringExpression = exports.TemplateStringExpression = exports.TemplateStringQuasiExpression = exports.CallfuncExpression = exports.NewExpression = exports.SourceLiteralExpression = exports.VariableExpression = exports.UnaryExpression = exports.AALiteralExpression = exports.AAMemberExpression = exports.ArrayLiteralExpression = exports.EscapedCharCodeLiteralExpression = exports.LiteralExpression = exports.GroupingExpression = exports.IndexedGetExpression = exports.XmlAttributeGetExpression = exports.DottedGetExpression = exports.NamespacedVariableNameExpression = exports.FunctionParameterExpression = exports.FunctionExpression = exports.CallExpression = exports.BinaryExpression = exports.Expression = void 0;
+exports.ArrayTypeExpression = exports.TypeExpression = exports.RegexLiteralExpression = exports.NullCoalescingExpression = exports.TernaryExpression = exports.AnnotationExpression = exports.TaggedTemplateStringExpression = exports.TemplateStringExpression = exports.TemplateStringQuasiExpression = exports.CallfuncExpression = exports.NewExpression = exports.SourceLiteralExpression = exports.VariableExpression = exports.UnaryExpression = exports.AALiteralExpression = exports.AAMemberExpression = exports.ArrayLiteralExpression = exports.EscapedCharCodeLiteralExpression = exports.LiteralExpression = exports.GroupingExpression = exports.IndexedGetExpression = exports.XmlAttributeGetExpression = exports.DottedGetExpression = exports.NamespacedVariableNameExpression = exports.FunctionParameterExpression = exports.FunctionExpression = exports.CallExpression = exports.BinaryExpression = exports.Expression = void 0;
 const TokenKind_1 = require("../lexer/TokenKind");
 const util_1 = require("../util");
 const Parser_1 = require("./Parser");
@@ -12,6 +12,7 @@ const DynamicType_1 = require("../types/DynamicType");
 const SymbolTable_1 = require("../SymbolTable");
 const FunctionType_1 = require("../types/FunctionType");
 const ObjectType_1 = require("../types/ObjectType");
+const ArrayType_1 = require("../types/ArrayType");
 /** A BrightScript expression */
 class Expression {
     constructor() {
@@ -28,7 +29,7 @@ class BinaryExpression extends Expression {
         this.left = left;
         this.operator = operator;
         this.right = right;
-        this.range = util_1.default.createRangeFromPositions(this.left.range.start, this.right.range.end);
+        this.range = util_1.default.createBoundingRange(this.left, this.right);
     }
     transpile(state) {
         return [
@@ -59,7 +60,7 @@ class CallExpression extends Expression {
         this.closingParen = closingParen;
         this.args = args;
         this.namespaceName = namespaceName;
-        this.range = util_1.default.createRangeFromPositions(this.callee.range.start, this.closingParen.range.end);
+        this.range = util_1.default.createBoundingRange(this.callee, this.closingParen);
     }
     transpile(state, nameOverride) {
         let result = [];
@@ -94,7 +95,7 @@ class CallExpression extends Expression {
 exports.CallExpression = CallExpression;
 CallExpression.MaximumArguments = util_1.MAX_PARAM_COUNT;
 class FunctionExpression extends Expression {
-    constructor(parameters, body, functionType, end, leftParen, rightParen, asToken, returnTypeToken, 
+    constructor(parameters, body, functionType, end, leftParen, rightParen, asToken, returnType, 
     /**
      * If this function is enclosed within another function, this will reference that parent function
      */
@@ -107,7 +108,7 @@ class FunctionExpression extends Expression {
         this.leftParen = leftParen;
         this.rightParen = rightParen;
         this.asToken = asToken;
-        this.returnTypeToken = returnTypeToken;
+        this.returnType = returnType;
         this.parentFunction = parentFunction;
         this.namespaceName = namespaceName;
         this.parentSymbolTable = parentSymbolTable;
@@ -121,27 +122,38 @@ class FunctionExpression extends Expression {
          * A list of all child functions declared directly within this function
          */
         this.childFunctionExpressions = [];
-        if (this.returnTypeToken) {
-            this.returnType = util_1.default.tokenToBscType(this.returnTypeToken, true, namespaceName);
+        if (this.returnType) {
+            this._returnType = this.returnType.type;
         }
         else if (this.functionType.text.toLowerCase() === 'sub') {
-            this.returnType = new VoidType_1.VoidType();
+            this._returnType = new VoidType_1.VoidType();
         }
         else {
-            this.returnType = new DynamicType_1.DynamicType();
+            this._returnType = new DynamicType_1.DynamicType();
         }
         this.symbolTable = new SymbolTable_1.SymbolTable(parentSymbolTable);
         for (let param of parameters) {
-            this.symbolTable.addSymbol(param.name.text, param.name.range, param.type);
+            this.symbolTable.addSymbol(param.name.text, param.name.range, param.getType());
         }
     }
+    get range() {
+        return this.cacheRange();
+    }
     /**
-     * The range of the function, starting at the 'f' in function or 's' in sub (or the open paren if the keyword is missing),
-     * and ending with the last n' in 'end function' or 'b' in 'end sub'
+     * The range of the function
      */
-    get range() {
-        var _a, _b, _c, _d, _e;
-        return util_1.default.createRangeFromPositions(((_a = this.functionType) !== null && _a !== void 0 ? _a : this.leftParen).range.start, ((_e = (_d = (_c = (_b = this.end) !== null && _b !== void 0 ? _b : this.body) !== null && _c !== void 0 ? _c : this.returnTypeToken) !== null && _d !== void 0 ? _d : this.asToken) !== null && _e !== void 0 ? _e : this.rightParen).range.end);
+    cacheRange() {
+        var _a;
+        if (!this._range) {
+            this._range = util_1.default.createBoundingRange(this.functionType, this.leftParen, ...((_a = this.parameters) !== null && _a !== void 0 ? _a : []), this.rightParen, this.asToken, this.returnType, this.body, this.end);
+        }
+        return this._range;
+    }
+    /**
+     * The type this function returns
+     */
+    getReturnType() {
+        return this._returnType;
     }
     transpile(state, name, includeBody = true) {
         let results = [];
@@ -171,7 +183,7 @@ class FunctionExpression extends Expression {
             //as
             state.transpileToken(this.asToken), ' ', 
             //return type
-            state.sourceNode(this.returnTypeToken, this.returnType.toTypeString(state.typeContext)));
+            state.sourceNode(this.returnType, this.getReturnType().toTypeString(state.typeContext)));
         }
         if (includeBody) {
             state.lineage.unshift(this);
@@ -194,36 +206,35 @@ class FunctionExpression extends Expression {
             }
             //This is the core of full-program walking...it allows us to step into sub functions
             if (options.walkMode & visitors_1.InternalWalkMode.recurseChildFunctions) {
+                (0, visitors_1.walk)(this, 'returnType', visitor, options);
                 (0, visitors_1.walk)(this, 'body', visitor, options);
             }
         }
     }
     getFunctionType() {
-        let functionType = new FunctionType_1.FunctionType(this.returnType);
+        let functionType = new FunctionType_1.FunctionType(this.getReturnType());
         functionType.isSub = this.functionType.text === 'sub';
         for (let param of this.parameters) {
-            functionType.addParameter(param.name.text, param.type, param.isOptional);
+            functionType.addParameter(param.name.text, param.getType(), param.isOptional);
         }
         return functionType;
     }
 }
 exports.FunctionExpression = FunctionExpression;
 class FunctionParameterExpression extends Expression {
-    constructor(name, type, equalsToken, defaultValue, asToken, typeToken, namespaceName) {
+    constructor(name, typeInContext, equalsToken, defaultValue, asToken, type, namespaceName) {
         super();
         this.name = name;
-        this.type = type;
+        this.typeInContext = typeInContext;
         this.equalsToken = equalsToken;
         this.defaultValue = defaultValue;
         this.asToken = asToken;
-        this.typeToken = typeToken;
+        this.type = type;
         this.namespaceName = namespaceName;
+        this.range = util_1.default.createBoundingRange(this.name, this.equalsToken, this.defaultValue, this.asToken, this.type);
     }
-    get range() {
-        return {
-            start: this.name.range.start,
-            end: this.typeToken ? this.typeToken.range.end : this.name.range.end
-        };
+    getType() {
+        return this.typeInContext;
     }
     transpile(state) {
         let result = [
@@ -240,7 +251,7 @@ class FunctionParameterExpression extends Expression {
             result.push(' ');
             result.push(state.transpileToken(this.asToken));
             result.push(' ');
-            result.push(state.sourceNode(this.typeToken, this.type.toTypeString(state.typeContext)));
+            result.push(state.sourceNode(this.type, this.getType().toTypeString(state.typeContext)));
         }
         return result;
     }
@@ -248,6 +259,7 @@ class FunctionParameterExpression extends Expression {
         // eslint-disable-next-line no-bitwise
         if (this.defaultValue && options.walkMode & visitors_1.InternalWalkMode.walkExpressions) {
             (0, visitors_1.walk)(this, 'defaultValue', visitor, options);
+            (0, visitors_1.walk)(this, 'type', visitor, options);
         }
     }
     get isOptional() {
@@ -304,7 +316,7 @@ class DottedGetExpression extends Expression {
         this.obj = obj;
         this.name = name;
         this.dot = dot;
-        this.range = util_1.default.createRangeFromPositions(this.obj.range.start, this.name.range.end);
+        this.range = util_1.default.createBoundingRange(this.obj, this.dot, this.name);
     }
     transpile(state) {
         //if the callee starts with a namespace name, transpile the name
@@ -332,7 +344,7 @@ class XmlAttributeGetExpression extends Expression {
         this.obj = obj;
         this.name = name;
         this.at = at;
-        this.range = util_1.default.createRangeFromPositions(this.obj.range.start, this.name.range.end);
+        this.range = util_1.default.createBoundingRange(this.obj, this.at, this.name);
     }
     transpile(state) {
         return [
@@ -355,7 +367,7 @@ class IndexedGetExpression extends Expression {
         this.index = index;
         this.openingSquare = openingSquare;
         this.closingSquare = closingSquare;
-        this.range = util_1.default.createRangeFromPositions(this.obj.range.start, this.closingSquare.range.end);
+        this.range = util_1.default.createBoundingRange(this.obj, this.openingSquare, this.index, this.closingSquare);
     }
     transpile(state) {
         return [
@@ -378,7 +390,7 @@ class GroupingExpression extends Expression {
         super();
         this.tokens = tokens;
         this.expression = expression;
-        this.range = util_1.default.createRangeFromPositions(this.tokens.left.range.start, this.tokens.right.range.end);
+        this.range = util_1.default.createBoundingRange(this.tokens.left, this.expression, this.tokens.right);
     }
     transpile(state) {
         return [
@@ -398,11 +410,9 @@ class LiteralExpression extends Expression {
     constructor(token) {
         super();
         this.token = token;
+        this.range = this.token.range;
         this.type = util_1.default.tokenToBscType(token);
     }
-    get range() {
-        return this.token.range;
-    }
     transpile(state) {
         let text;
         if (this.token.kind === TokenKind_1.TokenKind.TemplateStringQuasi) {
@@ -450,12 +460,13 @@ class EscapedCharCodeLiteralExpression extends Expression {
 exports.EscapedCharCodeLiteralExpression = EscapedCharCodeLiteralExpression;
 class ArrayLiteralExpression extends Expression {
     constructor(elements, open, close, hasSpread = false) {
+        var _a;
         super();
         this.elements = elements;
         this.open = open;
         this.close = close;
         this.hasSpread = hasSpread;
-        this.range = util_1.default.createRangeFromPositions(this.open.range.start, this.close.range.end);
+        this.range = util_1.default.createBoundingRange(this.open, ...((_a = this.elements) !== null && _a !== void 0 ? _a : []), this.close);
     }
     transpile(state) {
         let result = [];
@@ -518,7 +529,7 @@ class AAMemberExpression extends Expression {
         this.colonToken = colonToken;
         this.value = value;
         this.type = type;
-        this.range = util_1.default.createRangeFromPositions(keyToken.range.start, this.value.range.end);
+        this.range = util_1.default.createBoundingRange(this.keyToken, this.colonToken, this.value);
     }
     transpile(state) {
         //TODO move the logic from AALiteralExpression loop into this function
@@ -531,6 +542,7 @@ class AAMemberExpression extends Expression {
 exports.AAMemberExpression = AAMemberExpression;
 class AALiteralExpression extends Expression {
     constructor(elements, open, close, functionExpression) {
+        var _a;
         super();
         this.elements = elements;
         this.open = open;
@@ -538,12 +550,12 @@ class AALiteralExpression extends Expression {
         this.functionExpression = functionExpression;
         this.symbolTable = new SymbolTable_1.SymbolTable();
         this.memberTable = new SymbolTable_1.SymbolTable();
-        this.range = util_1.default.createRangeFromPositions(this.open.range.start, this.close.range.end);
+        this.range = util_1.default.createBoundingRange(this.open, ...((_a = this.elements) !== null && _a !== void 0 ? _a : []), this.close);
         this.buildSymbolTable();
     }
     buildSymbolTable() {
         this.symbolTable.clear();
-        this.symbolTable.addSymbol('m', { start: this.open.range.start, end: this.close.range.end }, new ObjectType_1.ObjectType(this.memberTable));
+        this.symbolTable.addSymbol('m', { start: this.open.range.start, end: this.close.range.end }, new ObjectType_1.ObjectType('object', this.memberTable));
         for (const element of this.elements) {
             if ((0, reflection_1.isAAMemberExpression)(element)) {
                 this.memberTable.addSymbol(element.keyToken.text, element.keyToken.range, (0, Parser_1.getBscTypeFromExpression)(element.value, this.functionExpression));
@@ -633,7 +645,7 @@ class UnaryExpression extends Expression {
         super();
         this.operator = operator;
         this.right = right;
-        this.range = util_1.default.createRangeFromPositions(this.operator.range.start, this.right.range.end);
+        this.range = util_1.default.createBoundingRange(this.operator, this.right);
     }
     transpile(state) {
         return [
@@ -750,7 +762,7 @@ class NewExpression extends Expression {
         super();
         this.newKeyword = newKeyword;
         this.call = call;
-        this.range = util_1.default.createRangeFromPositions(this.newKeyword.range.start, this.call.range.end);
+        this.range = util_1.default.createBoundingRange(this.newKeyword, this.call);
     }
     /**
      * The name of the class to initialize (with optional namespace prefixed)
@@ -779,7 +791,7 @@ class NewExpression extends Expression {
 exports.NewExpression = NewExpression;
 class CallfuncExpression extends Expression {
     constructor(callee, operator, methodName, openingParen, args, closingParen) {
-        var _a, _b, _c;
+        var _a;
         super();
         this.callee = callee;
         this.operator = operator;
@@ -787,7 +799,7 @@ class CallfuncExpression extends Expression {
         this.openingParen = openingParen;
         this.args = args;
         this.closingParen = closingParen;
-        this.range = util_1.default.createRangeFromPositions(callee.range.start, ((_c = (_b = (_a = closingParen !== null && closingParen !== void 0 ? closingParen : args[args.length - 1]) !== null && _a !== void 0 ? _a : openingParen) !== null && _b !== void 0 ? _b : methodName) !== null && _c !== void 0 ? _c : operator).range.end);
+        this.range = util_1.default.createBoundingRange(this.callee, this.operator, this.methodName, this.openingParen, ...((_a = this.args) !== null && _a !== void 0 ? _a : []), this.closingParen);
     }
     transpile(state) {
         let result = [];
@@ -828,9 +840,10 @@ exports.CallfuncExpression = CallfuncExpression;
  */
 class TemplateStringQuasiExpression extends Expression {
     constructor(expressions) {
+        var _a;
         super();
         this.expressions = expressions;
-        this.range = util_1.default.createRangeFromPositions(this.expressions[0].range.start, this.expressions[this.expressions.length - 1].range.end);
+        this.range = util_1.default.createBoundingRange(...((_a = this.expressions) !== null && _a !== void 0 ? _a : []));
     }
     transpile(state, skipEmptyStrings = true) {
         let result = [];
@@ -857,12 +870,14 @@ class TemplateStringQuasiExpression extends Expression {
 exports.TemplateStringQuasiExpression = TemplateStringQuasiExpression;
 class TemplateStringExpression extends Expression {
     constructor(openingBacktick, quasis, expressions, closingBacktick) {
+        var _a;
         super();
         this.openingBacktick = openingBacktick;
         this.quasis = quasis;
         this.expressions = expressions;
         this.closingBacktick = closingBacktick;
-        this.range = util_1.default.createRangeFromPositions(quasis[0].range.start, quasis[quasis.length - 1].range.end);
+        //the expression always starts and ends with a quasi, so we don't need to consider the expression locations
+        this.range = util_1.default.createBoundingRange(this.openingBacktick, ...((_a = this.quasis) !== null && _a !== void 0 ? _a : []), this.closingBacktick);
     }
     transpile(state) {
         if (this.quasis.length === 1 && this.expressions.length === 0) {
@@ -914,13 +929,15 @@ class TemplateStringExpression extends Expression {
 exports.TemplateStringExpression = TemplateStringExpression;
 class TaggedTemplateStringExpression extends Expression {
     constructor(tagName, openingBacktick, quasis, expressions, closingBacktick) {
+        var _a;
         super();
         this.tagName = tagName;
         this.openingBacktick = openingBacktick;
         this.quasis = quasis;
         this.expressions = expressions;
         this.closingBacktick = closingBacktick;
-        this.range = util_1.default.createRangeFromPositions(quasis[0].range.start, quasis[quasis.length - 1].range.end);
+        //the expression always starts and ends with a quasi, so we don't need to consider the expression locations
+        this.range = util_1.default.createBoundingRange(this.tagName, this.openingBacktick, ...((_a = this.quasis) !== null && _a !== void 0 ? _a : []), this.closingBacktick);
     }
     transpile(state) {
         let result = [];
@@ -966,7 +983,15 @@ class AnnotationExpression extends Expression {
         this.atToken = atToken;
         this.nameToken = nameToken;
         this.name = nameToken.text;
-        this.range = util_1.default.createRangeFromPositions(atToken.range.start, nameToken.range.end);
+    }
+    get range() {
+        return this.cacheRange();
+    }
+    cacheRange() {
+        if (!this._range) {
+            this._range = util_1.default.createBoundingRange(this.atToken, this.nameToken, this.call);
+        }
+        return this._range;
     }
     /**
      * Convert annotation arguments to JavaScript types
@@ -996,14 +1021,13 @@ class AnnotationExpression extends Expression {
 exports.AnnotationExpression = AnnotationExpression;
 class TernaryExpression extends Expression {
     constructor(test, questionMarkToken, consequent, colonToken, alternate) {
-        var _a, _b, _c;
         super();
         this.test = test;
         this.questionMarkToken = questionMarkToken;
         this.consequent = consequent;
         this.colonToken = colonToken;
         this.alternate = alternate;
-        this.range = util_1.default.createRangeFromPositions(test.range.start, ((_c = (_b = (_a = alternate !== null && alternate !== void 0 ? alternate : colonToken) !== null && _a !== void 0 ? _a : consequent) !== null && _b !== void 0 ? _b : questionMarkToken) !== null && _c !== void 0 ? _c : test).range.end);
+        this.range = util_1.default.createBoundingRange(this.test, this.questionMarkToken, this.consequent, this.colonToken, this.alternate);
     }
     transpile(state) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
@@ -1041,12 +1065,11 @@ class TernaryExpression extends Expression {
 exports.TernaryExpression = TernaryExpression;
 class NullCoalescingExpression extends Expression {
     constructor(consequent, questionQuestionToken, alternate) {
-        var _a;
         super();
         this.consequent = consequent;
         this.questionQuestionToken = questionQuestionToken;
         this.alternate = alternate;
-        this.range = util_1.default.createRangeFromPositions(consequent.range.start, ((_a = alternate !== null && alternate !== void 0 ? alternate : questionQuestionToken) !== null && _a !== void 0 ? _a : consequent).range.end);
+        this.range = util_1.default.createBoundingRange(this.consequent, this.questionQuestionToken, this.alternate);
     }
     transpile(state) {
         let result = [];
@@ -1086,9 +1109,7 @@ class RegexLiteralExpression extends Expression {
     constructor(tokens) {
         super();
         this.tokens = tokens;
-    }
-    get range() {
-        return this.tokens.regexLiteral.range;
+        this.range = this.tokens.regexLiteral.range;
     }
     transpile(state) {
         var _a, _b;
@@ -1119,6 +1140,109 @@ class RegexLiteralExpression extends Expression {
     }
 }
 exports.RegexLiteralExpression = RegexLiteralExpression;
+class TypeExpression extends Expression {
+    constructor(tokens, namespaceName) {
+        super();
+        this.tokens = tokens;
+        this.namespaceName = namespaceName;
+        this.range = util_1.default.createBoundingRange(this.tokens.type);
+    }
+    /**
+     * The this TypeExpression refers to
+     */
+    get type() {
+        if (this._type) {
+            return this._type;
+        }
+        this._type = this.getType(Parser_1.ParseMode.BrighterScript);
+        return this._type;
+    }
+    /**
+     * Derive a BscType from the type token
+     * Can deal with multiple brackets to make multidimensional arrays, eg. float[][]
+     * Defaults to `DynamicType`
+     */
+    getType(parseMode = Parser_1.ParseMode.BrighterScript) {
+        let exprType = this.tokens.type
+            ? util_1.default.tokenToBscType(this.tokens.type, parseMode === Parser_1.ParseMode.BrighterScript, this.namespaceName)
+            : new DynamicType_1.DynamicType();
+        return exprType;
+    }
+    /**
+     * Is this a valid, (eg. known) type?
+     */
+    isValidType(parseMode = Parser_1.ParseMode.BrighterScript) {
+        return !!util_1.default.tokenToBscType(this.tokens.type, parseMode === Parser_1.ParseMode.BrighterScript, this.namespaceName);
+    }
+    /**
+     * Gives a human readable string that says the type
+     * @returns text to display to show the type
+     */
+    getText() {
+        let result = this.tokens.type.text;
+        return result;
+    }
+    transpile(state) {
+        let result = [];
+        //type declaration
+        result.push(state.sourceNode({ range: this.range }, this.type.toTypeString(state.typeContext)));
+        return result;
+    }
+    walk(visitor, options) {
+        //nothing to walk
+    }
+}
+exports.TypeExpression = TypeExpression;
+class ArrayTypeExpression extends TypeExpression {
+    constructor(innerTypes, // this is an array so that in the future when we support union types
+    bracketTokens, namespaceName) {
+        super({}, namespaceName);
+        this.innerTypes = innerTypes;
+        this.bracketTokens = bracketTokens;
+        this.namespaceName = namespaceName;
+        this.range = util_1.default.createBoundingRange(this.bracketTokens.leftBracket, this.bracketTokens.rightBracket, ...this.innerTypes);
+    }
+    /*
+     * TODO - Support union types
+    */
+    get defaultTypeExpression() {
+        return this.innerTypes[0];
+    }
+    /**
+     * Derive a BscType from the type token
+     * Returns an array type with the inner types based on the inner type expressions
+     */
+    getType(parseMode = Parser_1.ParseMode.BrighterScript) {
+        const innerBscTypes = this.innerTypes.map(inner => inner.getType(parseMode));
+        return new ArrayType_1.ArrayType(...innerBscTypes);
+    }
+    /**
+     * Is this a valid, (eg. known) type?
+     */
+    isValidType(parseMode = Parser_1.ParseMode.BrighterScript) {
+        if (parseMode === Parser_1.ParseMode.BrighterScript) {
+            return this.innerTypes.reduce((validSoFar, innerType) => {
+                return validSoFar && innerType.isValidType(parseMode);
+            }, true);
+        }
+        return false;
+    }
+    /**
+     * Gives a human readable string that says the type
+     * @returns text to display to show the type
+     */
+    getText() {
+        return this.defaultTypeExpression.getText() + '[]';
+    }
+    walk(visitor, options) {
+        if (options.walkMode & visitors_1.InternalWalkMode.walkExpressions) {
+            for (let i = 0; i < this.innerTypes.length; i++) {
+                (0, visitors_1.walk)(this.innerTypes, i, visitor, options, this);
+            }
+        }
+    }
+}
+exports.ArrayTypeExpression = ArrayTypeExpression;
 function expressionToValue(expr, strict) {
     if (!expr) {
         return null;