Support "Go To Definition" and "Go to References" for #includes. (#40)

Fixes #36

Author: harrisont

CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.6.0
+
+## New Features
+
+* ([#36](https://github.com/harrisont/fastbuild-vscode/issues/36)) Support "Go To Definition" and "Go to References" for `#include`s.
+
 # v0.5.11
 
 ## Changes

README.md

@@ -20,6 +20,7 @@ Contains a language server and Visual Studio Code client for the [FASTBuild](htt
 * Variables
 * `#import`s
 * `#define`s
+* `#include`s
 
 ![Demo - go to definition and references](https://user-images.githubusercontent.com/144260/229382457-e15236ef-a0d6-4815-9f5c-6763d346399f.gif)
 

package.json

@@ -2,7 +2,7 @@
 	"name": "fastbuild-support",
 	"displayName": "FASTBuild Support",
 	"description": "FASTBuild language support. Includes go-to definition, find references, variable evaluation, syntax errors, etc.",
-	"version": "0.5.11",
+	"version": "0.6.0",
 	"preview": true,
 	"publisher": "HarrisonT",
 	"author": {

server/src/evaluator.ts

@@ -139,17 +139,26 @@ export interface TargetReference {
     range: SourceRange;
 }
 
+export interface IncludeReference {
+    includeUri: UriStr;
+    range: SourceRange;
+}
+
 export class EvaluatedData {
     evaluatedVariables: EvaluatedVariable[] = [];
 
-    variableReferences: VariableReference[] = [];
-
     variableDefinitions: VariableDefinition[] = [];
 
-    targetReferences: TargetReference[] = [];
+    variableReferences: VariableReference[] = [];
 
     // Maps a target name to its definition
     targetDefinitions = new Map<string, TargetDefinition>();
+
+    targetReferences: TargetReference[] = [];
+
+    includeDefinitions = new Set<UriStr>();
+
+    includeReferences: IncludeReference[] = [];
 }
 
 type ScopeLocation = 'current' | 'parent';
@@ -1330,15 +1339,24 @@ function evaluateStatements(statements: Statement[], context: EvaluationContext)
             } else if (isParsedStatementInclude(statement)) {  // #include
                 const thisFbuildUriDir = vscodeUri.Utils.dirname(vscodeUri.URI.parse(context.thisFbuildUri));
                 const includeUri = vscodeUri.Utils.resolvePath(thisFbuildUriDir, statement.path.value);
-                if (!context.onceIncludeUrisAlreadyIncluded.includes(includeUri.toString())) {
+                const includeUriStr = includeUri.toString();
+                const includeRange = new SourceRange(context.thisFbuildUri, statement.path.range);
+
+                context.evaluatedData.includeDefinitions.add(includeUriStr);
+                const includeReference: IncludeReference = {
+                    includeUri: includeUriStr,
+                    range: includeRange,
+                };
+                context.evaluatedData.includeReferences.push(includeReference);
+
+                if (!context.onceIncludeUrisAlreadyIncluded.includes(includeUriStr)) {
                     const maybeIncludeParseData = context.parseDataProvider.getParseData(includeUri);
                     if (maybeIncludeParseData.hasError) {
                         const includeError = maybeIncludeParseData.getError();
                         let error: Error;
                         if (includeError instanceof ParseError) {
                             error = includeError;
                         } else {
-                            const includeRange = new SourceRange(context.thisFbuildUri, statement.path.range);
                             error = new EvaluationError(includeRange, `Unable to open include: ${includeError.message}`);
                         }
                         return error;
@@ -1364,7 +1382,7 @@ function evaluateStatements(statements: Statement[], context: EvaluationContext)
                         defines: context.defines,
                         userFunctions: context.userFunctions,
                         rootFbuildDirUri: context.rootFbuildDirUri,
-                        thisFbuildUri: includeUri.toString(),
+                        thisFbuildUri: includeUriStr,
                         fileSystem: context.fileSystem,
                         parseDataProvider: context.parseDataProvider,
                         onceIncludeUrisAlreadyIncluded: context.onceIncludeUrisAlreadyIncluded,

server/src/features/definitionProvider.ts

@@ -4,6 +4,7 @@ import {
 } from 'vscode-languageserver-protocol';
 
 import {
+    createRange,
     isPositionInRange,
 } from '../parser';
 
@@ -15,17 +16,34 @@ export class DefinitionProvider {
     getDefinition(params: DefinitionParams, evaluatedData: EvaluatedData): DefinitionLink[] | null {
         const uri = params.textDocument.uri;
         const position = params.position;
-        const variableReferences = evaluatedData.variableReferences;
 
-        for (let i = 0; i < variableReferences.length; i++) {
-            const variableReference = variableReferences[i];
-            if (uri == variableReference.range.uri
-                && isPositionInRange(position, variableReference.range))
+        // Check for a matching #include definition.
+        for (let i = 0; i < evaluatedData.includeReferences.length; i++) {
+            const reference = evaluatedData.includeReferences[i];
+            if (uri == reference.range.uri
+                && isPositionInRange(position, reference.range))
             {
-                const definition = variableReference.definition;
+                const includeRange = createRange(0, 0, 0, 0);
+                const definitionLink: DefinitionLink = {
+                    originSelectionRange: reference.range,
+                    targetUri: reference.includeUri,
+                    targetRange: includeRange,
+                    targetSelectionRange: includeRange,
+                };
+                return [definitionLink];
+            }
+        }
+
+        // Check for a matching variable definition.
+        for (let i = 0; i < evaluatedData.variableReferences.length; i++) {
+            const reference = evaluatedData.variableReferences[i];
+            if (uri == reference.range.uri
+                && isPositionInRange(position, reference.range))
+            {
+                const definition = reference.definition;
 
                 const definitionLink: DefinitionLink = {
-                    originSelectionRange: variableReference.range,
+                    originSelectionRange: reference.range,
                     targetUri: definition.range.uri,
                     targetRange: definition.range,
                     targetSelectionRange: definition.range,

server/src/features/referenceProvider.ts

@@ -21,6 +21,7 @@ export class ReferenceProvider {
         const position = params.position;
 
         const references = this.getTargetReferences(uri, position, evaluatedData);
+        references.push(...this.getIncludeReferences(uri, position, evaluatedData));
         references.push(...this.getVariableReferences(uri, position, evaluatedData));
         return references;
     }
@@ -53,6 +54,34 @@ export class ReferenceProvider {
         return [...locations.values()];
     }
 
+    getIncludeReferences(uri: string, position: Position, evaluatedData: EvaluatedData): Location[] {
+        const references = evaluatedData.includeReferences;
+
+        const referenceAtPosition = references.find(ref => (ref.range.uri == uri && isPositionInRange(position, ref.range)));
+        if (referenceAtPosition === undefined) {
+            return [];
+        }
+
+        // Search algorithm: for each references, check if the URI matches.
+        // This is not very optimized.
+
+        // Map JSON.stringify(Location) to Location in order to deduplicate referencs in a 'ForEach' loop.
+        const locations = new Map<string, Location>();
+
+        for (const reference of references)
+        {
+            if (reference.includeUri === referenceAtPosition.includeUri) {
+                const location: Location = {
+                    uri: reference.range.uri,
+                    range: reference.range
+                };
+                locations.set(JSON.stringify(location), location);
+            }
+        }
+
+        return [...locations.values()];
+    }
+
     getVariableReferences(uri: string, position: Position, evaluatedData: EvaluatedData): Location[] {
         const references = evaluatedData.variableReferences;
 
@@ -80,4 +109,4 @@ export class ReferenceProvider {
 
         return [...locations.values()];
     }
-}
+}

server/src/test/2-evaluator.test.ts

@@ -19,6 +19,7 @@ import {
     evaluate,
     EvaluatedData,
     EvaluatedVariable,
+    IncludeReference,
     SourceRange,
     Struct,
     StructMember,
@@ -4571,7 +4572,7 @@ Expecting to see the following:
                 ]
             ]), true /*enableDiagnostics*/);
 
-            assert.deepStrictEqual(result.evaluatedVariables, [
+            const expectedEvaluatedVariables: EvaluatedVariable[] = [
                 {
                     value: 1,
                     range: createFileRange('file:///helper.bff', 1, 24, 1, 35),
@@ -4580,7 +4581,8 @@ Expecting to see the following:
                     value: 1,
                     range: createFileRange('file:///fbuild.bff', 2, 31, 2, 42),
                 }
-            ]);
+            ];
+            assert.deepStrictEqual(result.evaluatedVariables, expectedEvaluatedVariables);
 
             const definitionFromHelper: VariableDefinition = {
                 id: 1,
@@ -4592,7 +4594,7 @@ Expecting to see the following:
                 definitionFromHelper,  // FromHelper
             ]);
 
-            assert.deepStrictEqual(result.variableReferences, [
+            const expectedVariableReferences: VariableReference[] = [
                 // helper.bff ".FromHelper = 1" LHS
                 {
                     definition: definitionFromHelper,
@@ -4603,7 +4605,20 @@ Expecting to see the following:
                     definition: definitionFromHelper,
                     range: createFileRange('file:///fbuild.bff', 2, 31, 2, 42),
                 },
-            ]);
+            ];
+            assert.deepStrictEqual(result.variableReferences, expectedVariableReferences);
+
+            assert.deepStrictEqual(result.includeDefinitions, new Set<UriStr>([
+                'file:///helper.bff',
+            ]));
+
+            const expectedIncludeReferences: IncludeReference[] = [
+                {
+                    includeUri: 'file:///helper.bff',
+                    range: createFileRange('file:///fbuild.bff', 1, 33, 1, 45),
+                },
+            ];
+            assert.deepStrictEqual(result.includeReferences, expectedIncludeReferences);
         });
 
         it('include the same file multiple times in a row', () => {
@@ -4624,7 +4639,7 @@ Expecting to see the following:
                 ],
             ]), true /*enableDiagnostics*/);
 
-            assert.deepStrictEqual(result.evaluatedVariables, [
+            const expectedEvaluatedVariables: EvaluatedVariable[] = [
                 {
                     value: 'Bobo',
                     range: createFileRange('file:///some/path/fbuild.bff', 1, 24, 1, 29),
@@ -4637,7 +4652,24 @@ Expecting to see the following:
                     value: 'Bobo',
                     range: createFileRange('file:///some/path/greetings.bff', 1, 38, 1, 44),
                 },
-            ]);
+            ];
+            assert.deepStrictEqual(result.evaluatedVariables, expectedEvaluatedVariables);
+
+            assert.deepStrictEqual(result.includeDefinitions, new Set<UriStr>([
+                'file:///some/path/greetings.bff',
+            ]));
+
+            const expectedIncludeReferences: IncludeReference[] = [
+                {
+                    includeUri: 'file:///some/path/greetings.bff',
+                    range: createFileRange('file:///some/path/fbuild.bff', 2, 33, 2, 48),
+                },
+                {
+                    includeUri: 'file:///some/path/greetings.bff',
+                    range: createFileRange('file:///some/path/fbuild.bff', 3, 33, 3, 48),
+                },
+            ];
+            assert.deepStrictEqual(result.includeReferences, expectedIncludeReferences);
         });
 
         it('include with ".."', () => {
@@ -4673,7 +4705,7 @@ Expecting to see the following:
                 ]
             ]), true /*enableDiagnostics*/);
 
-            assert.deepStrictEqual(result.evaluatedVariables, [
+            const expectedEvaluatedVariables: EvaluatedVariable[] = [
                 {
                     value: 'dog',
                     range: createFileRange('file:///some/path/animals/dog.bff', 1, 24, 1, 29),
@@ -4706,7 +4738,34 @@ Expecting to see the following:
                     value: 'Hello cat',
                     range: createFileRange('file:///some/path/animals/cat.bff', 3, 31, 3, 39),
                 },
-            ]);
+            ];
+            assert.deepStrictEqual(result.evaluatedVariables, expectedEvaluatedVariables);
+
+            assert.deepStrictEqual(result.includeDefinitions, new Set<UriStr>([
+                'file:///some/path/animals/dog.bff',
+                'file:///some/path/greetings.bff',
+                'file:///some/path/animals/cat.bff',
+            ]));
+
+            const expectedIncludeReferences: IncludeReference[] = [
+                {
+                    includeUri: 'file:///some/path/animals/dog.bff',
+                    range: createFileRange('file:///some/path/fbuild.bff', 1, 33, 1, 50),
+                },
+                {
+                    includeUri: 'file:///some/path/greetings.bff',
+                    range: createFileRange('file:///some/path/animals/dog.bff', 2, 33, 2, 51),
+                },
+                {
+                    includeUri: 'file:///some/path/animals/cat.bff',
+                    range: createFileRange('file:///some/path/fbuild.bff', 2, 33, 2, 50),
+                },
+                {
+                    includeUri: 'file:///some/path/greetings.bff',
+                    range: createFileRange('file:///some/path/animals/cat.bff', 2, 33, 2, 51),
+                },
+            ];
+            assert.deepStrictEqual(result.includeReferences, expectedIncludeReferences);
         });
     });