[analyzer] exploded-graph-rewriter: Fix escaping and unescaping of StringRegions.

[NoQ]

Summary

Additionally, add a forgotten escape for Store values.

[Charusso]

Thanks!

clang/lib/StaticAnalyzer/Core/RegionStore.cpp

222

Could you inject /*AddQuotes=*/?

clang/test/Analysis/exploded-graph-rewriter/escapes.c

4

I like that styling.

clang/utils/analyzer/exploded-graph-rewriter.py

287

I think this is the correct approach.

[NoQ]

Oh, right, thanks!

clang/lib/StaticAnalyzer/Core/RegionStore.cpp

public:
   /// Return the internal tree as a Store.
   Store asStore() const {
     return asImmutableMap().getRootWithoutRetain();
   }
 
   void printJson(raw_ostream &Out, const char *NL = "\n",
                  unsigned int Space = 0, bool IsDot = false) const {
     for (iterator I = begin(); I != end(); ++I) {
+      // TODO: We might need a .printJson for I.getKey() as well.
       Indent(Out, Space, IsDot)
           << "{ \"cluster\": \"" << I.getKey() << "\", \"pointer\": \""
           << (const void *)I.getKey() << "\", \"items\": [" << NL;
 
       ++Space;
       const ClusterBindings &CB = I.getData();
       for (ClusterBindings::iterator CI = CB.begin(); CI != CB.end(); ++CI) {
-        Indent(Out, Space, IsDot) << "{ " << CI.getKey() << ", \"value\": \""
-                                  << CI.getData() << "\" }";
+        Indent(Out, Space, IsDot) << "{ " << CI.getKey() << ", \"value\": ";
+        CI.getData().printJson(Out, /*AddQuotes=*/true);
+        Out << " }";
         if (std::next(CI) != CB.end())
           Out << ',';
         Out << NL;
       }
 
       --Space;
       Indent(Out, Space, IsDot) << "]}";
       if (std::next(I) != end())

clang/test/Analysis/exploded-graph-rewriter/escapes.c

+// FIXME: Figure out how to use %clang_analyze_cc1 with our lit.local.cfg.
+// RUN: %clang_cc1 -analyze -analyzer-checker=core \
+// RUN:                     -analyzer-dump-egraph=%t.dot %s
+// RUN: %exploded_graph_rewriter %t.dot | FileCheck %s
+
+// FIXME: Substitution doesn't seem to work on Windows.
+// UNSUPPORTED: system-windows
+
+void string_region_escapes() {
+  // CHECK: const char *const foo = "foo";
+  // CHECK-SAME: Store:
+  // CHECK-SAME: <td align="left">foo</td><td align="left">0</td>
+  // CHECK-SAME: <td align="left">&amp;Element\{"foo",0 S64b,char\}</td>
+  // CHECK-SAME: Environment:
+  // CHECK-SAME: <td align="left">"foo"</td>
+  // CHECK-SAME: <td align="left">&amp;Element\{"foo",0 S64b,char\}</td>
+  const char *const foo = "foo";
+}

clang/test/Analysis/exploded-graph-rewriter/lit.local.cfg

 config.substitutions.append(('%exploded_graph_rewriter',
                              '\'%s\' %s' % (
                                  config.python_executable,
                                  lit.util.which('exploded-graph-rewriter.py',
                                                 os.path.join(
                                                     config.clang_src_dir,
                                                     'utils', 'analyzer')))))
 
-config.suffixes = ['.dot']
+config.suffixes.add('.dot')

clang/utils/analyzer/exploded-graph-rewriter.py

def add_raw_line(self, raw_line):
                 self.root_id = node_id
             # Note: when writing tests you don't need to escape everything,
             # even though in a valid dot file everything is escaped.
             node_label = result.group(2).replace('\\l', '') \
                                         .replace(' ', '') \
                                         .replace('\\"', '"') \
                                         .replace('\\{', '{') \
                                         .replace('\\}', '}') \
+                                        .replace('\\\\', '\\') \
                                         .replace('\\<', '\\\\<') \
                                         .replace('\\>', '\\\\>') \
                                         .rstrip(',')
             logging.debug(node_label)
             json_node = json.loads(node_label)
             self.nodes[node_id].construct(node_id, json_node)
             return
         logging.debug('Skipping.')