[slang-tidy] Fix XilinxDoNotCareValues checker (#1225)

Co-authored-by: Yan Churkin <[email protected]>
MikePopoloski · Jan 28, 2025 · 2e39ffe · 2e39ffe
1 parent f8042bf
commit 2e39ffe
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/tools/tidy/src/synthesis/XilinxDoNotCareValues.cpp b/tools/tidy/src/synthesis/XilinxDoNotCareValues.cpp
@@ -7,18 +7,21 @@
 #include "fmt/color.h"
 
 #include "slang/syntax/AllSyntax.h"
+#include "slang/syntax/SyntaxPrinter.h"
 
 using namespace slang;
 using namespace slang::ast;
+using namespace slang::syntax;
 
 namespace xilinx_do_not_care_values {
 struct MainVisitor : public TidyVisitor, ASTVisitor<MainVisitor, true, true> {
     explicit MainVisitor(Diagnostics& diagnostics) : TidyVisitor(diagnostics) {}
 
     void handle(const IntegerLiteral& expr) {
         if (auto syntax = expr.syntax; syntax) {
-            bool hasDoNotCare = syntax->toString().find('?') != std::string::npos;
-            bool hasDecimal = syntax->toString().find('d') != std::string::npos;
+            auto strSyntax = SyntaxPrinter().setIncludeTrivia(false).print(*syntax).str();
+            bool hasDoNotCare = strSyntax.find('?') != std::string::npos;
+            bool hasDecimal = strSyntax.find('d') != std::string::npos;
 
             if (hasDoNotCare && hasDecimal)
                 diags.add(diag::XilinxDoNotCareValues, syntax->sourceRange());

diff --git a/tools/tidy/tests/XilinxDoNotCareValuesTest.cpp b/tools/tidy/tests/XilinxDoNotCareValuesTest.cpp
@@ -63,3 +63,24 @@ endmodule
     bool result = visitor->check(root);
     CHECK(result);
 }
+
+TEST_CASE("XilinxDoNotCareValues: No do-not-care values but with comment") {
+    auto tree = SyntaxTree::fromText(R"(
+module top;
+    logic [3:0] a =
+       /*'d?*/4'd10;
+endmodule
+)");
+
+    Compilation compilation;
+    compilation.addSyntaxTree(tree);
+    compilation.getAllDiagnostics();
+    auto& root = compilation.getRoot();
+
+    TidyConfig config;
+    Registry::setConfig(config);
+    Registry::setSourceManager(compilation.getSourceManager());
+    auto visitor = Registry::create("XilinxDoNotCareValues");
+    bool result = visitor->check(root);
+    CHECK(result);
+}