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<_> = s.chars().rev().take(2).collect();
  41         last_two.reverse();
  42         if last_two.as_slice() != ['\\', 'l'] {
  43             s = s.append("\\l");
  44         }
  45         s.to_strbuf()
  46     } else {
  47         s
  48     }
  49 }
  50
  51 impl<'a> dot::Labeller<'a, Node<'a>, Edge<'a>> for LabelledCFG<'a> {
  52     fn graph_id(&'a self) -> dot::Id<'a> { dot::Id::new(self.name.as_slice()) }
  53
  54     fn node_id(&'a self, &(i,_): &Node<'a>) -> dot::Id<'a> {
  55         dot::Id::new(format!("N{:u}", i.node_id()))
  56     }
  57
  58     fn node_label(&'a self, &(i, n): &Node<'a>) -> dot::LabelText<'a> {
  59         if i == self.cfg.entry {
  60             dot::LabelStr("entry".into_maybe_owned())
  61         } else if i == self.cfg.exit {
  62             dot::LabelStr("exit".into_maybe_owned())
  63         } else if n.data.id == ast::DUMMY_NODE_ID {
  64             dot::LabelStr("(dummy_node)".into_maybe_owned())
  65         } else {
  66             let s = self.ast_map.node_to_str(n.data.id);
  67             // left-aligns the lines
  68             let s = replace_newline_with_backslash_l(s);
  69             dot::EscStr(s.into_maybe_owned())
  70         }
  71     }
  72
  73     fn edge_label(&self, e: &Edge<'a>) -> dot::LabelText<'a> {
  74         let mut label = StrBuf::new();
  75         let mut put_one = false;
  76         for (i, &node_id) in e.data.exiting_scopes.iter().enumerate() {
  77             if put_one {
  78                 label = label.append(",\\l");
  79             } else {
  80                 put_one = true;
  81             }
  82             let s = self.ast_map.node_to_str(node_id);
  83             // left-aligns the lines
  84             let s = replace_newline_with_backslash_l(s);
  85             label = label.append(format!("exiting scope_{} {}", i, s.as_slice()));
  86         }
  87         dot::EscStr(label.into_maybe_owned())
  88     }
  89 }
  90
  91 impl<'a> dot::GraphWalk<'a, Node<'a>, Edge<'a>> for &'a cfg::CFG {
  92     fn nodes(&self) -> dot::Nodes<'a, Node<'a>> {
  93         let mut v = Vec::new();
  94         self.graph.each_node(|i, nd| { v.push((i, nd)); true });
  95         dot::maybe_owned_vec::Growable(v)
  96     }
  97     fn edges(&self) -> dot::Edges<'a, Edge<'a>> {
  98         self.graph.all_edges().iter().collect()
  99     }
 100     fn source(&self, edge: &Edge<'a>) -> Node<'a> {
 101         let i = edge.source();
 102         (i, self.graph.node(i))
 103     }
 104     fn target(&self, edge: &Edge<'a>) -> Node<'a> {
 105         let i = edge.target();
 106         (i, self.graph.node(i))
 107     }
 108 }
 109
 110 impl<'a> dot::GraphWalk<'a, Node<'a>, Edge<'a>> for LabelledCFG<'a>
 111 {
 112     fn nodes(&self) -> dot::Nodes<'a, Node<'a>> { self.cfg.nodes() }
 113     fn edges(&self) -> dot::Edges<'a, Edge<'a>> { self.cfg.edges() }
 114     fn source(&self, edge: &Edge<'a>) -> Node<'a> { self.cfg.source(edge) }
 115     fn target(&self, edge: &Edge<'a>) -> Node<'a> { self.cfg.target(edge) }
 116 }