Adding verilator support (#32)

* Adding verilator support * updated the readme for verilator updated the package.json for verilator removed notices about errors in submodules. * Update README.md

Author: terriblefire

README.md

@@ -21,6 +21,7 @@ Verilog HDL support based on [https://github.com/textmate/verilog.tmbundle](http
  * `iverilog`
  * `xvlog`
  * `modelsim`
+ * `verilator`
  * `none`
  * Icarus Verilog (`iverilog`)
  - Make sure the path to your Icaurus Verilog installation is present in the `PATH` variable.
@@ -34,7 +35,10 @@ Verilog HDL support based on [https://github.com/textmate/verilog.tmbundle](http
  - The "work" library of Modelsim should be present in the workspace directory.
  * If not already present, create the work library in the workspace directory by running `vlib work`.
  - Use `verilog.linting.modelsim.arguments` setting to add custom arguments to the linter.
-
+ * Verilator (`verilator`)
+ - Make sure the path to "verilator" executable file is present in the `PATH` variable.
+ - Use `verilog.linting.verilator.arguments` setting to add custom arguments to the linter. The argument `--lint-only -I<document folder>` will be added by the linter automatically
+ - Use `verilog.linting.verilator.runAtFileLocation` setting to run Verilator at the file location. By default, it will be run at workspace directory, requiring that `` `include`` directives contain file paths relative to the workspace directory.
 ### In progress
 - Icarus Verilog integration
  * Working in:
@@ -53,6 +57,13 @@ Verilog HDL support based on [https://github.com/textmate/verilog.tmbundle](http
  - Windows: Yes
  - Linux: Not Tested
  - macOS: Not Tested
+- Verilator integration
+ * Working in:
+ - Windows: Not Tested
+ * There are no available windows binaries to test with.
+ - Linux: Yes
+ * Tested on Debian 9. Visual Studio Code 1.26.1
+ - macOS: Not Tested
 
 ### In the future
 - Please post issue if you have any new idea

package.json

@@ -63,11 +63,12 @@
 "enum": [
 "xvlog",
 "iverilog",
+"verilator",
 "modelsim",
 "none"
 ],
 "default": "none",
-"description": "Select the verilog linter. Possible values are 'iverilog', 'xvlog' or 'none'"
+"description": "Select the verilog linter. Possible values are 'iverilog', 'verilator', xvlog' or 'none'"
 },
 "verilog.linting.iverilog.arguments": {
 "scope": "window",
@@ -86,6 +87,18 @@
 "type": "string",
 "default": "",
 "description": "Add Modelsim arguments here. They will be added to Modelsim while linting."
+},
+"verilog.linting.verilator.arguments": {
+"scope": "window",
+"type": "string",
+"default": "",
+"description": "Add Verilator arguments here (like macros). They will be added to Verilator while linting (The command \"--lint-only -I<document folder>\" will be added by the linter by default)"
+},
+"verilog.linting.verilator.runAtFileLocation": {
+"scope": "window",
+"type": "boolean",
+"default": false,
+"description": "If enabled, Verilator will be ran at the file location for linting. Else it will be run at workspace folder. Disabled by default."
 }
 }
 }
@@ -97,11 +110,15 @@
 "update-vscode": "node ./node_modules/vscode/bin/install",
 "postinstall": "node ./node_modules/vscode/bin/install"
 },
-"dependencies": {},
+"dependencies": {
+"code-generator": "^1.0.7",
+"vsce": "^1.49.2",
+"yo": "^2.0.5"
+},
 "devDependencies": {
 "@types/mocha": "^2.2.45",
 "@types/node": "^7.0.51",
-"typescript": "^2.8.1",
+"typescript": "^2.9.2",
 "vscode": "^1.1.14"
 }
 }

src/extension.ts

@@ -5,6 +5,7 @@ import {workspace, window, commands, Disposable, Range, ExtensionContext,
  languages, extensions, Selection, Uri} from "vscode";
 import BaseLinter from "./linter/BaseLinter";
 import IcarusLinter from "./linter/IcarusLinter";
+import VerilatorLinter from "./linter/VerilatorLinter";
 import XvlogLinter from "./linter/XvlogLinter";
 import ModelsimLinter from "./linter/ModelsimLinter";
 
@@ -66,6 +67,9 @@ function configLinter() {
  case "modelsim":
  linter = new ModelsimLinter();
  break;
+ case "verilator":
+ linter = new VerilatorLinter();
+ break;
  default:
  console.log("Invalid linter name.")
  linter = null;

src/linter/VerilatorLinter.ts

@@ -0,0 +1,105 @@
+import {workspace, window, Disposable, Range, TextDocument, Diagnostic, DiagnosticSeverity, DiagnosticCollection, languages} from "vscode";
+import * as child from 'child_process';
+import BaseLinter from "./BaseLinter";
+import { join } from "path";
+
+var isWindows = process.platform === "win32";
+
+export default class VerilatorLinter extends BaseLinter {
+ private verilatorArgs: string;
+ private runAtFileLocation: boolean;
+
+ constructor() {
+ super("verilator");
+
+ workspace.onDidChangeConfiguration(() => {
+ this.getConfig();
+ })
+ this.getConfig();
+ }
+
+ private getConfig() {
+ this.verilatorArgs = <string>workspace.getConfiguration().get('verilog.linting.verilator.arguments', '');
+ this.runAtFileLocation = <boolean>workspace.getConfiguration().get('verilog.linting.verilator.runAtFileLocation')
+ }
+
+ protected splitTerms(line: string){
+ let terms = line.split(':');
+ 
+ for (var i = 0; i < terms.length; i++) {
+ if (terms[i] == ' ') { 
+ terms.splice(i, 1);
+ i--;
+ }
+ else 
+ {
+ terms[i] = terms[i].trim();
+ }
+ }
+
+ return terms;
+ }
+
+ protected getSeverity(severityString: string){
+ let result = DiagnosticSeverity.Information;
+
+ if (severityString.startsWith('Error'))
+ {
+ result = DiagnosticSeverity.Error;
+ }
+ else if (severityString.startsWith('Warning'))
+ {
+ result = DiagnosticSeverity.Warning;
+ }
+
+ return result;
+ }
+ 
+ protected lint(doc: TextDocument) {
+ let docUri: string = doc.uri.fsPath //path of current doc
+ let lastIndex:number = (isWindows == true)? docUri.lastIndexOf("\\") : docUri.lastIndexOf("/");
+ let docFolder = docUri.substr(0, lastIndex); //folder of current doc
+ let runLocation: string = (this.runAtFileLocation == true)? docFolder : workspace.rootPath; //choose correct location to run
+ let command: string = 'verilator --lint-only -I'+docFolder+ ' ' + this.verilatorArgs + ' \"' + doc.fileName +'\"'; //command to execute
+ var foo: child.ChildProcess = child.exec(command,{cwd:runLocation},(error:Error, stdout:string, stderr:string) => {
+ let diagnostics: Diagnostic[] = [];
+ let lines = stderr.split(/\r?\n/g);
+ 
+ // Parse output lines
+ lines.forEach((line, i) => {
+ 
+ if(line.startsWith('%')){
+ // remove the %
+ line = line.substr(1)
+
+ // was it for a submodule
+ if (line.search(doc.fileName) > 0)
+ {
+ // remove the filename 
+ line = line.replace(doc.fileName, '');
+ line = line.replace(/\s+/g,' ').trim();
+ 
+ let terms = this.splitTerms(line);
+ let severity = this.getSeverity(terms[0]);
+ let message = terms.slice(2).join(' ')
+ let lineNum = parseInt(terms[1].trim()) - 1;
+
+ if (lineNum != NaN)
+ { 
+ console.log(terms[1].trim() + ' ' + message);
+
+ diagnostics.push({
+ severity: severity,
+ range:new Range(lineNum, 0, lineNum, Number.MAX_VALUE),
+ message: message,
+ code: 'verilator',
+ source: 'verilator'
+ }); 
+ }
+ }
+ }
+ })
+ this.diagnostic_collection.set(doc.uri, diagnostics)
+ })
+ }
+}