/usr/share/doc/libghc-graphviz-doc/html/src/Data-GraphViz.html is in libghc-graphviz-doc 2999.18.1.2-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>Data/GraphViz.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE CPP, FlexibleContexts, MultiParamTypeClasses, OverloadedStrings #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>{- |
<a name="line-4"></a> Module : Data.GraphViz
<a name="line-5"></a> Description : Graphviz bindings for Haskell.
<a name="line-6"></a> Copyright : (c) Matthew Sackman, Ivan Lazar Miljenovic
<a name="line-7"></a> License : 3-Clause BSD-style
<a name="line-8"></a> Maintainer : Ivan.Miljenovic@gmail.com
<a name="line-9"></a>
<a name="line-10"></a> This is the top-level module for the graphviz library. It provides
<a name="line-11"></a> functions to convert 'Data.Graph.Inductive.Graph.Graph's into the
<a name="line-12"></a> /Dot/ language used by the /Graphviz/ suite of programs (as well as a
<a name="line-13"></a> limited ability to perform the reverse operation).
<a name="line-14"></a>
<a name="line-15"></a> If you wish to construct a Haskell representation of a Dot graph
<a name="line-16"></a> yourself rather than using the conversion functions here, please
<a name="line-17"></a> see the "Data.GraphViz.Types" module as a starting point for how to
<a name="line-18"></a> do so.
<a name="line-19"></a>
<a name="line-20"></a> Information about Graphviz and the Dot language can be found at:
<a name="line-21"></a> <<a href="http://graphviz.org/">http://graphviz.org/</a>>
<a name="line-22"></a> -}</span>
<a name="line-23"></a>
<a name="line-24"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span>
<a name="line-25"></a> <span class='hs-layout'>(</span> <span class='hs-comment'>-- * Conversion from graphs to /Dot/ format.</span>
<a name="line-26"></a> <span class='hs-comment'>-- ** Specifying parameters.</span>
<a name="line-27"></a> <span class='hs-comment'>-- $params</span>
<a name="line-28"></a> <span class='hs-conid'>GraphvizParams</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-29"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>defaultParams</span>
<a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>nonClusteredParams</span>
<a name="line-31"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>blankParams</span>
<a name="line-32"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>setDirectedness</span>
<a name="line-33"></a> <span class='hs-comment'>-- *** Specifying clusters.</span>
<a name="line-34"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>NodeCluster</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-35"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>LNodeCluster</span>
<a name="line-36"></a> <span class='hs-comment'>-- ** Converting graphs.</span>
<a name="line-37"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>graphToDot</span>
<a name="line-38"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>graphElemsToDot</span>
<a name="line-39"></a> <span class='hs-comment'>-- ** Pseudo-inverse conversion.</span>
<a name="line-40"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>dotToGraph</span>
<a name="line-41"></a> <span class='hs-comment'>-- * Graph augmentation.</span>
<a name="line-42"></a> <span class='hs-comment'>-- $augment</span>
<a name="line-43"></a> <span class='hs-comment'>-- ** Type aliases for @Node@ and @Edge@ labels.</span>
<a name="line-44"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>AttributeNode</span>
<a name="line-45"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>AttributeEdge</span>
<a name="line-46"></a> <span class='hs-comment'>-- ** Customisable augmentation.</span>
<a name="line-47"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>graphToGraph</span>
<a name="line-48"></a> <span class='hs-comment'>-- ** Quick augmentation.</span>
<a name="line-49"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>dotizeGraph</span>
<a name="line-50"></a> <span class='hs-comment'>-- ** Manual augmentation.</span>
<a name="line-51"></a> <span class='hs-comment'>-- $manualAugment</span>
<a name="line-52"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>EdgeID</span>
<a name="line-53"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>addEdgeIDs</span>
<a name="line-54"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>setEdgeIDAttribute</span>
<a name="line-55"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>dotAttributes</span>
<a name="line-56"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>augmentGraph</span>
<a name="line-57"></a> <span class='hs-comment'>-- * Utility functions</span>
<a name="line-58"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>preview</span>
<a name="line-59"></a> <span class='hs-comment'>-- * Re-exporting other modules.</span>
<a name="line-60"></a> <span class='hs-layout'>,</span> <span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-61"></a> <span class='hs-layout'>,</span> <span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span><span class='hs-varop'>.</span><span class='hs-conid'>Canonical</span>
<a name="line-62"></a> <span class='hs-layout'>,</span> <span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Attributes</span>
<a name="line-63"></a> <span class='hs-layout'>,</span> <span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Commands</span>
<a name="line-64"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-65"></a>
<a name="line-66"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Algorithms</span><span class='hs-varop'>.</span><span class='hs-conid'>Clustering</span>
<a name="line-67"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Attributes</span>
<a name="line-68"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Attributes</span><span class='hs-varop'>.</span><span class='hs-conid'>Complete</span> <span class='hs-layout'>(</span><span class='hs-conid'>AttributeName</span><span class='hs-layout'>,</span> <span class='hs-conid'>CustomAttribute</span><span class='hs-layout'>,</span>
<a name="line-69"></a> <span class='hs-varid'>customAttribute</span><span class='hs-layout'>,</span> <span class='hs-varid'>customValue</span><span class='hs-layout'>,</span>
<a name="line-70"></a> <span class='hs-varid'>findSpecifiedCustom</span><span class='hs-layout'>)</span>
<a name="line-71"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Commands</span>
<a name="line-72"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Commands</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-varid'>hGetDot</span><span class='hs-layout'>)</span>
<a name="line-73"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span><span class='hs-varop'>.</span><span class='hs-conid'>Util</span> <span class='hs-layout'>(</span><span class='hs-varid'>uniq</span><span class='hs-layout'>,</span> <span class='hs-varid'>uniqBy</span><span class='hs-layout'>)</span>
<a name="line-74"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-75"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span><span class='hs-varop'>.</span><span class='hs-conid'>Canonical</span> <span class='hs-layout'>(</span><span class='hs-conid'>DotGraph</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>DotStatements</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-76"></a> <span class='hs-conid'>DotSubGraph</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-77"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>GraphViz</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span><span class='hs-varop'>.</span><span class='hs-conid'>Generalised</span> <span class='hs-layout'>(</span><span class='hs-conid'>FromGeneralisedDot</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-78"></a>
<a name="line-79"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Arrow</span> <span class='hs-layout'>(</span><span class='hs-varid'>first</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>&&&</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-80"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Concurrent</span> <span class='hs-layout'>(</span><span class='hs-varid'>forkIO</span><span class='hs-layout'>)</span>
<a name="line-81"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Graph</span><span class='hs-varop'>.</span><span class='hs-conid'>Inductive</span><span class='hs-varop'>.</span><span class='hs-conid'>Graph</span>
<a name="line-82"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Map</span>
<a name="line-83"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromJust</span><span class='hs-layout'>,</span> <span class='hs-varid'>mapMaybe</span><span class='hs-layout'>)</span>
<a name="line-84"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Set</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Set</span>
<a name="line-85"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span> <span class='hs-layout'>(</span><span class='hs-conid'>Text</span><span class='hs-layout'>)</span>
<a name="line-86"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>T</span>
<a name="line-87"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Unsafe</span> <span class='hs-layout'>(</span><span class='hs-varid'>unsafePerformIO</span><span class='hs-layout'>)</span>
<a name="line-88"></a>
<a name="line-89"></a><span class='hs-cpp'>#if !(MIN_VERSION_base (4,8,0))</span>
<a name="line-90"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Functor</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varop'><$></span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-91"></a><span class='hs-cpp'>#endif</span>
<a name="line-92"></a>
<a name="line-93"></a><span class='hs-comment'>-- -----------------------------------------------------------------------------</span>
<a name="line-94"></a>
<a name="line-95"></a><a name="isUndirected"></a><span class='hs-comment'>-- | Determine if the given graph is undirected.</span>
<a name="line-96"></a><span class='hs-definition'>isUndirected</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ord</span> <span class='hs-varid'>b</span><span class='hs-layout'>,</span> <span class='hs-conid'>Graph</span> <span class='hs-varid'>g</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>g</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span>
<a name="line-97"></a><span class='hs-definition'>isUndirected</span> <span class='hs-varid'>g</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>all</span> <span class='hs-varid'>hasFlip</span> <span class='hs-varid'>es</span>
<a name="line-98"></a> <span class='hs-keyword'>where</span>
<a name="line-99"></a> <span class='hs-varid'>es</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>labEdges</span> <span class='hs-varid'>g</span>
<a name="line-100"></a> <span class='hs-varid'>eSet</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Set</span><span class='hs-varop'>.</span><span class='hs-varid'>fromList</span> <span class='hs-varid'>es</span>
<a name="line-101"></a> <span class='hs-varid'>hasFlip</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Set</span><span class='hs-varop'>.</span><span class='hs-varid'>member</span> <span class='hs-layout'>(</span><span class='hs-varid'>flippedEdge</span> <span class='hs-varid'>e</span><span class='hs-layout'>)</span> <span class='hs-varid'>eSet</span>
<a name="line-102"></a> <span class='hs-varid'>flippedEdge</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span><span class='hs-layout'>,</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span><span class='hs-varid'>l</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span><span class='hs-varid'>f</span><span class='hs-layout'>,</span><span class='hs-varid'>l</span><span class='hs-layout'>)</span>
<a name="line-103"></a>
<a name="line-104"></a><span class='hs-comment'>-- -----------------------------------------------------------------------------</span>
<a name="line-105"></a>
<a name="line-106"></a><span class='hs-comment'>{- $params
<a name="line-107"></a>
<a name="line-108"></a> A 'GraphvizParams' value contains all the information necessary to
<a name="line-109"></a> manipulate 'Graph's with this library. As such, its components deal
<a name="line-110"></a> with:
<a name="line-111"></a>
<a name="line-112"></a> * Whether to treat graphs as being directed or not;
<a name="line-113"></a>
<a name="line-114"></a> * Which top-level 'GlobalAttributes' values should be applied;
<a name="line-115"></a>
<a name="line-116"></a> * How to define (and name) clusters;
<a name="line-117"></a>
<a name="line-118"></a> * How to format clusters, nodes and edges.
<a name="line-119"></a>
<a name="line-120"></a> Apart from not having to pass multiple values around, another
<a name="line-121"></a> advantage of using 'GraphvizParams' over the previous approach is that
<a name="line-122"></a> there is no distinction between clustering and non-clustering variants
<a name="line-123"></a> of the same functions.
<a name="line-124"></a>
<a name="line-125"></a> Example usages of 'GraphvizParams' follow:
<a name="line-126"></a>
<a name="line-127"></a> * Quickly visualise a graph using the default parameters. Note the
<a name="line-128"></a> usage of @'nonClusteredParams'@ over @'defaultParams'@ to avoid
<a name="line-129"></a> type-checking problems with the cluster type.
<a name="line-130"></a>
<a name="line-131"></a> > defaultVis :: (Graph gr) => gr nl el -> DotGraph Node
<a name="line-132"></a> > defaultVis = graphToDot nonClusteredParams
<a name="line-133"></a>
<a name="line-134"></a> * As with @defaultVis@, but determine whether or not the graph is
<a name="line-135"></a> directed or undirected.
<a name="line-136"></a>
<a name="line-137"></a> > checkDirectednessVis :: (Graph gr, Ord el) => gr nl el -> DotGraph Node
<a name="line-138"></a> > checkDirectednessVis = setDirectedness graphToDot nonClusteredParams
<a name="line-139"></a>
<a name="line-140"></a> * Clustering nodes based upon whether they are even or odd. We
<a name="line-141"></a> have the option of either constructing a @GraphvizParams@
<a name="line-142"></a> directly, or using @'blankParams'@. Using the latter to avoid
<a name="line-143"></a> setting @'isDirected'@:
<a name="line-144"></a>
<a name="line-145"></a> > evenOdd :: (Graph gr, Ord el) => gr Int el -> DotGraph Node
<a name="line-146"></a> > evenOdd = setDirectedness graphToDot params
<a name="line-147"></a> > where
<a name="line-148"></a> > params = blankParams { globalAttributes = []
<a name="line-149"></a> > , clusterBy = clustBy
<a name="line-150"></a> > , clusterID = Num . Int
<a name="line-151"></a> > , fmtCluster = clFmt
<a name="line-152"></a> > , fmtNode = const []
<a name="line-153"></a> > , fmtEdge = const []
<a name="line-154"></a> > }
<a name="line-155"></a> > clustBy (n,l) = C (n `mod` 2) $ N (n,l)
<a name="line-156"></a> > clFmt m = [GraphAttrs [toLabel $ "n == " ++ show m ++ " (mod 2)"]]
<a name="line-157"></a>
<a name="line-158"></a> For more examples, see the source of 'dotizeGraph' and 'preview'.
<a name="line-159"></a>
<a name="line-160"></a> -}</span>
<a name="line-161"></a>
<a name="line-162"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- | Defines the parameters used to convert a 'Graph' into a 'DotRepr'.</span>
<a name="line-163"></a><a name="GraphvizParams"></a><span class='hs-comment'>--</span>
<a name="line-164"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- A value of type @'GraphvizParams' n nl el cl l@ indicates that</span>
<a name="line-165"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- the 'Graph' has a node type of @n@, node labels of type @nl@,</span>
<a name="line-166"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- edge labels of type @el@, corresponding clusters of type @cl@ and</span>
<a name="line-167"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- after clustering the nodes have a label of type @l@ (which may or</span>
<a name="line-168"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- may not be the same as @nl@).</span>
<a name="line-169"></a><a name="GraphvizParams"></a><span class='hs-comment'>--</span>
<a name="line-170"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- The tuples in the function types represent labelled nodes (for</span>
<a name="line-171"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- @(n,nl)@ and @(n,l)@) and labelled edges (@(n,n,el)@; the value</span>
<a name="line-172"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- @(f,t,ftl)@ is an edge from @f@ to @l@ with a label of @ftl@).</span>
<a name="line-173"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- These correspond to 'LNode' and 'LEdge' in FGL graphs.</span>
<a name="line-174"></a><a name="GraphvizParams"></a><span class='hs-comment'>--</span>
<a name="line-175"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- The clustering in 'clusterBy' can be to arbitrary depth.</span>
<a name="line-176"></a><a name="GraphvizParams"></a><span class='hs-comment'>--</span>
<a name="line-177"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- Note that the term \"cluster\" is slightly conflated here: in</span>
<a name="line-178"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- terms of @GraphvizParams@ values, a cluster is a grouping of</span>
<a name="line-179"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- nodes; the 'isDotCluster' function lets you specify whether it is</span>
<a name="line-180"></a><a name="GraphvizParams"></a><span class='hs-comment'>-- a cluster in the Dot sense or just a sub-graph.</span>
<a name="line-181"></a><a name="GraphvizParams"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>GraphvizParams</span> <span class='hs-varid'>n</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-varid'>cl</span> <span class='hs-varid'>l</span>
<a name="line-182"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Params</span> <span class='hs-layout'>{</span> <span class='hs-comment'>-- | @True@ if the graph is directed; @False@</span>
<a name="line-183"></a> <span class='hs-comment'>-- otherwise.</span>
<a name="line-184"></a> <span class='hs-varid'>isDirected</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span>
<a name="line-185"></a> <span class='hs-comment'>-- | The top-level global 'Attributes' for the entire</span>
<a name="line-186"></a> <span class='hs-comment'>-- graph.</span>
<a name="line-187"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>globalAttributes</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>GlobalAttributes</span><span class='hs-keyglyph'>]</span>
<a name="line-188"></a> <span class='hs-comment'>-- | A function to specify which cluster a particular</span>
<a name="line-189"></a> <span class='hs-comment'>-- node is in.</span>
<a name="line-190"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>clusterBy</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span><span class='hs-varid'>nl</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>NodeCluster</span> <span class='hs-varid'>cl</span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span><span class='hs-varid'>l</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-191"></a> <span class='hs-comment'>-- | Is this \"cluster\" actually a cluster, or just a</span>
<a name="line-192"></a> <span class='hs-comment'>-- sub-graph?</span>
<a name="line-193"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>isDotCluster</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varid'>cl</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span><span class='hs-layout'>)</span>
<a name="line-194"></a> <span class='hs-comment'>-- | The name/identifier for a cluster.</span>
<a name="line-195"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>clusterID</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varid'>cl</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>GraphID</span><span class='hs-layout'>)</span>
<a name="line-196"></a> <span class='hs-comment'>-- | Specify which global attributes are applied in</span>
<a name="line-197"></a> <span class='hs-comment'>-- the given cluster.</span>
<a name="line-198"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtCluster</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varid'>cl</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>GlobalAttributes</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-199"></a> <span class='hs-comment'>-- | The specific @Attributes@ for a node.</span>
<a name="line-200"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtNode</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span><span class='hs-varid'>l</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Attributes</span><span class='hs-layout'>)</span>
<a name="line-201"></a> <span class='hs-comment'>-- | The specific @Attributes@ for an edge.</span>
<a name="line-202"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtEdge</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span><span class='hs-varid'>el</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Attributes</span><span class='hs-layout'>)</span>
<a name="line-203"></a> <span class='hs-layout'>}</span>
<a name="line-204"></a>
<a name="line-205"></a>
<a name="line-206"></a><a name="LNodeCluster"></a><span class='hs-comment'>-- | An alias for 'NodeCluster' when dealing with FGL graphs.</span>
<a name="line-207"></a><a name="LNodeCluster"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>LNodeCluster</span> <span class='hs-varid'>cl</span> <span class='hs-varid'>l</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>NodeCluster</span> <span class='hs-varid'>cl</span> <span class='hs-layout'>(</span><span class='hs-conid'>Node</span><span class='hs-layout'>,</span><span class='hs-varid'>l</span><span class='hs-layout'>)</span>
<a name="line-208"></a>
<a name="line-209"></a><a name="defaultParams"></a><span class='hs-comment'>-- | A default 'GraphvizParams' value which assumes the graph is</span>
<a name="line-210"></a><span class='hs-comment'>-- directed, contains no clusters and has no 'Attribute's set.</span>
<a name="line-211"></a><span class='hs-comment'>--</span>
<a name="line-212"></a><span class='hs-comment'>-- If you wish to have the labels of the nodes to have a different</span>
<a name="line-213"></a><span class='hs-comment'>-- type after applying 'clusterBy' from before clustering, then you</span>
<a name="line-214"></a><span class='hs-comment'>-- will have to specify your own 'GraphvizParams' value from</span>
<a name="line-215"></a><span class='hs-comment'>-- scratch (or use 'blankParams').</span>
<a name="line-216"></a><span class='hs-comment'>--</span>
<a name="line-217"></a><span class='hs-comment'>-- If you use a custom 'clusterBy' function (which if you actually</span>
<a name="line-218"></a><span class='hs-comment'>-- want clusters you should) then you should also override the</span>
<a name="line-219"></a><span class='hs-comment'>-- (nonsensical) default 'clusterID'.</span>
<a name="line-220"></a><span class='hs-definition'>defaultParams</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GraphvizParams</span> <span class='hs-varid'>n</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-varid'>cl</span> <span class='hs-varid'>nl</span>
<a name="line-221"></a><span class='hs-definition'>defaultParams</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Params</span> <span class='hs-layout'>{</span> <span class='hs-varid'>isDirected</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>True</span>
<a name="line-222"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>globalAttributes</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span>
<a name="line-223"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>clusterBy</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>N</span>
<a name="line-224"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>isDotCluster</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>const</span> <span class='hs-conid'>True</span>
<a name="line-225"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>clusterID</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>const</span> <span class='hs-layout'>(</span><span class='hs-conid'>Num</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Int</span> <span class='hs-num'>0</span><span class='hs-layout'>)</span>
<a name="line-226"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtCluster</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>const</span> <span class='hs-conid'>[]</span>
<a name="line-227"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtNode</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>const</span> <span class='hs-conid'>[]</span>
<a name="line-228"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtEdge</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>const</span> <span class='hs-conid'>[]</span>
<a name="line-229"></a> <span class='hs-layout'>}</span>
<a name="line-230"></a>
<a name="line-231"></a><a name="nonClusteredParams"></a><span class='hs-comment'>-- | A variant of 'defaultParams' that enforces that the clustering</span>
<a name="line-232"></a><span class='hs-comment'>-- type is @'()'@ (i.e.: no clustering); this avoids problems when</span>
<a name="line-233"></a><span class='hs-comment'>-- using 'defaultParams' internally within a function without any</span>
<a name="line-234"></a><span class='hs-comment'>-- constraint on what the clustering type is.</span>
<a name="line-235"></a><span class='hs-definition'>nonClusteredParams</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GraphvizParams</span> <span class='hs-varid'>n</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-conid'>()</span> <span class='hs-varid'>nl</span>
<a name="line-236"></a><span class='hs-definition'>nonClusteredParams</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>defaultParams</span>
<a name="line-237"></a>
<a name="line-238"></a><a name="blankParams"></a><span class='hs-comment'>-- | A 'GraphvizParams' value where every field is set to</span>
<a name="line-239"></a><span class='hs-comment'>-- @'undefined'@. This is useful when you have a function that will</span>
<a name="line-240"></a><span class='hs-comment'>-- set some of the values for you (e.g. 'setDirectedness') but you</span>
<a name="line-241"></a><span class='hs-comment'>-- don't want to bother thinking of default values to set in the</span>
<a name="line-242"></a><span class='hs-comment'>-- meantime. This is especially useful when you are</span>
<a name="line-243"></a><span class='hs-comment'>-- programmatically setting the clustering function (and as such do</span>
<a name="line-244"></a><span class='hs-comment'>-- not know what the types might be).</span>
<a name="line-245"></a><span class='hs-definition'>blankParams</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GraphvizParams</span> <span class='hs-varid'>n</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-varid'>cl</span> <span class='hs-varid'>l</span>
<a name="line-246"></a><span class='hs-definition'>blankParams</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Params</span> <span class='hs-layout'>{</span> <span class='hs-varid'>isDirected</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>undefined</span>
<a name="line-247"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>globalAttributes</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>undefined</span>
<a name="line-248"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>clusterBy</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>undefined</span>
<a name="line-249"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>isDotCluster</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>undefined</span>
<a name="line-250"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>clusterID</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>undefined</span>
<a name="line-251"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtCluster</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>undefined</span>
<a name="line-252"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtNode</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>undefined</span>
<a name="line-253"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtEdge</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>undefined</span>
<a name="line-254"></a> <span class='hs-layout'>}</span>
<a name="line-255"></a>
<a name="line-256"></a><a name="setDirectedness"></a><span class='hs-comment'>-- | Determine if the provided 'Graph' is directed or not and set the</span>
<a name="line-257"></a><span class='hs-comment'>-- value of 'isDirected' appropriately.</span>
<a name="line-258"></a><span class='hs-definition'>setDirectedness</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ord</span> <span class='hs-varid'>el</span><span class='hs-layout'>,</span> <span class='hs-conid'>Graph</span> <span class='hs-varid'>gr</span><span class='hs-layout'>)</span>
<a name="line-259"></a> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-conid'>GraphvizParams</span> <span class='hs-conid'>Node</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-varid'>cl</span> <span class='hs-varid'>l</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>gr</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-260"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>GraphvizParams</span> <span class='hs-conid'>Node</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-varid'>cl</span> <span class='hs-varid'>l</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>gr</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span>
<a name="line-261"></a><span class='hs-definition'>setDirectedness</span> <span class='hs-varid'>f</span> <span class='hs-varid'>params</span> <span class='hs-varid'>gr</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>f</span> <span class='hs-varid'>params'</span> <span class='hs-varid'>gr</span>
<a name="line-262"></a> <span class='hs-keyword'>where</span>
<a name="line-263"></a> <span class='hs-varid'>params'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>params</span> <span class='hs-layout'>{</span> <span class='hs-varid'>isDirected</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>not</span> <span class='hs-varop'>$</span> <span class='hs-varid'>isUndirected</span> <span class='hs-varid'>gr</span> <span class='hs-layout'>}</span>
<a name="line-264"></a>
<a name="line-265"></a><a name="graphToDot"></a><span class='hs-comment'>-- | Convert a graph to /Dot/ format, using the specified parameters</span>
<a name="line-266"></a><span class='hs-comment'>-- to cluster the graph, etc.</span>
<a name="line-267"></a><span class='hs-definition'>graphToDot</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ord</span> <span class='hs-varid'>cl</span><span class='hs-layout'>,</span> <span class='hs-conid'>Graph</span> <span class='hs-varid'>gr</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>GraphvizParams</span> <span class='hs-conid'>Node</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-varid'>cl</span> <span class='hs-varid'>l</span>
<a name="line-268"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>gr</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>DotGraph</span> <span class='hs-conid'>Node</span>
<a name="line-269"></a><span class='hs-definition'>graphToDot</span> <span class='hs-varid'>params</span> <span class='hs-varid'>graph</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>graphElemsToDot</span> <span class='hs-varid'>params</span> <span class='hs-layout'>(</span><span class='hs-varid'>labNodes</span> <span class='hs-varid'>graph</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>labEdges</span> <span class='hs-varid'>graph</span><span class='hs-layout'>)</span>
<a name="line-270"></a>
<a name="line-271"></a><a name="graphElemsToDot"></a><span class='hs-comment'>-- | As with 'graphToDot', but this allows you to easily convert other</span>
<a name="line-272"></a><span class='hs-comment'>-- graph-like formats to a Dot graph as long as you can get a list</span>
<a name="line-273"></a><span class='hs-comment'>-- of nodes and edges from it.</span>
<a name="line-274"></a><span class='hs-definition'>graphElemsToDot</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ord</span> <span class='hs-varid'>cl</span><span class='hs-layout'>,</span> <span class='hs-conid'>Ord</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>GraphvizParams</span> <span class='hs-varid'>n</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-varid'>cl</span> <span class='hs-varid'>l</span>
<a name="line-275"></a> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span><span class='hs-varid'>nl</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span><span class='hs-varid'>el</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>DotGraph</span> <span class='hs-varid'>n</span>
<a name="line-276"></a><span class='hs-definition'>graphElemsToDot</span> <span class='hs-varid'>params</span> <span class='hs-varid'>lns</span> <span class='hs-varid'>les</span>
<a name="line-277"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DotGraph</span> <span class='hs-layout'>{</span> <span class='hs-varid'>strictGraph</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>False</span>
<a name="line-278"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>directedGraph</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>dirGraph</span>
<a name="line-279"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>graphID</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Nothing</span>
<a name="line-280"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>graphStatements</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>stmts</span>
<a name="line-281"></a> <span class='hs-layout'>}</span>
<a name="line-282"></a> <span class='hs-keyword'>where</span>
<a name="line-283"></a> <span class='hs-varid'>dirGraph</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>isDirected</span> <span class='hs-varid'>params</span>
<a name="line-284"></a> <span class='hs-varid'>stmts</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DotStmts</span> <span class='hs-layout'>{</span> <span class='hs-varid'>attrStmts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>globalAttributes</span> <span class='hs-varid'>params</span>
<a name="line-285"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>subGraphs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>cs</span>
<a name="line-286"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>nodeStmts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ns</span>
<a name="line-287"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>edgeStmts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>es</span>
<a name="line-288"></a> <span class='hs-layout'>}</span>
<a name="line-289"></a> <span class='hs-layout'>(</span><span class='hs-varid'>cs</span><span class='hs-layout'>,</span> <span class='hs-varid'>ns</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>clustersToNodes</span> <span class='hs-layout'>(</span><span class='hs-varid'>clusterBy</span> <span class='hs-varid'>params</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>isDotCluster</span> <span class='hs-varid'>params</span><span class='hs-layout'>)</span>
<a name="line-290"></a> <span class='hs-layout'>(</span><span class='hs-varid'>clusterID</span> <span class='hs-varid'>params</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>fmtCluster</span> <span class='hs-varid'>params</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>fmtNode</span> <span class='hs-varid'>params</span><span class='hs-layout'>)</span>
<a name="line-291"></a> <span class='hs-varid'>lns</span>
<a name="line-292"></a> <span class='hs-varid'>es</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mapMaybe</span> <span class='hs-varid'>mkDotEdge</span> <span class='hs-varid'>les</span>
<a name="line-293"></a> <span class='hs-varid'>mkDotEdge</span> <span class='hs-varid'>e</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-varid'>f</span><span class='hs-layout'>,</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span><span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>dirGraph</span> <span class='hs-varop'>||</span> <span class='hs-varid'>f</span> <span class='hs-varop'><=</span> <span class='hs-varid'>t</span>
<a name="line-294"></a> <span class='hs-keyword'>then</span> <span class='hs-conid'>Just</span>
<a name="line-295"></a> <span class='hs-conid'>DotEdge</span> <span class='hs-layout'>{</span> <span class='hs-varid'>fromNode</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>f</span>
<a name="line-296"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toNode</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>t</span>
<a name="line-297"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>edgeAttributes</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fmtEdge</span> <span class='hs-varid'>params</span> <span class='hs-varid'>e</span>
<a name="line-298"></a> <span class='hs-layout'>}</span>
<a name="line-299"></a> <span class='hs-keyword'>else</span> <span class='hs-conid'>Nothing</span>
<a name="line-300"></a>
<a name="line-301"></a><a name="dotToGraph"></a><span class='hs-comment'>-- | A pseudo-inverse to 'graphToDot'; \"pseudo\" in the sense that</span>
<a name="line-302"></a><span class='hs-comment'>-- the original node and edge labels aren't able to be</span>
<a name="line-303"></a><span class='hs-comment'>-- reconstructed.</span>
<a name="line-304"></a><span class='hs-definition'>dotToGraph</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>DotRepr</span> <span class='hs-varid'>dg</span> <span class='hs-conid'>Node</span><span class='hs-layout'>,</span> <span class='hs-conid'>Graph</span> <span class='hs-varid'>gr</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>dg</span> <span class='hs-conid'>Node</span>
<a name="line-305"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>gr</span> <span class='hs-conid'>Attributes</span> <span class='hs-conid'>Attributes</span>
<a name="line-306"></a><span class='hs-definition'>dotToGraph</span> <span class='hs-varid'>dg</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkGraph</span> <span class='hs-varid'>ns'</span> <span class='hs-varid'>es</span>
<a name="line-307"></a> <span class='hs-keyword'>where</span>
<a name="line-308"></a> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>graphIsDirected</span> <span class='hs-varid'>dg</span>
<a name="line-309"></a> <span class='hs-comment'>-- Applying uniqBy just in case...</span>
<a name="line-310"></a> <span class='hs-varid'>ns</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>uniqBy</span> <span class='hs-varid'>fst</span> <span class='hs-varop'>.</span> <span class='hs-varid'>map</span> <span class='hs-varid'>toLN</span> <span class='hs-varop'>$</span> <span class='hs-varid'>graphNodes</span> <span class='hs-varid'>dg</span>
<a name="line-311"></a> <span class='hs-varid'>es</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>concatMap</span> <span class='hs-varid'>toLE</span> <span class='hs-varop'>$</span> <span class='hs-varid'>graphEdges</span> <span class='hs-varid'>dg</span>
<a name="line-312"></a> <span class='hs-comment'>-- Need to check that for some reason there aren't node IDs in an</span>
<a name="line-313"></a> <span class='hs-comment'>-- edge but not on their own.</span>
<a name="line-314"></a> <span class='hs-varid'>nSet</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Set</span><span class='hs-varop'>.</span><span class='hs-varid'>fromList</span> <span class='hs-varop'>$</span> <span class='hs-varid'>map</span> <span class='hs-varid'>fst</span> <span class='hs-varid'>ns</span>
<a name="line-315"></a> <span class='hs-varid'>nEs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-varid'>flip</span> <span class='hs-conid'>(,)</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span>
<a name="line-316"></a> <span class='hs-varop'>.</span> <span class='hs-varid'>uniq</span>
<a name="line-317"></a> <span class='hs-varop'>.</span> <span class='hs-varid'>filter</span> <span class='hs-layout'>(</span><span class='hs-varop'>`</span><span class='hs-conid'>Set</span><span class='hs-varop'>.</span><span class='hs-varid'>notMember</span><span class='hs-varop'>`</span> <span class='hs-varid'>nSet</span><span class='hs-layout'>)</span>
<a name="line-318"></a> <span class='hs-varop'>$</span> <span class='hs-varid'>concatMap</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>n1</span><span class='hs-layout'>,</span><span class='hs-varid'>n2</span><span class='hs-layout'>,</span><span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>n1</span><span class='hs-layout'>,</span><span class='hs-varid'>n2</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-varid'>es</span>
<a name="line-319"></a> <span class='hs-varid'>ns'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ns</span> <span class='hs-varop'>++</span> <span class='hs-varid'>nEs</span>
<a name="line-320"></a> <span class='hs-comment'>-- Conversion functions</span>
<a name="line-321"></a> <span class='hs-varid'>toLN</span> <span class='hs-layout'>(</span><span class='hs-conid'>DotNode</span> <span class='hs-varid'>n</span> <span class='hs-keyword'>as</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span><span class='hs-keyword'>as</span><span class='hs-layout'>)</span>
<a name="line-322"></a> <span class='hs-varid'>toLE</span> <span class='hs-layout'>(</span><span class='hs-conid'>DotEdge</span> <span class='hs-varid'>f</span> <span class='hs-varid'>t</span> <span class='hs-keyword'>as</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-keyword'>if</span> <span class='hs-varid'>d</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>id</span> <span class='hs-keyword'>else</span> <span class='hs-layout'>(</span><span class='hs-conop'>:</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span><span class='hs-varid'>f</span><span class='hs-layout'>,</span><span class='hs-keyword'>as</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>f</span><span class='hs-layout'>,</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span><span class='hs-keyword'>as</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-323"></a>
<a name="line-324"></a><span class='hs-comment'>-- -----------------------------------------------------------------------------</span>
<a name="line-325"></a>
<a name="line-326"></a><span class='hs-comment'>{- $augment
<a name="line-327"></a> The following functions provide support for passing a 'Graph'
<a name="line-328"></a> through the appropriate 'GraphvizCommand' to augment the 'Graph' by
<a name="line-329"></a> adding positional information, etc.
<a name="line-330"></a>
<a name="line-331"></a> A 'CustomAttribute' is used to distinguish multiple edges between
<a name="line-332"></a> two nodes from each other.
<a name="line-333"></a>
<a name="line-334"></a> Note that the reason that most of these functions do not have
<a name="line-335"></a> 'unsafePerformIO' applied to them is because if you set a global
<a name="line-336"></a> 'Attribute' of:
<a name="line-337"></a>
<a name="line-338"></a> @
<a name="line-339"></a> 'Start' ('StartStyle' 'RandomStyle')
<a name="line-340"></a> @
<a name="line-341"></a>
<a name="line-342"></a> then it will not necessarily be referentially transparent (ideally,
<a name="line-343"></a> no matter what the seed is, it will still eventually be drawn to the
<a name="line-344"></a> same optimum, but this can't be guaranteed). As such, if you are sure
<a name="line-345"></a> that you're not using such an 'Attribute', then you should be able to
<a name="line-346"></a> use 'unsafePerformIO' directly in your own code.
<a name="line-347"></a>-}</span>
<a name="line-348"></a>
<a name="line-349"></a><a name="AttributeNode"></a><span class='hs-comment'>-- | Augment the current node label type with the 'Attributes' applied</span>
<a name="line-350"></a><a name="AttributeNode"></a><span class='hs-comment'>-- to that node.</span>
<a name="line-351"></a><a name="AttributeNode"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>AttributeNode</span> <span class='hs-varid'>nl</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>Attributes</span><span class='hs-layout'>,</span> <span class='hs-varid'>nl</span><span class='hs-layout'>)</span>
<a name="line-352"></a>
<a name="line-353"></a><a name="AttributeEdge"></a><span class='hs-comment'>-- | Augment the current edge label type with the 'Attributes' applied</span>
<a name="line-354"></a><a name="AttributeEdge"></a><span class='hs-comment'>-- to that edge.</span>
<a name="line-355"></a><a name="AttributeEdge"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>AttributeEdge</span> <span class='hs-varid'>el</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>Attributes</span><span class='hs-layout'>,</span> <span class='hs-varid'>el</span><span class='hs-layout'>)</span>
<a name="line-356"></a>
<a name="line-357"></a><a name="graphToGraph"></a><span class='hs-comment'>-- | Run the appropriate Graphviz command on the graph to get</span>
<a name="line-358"></a><span class='hs-comment'>-- positional information and then combine that information back</span>
<a name="line-359"></a><span class='hs-comment'>-- into the original graph.</span>
<a name="line-360"></a><span class='hs-definition'>graphToGraph</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ord</span> <span class='hs-varid'>cl</span><span class='hs-layout'>,</span> <span class='hs-conid'>Graph</span> <span class='hs-varid'>gr</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>GraphvizParams</span> <span class='hs-conid'>Node</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-varid'>cl</span> <span class='hs-varid'>l</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>gr</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span>
<a name="line-361"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-varid'>gr</span> <span class='hs-layout'>(</span><span class='hs-conid'>AttributeNode</span> <span class='hs-varid'>nl</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>AttributeEdge</span> <span class='hs-varid'>el</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-362"></a><span class='hs-definition'>graphToGraph</span> <span class='hs-varid'>params</span> <span class='hs-varid'>gr</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>dotAttributes</span> <span class='hs-layout'>(</span><span class='hs-varid'>isDirected</span> <span class='hs-varid'>params</span><span class='hs-layout'>)</span> <span class='hs-varid'>gr'</span> <span class='hs-varid'>dot</span>
<a name="line-363"></a> <span class='hs-keyword'>where</span>
<a name="line-364"></a> <span class='hs-varid'>dot</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>graphToDot</span> <span class='hs-varid'>params'</span> <span class='hs-varid'>gr'</span>
<a name="line-365"></a> <span class='hs-varid'>params'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>params</span> <span class='hs-layout'>{</span> <span class='hs-varid'>fmtEdge</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>setEdgeIDAttribute</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fmtEdge</span> <span class='hs-varid'>params</span> <span class='hs-layout'>}</span>
<a name="line-366"></a> <span class='hs-varid'>gr'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>addEdgeIDs</span> <span class='hs-varid'>gr</span>
<a name="line-367"></a>
<a name="line-368"></a><span class='hs-comment'>-- -----------------------------------------------------------------------------</span>
<a name="line-369"></a>
<a name="line-370"></a><a name="dotizeGraph"></a><span class='hs-comment'>-- | This is a \"quick-and-dirty\" graph augmentation function that</span>
<a name="line-371"></a><span class='hs-comment'>-- sets no 'Attributes' and thus should be referentially transparent</span>
<a name="line-372"></a><span class='hs-comment'>-- and is wrapped in 'unsafePerformIO'.</span>
<a name="line-373"></a><span class='hs-comment'>--</span>
<a name="line-374"></a><span class='hs-comment'>-- Note that the provided 'GraphvizParams' is only used for</span>
<a name="line-375"></a><span class='hs-comment'>-- 'isDirected', 'clusterBy' and 'clusterID'.</span>
<a name="line-376"></a><span class='hs-definition'>dotizeGraph</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ord</span> <span class='hs-varid'>cl</span><span class='hs-layout'>,</span> <span class='hs-conid'>Graph</span> <span class='hs-varid'>gr</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>GraphvizParams</span> <span class='hs-conid'>Node</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-varid'>cl</span> <span class='hs-varid'>l</span>
<a name="line-377"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>gr</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>gr</span> <span class='hs-layout'>(</span><span class='hs-conid'>AttributeNode</span> <span class='hs-varid'>nl</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>AttributeEdge</span> <span class='hs-varid'>el</span><span class='hs-layout'>)</span>
<a name="line-378"></a><span class='hs-definition'>dotizeGraph</span> <span class='hs-varid'>params</span> <span class='hs-varid'>gr</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unsafePerformIO</span>
<a name="line-379"></a> <span class='hs-varop'>$</span> <span class='hs-varid'>graphToGraph</span> <span class='hs-varid'>params'</span> <span class='hs-varid'>gr</span>
<a name="line-380"></a> <span class='hs-keyword'>where</span>
<a name="line-381"></a> <span class='hs-varid'>params'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>params</span> <span class='hs-layout'>{</span> <span class='hs-varid'>fmtCluster</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>const</span> <span class='hs-conid'>[]</span>
<a name="line-382"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtNode</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>const</span> <span class='hs-conid'>[]</span>
<a name="line-383"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtEdge</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>const</span> <span class='hs-conid'>[]</span>
<a name="line-384"></a> <span class='hs-layout'>}</span>
<a name="line-385"></a>
<a name="line-386"></a><span class='hs-comment'>-- -----------------------------------------------------------------------------</span>
<a name="line-387"></a>
<a name="line-388"></a><span class='hs-comment'>{- $manualAugment
<a name="line-389"></a>
<a name="line-390"></a> This section allows you to manually augment graphs by providing
<a name="line-391"></a> fine-grained control over the augmentation process (the standard
<a name="line-392"></a> augmentation functions compose these together). Possible reasons for
<a name="line-393"></a> manual augmentation are:
<a name="line-394"></a>
<a name="line-395"></a> * Gain access to the intermediary 'DotRepr' used.
<a name="line-396"></a>
<a name="line-397"></a> * Convert the default 'DotGraph' to a @GDotGraph@ (found in
<a name="line-398"></a> "Data.GraphViz.Types.Generalised") so as to have greater control over
<a name="line-399"></a> the generated Dot code.
<a name="line-400"></a>
<a name="line-401"></a> * Use a specific 'GraphvizCommand' rather than the default.
<a name="line-402"></a>
<a name="line-403"></a> Note that whilst these functions provide you with more control, you
<a name="line-404"></a> must be careful how you use them: if you use the wrong 'DotRepr' for
<a name="line-405"></a> a 'Graph', then the behaviour of 'augmentGraph' (and all functions
<a name="line-406"></a> that use it) is undefined. The main point is to make sure that the
<a name="line-407"></a> defined 'DotNode' and 'DotEdge' values aren't removed (or their ID
<a name="line-408"></a> values - or the 'Attributes' for the 'DotEdge's - altered) to
<a name="line-409"></a> ensure that it is possible to match up the nodes and edges in the
<a name="line-410"></a> 'Graph' with those in the 'DotRepr'.
<a name="line-411"></a>
<a name="line-412"></a>-}</span>
<a name="line-413"></a>
<a name="line-414"></a><a name="EdgeID"></a><span class='hs-comment'>-- | Used to augment an edge label with a unique identifier.</span>
<a name="line-415"></a><a name="EdgeID"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>EdgeID</span> <span class='hs-varid'>el</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>EID</span> <span class='hs-layout'>{</span> <span class='hs-varid'>eID</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Text</span>
<a name="line-416"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>eLbl</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>el</span>
<a name="line-417"></a> <span class='hs-layout'>}</span>
<a name="line-418"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Ord</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-419"></a><span class='hs-comment'>-- Show is only provided for printing/debugging purposes when using a</span>
<a name="line-420"></a><span class='hs-comment'>-- normal Tree-based graph. Since it doesn't support Read, neither</span>
<a name="line-421"></a><span class='hs-comment'>-- does EdgeID.</span>
<a name="line-422"></a>
<a name="line-423"></a><a name="addEdgeIDs"></a><span class='hs-comment'>-- | Add unique edge identifiers to each label. This is useful for</span>
<a name="line-424"></a><span class='hs-comment'>-- when multiple edges between two nodes need to be distinguished.</span>
<a name="line-425"></a><span class='hs-definition'>addEdgeIDs</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Graph</span> <span class='hs-varid'>gr</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>gr</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>gr</span> <span class='hs-varid'>nl</span> <span class='hs-layout'>(</span><span class='hs-conid'>EdgeID</span> <span class='hs-varid'>el</span><span class='hs-layout'>)</span>
<a name="line-426"></a><span class='hs-definition'>addEdgeIDs</span> <span class='hs-varid'>g</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkGraph</span> <span class='hs-varid'>ns</span> <span class='hs-varid'>es'</span>
<a name="line-427"></a> <span class='hs-keyword'>where</span>
<a name="line-428"></a> <span class='hs-varid'>ns</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>labNodes</span> <span class='hs-varid'>g</span>
<a name="line-429"></a> <span class='hs-varid'>es</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>labEdges</span> <span class='hs-varid'>g</span>
<a name="line-430"></a> <span class='hs-varid'>es'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>zipWith</span> <span class='hs-varid'>addID</span> <span class='hs-varid'>es</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-num'>1</span><span class='hs-keyglyph'>..</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Int</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-431"></a> <span class='hs-varid'>addID</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span><span class='hs-layout'>,</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span><span class='hs-varid'>l</span><span class='hs-layout'>)</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span><span class='hs-layout'>,</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span><span class='hs-conid'>EID</span> <span class='hs-layout'>(</span><span class='hs-conid'>T</span><span class='hs-varop'>.</span><span class='hs-varid'>pack</span> <span class='hs-varop'>$</span> <span class='hs-varid'>show</span> <span class='hs-varid'>i</span><span class='hs-layout'>)</span> <span class='hs-varid'>l</span><span class='hs-layout'>)</span>
<a name="line-432"></a>
<a name="line-433"></a><a name="setEdgeIDAttribute"></a><span class='hs-comment'>-- | Add a custom attribute to the list of attributes containing the</span>
<a name="line-434"></a><span class='hs-comment'>-- value of the unique edge identifier.</span>
<a name="line-435"></a><span class='hs-definition'>setEdgeIDAttribute</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>LEdge</span> <span class='hs-varid'>el</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Attributes</span><span class='hs-layout'>)</span>
<a name="line-436"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>LEdge</span> <span class='hs-layout'>(</span><span class='hs-conid'>EdgeID</span> <span class='hs-varid'>el</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Attributes</span><span class='hs-layout'>)</span>
<a name="line-437"></a><span class='hs-definition'>setEdgeIDAttribute</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span> <span class='hs-varid'>e</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span><span class='hs-varid'>eid</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>identifierAttribute</span> <span class='hs-layout'>(</span><span class='hs-varid'>eID</span> <span class='hs-varid'>eid</span><span class='hs-layout'>)</span>
<a name="line-438"></a> <span class='hs-conop'>:</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span> <span class='hs-varop'>.</span> <span class='hs-varid'>stripID</span><span class='hs-layout'>)</span> <span class='hs-varid'>e</span>
<a name="line-439"></a>
<a name="line-440"></a><a name="identifierAttrName"></a><span class='hs-definition'>identifierAttrName</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>AttributeName</span>
<a name="line-441"></a><span class='hs-definition'>identifierAttrName</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"graphviz_distinguish_multiple_edges"</span>
<a name="line-442"></a>
<a name="line-443"></a><a name="identifierAttribute"></a><span class='hs-definition'>identifierAttribute</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Text</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CustomAttribute</span>
<a name="line-444"></a><span class='hs-definition'>identifierAttribute</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>customAttribute</span> <span class='hs-varid'>identifierAttrName</span>
<a name="line-445"></a>
<a name="line-446"></a><a name="stripID"></a><span class='hs-comment'>-- | Remove the unique identifier from the 'LEdge'.</span>
<a name="line-447"></a><span class='hs-definition'>stripID</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>LEdge</span> <span class='hs-layout'>(</span><span class='hs-conid'>EdgeID</span> <span class='hs-varid'>el</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LEdge</span> <span class='hs-varid'>el</span>
<a name="line-448"></a><span class='hs-definition'>stripID</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span><span class='hs-layout'>,</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span><span class='hs-varid'>eid</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span><span class='hs-layout'>,</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span> <span class='hs-varid'>eLbl</span> <span class='hs-varid'>eid</span><span class='hs-layout'>)</span>
<a name="line-449"></a>
<a name="line-450"></a><a name="dotAttributes"></a><span class='hs-comment'>-- | Pass the 'DotRepr' through the relevant command and then augment</span>
<a name="line-451"></a><span class='hs-comment'>-- the 'Graph' that it came from.</span>
<a name="line-452"></a><span class='hs-definition'>dotAttributes</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Graph</span> <span class='hs-varid'>gr</span><span class='hs-layout'>,</span> <span class='hs-conid'>PPDotRepr</span> <span class='hs-varid'>dg</span> <span class='hs-conid'>Node</span><span class='hs-layout'>,</span> <span class='hs-conid'>FromGeneralisedDot</span> <span class='hs-varid'>dg</span> <span class='hs-conid'>Node</span><span class='hs-layout'>)</span>
<a name="line-453"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Bool</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>gr</span> <span class='hs-varid'>nl</span> <span class='hs-layout'>(</span><span class='hs-conid'>EdgeID</span> <span class='hs-varid'>el</span><span class='hs-layout'>)</span>
<a name="line-454"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>dg</span> <span class='hs-conid'>Node</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-varid'>gr</span> <span class='hs-layout'>(</span><span class='hs-conid'>AttributeNode</span> <span class='hs-varid'>nl</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>AttributeEdge</span> <span class='hs-varid'>el</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-455"></a><span class='hs-definition'>dotAttributes</span> <span class='hs-varid'>isDir</span> <span class='hs-varid'>gr</span> <span class='hs-varid'>dot</span>
<a name="line-456"></a> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>augmentGraph</span> <span class='hs-varid'>gr</span> <span class='hs-varop'>.</span> <span class='hs-varid'>parseDG</span> <span class='hs-varop'><$></span> <span class='hs-varid'>graphvizWithHandle</span> <span class='hs-varid'>command</span> <span class='hs-varid'>dot</span> <span class='hs-conid'>DotOutput</span> <span class='hs-varid'>hGetDot</span>
<a name="line-457"></a> <span class='hs-keyword'>where</span>
<a name="line-458"></a> <span class='hs-varid'>parseDG</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>`asTypeOf`</span> <span class='hs-varid'>dot</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fromGeneralised</span>
<a name="line-459"></a> <span class='hs-varid'>command</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>isDir</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>dirCommand</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>undirCommand</span>
<a name="line-460"></a>
<a name="line-461"></a><a name="augmentGraph"></a><span class='hs-comment'>-- | Use the 'Attributes' in the provided 'DotGraph' to augment the</span>
<a name="line-462"></a><span class='hs-comment'>-- node and edge labels in the provided 'Graph'. The unique</span>
<a name="line-463"></a><span class='hs-comment'>-- identifiers on the edges are also stripped off.</span>
<a name="line-464"></a><span class='hs-comment'>--</span>
<a name="line-465"></a><span class='hs-comment'>-- Please note that the behaviour for this function is undefined if</span>
<a name="line-466"></a><span class='hs-comment'>-- the 'DotGraph' does not come from the original 'Graph' (either</span>
<a name="line-467"></a><span class='hs-comment'>-- by using a conversion function or by passing the result of a</span>
<a name="line-468"></a><span class='hs-comment'>-- conversion function through a 'GraphvizCommand' via the</span>
<a name="line-469"></a><span class='hs-comment'>-- 'DotOutput' or similar).</span>
<a name="line-470"></a><span class='hs-definition'>augmentGraph</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Graph</span> <span class='hs-varid'>gr</span><span class='hs-layout'>,</span> <span class='hs-conid'>DotRepr</span> <span class='hs-varid'>dg</span> <span class='hs-conid'>Node</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>gr</span> <span class='hs-varid'>nl</span> <span class='hs-layout'>(</span><span class='hs-conid'>EdgeID</span> <span class='hs-varid'>el</span><span class='hs-layout'>)</span>
<a name="line-471"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>dg</span> <span class='hs-conid'>Node</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>gr</span> <span class='hs-layout'>(</span><span class='hs-conid'>AttributeNode</span> <span class='hs-varid'>nl</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>AttributeEdge</span> <span class='hs-varid'>el</span><span class='hs-layout'>)</span>
<a name="line-472"></a><span class='hs-definition'>augmentGraph</span> <span class='hs-varid'>g</span> <span class='hs-varid'>dg</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkGraph</span> <span class='hs-varid'>lns</span> <span class='hs-varid'>les</span>
<a name="line-473"></a> <span class='hs-keyword'>where</span>
<a name="line-474"></a> <span class='hs-varid'>lns</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-varid'>l</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varid'>nodeMap</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.!</span> <span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-varid'>l</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-475"></a> <span class='hs-varop'>$</span> <span class='hs-varid'>labNodes</span> <span class='hs-varid'>g</span>
<a name="line-476"></a> <span class='hs-varid'>les</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>augmentEdge</span> <span class='hs-varop'>$</span> <span class='hs-varid'>labEdges</span> <span class='hs-varid'>g</span>
<a name="line-477"></a> <span class='hs-varid'>augmentEdge</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span><span class='hs-layout'>,</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span><span class='hs-conid'>EID</span> <span class='hs-varid'>eid</span> <span class='hs-varid'>l</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span><span class='hs-layout'>,</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varid'>edgeMap</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.!</span> <span class='hs-varid'>eid</span><span class='hs-layout'>,</span> <span class='hs-varid'>l</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-478"></a> <span class='hs-varid'>ns</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>graphNodes</span> <span class='hs-varid'>dg</span>
<a name="line-479"></a> <span class='hs-varid'>es</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>graphEdges</span> <span class='hs-varid'>dg</span>
<a name="line-480"></a> <span class='hs-varid'>nodeMap</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>fromList</span> <span class='hs-varop'>$</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-varid'>nodeID</span> <span class='hs-varop'>&&&</span> <span class='hs-varid'>nodeAttributes</span><span class='hs-layout'>)</span> <span class='hs-varid'>ns</span>
<a name="line-481"></a> <span class='hs-varid'>edgeMap</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>fromList</span> <span class='hs-varop'>$</span> <span class='hs-varid'>map</span> <span class='hs-varid'>edgeIDAttrs</span> <span class='hs-varid'>es</span>
<a name="line-482"></a> <span class='hs-varid'>edgeIDAttrs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>first</span> <span class='hs-varid'>customValue</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fromJust</span>
<a name="line-483"></a> <span class='hs-varop'>.</span> <span class='hs-varid'>findSpecifiedCustom</span> <span class='hs-varid'>identifierAttrName</span>
<a name="line-484"></a> <span class='hs-varop'>.</span> <span class='hs-varid'>edgeAttributes</span>
<a name="line-485"></a>
<a name="line-486"></a><span class='hs-comment'>-- -----------------------------------------------------------------------------</span>
<a name="line-487"></a><span class='hs-comment'>-- Utility Functions</span>
<a name="line-488"></a>
<a name="line-489"></a><a name="preview"></a><span class='hs-comment'>-- | Quickly visualise a graph using the 'Xlib' 'GraphvizCanvas'. If</span>
<a name="line-490"></a><span class='hs-comment'>-- your label types are not (and cannot) be instances of 'Labellable',</span>
<a name="line-491"></a><span class='hs-comment'>-- you may wish to use 'gmap', 'nmap' or 'emap' to set them to a value</span>
<a name="line-492"></a><span class='hs-comment'>-- such as @\"\"@.</span>
<a name="line-493"></a><span class='hs-definition'>preview</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ord</span> <span class='hs-varid'>el</span><span class='hs-layout'>,</span> <span class='hs-conid'>Graph</span> <span class='hs-varid'>gr</span><span class='hs-layout'>,</span> <span class='hs-conid'>Labellable</span> <span class='hs-varid'>nl</span><span class='hs-layout'>,</span> <span class='hs-conid'>Labellable</span> <span class='hs-varid'>el</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>gr</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>el</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-494"></a><span class='hs-definition'>preview</span> <span class='hs-varid'>g</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ign</span> <span class='hs-varop'>$</span> <span class='hs-varid'>forkIO</span> <span class='hs-layout'>(</span><span class='hs-varid'>ign</span> <span class='hs-varop'>$</span> <span class='hs-varid'>runGraphvizCanvas'</span> <span class='hs-varid'>dg</span> <span class='hs-conid'>Xlib</span><span class='hs-layout'>)</span>
<a name="line-495"></a> <span class='hs-keyword'>where</span>
<a name="line-496"></a> <span class='hs-varid'>dg</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>setDirectedness</span> <span class='hs-varid'>graphToDot</span> <span class='hs-varid'>params</span> <span class='hs-varid'>g</span>
<a name="line-497"></a> <span class='hs-varid'>params</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>nonClusteredParams</span> <span class='hs-layout'>{</span> <span class='hs-varid'>fmtNode</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span><span class='hs-varid'>l</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>toLabel</span> <span class='hs-varid'>l</span><span class='hs-keyglyph'>]</span>
<a name="line-498"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fmtEdge</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-varid'>l</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>toLabel</span> <span class='hs-varid'>l</span><span class='hs-keyglyph'>]</span>
<a name="line-499"></a> <span class='hs-layout'>}</span>
<a name="line-500"></a> <span class='hs-varid'>ign</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>>></span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
</pre></body>
</html>
|