Moduledotgen-0.4.3Haskell2010

Text.Dot

This module provides a simple interface for building .dot graph files, for input into the dot and graphviz tools. It includes a monadic interface for building graphs.

2 types
13 values

Packagedotgen-0.4.3
Exports15
LanguageHaskell2010
LicenceBSD-3-Clause
SourceDot.hs

Dot

1 declaration

datadata Dot a

Instances3Monad, Functor, Applicative

Monad DotDefined in dotgen-0.4.3 · Text.Dot
Functor DotDefined in dotgen-0.4.3 · Text.Dot
Applicative DotDefined in dotgen-0.4.3 · Text.Dot

Nodes

4 declarations

valuenode :: [(String, String)] -> Dot NodeId

node takes a list of attributes, generates a new node, and gives a NodeId.

datadata NodeId

Instances1Show

Show NodeIdDefined in dotgen-0.4.3 · Text.Dot

valueuserNodeId :: Int -> NodeId

userNodeId allows a user to use their own (Int-based) node id's, without needing to remap them.

valueuserNode :: NodeId -> [(String, String)] -> Dot ()

userNode takes a NodeId, and adds some attributes to that node.

Edges

3 declarations

valueedge :: NodeId -> NodeId -> [(String, String)] -> Dot ()

edge generates an edge between two NodeIds, with attributes.

valueedge'

:: NodeId
-> Maybe String
-> NodeId
-> Maybe String
-> [(String, String)]
-> Dot ()

edge generates an edge between two NodeIds, with optional node sub-labels, and attributes.

value(.->.) :: NodeId -> NodeId -> Dot ()

.->. generates an edge between two NodeIds.

Showing a graph

1 declaration

valueshowDot :: Dot a -> String

Other combinators

5 declarations

valuescope :: Dot a -> Dot a

scope groups a subgraph together; in dot these are the subgraphs inside "{" and "}".

valueattribute :: (String, String) -> Dot ()

attribute gives a attribute to the current scope.

valuesame :: [NodeId] -> Dot ()

same provides a combinator for a common pattern; a set of NodeIds with the same rank.

valuecluster :: Dot a -> Dot (NodeId, a)

cluster builds an explicit, internally named subgraph (called cluster).

Simple netlist generation

1 declaration

valuenetlistGraph

:: Ord a
=> (b -> [(String, String)])
Attributes for each node
-> (b -> [a])
Out edges leaving each node
-> [(a, b)]
The netlist
-> Dot ()

netlistGraph generates a simple graph from a netlist.