1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
|
(**************************************************************************)
(* *)
(* This file is part of OcamlGraph. *)
(* *)
(* Copyright (C) 2009-2010 *)
(* CEA (Commissariat l'nergie Atomique) *)
(* *)
(* you can redistribute it and/or modify it under the terms of the GNU *)
(* Lesser General Public License as published by the Free Software *)
(* Foundation, version 2.1, with a linking exception. *)
(* *)
(* It is distributed in the hope that it will be useful, *)
(* but WITHOUT ANY WARRANTY; without even the implied warranty of *)
(* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *)
(* GNU Lesser General Public License for more details. *)
(* *)
(* See the file ../LICENSE for more details. *)
(* *)
(* Authors: *)
(* - Julien Signoles (Julien.Signoles@cea.fr) *)
(* - Jean-Denis Koeck (jdkoeck@gmail.com) *)
(* - Benoit Bataille (benoit.bataille@gmail.com) *)
(* *)
(**************************************************************************)
(* This graph model is for now immutable, no adding or removing nodes. *)
open Graph
open XDot
open Printf
exception DotError of string
(* ABSTRACT CLASS *)
class type ['vertex, 'edge, 'cluster] abstract_model = object
method iter_edges : ('vertex -> 'vertex -> unit) -> unit
method iter_edges_e : ('edge -> unit) -> unit
method iter_pred : ('vertex -> unit) -> 'vertex -> unit
method iter_pred_e : ('edge -> unit) -> 'vertex -> unit
method iter_succ : ('vertex -> unit) -> 'vertex -> unit
method iter_succ_e : ('edge -> unit) -> 'vertex -> unit
method iter_vertex : ('vertex -> unit) -> unit
method iter_clusters : ('cluster -> unit) -> unit
method iter_associated_vertex : ('vertex -> unit) -> 'vertex -> unit
(** Membership functions *)
method find_edge : 'vertex -> 'vertex -> 'edge
method mem_edge : 'vertex -> 'vertex -> bool
method mem_edge_e : 'edge -> bool
method mem_vertex : 'vertex -> bool
method src : 'edge -> 'vertex
method dst : 'edge -> 'vertex
(** Dot layout *)
method bounding_box : bounding_box
method get_edge_layout : 'edge -> edge_layout
method get_vertex_layout : 'vertex -> node_layout
method get_cluster_layout : 'cluster -> cluster_layout
end
(* BUILDING A MODEL WITH AN OCAML GRAPH *)
module Make(G : Graphviz.GraphWithDotAttrs) = struct
type cluster = string
module X = XDot.Make(G)
class model layout g : [G.vertex, G.edge, cluster] abstract_model = object
(* Iterators *)
method iter_edges f = G.iter_edges f g
method iter_edges_e f = G.iter_edges_e f g
method iter_pred f v = G.iter_pred f g v
method iter_pred_e f v = G.iter_pred_e f g v
method iter_succ f = G.iter_succ f g
method iter_succ_e f = G.iter_succ_e f g
method iter_vertex f = G.iter_vertex f g
method iter_associated_vertex f v = f v
method iter_clusters f =
Hashtbl.iter (fun k v -> f k) layout.X.cluster_layouts
(* Membership functions *)
method find_edge = try G.find_edge g with Not_found -> assert false
method mem_edge = G.mem_edge g
method mem_edge_e = G.mem_edge_e g
method mem_vertex = G.mem_vertex g
method src = G.E.src
method dst = G.E.dst
(* Layout *)
method bounding_box = layout.X.bbox
method get_vertex_layout v =
try X.HV.find layout.X.vertex_layouts v
with Not_found -> assert false
method get_edge_layout e =
try X.HE.find layout.X.edge_layouts e
with Not_found -> assert false
method get_cluster_layout c =
try Hashtbl.find layout.X.cluster_layouts c
with Not_found -> assert false
end
let from_graph ?(cmd="dot") ?(tmp_name = "dgraph") g =
(* Output dot file *)
let module DumpDot = Graphviz.Dot(G) in
let dot_file, out = Filename.open_temp_file tmp_name ".dot" in
DumpDot.output_graph out g;
close_out out;
(* Get layout from dot file *)
let layout =
try
X.layout_of_dot ~cmd ~dot_file g
with X.DotError err -> raise (DotError err)
in
let model = new model layout g in
Sys.remove dot_file;
model
end
(* BUILDING A MODEL WITH A DOT FILE *)
(* Here we build a model from a graph where vertices and edges
are labeled with xdot layouts *)
module Vertex = struct
type t = XDot.node_layout
end
module Edge = struct
type t = XDot.edge_layout
let default = XDot.mk_edge_layout
~draw:[] ~ldraw:[] ~hdraw:[] ~tdraw:[] ~hldraw:[] ~tldraw:[]
let compare : t -> t -> int = Pervasives.compare
end
module DotG = Imperative.Digraph.AbstractLabeled(Vertex)(Edge)
module DotB = Builder.I(DotG)
type cluster = string
type dotg_model = (DotG.vertex, DotG.edge, cluster) abstract_model
module DotParser =
Dot.Parse
(DotB)
(struct
(* Read the attributes of a node *)
let node = XDot.read_node_layout
(* Read edge attributes *)
let edge = XDot.read_edge_layout
end)
module DotModel = struct
type cluster = string
type clusters_hash = (cluster, Graph.Dot_ast.attr list) Hashtbl.t
class model g clusters_hash bounding_box
: [DotG.vertex, DotG.edge, cluster] abstract_model
=
object
(* Iterators *)
method iter_edges f = DotG.iter_edges f g
method iter_edges_e f = DotG.iter_edges_e f g
method iter_pred f v = DotG.iter_pred f g v
method iter_pred_e f v = DotG.iter_pred_e f g v
method iter_succ f = DotG.iter_succ f g
method iter_succ_e f = DotG.iter_succ_e f g
method iter_vertex f = DotG.iter_vertex f g
method iter_associated_vertex f v = f v
method iter_clusters f = Hashtbl.iter (fun k _ -> f k) clusters_hash
(* Membership functions *)
method find_edge = try DotG.find_edge g with Not_found -> assert false
method mem_edge = DotG.mem_edge g
method mem_edge_e = DotG.mem_edge_e g
method mem_vertex = DotG.mem_vertex g
method src = DotG.E.src
method dst = DotG.E.dst
(* Layout *)
method bounding_box = bounding_box
method get_vertex_layout = DotG.V.label
method get_edge_layout = DotG.E.label
method get_cluster_layout c =
let attrs =
try Hashtbl.find clusters_hash c with Not_found -> assert false
in
XDot.read_cluster_layout attrs
end
let model = new model
end
(* Runs graphviz, parses the graph and instantiates the model *)
let read_dot ?(cmd="dot") dot_file =
let basename = try Filename.chop_extension dot_file
with Invalid_argument _ -> dot_file in
let xdot_file = basename ^ ".xdot" in
let dot_cmd = Printf.sprintf "%s -Txdot %s > %s" cmd dot_file xdot_file in
(* Run graphviz *)
match Sys.command dot_cmd with
| 0 -> begin
let graph, bb, clusters_hash =
DotParser.parse_bounding_box_and_clusters xdot_file in
DotModel.model graph clusters_hash (XDot.read_bounding_box bb)
end
| _ -> raise (DotError "Error during dot execution")
(* Does not run graphviz.
Parses a graph from an xdot file and instantiates the model. *)
let read_xdot xdot_file =
let graph, bb, clusters_hash =
DotParser.parse_bounding_box_and_clusters xdot_file
in
DotModel.model graph clusters_hash (XDot.read_bounding_box bb)
|