components/extlib/graphvizPp.mli

   1 (* Copyright (C) 2006, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 (* $Id$ *)
  27
  28 (** {2 Pretty printer for generating (textual) Graphviz markup} *)
  29
  30 type attribute = string * string  (* <key, value> pair *)
  31
  32 module type GraphvizFormatter =
  33   sig
  34     (** @param name graph name
  35      * @param graph_type type of dot graph, default value "digraph"
  36      *        interesting options: "strict digraph"
  37      * @param graph_attrs graph attributes
  38      * @param node_attrs graph-wide node attributes
  39      * @param edge_attrs graph-wide edge attributes *)
  40     val header:
  41       ?graph_type:string ->
  42       ?name:string -> ?graph_attrs:(attribute list) ->
  43       ?node_attrs:(attribute list) -> ?edge_attrs:(attribute list) ->
  44       Format.formatter ->
  45         unit
  46     val node: string -> ?attrs:(attribute list) -> Format.formatter -> unit
  47     val edge:
  48       string -> string -> ?attrs:(attribute list) -> Format.formatter ->
  49         unit
  50     val raw: string -> Format.formatter -> unit
  51     val trailer: Format.formatter -> unit
  52   end
  53
  54 module Dot: GraphvizFormatter
  55