Wrote an irep to JSON converter

Use this converter in the show_goto_functions_json to provide more
information.

Author: thk123

src/goto-programs/show_goto_functions_json.cpp

@@ -10,6 +10,7 @@ Author: Thomas Kiley
 #include <sstream>
 
 #include <util/json_expr.h>
+#include <util/json_irep.h>
 #include <util/cprover_prefix.h>
 #include <util/prefix.h>
 
@@ -54,6 +55,7 @@ json_objectt show_goto_functions_jsont::get_goto_functions(
   const goto_functionst &goto_functions)
 {
   json_arrayt json_functions;
+  const json_irept no_comments_irep_converter(false);
   for(const auto &function_entry : goto_functions.function_map)
   {
     const irep_idt &function_name=function_entry.first;
@@ -93,6 +95,16 @@ json_objectt show_goto_functions_jsont::get_goto_functions(
         instruction_entry["instruction"]=
           json_stringt(instruction_builder.str());
 
+        json_arrayt operand_array;
+        for(const exprt &operand : instruction.code.operands())
+        {
+          json_objectt operand_object;
+          no_comments_irep_converter.convert_from_irep(operand, operand_object);
+          operand_array.push_back(operand_object);
+        }
+
+        instruction_entry["operands"]=operand_array;
+
         json_instruction_array.push_back(instruction_entry);
       }
 

src/util/Makefile

@@ -21,7 +21,7 @@ SRC = arith_tools.cpp base_type.cpp cmdline.cpp config.cpp symbol_table.cpp \
       bv_arithmetic.cpp tempdir.cpp tempfile.cpp timer.cpp unicode.cpp \
       irep_ids.cpp byte_operators.cpp string2int.cpp file_util.cpp \
       memory_info.cpp pipe_stream.cpp irep_hash.cpp endianness_map.cpp \
-      ssa_expr.cpp json_expr.cpp \
+      ssa_expr.cpp json_irep.cpp json_expr.cpp \
       string_utils.cpp
 
 INCLUDES= -I ..

src/util/json_irep.cpp

@@ -0,0 +1,133 @@
+/*******************************************************************\
+
+Module: Util
+
+Author: Thomas Kiley, [email protected]
+
+\*******************************************************************/
+
+#include "irep.h"
+#include "json.h"
+#include "json_irep.h"
+
+/*******************************************************************\
+
+Function: json_irept::json_irept
+
+  Inputs:
+   include_comments - when generating the JSON, should the comments
+                      sub tree be included.
+
+ Outputs:
+
+ Purpose: To convert to JSON from an irep structure by recurssively
+          generating JSON for the different sub trees.
+
+\*******************************************************************/
+
+json_irept::json_irept(bool include_comments):
+  include_comments(include_comments)
+{}
+
+/*******************************************************************\
+
+Function: json_irept::convert_from_irep
+
+  Inputs:
+   irep - The irep structure to turn into json
+   json - The json object to be filled up.
+
+ Outputs:
+
+ Purpose: To convert to JSON from an irep structure by recurssively
+          generating JSON for the different sub trees.
+
+\*******************************************************************/
+
+void json_irept::convert_from_irep(const irept &irep, jsont &json) const
+{
+  json_objectt &irep_object=json.make_object();
+  if(irep.id()!=ID_nil)
+    irep_object["id"]=json_stringt(irep.id_string());
+
+  convert_sub_tree("sub", irep.get_sub(), irep_object);
+  convert_named_sub_tree("named_sub", irep.get_named_sub(), irep_object);
+  if(include_comments)
+  {
+    convert_named_sub_tree("comment", irep.get_comments(), irep_object);
+  }
+}
+
+/*******************************************************************\
+
+Function: json_irept::convert_sub_tree
+
+  Inputs:
+   sub_tree_id - the name to give the subtree in the parent object
+   sub_trees - the list of subtrees to parse
+   parent - the parent JSON object who should be added to
+
+ Outputs:
+
+ Purpose: To convert to JSON from a list of ireps that are in an
+          unlabelled subtree. The parent JSON object will get a key
+          called sub_tree_id and the value shall be an array of JSON
+          objects generated from each of the sub trees
+
+\*******************************************************************/
+
+void json_irept::convert_sub_tree(
+  const std::string &sub_tree_id,
+  const irept::subt &sub_trees,
+  json_objectt &parent) const
+{
+  if(sub_trees.size()>0)
+  {
+    json_arrayt sub_objects;
+    for(const irept &sub_tree : sub_trees)
+    {
+      json_objectt sub_object;
+      convert_from_irep(sub_tree, sub_object);
+      sub_objects.push_back(sub_object);
+    }
+    parent[sub_tree_id]=sub_objects;
+  }
+}
+
+/*******************************************************************\
+
+Function: json_irept::convert_named_sub_tree
+
+  Inputs:
+   sub_tree_id - the name to give the subtree in the parent object
+   sub_trees - the map of subtrees to parse
+   parent - the parent JSON object who should be added to
+
+ Outputs:
+
+ Purpose: To convert to JSON from a map of ireps that are in a
+          named subtree. The parent JSON object will get a key
+          called sub_tree_id and the value shall be a JSON object
+          whose keys shall be the name of the sub tree and the value
+          will be the object generated from the sub tree.
+
+\*******************************************************************/
+
+void json_irept::convert_named_sub_tree(
+  const std::string &sub_tree_id,
+  const irept::named_subt &sub_trees,
+  json_objectt &parent) const
+{
+  if(sub_trees.size()>0)
+  {
+    json_objectt sub_objects;
+    for(const auto &sub_tree : sub_trees)
+    {
+      json_objectt sub_object;
+      convert_from_irep(sub_tree.second, sub_object);
+      sub_objects[id2string(sub_tree.first)]=sub_object;
+    }
+    parent[sub_tree_id]=sub_objects;
+  }
+}
+

src/util/json_irep.h

@@ -0,0 +1,36 @@
+/*******************************************************************\
+
+Module: Util
+
+Author: Thomas Kiley, [email protected]
+
+\*******************************************************************/
+
+#ifndef CPROVER_UTIL_JSON_IREP_H
+#define CPROVER_UTIL_JSON_IREP_H
+
+#include <util/irep.h>
+class jsont;
+class json_objectt;
+
+class json_irept
+{
+public:
+  explicit json_irept(bool include_comments);
+  void convert_from_irep(const irept &irep, jsont &json) const;
+
+private:
+  void convert_sub_tree(
+    const std::string &sub_tree_id,
+    const irept::subt &sub_trees,
+    json_objectt &parent) const;
+
+  void convert_named_sub_tree(
+    const std::string &sub_tree_id,
+    const irept::named_subt &sub_trees,
+    json_objectt &parent) const;
+
+  bool include_comments;
+};
+
+#endif // CPROVER_UTIL_JSON_IREP_H