Copyright	(c) Ivan Lazar Miljenovic
License	3-Clause BSD-style
Maintainer	Ivan.Miljenovic@gmail.com
Safe Haskell	None
Language	Haskell2010

Data.GraphViz.Types.Generalised

Contents

Sub-components of a DotGraph.
Re-exported from Data.GraphViz.Types.

Description

The generalised Dot representation most closely matches the implementation of actual Dot code, as it places no restrictions on ordering of elements, etc. As such it should be able to parse any existing Dot code (taking into account the parsing limitations/assumptions).

The sample graph could be implemented (this is actually a prettied version of parsing in the Dot code) as:

DotGraph { strictGraph = False
         , directedGraph = True
         , graphID = Just (Str "G")
         , graphStatements = Seq.fromList [ SG $ DotSG { isCluster = True
                                                       , subGraphID = Just (Int 0)
                                                       , subGraphStmts = Seq.fromList [ GA $ GraphAttrs [style filled]
                                                                                      , GA $ GraphAttrs [color LightGray]
                                                                                      , GA $ NodeAttrs [style filled, color White]
                                                                                      , DE $ DotEdge "a0" "a1" []
                                                                                      , DE $ DotEdge "a1" "a2" []
                                                                                      , DE $ DotEdge "a2" "a3" []
                                                                                      , GA $ GraphAttrs [textLabel "process #1"]]}
                                          , SG $ DotSG { isCluster = True
                                                       , subGraphID = Just (Int 1)
                                                       , subGraphStmts = fromList [ GA $ NodeAttrs [style filled]
                                                                                  , DE $ DotEdge "b0" "b1" []
                                                                                  , DE $ DotEdge "b1" "b2" []
                                                                                  , DE $ DotEdge "b2" "b3" []
                                                                                  , GA $ GraphAttrs [textLabel "process #2"]
                                                                                  , GA $ GraphAttrs [color Blue]]}
                                          , DE $ DotEdge "start" "a0" []
                                          , DE $ DotEdge "start" "b0" []
                                          , DE $ DotEdge "a1" "b3" []
                                          , DE $ DotEdge "b2" "a3" []
                                          , DE $ DotEdge "a3" "a0" []
                                          , DE $ DotEdge "a3" "end" []
                                          , DE $ DotEdge "b3" "end" []
                                          , DN $ DotNode "start" [shape MDiamond]
                                          , DN $ DotNode "end" [shape MSquare]]}

Synopsis

Documentation

data DotGraph n Source

The internal representation of a generalised graph in Dot form.

Constructors

DotGraph
Fields strictGraph :: Bool If `True`, no multiple edges are drawn. directedGraph :: Bool graphID :: Maybe GraphID graphStatements :: DotStatements n

Instances

Functor DotGraph	Assumed to be an injective mapping function.
(Ord n, PrintDot n, ParseDot n) => PPDotRepr DotGraph n
(Ord n, ParseDot n) => ParseDotRepr DotGraph n
(Ord n, PrintDot n) => PrintDotRepr DotGraph n
Ord n => DotRepr DotGraph n
Ord n => FromGeneralisedDot DotGraph n
Eq n => Eq (DotGraph n)
Ord n => Ord (DotGraph n)
Read n => Read (DotGraph n)
Show n => Show (DotGraph n)
ParseDot n => ParseDot (DotGraph n)
PrintDot n => PrintDot (DotGraph n)

class DotRepr dg n => FromGeneralisedDot dg n where Source

This class is useful for being able to parse in a dot graph as a generalised one, and then convert it to your preferred representation.

This can be seen as a semi-inverse of fromCanonical.

Methods

fromGeneralised :: DotGraph n -> dg n Source

Instances

Ord n => FromGeneralisedDot DotGraph n
Ord n => FromGeneralisedDot DotGraph n
Ord n => FromGeneralisedDot DotGraph n

Sub-components of a `DotGraph`.

type DotStatements n = Seq (DotStatement n) Source

data DotStatement n Source

Constructors

GA GlobalAttributes
SG (DotSubGraph n)
DN (DotNode n)
DE (DotEdge n)

Instances

Functor DotStatement
Eq n => Eq (DotStatement n)
Ord n => Ord (DotStatement n)
Read n => Read (DotStatement n)
Show n => Show (DotStatement n)
ParseDot n => ParseDot (DotStatement n)
PrintDot n => PrintDot (DotStatement n)

data DotSubGraph n Source

Constructors

DotSG
Fields isCluster :: Bool subGraphID :: Maybe GraphID subGraphStmts :: DotStatements n

Instances

Functor DotSubGraph
Eq n => Eq (DotSubGraph n)
Ord n => Ord (DotSubGraph n)
Read n => Read (DotSubGraph n)
Show n => Show (DotSubGraph n)
ParseDot n => ParseDot (DotSubGraph n)
PrintDot n => PrintDot (DotSubGraph n)

Re-exported from `Data.GraphViz.Types`.

data GraphID Source

A polymorphic type that covers all possible ID values allowed by Dot syntax. Note that whilst the ParseDot and PrintDot instances for String will properly take care of the special cases for numbers, they are treated differently here.

Constructors

Str Text
Num Number

Instances

Eq GraphID
Ord GraphID
Read GraphID
Show GraphID
ParseDot GraphID
PrintDot GraphID

data GlobalAttributes Source

Represents a list of top-level list of Attributes for the entire graph/sub-graph. Note that GraphAttrs also applies to DotSubGraphs.

Note that Dot allows a single Attribute to be listed on a line; if this is the case then when parsing, the type of Attribute it is determined and that type of GlobalAttribute is created.

Constructors

GraphAttrs
Fields attrs :: Attributes
NodeAttrs
Fields attrs :: Attributes
EdgeAttrs
Fields attrs :: Attributes

Instances

Eq GlobalAttributes
Ord GlobalAttributes
Read GlobalAttributes
Show GlobalAttributes
ParseDot GlobalAttributes
PrintDot GlobalAttributes

data DotNode n Source

A node in DotGraph.

Constructors

DotNode
Fields nodeID :: n nodeAttributes :: Attributes

Instances

Functor DotNode
Eq n => Eq (DotNode n)
Ord n => Ord (DotNode n)
Read n => Read (DotNode n)
Show n => Show (DotNode n)
ParseDot n => ParseDot (DotNode n)
PrintDot n => PrintDot (DotNode n)

data DotEdge n Source

An edge in DotGraph.

Constructors

DotEdge
Fields fromNode :: n toNode :: n edgeAttributes :: Attributes

Instances

Functor DotEdge
Eq n => Eq (DotEdge n)
Ord n => Ord (DotEdge n)
Read n => Read (DotEdge n)
Show n => Show (DotEdge n)
ParseDot n => ParseDot (DotEdge n)
PrintDot n => PrintDot (DotEdge n)

Documentation

Sub-components of a DotGraph.

Re-exported from Data.GraphViz.Types.

Sub-components of a `DotGraph`.

Re-exported from `Data.GraphViz.Types`.