DataFlow.Core

Documentation

type ID = String

An identifier corresponding to those in Graphviz.

type Name = String

The name of a Diagram or Object.

type Operation = String

Operation heading.

type Description = String

Operation description.

data Diagram

The top level diagram.

Constructors

Diagram Name [Object]

Instances

RenderDFD Diagram

data Object

An object in a diagram.

Constructors

InputOutput ID Name

A Input or Output in DFD.

TrustBoundary ID Name [Object]

Surrounds other objects, denoting a boundary.

Function ID Name

A "Function" in DFD.

Database ID Name

A "Database" in DFD.

Flow ID ID Operation Description

Describes the flow of data between two objects.

Instances

Eq Object

Show Object

RenderDFD Object

type Renderer t = WriterT [String] (State RendererState) t

The Renderer represents some output generator that runs on a Diagram.

evalDiagram :: Renderer () -> String

Run the Renderer and get the output as a String.

write :: String -> Renderer ()

Write a string to the output (no linefeed).

writeln :: String -> Renderer ()

Write a string to the output (with linefeed).

nextStep :: Renderer Int

Get the next "step" number (the order of flow arrows in the diagram).

indent :: Renderer ()

Increase indent with 2 spaces.

dedent :: Renderer ()

Decrease indent with 2 spaces.

withIndent :: Renderer () -> Renderer ()

Indent the output of gen with 2 spaces.

blank :: Renderer ()

Write a blank line.

label :: Renderer () -> Renderer ()

Write a label with the output of gen as its contents.

tag :: String -> String -> Renderer () -> Renderer ()

Write an HTML tag t with the output of gen as its contents.

bold :: Renderer () -> Renderer ()

Write a <b> tag surrounding the output of another Renderer.

table :: String -> Renderer () -> Renderer ()

Write a <table> tag, with attributes, surrounding the output of another Renderer.

tr :: Renderer () -> Renderer ()

Write a <tr> tag surrounding the output of another Renderer.

td :: Renderer () -> Renderer ()

Write a <td> tag surrounding the output of another Renderer.

data Enclosing

The enclosing characters in a block.

Constructors

Brackets

CurlyBrackets

objectWith :: Enclosing -> ID -> Renderer () -> Renderer ()

Write an object with the given Enclosing characters, ID and Renderer as its contents.

attrs :: ID -> String -> Renderer ()

Write an attributes declaration for the given ID.