DzenDhall.AST.Render

Everything needed to convert an AST to Text.

Documentation

data RenderState

Stacks are used to backtrack various dzen markup language tags.

Dzen itself does not perform backtracking, thus, for example, the letter "c" in ^fg(red)a^fg(green)b^fg()c^fg() will not be colorized, but render definition for AST mitigates this flaw.

For example,

runRender $
  ASTProp (FG $ Color "red")
    (ASTs (ASTs (ASTText "a")
                (ASTProp (FG $ Color "green")
                  (ASTText "b")))
          (ASTText "c"))

will be rendered as ^fg(red)a^fg(green)b^fg(red)c^fg() (so that "c" will be red).

Constructors

RenderState

Fields

• _bgStack :: [Color]
• _fgStack :: [Color]
• _ibStack :: [IgnoreBackground]

data IgnoreBackground

A flag that indicates that background should be ignored (analogous to ^ib() dzen markup command).

Constructors

IgnoreBackground

Instances

Renderable IgnoreBackground

Defined in DzenDhall.AST.Render

Methods

render :: IgnoreBackground -> Render ()

ibStack :: Lens' RenderState [IgnoreBackground]

fgStack :: Lens' RenderState [Color]

bgStack :: Lens' RenderState [Color]

type Stack a = Lens' RenderState [a]

type Render = StateT RenderState (Writer Text)

runRender :: Renderable a => a -> Text

class Renderable a where

Methods

render :: a -> Render ()

Instances

Renderable Event

Defined in DzenDhall.AST.Render

Methods

render :: Event -> Render ()

Renderable Button

Defined in DzenDhall.AST.Render

Methods

render :: Button -> Render ()

Renderable AbsolutePosition

Defined in DzenDhall.AST.Render

Methods

render :: AbsolutePosition -> Render ()

Renderable Color

Defined in DzenDhall.AST.Render

Methods

render :: Color -> Render ()

Renderable ClickableArea

Defined in DzenDhall.AST.Render

Methods

render :: ClickableArea -> Render ()

Renderable Shape

Defined in DzenDhall.AST.Render

Methods

render :: Shape -> Render ()

Renderable AST

Defined in DzenDhall.AST.Render

Methods

render :: AST -> Render ()

Renderable IgnoreBackground

Defined in DzenDhall.AST.Render

Methods

render :: IgnoreBackground -> Render ()

Helper functions

write :: Text -> Render ()

usingStackWithTag :: Renderable a => Stack a -> Text -> a -> AST -> Render ()

^fg(), ^bg() and ^ib() are rendered using the same algorithm.

pop :: Stack a -> Render (Maybe a)

push :: Stack a -> a -> Render ()

renew :: Renderable a => Stack a -> Text -> Render ()