src/libgraphviz/lib.rs

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