Moduleprettyprinter-1.7.2Haskell2010

Prettyprinter.Render.Util.SimpleDocTree

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

1 type
6 values

Packageprettyprinter-1.7.2
Exports7
LanguageHaskell2010
LicenceBSD-2-Clause
SourceSimpleDocTree.hs

Type and conversion

2 declarations

datadata SimpleDocTree ann

A SimpleDocStream is a linked list of different annotated cons cells (SText and then some further SimpleDocStream, SLine and then some further SimpleDocStream, …). 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
length is O(n), so we cache it in the Int field.
STLine !Int
Int = indentation level for the (next) line
STAnn ann (SimpleDocTree ann)
Annotate the contained document.
STConcat [SimpleDocTree ann]
Horizontal concatenation of multiple documents.

Instances8Functor, Foldable, Traversable, Eq, Ord, Show, …

Functor SimpleDocTreeDefined in prettyprinter-1.7.2 · Prettyprinter.Render.Util.SimpleDocTree
Alter the document’s annotations.
This instance makes SimpleDocTree more flexible (because it can be used in Functor-polymorphic values), but fmap is much less readable compared to using reAnnotateST in code that only works for SimpleDocTree anyway. Consider using the latter when the type does not matter.
Foldable SimpleDocTreeDefined in prettyprinter-1.7.2 · Prettyprinter.Render.Util.SimpleDocTree
Collect all annotations from a document.
Traversable SimpleDocTreeDefined in prettyprinter-1.7.2 · Prettyprinter.Render.Util.SimpleDocTree
Transform a document based on its annotations, possibly leveraging Applicative effects.
Eq ann => Eq (SimpleDocTree ann)Defined in prettyprinter-1.7.2 · Prettyprinter.Render.Util.SimpleDocTree
Ord ann => Ord (SimpleDocTree ann)Defined in prettyprinter-1.7.2 · Prettyprinter.Render.Util.SimpleDocTree
Show ann => Show (SimpleDocTree ann)Defined in prettyprinter-1.7.2 · Prettyprinter.Render.Util.SimpleDocTree
Generic (SimpleDocTree ann)Defined in prettyprinter-1.7.2 · Prettyprinter.Render.Util.SimpleDocTree
type Rep (SimpleDocTree ann) = D1 ('MetaData "SimpleDocTree" "Prettyprinter.Render.Util.SimpleDocTree" "prettyprinter-1.7.2-SPFFk7WrbZ5dowUcxRlzD" 'False) ((C1 ('MetaCons "STEmpty" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "STChar" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Char)) :+: C1 ('MetaCons "STText" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :+: (C1 ('MetaCons "STLine" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int)) :+: (C1 ('MetaCons "STAnn" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ann) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SimpleDocTree ann))) :+: C1 ('MetaCons "STConcat" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SimpleDocTree ann])))))Defined in prettyprinter-1.7.2 · Prettyprinter.Render.Util.SimpleDocTree

valuetreeForm :: SimpleDocStream ann -> SimpleDocTree ann

Convert a SimpleDocStream to its SimpleDocTree representation.

Manipulating annotations

3 declarations

valueunAnnotateST :: SimpleDocTree ann -> SimpleDocTree xxx

Remove all annotations. unAnnotate for SimpleDocTree.

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

Change the annotation of a document. reAnnotate for SimpleDocTree.

valuealterAnnotationsST

:: ann -> [ann']
-> SimpleDocTree ann
-> SimpleDocTree ann'

Change the annotation of a document to a different annotation, or none at all. alterAnnotations for SimpleDocTree.

Note that this is as powerful as alterAnnotations, allowing one annotation to become multiple ones, contrary to alterAnnotationsS, which cannot do this.

Common use case shortcut definitions

2 declarations

valuerenderSimplyDecorated

:: Monoid out
=> (Text -> out)
Render plain Text
-> (ann -> out -> out)
How to modify an element with an annotation
-> SimpleDocTree ann
-> out

Simplest possible tree-based renderer.

For example, here is a document annotated with (), and the behaviour is to surround annotated regions with »>>>« and »<<<«:

Example3 expressions

>>> let doc = "hello" <+> annotate () "world" <> "!">>> let stdoc = treeForm (layoutPretty defaultLayoutOptions doc)>>> T.putStrLn (renderSimplyDecorated id (\() x -> ">>>" <> x <> "<<<") stdoc)hello >>>world<<<!

valuerenderSimplyDecoratedA

:: (Applicative f, Monoid out)
=> (Text -> f out)
Render plain Text
-> (ann -> f out -> f out)
How to modify an element with an annotation
-> SimpleDocTree ann
-> f out

Version of renderSimplyDecoratedA that allows for Applicative effects.