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(core)]
 279 #![feature(old_io)]
 280
 281 use self::LabelText::*;
 282
 283 use std::borrow::IntoCow;
 284 use std::old_io;
 285 use std::string::CowString;
 286 use std::vec::CowVec;
 287
 288 /// The text for a graphviz label on a node or edge.
 289 pub enum LabelText<'a> {
 290     /// This kind of label preserves the text directly as is.
 291     ///
 292     /// Occurrences of backslashes (`\`) are escaped, and thus appear
 293     /// as backslashes in the rendered label.
 294     LabelStr(CowString<'a>),
 295
 296     /// This kind of label uses the graphviz label escString type:
 297     /// http://www.graphviz.org/content/attrs#kescString
 298     ///
 299     /// Occurrences of backslashes (`\`) are not escaped; instead they
 300     /// are interpreted as initiating an escString escape sequence.
 301     ///
 302     /// Escape sequences of particular interest: in addition to `\n`
 303     /// to break a line (centering the line preceding the `\n`), there
 304     /// are also the escape sequences `\l` which left-justifies the
 305     /// preceding line and `\r` which right-justifies it.
 306     EscStr(CowString<'a>),
 307 }
 308
 309 // There is a tension in the design of the labelling API.
 310 //
 311 // For example, I considered making a `Labeller<T>` trait that
 312 // provides labels for `T`, and then making the graph type `G`
 313 // implement `Labeller<Node>` and `Labeller<Edge>`. However, this is
 314 // not possible without functional dependencies. (One could work
 315 // around that, but I did not explore that avenue heavily.)
 316 //
 317 // Another approach that I actually used for a while was to make a
 318 // `Label<Context>` trait that is implemented by the client-specific
 319 // Node and Edge types (as well as an implementation on Graph itself
 320 // for the overall name for the graph). The main disadvantage of this
 321 // second approach (compared to having the `G` type parameter
 322 // implement a Labelling service) that I have encountered is that it
 323 // makes it impossible to use types outside of the current crate
 324 // directly as Nodes/Edges; you need to wrap them in newtype'd
 325 // structs. See e.g. the `No` and `Ed` structs in the examples. (In
 326 // practice clients using a graph in some other crate would need to
 327 // provide some sort of adapter shim over the graph anyway to
 328 // interface with this library).
 329 //
 330 // Another approach would be to make a single `Labeller<N,E>` trait
 331 // that provides three methods (graph_label, node_label, edge_label),
 332 // and then make `G` implement `Labeller<N,E>`. At first this did not
 333 // appeal to me, since I had thought I would need separate methods on
 334 // each data variant for dot-internal identifiers versus user-visible
 335 // labels. However, the identifier/label distinction only arises for
 336 // nodes; graphs themselves only have identifiers, and edges only have
 337 // labels.
 338 //
 339 // So in the end I decided to use the third approach described above.
 340
 341 /// `Id` is a Graphviz `ID`.
 342 pub struct Id<'a> {
 343     name: CowString<'a>,
 344 }
 345
 346 impl<'a> Id<'a> {
 347     /// Creates an `Id` named `name`.
 348     ///
 349     /// The caller must ensure that the input conforms to an
 350     /// identifier format: it must be a non-empty string made up of
 351     /// alphanumeric or underscore characters, not beginning with a
 352     /// digit (i.e. the regular expression `[a-zA-Z_][a-zA-Z_0-9]*`).
 353     ///
 354     /// (Note: this format is a strict subset of the `ID` format
 355     /// defined by the DOT language.  This function may change in the
 356     /// future to accept a broader subset, or the entirety, of DOT's
 357     /// `ID` format.)
 358     ///
 359     /// Passing an invalid string (containing spaces, brackets,
 360     /// quotes, ...) will return an empty `Err` value.
 361     pub fn new<Name: IntoCow<'a, String, str>>(name: Name) -> Result<Id<'a>, ()> {
 362         let name = name.into_cow();
 363         {
 364             let mut chars = name.chars();
 365             match chars.next() {
 366                 Some(c) if is_letter_or_underscore(c) => { ; },
 367                 _ => return Err(())
 368             }
 369             if !chars.all(is_constituent) {
 370                 return Err(())
 371             }
 372         }
 373         return Ok(Id{ name: name });
 374
 375         fn is_letter_or_underscore(c: char) -> bool {
 376             in_range('a', c, 'z') || in_range('A', c, 'Z') || c == '_'
 377         }
 378         fn is_constituent(c: char) -> bool {
 379             is_letter_or_underscore(c) || in_range('0', c, '9')
 380         }
 381         fn in_range(low: char, c: char, high: char) -> bool {
 382             low as uint <= c as uint && c as uint <= high as uint
 383         }
 384     }
 385
 386     pub fn as_slice(&'a self) -> &'a str {
 387         &*self.name
 388     }
 389
 390     pub fn name(self) -> CowString<'a> {
 391         self.name
 392     }
 393 }
 394
 395 /// Each instance of a type that implements `Label<C>` maps to a
 396 /// unique identifier with respect to `C`, which is used to identify
 397 /// it in the generated .dot file. They can also provide more
 398 /// elaborate (and non-unique) label text that is used in the graphviz
 399 /// rendered output.
 400
 401 /// The graph instance is responsible for providing the DOT compatible
 402 /// identifiers for the nodes and (optionally) rendered labels for the nodes and
 403 /// edges, as well as an identifier for the graph itself.
 404 pub trait Labeller<'a,N,E> {
 405     /// Must return a DOT compatible identifier naming the graph.
 406     fn graph_id(&'a self) -> Id<'a>;
 407
 408     /// Maps `n` to a unique identifier with respect to `self`. The
 409     /// implementer is responsible for ensuring that the returned name
 410     /// is a valid DOT identifier.
 411     fn node_id(&'a self, n: &N) -> Id<'a>;
 412
 413     /// Maps `n` to a label that will be used in the rendered output.
 414     /// The label need not be unique, and may be the empty string; the
 415     /// default is just the output from `node_id`.
 416     fn node_label(&'a self, n: &N) -> LabelText<'a> {
 417         LabelStr(self.node_id(n).name)
 418     }
 419
 420     /// Maps `e` to a label that will be used in the rendered output.
 421     /// The label need not be unique, and may be the empty string; the
 422     /// default is in fact the empty string.
 423     fn edge_label(&'a self, e: &E) -> LabelText<'a> {
 424         let _ignored = e;
 425         LabelStr("".into_cow())
 426     }
 427 }
 428
 429 impl<'a> LabelText<'a> {
 430     pub fn label<S:IntoCow<'a, String, str>>(s: S) -> LabelText<'a> {
 431         LabelStr(s.into_cow())
 432     }
 433
 434     pub fn escaped<S:IntoCow<'a, String, str>>(s: S) -> LabelText<'a> {
 435         EscStr(s.into_cow())
 436     }
 437
 438     fn escape_char<F>(c: char, mut f: F) where F: FnMut(char) {
 439         match c {
 440             // not escaping \\, since Graphviz escString needs to
 441             // interpret backslashes; see EscStr above.
 442             '\\' => f(c),
 443             _ => for c in c.escape_default() { f(c) }
 444         }
 445     }
 446     fn escape_str(s: &str) -> String {
 447         let mut out = String::with_capacity(s.len());
 448         for c in s.chars() {
 449             LabelText::escape_char(c, |c| out.push(c));
 450         }
 451         out
 452     }
 453
 454     /// Renders text as string suitable for a label in a .dot file.
 455     pub fn escape(&self) -> String {
 456         match self {
 457             &LabelStr(ref s) => s.escape_default(),
 458             &EscStr(ref s) => LabelText::escape_str(&s[]),
 459         }
 460     }
 461
 462     /// Decomposes content into string suitable for making EscStr that
 463     /// yields same content as self.  The result obeys the law
 464     /// render(`lt`) == render(`EscStr(lt.pre_escaped_content())`) for
 465     /// all `lt: LabelText`.
 466     fn pre_escaped_content(self) -> CowString<'a> {
 467         match self {
 468             EscStr(s) => s,
 469             LabelStr(s) => if s.contains_char('\\') {
 470                 (&*s).escape_default().into_cow()
 471             } else {
 472                 s
 473             },
 474         }
 475     }
 476
 477     /// Puts `prefix` on a line above this label, with a blank line separator.
 478     pub fn prefix_line(self, prefix: LabelText) -> LabelText<'static> {
 479         prefix.suffix_line(self)
 480     }
 481
 482     /// Puts `suffix` on a line below this label, with a blank line separator.
 483     pub fn suffix_line(self, suffix: LabelText) -> LabelText<'static> {
 484         let mut prefix = self.pre_escaped_content().into_owned();
 485         let suffix = suffix.pre_escaped_content();
 486         prefix.push_str(r"\n\n");
 487         prefix.push_str(&suffix[]);
 488         EscStr(prefix.into_cow())
 489     }
 490 }
 491
 492 pub type Nodes<'a,N> = CowVec<'a,N>;
 493 pub type Edges<'a,E> = CowVec<'a,E>;
 494
 495 // (The type parameters in GraphWalk should be associated items,
 496 // when/if Rust supports such.)
 497
 498 /// GraphWalk is an abstraction over a directed graph = (nodes,edges)
 499 /// made up of node handles `N` and edge handles `E`, where each `E`
 500 /// can be mapped to its source and target nodes.
 501 ///
 502 /// The lifetime parameter `'a` is exposed in this trait (rather than
 503 /// introduced as a generic parameter on each method declaration) so
 504 /// that a client impl can choose `N` and `E` that have substructure
 505 /// that is bound by the self lifetime `'a`.
 506 ///
 507 /// The `nodes` and `edges` method each return instantiations of
 508 /// `CowVec` to leave implementers the freedom to create
 509 /// entirely new vectors or to pass back slices into internally owned
 510 /// vectors.
 511 pub trait GraphWalk<'a, N, E> {
 512     /// Returns all the nodes in this graph.
 513     fn nodes(&'a self) -> Nodes<'a, N>;
 514     /// Returns all of the edges in this graph.
 515     fn edges(&'a self) -> Edges<'a, E>;
 516     /// The source node for `edge`.
 517     fn source(&'a self, edge: &E) -> N;
 518     /// The target node for `edge`.
 519     fn target(&'a self, edge: &E) -> N;
 520 }
 521
 522 #[derive(Copy, PartialEq, Eq, Debug)]
 523 pub enum RenderOption {
 524     NoEdgeLabels,
 525     NoNodeLabels,
 526 }
 527
 528 /// Returns vec holding all the default render options.
 529 pub fn default_options() -> Vec<RenderOption> { vec![] }
 530
 531 /// Renders directed graph `g` into the writer `w` in DOT syntax.
 532 /// (Simple wrapper around `render_opts` that passes a default set of options.)
 533 pub fn render<'a, N:Clone+'a, E:Clone+'a, G:Labeller<'a,N,E>+GraphWalk<'a,N,E>, W:Writer>(
 534               g: &'a G,
 535               w: &mut W) -> old_io::IoResult<()> {
 536     render_opts(g, w, &[])
 537 }
 538
 539 /// Renders directed graph `g` into the writer `w` in DOT syntax.
 540 /// (Main entry point for the library.)
 541 pub fn render_opts<'a, N:Clone+'a, E:Clone+'a, G:Labeller<'a,N,E>+GraphWalk<'a,N,E>, W:Writer>(
 542               g: &'a G,
 543               w: &mut W,
 544               options: &[RenderOption]) -> old_io::IoResult<()>
 545 {
 546     fn writeln<W:Writer>(w: &mut W, arg: &[&str]) -> old_io::IoResult<()> {
 547         for &s in arg { try!(w.write_str(s)); }
 548         w.write_char('\n')
 549     }
 550
 551     fn indent<W:Writer>(w: &mut W) -> old_io::IoResult<()> {
 552         w.write_str("    ")
 553     }
 554
 555     try!(writeln(w, &["digraph ", g.graph_id().as_slice(), " {"]));
 556     for n in &*g.nodes() {
 557         try!(indent(w));
 558         let id = g.node_id(n);
 559         if options.contains(&RenderOption::NoNodeLabels) {
 560             try!(writeln(w, &[id.as_slice(), ";"]));
 561         } else {
 562             let escaped = g.node_label(n).escape();
 563             try!(writeln(w, &[id.as_slice(),
 564                               "[label=\"", &escaped, "\"];"]));
 565         }
 566     }
 567
 568     for e in &*g.edges() {
 569         let escaped_label = g.edge_label(e).escape();
 570         try!(indent(w));
 571         let source = g.source(e);
 572         let target = g.target(e);
 573         let source_id = g.node_id(&source);
 574         let target_id = g.node_id(&target);
 575         if options.contains(&RenderOption::NoEdgeLabels) {
 576             try!(writeln(w, &[source_id.as_slice(),
 577                               " -> ", target_id.as_slice(), ";"]));
 578         } else {
 579             try!(writeln(w, &[source_id.as_slice(),
 580                               " -> ", target_id.as_slice(),
 581                               "[label=\"", &escaped_label, "\"];"]));
 582         }
 583     }
 584
 585     writeln(w, &["}"])
 586 }
 587
 588 #[cfg(test)]
 589 mod tests {
 590     use self::NodeLabels::*;
 591     use super::{Id, Labeller, Nodes, Edges, GraphWalk, render};
 592     use super::LabelText::{self, LabelStr, EscStr};
 593     use std::old_io::IoResult;
 594     use std::borrow::IntoCow;
 595     use std::iter::repeat;
 596
 597     /// each node is an index in a vector in the graph.
 598     type Node = uint;
 599     struct Edge {
 600         from: uint, to: uint, label: &'static str
 601     }
 602
 603     fn edge(from: uint, to: uint, label: &'static str) -> Edge {
 604         Edge { from: from, to: to, label: label }
 605     }
 606
 607     struct LabelledGraph {
 608         /// The name for this graph. Used for labelling generated `digraph`.
 609         name: &'static str,
 610
 611         /// Each node is an index into `node_labels`; these labels are
 612         /// used as the label text for each node. (The node *names*,
 613         /// which are unique identifiers, are derived from their index
 614         /// in this array.)
 615         ///
 616         /// If a node maps to None here, then just use its name as its
 617         /// text.
 618         node_labels: Vec<Option<&'static str>>,
 619
 620         /// Each edge relates a from-index to a to-index along with a
 621         /// label; `edges` collects them.
 622         edges: Vec<Edge>,
 623     }
 624
 625     // A simple wrapper around LabelledGraph that forces the labels to
 626     // be emitted as EscStr.
 627     struct LabelledGraphWithEscStrs {
 628         graph: LabelledGraph
 629     }
 630
 631     enum NodeLabels<L> {
 632         AllNodesLabelled(Vec<L>),
 633         UnlabelledNodes(uint),
 634         SomeNodesLabelled(Vec<Option<L>>),
 635     }
 636
 637     type Trivial = NodeLabels<&'static str>;
 638
 639     impl NodeLabels<&'static str> {
 640         fn to_opt_strs(self) -> Vec<Option<&'static str>> {
 641             match self {
 642                 UnlabelledNodes(len)
 643                     => repeat(None).take(len).collect(),
 644                 AllNodesLabelled(lbls)
 645                     => lbls.into_iter().map(
 646                         |l|Some(l)).collect(),
 647                 SomeNodesLabelled(lbls)
 648                     => lbls.into_iter().collect(),
 649             }
 650         }
 651     }
 652
 653     impl LabelledGraph {
 654         fn new(name: &'static str,
 655                node_labels: Trivial,
 656                edges: Vec<Edge>) -> LabelledGraph {
 657             LabelledGraph {
 658                 name: name,
 659                 node_labels: node_labels.to_opt_strs(),
 660                 edges: edges
 661             }
 662         }
 663     }
 664
 665     impl LabelledGraphWithEscStrs {
 666         fn new(name: &'static str,
 667                node_labels: Trivial,
 668                edges: Vec<Edge>) -> LabelledGraphWithEscStrs {
 669             LabelledGraphWithEscStrs {
 670                 graph: LabelledGraph::new(name, node_labels, edges)
 671             }
 672         }
 673     }
 674
 675     fn id_name<'a>(n: &Node) -> Id<'a> {
 676         Id::new(format!("N{}", *n)).unwrap()
 677     }
 678
 679     impl<'a> Labeller<'a, Node, &'a Edge> for LabelledGraph {
 680         fn graph_id(&'a self) -> Id<'a> {
 681             Id::new(&self.name[]).unwrap()
 682         }
 683         fn node_id(&'a self, n: &Node) -> Id<'a> {
 684             id_name(n)
 685         }
 686         fn node_label(&'a self, n: &Node) -> LabelText<'a> {
 687             match self.node_labels[*n] {
 688                 Some(ref l) => LabelStr(l.into_cow()),
 689                 None        => LabelStr(id_name(n).name()),
 690             }
 691         }
 692         fn edge_label(&'a self, e: & &'a Edge) -> LabelText<'a> {
 693             LabelStr(e.label.into_cow())
 694         }
 695     }
 696
 697     impl<'a> Labeller<'a, Node, &'a Edge> for LabelledGraphWithEscStrs {
 698         fn graph_id(&'a self) -> Id<'a> { self.graph.graph_id() }
 699         fn node_id(&'a self, n: &Node) -> Id<'a> { self.graph.node_id(n) }
 700         fn node_label(&'a self, n: &Node) -> LabelText<'a> {
 701             match self.graph.node_label(n) {
 702                 LabelStr(s) | EscStr(s) => EscStr(s),
 703             }
 704         }
 705         fn edge_label(&'a self, e: & &'a Edge) -> LabelText<'a> {
 706             match self.graph.edge_label(e) {
 707                 LabelStr(s) | EscStr(s) => EscStr(s),
 708             }
 709         }
 710     }
 711
 712     impl<'a> GraphWalk<'a, Node, &'a Edge> for LabelledGraph {
 713         fn nodes(&'a self) -> Nodes<'a,Node> {
 714             (0..self.node_labels.len()).collect()
 715         }
 716         fn edges(&'a self) -> Edges<'a,&'a Edge> {
 717             self.edges.iter().collect()
 718         }
 719         fn source(&'a self, edge: & &'a Edge) -> Node {
 720             edge.from
 721         }
 722         fn target(&'a self, edge: & &'a Edge) -> Node {
 723             edge.to
 724         }
 725     }
 726
 727     impl<'a> GraphWalk<'a, Node, &'a Edge> for LabelledGraphWithEscStrs {
 728         fn nodes(&'a self) -> Nodes<'a,Node> {
 729             self.graph.nodes()
 730         }
 731         fn edges(&'a self) -> Edges<'a,&'a Edge> {
 732             self.graph.edges()
 733         }
 734         fn source(&'a self, edge: & &'a Edge) -> Node {
 735             edge.from
 736         }
 737         fn target(&'a self, edge: & &'a Edge) -> Node {
 738             edge.to
 739         }
 740     }
 741
 742     fn test_input(g: LabelledGraph) -> IoResult<String> {
 743         let mut writer = Vec::new();
 744         render(&g, &mut writer).unwrap();
 745         (&mut &*writer).read_to_string()
 746     }
 747
 748     // All of the tests use raw-strings as the format for the expected outputs,
 749     // so that you can cut-and-paste the content into a .dot file yourself to
 750     // see what the graphviz visualizer would produce.
 751
 752     #[test]
 753     fn empty_graph() {
 754         let labels : Trivial = UnlabelledNodes(0);
 755         let r = test_input(LabelledGraph::new("empty_graph", labels, vec!()));
 756         assert_eq!(r.unwrap(),
 757 r#"digraph empty_graph {
 758 }
 759 "#);
 760     }
 761
 762     #[test]
 763     fn single_node() {
 764         let labels : Trivial = UnlabelledNodes(1);
 765         let r = test_input(LabelledGraph::new("single_node", labels, vec!()));
 766         assert_eq!(r.unwrap(),
 767 r#"digraph single_node {
 768     N0[label="N0"];
 769 }
 770 "#);
 771     }
 772
 773     #[test]
 774     fn single_edge() {
 775         let labels : Trivial = UnlabelledNodes(2);
 776         let result = test_input(LabelledGraph::new("single_edge", labels,
 777                                                    vec!(edge(0, 1, "E"))));
 778         assert_eq!(result.unwrap(),
 779 r#"digraph single_edge {
 780     N0[label="N0"];
 781     N1[label="N1"];
 782     N0 -> N1[label="E"];
 783 }
 784 "#);
 785     }
 786
 787     #[test]
 788     fn test_some_labelled() {
 789         let labels : Trivial = SomeNodesLabelled(vec![Some("A"), None]);
 790         let result = test_input(LabelledGraph::new("test_some_labelled", labels,
 791                                                    vec![edge(0, 1, "A-1")]));
 792         assert_eq!(result.unwrap(),
 793 r#"digraph test_some_labelled {
 794     N0[label="A"];
 795     N1[label="N1"];
 796     N0 -> N1[label="A-1"];
 797 }
 798 "#);
 799     }
 800
 801     #[test]
 802     fn single_cyclic_node() {
 803         let labels : Trivial = UnlabelledNodes(1);
 804         let r = test_input(LabelledGraph::new("single_cyclic_node", labels,
 805                                               vec!(edge(0, 0, "E"))));
 806         assert_eq!(r.unwrap(),
 807 r#"digraph single_cyclic_node {
 808     N0[label="N0"];
 809     N0 -> N0[label="E"];
 810 }
 811 "#);
 812     }
 813
 814     #[test]
 815     fn hasse_diagram() {
 816         let labels = AllNodesLabelled(vec!("{x,y}", "{x}", "{y}", "{}"));
 817         let r = test_input(LabelledGraph::new(
 818             "hasse_diagram", labels,
 819             vec!(edge(0, 1, ""), edge(0, 2, ""),
 820                  edge(1, 3, ""), edge(2, 3, ""))));
 821         assert_eq!(r.unwrap(),
 822 r#"digraph hasse_diagram {
 823     N0[label="{x,y}"];
 824     N1[label="{x}"];
 825     N2[label="{y}"];
 826     N3[label="{}"];
 827     N0 -> N1[label=""];
 828     N0 -> N2[label=""];
 829     N1 -> N3[label=""];
 830     N2 -> N3[label=""];
 831 }
 832 "#);
 833     }
 834
 835     #[test]
 836     fn left_aligned_text() {
 837         let labels = AllNodesLabelled(vec!(
 838             "if test {\
 839            \\l    branch1\
 840            \\l} else {\
 841            \\l    branch2\
 842            \\l}\
 843            \\lafterward\
 844            \\l",
 845             "branch1",
 846             "branch2",
 847             "afterward"));
 848
 849         let mut writer = Vec::new();
 850
 851         let g = LabelledGraphWithEscStrs::new(
 852             "syntax_tree", labels,
 853             vec!(edge(0, 1, "then"), edge(0, 2, "else"),
 854                  edge(1, 3, ";"),    edge(2, 3, ";"   )));
 855
 856         render(&g, &mut writer).unwrap();
 857         let r = (&mut &*writer).read_to_string();
 858
 859         assert_eq!(r.unwrap(),
 860 r#"digraph syntax_tree {
 861     N0[label="if test {\l    branch1\l} else {\l    branch2\l}\lafterward\l"];
 862     N1[label="branch1"];
 863     N2[label="branch2"];
 864     N3[label="afterward"];
 865     N0 -> N1[label="then"];
 866     N0 -> N2[label="else"];
 867     N1 -> N3[label=";"];
 868     N2 -> N3[label=";"];
 869 }
 870 "#);
 871     }
 872
 873     #[test]
 874     fn simple_id_construction() {
 875         let id1 = Id::new("hello");
 876         match id1 {
 877             Ok(_) => {;},
 878             Err(..) => panic!("'hello' is not a valid value for id anymore")
 879         }
 880     }
 881
 882     #[test]
 883     fn badly_formatted_id() {
 884         let id2 = Id::new("Weird { struct : ure } !!!");
 885         match id2 {
 886             Ok(_) => panic!("graphviz id suddenly allows spaces, brackets and stuff"),
 887             Err(..) => {;}
 888         }
 889     }
 890 }