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

data DotGraph n = DotGraph {
- strictGraph :: Bool
- directedGraph :: Bool
- graphID :: Maybe GraphID
- graphStatements :: DotStatements n
}
class DotRepr dg n => FromGeneralisedDot dg n where
- fromGeneralised :: DotGraph n -> dg n
type DotStatements n = Seq (DotStatement n)
data DotStatement n
- = GA GlobalAttributes
- | SG (DotSubGraph n)
- | DN (DotNode n)
- | DE (DotEdge n)
data DotSubGraph n = DotSG {
- isCluster :: Bool
- subGraphID :: Maybe GraphID
- subGraphStmts :: DotStatements n
}
data GraphID
- = Str Text
- | Num Number
data GlobalAttributes
- = GraphAttrs {
  - attrs :: Attributes
  }
- | NodeAttrs {
  - attrs :: Attributes
  }
- | EdgeAttrs {
  - attrs :: Attributes
  }
data DotNode n = DotNode {
- nodeID :: n
- nodeAttributes :: Attributes
}
data DotEdge n = DotEdge {
- fromNode :: n
- toNode :: n
- edgeAttributes :: Attributes
}

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 Source #	Assumed to be an injective mapping function.
Instance details Defined in Data.GraphViz.Types.Generalised Methods fmap :: (a -> b) -> DotGraph a -> DotGraph b # (<$) :: a -> DotGraph b -> DotGraph a #
(Ord n, PrintDot n, ParseDot n) => PPDotRepr DotGraph n Source #
Instance details Defined in Data.GraphViz.Types.Generalised
(Ord n, ParseDot n) => ParseDotRepr DotGraph n Source #
Instance details Defined in Data.GraphViz.Types.Generalised
(Ord n, PrintDot n) => PrintDotRepr DotGraph n Source #
Instance details Defined in Data.GraphViz.Types.Generalised
Ord n => DotRepr DotGraph n Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods fromCanonical :: DotGraph0 n -> DotGraph n Source # getID :: DotGraph n -> Maybe GraphID Source # setID :: GraphID -> DotGraph n -> DotGraph n Source # graphIsDirected :: DotGraph n -> Bool Source # setIsDirected :: Bool -> DotGraph n -> DotGraph n Source # graphIsStrict :: DotGraph n -> Bool Source # setStrictness :: Bool -> DotGraph n -> DotGraph n Source # mapDotGraph :: DotRepr DotGraph n' => (n -> n') -> DotGraph n -> DotGraph n' Source # graphStructureInformation :: DotGraph n -> (GlobalAttributes, ClusterLookup) Source # nodeInformation :: Bool -> DotGraph n -> NodeLookup n Source # edgeInformation :: Bool -> DotGraph n -> [DotEdge n] Source # unAnonymise :: DotGraph n -> DotGraph n Source #
Ord n => FromGeneralisedDot DotGraph n Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods fromGeneralised :: DotGraph n -> DotGraph n Source #
Eq n => Eq (DotGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods (==) :: DotGraph n -> DotGraph n -> Bool # (/=) :: DotGraph n -> DotGraph n -> Bool #
Ord n => Ord (DotGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods compare :: DotGraph n -> DotGraph n -> Ordering # (<) :: DotGraph n -> DotGraph n -> Bool # (<=) :: DotGraph n -> DotGraph n -> Bool # (>) :: DotGraph n -> DotGraph n -> Bool # (>=) :: DotGraph n -> DotGraph n -> Bool # max :: DotGraph n -> DotGraph n -> DotGraph n # min :: DotGraph n -> DotGraph n -> DotGraph n #
Read n => Read (DotGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods readsPrec :: Int -> ReadS (DotGraph n) # readList :: ReadS [DotGraph n] # readPrec :: ReadPrec (DotGraph n) # readListPrec :: ReadPrec [DotGraph n] #
Show n => Show (DotGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods showsPrec :: Int -> DotGraph n -> ShowS # show :: DotGraph n -> String # showList :: [DotGraph n] -> ShowS #
ParseDot n => ParseDot (DotGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods parseUnqt :: Parse (DotGraph n) Source # parse :: Parse (DotGraph n) Source # parseUnqtList :: Parse [DotGraph n] Source # parseList :: Parse [DotGraph n] Source #
PrintDot n => PrintDot (DotGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods unqtDot :: DotGraph n -> DotCode Source # toDot :: DotGraph n -> DotCode Source # unqtListToDot :: [DotGraph n] -> DotCode Source # listToDot :: [DotGraph n] -> DotCode Source #

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 Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods fromGeneralised :: DotGraph0 n -> DotGraph n Source #
Ord n => FromGeneralisedDot DotGraph n Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods fromGeneralised :: DotGraph n -> DotGraph n Source #
Ord n => FromGeneralisedDot DotGraph n Source #
Instance details Defined in Data.GraphViz.Types.Graph Methods fromGeneralised :: DotGraph0 n -> DotGraph n Source #

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 Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods fmap :: (a -> b) -> DotStatement a -> DotStatement b # (<$) :: a -> DotStatement b -> DotStatement a #
Eq n => Eq (DotStatement n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods (==) :: DotStatement n -> DotStatement n -> Bool # (/=) :: DotStatement n -> DotStatement n -> Bool #
Ord n => Ord (DotStatement n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods compare :: DotStatement n -> DotStatement n -> Ordering # (<) :: DotStatement n -> DotStatement n -> Bool # (<=) :: DotStatement n -> DotStatement n -> Bool # (>) :: DotStatement n -> DotStatement n -> Bool # (>=) :: DotStatement n -> DotStatement n -> Bool # max :: DotStatement n -> DotStatement n -> DotStatement n # min :: DotStatement n -> DotStatement n -> DotStatement n #
Read n => Read (DotStatement n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods readsPrec :: Int -> ReadS (DotStatement n) # readList :: ReadS [DotStatement n] # readPrec :: ReadPrec (DotStatement n) # readListPrec :: ReadPrec [DotStatement n] #
Show n => Show (DotStatement n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods showsPrec :: Int -> DotStatement n -> ShowS # show :: DotStatement n -> String # showList :: [DotStatement n] -> ShowS #
ParseDot n => ParseDot (DotStatement n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods parseUnqt :: Parse (DotStatement n) Source # parse :: Parse (DotStatement n) Source # parseUnqtList :: Parse [DotStatement n] Source # parseList :: Parse [DotStatement n] Source #
PrintDot n => PrintDot (DotStatement n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods unqtDot :: DotStatement n -> DotCode Source # toDot :: DotStatement n -> DotCode Source # unqtListToDot :: [DotStatement n] -> DotCode Source # listToDot :: [DotStatement n] -> DotCode Source #

data DotSubGraph n Source #

Constructors

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

Instances

Functor DotSubGraph Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods fmap :: (a -> b) -> DotSubGraph a -> DotSubGraph b # (<$) :: a -> DotSubGraph b -> DotSubGraph a #
Eq n => Eq (DotSubGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods (==) :: DotSubGraph n -> DotSubGraph n -> Bool # (/=) :: DotSubGraph n -> DotSubGraph n -> Bool #
Ord n => Ord (DotSubGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods compare :: DotSubGraph n -> DotSubGraph n -> Ordering # (<) :: DotSubGraph n -> DotSubGraph n -> Bool # (<=) :: DotSubGraph n -> DotSubGraph n -> Bool # (>) :: DotSubGraph n -> DotSubGraph n -> Bool # (>=) :: DotSubGraph n -> DotSubGraph n -> Bool # max :: DotSubGraph n -> DotSubGraph n -> DotSubGraph n # min :: DotSubGraph n -> DotSubGraph n -> DotSubGraph n #
Read n => Read (DotSubGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods readsPrec :: Int -> ReadS (DotSubGraph n) # readList :: ReadS [DotSubGraph n] # readPrec :: ReadPrec (DotSubGraph n) # readListPrec :: ReadPrec [DotSubGraph n] #
Show n => Show (DotSubGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods showsPrec :: Int -> DotSubGraph n -> ShowS # show :: DotSubGraph n -> String # showList :: [DotSubGraph n] -> ShowS #
ParseDot n => ParseDot (DotSubGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods parseUnqt :: Parse (DotSubGraph n) Source # parse :: Parse (DotSubGraph n) Source # parseUnqtList :: Parse [DotSubGraph n] Source # parseList :: Parse [DotSubGraph n] Source #
PrintDot n => PrintDot (DotSubGraph n) Source #
Instance details Defined in Data.GraphViz.Types.Generalised Methods unqtDot :: DotSubGraph n -> DotCode Source # toDot :: DotSubGraph n -> DotCode Source # unqtListToDot :: [DotSubGraph n] -> DotCode Source # listToDot :: [DotSubGraph n] -> DotCode Source #

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 Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods (==) :: GraphID -> GraphID -> Bool # (/=) :: GraphID -> GraphID -> Bool #
Ord GraphID Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods compare :: GraphID -> GraphID -> Ordering # (<) :: GraphID -> GraphID -> Bool # (<=) :: GraphID -> GraphID -> Bool # (>) :: GraphID -> GraphID -> Bool # (>=) :: GraphID -> GraphID -> Bool # max :: GraphID -> GraphID -> GraphID # min :: GraphID -> GraphID -> GraphID #
Read GraphID Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods readsPrec :: Int -> ReadS GraphID # readList :: ReadS [GraphID] # readPrec :: ReadPrec GraphID # readListPrec :: ReadPrec [GraphID] #
Show GraphID Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods showsPrec :: Int -> GraphID -> ShowS # show :: GraphID -> String # showList :: [GraphID] -> ShowS #
ParseDot GraphID Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods parseUnqt :: Parse GraphID Source # parse :: Parse GraphID Source # parseUnqtList :: Parse [GraphID] Source # parseList :: Parse [GraphID] Source #
PrintDot GraphID Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods unqtDot :: GraphID -> DotCode Source # toDot :: GraphID -> DotCode Source # unqtListToDot :: [GraphID] -> DotCode Source # listToDot :: [GraphID] -> DotCode Source #

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 Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods (==) :: GlobalAttributes -> GlobalAttributes -> Bool # (/=) :: GlobalAttributes -> GlobalAttributes -> Bool #
Ord GlobalAttributes Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods compare :: GlobalAttributes -> GlobalAttributes -> Ordering # (<) :: GlobalAttributes -> GlobalAttributes -> Bool # (<=) :: GlobalAttributes -> GlobalAttributes -> Bool # (>) :: GlobalAttributes -> GlobalAttributes -> Bool # (>=) :: GlobalAttributes -> GlobalAttributes -> Bool # max :: GlobalAttributes -> GlobalAttributes -> GlobalAttributes # min :: GlobalAttributes -> GlobalAttributes -> GlobalAttributes #
Read GlobalAttributes Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods readsPrec :: Int -> ReadS GlobalAttributes # readList :: ReadS [GlobalAttributes] # readPrec :: ReadPrec GlobalAttributes # readListPrec :: ReadPrec [GlobalAttributes] #
Show GlobalAttributes Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods showsPrec :: Int -> GlobalAttributes -> ShowS # show :: GlobalAttributes -> String # showList :: [GlobalAttributes] -> ShowS #
ParseDot GlobalAttributes Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods parseUnqt :: Parse GlobalAttributes Source # parse :: Parse GlobalAttributes Source # parseUnqtList :: Parse [GlobalAttributes] Source # parseList :: Parse [GlobalAttributes] Source #
PrintDot GlobalAttributes Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods unqtDot :: GlobalAttributes -> DotCode Source # toDot :: GlobalAttributes -> DotCode Source # unqtListToDot :: [GlobalAttributes] -> DotCode Source # listToDot :: [GlobalAttributes] -> DotCode Source #

data DotNode n Source #

A node in DotGraph.

Constructors

DotNode
Fields nodeID :: n nodeAttributes :: Attributes

Instances

Functor DotNode Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods fmap :: (a -> b) -> DotNode a -> DotNode b # (<$) :: a -> DotNode b -> DotNode a #
Eq n => Eq (DotNode n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods (==) :: DotNode n -> DotNode n -> Bool # (/=) :: DotNode n -> DotNode n -> Bool #
Ord n => Ord (DotNode n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods compare :: DotNode n -> DotNode n -> Ordering # (<) :: DotNode n -> DotNode n -> Bool # (<=) :: DotNode n -> DotNode n -> Bool # (>) :: DotNode n -> DotNode n -> Bool # (>=) :: DotNode n -> DotNode n -> Bool # max :: DotNode n -> DotNode n -> DotNode n # min :: DotNode n -> DotNode n -> DotNode n #
Read n => Read (DotNode n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods readsPrec :: Int -> ReadS (DotNode n) # readList :: ReadS [DotNode n] # readPrec :: ReadPrec (DotNode n) # readListPrec :: ReadPrec [DotNode n] #
Show n => Show (DotNode n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods showsPrec :: Int -> DotNode n -> ShowS # show :: DotNode n -> String # showList :: [DotNode n] -> ShowS #
ParseDot n => ParseDot (DotNode n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods parseUnqt :: Parse (DotNode n) Source # parse :: Parse (DotNode n) Source # parseUnqtList :: Parse [DotNode n] Source # parseList :: Parse [DotNode n] Source #
PrintDot n => PrintDot (DotNode n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods unqtDot :: DotNode n -> DotCode Source # toDot :: DotNode n -> DotCode Source # unqtListToDot :: [DotNode n] -> DotCode Source # listToDot :: [DotNode n] -> DotCode Source #

data DotEdge n Source #

An edge in DotGraph.

Constructors

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

Instances

Functor DotEdge Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods fmap :: (a -> b) -> DotEdge a -> DotEdge b # (<$) :: a -> DotEdge b -> DotEdge a #
Eq n => Eq (DotEdge n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods (==) :: DotEdge n -> DotEdge n -> Bool # (/=) :: DotEdge n -> DotEdge n -> Bool #
Ord n => Ord (DotEdge n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods compare :: DotEdge n -> DotEdge n -> Ordering # (<) :: DotEdge n -> DotEdge n -> Bool # (<=) :: DotEdge n -> DotEdge n -> Bool # (>) :: DotEdge n -> DotEdge n -> Bool # (>=) :: DotEdge n -> DotEdge n -> Bool # max :: DotEdge n -> DotEdge n -> DotEdge n # min :: DotEdge n -> DotEdge n -> DotEdge n #
Read n => Read (DotEdge n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods readsPrec :: Int -> ReadS (DotEdge n) # readList :: ReadS [DotEdge n] # readPrec :: ReadPrec (DotEdge n) # readListPrec :: ReadPrec [DotEdge n] #
Show n => Show (DotEdge n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods showsPrec :: Int -> DotEdge n -> ShowS # show :: DotEdge n -> String # showList :: [DotEdge n] -> ShowS #
ParseDot n => ParseDot (DotEdge n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods parseUnqt :: Parse (DotEdge n) Source # parse :: Parse (DotEdge n) Source # parseUnqtList :: Parse [DotEdge n] Source # parseList :: Parse [DotEdge n] Source #
PrintDot n => PrintDot (DotEdge n) Source #
Instance details Defined in Data.GraphViz.Types.Internal.Common Methods unqtDot :: DotEdge n -> DotCode Source # toDot :: DotEdge n -> DotCode Source # unqtListToDot :: [DotEdge n] -> DotCode Source # listToDot :: [DotEdge n] -> DotCode Source #

Documentation

Sub-components of a DotGraph.

Re-exported from Data.GraphViz.Types.

Sub-components of a `DotGraph`.

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