[analyzer] exploded-graph-rewriter: Implement a dark color scheme.

[NoQ]

Summary

$ utils/analyzer/exploded-graph-rewriter.py --help

usage: exploded-graph-rewriter.py [-h] [-v] [-d] [--dark] filename
  ...
  --dark         dark mode

[NoQ]

Unforget a test.

[Charusso]

I really like that, thanks you! When you spend tons of time it is good for your eyes and that dark theme is very cool in 2019.

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

368

Oh wait, it is bad for your eyes. I am using background #252526 (37, 37, 38), text #DCDCDC (155, 155, 155), which still a little bit confusing after a long period of time.

[NoQ]

Softer background color.

clang/test/Analysis/exploded-graph-rewriter/edge.dot

-// RUN: %exploded_graph_rewriter %s | FileCheck %s
+// RUN: %exploded_graph_rewriter %s | FileCheck %s -check-prefix=LIGHT
+// RUN: %exploded_graph_rewriter --dark %s | FileCheck %s -check-prefixes=DARK
 
 // FIXME: Substitution doesn't seem to work on Windows.
 // UNSUPPORTED: system-windows
 
 Node0x1 [shape=record,label=
  "{{ "node_id": 1, "pointer": "0x1",
      "program_state": null, "program_points": []}\l}"];
 
-// CHECK: Node0x1 -> Node0x2;
+// LIGHT: Node0x1 -> Node0x2;
+// DARK:  Node0x1 -> Node0x2 [color="white"];
 Node0x1 -> Node0x2;
 
 Node0x2 [shape=record,label=
  "{{ "node_id": 2, "pointer": "0x2",
      "program_state": null, "program_points": []}\l}"];

clang/test/Analysis/exploded-graph-rewriter/empty.dot

 // RUN: %exploded_graph_rewriter %s | FileCheck %s
+// RUN: %exploded_graph_rewriter --dark %s | FileCheck %s \
+// RUN:                                         -check-prefixes=CHECK,DARK
 
 // FIXME: Substitution doesn't seem to work on Windows.
 // UNSUPPORTED: system-windows
 
 digraph "Exploded Graph" {
   label="Exploded Graph";
 }
 
 // CHECK:      digraph "ExplodedGraph" {
+// DARK-NEXT:    bgcolor="black";
 // CHECK-NEXT:   label="";
 // CHECK-NEXT: }

clang/test/Analysis/exploded-graph-rewriter/environment.dot

 // RUN: %exploded_graph_rewriter %s | FileCheck %s
 
 // FIXME: Substitution doesn't seem to work on Windows.
 // UNSUPPORTED: system-windows
 
 // CHECK: <b>Environment: </b>
 // CHECK-SAME: <table border="0">
 // CHECK-SAME:   <tr>
 // CHECK-SAME:     <td align="left">
 // CHECK-SAME:       <b>#0 Call</b>
 // CHECK-SAME:     </td>
 // CHECK-SAME:     <td align="left" colspan="2">
-// CHECK-SAME:       <font color="grey60">foo </font>(line 4)
+// CHECK-SAME:       <font color="gray60">foo </font>(line 4)
 // CHECK-SAME:     </td>
 // CHECK-SAME:   </tr>
 // CHECK-SAME:   <tr>
 // CHECK-SAME:     <td align="left">
 // CHECK-SAME:       <i>S5</i>
 // CHECK-SAME:     </td>
 // CHECK-SAME:     <td align="left">
 // CHECK-SAME:       bar()

clang/test/Analysis/exploded-graph-rewriter/node_labels.dot

+// RUN: %exploded_graph_rewriter %s | FileCheck %s -check-prefixes=CHECK,LIGHT
+// RUN: %exploded_graph_rewriter %s --dark | FileCheck %s \
+// RUN:                                         -check-prefixes CHECK,DARK
+
+// FIXME: Substitution doesn't seem to work on Windows.
+// UNSUPPORTED: system-windows
+
+// LIGHT: Node0x1 [shape=record,label=<
+// DARK:  Node0x1 [shape=record,color="white",fontcolor="gray80",label=<
+// CHECK-SAME:   <tr>
+// LIGHT-SAME:     <td bgcolor="gray">
+// DARK-SAME:      <td bgcolor="gray20">
+// CHECK-SAME:       <b>Node 1 (0x1) - State Unspecified</b>
+// CHECK-SAME:     </td>
+// CHECK-SAME:   </tr>
+Node0x1 [shape=record,label=
+ "{
+    { "node_id": 1, "pointer": "0x1",
+      "program_state": null,
+      "program_points": []
+    }
+\l}"];

clang/test/Analysis/exploded-graph-rewriter/objects_under_construction.cpp

struct S {
   S() {}
 };
 
 void test() {
   // CHECK: Objects Under Construction:
   // CHECK-SAME: <tr>
   // CHECK-SAME:   <td align="left"><b>#0 Call</b></td>
   // CHECK-SAME:   <td align="left" colspan="2">
-  // CHECK-SAME:     <font color="grey60">test </font>
+  // CHECK-SAME:     <font color="gray60">test </font>
   // CHECK-SAME:   </td>
   // CHECK-SAME: </tr>
   // CHECK-SAME: <tr>
   // CHECK-SAME:   <td align="left"><i>S{{[0-9]*}}</i></td>
   // CHECK-SAME:   <td align="left"><font color="darkgreen"><i>
   // CHECK-SAME:     (materialize temporary)
   // CHECK-SAME:   </i></font></td>
   // CHECK-SAME:   <td align="left">S()</td>

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

def add_raw_line(self, raw_line):
             self.nodes[node_id].construct(node_id, json_node)
             return
         logging.debug('Skipping.')
 
 
 # A visitor that dumps the ExplodedGraph into a DOT file with fancy HTML-based
 # syntax highlighing.
 class DotDumpVisitor(object):
-    def __init__(self, do_diffs):
+    def __init__(self, do_diffs, dark_mode):
         super(DotDumpVisitor, self).__init__()
         self._do_diffs = do_diffs
+        self._dark_mode = dark_mode
 
     @staticmethod
     def _dump_raw(s):
         print(s, end='')
 
     @staticmethod
     def _dump(s):
         print(s.replace('&', '&')
def _diff_plus_minus(is_added):
             return ''
         if is_added:
             return '<font color="forestgreen">+</font>'
         return '<font color="red">-</font>'
 
     def visit_begin_graph(self, graph):
         self._graph = graph
         self._dump_raw('digraph "ExplodedGraph" {\n')
+        if self._dark_mode:
+            self._dump_raw('bgcolor="black";\n')
         self._dump_raw('label="";\n')
 
     def visit_program_point(self, p):
         if p.kind in ['Edge', 'BlockEntrance', 'BlockExit']:
             color = 'gold3'
         elif p.kind in ['PreStmtPurgeDeadSymbols',
                         'PostStmtPurgeDeadSymbols']:
             color = 'red'
         elif p.kind in ['CallEnter', 'CallExitBegin', 'CallExitEnd']:
-            color = 'blue'
+            color = 'dodgerblue' if self._dark_mode else 'blue'
         elif p.kind in ['Statement']:
             color = 'cyan4'
         else:
             color = 'forestgreen'
 
         if p.kind == 'Statement':
             # This avoids pretty-printing huge statements such as CompoundStmt.
             # Such statements show up only at [Pre|Post]StmtPurgeDeadSymbols
class DotDumpVisitor(object):
 
     def visit_environment(self, e, prev_e=None):
         self._dump('<table border="0">')
 
         def dump_location_context(lc, is_added=None):
             self._dump('<tr><td>%s</td>'
                        '<td align="left"><b>%s</b></td>'
                        '<td align="left" colspan="2">'
-                       '<font color="grey60">%s </font>'
+                       '<font color="gray60">%s </font>'
                        '%s</td></tr>'
                        % (self._diff_plus_minus(is_added),
                           lc.caption, lc.decl,
                           ('(line %s)' % lc.line) if lc.line is not None
                           else ''))
 
         def dump_binding(f, b, is_added=None):
             self._dump('<tr><td>%s</td>'
                        '<td align="left"><i>S%s</i></td>'
                        '%s'
                        '<td align="left">%s</td>'
                        '<td align="left">%s</td></tr>'
                        % (self._diff_plus_minus(is_added),
                           b.stmt_id,
-                          '<td align="left"><font color="darkgreen"><i>'
-                          '(%s)</i></font></td>' % b.kind
-                          if b.kind is not None else '',
+                          '<td align="left"><font color="%s"><i>'
+                          '%s</i></font></td>' % (
+                              'lavender' if self._dark_mode else 'darkgreen',
+                              ('(%s)' % b.kind) if b.kind is not None else ' '
+                          ),
                           b.pretty, f.bindings[b]))
 
         frames_updated = e.diff_frames(prev_e) if prev_e is not None else None
         if frames_updated:
             for i in frames_updated:
                 f = e.frames[i]
                 prev_f = prev_e.frames[i]
                 dump_location_context(f.location_context)
def visit_state(self, s, prev_s):
                                         s, prev_s)
         self.visit_generic_map_in_state('dynamic_types', 'Dynamic Types',
                                         s, prev_s)
         self.visit_environment_in_state('constructing_objects',
                                         'Objects Under Construction',
                                         s, prev_s)
 
     def visit_node(self, node):
-        self._dump('%s [shape=record,label=<<table border="0">'
+        self._dump('%s [shape=record,'
                    % (node.node_name()))
+        if self._dark_mode:
+            self._dump('color="white",fontcolor="gray80",')
+        self._dump('label=<<table border="0">')
 
-        self._dump('<tr><td bgcolor="grey"><b>Node %d (%s) - '
+        self._dump('<tr><td bgcolor="%s"><b>Node %d (%s) - '
                    'State %s</b></td></tr>'
-                   % (node.node_id, node.ptr, node.state.state_id
+                   % ("gray20" if self._dark_mode else "gray",
+                      node.node_id, node.ptr, node.state.state_id
                       if node.state is not None else 'Unspecified'))
         self._dump('<tr><td align="left" width="0">')
         if len(node.points) > 1:
             self._dump('<b>Program points:</b></td></tr>')
         else:
             self._dump('<b>Program point:</b></td></tr>')
         self._dump('<tr><td align="left" width="0">'
                    '<table border="0" align="left" width="0">')
         for p in node.points:
             self.visit_program_point(p)
         self._dump('</table></td></tr>')
 
         if node.state is not None:
             prev_s = None
             # Do diffs only when we have a unique predecessor.
             # Don't do diffs on the leaf nodes because they're
             # the important ones.
             if self._do_diffs and len(node.predecessors) == 1 \
                and len(node.successors) > 0:
                 prev_s = self._graph.nodes[node.predecessors[0]].state
             self.visit_state(node.state, prev_s)
         self._dump_raw('</table>>];\n')
 
     def visit_edge(self, pred, succ):
-        self._dump_raw('%s -> %s;\n' % (pred.node_name(), succ.node_name()))
+        self._dump_raw('%s -> %s%s;\n' % (
+            pred.node_name(), succ.node_name(),
+            ' [color="white"]' if self._dark_mode else ''
+        ))
 
     def visit_end_of_graph(self):
         self._dump_raw('}\n')
 
 
 # A class that encapsulates traversal of the ExplodedGraph. Different explorer
 # kinds could potentially traverse specific sub-graphs.
 class Explorer(object):
def main():
     parser.add_argument('filename', type=str)
     parser.add_argument('-v', '--verbose', action='store_const',
                         dest='loglevel', const=logging.DEBUG,
                         default=logging.WARNING,
                         help='enable info prints')
     parser.add_argument('-d', '--diff', action='store_const', dest='diff',
                         const=True, default=False,
                         help='display differences between states')
+    parser.add_argument('--dark', action='store_const', dest='dark',
+                        const=True, default=False,
+                        help='dark mode')
     args = parser.parse_args()
     logging.basicConfig(level=args.loglevel)
 
     graph = ExplodedGraph()
     with open(args.filename) as fd:
         for raw_line in fd:
             raw_line = raw_line.strip()
             graph.add_raw_line(raw_line)
 
     explorer = Explorer()
-    visitor = DotDumpVisitor(args.diff)
+    visitor = DotDumpVisitor(args.diff, args.dark)
     explorer.explore(graph, visitor)
 
 
 if __name__ == '__main__':
     main()