Data.TreeDiff.Pretty

Utilities to pretty print Expr and EditExpr

Explicit dictionary

data Pretty doc

Because we don't want to commit to single pretty printing library, we use explicit dictionary.

Constructors

Pretty

Fields

• ppCon :: ConstructorName -> doc

  Display ConstructorName

• ppApp :: doc -> [doc] -> doc

  Display App

• ppRec :: doc -> [(FieldName, doc)] -> doc

  Display Rec

• ppLst :: [doc] -> doc

  Display Lst

• ppCpy :: doc -> doc

  Display unchanged parts

• ppIns :: doc -> doc

  Display added parts

• ppDel :: doc -> doc

  Display removed parts

• ppEdits :: [doc] -> doc

  Combined edits (usually some sep combinator)

• ppEllip :: doc

  Ellipsis

• ppParens :: doc -> doc

  Parens an expression

ppExpr :: Pretty doc -> Expr -> doc

Pretty print an Expr using explicit pretty-printing dictionary.

ppEditExpr :: Pretty doc -> Edit EditExpr -> doc

Pretty print an Edit EditExpr using explicit pretty-printing dictionary.

ppEditExprCompact :: Pretty doc -> Edit EditExpr -> doc

Like ppEditExpr but print unchanged parts only shallowly

pretty

prettyPretty :: Pretty Doc

Pretty via pretty library.

prettyExpr :: Expr -> Doc

Pretty print Expr using pretty.

>>> prettyExpr $ Rec "ex" (OMap.fromList [("[]", App "bar" [])])
ex {`[]` = bar}

prettyEditExpr :: Edit EditExpr -> Doc

Pretty print Edit EditExpr using pretty.

prettyEditExprCompact :: Edit EditExpr -> Doc

Compact prettyEditExpr.

ansi-wl-pprint

ansiWlPretty :: Pretty Doc

Pretty via ansi-wl-pprint library (with colors).

ansiWlExpr :: Expr -> Doc

Pretty print Expr using ansi-wl-pprint.

ansiWlEditExpr :: Edit EditExpr -> Doc

Pretty print Edit EditExpr using ansi-wl-pprint.

ansiWlEditExprCompact :: Edit EditExpr -> Doc

Compact ansiWlEditExpr

background

ansiWlBgPretty :: Pretty Doc

Like ansiWlPretty but color the background.

ansiWlBgExpr :: Expr -> Doc

Pretty print Expr using ansi-wl-pprint.

ansiWlBgEditExpr :: Edit EditExpr -> Doc

Pretty print Edit EditExpr using ansi-wl-pprint.

ansiWlBgEditExprCompact :: Edit EditExpr -> Doc

Compact ansiWlBgEditExpr.

Utilities

escapeName :: String -> String

Escape field or constructor name

>>> putStrLn $ escapeName "Foo"
Foo

>>> putStrLn $ escapeName "_×_"
_×_

>>> putStrLn $ escapeName "-3"
`-3`

>>> putStrLn $ escapeName "kebab-case"
kebab-case

>>> putStrLn $ escapeName "inner space"
`inner space`

>>> putStrLn $ escapeName $ show "looks like a string"
"looks like a string"

>>> putStrLn $ escapeName $ show "tricky" ++ "   "
`"tricky"   `

>>> putStrLn $ escapeName "[]"
`[]`

>>> putStrLn $ escapeName "_,_"
`_,_`