Text.FlowDiagram

Converts flow diagrams to the Graphviz (Dot) files for subsequent rendering into nice pictures.

Documentation

flow2dot :: [Flow] -> String

flow2dot take a list of flow diagram items (Flow) and converts them to Graphviz code

parseFlow :: String -> String -> [Flow]

Parse given string and return Flow Diagram contained therein. All syntax errors are thrown via error

parseFlowFromFile :: FilePath -> IO [Flow]

Parse specified file and return Flow Diagram contained therein. All syntax errors are thrown via error

showFlow :: Flow -> String

Print element of the flow diagram as String

data Flow

Flow could include messages and actions, one item per source line

Constructors

Msg Swimline Swimline String

Message (from, to, message text). Syntax in the source file: from -> to: message text

Action Swimline String

Action (actor, message text). Syntax in the source file: actor: message text

Order [Swimline]

Tries to put swimlines in the specified order. Syntax: order swimline1 swimline2 ...

Instances

Eq Flow

Defined in Text.FlowDiagram

Methods

(==) :: Flow -> Flow -> Bool

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

Show Flow

Defined in Text.FlowDiagram

Methods

showsPrec :: Int -> Flow -> ShowS

show :: Flow -> String

showList :: [Flow] -> ShowS