Merge pull request diffblue#233 from diffblue/feature/added_listing_of_function_without_bodies_to_HTML_program_dump

Listing of functions without bodies to HTML program dump.

Author: marek-trtik

src/summaries/summary_dump.cpp

@@ -431,15 +431,16 @@ std::string  dump_symbol_table_symbols_in_html(
 
   dump_html_prefix(ostr, "Symbol table symbols");
   ostr << "<h2>Symbols table</h2>\n";
-  ostr << "<table>\n"
-           "  <tr>\n"
-           "    <th>Symbol name</th>\n"
-           "    <th>Properties</th>\n"
-           "  </tr>\n";
   std::map<std::string, irep_idt> sorted_keys;
   for(const auto &name_props : symbol_table.symbols)
     sorted_keys.insert({to_html_text(as_string(name_props.first)),
                         name_props.first});
+  ostr << "<table>\n"
+    "  <caption>There are " << sorted_keys.size() << " symbols.</caption>\n"
+    "  <tr>\n"
+    "    <th>Symbol name</th>\n"
+    "    <th>Properties</th>\n"
+    "  </tr>\n";
   for(const auto &name_key : sorted_keys)
   {
     const symbolt &symbol=symbol_table.symbols.at(name_key.second);
@@ -684,25 +685,29 @@ std::string dump_symbol_table_as_html_table(
   if(!error.empty())
     return error;
 
-  ostr << "<table>\n"
-          "  <tr>\n"
-          "    <th>Property</th>\n"
-          "    <th>Value</th>\n"
-          "  </tr>\n"
-          "  <tr>\n"
-          "    <td>Detailed information about all symbols in the table</td>\n"
-          "    <td><a href=\"./symbol_table_symbols.html\">here</a></td>\n"
-          "  </tr>\n"
-          "  <tr>\n"
-          "    <td>Content of multimap 'symbol_tablet::symbol_base_map'</td>\n"
-          "    <td><a href=\"./symbol_table_base.html\">here</a></td>\n"
-          "  </tr>\n"
-          "  <tr>\n"
-          "    <td>Content of multimap 'symbol_tablet::symbol_module_map'"
-          "</td>\n"
-          "    <td><a href=\"./symbol_table_module.html\">here</a></td>\n"
-          "  </tr>\n"
-          "</table>\n";
+  ostr
+    << "<table>\n"
+    << "  <caption>There are "
+    << symbol_table.symbols.size()
+    << " symbols.</caption>\n"
+    << "  <tr>\n"
+    << "    <th>Property</th>\n"
+    << "    <th>Value</th>\n"
+    << "  </tr>\n"
+    << "  <tr>\n"
+    << "    <td>Detailed information about all symbols in the table</td>\n"
+    << "    <td><a href=\"./symbol_table_symbols.html\">here</a></td>\n"
+    << "  </tr>\n"
+    << "  <tr>\n"
+    << "    <td>Content of multimap 'symbol_tablet::symbol_base_map'</td>\n"
+    << "    <td><a href=\"./symbol_table_base.html\">here</a></td>\n"
+    << "  </tr>\n"
+    << "  <tr>\n"
+    << "    <td>Content of multimap 'symbol_tablet::symbol_module_map'"
+    << "</td>\n"
+    << "    <td><a href=\"./symbol_table_module.html\">here</a></td>\n"
+    << "  </tr>\n"
+    << "</table>\n";
 
   return error;
 }
@@ -769,16 +774,21 @@ std::string  dump_goto_program_in_html(
   ostr << "<h1>Properties of the analysed GOTO program</h1>\n";
 
   ostr << "<h3>Listing of functions with bodies (definitions).</h3>\n";
-  ostr << "<table>\n"
-          "  <tr>\n"
-          "    <th>Function name</th>\n"
-          "    <th>Code</th>\n"
-          "  </tr>\n"
-          ;
-  std::set<std::string>  ordered;
+  std::set<std::string>  ordered, ordered_declarations;
   for(auto  it = functions.cbegin(); it != functions.cend(); it++)
+  {
     if(it->second.body_available())
       ordered.insert(as_string(it->first));
+    else
+      ordered_declarations.insert(as_string(it->first));
+  }
+  ostr
+    << "<table>\n"
+    << "  <caption>There are " << ordered.size() << " functions.</caption>\n"
+    << "  <tr>\n"
+    << "    <th>Function name</th>\n"
+    << "    <th>Code</th>\n"
+    << "  </tr>\n";
   for (auto const& fn_name : ordered)
       ostr << "  <tr>\n"
               "    <td>" << to_html_text(fn_name) << "</td>\n"
@@ -788,6 +798,25 @@ std::string  dump_goto_program_in_html(
               ;
   ostr << "</table>\n";
 
+  if(!ordered_declarations.empty())
+  {
+    ostr
+      << "<h3>Listing of functions without bodies (undefined references)</h3>\n"
+      << "<table>\n"
+      << "  <caption>There are "
+      << ordered_declarations.size()
+      << " functions.";
+    for(const auto &fn_name : ordered_declarations)
+    {
+      ostr
+        << "  <tr>\n"
+        << "    <td>" << to_html_text(fn_name) << "</td>\n"
+        << "  </tr>\n";
+    }
+    ostr << "</table>\n";
+  }
+
+
   ostr << "<h3>Symbol table</h3>\n";
 
   std::string error=
@@ -895,23 +924,51 @@ std::string  dump_goto_functions_in_html(
                             "Cannot open the log file '" << log_filename
                          << "'.";
   dump_html_prefix(ostr, "Functions");
-  ostr << "<h3>Listing of functions</h3>\n";
-  ostr << "<table>\n"
-          "  <tr>\n"
-          "    <th>Function name</th>\n"
-          "    <th>Code</th>\n"
-          "  </tr>\n";
-  std::set<std::string> ordered;
+  ostr << "<h3>Listing of functions with bodies (definitions)</h3>\n";
+  std::set<std::string> ordered, ordered_declarations;
   for(auto it=functions.cbegin(); it!=functions.cend(); ++it)
+  {
     if(it->second.body_available())
       ordered.insert(as_string(it->first));
+    else
+      ordered_declarations.insert(as_string(it->first));
+  }
+  ostr
+    << "<table>\n"
+    << "  <caption>There are "
+    << ordered.size()
+    << " functions."
+    <<"</caption>\n"
+    << "  <tr>\n"
+    << "    <th>Function name</th>\n"
+    << "    <th>Code</th>\n"
+    << "  </tr>\n";
   for(const auto &fn_name : ordered)
       ostr << "  <tr>\n"
               "    <td>" << to_html_text(fn_name) << "</td>\n"
               "    <td><a href=\"./" << to_file_name(fn_name)
                                      << "/index.html\">here</a></td>\n"
               "  </tr>\n";
   ostr << "</table>\n";
+
+  if(!ordered_declarations.empty())
+  {
+    ostr
+      << "<h3>Listing of functions without bodies (undefined references)</h3>\n"
+      << "<table>\n"
+      << "  <caption>There are "
+      << ordered_declarations.size()
+      << " functions.";
+    for(const auto &fn_name : ordered_declarations)
+    {
+      ostr
+        << "  <tr>\n"
+        << "    <td>" << to_html_text(fn_name) << "</td>\n"
+        << "  </tr>\n";
+    }
+    ostr << "</table>\n";
+  }
+
   dump_html_suffix(ostr);
   return ""; // no error.
 }