Module Lib.PP

Courtesy of Philip Wadler.

This is a port of Prof. Philip Wadlers pretty printer library to Frege. For more info see "http://homepages.inf.ed.ac.uk/wadler/papers/prettier/prettier.pdf"

Imports

• import frege.Prelude as Prelude
• import Prelude.PreludeArrays as PreludeArrays
• import Prelude.PreludeBase as PreludeBase
• import Prelude.PreludeDecimal as PreludeDecimal
• import Prelude.PreludeIO as PreludeIO
• import Prelude.PreludeList as PreludeList
• import Prelude.PreludeMonad as PreludeMonad
• import Prelude.PreludeText as PreludeText
• import Java.util.Regex as Regexp

Table of Content

• Definitions

  data DOCUMENT

  data Doc

  data PDOC

  <> ∷ DOCUMENT → DOCUMENT → DOCUMENT 

  nest ∷ Int → DOCUMENT → DOCUMENT

  text ∷ String → DOCUMENT

  group ∷ DOCUMENT → DOCUMENT

  flatten ∷ DOCUMENT → DOCUMENT

  layout' ∷ Doc → String

  layout ∷ Doc → ST 𝖆 String

  appendableFromWriter ∷ MutableIO Writer → STMutable RealWorld Appendable 

  prettyIO ∷ MutableIO Writer → Int → DOCUMENT → IO ()

  blanks64 ∷ String

  best ∷ Int → Int → DOCUMENT → Doc

  be ∷ Int → Int → [PDOC] → Doc

  better ∷ Int → Int → Doc → Maybe Doc

  fits ∷ Int → Doc → Bool

  pretty ∷ Int → DOCUMENT → String

  <+> ∷ DOCUMENT → DOCUMENT → DOCUMENT 

  </> ∷ DOCUMENT → DOCUMENT → DOCUMENT 

  folddoc ∷ (DOCUMENT→DOCUMENT→DOCUMENT) → [DOCUMENT] → DOCUMENT

  spread ∷ [DOCUMENT] → DOCUMENT

  stack ∷ [DOCUMENT] → DOCUMENT

  bracket ∷ String → DOCUMENT → String → DOCUMENT

  block ∷ String → DOCUMENT → String → DOCUMENT

  <~/> ∷ DOCUMENT → DOCUMENT → DOCUMENT 

  <+/> ∷ DOCUMENT → DOCUMENT → DOCUMENT 

  fill ∷ [DOCUMENT] → DOCUMENT

  sep ∷ String → [DOCUMENT] → DOCUMENT

  tight ∷ String → [DOCUMENT] → DOCUMENT

  break ∷ String → [DOCUMENT]

  msgdoc ∷ String → DOCUMENT

• Re-Exported Items

  toList ∷ Maybe 𝖆 → [𝖆]

• Functions and Values by Type

Definitions

data DOCUMENT

Constructors

APPEND DOCUMENT   DOCUMENT

GROUP DOCUMENT   DOCUMENT
infixr  9

LINE

NEST Int   DOCUMENT

NONE

TEXT (String)

data Doc

Constructors

Line {ind ∷ Int, doc ∷ Doc}

None

Text {hd ∷ String, doc ∷ Doc}

Member Functions

doc ∷ Doc → Doc

access field doc

hd ∷ Doc → String

access field hd

ind ∷ Doc → Int

access field ind

<> ∷ DOCUMENT → DOCUMENT → DOCUMENT
infixr  6

nest ∷ Int → DOCUMENT → DOCUMENT

text ∷ String → DOCUMENT

group ∷ DOCUMENT → DOCUMENT

flatten ∷ DOCUMENT → DOCUMENT

layout' ∷ Doc → String

layout ∷ Doc → ST 𝖆 String

appendableFromWriter ∷ MutableIO Writer → STMutable RealWorld Appendable
native (Appendable)

prettyIO ∷ MutableIO Writer → Int → DOCUMENT → IO ()

blanks64 ∷ String

data PDOC

Constructors

PDOC {off ∷ Int, doc ∷ DOCUMENT}

Member Functions

doc ∷ PDOC → DOCUMENT

access field doc

off ∷ PDOC → Int

access field off

best ∷ Int → Int → DOCUMENT → Doc

be ∷ Int → Int → [PDOC] → Doc

better ∷ Int → Int → Doc → Maybe Doc

fits ∷ Int → Doc → Bool

pretty ∷ Int → DOCUMENT → String

<+> ∷ DOCUMENT → DOCUMENT → DOCUMENT
infixr  8

two documents with intervening space

</> ∷ DOCUMENT → DOCUMENT → DOCUMENT
infixr  7

two documents stacked

folddoc ∷ (DOCUMENT→DOCUMENT→DOCUMENT) → [DOCUMENT] → DOCUMENT

spread ∷ [DOCUMENT] → DOCUMENT

some documents with space inbetween

stack ∷ [DOCUMENT] → DOCUMENT

some documents stacked

bracket ∷ String → DOCUMENT → String → DOCUMENT

block ∷ String → DOCUMENT → String → DOCUMENT

<~/> ∷ DOCUMENT → DOCUMENT → DOCUMENT
infixr  7

join two documents without intervening space or stack them

<+/> ∷ DOCUMENT → DOCUMENT → DOCUMENT
infixr  7

join two documents with intervening space or stack them

fill ∷ [DOCUMENT] → DOCUMENT

sep ∷ String → [DOCUMENT] → DOCUMENT

like fill, but with separator between items

tight ∷ String → [DOCUMENT] → DOCUMENT

like sep, but no space after separator

break ∷ String → [DOCUMENT]

fill words of a string

msgdoc ∷ String → DOCUMENT

turn a string into a document by breaking on space and filling up

Functions and Values by Type

(DOCUMENT→DOCUMENT→DOCUMENT) → [DOCUMENT] → DOCUMENT

folddoc

MutableIO Writer → Int → DOCUMENT → IO ()

prettyIO

MutableIO Writer → STMutable RealWorld Appendable

appendableFromWriter

String → [DOCUMENT] → DOCUMENT

sep, tight

String → DOCUMENT → String → DOCUMENT

block, bracket

String → Doc → Doc

Doc.Text

String → [DOCUMENT]

break

String → DOCUMENT

msgdoc, text, DOCUMENT.TEXT

[DOCUMENT] → DOCUMENT

fill, spread, stack

DOCUMENT → DOCUMENT → DOCUMENT

<+/>, <+>, </>, <>, <~/>, DOCUMENT.APPEND, DOCUMENT.GROUP

DOCUMENT → DOCUMENT

flatten, group

Doc → (String→String) → Doc

Doc.chg$hd

Doc → (Doc→Doc) → Doc

Doc.chg$doc

Doc → (Int→Int) → Doc

Doc.chg$ind

Doc → String → Doc

Doc.upd$hd

Doc → Doc → Doc

Doc.upd$doc

Doc → Int → Doc

Doc.upd$ind

Doc → String

layout', Doc.hd

Doc → Doc

Doc.doc

Doc → Bool

Doc.has$ind, Doc.has$doc, Doc.has$hd

Doc → Int

Doc.ind

PDOC → (DOCUMENT→DOCUMENT) → PDOC

PDOC.chg$doc

PDOC → (Int→Int) → PDOC

PDOC.chg$off

PDOC → DOCUMENT → PDOC

PDOC.upd$doc

PDOC → Int → PDOC

PDOC.upd$off

PDOC → DOCUMENT

PDOC.doc

PDOC → Int

PDOC.off

Int → DOCUMENT → String

pretty

Int → DOCUMENT → DOCUMENT

nest, DOCUMENT.NEST

Int → DOCUMENT → PDOC

PDOC.PDOC

Int → Doc → Doc

Doc.Line

Int → Doc → Bool

fits

Int → Int → [PDOC] → Doc

be

Int → Int → DOCUMENT → Doc

best

Int → Int → Doc → Maybe Doc

better

String

blanks64

DOCUMENT

DOCUMENT.NONE, DOCUMENT.LINE

Doc

Doc.None

Doc → ST 𝖆 String

layout

𝖆 → Bool

PDOC.has$doc, PDOC.has$off