-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Library and binary to generate sequence/flow diagrams from plain text source
--   
--   Generates sequence diagrams from textual descriptions with help of
--   Graphviz graph drawing tool.
@package flow2dot
@version 0.9.2


-- | Converts flow diagrams to the Graphviz (Dot) files for subsequent
--   rendering into nice pictures.
module Text.FlowDiagram

-- | <a>flow2dot</a> take a list of flow diagram items (<a>Flow</a>) and
--   converts them to Graphviz code
flow2dot :: [Flow] -> String

-- | Parse given string and return Flow Diagram contained therein. All
--   syntax errors are thrown via <a>error</a>
parseFlow :: String -> String -> [Flow]

-- | Parse specified file and return Flow Diagram contained therein. All
--   syntax errors are thrown via <a>error</a>
parseFlowFromFile :: FilePath -> IO [Flow]

-- | Print element of the flow diagram as String
showFlow :: Flow -> String

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

-- | Message (from, to, message text). Syntax in the source file: <tt>from
--   -&gt; to: message text</tt>
Msg :: Swimline -> Swimline -> String -> Flow

-- | Action (actor, message text). Syntax in the source file: <tt>actor:
--   message text</tt>
Action :: Swimline -> String -> Flow

-- | Tries to put swimlines in the specified order. Syntax: <tt>order
--   swimline1 swimline2 ...</tt>
Order :: [Swimline] -> Flow
instance GHC.Show.Show Text.FlowDiagram.Flow
instance GHC.Classes.Eq Text.FlowDiagram.Flow