Make VpiListenerTracer.h be self-contained.

The header relied on forward declared classes, but since it actually accesses members (VpiLineNo() etc.), it needs a full declaration of these.
chipsalliance · Jun 15, 2022 · 28af447 · 28af447
1 parent 79ecd7a
commit 28af447
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/templates/VpiListenerTracer.h b/templates/VpiListenerTracer.h
@@ -29,6 +29,8 @@
 
 #include "VpiListener.h"
 
+#include "uhdm/uhdm.h"  // Needed to know how to access VPI line/column
+
 #include <ostream>
 #include <string>
 

diff --git a/tests/vpi_listener_test.cpp b/tests/vpi_listener_test.cpp
@@ -1,18 +1,23 @@
 // -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
-#include "uhdm/VpiListener.h"
-
 #include <iostream>
 #include <memory>
 #include <stack>
 
 #include "gmock/gmock.h"
 #include "gtest/gtest.h"
-#include "uhdm/uhdm.h"
+
+// uhdm
 #include "uhdm/VpiListener.h"
+#include "uhdm/VpiListenerTracer.h"
+
+// We include this last to make sure that the headers above don't accidentally
+// depend on any class defined here
+#include "uhdm/uhdm.h"
 
 using namespace UHDM;
 using testing::ElementsAre;
+using testing::HasSubstr;
 
 class MyVpiListener : public VpiListener {
  protected:
@@ -125,3 +130,13 @@ TEST(VpiListenerTest, ProgramModule) {
   };
   EXPECT_EQ(listener->collected(), expected);
 }
+
+TEST(UhdmListenerTracerTest, ProgramModule) {
+  Serializer serializer;
+  const std::vector<vpiHandle>& design = buildModuleProg(&serializer);
+
+  std::stringstream out;
+  std::unique_ptr<VpiListenerTracer> listener(new VpiListenerTracer(out));
+  listener->listenDesigns(design);
+  EXPECT_THAT(out.str(), HasSubstr("enterDesign: [0,0:0,0]"));
+}