Find all references

CHANGELOG.md

@@ -11,9 +11,9 @@ Our development roadmap outlines the planned features for EBNF Tools. Features m
 - [x] **Commenting blocks of code**: Allows you to quickly comment out blocks of EBNF code.
 - [x] **Bracket matching**: Aids in matching brackets in your EBNF code.
 - [x] **Rename symbol**: Allows renaming of symbols throughout your EBNF code.
-- [x] **Go to Definition**: Quickly navigate to the definition of a symbol in your EBNF code.
+- [x] **Go to Definition / Peek Definition**: Quickly navigate to the definition of a symbol in your EBNF code.
 - [x] **Code folding (by markers)**: Hide sections of your EBNF code for easier reading and navigation.
-- [ ] **Find All References / Peek Definition**: Find every reference to a specific symbol in your EBNF code.
+- [x] **Find All References**: Find every reference to a specific symbol in your EBNF code.
 - [ ] **Formatting**: Automatically format your EBNF code to adhere to a specific style or standard.
 - [ ] **Commands (Compile to tmLanguage)**: A planned command for compiling EBNF code to tmLanguage.
 - [ ] **IntelliSense - List Members**: Get a list of members for a given symbol.
@@ -25,17 +25,22 @@ Our development roadmap outlines the planned features for EBNF Tools. Features m
 
 The change log lists the updates for each version that has been released on the official Visual Studio Code extension gallery.
 
+### Version 1.3
+**Pending Release**
+
+- _Find All References_
+
 ### Version 1.2
 **Released on 2023-06-22**
 
-- _Go to definition_ feature implemented.
-- _Code folding (by markers)_ feature implemented.
+- _Go to definition_
+- _Code folding (by markers)_
 - Added support for syntax highlighting in _Markdown fenced code blocks_. Big thanks to [Brendan Doney](https://github.com/brdoney) for providing *[codeblock.json](https://github.com/igochkov/vscode-ebnf/blob/main/syntaxes/codeblock.json)*
 
 ### Version 1.1
 **Released on 2023-06-17**
 
-- _Rename symbol_ feature implemented.
+- _Rename symbol_
 - Fixed broken links to images.
 
 ### Version 1.0

README.md

@@ -36,6 +36,10 @@ The EBNF Tools extension currently offers the following features:
 
 ![Code folding (by markers)](https://raw.githubusercontent.com/igochkov/vscode-ebnf/main/docs/folding.gif)
 
+- **Find All References**: Find every reference to a specific symbol in your EBNF code.
+
+![Find All References](https://raw.githubusercontent.com/igochkov/vscode-ebnf/main/docs/references.gif)
+
 ## Contributing
 
 We welcome contributions to the EBNF Tools project. If you want to contribute, please first read our [contribution guidelines](https://github.com/igochkov/vscode-ebnf/blob/main/CONTRIBUTING.md).

src/extension.ts

@@ -1,30 +1,38 @@
-import { DocumentFilter, languages, workspace, TextDocumentChangeEvent, Disposable, Event, TextDocument } from 'vscode'
-import { EBNFRenameProvider } from './providers/RenameProvider'
+import { DocumentFilter, languages, workspace, TextDocumentChangeEvent, ExtensionContext, TextDocument } from 'vscode';
+import { EBNFRenameProvider } from './providers/RenameProvider';
 import { EBNFDefinitionProvider } from './providers/DefinitionProvider';
+import { EBNFReferenceProvider } from './providers/EBNFReferenceProvider';
 
-const EbnfSelector: DocumentFilter = { language: 'ebnf', scheme: 'file' };
+export function activate(ctx: ExtensionContext): void
+{
+    const EbnfSelector: DocumentFilter = { language: 'ebnf', scheme: 'file' };
 
-languages.registerRenameProvider(EbnfSelector, new EBNFRenameProvider());
-languages.registerDefinitionProvider(EbnfSelector, new EBNFDefinitionProvider());
+    ctx.subscriptions.push(languages.registerRenameProvider(EbnfSelector, new EBNFRenameProvider()));
+    ctx.subscriptions.push(languages.registerDefinitionProvider(EbnfSelector, new EBNFDefinitionProvider()));
+    ctx.subscriptions.push(languages.registerReferenceProvider(EbnfSelector, new EBNFReferenceProvider()));
 
-workspace.onDidOpenTextDocument(OnDocumentOpen);
-workspace.onDidChangeTextDocument(OnDocumentChange);
-workspace.onDidCloseTextDocument(OnDocumentClose);
-
-function OnDocumentOpen(document: TextDocument) {
-    // TODO: Not implemented yet
-    // if the file is ebnf
-    // parse and cache AST 
+    // workspace.onDidOpenTextDocument(OnDocumentOpen);
+    // workspace.onDidChangeTextDocument(OnDocumentChange);
+    // workspace.onDidCloseTextDocument(OnDocumentClose);
 }
 
-function OnDocumentChange(event: TextDocumentChangeEvent) {
-    // TODO: Not implemented yet
-    // if changes and file is ebnf
-    // re-parse
-}
+// function OnDocumentOpen(document: TextDocument)
+// {
+//     // TODO: Not implemented yet
+//     // if the file is ebnf
+//     // parse and cache AST 
+// }
+
+// function OnDocumentChange(event: TextDocumentChangeEvent)
+// {
+//     // TODO: Not implemented yet
+//     // if changes and file is ebnf
+//     // re-parse
+// }
 
-function OnDocumentClose(document: TextDocument) {
-    // TODO: Not implemented yet
-    // if the file is ebnf
-    // remove from cache
-}
+// function OnDocumentClose(document: TextDocument)
+// {
+//     // TODO: Not implemented yet
+//     // if the file is ebnf
+//     // remove from cache
+// }

src/providers/EBNFReferenceProvider.ts

@@ -0,0 +1,44 @@
+import * as vscode from "vscode";
+import { CharStreams, CommonTokenStream } from 'antlr4ts';
+import { ParseTreeListener } from 'antlr4ts/tree/ParseTreeListener';
+
+import { EBNFLexer } from '../parser/EBNFLexer';
+import { EBNFParser } from '../parser/EBNFParser';
+import { ISymbolInfo } from '../ISymbolInfo';
+import { IdentifierListener } from '../listeners/IdentifierListener';
+
+export class EBNFReferenceProvider implements vscode.ReferenceProvider
+{
+    public provideReferences(document: vscode.TextDocument, position: vscode.Position, context: vscode.ReferenceContext, token: vscode.CancellationToken): vscode.ProviderResult<vscode.Location[]>
+    {
+        const range = document.getWordRangeAtPosition(position);
+        const text = document.getText(range);
+
+        if (!text)
+        {
+            return;
+        }
+
+        const content = document.getText();
+        const inputStream = CharStreams.fromString(content);
+        const lexer = new EBNFLexer(inputStream);
+        const tokenStream = new CommonTokenStream(lexer);
+        const parser = new EBNFParser(tokenStream);
+        const listener = new IdentifierListener();
+        parser.addParseListener(listener as ParseTreeListener);
+
+        parser.syntax();
+
+        var result: vscode.Location[]
+            = listener.symbols.filter(symbol => symbol.text == text)
+                .map(ref => new vscode.Location(document.uri,
+                    new vscode.Range(
+                        ref.line - 1,
+                        ref.charPositionInLine,
+                        ref.line - 1,
+                        ref.charPositionInLine + ref.text.length
+                    )));
+
+        return result;
+    }
+}