Merge branch 'master' into release-0.13.11-prep

Author: joecrop

.github/workflows/codeql.yml

@@ -0,0 +1,92 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron: '41 8 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: javascript-typescript
+          build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    # If the analyze step fails for one of the languages you are analyzing with
+    # "We were unable to automatically build your code", modify the matrix above
+    # to set the build mode to "manual" for that language. Then modify this step
+    # to build your code.
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    - if: matrix.build-mode == 'manual'
+      shell: bash
+      run: |
+        echo 'If you are using a "manual" build mode for one or more of the' \
+          'languages you are analyzing, replace this with the commands to build' \
+          'your code, for example:'
+        echo '  make bootstrap'
+        echo '  make release'
+        exit 1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

CHANGELOG.md

@@ -10,6 +10,12 @@ More details can be found on the [Releases](https://github.com/eirikpre/VSCode-S
 - 💡 Back-end Language Server for Systemverilog
 - 💡 Complete syntax highlighting
 
+### [0.13.10]
+
+- Right-justified icons by `joecrop`
+- Added support for symbol resolution in vh, svh, vams, and veriloga files by `joecrop`
+- Added support for import statements within module headers when auto-instantiating modules by `Stavegu`
+
 ### [0.13.9]
 
 - Added basic syntax highlighting support for sdc/xdc files inspired by [https://github.com/mshr-h/vscode-verilog-hdl-support](vscode-verilog-hdl-support) by `joecrop`

configs/scd.json renamed to configs/sdc.json

@@ -0,0 +1,11 @@
+{
+	"comments": {
+		"lineComment": "--",
+		"blockComment": []
+	},
+	"brackets": [
+		["{", "}"],
+		["[", "]"],
+		["(", ")"]
+	]
+}

configs/vhdl.configuration.json

@@ -157,6 +157,19 @@
                 }
             },
             {
+				"id": "vhdl",
+				"aliases": [
+					"VHDL",
+					"vhdl"
+				],
+				"extensions": [
+					".vhd",
+					".vhdl",
+					".vho"
+				],
+				"configuration": "./configs/vhdl.configuration.json"
+			},
+			{
                 "id": "sdc",
                 "aliases": [
                     "Synopsys Design Constraints"
@@ -251,6 +264,11 @@
                 "path": "./syntaxes/verilog-filelist.json"
             },
             {
+				"language": "vhdl",
+				"scopeName": "source.vhdl",
+				"path": "./syntaxes/vhdl.tmLanguage.json"
+			},
+			{
                 "language": "sdc",
                 "scopeName": "source.sdc",
                 "path": "./syntaxes/sdc.json"

package.json

@@ -16,6 +16,7 @@ export class SystemVerilogParser {
             /(?:automatic\s+)?/,
             ')',
             /(?<name>\w+)/,
+            /(?<import>\s*import\s*\w+::[\w*]+;)?/,
             /(?<params>\s*#\s*\([\w\W]*?\))?/,
             /(?<ports>\s*\([\W\w]*?\))?/,
             /\s*;/,

src/parser.ts

@@ -108,7 +108,7 @@ function isModuleParameterized(symbol: string, container: string): boolean {
     // Remove new lines
     container = container.replace(/\r\n|\n|\r/g, ' ');
     // Surround '#(' with space
-    container = container.replace(/#\(/g, ' #( ');
+    container = container.replace(/#\s*\(/g, ' #( ');
     // Replace multiple white spaces with a single whitespace
     container = container.replace(/\t+/g, ' ');
     container = container.replace(/  +/g, ' ');
@@ -118,7 +118,13 @@ function isModuleParameterized(symbol: string, container: string): boolean {
         return false;
     }
 
-    if (keys[0] === symbol && keys[1] === '#(') {
+    // Get only indexes related to module header
+    const subkeys = keys.slice(
+        0,
+        keys.findIndex((element) => element.includes(';') && !element.includes('::'))
+    );
+
+    if (subkeys[0] === symbol && subkeys.find((element) => element === '#(')) {
         return true;
     }
 

src/providers/ModuleInstantiator.ts

@@ -206,7 +206,7 @@ suite('ModuleInstantiator Tests', () => {
 
         let fullRange = null;
         // Range of the module in the document
-        fullRange = new vscode.Range(new vscode.Position(300, 6), new vscode.Position(324, 0));
+        fullRange = new vscode.Range(new vscode.Position(301, 6), new vscode.Position(324, 0));
 
         let container = document.getText(fullRange).replace(/^\s+|\s+$/g, '');
 
@@ -239,6 +239,46 @@ suite('ModuleInstantiator Tests', () => {
 
         compareInstantiation('azzer', container, instance);
     });
+
+    test('test #10: formatInstance without parameters and with import', async () => {
+        let uri = vscode.Uri.file(path.join(__dirname, testFolderLocation, 'test-files', 'ModuleInstantiator.test.1.v')); // prettier-ignore
+        let document = await vscode.workspace.openTextDocument(uri);
+
+        // Range of the module in the document
+        let fullRange = null;
+        fullRange = new vscode.Range(new vscode.Position(358, 6), new vscode.Position(392, 0));
+
+        const container = document.getText(fullRange).replace(/^\s+|\s+$/g, '');
+        uri = vscode.Uri.file(path.join(__dirname, testFolderLocation, 'test-files', 'ModuleInstantiator.test.2.v'));
+        document = await vscode.workspace.openTextDocument(uri);
+        fullRange = new vscode.Range(new vscode.Position(168, 0), new vscode.Position(179, 0));
+
+        let instance = document.getText(fullRange);
+
+        compareInstantiation('abber', container, instance);
+    });
+
+    test('test #11: formatInstance with parameters and specific import', async () => {
+        let uri = vscode.Uri.file(path.join(__dirname, testFolderLocation, 'test-files', 'ModuleInstantiator.test.1.v')); // prettier-ignore
+        let document = await vscode.workspace.openTextDocument(uri);
+
+        let fullRange = null;
+        // Range of the module in the document
+        fullRange = new vscode.Range(new vscode.Position(395, 6), new vscode.Position(431, 0));
+
+        let container = document.getText(fullRange).replace(/^\s+|\s+$/g, '');
+
+        console.log('Container \n\r' + container);
+
+        uri = vscode.Uri.file(path.join(__dirname, testFolderLocation, 'test-files', 'ModuleInstantiator.test.2.v'));
+        document = await vscode.workspace.openTextDocument(uri);
+
+        fullRange = new vscode.Range(new vscode.Position(184, 0), new vscode.Position(198, 0));
+
+        let instance = document.getText(fullRange);
+
+        compareInstantiation('affer', container, instance);
+    });
 });
 
 function compareInstantiation(instance_name, container_name, expected): void {

src/test/ModuleInstantiator.test.ts

@@ -17,7 +17,7 @@ let symbols: Map<string, Array<SystemVerilogSymbol>>;
 const testFolderLocation = '../../src/test';
 
 const uri = Uri.file(path.join(__dirname, testFolderLocation, 'test-files', 'ModuleInstantiator.test.1.v'));
-const documentSymbols = ['adder', 'bar', 'akker', 'accer', 'anner', 'atter', 'apper', 'golden'];
+const documentSymbols = ['adder', 'bar', 'akker', 'accer', 'anner', 'atter', 'apper', 'golden', 'abber', 'affer'];
 
 const nonSVUri = Uri.file(path.join(__dirname, testFolderLocation, 'test-files', 'foo.txt'));
 
@@ -31,10 +31,10 @@ suite('indexer_map Tests', () => {
         assert.strictEqual(symbols.size, 4);
         let count = await indexer.addDocumentSymbols(sVDocument, symbols);
 
-        assert.strictEqual(count, 10);
+        assert.strictEqual(count, 12);
         assert.strictEqual(symbols.size, 5);
-        assert.strictEqual(symbols.get(uri.fsPath).length, 10);
-        assert.strictEqual(getSymbolsCount(), 23);
+        assert.strictEqual(symbols.get(uri.fsPath).length, 12);
+        assert.strictEqual(getSymbolsCount(), 25);
 
         documentSymbols.forEach((symbolName) => {
             if (!symbolExists(symbolName)) {
@@ -47,28 +47,28 @@ suite('indexer_map Tests', () => {
         assert.strictEqual(count, 0);
         assert.strictEqual(symbols.size, 5);
         assert.strictEqual(symbols.get(nonSVUri.fsPath), undefined);
-        assert.strictEqual(getSymbolsCount(), 23);
+        assert.strictEqual(getSymbolsCount(), 25);
 
         // undefined/null document
         count = await indexer.addDocumentSymbols(undefined, symbols);
         assert.strictEqual(count, 0);
         assert.strictEqual(symbols.size, 5);
-        assert.strictEqual(getSymbolsCount(), 23);
+        assert.strictEqual(getSymbolsCount(), 25);
 
         count = await indexer.addDocumentSymbols(sVDocument, undefined);
         assert.strictEqual(count, 0);
         assert.strictEqual(symbols.size, 5);
-        assert.strictEqual(getSymbolsCount(), 23);
+        assert.strictEqual(getSymbolsCount(), 25);
 
         count = await indexer.addDocumentSymbols(undefined, undefined);
         assert.strictEqual(count, 0);
         assert.strictEqual(symbols.size, 5);
-        assert.strictEqual(getSymbolsCount(), 23);
+        assert.strictEqual(getSymbolsCount(), 25);
 
         count = await indexer.addDocumentSymbols(null, symbols);
         assert.strictEqual(count, 0);
         assert.strictEqual(symbols.size, 5);
-        assert.strictEqual(getSymbolsCount(), 23);
+        assert.strictEqual(getSymbolsCount(), 25);
     });
 
     test('test #2: removeDocumentSymbols', async () => {
@@ -80,9 +80,9 @@ suite('indexer_map Tests', () => {
         assert.strictEqual(symbols.size, 4);
         let count = await indexer.addDocumentSymbols(sVDocument, symbols);
 
-        assert.strictEqual(count, 10);
+        assert.strictEqual(count, 12);
         assert.strictEqual(symbols.size, 5);
-        assert.strictEqual(getSymbolsCount(), 23);
+        assert.strictEqual(getSymbolsCount(), 25);
 
         count = indexer.removeDocumentSymbols(sVDocument.uri.fsPath, symbols);
 
@@ -92,7 +92,7 @@ suite('indexer_map Tests', () => {
             }
         });
 
-        assert.strictEqual(count, -10);
+        assert.strictEqual(count, -12);
         assert.strictEqual(symbols.size, 4);
         assert.strictEqual(getSymbolsCount(), 13);
 

src/test/indexer_map.test.ts

@@ -351,3 +351,80 @@ module azzer #(parameter SIZE = (2*1)+1,
   assign c = tmp_c;
 
 endmodule
+
+// -------------------------------------------------------
+// -- Example without parameters and with import
+// -------------------------------------------------------
+
+module abber import pa_Package::*; (
+  input 	     clk,
+  input 	     reset,
+  input  [3:0] a,
+  // keep this single comment
+  input  [3:0] b,
+  /* multiline comment should
+  be kept*/
+  input        valid,
+  output [6:0] c
+  );
+
+  reg [6:0] tmp_c;
+
+  //Reset
+  always_ff @(posedge reset)
+    tmp_c <= pa_adder::RV_C;
+
+  `ifdef VERBOSE_RESET
+    always @(posedge reset) begin
+      wait(posedge reset);
+      $display("Reset asserted!")
+    end
+  `endif
+
+  // Waddition operation
+  always @(posedge clk)
+    if(valid) tmp_c <= a + b;
+
+  assign c = tmp_c;
+
+endmodule
+
+// -------------------------------------------------------
+// -- Example with parameters and specific import
+// -------------------------------------------------------
+
+module affer import pa_Package::PARAMETER1; #(
+  parameter     SIZE = PARAMETER1,
+  parameter     SIZE_TWO
+)(
+  input 	     clk,
+  input 	     reset,
+  input  [3:0] a,
+  // keep this single comment
+  input  [3:0] b,
+  /* multiline comment should
+  be kept*/
+  input        valid,
+  output [6:0] c
+  );
+
+  reg [6:0] tmp_c;
+
+  //Reset
+  always_ff @(posedge reset)
+    tmp_c <= pa_adder::RV_C;
+
+  `ifdef VERBOSE_RESET
+    always @(posedge reset) begin
+      wait(posedge reset);
+      $display("Reset asserted!")
+    end
+  `endif
+
+  // Waddition operation
+  always @(posedge clk)
+    if(valid) tmp_c <= a + b;
+
+  assign c = tmp_c;
+
+endmodule