src/librustc/middle/cfg/graphviz.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 /// This module provides linkage between rustc::middle::graph and
  12 /// libgraphviz traits.
  13
  14 /// For clarity, rename the graphviz crate locally to dot.
  15 use dot = graphviz;
  16
  17 use syntax::ast;
  18 use syntax::ast_map;
  19
  20 use middle::cfg;
  21
  22 pub type Node<'a> = (cfg::CFGIndex, &'a cfg::CFGNode);
  23 pub type Edge<'a> = &'a cfg::CFGEdge;
  24
  25 pub struct LabelledCFG<'a>{
  26     pub ast_map: &'a ast_map::Map,
  27     pub cfg: &'a cfg::CFG,
  28     pub name: StrBuf,
  29 }
  30
  31 fn replace_newline_with_backslash_l(s: StrBuf) -> StrBuf {
  32     // Replacing newlines with \\l causes each line to be left-aligned,
  33     // improving presentation of (long) pretty-printed expressions.
  34     if s.as_slice().contains("\n") {
  35         let mut s = s.replace("\n", "\\l");
  36         // Apparently left-alignment applies to the line that precedes
  37         // \l, not the line that follows; so, add \l at end of string
  38         // if not already present, ensuring last line gets left-aligned
  39         // as well.
  40         let mut last_two: Vec<_> =
  41             s.as_slice().chars().rev().take(2).collect();
  42         last_two.reverse();
  43         if last_two.as_slice() != ['\\', 'l'] {
  44             s = s.append("\\l");
  45         }
  46         s.to_strbuf()
  47     } else {
  48         s
  49     }
  50 }
  51
  52 impl<'a> dot::Labeller<'a, Node<'a>, Edge<'a>> for LabelledCFG<'a> {
  53     fn graph_id(&'a self) -> dot::Id<'a> { dot::Id::new(self.name.as_slice()) }
  54
  55     fn node_id(&'a self, &(i,_): &Node<'a>) -> dot::Id<'a> {
  56         dot::Id::new(format!("N{:u}", i.node_id()))
  57     }
  58
  59     fn node_label(&'a self, &(i, n): &Node<'a>) -> dot::LabelText<'a> {
  60         if i == self.cfg.entry {
  61             dot::LabelStr("entry".into_maybe_owned())
  62         } else if i == self.cfg.exit {
  63             dot::LabelStr("exit".into_maybe_owned())
  64         } else if n.data.id == ast::DUMMY_NODE_ID {
  65             dot::LabelStr("(dummy_node)".into_maybe_owned())
  66         } else {
  67             let s = self.ast_map.node_to_str(n.data.id);
  68             // left-aligns the lines
  69             let s = replace_newline_with_backslash_l(s);
  70             dot::EscStr(s.into_maybe_owned())
  71         }
  72     }
  73
  74     fn edge_label(&self, e: &Edge<'a>) -> dot::LabelText<'a> {
  75         let mut label = StrBuf::new();
  76         let mut put_one = false;
  77         for (i, &node_id) in e.data.exiting_scopes.iter().enumerate() {
  78             if put_one {
  79                 label = label.append(",\\l");
  80             } else {
  81                 put_one = true;
  82             }
  83             let s = self.ast_map.node_to_str(node_id);
  84             // left-aligns the lines
  85             let s = replace_newline_with_backslash_l(s);
  86             label = label.append(format!("exiting scope_{} {}",
  87                                          i,
  88                                          s.as_slice()).as_slice());
  89         }
  90         dot::EscStr(label.into_maybe_owned())
  91     }
  92 }
  93
  94 impl<'a> dot::GraphWalk<'a, Node<'a>, Edge<'a>> for &'a cfg::CFG {
  95     fn nodes(&self) -> dot::Nodes<'a, Node<'a>> {
  96         let mut v = Vec::new();
  97         self.graph.each_node(|i, nd| { v.push((i, nd)); true });
  98         dot::maybe_owned_vec::Growable(v)
  99     }
 100     fn edges(&self) -> dot::Edges<'a, Edge<'a>> {
 101         self.graph.all_edges().iter().collect()
 102     }
 103     fn source(&self, edge: &Edge<'a>) -> Node<'a> {
 104         let i = edge.source();
 105         (i, self.graph.node(i))
 106     }
 107     fn target(&self, edge: &Edge<'a>) -> Node<'a> {
 108         let i = edge.target();
 109         (i, self.graph.node(i))
 110     }
 111 }
 112
 113 impl<'a> dot::GraphWalk<'a, Node<'a>, Edge<'a>> for LabelledCFG<'a>
 114 {
 115     fn nodes(&self) -> dot::Nodes<'a, Node<'a>> { self.cfg.nodes() }
 116     fn edges(&self) -> dot::Edges<'a, Edge<'a>> { self.cfg.edges() }
 117     fn source(&self, edge: &Edge<'a>) -> Node<'a> { self.cfg.source(edge) }
 118     fn target(&self, edge: &Edge<'a>) -> Node<'a> { self.cfg.target(edge) }
 119 }