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


-- | Configurable text rendering of trees.
--   
--   Configurable text rendering of trees.
@package tree-render-text
@version 0.1.1.0


-- | Configurable text rendering of trees.
--   
--   Example renderings for:
--   
--   <pre>
--   import Data.Tree
--   
--   tree :: Tree String
--   tree =
--     Node "Add"
--       [ Node "Add"
--         [ Node "0" []
--         , Node "Mul"
--           [ Node "1" []
--           , Node "2" []
--           ]
--         ]
--       , Node "Neg"
--         [ Node "Max"
--           [ Node "3" []
--           , Node "4" []
--           , Node "5" []
--           , Node "Var"
--             [ Node "x" []
--             ]
--           , Node "6" []
--           ]
--         ]
--       ]
--   
--   renderTree (tracedRenderOptions id) tree
--   
--   ● Add
--   ├─● Add
--   │ ├─● 0
--   │ ╰─● Mul
--   │   ├─● 1
--   │   ╰─● 2
--   ╰─● Neg
--     ╰─● Max
--       ├─● 3
--       ├─● 4
--       ├─● 5
--       ├─● Var
--       │ ╰─● x
--       ╰─● 6
--   
--   Other renderings by setting 'ParentLocation' and 'ChildOrder' in the options:
--   
--     ╭─● 0         ╭─● 0       ● Add             ╭─● 6         ╭─● 6
--     │ ╭─● 1     ╭─● Add       ├─● Neg           │ ╭─● x       │ ╭─● x
--     │ ├─● 2     │ │ ╭─● 1     │ ╰─● Max         ├─● Var       ├─● Var
--     ├─● Mul     │ ╰─● Mul     │   ├─● 6         ├─● 5         ├─● 5
--   ╭─● Add       │   ╰─● 2     │   ├─● Var       ├─● 4       ╭─● Max
--   │   ╭─● 3     ● Add         │   │ ╰─● x       ├─● 3       │ ├─● 4
--   │   ├─● 4     ╰─● Neg       │   ├─● 5       ╭─● Max       │ ╰─● 3
--   │   ├─● 5       │ ╭─● 3     │   ├─● 4     ╭─● Neg       ╭─● Neg
--   │   │ ╭─● x     │ ├─● 4     │   ╰─● 3     │   ╭─● 2     ● Add
--   │   ├─● Var     ╰─● Max     ╰─● Add       │   ├─● 1     │   ╭─● 2
--   │   ├─● 6         ├─● 5       ├─● Mul     │ ╭─● Mul     │ ╭─● Mul
--   │ ╭─● Max         ├─● Var     │ ├─● 2     │ ├─● 0       │ │ ╰─● 1
--   ├─● Neg           │ ╰─● x     │ ╰─● 1     ├─● Add       ╰─● Add
--   ● Add             ╰─● 6       ╰─● 0       ● Add           ╰─● 0
--   </pre>
module Data.Tree.Render.Text

-- | Describes where a parent node is rendered, relative to its children.
data ParentLocation
ParentBeforeChildren :: ParentLocation
ParentAfterChildren :: ParentLocation
ParentBetweenChildren :: ParentLocation

-- | Describes the render order of a node's children.
data ChildOrder
FirstToLast :: ChildOrder
LastToFirst :: ChildOrder

-- | A part of a path along a rendered tree.
data BranchPath

-- | Describes a turn going up toward the left.
--   
--   e.g. <tt>"╭─"</tt>
BranchUp :: BranchPath

-- | Describes a turn going down toward the left.
--   
--   e.g. <tt>"╰─"</tt>
BranchDown :: BranchPath

-- | Describes a T-join of a path going up and down toward the left.
--   
--   e.g. <tt>"├─"</tt>
BranchJoin :: BranchPath

-- | Describes a path going up and down.
--   
--   e.g. <tt>"│ "</tt>
BranchContinue :: BranchPath

-- | Describes a part that does NOT contain a path piece.
--   
--   e.g. <tt>" "</tt>
BranchEmpty :: BranchPath

-- | Renders a pretty printed <a>Tree</a> within a monadic context.
renderTreeM :: Monad m => RenderOptionsM m string label -> Tree label -> m ()

-- | Renders a pretty printed <a>Forest</a> within a monadic context.
renderForestM :: Monad m => RenderOptionsM m string label -> Forest label -> m ()

-- | Options used for rendering a 'Tree label'.
data RenderOptionsM m string label
RenderOptions :: ParentLocation -> ChildOrder -> Int -> Bool -> (String -> string) -> (string -> m ()) -> (label -> string) -> (label -> string) -> string -> (BranchPath -> string) -> RenderOptionsM m string label

-- | Controls where parent nodes are rendered.
[oParentLocation] :: RenderOptionsM m string label -> ParentLocation

-- | Controls the order a node's children are rendered.
[oChildOrder] :: RenderOptionsM m string label -> ChildOrder

-- | The amount of vertical spacing between nodes.
[oVerticalPad] :: RenderOptionsM m string label -> Int

-- | If <a>True</a>, a newline is prepended to the rendered output.
[oPrependNewLine] :: RenderOptionsM m string label -> Bool

-- | Promotes a <a>String</a> to a <tt>string</tt>.
[oFromString] :: RenderOptionsM m string label -> String -> string

-- | Writes a <tt>string</tt>.
[oWrite] :: RenderOptionsM m string label -> string -> m ()

-- | Shows a <a>rootLabel</a>.
[oShowNodeLabel] :: RenderOptionsM m string label -> label -> string

-- | Get the marker for a node. Although this takes as input a node's
--   <tt>label</tt>, this should not render the label itself.
--   
--   The label is passed as an argument to allow things such as:
--   
--   <ul>
--   <li>Rendering a node marker differently for labels that fail to pass a
--   test.</li>
--   <li>Highlighting a node currently being visited.</li>
--   </ul>
--   
--   Simple use cases would use a constant function ignoring the label
--   value.
[oGetNodeMarker] :: RenderOptionsM m string label -> label -> string

-- | The marker usef for rendering an artificial root when rendering
--   <a>Forest</a>s.
[oForestRootMarker] :: RenderOptionsM m string label -> string

-- | Shows a <a>BranchPath</a>. The returned values should contain no
--   newlines and should all be of the same printed width when rendered as
--   text.
[oShowBranchPath] :: RenderOptionsM m string label -> BranchPath -> string

-- | Options for producing a line-traced tree using unicode drawing
--   characters.
--   
--   This uses:
--   
--   <pre>
--   BranchUp       -&gt; "╭─"
--   BranchDown     -&gt; "╰─"
--   BranchJoin     -&gt; "├─"
--   BranchContinue -&gt; "│ "
--   BranchEmpty    -&gt; "  "
--   </pre>
tracedRenderOptionsM :: (String -> string) -> (string -> m ()) -> (label -> string) -> RenderOptionsM m string label

-- | Options for producing a line-traced tree using ASCII characters.
--   
--   This uses:
--   
--   <pre>
--   BranchUp       -&gt; ",-"
--   BranchDown     -&gt; "`-"
--   BranchJoin     -&gt; "|-"
--   BranchContinue -&gt; "| "
--   BranchEmpty    -&gt; "  "
--   </pre>
tracedRenderOptionsAsciiM :: (String -> string) -> (string -> m ()) -> (label -> string) -> RenderOptionsM m string label

-- | Renders a <a>Tree</a> a pretty printed tree as a <a>String</a>.
renderTree :: RenderOptions String label -> Tree label -> String

-- | Renders a <a>Forest</a> a pretty printed tree as a <a>String</a>.
renderForest :: RenderOptions String label -> Forest label -> String

-- | An alias of <a>RenderOptionsM</a> for producing pure <a>String</a>
--   renders.
type RenderOptions = RenderOptionsM (Writer (DList Char))

-- | Simplified <a>tracedRenderOptionsM</a> when using
--   <a>RenderOptionsM</a>.
tracedRenderOptions :: (label -> String) -> RenderOptions String label

-- | Simplified <a>tracedRenderOptionsAsciiM</a> when using
--   <a>RenderOptionsM</a>.
tracedRenderOptionsAscii :: (label -> String) -> RenderOptions String label
instance GHC.Classes.Ord Data.Tree.Render.Text.BranchPath
instance GHC.Classes.Eq Data.Tree.Render.Text.BranchPath
instance GHC.Show.Show Data.Tree.Render.Text.BranchPath
instance GHC.Classes.Ord Data.Tree.Render.Text.ChildOrder
instance GHC.Classes.Eq Data.Tree.Render.Text.ChildOrder
instance GHC.Show.Show Data.Tree.Render.Text.ChildOrder
instance GHC.Classes.Ord Data.Tree.Render.Text.ParentLocation
instance GHC.Classes.Eq Data.Tree.Render.Text.ParentLocation
instance GHC.Show.Show Data.Tree.Render.Text.ParentLocation