Adds Callfunc Completion and Validation #1352

markwpearce · 2024-11-21T20:26:09Z

Gives callFunc a whole lotta love!

Fixes an issue with completions on @. where ALL possible callfuncs would appear. This was a result of the parser having an exception on incomplete @. invocations
Adds function documentation to hovers on @. callfunc invocations
Stores all resolved types associated with callfuncs for a component in a symbolTable that is used a sibiling table when the callfunc is used in another scope
Return type of Callfunc and @. invocations are used to set types in assignments
Validates arg counts and type mismatches for callfunc and @.

While I was it, I also added validation and return typing for <component>.createChild()

Additional validation enhancements:

if a type depends on another type (eg, has a member of another type), and that member type changes, then all segments/ASTNodes that reference the wider type are also re-validated. This means that the type-safety flows down and things get appropriately re-validated when there are changes.
Better handling of typecast statements when setting up file segments for revalidation
Better handling of when component types change, and re-validation because of that.

TODO:

Make validation updates work better. Currently, you need to edit an XML file of the component for things to revalidate if the exported function type changes
Deal with how adding sibling tables messes up other validations. Like if the resolved version stay around when they actually should be unresolved
Do not have validation errors if the component type is the generic roSGNode

To be honest, I think that if we properly re-build the Component type when a member file changes, that would fix both problems.

Also fixes #1309

…re built in types

…anges

markwpearce · 2024-11-25T17:25:12Z

src/AstValidationSegmenter.ts

@@ -169,6 +174,16 @@ export class AstValidationSegmenter {
        const assignedSymbolsNames = new Set<string>();
        this.currentClassStatement = segment.findAncestor(isClassStatement);

+        if (isTypecastStatement(segment)) {


Changes in this file are related to typecast statements... if there's a top level typecast, then if that type changes, everything referencing m should be revalidated

markwpearce · 2024-11-25T17:26:42Z

src/DiagnosticManager.ts

@@ -234,7 +234,7 @@ export class DiagnosticManager {
                    isMatch = !!context.tags?.includes(filter.tag);
                }
                if (isMatch && needToMatch.scope) {
-                    isMatch = context.scope === filter.scope;
+                    isMatch = context.scope?.name === filter.scope.name;


if an xml file changes, then there is a new scope created, so a check on context.scope === filter.scope wouldn't work to remove old diagnostics

markwpearce · 2024-11-25T17:27:31Z

src/types/BscType.ts

@@ -10,6 +10,7 @@ export abstract class BscType {
    public readonly memberTable: SymbolTable;
    protected __identifier: string;
    protected hasAddedBuiltInInterfaces = false;
+    public isBuiltIn = false;


Added a flag at the type level to basically say "this is a type we don't need to mess with"

markwpearce · 2024-11-25T17:28:28Z

src/Program.ts

@@ -385,16 +402,20 @@ export class Program {
     * @param xmlFile XML file with <component> tag
     */
    private addDeferredComponentTypeSymbolCreation(xmlFile: XmlFile) {
-        this.componentSymbolsToUpdate.add({ componentKey: this.getComponentKey(xmlFile), componentName: xmlFile.componentName?.text });
-
+        const componentKey = this.getComponentKey(xmlFile);


changed this to a map with unique keys, because there multiple places where it can get updated

markwpearce · 2024-11-25T17:44:25Z

src/Program.ts

        const scopesForCrossScopeValidation = [];
        for (let scopeName of this.getSortedScopeNames()) {
            let scope = this.scopes[scopeName];
-            if (this.globalScope !== scope && !scope.isValidated) {
+            if (this.globalScope !== scope && (someComponentTypeChanged || !scope.isValidated)) {


If a component type changes, don't try to limit the number of scopes to check.
In reality, this hardly changes the actual validation time anyway

markwpearce · 2024-11-25T17:45:17Z

src/SymbolTable.ts

+
+    private cachedCircularReferenceCheck: null | boolean = null;
+
+    private hasCircularReferenceWithAncestor() {


ran into some problems with circular references in symbol tables --- best way to deal with that is to check once and cache

markwpearce · 2024-11-25T17:48:15Z

src/bscPlugin/validation/ScopeValidator.ts

@@ -288,18 +293,8 @@ export class ScopeValidator {
        //if this is a `createObject('roSGNode'` call, only support known sg node types
        if (firstParamStringValueLower === 'rosgnode' && isLiteralExpression(call?.args[1])) {
            const componentName: Token = call?.args[1]?.tokens.value;
-            //don't validate any components with a colon in their name (probably component libraries, but regular components can have them too).


refactored some of this code to make checking specific KINDs of function calls easier - eg. callfunc args are offset by 1 vs. real function call args

markwpearce · 2024-11-25T17:49:51Z

src/files/BrsFile.ts

@@ -46,6 +46,7 @@ import { DefinitionProvider } from '../bscPlugin/definition/DefinitionProvider';
 export interface ProvidedSymbol {
    symbol: BscSymbol;
    duplicates: BscSymbol[];
+    requiredSymbolNames?: Set<string>;


These are the required symbol names this symbol provided from the file needs

markwpearce · 2024-11-25T17:51:17Z

src/parser/Parser.ts

-        let openParen = this.consume(DiagnosticMessages.expectedOpenParenToFollowCallfuncIdentifier(), TokenKind.LeftParen);
-        let call = this.finishCall(openParen, callee, false);
-
+        let methodName = this.tryConsume(DiagnosticMessages.expectedIdentifier(), TokenKind.Identifier, ...AllowedProperties);


this change makes it so an exception is NOT thrown on a bad @. line, so that proper completions are provided

markwpearce · 2024-11-25T17:52:40Z

src/types/ComponentType.ts

+            return true;
+        }
+
+        return isComponentType(targetType) && this.name.toLowerCase() === targetType.name.toLowerCase() &&


A better job of checking equality of Component Types, so that we can check if a change was substantial enough to re-validate

markwpearce · 2024-11-25T17:53:11Z

src/types/ComponentType.ts

@@ -60,9 +73,11 @@ export class ComponentType extends InheritableType {
        }
    }

+    private hasStartedAddingBuiltInInterfaces = false;


needed to add this incase there were some circular references -- there would be stack overflows

markwpearce · 2024-11-25T17:55:19Z

src/types/ComponentType.ts

-        return this.callFuncMemberTable.getSymbolType(name, options);
+        const callFuncType = this.callFuncMemberTable.getSymbolType(name, options);
+
+        const addAssociatedTypesTableAsSiblingToMemberTable = (type: BscType) => {


if you find a callFunc for this a given name, adds a sibling table of the types required for that callFunc to the type.
This makes it so the required types for the callfunc are available in a different context

markwpearce added 11 commits November 18, 2024 15:46

Fixed completion and hovers on callFUn invocations

cc42bfd

Callfunc return types are used for assignments

0871ad7

Callfunc and @invocations return types are honored, as long as they a…

ac8299d

…re built in types

Adds Callfunc invocation validation

03c9a82

removed .onlys

eed31a7

Adds component.createChild() typing

332332a

fixed some comments

74ab909

Removed validation errors on generic roSgNode

a320d93

Perform validation on dependent types when ComponentType changes

d9b2255

added one final test for for revalidation when callfunc type changes

c68cdbe

Re-validates references to a component when the callfunc signature ch…

0ff8001

…anges

markwpearce marked this pull request as ready for review November 25, 2024 17:16

markwpearce added this to the v1.0.0 milestone Nov 25, 2024

markwpearce commented Nov 25, 2024

View reviewed changes

Change some comments:

940af94

markwpearce commented Nov 25, 2024

View reviewed changes

removed commented out code

4f5b5a7

markwpearce commented Nov 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds Callfunc Completion and Validation #1352

Adds Callfunc Completion and Validation #1352

markwpearce commented Nov 21, 2024 •

edited

Loading

markwpearce Nov 25, 2024 •

edited

Loading

markwpearce Nov 25, 2024

markwpearce Nov 25, 2024

markwpearce Nov 25, 2024

markwpearce Nov 25, 2024

markwpearce Nov 25, 2024

markwpearce Nov 25, 2024

markwpearce Nov 25, 2024

markwpearce Nov 25, 2024 •

edited

Loading

markwpearce Nov 25, 2024

markwpearce Nov 25, 2024

markwpearce Nov 25, 2024


		private cachedCircularReferenceCheck: null \| boolean = null;

		private hasCircularReferenceWithAncestor() {

Adds Callfunc Completion and Validation #1352

Are you sure you want to change the base?

Adds Callfunc Completion and Validation #1352

Conversation

markwpearce commented Nov 21, 2024 • edited Loading

markwpearce Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markwpearce Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markwpearce commented Nov 21, 2024 •

edited

Loading

markwpearce Nov 25, 2024 •

edited

Loading

markwpearce Nov 25, 2024 •

edited

Loading