Merge pull request #5375 from thk123/vsd/util

Util changes needed for VSD

Author: Thomas Kiley

src/util/journalling_symbol_table.h

@@ -140,6 +140,9 @@ class journalling_symbol_tablet : public symbol_table_baset
       base_symbol_table.end(), [this](const irep_idt &id) { on_update(id); });
   }
 
+  using symbol_table_baset::begin;
+  using symbol_table_baset::end;
+
   const changesett &get_inserted() const
   {
     return inserted;

src/util/symbol_table.h

@@ -120,17 +120,8 @@ class symbol_tablet : public symbol_table_baset
     return iteratort(internal_symbols.end());
   }
 
-  typedef symbolst::const_iterator const_iteratort;
-
-  virtual const_iteratort begin() const
-  {
-    return internal_symbols.begin();
-  }
-
-  virtual const_iteratort end() const
-  {
-    return internal_symbols.end();
-  }
+  using symbol_table_baset::begin;
+  using symbol_table_baset::end;
 
   /// Check that the symbol table is well-formed
   void validate(const validation_modet vm = validation_modet::INVARIANT) const;

src/util/symbol_table_base.cpp

@@ -60,6 +60,16 @@ void symbol_table_baset::show(std::ostream &out) const
     out << symbols.at(name);
 }
 
+symbol_table_baset::const_iteratort symbol_table_baset::end() const
+{
+  return symbols.end();
+}
+
+symbol_table_baset::const_iteratort symbol_table_baset::begin() const
+{
+  return symbols.begin();
+}
+
 /// Print the contents of the symbol table.
 /// \param out: The ostream to direct output to
 /// \param symbol_table: The symbol table to print out

src/util/symbol_table_base.h

@@ -234,6 +234,11 @@ class symbol_table_baset
 
   virtual iteratort begin() = 0;
   virtual iteratort end() = 0;
+
+  using const_iteratort = symbolst::const_iterator;
+
+  virtual const_iteratort begin() const;
+  virtual const_iteratort end() const;
 };
 
 std::ostream &

src/util/symbol_table_builder.h

@@ -85,6 +85,9 @@ class symbol_table_buildert : public symbol_table_baset
     return base_symbol_table.end();
   }
 
+  using symbol_table_baset::begin;
+  using symbol_table_baset::end;
+
   /// Try to find the next free identity for the passed-in prefix in
   /// this symbol table.
   /// \remark

unit/util/irep.cpp

@@ -22,7 +22,7 @@ SCENARIO("irept_memory", "[core][utils][irept]")
       const std::size_t ref_count_size = 0;
 #endif
 
-#ifndef USE_STRING
+#ifndef USE_STD_STRING
       const std::size_t data_size = sizeof(dstringt);
       REQUIRE(sizeof(dstringt) == sizeof(unsigned));
 #else

unit/util/symbol_table.cpp

@@ -17,14 +17,53 @@ TEST_CASE("Iterating through a symbol table", "[core][utils][symbol_tablet]")
 
   symbol_table.insert(symbol);
 
-  int counter = 0;
-  for(auto &entry : symbol_table)
+  SECTION("Non const iterator")
   {
-    (void)entry; // we are just testing iteration here
-    ++counter;
+    int counter = 0;
+    for(auto &entry : symbol_table)
+    {
+      (void)entry; // we are just testing iteration here
+      ++counter;
+    }
+    REQUIRE(counter == 1);
+  }
+  SECTION("Const iterator")
+  {
+    int counter = 0;
+    for(const auto &entry : symbol_table)
+    {
+      (void)entry; // we are just testing iteration here
+      ++counter;
+    }
+    REQUIRE(counter == 1);
+  }
+  SECTION("Polymorphic access")
+  {
+    SECTION("Non-const iterator")
+    {
+      symbol_table_baset &base_st = symbol_table;
+      REQUIRE(std::distance(base_st.begin(), base_st.end()) == 1);
+      int counter = 0;
+      for(auto &entry : base_st)
+      {
+        (void)entry; // we are just testing iteration here
+        ++counter;
+      }
+      REQUIRE(counter == 1);
+    }
+    SECTION("Const iterator")
+    {
+      const symbol_table_baset &base_st = symbol_table;
+      REQUIRE(std::distance(base_st.begin(), base_st.end()) == 1);
+      int counter = 0;
+      for(const auto &entry : base_st)
+      {
+        (void)entry; // we are just testing iteration here
+        ++counter;
+      }
+      REQUIRE(counter == 1);
+    }
   }
-
-  REQUIRE(counter == 1);
 }
 
 SCENARIO(