-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Wadler/Leijen pretty printer with annotations and slightly modernized API -- -- Wadler/Leijen pretty printer with annotations and slightly modernized -- API @package wl-pprint-annotated @version 0.0.1.4 -- | Pretty print module based on Daan Leijen's implementation of Philip -- Wadler's "prettier printer" -- --
-- "A prettier printer" -- Draft paper, April 1997, revised March 1998. -- http://homepages.inf.ed.ac.uk/wadler/papers/prettier/prettier.pdf ---- -- This is an implementation of the pretty printing combinators described -- by Philip Wadler (1997). In their bare essence, the combinators of -- Wadler are not expressive enough to describe some commonly occurring -- layouts. The PPrint library adds new primitives to describe these -- layouts and works well in practice. -- -- The library is based on a single way to concatenate documents, which -- is associative and has both a left and right unit. This simple design -- leads to an efficient and short implementation. The simplicity is -- reflected in the predictable behaviour of the combinators which make -- them easy to use in practice. -- -- A thorough description of the primitive combinators and their -- implementation can be found in Philip Wadler's paper (1997). Additions -- and the main differences with his original paper are: -- --
-- show (text "hello" <#> text "world") ---- -- Which would return the string "hello\nworld", i.e. -- --
-- hello -- world --data Doc a Empty :: Doc a Char :: {-# UNPACK #-} !Char -> Doc a Text :: {-# UNPACK #-} !Int -> String -> Doc a Line :: Doc a FlatAlt :: (Doc a) -> (Doc a) -> Doc a Cat :: (Doc a) -> (Doc a) -> Doc a Nest :: {-# UNPACK #-} !Int -> (Doc a) -> Doc a Union :: (Doc a) -> (Doc a) -> Doc a Annotate :: a -> (Doc a) -> Doc a Column :: (Int -> Doc a) -> Doc a Nesting :: (Int -> Doc a) -> Doc a Columns :: (Maybe Int -> Doc a) -> Doc a Ribbon :: (Maybe Int -> Doc a) -> Doc a -- | The action (putDoc doc) pretty prints document doc -- to the standard output, with a page width of 100 characters and a -- ribbon width of 40 characters. -- --
-- main :: IO ()
-- main = do{ putDoc (text "hello" <+> text "world") }
--
--
-- Which would output
--
-- -- hello world --putDoc :: Doc a -> IO () -- | (hPutDoc handle doc) pretty prints document doc to -- the file handle handle with a page width of 100 characters -- and a ribbon width of 40 characters. -- --
-- main = do{ handle <- openFile "MyFile" WriteMode
-- ; hPutDoc handle (vcat (map text
-- ["vertical","text"]))
-- ; hClose handle
-- }
--
hPutDoc :: Handle -> Doc a -> IO ()
-- | The document (char c) contains the literal character
-- c. The character shouldn't be a newline ('\n'), the
-- function line should be used for line breaks.
char :: Char -> Doc a
-- | The document (text s) contains the literal string s.
-- The string shouldn't contain any newline ('\n') characters.
-- If the string contains newline characters, the function pretty
-- should be used.
text :: String -> Doc a
-- | The document (nest i x) renders document x with the
-- current indentation level increased by i (See also hang,
-- align and indent).
--
-- -- nest 2 (text "hello" <#> text "world") <#> text "!" ---- -- outputs as: -- --
-- hello -- world -- ! --nest :: Int -> Doc a -> Doc a -- | The line document advances to the next line and indents to -- the current nesting level. Document line behaves like -- (text " ") if the line break is undone by group. line :: Doc a -- | The linebreak document advances to the next line and indents -- to the current nesting level. Document linebreak behaves like -- mempty if the line break is undone by group. linebreak :: Doc a -- | The group combinator is used to specify alternative layouts. -- The document (group x) undoes all line breaks in document -- x. The resulting line is added to the current line if that -- fits the page. Otherwise, the document x is rendered without -- any changes. group :: Doc a -> Doc a -- | The document softline behaves like space if the -- resulting output fits the page, otherwise it behaves like line. -- --
-- softline = group line --softline :: Doc a -- | The document softbreak behaves like mempty if the -- resulting output fits the page, otherwise it behaves like line. -- --
-- softbreak = group linebreak --softbreak :: Doc a -- | A linebreak that can not be flattened; it is guaranteed to be rendered -- as a newline. hardline :: Doc a -- | flatAlt creates a document that changes when flattened; -- normally it is rendered as the first argument, but when flattened is -- rendered as the second. flatAlt :: Doc a -> Doc a -> Doc a flatten :: Doc a -> Doc a -- | Annotate a document. annotate :: a -> Doc a -> Doc a -- | Remove the annotations from a document. noAnnotate :: Doc a -> Doc a' docMapAnn :: (a -> Doc a' -> Doc a') -> Doc a -> Doc a' simpleDocMapAnn :: (r -> a -> r) -> (r -> a -> r) -> (r -> SimpleDoc a' -> SimpleDoc a') -> (r -> SimpleDoc a' -> SimpleDoc a') -> r -> SimpleDoc a -> SimpleDoc a' simpleDocScanAnn :: (r -> a -> r) -> r -> SimpleDoc a -> SimpleDoc r -- | The document (align x) renders document x with the -- nesting level set to the current column. It is used for example to -- implement hang. -- -- As an example, we will put a document right above another one, -- regardless of the current nesting level: -- --
-- x $$ y = align (x <#> y) ---- --
-- test = text "hi" <+> (text "nice" $$ text "world") ---- -- which will be layed out as: -- --
-- hi nice -- world --align :: Doc a -> Doc a -- | The hang combinator implements hanging indentation. The document -- (hang i x) renders document x with a nesting level -- set to the current column plus i. The following example uses -- hanging indentation for some text: -- --
-- test = hang 4 (fillSep (map text -- (words "the hang combinator indents these words !"))) ---- -- Which lays out on a page with a width of 20 characters as: -- --
-- the hang combinator -- indents these -- words ! ---- -- The hang combinator is implemented as: -- --
-- hang i x = align (nest i x) --hang :: Int -> Doc a -> Doc a -- | The document (indent i x) indents document x with -- i spaces. -- --
-- test = indent 4 (fillSep (map text -- (words "the indent combinator indents these words !"))) ---- -- Which lays out with a page width of 20 as: -- --
-- the indent -- combinator -- indents these -- words ! --indent :: Int -> Doc a -> Doc a -- | The document (encloseSep l r sep xs) concatenates the -- documents xs separated by sep and encloses the -- resulting document by l and r. The documents are -- rendered horizontally if that fits the page. Otherwise they are -- aligned vertically. All separators are put in front of the elements. -- For example, the combinator list can be defined with -- encloseSep: -- --
-- list xs = encloseSep lbracket rbracket comma xs -- test = text "list" <+> (list (map int [10,200,3000])) ---- -- Which is layed out with a page width of 20 as: -- --
-- list [10, 200, 3000] ---- -- But when the page width is 15, it is layed out as: -- --
-- list [ 10 -- , 200 -- , 3000 ] --encloseSep :: Foldable f => Doc a -> Doc a -> Doc a -> f (Doc a) -> Doc a -- | The document (list xs) comma separates the documents -- xs and encloses them in square brackets. The documents are -- rendered horizontally if that fits the page. Otherwise they are -- aligned vertically. All comma separators are put in front of the -- elements. list :: Foldable f => f (Doc a) -> Doc a -- | The document (tupled xs) comma separates the documents -- xs and encloses them in parenthesis. The documents are -- rendered horizontally if that fits the page. Otherwise they are -- aligned vertically. All comma separators are put in front of the -- elements. tupled :: Foldable f => f (Doc a) -> Doc a -- | The document (semiBraces xs) separates the documents -- xs with semi colons and encloses them in braces. The -- documents are rendered horizontally if that fits the page. Otherwise -- they are aligned vertically. All semi colons are put in front of the -- elements. semiBraces :: Foldable f => f (Doc a) -> Doc a (<+>) :: Doc a -> Doc a -> Doc a infixr 6 <+> -- | The document (x </> y) concatenates document x -- and y with a softline in between. This effectively -- puts x and y either next to each other (with a -- space in between) or underneath each other. (infixr 5) (>) :: Doc a -> Doc a -> Doc a infixr 5 > -- | The document (x <//> y) concatenates document -- x and y with a softbreak in between. This -- effectively puts x and y either right next to each -- other or underneath each other. (infixr 5) (/>) :: Doc a -> Doc a -> Doc a infixr 5 /> -- | The document (x <#> y) concatenates document x -- and y with a line in between. (infixr 5) (<#>) :: Doc a -> Doc a -> Doc a infixr 5 <#> -- | The document (x <##> y) concatenates document -- x and y with a linebreak in between. -- (infixr 5) (<##>) :: Doc a -> Doc a -> Doc a infixr 5 <##> -- | The document (hsep xs) concatenates all documents xs -- horizontally with (<+>). hsep :: Foldable f => f (Doc a) -> Doc a -- | The document (vsep xs) concatenates all documents xs -- vertically with (<#>). If a group undoes the -- line breaks inserted by vsep, all documents are separated -- with a space. -- --
-- someText = map text (words ("text to lay out"))
--
-- test = text "some" <+> vsep someText
--
--
-- This is layed out as:
--
-- -- some text -- to -- lay -- out ---- -- The align combinator can be used to align the documents under -- their first element -- --
-- test = text "some" <+> align (vsep someText) ---- -- Which is printed as: -- --
-- some text -- to -- lay -- out --vsep :: Foldable f => f (Doc a) -> Doc a -- | The document (fillSep xs) concatenates documents xs -- horizontally with (<+>) as long as its fits the page, -- then inserts a line and continues doing that for all -- documents in xs. -- --
-- fillSep xs = foldr (</>) mempty xs --fillSep :: Foldable f => f (Doc a) -> Doc a -- | The document (sep xs) concatenates all documents xs -- either horizontally with (<+>), if it fits the page, or -- vertically with (<#>). -- --
-- sep xs = group (vsep xs) --sep :: Foldable f => f (Doc a) -> Doc a -- | The document (hcat xs) concatenates all documents xs -- horizontally with (<>). hcat :: Foldable f => f (Doc a) -> Doc a -- | The document (vcat xs) concatenates all documents xs -- vertically with (<##>). If a group undoes the -- line breaks inserted by vcat, all documents are directly -- concatenated. vcat :: Foldable f => f (Doc a) -> Doc a -- | The document (fillCat xs) concatenates documents xs -- horizontally with (<>) as long as its fits the page, -- then inserts a linebreak and continues doing that for all -- documents in xs. -- --
-- fillCat xs = foldr (<//>) mempty xs --fillCat :: Foldable f => f (Doc a) -> Doc a -- | The document (cat xs) concatenates all documents xs -- either horizontally with (<>), if it fits the page, or -- vertically with (<##>). -- --
-- cat xs = group (vcat xs) --cat :: Foldable f => f (Doc a) -> Doc a -- | (punctuate p xs) concatenates all documents in xs -- with document p except for the last document. -- --
-- someText = map text ["words","in","a","tuple"] -- test = parens (align (cat (punctuate comma someText))) ---- -- This is layed out on a page width of 20 as: -- --
-- (words,in,a,tuple) ---- -- But when the page width is 15, it is layed out as: -- --
-- (words, -- in, -- a, -- tuple) ---- -- (If you want put the commas in front of their elements instead of at -- the end, you should use tupled or, in general, -- encloseSep.) punctuate :: Traversable f => Doc a -> f (Doc a) -> f (Doc a) -- | The document (fill i x) renders document x. It then -- appends spaces until the width is equal to i. If the -- width of x is already larger, nothing is appended. This -- combinator is quite useful in practice to output a list of bindings. -- The following example demonstrates this. -- --
-- types = [("mempty","Doc a")
-- ,("nest","Int -> Doc a -> Doc a")
-- ,("linebreak","Doc a")]
--
-- ptype (name,tp)
-- = fill 6 (text name) <+> text "::" <+> text tp
--
-- test = text "let" <+> align (vcat (map ptype types))
--
--
-- Which is layed out as:
--
-- -- let mempty :: Doc a -- nest :: Int -> Doc a -> Doc a -- linebreak :: Doc a --fill :: Int -> Doc a -> Doc a -- | The document (fillBreak i x) first renders document -- x. It then appends spaces until the width is equal -- to i. If the width of x is already larger than -- i, the nesting level is increased by i and a -- line is appended. When we redefine ptype in the -- previous example to use fillBreak, we get a useful variation -- of the previous output: -- --
-- ptype (name,tp) -- = fillBreak 6 (text name) <+> text "::" <+> text tp ---- -- The output will now be: -- --
-- let mempty :: Doc a -- nest :: Int -> Doc a -> Doc a -- linebreak -- :: Doc a --fillBreak :: Int -> Doc a -> Doc a -- | The document (enclose l r x) encloses document x -- between documents l and r using (<>). -- --
-- enclose l r x = l <> x <> r --enclose :: Doc a -> Doc a -> Doc a -> Doc a -- | Document (squotes x) encloses document x with single -- quotes "'". squotes :: Doc a -> Doc a -- | Document (dquotes x) encloses document x with double -- quotes '"'. dquotes :: Doc a -> Doc a -- | Document (parens x) encloses document x in -- parenthesis, "(" and ")". parens :: Doc a -> Doc a -- | Document (angles x) encloses document x in angles, -- "<" and ">". angles :: Doc a -> Doc a -- | Document (braces x) encloses document x in braces, -- "{" and "}". braces :: Doc a -> Doc a -- | Document (brackets x) encloses document x in square -- brackets, "[" and "]". brackets :: Doc a -> Doc a -- | The document lparen contains a left parenthesis, "(". lparen :: Doc a -- | The document rparen contains a right parenthesis, ")". rparen :: Doc a -- | The document langle contains a left angle, "<". langle :: Doc a -- | The document rangle contains a right angle, ">". rangle :: Doc a -- | The document lbrace contains a left brace, "{". lbrace :: Doc a -- | The document rbrace contains a right brace, "}". rbrace :: Doc a -- | The document lbracket contains a left square bracket, "[". lbracket :: Doc a -- | The document rbracket contains a right square bracket, "]". rbracket :: Doc a -- | The document squote contains a single quote, "'". squote :: Doc a -- | The document dquote contains a double quote, '"'. dquote :: Doc a -- | The document semi contains a semi colon, ";". semi :: Doc a -- | The document colon contains a colon, ":". colon :: Doc a -- | The document comma contains a comma, ",". comma :: Doc a -- | The document space contains a single space, " ". -- --
-- x <+> y = x <> space <> y --space :: Doc a -- | The document dot contains a single dot, ".". dot :: Doc a -- | The document backslash contains a back slash, "\". backslash :: Doc a -- | The document equals contains an equal sign, "=". equals :: Doc a -- | The member prettyList is only used to define the instance -- Pretty a => Pretty [a]. In normal circumstances only the -- pretty function is used. class Pretty a where prettyList = list . map pretty pretty = text . show pretty :: Pretty a => a -> Doc b prettyList :: Pretty a => [a] -> Doc b pretty :: (Pretty a, Show a) => a -> Doc b -- | The data type SimpleDoc represents rendered documents and is -- used by the display functions. -- -- The Int in SText contains the length of the string. -- The Int in SLine contains the indentation for that -- line. The library provides two default display functions -- displayS and displayIO. You can provide your own display -- function by writing a function from a SimpleDoc to your own -- output format. data SimpleDoc a SEmpty :: SimpleDoc a SChar :: {-# UNPACK #-} !Char -> (SimpleDoc a) -> SimpleDoc a SText :: {-# UNPACK #-} !Int -> String -> (SimpleDoc a) -> SimpleDoc a SLine :: {-# UNPACK #-} !Int -> (SimpleDoc a) -> SimpleDoc a SPushAnn :: a -> (SimpleDoc a) -> SimpleDoc a SPopAnn :: a -> (SimpleDoc a) -> SimpleDoc a -- | This is the default pretty printer which is used by show, -- putDoc and hPutDoc. This routine uses a page width of -- 100 characters and a ribbon width of 40 characters. renderPrettyDefault :: Doc a -> SimpleDoc a -- | This is the default pretty printer which is used by show, -- putDoc and hPutDoc. (renderPretty ribbonfrac width -- x) renders document x with a page width of -- width and a ribbon width of (ribbonfrac * width) -- characters. The ribbon width is the maximal amount of non-indentation -- characters on a line. The parameter ribbonfrac should be -- between 0.0 and 1.0. If it is lower or higher, the -- ribbon width will be 0 or width respectively. renderPretty :: Float -> Int -> Doc a -> SimpleDoc a -- | (renderCompact x) renders document x without adding -- any indentation. Since no 'pretty' printing is involved, this renderer -- is very fast. The resulting output contains fewer characters than a -- pretty printed version and can be used for output that is read by -- other programs. renderCompact :: Doc a -> SimpleDoc a -- | A slightly smarter rendering algorithm with more lookahead. It -- provides provide earlier breaking on deeply nested structures. For -- example, consider this python-ish pseudocode: -- fun(fun(fun(fun(fun([abcdefg, abcdefg]))))) If we put a -- softbreak (+ nesting 2) after each open parenthesis, and align the -- elements of the list to match the opening brackets, this will render -- with renderPretty and a page width of 20c as: -- fun(fun(fun(fun(fun([ | abcdef, | abcdef, ] ))))) | Where the -- 20c. boundary has been marked with |. Because renderPretty -- only uses one-line lookahead, it sees that the first line fits, and is -- stuck putting the second and third lines after the 20c mark. In -- contrast, renderSmart will continue to check the potential -- document up to the end of the indentation level. Thus, it will format -- the document as: -- --
-- fun( | -- fun( | -- fun( | -- fun( | -- fun([ | -- abcdef, -- abcdef, -- ] | -- ))))) | ---- -- Which fits within the 20c. mark. In addition, renderSmart -- uses this lookahead to minimize the number of lines printed, leading -- to more compact and visually appealing output. Consider this example -- using the same syntax as above: aaaaaaaaaaa([abc, def, ghi]) -- When rendered with renderPretty and a page width of 20c, we -- get: aaaaaaaaaaa([ abc , def , ghi ]) Whereas when rendered -- with renderSmart and a page width of 20c, we get: -- aaaaaaaaaaa( [abc, def, ghi]) renderSmart :: Int -> Doc a -> SimpleDoc a -- | (display simpleDoc) takes the output simpleDoc from -- a rendering function and outputs a String. Along the way, all -- annotations are discarded. display :: SimpleDoc a -> String -- | (displayS simpleDoc) takes the output simpleDoc from -- a rendering function and transforms it to a ShowS type (for use -- in the Show class). Along the way, all annotations are -- discarded. displayS :: SimpleDoc a -> ShowS -- | (display simpleDoc) takes the output simpleDoc from -- a rendering function and outputs a Text. Along the way, all -- annotations are discarded. displayT :: SimpleDoc a -> Text -- | (displayIO handle simpleDoc) writes simpleDoc to the -- file handle handle, discarding all annotations. This function -- is used for example by hPutDoc: -- --
-- hPutDoc handle doc = displayIO handle (renderPrettyDefault doc) --displayIO :: Handle -> SimpleDoc a -> IO () -- | Display a rendered document. -- -- This function takes a means of pushing an annotated region, a means of -- ending it, and a means of displaying a string, with effects f -- to display or compute the output o. displayDecoratedA :: (Applicative f, Monoid o) => (a -> f o) -> (a -> f o) -> (String -> f o) -> SimpleDoc a -> f o -- | Display a rendered document. -- -- This function takes a means of pushing an annotated region, a means of -- ending it, and a means of displaying a string to compute the output -- o. displayDecorated :: Monoid o => (a -> o) -> (a -> o) -> (String -> o) -> SimpleDoc a -> o -- | The type alias SpanList is used by displaySpan -- -- First element is the starting position, second the length and third -- the annotation at the given range. type SpanList a = [(Int, Int, a)] -- | Generate a pair of a string and a list of source span/annotation pairs displaySpans :: Monoid o => (String -> o) -> SimpleDoc a -> (o, SpanList a) column :: (Int -> Doc a) -> Doc a nesting :: (Int -> Doc a) -> Doc a width :: Doc a -> (Int -> Doc a) -> Doc a columns :: (Maybe Int -> Doc a) -> Doc a ribbon :: (Maybe Int -> Doc a) -> Doc a -- | Identity of mappend mempty :: Monoid a => a -- | An associative operation. -- --
-- (a <> b) <> c = a <> (b <> c) ---- -- If a is also a Monoid we further require -- --
-- (<>) = mappend --(<>) :: Semigroup a => a -> a -> a instance Data.Traversable.Traversable Text.PrettyPrint.Annotated.WL.SimpleDoc instance Data.Foldable.Foldable Text.PrettyPrint.Annotated.WL.SimpleDoc instance GHC.Base.Functor Text.PrettyPrint.Annotated.WL.SimpleDoc instance GHC.Generics.Generic (Text.PrettyPrint.Annotated.WL.SimpleDoc a) instance GHC.Base.Functor Text.PrettyPrint.Annotated.WL.Doc instance GHC.Generics.Generic (Text.PrettyPrint.Annotated.WL.Doc a) instance Data.Semigroup.Semigroup (Text.PrettyPrint.Annotated.WL.Doc a) instance GHC.Base.Monoid (Text.PrettyPrint.Annotated.WL.Doc a) instance Data.String.IsString (Text.PrettyPrint.Annotated.WL.Doc a) instance Text.PrettyPrint.Annotated.WL.Pretty (Text.PrettyPrint.Annotated.WL.Doc a) instance Text.PrettyPrint.Annotated.WL.Pretty a => Text.PrettyPrint.Annotated.WL.Pretty [a] instance Text.PrettyPrint.Annotated.WL.Pretty Data.Text.Internal.Text instance Text.PrettyPrint.Annotated.WL.Pretty Data.Text.Internal.Lazy.Text instance Text.PrettyPrint.Annotated.WL.Pretty () instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Types.Char instance Text.PrettyPrint.Annotated.WL.Pretty a => Text.PrettyPrint.Annotated.WL.Pretty (Data.Sequence.Seq a) instance Text.PrettyPrint.Annotated.WL.Pretty a => Text.PrettyPrint.Annotated.WL.Pretty (Data.List.NonEmpty.NonEmpty a) instance (Text.PrettyPrint.Annotated.WL.Pretty a, Text.PrettyPrint.Annotated.WL.Pretty b) => Text.PrettyPrint.Annotated.WL.Pretty (a, b) instance (Text.PrettyPrint.Annotated.WL.Pretty a, Text.PrettyPrint.Annotated.WL.Pretty b, Text.PrettyPrint.Annotated.WL.Pretty c) => Text.PrettyPrint.Annotated.WL.Pretty (a, b, c) instance Text.PrettyPrint.Annotated.WL.Pretty a => Text.PrettyPrint.Annotated.WL.Pretty (GHC.Base.Maybe a) instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Types.Bool instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Types.Int instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Int.Int8 instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Int.Int16 instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Int.Int32 instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Int.Int64 instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Types.Word instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Word.Word8 instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Word.Word16 instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Word.Word32 instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Word.Word64 instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Integer.Type.Integer instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Natural.Natural instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Types.Float instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Types.Double instance Text.PrettyPrint.Annotated.WL.Pretty GHC.Real.Rational instance Control.DeepSeq.NFData a => Control.DeepSeq.NFData (Text.PrettyPrint.Annotated.WL.Doc a) instance Control.DeepSeq.NFData a => Control.DeepSeq.NFData (Text.PrettyPrint.Annotated.WL.SimpleDoc a) instance GHC.Show.Show (Text.PrettyPrint.Annotated.WL.Doc a)