Improve class hierarchy output

more readable output, adds info whether class is abstract
removes the plain text unit test which is replaced by a
JBMC regression test in a later commit

Author: peterschrammel

jbmc/unit/java_bytecode/goto-programs/class_hierarchy_output.cpp

@@ -17,21 +17,15 @@
 void require_parent_child_relationship(
   const std::string &parent_raw,
   const std::string &child_raw,
-  const std::string &output,
   const std::string &output_dot)
 {
   std::string parent = "java::" + parent_raw;
   std::string child = "java::" + child_raw;
 
-  std::stringstream
-    plain_child_expectation, plain_parent_expectation, dot_expectation;
+  std::stringstream dot_expectation;
 
-  plain_child_expectation << "Child of " << parent << ": " << child;
-  plain_parent_expectation << "Parent of " << child << ": " << parent;
   dot_expectation << "\"" << child << "\" -> \"" << parent << "\"";
 
-  REQUIRE(output.find(plain_child_expectation.str()) != std::string::npos);
-  REQUIRE(output.find(plain_parent_expectation.str()) != std::string::npos);
   REQUIRE(output_dot.find(dot_expectation.str()) != std::string::npos);
 }
 
@@ -47,20 +41,18 @@ SCENARIO(
   std::stringstream output_dot_stream;
 
   hierarchy(symbol_table);
-  hierarchy.output(output_stream);
   hierarchy.output_dot(output_dot_stream);
 
-  std::string output = output_stream.str();
   std::string output_dot = output_dot_stream.str();
 
   require_parent_child_relationship(
-    "HierarchyTest", "HierarchyTestChild1", output, output_dot);
+    "HierarchyTest", "HierarchyTestChild1", output_dot);
   require_parent_child_relationship(
-    "HierarchyTest", "HierarchyTestChild2", output, output_dot);
+    "HierarchyTest", "HierarchyTestChild2", output_dot);
   require_parent_child_relationship(
-    "HierarchyTestChild1", "HierarchyTestGrandchild", output, output_dot);
+    "HierarchyTestChild1", "HierarchyTestGrandchild", output_dot);
   require_parent_child_relationship(
-    "HierarchyTestInterface1", "HierarchyTestGrandchild", output, output_dot);
+    "HierarchyTestInterface1", "HierarchyTestGrandchild", output_dot);
   require_parent_child_relationship(
-    "HierarchyTestInterface2", "HierarchyTestGrandchild", output, output_dot);
+    "HierarchyTestInterface2", "HierarchyTestGrandchild", output_dot);
 }

src/goto-instrument/goto_instrument_parse_options.cpp

@@ -659,7 +659,7 @@ int goto_instrument_parse_optionst::doit()
       if(cmdline.isset("dot"))
         hierarchy.output_dot(std::cout);
       else
-        hierarchy.output(std::cout);
+        hierarchy.output(std::cout, false);
 
       return 0;
     }

src/goto-programs/class_hierarchy.cpp

@@ -30,6 +30,9 @@ void class_hierarchyt::operator()(const symbol_tablet &symbol_table)
     {
       const struct_typet &struct_type = to_struct_type(symbol_pair.second.type);
 
+      class_map[symbol_pair.first].is_abstract =
+        struct_type.get_bool(ID_abstract);
+
       const irept::subt &bases=
         struct_type.find(ID_bases).get_sub();
 
@@ -123,17 +126,23 @@ void class_hierarchyt::get_parents_trans_rec(
     get_parents_trans_rec(child, dest);
 }
 
-void class_hierarchyt::output(std::ostream &out) const
+/// Output the class hierarchy in plain text
+/// \param out: the output stream
+/// \param children_only: print the children only and do not print the parents
+void class_hierarchyt::output(std::ostream &out, bool children_only) const
 {
   for(const auto &c : class_map)
   {
-    for(const auto &pa : c.second.parents)
-      out << "Parent of " << c.first << ": "
-          << pa << '\n';
-
+    out << c.first << (c.second.is_abstract ? " (abstract)" : "") << ":\n";
+    if(!children_only)
+    {
+      out << "  parents:\n";
+      for(const auto &pa : c.second.parents)
+        out << "    " << pa << '\n';
+    }
+    out << "  children:\n";
     for(const auto &ch : c.second.children)
-      out << "Child of " << c.first << ": "
-          << ch << '\n';
+      out << "    " << ch << '\n';
   }
 }
 

src/goto-programs/class_hierarchy.h

@@ -32,6 +32,7 @@ class class_hierarchyt
   {
   public:
     idst parents, children;
+    bool is_abstract;
   };
 
   typedef std::map<irep_idt, entryt> class_mapt;
@@ -55,7 +56,7 @@ class class_hierarchyt
     return result;
   }
 
-  void output(std::ostream &) const;
+  void output(std::ostream &, bool children_only) const;
   void output_dot(std::ostream &) const;
 
 protected: