DotParse

Parser & Printer for the dot language of graphviz

See DotParse.Examples for usage.

Documentation

data DotConfig

printing options, for separators.

Constructors

DotConfig

Fields

• topLevelSep :: ByteString
• statementSep :: ByteString
• attSep :: ByteString
• subGraphSep :: ByteString

Instances

Generic DotConfig

Defined in DotParse.Types

Associated Types

type Rep DotConfig :: Type -> Type

Methods

from :: DotConfig -> Rep DotConfig x

to :: Rep DotConfig x -> DotConfig

Show DotConfig

Defined in DotParse.Types

Methods

showsPrec :: Int -> DotConfig -> ShowS

show :: DotConfig -> String

showList :: [DotConfig] -> ShowS

Eq DotConfig

Defined in DotParse.Types

Methods

(==) :: DotConfig -> DotConfig -> Bool

(/=) :: DotConfig -> DotConfig -> Bool

type Rep DotConfig

Defined in DotParse.Types

type Rep DotConfig = D1 ('MetaData "DotConfig" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "DotConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "topLevelSep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "statementSep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :*: (S1 ('MetaSel ('Just "attSep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "subGraphSep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString))))

defaultDotConfig :: DotConfig

default separators

class DotParse a where

A parser & printer class for a graphviz graph and components of its dot language

Methods

dotPrint :: DotConfig -> a -> ByteString

dotParse :: Parser Error a

Instances

DotParse AttributeStatement

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> AttributeStatement -> ByteString

dotParse :: Parser Error AttributeStatement

DotParse AttributeType

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> AttributeType -> ByteString

dotParse :: Parser Error AttributeType

DotParse Compass

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Compass -> ByteString

dotParse :: Parser Error Compass

DotParse Directed

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Directed -> ByteString

dotParse :: Parser Error Directed

DotParse EdgeID

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> EdgeID -> ByteString

dotParse :: Parser Error EdgeID

DotParse EdgeOp

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> EdgeOp -> ByteString

dotParse :: Parser Error EdgeOp

DotParse EdgeStatement

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> EdgeStatement -> ByteString

dotParse :: Parser Error EdgeStatement

DotParse GlobalAttributeStatement

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> GlobalAttributeStatement -> ByteString

dotParse :: Parser Error GlobalAttributeStatement

DotParse Graph

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Graph -> ByteString

dotParse :: Parser Error Graph

DotParse ID

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> ID -> ByteString

dotParse :: Parser Error ID

DotParse NodeStatement

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> NodeStatement -> ByteString

dotParse :: Parser Error NodeStatement

DotParse Port

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Port -> ByteString

dotParse :: Parser Error Port

DotParse Statement

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Statement -> ByteString

dotParse :: Parser Error Statement

DotParse Strict

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Strict -> ByteString

dotParse :: Parser Error Strict

DotParse SubGraphStatement

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> SubGraphStatement -> ByteString

dotParse :: Parser Error SubGraphStatement

DotParse (Point Double)

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Point Double -> ByteString

dotParse :: Parser Error (Point Double)

DotParse (Rect Double)

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Rect Double -> ByteString

dotParse :: Parser Error (Rect Double)

DotParse (Map ID ID)

Attribute collections

A given entity can have multiple attribute lists. For simplicity, these are mconcat'ed on parsing.

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Map ID ID -> ByteString

dotParse :: Parser Error (Map ID ID)

DotParse (ID, ID)

Attribute key-value pair of identifiers

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> (ID, ID) -> ByteString

dotParse :: Parser Error (ID, ID)

testDotParser :: forall a. DotParse a => Proxy a -> DotConfig -> ByteString -> IO ()

dotParse and then dotPrint:

• pretty printing error on failure.
• This is not an exact parser/printer, so the test re-parses the dotPrint, which should be idempotent

runDotParser :: DotParse a => ByteString -> a

run a dotParse erroring on leftovers, Fail or Err

data Graph

Representation of a full graphviz graph, as per the dot language specification

Constructors

Graph

Fields

• strict :: Last Strict
• directed :: Last Directed
• graphid :: Last ID
• nodeAttributes :: Map ID ID
• graphAttributes :: Map ID ID
• edgeAttributes :: Map ID ID
• globalAttributes :: Map ID ID
• nodes :: [NodeStatement]
• edges :: [EdgeStatement]
• subgraphs :: [SubGraphStatement]

Instances

Monoid Graph

Defined in DotParse.Types

Methods

mempty :: Graph

mappend :: Graph -> Graph -> Graph

mconcat :: [Graph] -> Graph

Semigroup Graph

Defined in DotParse.Types

Methods

(<>) :: Graph -> Graph -> Graph

sconcat :: NonEmpty Graph -> Graph

stimes :: Integral b => b -> Graph -> Graph

Generic Graph

Defined in DotParse.Types

Associated Types

type Rep Graph :: Type -> Type

Methods

from :: Graph -> Rep Graph x

to :: Rep Graph x -> Graph

Show Graph

Defined in DotParse.Types

Methods

showsPrec :: Int -> Graph -> ShowS

show :: Graph -> String

showList :: [Graph] -> ShowS

DotParse Graph

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Graph -> ByteString

dotParse :: Parser Error Graph

Eq Graph

Defined in DotParse.Types

Methods

(==) :: Graph -> Graph -> Bool

(/=) :: Graph -> Graph -> Bool

type Rep Graph

Defined in DotParse.Types

type Rep Graph = D1 ('MetaData "Graph" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "Graph" 'PrefixI 'True) (((S1 ('MetaSel ('Just "strict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last Strict)) :*: S1 ('MetaSel ('Just "directed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last Directed))) :*: (S1 ('MetaSel ('Just "graphid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Last ID)) :*: (S1 ('MetaSel ('Just "nodeAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ID ID)) :*: S1 ('MetaSel ('Just "graphAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ID ID))))) :*: ((S1 ('MetaSel ('Just "edgeAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ID ID)) :*: S1 ('MetaSel ('Just "globalAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ID ID))) :*: (S1 ('MetaSel ('Just "nodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [NodeStatement]) :*: (S1 ('MetaSel ('Just "edges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [EdgeStatement]) :*: S1 ('MetaSel ('Just "subgraphs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SubGraphStatement]))))))

defaultGraph :: Graph

Directed graph of size 1.

>>> BS.putStr $ dotPrint defaultDotConfig defaultGraph <> "\n"
digraph {
    node [height=0.5;shape=circle]
    graph [overlap=false;size="1!";splines=spline]
    edge [arrowsize=0.5]
    rankdir="TB"
    }

attL :: AttributeType -> ID -> Lens' Graph (Maybe ID)

attributes lens

gattL :: ID -> Lens' Graph (Maybe ID)

global attributes lens

processDot :: Directed -> ByteString -> IO ByteString

run a dot string through graphviz, collecting the augmented dot string output

processDotWith :: Directed -> [String] -> ByteString -> IO ByteString

run a dot string through graphviz, supplying arguments and collecting stdout

processGraph :: Graph -> IO Graph

Augment a Graph via the graphviz process

processGraphWith :: DotConfig -> Graph -> IO Graph

Augment a Graph via the graphviz process

data Strict

MergeEdges (strict)

Constructors

MergeEdges

NoMergeEdges

Instances

Generic Strict

Defined in DotParse.Types

Associated Types

type Rep Strict :: Type -> Type

Methods

from :: Strict -> Rep Strict x

to :: Rep Strict x -> Strict

Show Strict

Defined in DotParse.Types

Methods

showsPrec :: Int -> Strict -> ShowS

show :: Strict -> String

showList :: [Strict] -> ShowS

DotParse Strict

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Strict -> ByteString

dotParse :: Parser Error Strict

Eq Strict

Defined in DotParse.Types

Methods

(==) :: Strict -> Strict -> Bool

(/=) :: Strict -> Strict -> Bool

type Rep Strict

Defined in DotParse.Types

type Rep Strict = D1 ('MetaData "Strict" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "MergeEdges" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoMergeEdges" 'PrefixI 'False) (U1 :: Type -> Type))

defStrict :: Last Strict -> Strict

Default Strict is NoMergeEdges

data Directed

Directed (digraph | graph)

Constructors

Directed

UnDirected

Instances

Generic Directed

Defined in DotParse.Types

Associated Types

type Rep Directed :: Type -> Type

Methods

from :: Directed -> Rep Directed x

to :: Rep Directed x -> Directed

Show Directed

Defined in DotParse.Types

Methods

showsPrec :: Int -> Directed -> ShowS

show :: Directed -> String

showList :: [Directed] -> ShowS

DotParse Directed

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Directed -> ByteString

dotParse :: Parser Error Directed

Eq Directed

Defined in DotParse.Types

Methods

(==) :: Directed -> Directed -> Bool

(/=) :: Directed -> Directed -> Bool

type Rep Directed

Defined in DotParse.Types

type Rep Directed = D1 ('MetaData "Directed" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "Directed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UnDirected" 'PrefixI 'False) (U1 :: Type -> Type))

defDirected :: Last Directed -> Directed

Default Directed is Directed

data ID

Identifier as per the dot language specifications.

>>> runDotParser "0" :: ID
IDInt 0

>>> runDotParser "-.123" :: ID
IDDouble (-0.123)

>>> runParser dotParse "apple_1'" :: Result Error ID
OK (ID "apple_1") "'"

>>> :set -XQuasiQuotes
>>> runParser dotParse "\"hello\"" :: Result Error ID
OK (IDQuoted "hello") ""

>>> runDotParser "<The <font color='red'><b>foo</b></font>,<br/> the <font point-size='20'>bar</font> and<br/> the <i>baz</i>>" :: ID
IDHtml "<The <font color='red'><b>foo</b></font>,<br/> the <font point-size='20'>bar</font> and<br/> the <i>baz</i>>"

>>> runDotParser "shape=diamond" :: (ID,ID)
(ID "shape",ID "diamond")

>>> runDotParser "fontname=\"Arial\"" :: (ID,ID)
(ID "fontname",IDQuoted "Arial")

>>> runDotParser "[shape=diamond; color=blue] [label=label]" :: Map.Map ID ID
fromList [(ID "color",ID "blue"),(ID "label",ID "label"),(ID "shape",ID "diamond")]

Constructors

ID ByteString

IDInt Int

IDDouble Double

IDQuoted ByteString

IDHtml ByteString

Instances

Generic ID

Defined in DotParse.Types

Associated Types

type Rep ID :: Type -> Type

Methods

from :: ID -> Rep ID x

to :: Rep ID x -> ID

Show ID

Defined in DotParse.Types

Methods

showsPrec :: Int -> ID -> ShowS

show :: ID -> String

showList :: [ID] -> ShowS

DotParse ID

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> ID -> ByteString

dotParse :: Parser Error ID

Eq ID

Defined in DotParse.Types

Methods

(==) :: ID -> ID -> Bool

(/=) :: ID -> ID -> Bool

Ord ID

Defined in DotParse.Types

Methods

compare :: ID -> ID -> Ordering

(<) :: ID -> ID -> Bool

(<=) :: ID -> ID -> Bool

(>) :: ID -> ID -> Bool

(>=) :: ID -> ID -> Bool

max :: ID -> ID -> ID

min :: ID -> ID -> ID

DotParse (Map ID ID)

Attribute collections

A given entity can have multiple attribute lists. For simplicity, these are mconcat'ed on parsing.

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Map ID ID -> ByteString

dotParse :: Parser Error (Map ID ID)

DotParse (ID, ID)

Attribute key-value pair of identifiers

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> (ID, ID) -> ByteString

dotParse :: Parser Error (ID, ID)

type Rep ID

Defined in DotParse.Types

type Rep ID = D1 ('MetaData "ID" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) ((C1 ('MetaCons "ID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: C1 ('MetaCons "IDInt" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :+: (C1 ('MetaCons "IDDouble" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :+: (C1 ('MetaCons "IDQuoted" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: C1 ('MetaCons "IDHtml" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))))

label :: ID -> String

ID as the equivalent plain String

note that the dot language identifier equivalence law is:

x == y if label x == label y

data Compass

Compass instructions which are optionally associated with an identifier

Constructors

CompassN

CompassNE

CompassE

CompassSE

CompassS

CompassSW

CompassW

CompassNW

CompassC

Compass_

Instances

Generic Compass

Defined in DotParse.Types

Associated Types

type Rep Compass :: Type -> Type

Methods

from :: Compass -> Rep Compass x

to :: Rep Compass x -> Compass

Show Compass

Defined in DotParse.Types

Methods

showsPrec :: Int -> Compass -> ShowS

show :: Compass -> String

showList :: [Compass] -> ShowS

DotParse Compass

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Compass -> ByteString

dotParse :: Parser Error Compass

Eq Compass

Defined in DotParse.Types

Methods

(==) :: Compass -> Compass -> Bool

(/=) :: Compass -> Compass -> Bool

type Rep Compass

Defined in DotParse.Types

type Rep Compass = D1 ('MetaData "Compass" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (((C1 ('MetaCons "CompassN" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CompassNE" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CompassE" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CompassSE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CompassS" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "CompassSW" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CompassW" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CompassNW" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CompassC" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Compass_" 'PrefixI 'False) (U1 :: Type -> Type)))))

newtype Port

Port instructions which are optionally associated with an identifier

Constructors

Port

Fields

• portID :: These ID Compass

Instances

Generic Port

Defined in DotParse.Types

Associated Types

type Rep Port :: Type -> Type

Methods

from :: Port -> Rep Port x

to :: Rep Port x -> Port

Show Port

Defined in DotParse.Types

Methods

showsPrec :: Int -> Port -> ShowS

show :: Port -> String

showList :: [Port] -> ShowS

DotParse Port

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Port -> ByteString

dotParse :: Parser Error Port

Eq Port

Defined in DotParse.Types

Methods

(==) :: Port -> Port -> Bool

(/=) :: Port -> Port -> Bool

type Rep Port

Defined in DotParse.Types

type Rep Port = D1 ('MetaData "Port" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'True) (C1 ('MetaCons "Port" 'PrefixI 'True) (S1 ('MetaSel ('Just "portID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (These ID Compass))))

data AttributeType

Category of attribute

Constructors

GraphType

NodeType

EdgeType

Instances

Generic AttributeType

Defined in DotParse.Types

Associated Types

type Rep AttributeType :: Type -> Type

Methods

from :: AttributeType -> Rep AttributeType x

to :: Rep AttributeType x -> AttributeType

Show AttributeType

Defined in DotParse.Types

Methods

showsPrec :: Int -> AttributeType -> ShowS

show :: AttributeType -> String

showList :: [AttributeType] -> ShowS

DotParse AttributeType

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> AttributeType -> ByteString

dotParse :: Parser Error AttributeType

Eq AttributeType

Defined in DotParse.Types

Methods

(==) :: AttributeType -> AttributeType -> Bool

(/=) :: AttributeType -> AttributeType -> Bool

type Rep AttributeType

Defined in DotParse.Types

type Rep AttributeType = D1 ('MetaData "AttributeType" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "GraphType" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NodeType" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EdgeType" 'PrefixI 'False) (U1 :: Type -> Type)))

data AttributeStatement

Top-level attribute statement

>>> runDotParser "graph [overlap=false, splines=spline, size=\"1!\"];" :: Statement
StatementAttribute (AttributeStatement {attributeType = GraphType, attributes = fromList [(ID "overlap",ID "false"),(ID "size",IDQuoted "1!"),(ID "splines",ID "spline")]})

Constructors

AttributeStatement

Fields

• attributeType :: AttributeType
• attributes :: Map ID ID

Instances

Generic AttributeStatement

Defined in DotParse.Types

Associated Types

type Rep AttributeStatement :: Type -> Type

Methods

from :: AttributeStatement -> Rep AttributeStatement x

to :: Rep AttributeStatement x -> AttributeStatement

Show AttributeStatement

Defined in DotParse.Types

Methods

showsPrec :: Int -> AttributeStatement -> ShowS

show :: AttributeStatement -> String

showList :: [AttributeStatement] -> ShowS

DotParse AttributeStatement

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> AttributeStatement -> ByteString

dotParse :: Parser Error AttributeStatement

Eq AttributeStatement

Defined in DotParse.Types

Methods

(==) :: AttributeStatement -> AttributeStatement -> Bool

(/=) :: AttributeStatement -> AttributeStatement -> Bool

type Rep AttributeStatement

Defined in DotParse.Types

type Rep AttributeStatement = D1 ('MetaData "AttributeStatement" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "AttributeStatement" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AttributeType) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ID ID))))

data NodeStatement

Node statement

>>> runDotParser "A [shape=diamond; color=blue]" :: Statement
StatementNode (NodeStatement {nodeID = ID "A", port = Nothing, nodeAttrs = fromList [(ID "color",ID "blue"),(ID "shape",ID "diamond")]})

Constructors

NodeStatement

Fields

• nodeID :: ID
• port :: Maybe Port
• nodeAttrs :: Map ID ID

Instances

Generic NodeStatement

Defined in DotParse.Types

Associated Types

type Rep NodeStatement :: Type -> Type

Methods

from :: NodeStatement -> Rep NodeStatement x

to :: Rep NodeStatement x -> NodeStatement

Show NodeStatement

Defined in DotParse.Types

Methods

showsPrec :: Int -> NodeStatement -> ShowS

show :: NodeStatement -> String

showList :: [NodeStatement] -> ShowS

DotParse NodeStatement

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> NodeStatement -> ByteString

dotParse :: Parser Error NodeStatement

Eq NodeStatement

Defined in DotParse.Types

Methods

(==) :: NodeStatement -> NodeStatement -> Bool

(/=) :: NodeStatement -> NodeStatement -> Bool

type Rep NodeStatement

Defined in DotParse.Types

type Rep NodeStatement = D1 ('MetaData "NodeStatement" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "NodeStatement" 'PrefixI 'True) (S1 ('MetaSel ('Just "nodeID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ID) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Port)) :*: S1 ('MetaSel ('Just "nodeAttrs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ID ID)))))

data EdgeID

An edge can be specified in as a NodeID or as a SubGraph

Constructors

EdgeID ID (Maybe Port)

EdgeSubGraph SubGraphStatement

Instances

Generic EdgeID

Defined in DotParse.Types

Associated Types

type Rep EdgeID :: Type -> Type

Methods

from :: EdgeID -> Rep EdgeID x

to :: Rep EdgeID x -> EdgeID

Show EdgeID

Defined in DotParse.Types

Methods

showsPrec :: Int -> EdgeID -> ShowS

show :: EdgeID -> String

showList :: [EdgeID] -> ShowS

DotParse EdgeID

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> EdgeID -> ByteString

dotParse :: Parser Error EdgeID

Eq EdgeID

Defined in DotParse.Types

Methods

(==) :: EdgeID -> EdgeID -> Bool

(/=) :: EdgeID -> EdgeID -> Bool

type Rep EdgeID

Defined in DotParse.Types

type Rep EdgeID = D1 ('MetaData "EdgeID" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "EdgeID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ID) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Port))) :+: C1 ('MetaCons "EdgeSubGraph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SubGraphStatement)))

data EdgeOp

An edgeop is -> in directed graphs and -- in undirected graphs.

Constructors

EdgeDirected

EdgeUndirected

Instances

Generic EdgeOp

Defined in DotParse.Types

Associated Types

type Rep EdgeOp :: Type -> Type

Methods

from :: EdgeOp -> Rep EdgeOp x

to :: Rep EdgeOp x -> EdgeOp

Show EdgeOp

Defined in DotParse.Types

Methods

showsPrec :: Int -> EdgeOp -> ShowS

show :: EdgeOp -> String

showList :: [EdgeOp] -> ShowS

DotParse EdgeOp

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> EdgeOp -> ByteString

dotParse :: Parser Error EdgeOp

Eq EdgeOp

Defined in DotParse.Types

Methods

(==) :: EdgeOp -> EdgeOp -> Bool

(/=) :: EdgeOp -> EdgeOp -> Bool

type Rep EdgeOp

Defined in DotParse.Types

type Rep EdgeOp = D1 ('MetaData "EdgeOp" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "EdgeDirected" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EdgeUndirected" 'PrefixI 'False) (U1 :: Type -> Type))

fromDirected :: Directed -> EdgeOp

generate an EdgeOp given the type of graph.

data EdgeStatement

Edge statement

>>> runDotParser "A -> B [style=dashed, color=grey]" :: Statement
StatementEdge (EdgeStatement {edgeOp = EdgeDirected, leftEdge = EdgeID (ID "A") Nothing, rightEdges = EdgeID (ID "B") Nothing :| [], edgeAttrs = fromList [(ID "color",ID "grey"),(ID "style",ID "dashed")]})

Constructors

EdgeStatement

Fields

• edgeOp :: EdgeOp
• leftEdge :: EdgeID
• rightEdges :: NonEmpty EdgeID
• edgeAttrs :: Map ID ID

Instances

Generic EdgeStatement

Defined in DotParse.Types

Associated Types

type Rep EdgeStatement :: Type -> Type

Methods

from :: EdgeStatement -> Rep EdgeStatement x

to :: Rep EdgeStatement x -> EdgeStatement

Show EdgeStatement

Defined in DotParse.Types

Methods

showsPrec :: Int -> EdgeStatement -> ShowS

show :: EdgeStatement -> String

showList :: [EdgeStatement] -> ShowS

DotParse EdgeStatement

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> EdgeStatement -> ByteString

dotParse :: Parser Error EdgeStatement

Eq EdgeStatement

Defined in DotParse.Types

Methods

(==) :: EdgeStatement -> EdgeStatement -> Bool

(/=) :: EdgeStatement -> EdgeStatement -> Bool

type Rep EdgeStatement

Defined in DotParse.Types

type Rep EdgeStatement = D1 ('MetaData "EdgeStatement" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "EdgeStatement" 'PrefixI 'True) ((S1 ('MetaSel ('Just "edgeOp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EdgeOp) :*: S1 ('MetaSel ('Just "leftEdge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EdgeID)) :*: (S1 ('MetaSel ('Just "rightEdges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty EdgeID)) :*: S1 ('MetaSel ('Just "edgeAttrs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ID ID)))))

edgeID :: EdgeID -> Maybe ID

The edge ID or subgraph ID (if any)

edgeIDs :: EdgeStatement -> [(Maybe ID, Maybe ID)]

list of edges in a given EdgeStatement, including anonymous SugGraphs

edgeIDsNamed :: EdgeStatement -> [(ID, ID)]

edge IDs

data Statement

A dot statement as per the dot language specification.

Constructors

StatementNode NodeStatement

StatementEdge EdgeStatement

StatementGlobalAttribute GlobalAttributeStatement

StatementAttribute AttributeStatement

StatementSubGraph SubGraphStatement

Instances

Generic Statement

Defined in DotParse.Types

Associated Types

type Rep Statement :: Type -> Type

Methods

from :: Statement -> Rep Statement x

to :: Rep Statement x -> Statement

Show Statement

Defined in DotParse.Types

Methods

showsPrec :: Int -> Statement -> ShowS

show :: Statement -> String

showList :: [Statement] -> ShowS

DotParse Statement

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> Statement -> ByteString

dotParse :: Parser Error Statement

Eq Statement

Defined in DotParse.Types

Methods

(==) :: Statement -> Statement -> Bool

(/=) :: Statement -> Statement -> Bool

type Rep Statement

Defined in DotParse.Types

type Rep Statement = D1 ('MetaData "Statement" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) ((C1 ('MetaCons "StatementNode" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NodeStatement)) :+: C1 ('MetaCons "StatementEdge" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EdgeStatement))) :+: (C1 ('MetaCons "StatementGlobalAttribute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GlobalAttributeStatement)) :+: (C1 ('MetaCons "StatementAttribute" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AttributeStatement)) :+: C1 ('MetaCons "StatementSubGraph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SubGraphStatement)))))

addStatement :: Statement -> Graph -> Graph

add a graphviz statement to a Graph

addStatements :: [Statement] -> Graph -> Graph

add a list of graphviz statements to a Graph

data SubGraphStatement

A subgraph statement.

Note: each subgraph must have a unique name

>>> runDotParser "subgraph A {A, B, C}" :: Statement
StatementSubGraph (SubGraphStatement {subgraphID = Just (ID "A"), subgraphStatements = [StatementNode (NodeStatement {nodeID = ID "A", port = Nothing, nodeAttrs = fromList []}),StatementNode (NodeStatement {nodeID = ID "B", port = Nothing, nodeAttrs = fromList []}),StatementNode (NodeStatement {nodeID = ID "C", port = Nothing, nodeAttrs = fromList []})]})

Constructors

SubGraphStatement

Fields

• subgraphID :: Maybe ID
• subgraphStatements :: [Statement]

Instances

Generic SubGraphStatement

Defined in DotParse.Types

Associated Types

type Rep SubGraphStatement :: Type -> Type

Methods

from :: SubGraphStatement -> Rep SubGraphStatement x

to :: Rep SubGraphStatement x -> SubGraphStatement

Show SubGraphStatement

Defined in DotParse.Types

Methods

showsPrec :: Int -> SubGraphStatement -> ShowS

show :: SubGraphStatement -> String

showList :: [SubGraphStatement] -> ShowS

DotParse SubGraphStatement

Defined in DotParse.Types

Methods

dotPrint :: DotConfig -> SubGraphStatement -> ByteString

dotParse :: Parser Error SubGraphStatement

Eq SubGraphStatement

Defined in DotParse.Types

Methods

(==) :: SubGraphStatement -> SubGraphStatement -> Bool

(/=) :: SubGraphStatement -> SubGraphStatement -> Bool

type Rep SubGraphStatement

Defined in DotParse.Types

type Rep SubGraphStatement = D1 ('MetaData "SubGraphStatement" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "SubGraphStatement" 'PrefixI 'True) (S1 ('MetaSel ('Just "subgraphID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ID)) :*: S1 ('MetaSel ('Just "subgraphStatements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Statement])))

Conversion

graphToChartWith :: ChartConfig -> (ID -> Text) -> Graph -> ChartOptions

convert a Graph processed via the graphviz commands to a ChartOptions

graphToChart :: Graph -> ChartOptions

convert a Graph processed via the graphviz commands to a ChartOptions using the default ChartConfig.

data ChartConfig

Various configutaion parameters for the chart-svg Chart

Constructors

ChartConfig

Fields

• chartHeight :: Double
• chartScale :: Double
• edgeSize :: Double
• nodeBorderSize :: Double
• chartColor :: Colour
• chartBackgroundColor :: Colour
• backupNodeHeight :: Double
• backupNodeWidth :: Double
• chartVshift :: Double
• textSize :: Double
• escapeText :: EscapeText

Instances

Generic ChartConfig

Defined in DotParse.Types

Associated Types

type Rep ChartConfig :: Type -> Type

Methods

from :: ChartConfig -> Rep ChartConfig x

to :: Rep ChartConfig x -> ChartConfig

Show ChartConfig

Defined in DotParse.Types

Methods

showsPrec :: Int -> ChartConfig -> ShowS

show :: ChartConfig -> String

showList :: [ChartConfig] -> ShowS

Eq ChartConfig

Defined in DotParse.Types

Methods

(==) :: ChartConfig -> ChartConfig -> Bool

(/=) :: ChartConfig -> ChartConfig -> Bool

type Rep ChartConfig

Defined in DotParse.Types

type Rep ChartConfig = D1 ('MetaData "ChartConfig" "DotParse.Types" "dotparse-0.1.1.0-7ksB5EWrjOr2Em2eE9iYUk" 'False) (C1 ('MetaCons "ChartConfig" 'PrefixI 'True) (((S1 ('MetaSel ('Just "chartHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "chartScale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "edgeSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "nodeBorderSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "chartColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Colour)))) :*: ((S1 ('MetaSel ('Just "chartBackgroundColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Colour) :*: (S1 ('MetaSel ('Just "backupNodeHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "backupNodeWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :*: (S1 ('MetaSel ('Just "chartVshift") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "textSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "escapeText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EscapeText))))))

defaultChartConfig :: ChartConfig

default parameters

toStatements :: Directed -> Graph ByteString -> [Statement]

create Statements from a (no edge label) algebraic graph

toDotGraph :: Graph ByteString -> Graph

Convert an algebraic graph to a dotparse graph, starting with the defaultGraph.

toDotGraphWith :: Directed -> Graph -> Graph ByteString -> Graph

Convert an algebraic graph to a dotparse graph.