Data.Monoid.TreeDiagram

Tools for working with the TreeDiagram monoid to draw tree diagrams.

Documentation

data TreeDiagram

A monoid for generating tree diagrams

Instances

Monoid TreeDiagram

mempty is the empty tree diagram

>>> printTreeDiagram mempty

>>> printTreeDiagram $ mempty <> singleton 'a' <> mempty
'a'

Defined in Data.Monoid.TreeDiagram

Methods

mempty :: TreeDiagram

mappend :: TreeDiagram -> TreeDiagram -> TreeDiagram

mconcat :: [TreeDiagram] -> TreeDiagram

Semigroup TreeDiagram

<> composes two tree diagrams horizontally, connecting them via horizontal line

>>> printTreeDiagram $ singleton 'a' <> singleton 'b'
'a'─'b'

Defined in Data.Monoid.TreeDiagram

Methods

(<>) :: TreeDiagram -> TreeDiagram -> TreeDiagram

sconcat :: NonEmpty TreeDiagram -> TreeDiagram

stimes :: Integral b => b -> TreeDiagram -> TreeDiagram

showTreeDiagram :: TreeDiagram -> ShowS

render a tree diagram as a function that prepends a multi-line string

printTreeDiagram :: TreeDiagram -> IO ()

print a tree diagram

singleton :: Show a => a -> TreeDiagram

draw a value as a simple, single-line tree diagram

>>> printTreeDiagram $ singleton 'a'
'a'

subtree :: TreeDiagram -> TreeDiagram

Move a tree diagram to the subtree level, dropping a line down from the graph line to connect it to the new toplevel.

>>> printTreeDiagram $ subtree (singleton 'a') <> singleton 'b' <> subtree (singleton 'c')
 ┌─'b'─┐
 │     │
'a'   'c'
>>> printTreeDiagram $ subtree mempty
╷
│
╵

width :: TreeDiagram -> Int

Full width of a tree diagram

>>> let d = singleton 'a' <> subtree (subtree (singleton 'b') <> singleton 'c')
>>> printTreeDiagram d
'a'───┐
      │
    ┌─'c'
    │
   'b'
>>> width d
9

height :: TreeDiagram -> Int

Full height of a tree diagram

>>> let d = singleton 'a' <> subtree (subtree (singleton 'b') <> singleton 'c')
>>> printTreeDiagram d
'a'───┐
      │
    ┌─'c'
    │
   'b'
>>> height d
5