Data.Tree.Render.Text

Configurable text rendering of trees.

Documentation

data ParentLocation

Describes where a parent node is rendered, relative to its children.

Constructors

ParentBeforeChildren

ParentAfterChildren

ParentBetweenChildren

Instances

Eq ParentLocation

Defined in Data.Tree.Render.Text

Methods

(==) :: ParentLocation -> ParentLocation -> Bool

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

Ord ParentLocation

Defined in Data.Tree.Render.Text

Methods

compare :: ParentLocation -> ParentLocation -> Ordering

(<) :: ParentLocation -> ParentLocation -> Bool

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

(>) :: ParentLocation -> ParentLocation -> Bool

(>=) :: ParentLocation -> ParentLocation -> Bool

max :: ParentLocation -> ParentLocation -> ParentLocation

min :: ParentLocation -> ParentLocation -> ParentLocation

Show ParentLocation

Defined in Data.Tree.Render.Text

Methods

showsPrec :: Int -> ParentLocation -> ShowS

show :: ParentLocation -> String

showList :: [ParentLocation] -> ShowS

data ChildOrder

Describes the render order of a node's children.

Constructors

FirstToLast

LastToFirst

Instances

Eq ChildOrder

Defined in Data.Tree.Render.Text

Methods

(==) :: ChildOrder -> ChildOrder -> Bool

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

Ord ChildOrder

Defined in Data.Tree.Render.Text

Methods

compare :: ChildOrder -> ChildOrder -> Ordering

(<) :: ChildOrder -> ChildOrder -> Bool

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

(>) :: ChildOrder -> ChildOrder -> Bool

(>=) :: ChildOrder -> ChildOrder -> Bool

max :: ChildOrder -> ChildOrder -> ChildOrder

min :: ChildOrder -> ChildOrder -> ChildOrder

Show ChildOrder

Defined in Data.Tree.Render.Text

Methods

showsPrec :: Int -> ChildOrder -> ShowS

show :: ChildOrder -> String

showList :: [ChildOrder] -> ShowS

data BranchPath

A part of a path along a rendered tree.

Constructors

BranchUp

Describes a turn going up toward the left.

e.g. ╭─

BranchDown

Describes a turn going down toward the left.

e.g. ╰─

BranchJoin

Describes a T-join of a path going up and down toward the left.

e.g. ├─

BranchContinue

Describes a path going up and down.

e.g. │

BranchEmpty

Describes a part that does NOT contain a path piece.

e.g.

Instances

Eq BranchPath

Defined in Data.Tree.Render.Text

Methods

(==) :: BranchPath -> BranchPath -> Bool

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

Ord BranchPath

Defined in Data.Tree.Render.Text

Methods

compare :: BranchPath -> BranchPath -> Ordering

(<) :: BranchPath -> BranchPath -> Bool

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

(>) :: BranchPath -> BranchPath -> Bool

(>=) :: BranchPath -> BranchPath -> Bool

max :: BranchPath -> BranchPath -> BranchPath

min :: BranchPath -> BranchPath -> BranchPath

Show BranchPath

Defined in Data.Tree.Render.Text

Methods

showsPrec :: Int -> BranchPath -> ShowS

show :: BranchPath -> String

showList :: [BranchPath] -> ShowS

renderTreeM :: Monad m => RenderOptionsM m string label -> Tree label -> m ()

Renders a pretty printed tree within a monadic context.

data RenderOptionsM m string label

Options used for rendering a 'Tree label'.

Constructors

RenderOptions

Fields

• oParentLocation :: ParentLocation

  Controls where parent nodes are rendered.

• oChildOrder :: ChildOrder

  Controls the order a node's children are rendered.

• oVerticalPad :: Int

  The amount of vertical spacing between nodes.

• oPrependNewLine :: Bool

  If True, a newline is prepended to the rendered output.

• oFromString :: String -> string

  Promotes a String to a string.

• oWrite :: string -> m ()

  Writes a string.

• oShowNodeLabel :: label -> string

  Shows a rootLabel.

• oGetNodeMarker :: label -> string

  Get the marker for a node. Although this takes as input a node's label, this should not render the label itself.

  The label is passed as an argument to allow things such as: * Rendering a node marker differently for labels that fail to pass a test. * Highlighting a node currently being visited.

  Simple use cases would use a constant function ignoring the label value.

• oShowBranchPath :: BranchPath -> string

  Shows a BranchPath. The returned values should contain no newlines and should all be of the same printed width when rendered as text.

tracedRenderOptionsM

Arguments

:: (String -> string)

Promotes a String to a string.

-> (string -> m ())

Writes a string.

-> (label -> string)

Shows a rootLabel.

-> RenderOptionsM m string label

Options for producing a line-traced tree using unicode drawing characters.

This uses: BranchUp -> "╭─" BranchDown -> "╰─" BranchJoin -> "├─" BranchContinue -> "│ " BranchEmpty -> " "

tracedRenderOptionsAsciiM

Arguments

:: (String -> string)

Promotes a String to a string.

-> (string -> m ())

Writes a string.

-> (label -> string)

Shows a rootLabel.

-> RenderOptionsM m string label

Options for producing a line-traced tree using ASCII characters.

This uses: BranchUp -> ",-" BranchDown -> "`-" BranchJoin -> "|-" BranchContinue -> "| " BranchEmpty -> " "

renderTree :: RenderOptions String label -> Tree label -> String

Renders a Tree a pretty printed tree asa a String.

type RenderOptions = RenderOptionsM (Writer (DList Char))

An alias of RenderOptionsM for producing pure String renders.

tracedRenderOptions

Arguments

:: (label -> String)

Shows a rootLabel.

-> RenderOptions String label

Simplified tracedRenderOptionsM when using RenderOptionsM.

tracedRenderOptionsAscii

Arguments

:: (label -> String)

Shows a rootLabel.

-> RenderOptions String label

Simplified tracedRenderOptionsAsciiM when using RenderOptionsM.