brighterscript 1.0.0-alpha.13 → 1.0.0-alpha.14

package/dist/files/BrsFile.js

@@ -6,8 +6,11 @@ const vscode_languageserver_1 = require("vscode-languageserver");
 const chalk_1 = require("chalk");
 const path = require("path");
 const DiagnosticMessages_1 = require("../DiagnosticMessages");
-const lexer_1 = require("../lexer");
-const parser_1 = require("../parser");
+const Token_1 = require("../lexer/Token");
+const Lexer_1 = require("../lexer/Lexer");
+const TokenKind_1 = require("../lexer/TokenKind");
+const Parser_1 = require("../parser/Parser");
+const DynamicType_1 = require("../types/DynamicType");
 const util_1 = require("../util");
 const BrsTranspileState_1 = require("../parser/BrsTranspileState");
 const Preprocessor_1 = require("../preprocessor/Preprocessor");
@@ -19,8 +22,6 @@ const CommentFlagProcessor_1 = require("../CommentFlagProcessor");
 const BscType_1 = require("../types/BscType");
 const UninitializedType_1 = require("../types/UninitializedType");
 const InvalidType_1 = require("../types/InvalidType");
-const globalCallables_1 = require("../globalCallables");
-const DynamicType_1 = require("../types/DynamicType");
 /**
  * Holds all details about this file within the scope of the whole program
  */
@@ -41,9 +42,10 @@ class BrsFile {
         /**
          * The parseMode used for the parser for this file
          */
-        this.parseMode = parser_1.ParseMode.BrightScript;
+        this.parseMode = Parser_1.ParseMode.BrightScript;
         /**
          * Indicates whether this file needs to be validated.
+         * Files are only ever validated a single time
          */
         this.isValidated = false;
         this.diagnostics = [];
@@ -64,7 +66,7 @@ class BrsFile {
         //all BrighterScript files need to be transpiled
         if ((_a = this.extension) === null || _a === void 0 ? void 0 : _a.endsWith('.bs')) {
             this.needsTranspiled = true;
-            this.parseMode = parser_1.ParseMode.BrighterScript;
+            this.parseMode = Parser_1.ParseMode.BrighterScript;
         }
         this.isTypedef = this.extension === '.d.bs';
         if (!this.isTypedef) {
@@ -135,11 +137,13 @@ class BrsFile {
             this.diagnostics = [];
             //if we have a typedef file, skip parsing this file
             if (this.hasTypedef) {
+                //skip validation since the typedef is shadowing this file
+                this.isValidated = true;
                 return;
             }
             //tokenize the input file
             let lexer = this.program.logger.time(Logger_1.LogLevel.debug, ['lexer.lex', chalk_1.default.green(this.srcPath)], () => {
-                return lexer_1.Lexer.scan(fileContents, {
+                return Lexer_1.Lexer.scan(fileContents, {
                     includeWhitespace: false
                 });
             });
@@ -162,7 +166,7 @@ class BrsFile {
             //if the preprocessor generated tokens, use them.
             let tokens = preprocessor.processedTokens.length > 0 ? preprocessor.processedTokens : lexer.tokens;
             this.program.logger.time(Logger_1.LogLevel.debug, ['parser.parse', chalk_1.default.green(this.srcPath)], () => {
-                this._parser = parser_1.Parser.parse(tokens, {
+                this._parser = Parser_1.Parser.parse(tokens, {
                     mode: this.parseMode,
                     logger: this.program.logger
                 });
@@ -173,20 +177,39 @@ class BrsFile {
             this.findCallables();
             //find all places where a sub/function is being called
             this.findFunctionCalls();
-            this.findAndValidateImportAndImportStatements();
+            //register all import statements for use in the rest of the program
+            this.registerImports();
             //attach this file to every diagnostic
             for (let diagnostic of this.diagnostics) {
                 diagnostic.file = this;
             }
         }
         catch (e) {
-            this._parser = new parser_1.Parser();
+            this._parser = new Parser_1.Parser();
             this.diagnostics.push(Object.assign({ file: this, range: util_1.util.createRange(0, 0, 0, Number.MAX_VALUE) }, DiagnosticMessages_1.DiagnosticMessages.genericParserMessage('Critical error parsing file: ' + JSON.stringify((0, serialize_error_1.serializeError)(e)))));
         }
     }
-    validate() { }
-    findAndValidateImportAndImportStatements() {
-        var _a;
+    registerImports() {
+        var _a, _b, _c, _d;
+        for (const statement of (_c = (_b = (_a = this.parser) === null || _a === void 0 ? void 0 : _a.references) === null || _b === void 0 ? void 0 : _b.importStatements) !== null && _c !== void 0 ? _c : []) {
+            //register import statements
+            if ((0, reflection_1.isImportStatement)(statement) && statement.filePathToken) {
+                this.ownScriptImports.push({
+                    filePathRange: statement.filePathToken.range,
+                    pkgPath: util_1.util.getPkgPathFromTarget(this.pkgPath, statement.filePath),
+                    sourceFile: this,
+                    text: (_d = statement.filePathToken) === null || _d === void 0 ? void 0 : _d.text
+                });
+            }
+        }
+    }
+    validate() {
+        //only validate the file if it was actually parsed (skip files containing typedefs)
+        if (!this.hasTypedef) {
+            this.validateImportStatements();
+        }
+    }
+    validateImportStatements() {
         let topOfFileIncludeStatements = [];
         for (let stmt of this.ast.statements) {
             //skip comments
@@ -207,15 +230,6 @@ class BrsFile {
             ...this._parser.references.importStatements
         ];
         for (let result of statements) {
-            //register import statements
-            if ((0, reflection_1.isImportStatement)(result) && result.filePathToken) {
-                this.ownScriptImports.push({
-                    filePathRange: result.filePathToken.range,
-                    pkgPath: util_1.util.getPkgPathFromTarget(this.pkgPath, result.filePath),
-                    sourceFile: this,
-                    text: (_a = result.filePathToken) === null || _a === void 0 ? void 0 : _a.text
-                });
-            }
             //if this statement is not one of the top-of-file statements,
             //then add a diagnostic explaining that it is invalid
             if (!topOfFileIncludeStatements.includes(result)) {
@@ -273,7 +287,7 @@ class BrsFile {
         const processor = new CommentFlagProcessor_1.CommentFlagProcessor(this, ['rem', `'`], DiagnosticMessages_1.diagnosticCodes, [DiagnosticMessages_1.DiagnosticCodeMap.unknownDiagnosticCode]);
         this.commentFlags = [];
         for (let token of tokens) {
-            if (token.kind === lexer_1.TokenKind.Comment) {
+            if (token.kind === TokenKind_1.TokenKind.Comment) {
                 processor.tryAdd(token.text, token.range);
             }
         }
@@ -325,7 +339,7 @@ class BrsFile {
                 let args = [];
                 //TODO convert if stmts to use instanceof instead
                 for (let arg of expression.args) {
-                    let inferredType = (0, parser_1.getBscTypeFromExpression)(arg, func);
+                    let inferredType = (0, Parser_1.getBscTypeFromExpression)(arg, func);
                     let argText = '';
                     // Get the text to display for the arg
                     if (arg.token) {
@@ -333,7 +347,7 @@ class BrsFile {
                         //is a function call being passed into argument
                     }
                     else if (arg.name) {
-                        if ((0, lexer_1.isToken)(arg.name)) {
+                        if ((0, Token_1.isToken)(arg.name)) {
                             argText = arg.name.text;
                         }
                     }
@@ -404,10 +418,10 @@ class BrsFile {
         //if cursor is within a comment, disable completions
         let currentToken = this.parser.getTokenAt(position);
         const tokenKind = currentToken === null || currentToken === void 0 ? void 0 : currentToken.kind;
-        if (tokenKind === lexer_1.TokenKind.Comment) {
+        if (tokenKind === TokenKind_1.TokenKind.Comment) {
             return [];
         }
-        else if (tokenKind === lexer_1.TokenKind.StringLiteral || tokenKind === lexer_1.TokenKind.TemplateStringQuasi) {
+        else if (tokenKind === TokenKind_1.TokenKind.StringLiteral || tokenKind === TokenKind_1.TokenKind.TemplateStringQuasi) {
             const match = /^("?)(pkg|libpkg):/.exec(currentToken.text);
             if (match) {
                 const [, openingQuote, fileProtocol] = match;
@@ -439,7 +453,7 @@ class BrsFile {
         let functionExpression = this.getFunctionExpressionAtPosition(position);
         if (!functionExpression) {
             //we aren't in any function scope, so return the keyword completions and namespaces
-            if (this.parser.getTokenBefore(currentToken, lexer_1.TokenKind.New)) {
+            if (this.parser.getTokenBefore(currentToken, TokenKind_1.TokenKind.New)) {
                 // there's a new keyword, so only class types are viable here
                 return [...this.getGlobalClassStatementCompletions(currentToken, this.parseMode)];
             }
@@ -448,17 +462,17 @@ class BrsFile {
             }
         }
         const classNameCompletions = this.getGlobalClassStatementCompletions(currentToken, this.parseMode);
-        const newToken = this.parser.getTokenBefore(currentToken, lexer_1.TokenKind.New);
+        const newToken = this.parser.getTokenBefore(currentToken, TokenKind_1.TokenKind.New);
         if (newToken) {
             //we are after a new keyword; so we can only be namespaces or classes at this point
             result.push(...classNameCompletions);
             result.push(...namespaceCompletions);
             return result;
         }
-        if (this.parser.tokenFollows(currentToken, lexer_1.TokenKind.Goto)) {
+        if (this.parser.tokenFollows(currentToken, TokenKind_1.TokenKind.Goto)) {
             return this.getLabelCompletion(functionExpression);
         }
-        if (this.parser.isPositionNextToTokenKind(position, lexer_1.TokenKind.Dot)) {
+        if (this.parser.isPositionNextToTokenKind(position, TokenKind_1.TokenKind.Dot)) {
             if (namespaceCompletions.length > 0) {
                 //if we matched a namespace, after a dot, it can't be anything else but something from our namespace completions
                 return namespaceCompletions;
@@ -514,7 +528,7 @@ class BrsFile {
                     // kind: isFunctionType(foundType) ? CompletionItemKind.Function : CompletionItemKind.Variable
                 });
             }
-            if (this.parseMode === parser_1.ParseMode.BrighterScript) {
+            if (this.parseMode === Parser_1.ParseMode.BrighterScript) {
                 //include the first part of namespaces
                 let namespaces = scope.getAllNamespaceStatements();
                 for (let stmt of namespaces) {
@@ -552,7 +566,7 @@ class BrsFile {
         let classStatement = this.getClassFromToken(currentToken, functionExpression, scope);
         let results = new Map();
         if (classStatement) {
-            let classes = scope.getClassHierarchy(classStatement.item.getName(parser_1.ParseMode.BrighterScript).toLowerCase());
+            let classes = scope.getClassHierarchy(classStatement.item.getName(Parser_1.ParseMode.BrighterScript).toLowerCase());
             for (let cs of classes) {
                 for (let member of [...(_b = (_a = cs === null || cs === void 0 ? void 0 : cs.item) === null || _a === void 0 ? void 0 : _a.fields) !== null && _b !== void 0 ? _b : [], ...(_d = (_c = cs === null || cs === void 0 ? void 0 : cs.item) === null || _c === void 0 ? void 0 : _c.methods) !== null && _d !== void 0 ? _d : []]) {
                     if (!results.has(member.name.text.toLowerCase())) {
@@ -602,7 +616,7 @@ class BrsFile {
         let startsWithNamespace = '';
         let namespaceContainer;
         let tokenChain = [...originalTokenChain];
-        while (tokenChain[0] && tokenChain[0].usage === parser_1.TokenUsage.Direct) {
+        while (tokenChain[0] && tokenChain[0].usage === Parser_1.TokenUsage.Direct) {
             const namespaceNameToCheck = `${startsWithNamespace}${startsWithNamespace.length > 0 ? '.' : ''}${tokenChain[0].token.text}`.toLowerCase();
             const foundNamespace = scope.namespaceLookup.get(namespaceNameToCheck);
             if (foundNamespace) {
@@ -633,7 +647,7 @@ class BrsFile {
             let useExpandedTextOnly = false;
             if (containingClass.name === currentToken) {
                 symbolType = containingClass.getCustomType();
-                expandedText = `class ${containingClass.getName(parser_1.ParseMode.BrighterScript)}`;
+                expandedText = `class ${containingClass.getName(Parser_1.ParseMode.BrighterScript)}`;
                 useExpandedTextOnly = true;
                 currentClassRef = containingClass;
             }
@@ -652,13 +666,13 @@ class BrsFile {
                 // check if this is a method declaration
                 currentClassRef = containingClass;
                 symbolType = containingClass === null || containingClass === void 0 ? void 0 : containingClass.memberTable.getSymbolType(currentTokenLower, true, { file: this, scope: scope });
-                expandedText = [containingClass.getName(parser_1.ParseMode.BrighterScript), currentToken.text].join('.');
+                expandedText = [containingClass.getName(Parser_1.ParseMode.BrighterScript), currentToken.text].join('.');
             }
             else if (!func) {
                 // check if this is a field  declaration
                 currentClassRef = containingClass;
                 symbolType = containingClass === null || containingClass === void 0 ? void 0 : containingClass.memberTable.getSymbolType(currentTokenLower, true, { file: this, scope: scope });
-                expandedText = [containingClass.getName(parser_1.ParseMode.BrighterScript), currentToken.text].join('.');
+                expandedText = [containingClass.getName(Parser_1.ParseMode.BrighterScript), currentToken.text].join('.');
             }
             if (symbolType) {
                 return { type: symbolType, expandedTokenText: expandedText, symbolContainer: currentClassRef, useExpandedTextOnly: useExpandedTextOnly };
@@ -690,7 +704,7 @@ class BrsFile {
      */
     getSymbolTypeFromToken(currentToken, functionExpression, scope) {
         var _a, _b, _c, _d, _e;
-        if (!scope) {
+        if (!scope || !currentToken) {
             return undefined;
         }
         const cachedSymbolData = scope.symbolCache.get(currentToken);
@@ -720,13 +734,14 @@ class BrsFile {
         const typeContext = { file: this, scope: scope, position: (_c = tokenChain[0]) === null || _c === void 0 ? void 0 : _c.token.range.start };
         for (const tokenChainMember of tokenChain) {
             const token = tokenChainMember === null || tokenChainMember === void 0 ? void 0 : tokenChainMember.token;
+            const tokenUsage = tokenChainMember === null || tokenChainMember === void 0 ? void 0 : tokenChainMember.usage;
             const tokenLowerText = token.text.toLowerCase();
             if (tokenLowerText === 'super' && (0, reflection_1.isClassStatement)(symbolContainer) && tokenFoundCount === 0) {
                 /// Special cases for first item in chain inside a class
                 symbolContainer = scope === null || scope === void 0 ? void 0 : scope.getParentClass(symbolContainer);
                 currentSymbolTable = (_d = symbolContainer) === null || _d === void 0 ? void 0 : _d.memberTable;
                 if (symbolContainer && currentSymbolTable) {
-                    tokenText.push(symbolContainer.getName(parser_1.ParseMode.BrighterScript));
+                    tokenText.push(symbolContainer.getName(Parser_1.ParseMode.BrighterScript));
                     tokenFoundCount++;
                     continue;
                 }
@@ -738,7 +753,7 @@ class BrsFile {
             symbolType = currentSymbolTable.getSymbolType(tokenLowerText, true, typeContext);
             if (tokenFoundCount === 0 && !symbolType) {
                 //check for global callable
-                symbolType = (_e = globalCallables_1.globalCallableMap.get(tokenLowerText)) === null || _e === void 0 ? void 0 : _e.type;
+                symbolType = (_e = scope.getGlobalCallableByName(tokenLowerText)) === null || _e === void 0 ? void 0 : _e.type;
             }
             if (symbolType) {
                 // found this symbol, and it's valid. increase found counter
@@ -750,10 +765,13 @@ class BrsFile {
                 // the next symbol to check will be the return value of this function
                 symbolType = (0, BscType_1.getTypeFromContext)(symbolType.returnType, typeContext);
                 if (tokenFoundCount < tokenChain.length) {
-                    // We're still
+                    // We still have more tokens, but remember the last known reference
                     symbolTypeBeforeReference = symbolType;
                 }
             }
+            if ((0, reflection_1.isArrayType)(symbolType) && tokenUsage === Parser_1.TokenUsage.ArrayReference) {
+                symbolType = (0, BscType_1.getTypeFromContext)(symbolType.getDefaultType(typeContext), typeContext);
+            }
             if (symbolType === null || symbolType === void 0 ? void 0 : symbolType.memberTable) {
                 if ((0, reflection_1.isCustomType)(symbolType)) {
                     // we're currently looking at a customType, that has it's own symbol table
@@ -783,9 +801,12 @@ class BrsFile {
                 tokenText.push(token.text);
                 break;
             }
-            if (tokenText.length > 2) {
-                tokenText.shift(); // only care about last two symbols
-            }
+        }
+        if (tokenText.length > 2) {
+            // TokenText is used for hovers. We only need the last two tokens for a hover
+            // So in a long chain (e.g. klass.getData()[0].anotherKlass.property), the hover
+            // for the last token should just be "AnotherKlass.property", not the whole chain
+            tokenText = tokenText.slice(-2);
         }
         let expandedTokenText = tokenText.join('.');
         let backUpReturnType;
@@ -827,11 +848,11 @@ class BrsFile {
     }
     getGlobalClassStatementCompletions(currentToken, parseMode) {
         var _a;
-        if (parseMode === parser_1.ParseMode.BrightScript) {
+        if (parseMode === Parser_1.ParseMode.BrightScript) {
             return [];
         }
         let results = new Map();
-        let completionName = (_a = this.getPartialVariableName(currentToken, [lexer_1.TokenKind.New])) === null || _a === void 0 ? void 0 : _a.toLowerCase();
+        let completionName = (_a = this.getPartialVariableName(currentToken, [TokenKind_1.TokenKind.New])) === null || _a === void 0 ? void 0 : _a.toLowerCase();
         if (completionName === null || completionName === void 0 ? void 0 : completionName.includes('.')) {
             return [];
         }
@@ -853,17 +874,17 @@ class BrsFile {
     }
     getNamespaceCompletions(currentToken, parseMode, scope) {
         //BrightScript does not support namespaces, so return an empty list in that case
-        if (parseMode === parser_1.ParseMode.BrightScript) {
+        if (parseMode === Parser_1.ParseMode.BrightScript) {
             return [];
         }
-        let completionName = this.getPartialVariableName(currentToken, [lexer_1.TokenKind.New]);
+        let completionName = this.getPartialVariableName(currentToken, [TokenKind_1.TokenKind.New]);
         if (!completionName) {
             return [];
         }
         //remove any trailing identifer and then any trailing dot, to give us the
         //name of its immediate parent namespace
         let closestParentNamespaceName = completionName.replace(/\.([a-z0-9_]*)?$/gi, '');
-        let newToken = this.parser.getTokenBefore(currentToken, lexer_1.TokenKind.New);
+        let newToken = this.parser.getTokenBefore(currentToken, TokenKind_1.TokenKind.New);
         let result = new Map();
         for (let [, namespace] of scope.namespaceLookup) {
             //completionName = "NameA."
@@ -912,11 +933,11 @@ class BrsFile {
             return undefined;
         }
         let location;
-        const nameParts = this.getPartialVariableName(token, [lexer_1.TokenKind.New]).split('.');
+        const nameParts = this.getPartialVariableName(token, [TokenKind_1.TokenKind.New]).split('.');
         const endName = nameParts[nameParts.length - 1].toLowerCase();
         const namespaceName = nameParts.slice(0, -1).join('.').toLowerCase();
         const statementHandler = (statement) => {
-            if (!location && statement.getName(parser_1.ParseMode.BrighterScript).toLowerCase() === namespaceName) {
+            if (!location && statement.getName(Parser_1.ParseMode.BrighterScript).toLowerCase() === namespaceName) {
                 const namespaceItemStatementHandler = (statement) => {
                     if (!location && statement.name.text.toLowerCase() === endName) {
                         const uri = util_1.util.pathToUri(file.srcPath);
@@ -942,7 +963,7 @@ class BrsFile {
      * Given a current token, walk
      */
     getPartialVariableName(currentToken, excludeTokens = null) {
-        let identifierAndDotKinds = [lexer_1.TokenKind.Identifier, ...lexer_1.AllowedLocalIdentifiers, lexer_1.TokenKind.Dot];
+        let identifierAndDotKinds = [TokenKind_1.TokenKind.Identifier, ...TokenKind_1.AllowedLocalIdentifiers, TokenKind_1.TokenKind.Dot];
         //consume tokens backwards until we find something other than a dot or an identifier
         let tokens = [];
         const parser = this.parser;
@@ -1073,7 +1094,7 @@ class BrsFile {
         else {
             return;
         }
-        const name = (0, reflection_1.isClassFieldStatement)(statement) ? statement.name.text : statement.getName(parser_1.ParseMode.BrighterScript);
+        const name = (0, reflection_1.isClassFieldStatement)(statement) ? statement.name.text : statement.getName(Parser_1.ParseMode.BrighterScript);
         return vscode_languageserver_1.DocumentSymbol.create(name, '', symbolKind, statement.range, statement.range, children);
     }
     /**
@@ -1107,9 +1128,9 @@ class BrsFile {
         else {
             return symbols;
         }
-        const name = statement.getName(parser_1.ParseMode.BrighterScript);
+        const name = statement.getName(Parser_1.ParseMode.BrighterScript);
         const uri = util_1.util.pathToUri(this.srcPath);
-        const symbol = vscode_languageserver_1.SymbolInformation.create(name, symbolKind, statement.range, uri, containerStatement === null || containerStatement === void 0 ? void 0 : containerStatement.getName(parser_1.ParseMode.BrighterScript));
+        const symbol = vscode_languageserver_1.SymbolInformation.create(name, symbolKind, statement.range, uri, containerStatement === null || containerStatement === void 0 ? void 0 : containerStatement.getName(Parser_1.ParseMode.BrighterScript));
         symbols.push(symbol);
         return symbols;
     }
@@ -1123,8 +1144,8 @@ class BrsFile {
         const token = this.parser.getTokenAt(position);
         // While certain other tokens are allowed as local variables (AllowedLocalIdentifiers: https://github.com/rokucommunity/brighterscript/blob/master/src/lexer/TokenKind.ts#L418), these are converted by the parser to TokenKind.Identifier by the time we retrieve the token using getTokenAt
         let definitionTokenTypes = [
-            lexer_1.TokenKind.Identifier,
-            lexer_1.TokenKind.StringLiteral
+            TokenKind_1.TokenKind.Identifier,
+            TokenKind_1.TokenKind.StringLiteral
         ];
         //throw out invalid tokens and the wrong kind of tokens
         if (!token || !definitionTokenTypes.includes(token.kind)) {
@@ -1132,7 +1153,7 @@ class BrsFile {
         }
         let textToSearchFor = token.text.toLowerCase();
         const previousToken = this.parser.getTokenAt({ line: token.range.start.line, character: token.range.start.character });
-        if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === lexer_1.TokenKind.Callfunc) {
+        if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === TokenKind_1.TokenKind.Callfunc) {
             for (const scope of this.program.getScopes()) {
                 //to only get functions defined in interface methods
                 const callable = scope.getAllCallables().find((c) => c.callable.name.toLowerCase() === textToSearchFor); // eslint-disable-line @typescript-eslint/no-loop-func
@@ -1142,7 +1163,7 @@ class BrsFile {
             }
             return results;
         }
-        let classToken = this.parser.getTokenBefore(token, lexer_1.TokenKind.Class);
+        let classToken = this.parser.getTokenBefore(token, TokenKind_1.TokenKind.Class);
         if (classToken) {
             let cs = this.parser.references.classStatements.find((cs) => cs.classKeyword.range === classToken.range);
             if (cs === null || cs === void 0 ? void 0 : cs.parentClassName) {
@@ -1154,7 +1175,7 @@ class BrsFile {
             }
             return results;
         }
-        if (token.kind === lexer_1.TokenKind.StringLiteral) {
+        if (token.kind === TokenKind_1.TokenKind.StringLiteral) {
             // We need to strip off the quotes but only if present
             const startIndex = textToSearchFor.startsWith('"') ? 1 : 0;
             let endIndex = textToSearchFor.length;
@@ -1173,7 +1194,7 @@ class BrsFile {
                 results.push(vscode_languageserver_1.Location.create(uri, symbol.range));
             }
         }
-        if (this.parser.tokenFollows(token, lexer_1.TokenKind.Goto)) {
+        if (this.parser.tokenFollows(token, TokenKind_1.TokenKind.Goto)) {
             for (const label of func.labelStatements) {
                 if (label.tokens.identifier.text.toLocaleLowerCase() === textToSearchFor) {
                     const uri = util_1.util.pathToUri(this.srcPath);
@@ -1189,7 +1210,7 @@ class BrsFile {
                     continue;
                 }
                 filesSearched.add(file);
-                if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === lexer_1.TokenKind.Dot && file.parseMode === parser_1.ParseMode.BrighterScript) {
+                if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === TokenKind_1.TokenKind.Dot && file.parseMode === Parser_1.ParseMode.BrighterScript) {
                     results.push(...this.getClassMemberDefinitions(textToSearchFor, file));
                     const namespaceDefinition = this.getNamespaceDefinitions(token, file);
                     if (namespaceDefinition) {
@@ -1234,14 +1255,15 @@ class BrsFile {
     }
     getHover(position) {
         var _a, _b, _c;
+        const fence = (code) => util_1.util.mdFence(code, 'brightscript');
         //get the token at the position
         let token = this.parser.getTokenAt(position);
         let hoverTokenTypes = [
-            lexer_1.TokenKind.Identifier,
-            lexer_1.TokenKind.Function,
-            lexer_1.TokenKind.EndFunction,
-            lexer_1.TokenKind.Sub,
-            lexer_1.TokenKind.EndSub
+            TokenKind_1.TokenKind.Identifier,
+            TokenKind_1.TokenKind.Function,
+            TokenKind_1.TokenKind.EndFunction,
+            TokenKind_1.TokenKind.Sub,
+            TokenKind_1.TokenKind.EndSub
         ];
         //throw out invalid tokens and the wrong kind of tokens
         if (!token || !hoverTokenTypes.includes(token.kind)) {
@@ -1262,48 +1284,95 @@ class BrsFile {
                     }
                 }
             }
-            const typeTexts = [];
-            for (const scope of this.program.getScopesForFile(this)) {
+            const typeTexts = new Set();
+            const fileScopes = this.program.getScopesForFile(this).sort((a, b) => { var _a; return (_a = a.dependencyGraphKey) === null || _a === void 0 ? void 0 : _a.localeCompare(b.dependencyGraphKey); });
+            const callables = [];
+            for (const scope of fileScopes) {
                 scope.linkSymbolTable();
+                const typeContext = { file: this, scope: scope, position: position };
                 const typeTextPair = this.getSymbolTypeFromToken(token, func, scope);
                 if (typeTextPair) {
                     let scopeTypeText = '';
                     if ((0, reflection_1.isFunctionType)(typeTextPair.type)) {
-                        scopeTypeText = (_b = typeTextPair.type) === null || _b === void 0 ? void 0 : _b.toString();
+                        scopeTypeText = (_b = typeTextPair.type) === null || _b === void 0 ? void 0 : _b.toString(typeContext);
+                        //keep unique references to the callables for this function
+                        if (!typeTexts.has(scopeTypeText)) {
+                            callables.push(scope.getCallableByName(lowerTokenText));
+                        }
                     }
                     else if (typeTextPair.useExpandedTextOnly) {
                         scopeTypeText = typeTextPair.expandedTokenText;
                     }
                     else {
-                        scopeTypeText = `${typeTextPair.expandedTokenText} as ${(_c = typeTextPair.type) === null || _c === void 0 ? void 0 : _c.toString()}`;
+                        scopeTypeText = `${typeTextPair.expandedTokenText} as ${(_c = typeTextPair.type) === null || _c === void 0 ? void 0 : _c.toString(typeContext)}`;
                     }
-                    if (scopeTypeText && !typeTexts.includes(scopeTypeText)) {
-                        typeTexts.push(scopeTypeText);
+                    if (scopeTypeText) {
+                        typeTexts.add(scopeTypeText);
                     }
                 }
                 scope.unlinkSymbolTable();
             }
-            const typeText = typeTexts.join(' | ');
-            if (typeText) {
+            if (callables.length === typeTexts.size) {
+                //this is a function in all scopes, so build the function hover
+                return {
+                    range: token.range,
+                    contents: this.getCallableDocumentation([...typeTexts], callables)
+                };
+            }
+            else if ((typeTexts === null || typeTexts === void 0 ? void 0 : typeTexts.size) > 0) {
+                const typeText = [...typeTexts].join(' | ');
                 return {
                     range: token.range,
-                    contents: typeText
+                    contents: fence(typeText)
                 };
             }
         }
-        //look through all callables in relevant scopes
-        {
-            let scopes = this.program.getScopesForFile(this);
-            for (let scope of scopes) {
-                let callable = scope.getCallableByName(lowerTokenText);
-                if (callable) {
-                    return {
-                        range: token.range,
-                        contents: callable.type.toString()
-                    };
-                }
+        // //look through all callables in relevant scopes
+        // {
+        //     let scopes = this.program.getScopesForFile(this);
+        //     for (let scope of scopes) {
+        //         let callable = scope.getCallableByName(lowerTokenText);
+        //         if (callable) {
+        //             return {
+        //                 range: token.range,
+        //                 contents: this.getCallableDocumentation(callables)
+        //             };
+        //         }
+        //     }
+        // }
+    }
+    /**
+     * Build a hover documentation for a callable.
+     */
+    getCallableDocumentation(typeTexts, callables) {
+        var _a;
+        const callable = callables[0];
+        const typeText = typeTexts[0];
+        const comments = [];
+        const tokens = callable === null || callable === void 0 ? void 0 : callable.file.parser.tokens;
+        const idx = tokens === null || tokens === void 0 ? void 0 : tokens.indexOf((_a = callable.functionStatement) === null || _a === void 0 ? void 0 : _a.func.functionType);
+        for (let i = idx - 1; i >= 0; i--) {
+            const token = tokens[i];
+            //skip whitespace and newline chars
+            if (token.kind === TokenKind_1.TokenKind.Comment) {
+                comments.push(token);
+            }
+            else if (token.kind === TokenKind_1.TokenKind.Newline || token.kind === TokenKind_1.TokenKind.Whitespace) {
+                //skip these tokens
+                continue;
+                //any other token means there are no more comments
+            }
+            else {
+                break;
             }
         }
+        //message indicating if there are variations. example: (+3 variations) if there are 4 unique function signatures
+        const multiText = callables.length > 1 ? ` (+${callables.length - 1} variations)` : '';
+        let result = util_1.util.mdFence(typeText + multiText, 'brightscript');
+        if (comments.length > 0) {
+            result += '\n***\n' + comments.reverse().map(x => x.text.replace(/^('|rem)/i, '')).join('\n');
+        }
+        return result;
     }
     getSignatureHelpForNamespaceMethods(callableName, dottedGetText, scope) {
         var _a;
@@ -1351,12 +1420,12 @@ class BrsFile {
                 }
             }
             const kind = currentToken.kind;
-            if (kind === lexer_1.TokenKind.Comment) {
+            if (kind === TokenKind_1.TokenKind.Comment) {
                 // Strip off common leading characters to make it easier to read
                 const commentText = currentToken.text.replace(/^[' *\/]+/, '');
                 functionComments.unshift(commentText);
             }
-            else if (kind === lexer_1.TokenKind.Newline) {
+            else if (kind === TokenKind_1.TokenKind.Newline) {
                 if (functionComments.length === 0) {
                     continue;
                 }
@@ -1416,7 +1485,7 @@ class BrsFile {
         const classConstructor = this.getClassMethod(classStatement, 'new');
         let sigHelp = classConstructor ? this.getSignatureHelpForStatement(classConstructor) : undefined;
         if (sigHelp) {
-            sigHelp.key = classStatement.getName(parser_1.ParseMode.BrighterScript);
+            sigHelp.key = classStatement.getName(Parser_1.ParseMode.BrighterScript);
             sigHelp.signature.label = sigHelp.signature.label.replace(/(function|sub) new/, sigHelp.key);
         }
         return sigHelp;
@@ -1493,7 +1562,7 @@ exports.BrsFile = BrsFile;
  * List of completions for all valid keywords/reserved words.
  * Build this list once because it won't change for the lifetime of this process
  */
-exports.KeywordCompletions = Object.keys(lexer_1.Keywords)
+exports.KeywordCompletions = Object.keys(TokenKind_1.Keywords)
     //remove any keywords with whitespace
     .filter(x => !x.includes(' '))
     //create completions