Data.Text.Prettyprint.Doc.Render.Util.SimpleDocTree

Conversion of the linked-list-like SimpleDoc to a tree-like SimpleDocTree.

Documentation

data SimpleDocTree ann

A SimpleDoc is a linked list of different annotated cons cells (SText and then some further SimpleDoc, SLine and then some further SimpleDoc, …). This format is very suitable as a target for a layout engine, but not very useful for rendering to a structured format such as HTML, where we don’t want to do a lookahead until the end of some markup. These formats benefit from a tree-like structure that explicitly marks its contents as annotated. SimpleDocTree is that format.

Constructors

STEmpty

STChar Char

STText !Int Text

STLine !Int

STAnn ann (SimpleDocTree ann)

STConcat [SimpleDocTree ann]

Instances

Eq ann => Eq (SimpleDocTree ann)

Methods

(==) :: SimpleDocTree ann -> SimpleDocTree ann -> Bool

(/=) :: SimpleDocTree ann -> SimpleDocTree ann -> Bool

Ord ann => Ord (SimpleDocTree ann)

Methods

compare :: SimpleDocTree ann -> SimpleDocTree ann -> Ordering

(<) :: SimpleDocTree ann -> SimpleDocTree ann -> Bool

(<=) :: SimpleDocTree ann -> SimpleDocTree ann -> Bool

(>) :: SimpleDocTree ann -> SimpleDocTree ann -> Bool

(>=) :: SimpleDocTree ann -> SimpleDocTree ann -> Bool

max :: SimpleDocTree ann -> SimpleDocTree ann -> SimpleDocTree ann

min :: SimpleDocTree ann -> SimpleDocTree ann -> SimpleDocTree ann

Show ann => Show (SimpleDocTree ann)

Methods

showsPrec :: Int -> SimpleDocTree ann -> ShowS

show :: SimpleDocTree ann -> String

showList :: [SimpleDocTree ann] -> ShowS

treeForm :: SimpleDoc ann -> SimpleDocTree ann

Convert a SimpleDoc to its SimpleDocTree representation.

unAnnotateST :: SimpleDocTree ann -> SimpleDocTree xxx

Remove all annotations. unAnnotate for SimpleDocTree.

reAnnotateST :: (ann -> ann') -> SimpleDocTree ann -> SimpleDocTree ann'

Change the annotation of a document. reAnnotate for SimpleDocTree.