[circt-verilog-lsp] Add support for package import indexing (#9023)

This commit adds support for looking up the definition of package imports

Author: Scheremo

lib/Tools/circt-verilog-lsp-server/VerilogServerImpl/VerilogServer.cpp

@@ -26,6 +26,7 @@
 #include "slang/diagnostics/DiagnosticClient.h"
 #include "slang/diagnostics/Diagnostics.h"
 #include "slang/driver/Driver.h"
+#include "slang/syntax/AllSyntax.h"
 #include "slang/syntax/SyntaxTree.h"
 #include "slang/text/SourceLocation.h"
 #include "slang/text/SourceManager.h"
@@ -557,6 +558,33 @@ struct VerilogIndexer : slang::ast::ASTVisitor<VerilogIndexer, true, true> {
     visitDefault(expr);
   }
 
+  void visit(const slang::ast::ExplicitImportSymbol &expr) {
+    auto *def = expr.package();
+    if (!def)
+      return;
+
+    if (auto *syn = expr.getSyntax()) {
+      if (auto *item = syn->as_if<slang::syntax::PackageImportItemSyntax>()) {
+        insertSymbol(def, item->package.location(), /*isDefinition=*/false);
+      }
+    }
+    visitDefault(expr);
+  }
+
+  void visit(const slang::ast::WildcardImportSymbol &expr) {
+    auto *def = expr.getPackage();
+    if (!def)
+      return;
+
+    if (auto *syn = expr.getSyntax()) {
+      if (auto *item = syn->as_if<slang::syntax::PackageImportItemSyntax>()) {
+        insertSymbol(def, item->package.location(), false);
+      }
+    }
+
+    visitDefault(expr);
+  }
+
   void visit(const slang::ast::VariableDeclStatement &expr) {
     insertSymbol(&expr.symbol, expr.sourceRange, /*isDefinition=*/true);
     visitDefault(expr);

test/Tools/circt-verilog-lsp-server/find-package-import-def.test

@@ -0,0 +1,64 @@
+// RUN: cd %S && circt-verilog-lsp-server -lit-test  < %s | FileCheck %s
+// REQUIRES: slang
+{"jsonrpc":"2.0","id":0,"method":"initialize","params":{"processId":123,"rootPath":"verilog","capabilities":{},"trace":"off"}}
+// -----
+{"jsonrpc":"2.0","method":"textDocument/didOpen","params":{"textDocument":{
+  "uri":"test:///foo.sv",
+  "languageId":"verilog",
+  "version":1,
+  "text":"package apack;\ntypedef logic test_t;\n endpackage\nmodule test \nimport apack::*;\nimport apack::test_t;\n(output out\n);ifdef#()i_dut(.out(out));\nendmodule"
+}}}
+// -----
+// Find definition of `apack`
+{"jsonrpc":"2.0","id":1,"method":"textDocument/definition","params":{
+  "textDocument":{"uri":"test:///foo.sv"},
+  "position":{"line":4,"character":10}
+}}
+// -----
+// CHECK:  "id": 1,
+// CHECK-NEXT:  "jsonrpc": "2.0",
+// CHECK-NEXT:  "result": [
+// CHECK-NEXT:    {
+// CHECK-NEXT:      "range": {
+// CHECK-NEXT:        "end": {
+// CHECK-NEXT:          "character": 13,
+// CHECK-NEXT:          "line": 0
+// CHECK-NEXT:        },
+// CHECK-NEXT:        "start": {
+// CHECK-NEXT:          "character": 8,
+// CHECK-NEXT:          "line": 0
+// CHECK-NEXT:        }
+// CHECK-NEXT:      },
+// CHECK-NEXT:      "uri": "test:///foo.sv"
+// CHECK-NEXT:    }
+// CHECK-NEXT:  ]
+// CHECK-NEXT:}
+// Find definition of `apack`
+{"jsonrpc":"2.0","id":2,"method":"textDocument/definition","params":{
+  "textDocument":{"uri":"test:///foo.sv"},
+  "position":{"line":5,"character":10}
+}}
+// -----
+// CHECK:  "id": 2,
+// CHECK-NEXT:  "jsonrpc": "2.0",
+// CHECK-NEXT:  "result": [
+// CHECK-NEXT:    {
+// CHECK-NEXT:      "range": {
+// CHECK-NEXT:        "end": {
+// CHECK-NEXT:          "character": 13,
+// CHECK-NEXT:          "line": 0
+// CHECK-NEXT:        },
+// CHECK-NEXT:        "start": {
+// CHECK-NEXT:          "character": 8,
+// CHECK-NEXT:          "line": 0
+// CHECK-NEXT:        }
+// CHECK-NEXT:      },
+// CHECK-NEXT:      "uri": "test:///foo.sv"
+// CHECK-NEXT:    }
+// CHECK-NEXT:  ]
+// CHECK-NEXT:}
+// -----
+// -----
+{"jsonrpc":"2.0","id":3,"method":"shutdown"}
+// -----
+{"jsonrpc":"2.0","method":"exit"}