src/libgraphviz/lib.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 //! Generate files suitable for use with [Graphviz](http://www.graphviz.org/)
  12 //!
  13 //! The `render` function generates output (e.g. an `output.dot` file) for
  14 //! use with [Graphviz](http://www.graphviz.org/) by walking a labelled
  15 //! graph. (Graphviz can then automatically lay out the nodes and edges
  16 //! of the graph, and also optionally render the graph as an image or
  17 //! other [output formats](
  18 //! http://www.graphviz.org/content/output-formats), such as SVG.)
  19 //!
  20 //! Rather than impose some particular graph data structure on clients,
  21 //! this library exposes two traits that clients can implement on their
  22 //! own structs before handing them over to the rendering function.
  23 //!
  24 //! Note: This library does not yet provide access to the full
  25 //! expressiveness of the [DOT language](
  26 //! http://www.graphviz.org/doc/info/lang.html). For example, there are
  27 //! many [attributes](http://www.graphviz.org/content/attrs) related to
  28 //! providing layout hints (e.g. left-to-right versus top-down, which
  29 //! algorithm to use, etc). The current intention of this library is to
  30 //! emit a human-readable .dot file with very regular structure suitable
  31 //! for easy post-processing.
  32 //!
  33 //! # Examples
  34 //!
  35 //! The first example uses a very simple graph representation: a list of
  36 //! pairs of ints, representing the edges (the node set is implicit).
  37 //! Each node label is derived directly from the int representing the node,
  38 //! while the edge labels are all empty strings.
  39 //!
  40 //! This example also illustrates how to use `CowVec` to return
  41 //! an owned vector or a borrowed slice as appropriate: we construct the
  42 //! node vector from scratch, but borrow the edge list (rather than
  43 //! constructing a copy of all the edges from scratch).
  44 //!
  45 //! The output from this example renders five nodes, with the first four
  46 //! forming a diamond-shaped acyclic graph and then pointing to the fifth
  47 //! which is cyclic.
  48 //!
  49 //! ```rust
  50 //! use std::borrow::IntoCow;
  51 //! use graphviz as dot;
  52 //!
  53 //! type Nd = int;
  54 //! type Ed = (int,int);
  55 //! struct Edges(Vec<Ed>);
  56 //!
  57 //! pub fn render_to<W:Writer>(output: &mut W) {
  58 //!     let edges = Edges(vec!((0,1), (0,2), (1,3), (2,3), (3,4), (4,4)));
  59 //!     dot::render(&edges, output).unwrap()
  60 //! }
  61 //!
  62 //! impl<'a> dot::Labeller<'a, Nd, Ed> for Edges {
  63 //!     fn graph_id(&'a self) -> dot::Id<'a> { dot::Id::new("example1").unwrap() }
  64 //!
  65 //!     fn node_id(&'a self, n: &Nd) -> dot::Id<'a> {
  66 //!         dot::Id::new(format!("N{}", *n)).unwrap()
  67 //!     }
  68 //! }
  69 //!
  70 //! impl<'a> dot::GraphWalk<'a, Nd, Ed> for Edges {
  71 //!     fn nodes(&self) -> dot::Nodes<'a,Nd> {
  72 //!         // (assumes that |N| \approxeq |E|)
  73 //!         let &Edges(ref v) = self;
  74 //!         let mut nodes = Vec::with_capacity(v.len());
  75 //!         for &(s,t) in v.iter() {
  76 //!             nodes.push(s); nodes.push(t);
  77 //!         }
  78 //!         nodes.sort();
  79 //!         nodes.dedup();
  80 //!         nodes.into_cow()
  81 //!     }
  82 //!
  83 //!     fn edges(&'a self) -> dot::Edges<'a,Ed> {
  84 //!         let &Edges(ref edges) = self;
  85 //!         edges.as_slice().into_cow()
  86 //!     }
  87 //!
  88 //!     fn source(&self, e: &Ed) -> Nd { let &(s,_) = e; s }
  89 //!
  90 //!     fn target(&self, e: &Ed) -> Nd { let &(_,t) = e; t }
  91 //! }
  92 //!
  93 //! # pub fn main() { render_to(&mut Vec::new()) }
  94 //! ```
  95 //!
  96 //! ```no_run
  97 //! # pub fn render_to<W:Writer>(output: &mut W) { unimplemented!() }
  98 //! pub fn main() {
  99 //!     use std::old_io::File;
 100 //!     let mut f = File::create(&Path::new("example1.dot"));
 101 //!     render_to(&mut f)
 102 //! }
 103 //! ```
 104 //!
 105 //! Output from first example (in `example1.dot`):
 106 //!
 107 //! ```ignore
 108 //! digraph example1 {
 109 //!     N0[label="N0"];
 110 //!     N1[label="N1"];
 111 //!     N2[label="N2"];
 112 //!     N3[label="N3"];
 113 //!     N4[label="N4"];
 114 //!     N0 -> N1[label=""];
 115 //!     N0 -> N2[label=""];
 116 //!     N1 -> N3[label=""];
 117 //!     N2 -> N3[label=""];
 118 //!     N3 -> N4[label=""];
 119 //!     N4 -> N4[label=""];
 120 //! }
 121 //! ```
 122 //!
 123 //! The second example illustrates using `node_label` and `edge_label` to
 124 //! add labels to the nodes and edges in the rendered graph. The graph
 125 //! here carries both `nodes` (the label text to use for rendering a
 126 //! particular node), and `edges` (again a list of `(source,target)`
 127 //! indices).
 128 //!
 129 //! This example also illustrates how to use a type (in this case the edge
 130 //! type) that shares substructure with the graph: the edge type here is a
 131 //! direct reference to the `(source,target)` pair stored in the graph's
 132 //! internal vector (rather than passing around a copy of the pair
 133 //! itself). Note that this implies that `fn edges(&'a self)` must
 134 //! construct a fresh `Vec<&'a (uint,uint)>` from the `Vec<(uint,uint)>`
 135 //! edges stored in `self`.
 136 //!
 137 //! Since both the set of nodes and the set of edges are always
 138 //! constructed from scratch via iterators, we use the `collect()` method
 139 //! from the `Iterator` trait to collect the nodes and edges into freshly
 140 //! constructed growable `Vec` values (rather use the `into_cow`
 141 //! from the `IntoCow` trait as was used in the first example
 142 //! above).
 143 //!
 144 //! The output from this example renders four nodes that make up the
 145 //! Hasse-diagram for the subsets of the set `{x, y}`. Each edge is
 146 //! labelled with the &sube; character (specified using the HTML character
 147 //! entity `&sube`).
 148 //!
 149 //! ```rust
 150 //! use std::borrow::IntoCow;
 151 //! use graphviz as dot;
 152 //!
 153 //! type Nd = uint;
 154 //! type Ed<'a> = &'a (uint, uint);
 155 //! struct Graph { nodes: Vec<&'static str>, edges: Vec<(uint,uint)> }
 156 //!
 157 //! pub fn render_to<W:Writer>(output: &mut W) {
 158 //!     let nodes = vec!("{x,y}","{x}","{y}","{}");
 159 //!     let edges = vec!((0,1), (0,2), (1,3), (2,3));
 160 //!     let graph = Graph { nodes: nodes, edges: edges };
 161 //!
 162 //!     dot::render(&graph, output).unwrap()
 163 //! }
 164 //!
 165 //! impl<'a> dot::Labeller<'a, Nd, Ed<'a>> for Graph {
 166 //!     fn graph_id(&'a self) -> dot::Id<'a> { dot::Id::new("example2").unwrap() }
 167 //!     fn node_id(&'a self, n: &Nd) -> dot::Id<'a> {
 168 //!         dot::Id::new(format!("N{}", n)).unwrap()
 169 //!     }
 170 //!     fn node_label<'b>(&'b self, n: &Nd) -> dot::LabelText<'b> {
 171 //!         dot::LabelText::LabelStr(self.nodes[*n].as_slice().into_cow())
 172 //!     }
 173 //!     fn edge_label<'b>(&'b self, _: &Ed) -> dot::LabelText<'b> {
 174 //!         dot::LabelText::LabelStr("&sube;".into_cow())
 175 //!     }
 176 //! }
 177 //!
 178 //! impl<'a> dot::GraphWalk<'a, Nd, Ed<'a>> for Graph {
 179 //!     fn nodes(&self) -> dot::Nodes<'a,Nd> { (0..self.nodes.len()).collect() }
 180 //!     fn edges(&'a self) -> dot::Edges<'a,Ed<'a>> { self.edges.iter().collect() }
 181 //!     fn source(&self, e: &Ed) -> Nd { let & &(s,_) = e; s }
 182 //!     fn target(&self, e: &Ed) -> Nd { let & &(_,t) = e; t }
 183 //! }
 184 //!
 185 //! # pub fn main() { render_to(&mut Vec::new()) }
 186 //! ```
 187 //!
 188 //! ```no_run
 189 //! # pub fn render_to<W:Writer>(output: &mut W) { unimplemented!() }
 190 //! pub fn main() {
 191 //!     use std::old_io::File;
 192 //!     let mut f = File::create(&Path::new("example2.dot"));
 193 //!     render_to(&mut f)
 194 //! }
 195 //! ```
 196 //!
 197 //! The third example is similar to the second, except now each node and
 198 //! edge now carries a reference to the string label for each node as well
 199 //! as that node's index. (This is another illustration of how to share
 200 //! structure with the graph itself, and why one might want to do so.)
 201 //!
 202 //! The output from this example is the same as the second example: the
 203 //! Hasse-diagram for the subsets of the set `{x, y}`.
 204 //!
 205 //! ```rust
 206 //! use std::borrow::IntoCow;
 207 //! use graphviz as dot;
 208 //!
 209 //! type Nd<'a> = (uint, &'a str);
 210 //! type Ed<'a> = (Nd<'a>, Nd<'a>);
 211 //! struct Graph { nodes: Vec<&'static str>, edges: Vec<(uint,uint)> }
 212 //!
 213 //! pub fn render_to<W:Writer>(output: &mut W) {
 214 //!     let nodes = vec!("{x,y}","{x}","{y}","{}");
 215 //!     let edges = vec!((0,1), (0,2), (1,3), (2,3));
 216 //!     let graph = Graph { nodes: nodes, edges: edges };
 217 //!
 218 //!     dot::render(&graph, output).unwrap()
 219 //! }
 220 //!
 221 //! impl<'a> dot::Labeller<'a, Nd<'a>, Ed<'a>> for Graph {
 222 //!     fn graph_id(&'a self) -> dot::Id<'a> { dot::Id::new("example3").unwrap() }
 223 //!     fn node_id(&'a self, n: &Nd<'a>) -> dot::Id<'a> {
 224 //!         dot::Id::new(format!("N{}", n.0)).unwrap()
 225 //!     }
 226 //!     fn node_label<'b>(&'b self, n: &Nd<'b>) -> dot::LabelText<'b> {
 227 //!         let &(i, _) = n;
 228 //!         dot::LabelText::LabelStr(self.nodes[i].as_slice().into_cow())
 229 //!     }
 230 //!     fn edge_label<'b>(&'b self, _: &Ed<'b>) -> dot::LabelText<'b> {
 231 //!         dot::LabelText::LabelStr("&sube;".into_cow())
 232 //!     }
 233 //! }
 234 //!
 235 //! impl<'a> dot::GraphWalk<'a, Nd<'a>, Ed<'a>> for Graph {
 236 //!     fn nodes(&'a self) -> dot::Nodes<'a,Nd<'a>> {
 237 //!         self.nodes.iter().map(|s|s.as_slice()).enumerate().collect()
 238 //!     }
 239 //!     fn edges(&'a self) -> dot::Edges<'a,Ed<'a>> {
 240 //!         self.edges.iter()
 241 //!             .map(|&(i,j)|((i, self.nodes[i].as_slice()),
 242 //!                           (j, self.nodes[j].as_slice())))
 243 //!             .collect()
 244 //!     }
 245 //!     fn source(&self, e: &Ed<'a>) -> Nd<'a> { let &(s,_) = e; s }
 246 //!     fn target(&self, e: &Ed<'a>) -> Nd<'a> { let &(_,t) = e; t }
 247 //! }
 248 //!
 249 //! # pub fn main() { render_to(&mut Vec::new()) }
 250 //! ```
 251 //!
 252 //! ```no_run
 253 //! # pub fn render_to<W:Writer>(output: &mut W) { unimplemented!() }
 254 //! pub fn main() {
 255 //!     use std::old_io::File;
 256 //!     let mut f = File::create(&Path::new("example3.dot"));
 257 //!     render_to(&mut f)
 258 //! }
 259 //! ```
 260 //!
 261 //! # References
 262 //!
 263 //! * [Graphviz](http://www.graphviz.org/)
 264 //!
 265 //! * [DOT language](http://www.graphviz.org/doc/info/lang.html)
 266
 267 #![crate_name = "graphviz"]
 268 #![unstable(feature = "rustc_private")]
 269 #![feature(staged_api)]
 270 #![staged_api]
 271 #![crate_type = "rlib"]
 272 #![crate_type = "dylib"]
 273 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
 274        html_favicon_url = "http://www.rust-lang.org/favicon.ico",
 275        html_root_url = "http://doc.rust-lang.org/nightly/")]
 276 #![feature(int_uint)]
 277 #![feature(collections)]
 278 #![feature(old_io)]
 279
 280 use self::LabelText::*;
 281
 282 use std::borrow::{IntoCow, Cow};
 283 use std::old_io;
 284
 285 /// The text for a graphviz label on a node or edge.
 286 pub enum LabelText<'a> {
 287     /// This kind of label preserves the text directly as is.
 288     ///
 289     /// Occurrences of backslashes (`\`) are escaped, and thus appear
 290     /// as backslashes in the rendered label.
 291     LabelStr(Cow<'a, str>),
 292
 293     /// This kind of label uses the graphviz label escString type:
 294     /// http://www.graphviz.org/content/attrs#kescString
 295     ///
 296     /// Occurrences of backslashes (`\`) are not escaped; instead they
 297     /// are interpreted as initiating an escString escape sequence.
 298     ///
 299     /// Escape sequences of particular interest: in addition to `\n`
 300     /// to break a line (centering the line preceding the `\n`), there
 301     /// are also the escape sequences `\l` which left-justifies the
 302     /// preceding line and `\r` which right-justifies it.
 303     EscStr(Cow<'a, str>),
 304 }
 305
 306 // There is a tension in the design of the labelling API.
 307 //
 308 // For example, I considered making a `Labeller<T>` trait that
 309 // provides labels for `T`, and then making the graph type `G`
 310 // implement `Labeller<Node>` and `Labeller<Edge>`. However, this is
 311 // not possible without functional dependencies. (One could work
 312 // around that, but I did not explore that avenue heavily.)
 313 //
 314 // Another approach that I actually used for a while was to make a
 315 // `Label<Context>` trait that is implemented by the client-specific
 316 // Node and Edge types (as well as an implementation on Graph itself
 317 // for the overall name for the graph). The main disadvantage of this
 318 // second approach (compared to having the `G` type parameter
 319 // implement a Labelling service) that I have encountered is that it
 320 // makes it impossible to use types outside of the current crate
 321 // directly as Nodes/Edges; you need to wrap them in newtype'd
 322 // structs. See e.g. the `No` and `Ed` structs in the examples. (In
 323 // practice clients using a graph in some other crate would need to
 324 // provide some sort of adapter shim over the graph anyway to
 325 // interface with this library).
 326 //
 327 // Another approach would be to make a single `Labeller<N,E>` trait
 328 // that provides three methods (graph_label, node_label, edge_label),
 329 // and then make `G` implement `Labeller<N,E>`. At first this did not
 330 // appeal to me, since I had thought I would need separate methods on
 331 // each data variant for dot-internal identifiers versus user-visible
 332 // labels. However, the identifier/label distinction only arises for
 333 // nodes; graphs themselves only have identifiers, and edges only have
 334 // labels.
 335 //
 336 // So in the end I decided to use the third approach described above.
 337
 338 /// `Id` is a Graphviz `ID`.
 339 pub struct Id<'a> {
 340     name: Cow<'a, str>,
 341 }
 342
 343 impl<'a> Id<'a> {
 344     /// Creates an `Id` named `name`.
 345     ///
 346     /// The caller must ensure that the input conforms to an
 347     /// identifier format: it must be a non-empty string made up of
 348     /// alphanumeric or underscore characters, not beginning with a
 349     /// digit (i.e. the regular expression `[a-zA-Z_][a-zA-Z_0-9]*`).
 350     ///
 351     /// (Note: this format is a strict subset of the `ID` format
 352     /// defined by the DOT language.  This function may change in the
 353     /// future to accept a broader subset, or the entirety, of DOT's
 354     /// `ID` format.)
 355     ///
 356     /// Passing an invalid string (containing spaces, brackets,
 357     /// quotes, ...) will return an empty `Err` value.
 358     pub fn new<Name: IntoCow<'a, str>>(name: Name) -> Result<Id<'a>, ()> {
 359         let name = name.into_cow();
 360         {
 361             let mut chars = name.chars();
 362             match chars.next() {
 363                 Some(c) if is_letter_or_underscore(c) => { ; },
 364                 _ => return Err(())
 365             }
 366             if !chars.all(is_constituent) {
 367                 return Err(())
 368             }
 369         }
 370         return Ok(Id{ name: name });
 371
 372         fn is_letter_or_underscore(c: char) -> bool {
 373             in_range('a', c, 'z') || in_range('A', c, 'Z') || c == '_'
 374         }
 375         fn is_constituent(c: char) -> bool {
 376             is_letter_or_underscore(c) || in_range('0', c, '9')
 377         }
 378         fn in_range(low: char, c: char, high: char) -> bool {
 379             low as uint <= c as uint && c as uint <= high as uint
 380         }
 381     }
 382
 383     pub fn as_slice(&'a self) -> &'a str {
 384         &*self.name
 385     }
 386
 387     pub fn name(self) -> Cow<'a, str> {
 388         self.name
 389     }
 390 }
 391
 392 /// Each instance of a type that implements `Label<C>` maps to a
 393 /// unique identifier with respect to `C`, which is used to identify
 394 /// it in the generated .dot file. They can also provide more
 395 /// elaborate (and non-unique) label text that is used in the graphviz
 396 /// rendered output.
 397
 398 /// The graph instance is responsible for providing the DOT compatible
 399 /// identifiers for the nodes and (optionally) rendered labels for the nodes and
 400 /// edges, as well as an identifier for the graph itself.
 401 pub trait Labeller<'a,N,E> {
 402     /// Must return a DOT compatible identifier naming the graph.
 403     fn graph_id(&'a self) -> Id<'a>;
 404
 405     /// Maps `n` to a unique identifier with respect to `self`. The
 406     /// implementer is responsible for ensuring that the returned name
 407     /// is a valid DOT identifier.
 408     fn node_id(&'a self, n: &N) -> Id<'a>;
 409
 410     /// Maps `n` to a label that will be used in the rendered output.
 411     /// The label need not be unique, and may be the empty string; the
 412     /// default is just the output from `node_id`.
 413     fn node_label(&'a self, n: &N) -> LabelText<'a> {
 414         LabelStr(self.node_id(n).name)
 415     }
 416
 417     /// Maps `e` to a label that will be used in the rendered output.
 418     /// The label need not be unique, and may be the empty string; the
 419     /// default is in fact the empty string.
 420     fn edge_label(&'a self, e: &E) -> LabelText<'a> {
 421         let _ignored = e;
 422         LabelStr("".into_cow())
 423     }
 424 }
 425
 426 impl<'a> LabelText<'a> {
 427     pub fn label<S:IntoCow<'a, str>>(s: S) -> LabelText<'a> {
 428         LabelStr(s.into_cow())
 429     }
 430
 431     pub fn escaped<S:IntoCow<'a, str>>(s: S) -> LabelText<'a> {
 432         EscStr(s.into_cow())
 433     }
 434
 435     fn escape_char<F>(c: char, mut f: F) where F: FnMut(char) {
 436         match c {
 437             // not escaping \\, since Graphviz escString needs to
 438             // interpret backslashes; see EscStr above.
 439             '\\' => f(c),
 440             _ => for c in c.escape_default() { f(c) }
 441         }
 442     }
 443     fn escape_str(s: &str) -> String {
 444         let mut out = String::with_capacity(s.len());
 445         for c in s.chars() {
 446             LabelText::escape_char(c, |c| out.push(c));
 447         }
 448         out
 449     }
 450
 451     /// Renders text as string suitable for a label in a .dot file.
 452     pub fn escape(&self) -> String {
 453         match self {
 454             &LabelStr(ref s) => s.escape_default(),
 455             &EscStr(ref s) => LabelText::escape_str(&s[..]),
 456         }
 457     }
 458
 459     /// Decomposes content into string suitable for making EscStr that
 460     /// yields same content as self.  The result obeys the law
 461     /// render(`lt`) == render(`EscStr(lt.pre_escaped_content())`) for
 462     /// all `lt: LabelText`.
 463     fn pre_escaped_content(self) -> Cow<'a, str> {
 464         match self {
 465             EscStr(s) => s,
 466             LabelStr(s) => if s.contains_char('\\') {
 467                 (&*s).escape_default().into_cow()
 468             } else {
 469                 s
 470             },
 471         }
 472     }
 473
 474     /// Puts `prefix` on a line above this label, with a blank line separator.
 475     pub fn prefix_line(self, prefix: LabelText) -> LabelText<'static> {
 476         prefix.suffix_line(self)
 477     }
 478
 479     /// Puts `suffix` on a line below this label, with a blank line separator.
 480     pub fn suffix_line(self, suffix: LabelText) -> LabelText<'static> {
 481         let mut prefix = self.pre_escaped_content().into_owned();
 482         let suffix = suffix.pre_escaped_content();
 483         prefix.push_str(r"\n\n");
 484         prefix.push_str(&suffix[..]);
 485         EscStr(prefix.into_cow())
 486     }
 487 }
 488
 489 pub type Nodes<'a,N> = Cow<'a,[N]>;
 490 pub type Edges<'a,E> = Cow<'a,[E]>;
 491
 492 // (The type parameters in GraphWalk should be associated items,
 493 // when/if Rust supports such.)
 494
 495 /// GraphWalk is an abstraction over a directed graph = (nodes,edges)
 496 /// made up of node handles `N` and edge handles `E`, where each `E`
 497 /// can be mapped to its source and target nodes.
 498 ///
 499 /// The lifetime parameter `'a` is exposed in this trait (rather than
 500 /// introduced as a generic parameter on each method declaration) so
 501 /// that a client impl can choose `N` and `E` that have substructure
 502 /// that is bound by the self lifetime `'a`.
 503 ///
 504 /// The `nodes` and `edges` method each return instantiations of
 505 /// `CowVec` to leave implementers the freedom to create
 506 /// entirely new vectors or to pass back slices into internally owned
 507 /// vectors.
 508 pub trait GraphWalk<'a, N, E> {
 509     /// Returns all the nodes in this graph.
 510     fn nodes(&'a self) -> Nodes<'a, N>;
 511     /// Returns all of the edges in this graph.
 512     fn edges(&'a self) -> Edges<'a, E>;
 513     /// The source node for `edge`.
 514     fn source(&'a self, edge: &E) -> N;
 515     /// The target node for `edge`.
 516     fn target(&'a self, edge: &E) -> N;
 517 }
 518
 519 #[derive(Copy, PartialEq, Eq, Debug)]
 520 pub enum RenderOption {
 521     NoEdgeLabels,
 522     NoNodeLabels,
 523 }
 524
 525 /// Returns vec holding all the default render options.
 526 pub fn default_options() -> Vec<RenderOption> { vec![] }
 527
 528 /// Renders directed graph `g` into the writer `w` in DOT syntax.
 529 /// (Simple wrapper around `render_opts` that passes a default set of options.)
 530 pub fn render<'a, N:Clone+'a, E:Clone+'a, G:Labeller<'a,N,E>+GraphWalk<'a,N,E>, W:Writer>(
 531               g: &'a G,
 532               w: &mut W) -> old_io::IoResult<()> {
 533     render_opts(g, w, &[])
 534 }
 535
 536 /// Renders directed graph `g` into the writer `w` in DOT syntax.
 537 /// (Main entry point for the library.)
 538 pub fn render_opts<'a, N:Clone+'a, E:Clone+'a, G:Labeller<'a,N,E>+GraphWalk<'a,N,E>, W:Writer>(
 539               g: &'a G,
 540               w: &mut W,
 541               options: &[RenderOption]) -> old_io::IoResult<()>
 542 {
 543     fn writeln<W:Writer>(w: &mut W, arg: &[&str]) -> old_io::IoResult<()> {
 544         for &s in arg { try!(w.write_str(s)); }
 545         w.write_char('\n')
 546     }
 547
 548     fn indent<W:Writer>(w: &mut W) -> old_io::IoResult<()> {
 549         w.write_str("    ")
 550     }
 551
 552     try!(writeln(w, &["digraph ", g.graph_id().as_slice(), " {"]));
 553     for n in &*g.nodes() {
 554         try!(indent(w));
 555         let id = g.node_id(n);
 556         if options.contains(&RenderOption::NoNodeLabels) {
 557             try!(writeln(w, &[id.as_slice(), ";"]));
 558         } else {
 559             let escaped = g.node_label(n).escape();
 560             try!(writeln(w, &[id.as_slice(),
 561                               "[label=\"", &escaped, "\"];"]));
 562         }
 563     }
 564
 565     for e in &*g.edges() {
 566         let escaped_label = g.edge_label(e).escape();
 567         try!(indent(w));
 568         let source = g.source(e);
 569         let target = g.target(e);
 570         let source_id = g.node_id(&source);
 571         let target_id = g.node_id(&target);
 572         if options.contains(&RenderOption::NoEdgeLabels) {
 573             try!(writeln(w, &[source_id.as_slice(),
 574                               " -> ", target_id.as_slice(), ";"]));
 575         } else {
 576             try!(writeln(w, &[source_id.as_slice(),
 577                               " -> ", target_id.as_slice(),
 578                               "[label=\"", &escaped_label, "\"];"]));
 579         }
 580     }
 581
 582     writeln(w, &["}"])
 583 }
 584
 585 #[cfg(test)]
 586 mod tests {
 587     use self::NodeLabels::*;
 588     use super::{Id, Labeller, Nodes, Edges, GraphWalk, render};
 589     use super::LabelText::{self, LabelStr, EscStr};
 590     use std::old_io::IoResult;
 591     use std::borrow::IntoCow;
 592     use std::iter::repeat;
 593
 594     /// each node is an index in a vector in the graph.
 595     type Node = uint;
 596     struct Edge {
 597         from: uint, to: uint, label: &'static str
 598     }
 599
 600     fn edge(from: uint, to: uint, label: &'static str) -> Edge {
 601         Edge { from: from, to: to, label: label }
 602     }
 603
 604     struct LabelledGraph {
 605         /// The name for this graph. Used for labelling generated `digraph`.
 606         name: &'static str,
 607
 608         /// Each node is an index into `node_labels`; these labels are
 609         /// used as the label text for each node. (The node *names*,
 610         /// which are unique identifiers, are derived from their index
 611         /// in this array.)
 612         ///
 613         /// If a node maps to None here, then just use its name as its
 614         /// text.
 615         node_labels: Vec<Option<&'static str>>,
 616
 617         /// Each edge relates a from-index to a to-index along with a
 618         /// label; `edges` collects them.
 619         edges: Vec<Edge>,
 620     }
 621
 622     // A simple wrapper around LabelledGraph that forces the labels to
 623     // be emitted as EscStr.
 624     struct LabelledGraphWithEscStrs {
 625         graph: LabelledGraph
 626     }
 627
 628     enum NodeLabels<L> {
 629         AllNodesLabelled(Vec<L>),
 630         UnlabelledNodes(uint),
 631         SomeNodesLabelled(Vec<Option<L>>),
 632     }
 633
 634     type Trivial = NodeLabels<&'static str>;
 635
 636     impl NodeLabels<&'static str> {
 637         fn to_opt_strs(self) -> Vec<Option<&'static str>> {
 638             match self {
 639                 UnlabelledNodes(len)
 640                     => repeat(None).take(len).collect(),
 641                 AllNodesLabelled(lbls)
 642                     => lbls.into_iter().map(
 643                         |l|Some(l)).collect(),
 644                 SomeNodesLabelled(lbls)
 645                     => lbls.into_iter().collect(),
 646             }
 647         }
 648     }
 649
 650     impl LabelledGraph {
 651         fn new(name: &'static str,
 652                node_labels: Trivial,
 653                edges: Vec<Edge>) -> LabelledGraph {
 654             LabelledGraph {
 655                 name: name,
 656                 node_labels: node_labels.to_opt_strs(),
 657                 edges: edges
 658             }
 659         }
 660     }
 661
 662     impl LabelledGraphWithEscStrs {
 663         fn new(name: &'static str,
 664                node_labels: Trivial,
 665                edges: Vec<Edge>) -> LabelledGraphWithEscStrs {
 666             LabelledGraphWithEscStrs {
 667                 graph: LabelledGraph::new(name, node_labels, edges)
 668             }
 669         }
 670     }
 671
 672     fn id_name<'a>(n: &Node) -> Id<'a> {
 673         Id::new(format!("N{}", *n)).unwrap()
 674     }
 675
 676     impl<'a> Labeller<'a, Node, &'a Edge> for LabelledGraph {
 677         fn graph_id(&'a self) -> Id<'a> {
 678             Id::new(&self.name[..]).unwrap()
 679         }
 680         fn node_id(&'a self, n: &Node) -> Id<'a> {
 681             id_name(n)
 682         }
 683         fn node_label(&'a self, n: &Node) -> LabelText<'a> {
 684             match self.node_labels[*n] {
 685                 Some(ref l) => LabelStr(l.into_cow()),
 686                 None        => LabelStr(id_name(n).name()),
 687             }
 688         }
 689         fn edge_label(&'a self, e: & &'a Edge) -> LabelText<'a> {
 690             LabelStr(e.label.into_cow())
 691         }
 692     }
 693
 694     impl<'a> Labeller<'a, Node, &'a Edge> for LabelledGraphWithEscStrs {
 695         fn graph_id(&'a self) -> Id<'a> { self.graph.graph_id() }
 696         fn node_id(&'a self, n: &Node) -> Id<'a> { self.graph.node_id(n) }
 697         fn node_label(&'a self, n: &Node) -> LabelText<'a> {
 698             match self.graph.node_label(n) {
 699                 LabelStr(s) | EscStr(s) => EscStr(s),
 700             }
 701         }
 702         fn edge_label(&'a self, e: & &'a Edge) -> LabelText<'a> {
 703             match self.graph.edge_label(e) {
 704                 LabelStr(s) | EscStr(s) => EscStr(s),
 705             }
 706         }
 707     }
 708
 709     impl<'a> GraphWalk<'a, Node, &'a Edge> for LabelledGraph {
 710         fn nodes(&'a self) -> Nodes<'a,Node> {
 711             (0..self.node_labels.len()).collect()
 712         }
 713         fn edges(&'a self) -> Edges<'a,&'a Edge> {
 714             self.edges.iter().collect()
 715         }
 716         fn source(&'a self, edge: & &'a Edge) -> Node {
 717             edge.from
 718         }
 719         fn target(&'a self, edge: & &'a Edge) -> Node {
 720             edge.to
 721         }
 722     }
 723
 724     impl<'a> GraphWalk<'a, Node, &'a Edge> for LabelledGraphWithEscStrs {
 725         fn nodes(&'a self) -> Nodes<'a,Node> {
 726             self.graph.nodes()
 727         }
 728         fn edges(&'a self) -> Edges<'a,&'a Edge> {
 729             self.graph.edges()
 730         }
 731         fn source(&'a self, edge: & &'a Edge) -> Node {
 732             edge.from
 733         }
 734         fn target(&'a self, edge: & &'a Edge) -> Node {
 735             edge.to
 736         }
 737     }
 738
 739     fn test_input(g: LabelledGraph) -> IoResult<String> {
 740         let mut writer = Vec::new();
 741         render(&g, &mut writer).unwrap();
 742         (&mut &*writer).read_to_string()
 743     }
 744
 745     // All of the tests use raw-strings as the format for the expected outputs,
 746     // so that you can cut-and-paste the content into a .dot file yourself to
 747     // see what the graphviz visualizer would produce.
 748
 749     #[test]
 750     fn empty_graph() {
 751         let labels : Trivial = UnlabelledNodes(0);
 752         let r = test_input(LabelledGraph::new("empty_graph", labels, vec!()));
 753         assert_eq!(r.unwrap(),
 754 r#"digraph empty_graph {
 755 }
 756 "#);
 757     }
 758
 759     #[test]
 760     fn single_node() {
 761         let labels : Trivial = UnlabelledNodes(1);
 762         let r = test_input(LabelledGraph::new("single_node", labels, vec!()));
 763         assert_eq!(r.unwrap(),
 764 r#"digraph single_node {
 765     N0[label="N0"];
 766 }
 767 "#);
 768     }
 769
 770     #[test]
 771     fn single_edge() {
 772         let labels : Trivial = UnlabelledNodes(2);
 773         let result = test_input(LabelledGraph::new("single_edge", labels,
 774                                                    vec!(edge(0, 1, "E"))));
 775         assert_eq!(result.unwrap(),
 776 r#"digraph single_edge {
 777     N0[label="N0"];
 778     N1[label="N1"];
 779     N0 -> N1[label="E"];
 780 }
 781 "#);
 782     }
 783
 784     #[test]
 785     fn test_some_labelled() {
 786         let labels : Trivial = SomeNodesLabelled(vec![Some("A"), None]);
 787         let result = test_input(LabelledGraph::new("test_some_labelled", labels,
 788                                                    vec![edge(0, 1, "A-1")]));
 789         assert_eq!(result.unwrap(),
 790 r#"digraph test_some_labelled {
 791     N0[label="A"];
 792     N1[label="N1"];
 793     N0 -> N1[label="A-1"];
 794 }
 795 "#);
 796     }
 797
 798     #[test]
 799     fn single_cyclic_node() {
 800         let labels : Trivial = UnlabelledNodes(1);
 801         let r = test_input(LabelledGraph::new("single_cyclic_node", labels,
 802                                               vec!(edge(0, 0, "E"))));
 803         assert_eq!(r.unwrap(),
 804 r#"digraph single_cyclic_node {
 805     N0[label="N0"];
 806     N0 -> N0[label="E"];
 807 }
 808 "#);
 809     }
 810
 811     #[test]
 812     fn hasse_diagram() {
 813         let labels = AllNodesLabelled(vec!("{x,y}", "{x}", "{y}", "{}"));
 814         let r = test_input(LabelledGraph::new(
 815             "hasse_diagram", labels,
 816             vec!(edge(0, 1, ""), edge(0, 2, ""),
 817                  edge(1, 3, ""), edge(2, 3, ""))));
 818         assert_eq!(r.unwrap(),
 819 r#"digraph hasse_diagram {
 820     N0[label="{x,y}"];
 821     N1[label="{x}"];
 822     N2[label="{y}"];
 823     N3[label="{}"];
 824     N0 -> N1[label=""];
 825     N0 -> N2[label=""];
 826     N1 -> N3[label=""];
 827     N2 -> N3[label=""];
 828 }
 829 "#);
 830     }
 831
 832     #[test]
 833     fn left_aligned_text() {
 834         let labels = AllNodesLabelled(vec!(
 835             "if test {\
 836            \\l    branch1\
 837            \\l} else {\
 838            \\l    branch2\
 839            \\l}\
 840            \\lafterward\
 841            \\l",
 842             "branch1",
 843             "branch2",
 844             "afterward"));
 845
 846         let mut writer = Vec::new();
 847
 848         let g = LabelledGraphWithEscStrs::new(
 849             "syntax_tree", labels,
 850             vec!(edge(0, 1, "then"), edge(0, 2, "else"),
 851                  edge(1, 3, ";"),    edge(2, 3, ";"   )));
 852
 853         render(&g, &mut writer).unwrap();
 854         let r = (&mut &*writer).read_to_string();
 855
 856         assert_eq!(r.unwrap(),
 857 r#"digraph syntax_tree {
 858     N0[label="if test {\l    branch1\l} else {\l    branch2\l}\lafterward\l"];
 859     N1[label="branch1"];
 860     N2[label="branch2"];
 861     N3[label="afterward"];
 862     N0 -> N1[label="then"];
 863     N0 -> N2[label="else"];
 864     N1 -> N3[label=";"];
 865     N2 -> N3[label=";"];
 866 }
 867 "#);
 868     }
 869
 870     #[test]
 871     fn simple_id_construction() {
 872         let id1 = Id::new("hello");
 873         match id1 {
 874             Ok(_) => {;},
 875             Err(..) => panic!("'hello' is not a valid value for id anymore")
 876         }
 877     }
 878
 879     #[test]
 880     fn badly_formatted_id() {
 881         let id2 = Id::new("Weird { struct : ure } !!!");
 882         match id2 {
 883             Ok(_) => panic!("graphviz id suddenly allows spaces, brackets and stuff"),
 884             Err(..) => {;}
 885         }
 886     }
 887 }