Safe Haskell	Safe-Inferred
Language	Haskell2010

Text.PrettyPrint.Leijen.Extended

Contents

Pretty-print typeclass
Ansi terminal Doc
Selective re-exports from Text.PrettyPrint.Annotated.Leijen

Description

This module re-exports some of the interface for Text.PrettyPrint.Annotated.Leijen along with additional definitions useful for stack.

It defines a Monoid instance for Doc.

Synopsis

class Pretty a where
- pretty :: a -> StyleDoc
newtype StyleDoc = StyleDoc {
- unStyleDoc :: Doc StyleAnn
}
newtype StyleAnn = StyleAnn (Maybe Style)
displayAnsi :: (Pretty a, HasLogFunc env, HasStylesUpdate env, MonadReader env m, HasCallStack) => Int -> a -> m Utf8Builder
displayPlain :: (Pretty a, HasLogFunc env, HasStylesUpdate env, MonadReader env m, HasCallStack) => Int -> a -> m Utf8Builder
renderDefault :: Int -> Doc a -> SimpleDoc a
nest :: Int -> StyleDoc -> StyleDoc
line :: StyleDoc
linebreak :: StyleDoc
group :: StyleDoc -> StyleDoc
softline :: StyleDoc
softbreak :: StyleDoc
align :: StyleDoc -> StyleDoc
hang :: Int -> StyleDoc -> StyleDoc
indent :: Int -> StyleDoc -> StyleDoc
encloseSep :: StyleDoc -> StyleDoc -> StyleDoc -> [StyleDoc] -> StyleDoc
(<+>) :: StyleDoc -> StyleDoc -> StyleDoc
hsep :: [StyleDoc] -> StyleDoc
vsep :: [StyleDoc] -> StyleDoc
fillSep :: [StyleDoc] -> StyleDoc
sep :: [StyleDoc] -> StyleDoc
hcat :: [StyleDoc] -> StyleDoc
vcat :: [StyleDoc] -> StyleDoc
fillCat :: [StyleDoc] -> StyleDoc
cat :: [StyleDoc] -> StyleDoc
punctuate :: StyleDoc -> [StyleDoc] -> [StyleDoc]
fill :: Int -> StyleDoc -> StyleDoc
fillBreak :: Int -> StyleDoc -> StyleDoc
enclose :: StyleDoc -> StyleDoc -> StyleDoc -> StyleDoc
squotes :: StyleDoc -> StyleDoc
dquotes :: StyleDoc -> StyleDoc
parens :: StyleDoc -> StyleDoc
angles :: StyleDoc -> StyleDoc
braces :: StyleDoc -> StyleDoc
brackets :: StyleDoc -> StyleDoc
string :: String -> StyleDoc
annotate :: StyleAnn -> StyleDoc -> StyleDoc
noAnnotate :: StyleDoc -> StyleDoc
styleAnn :: Style -> StyleDoc -> StyleDoc

Pretty-print typeclass

class Pretty a where Source #

Minimal complete definition

Nothing

Methods

pretty :: a -> StyleDoc Source #

default pretty :: Show a => a -> StyleDoc Source #

Instances

Instances details

Pretty ModuleName Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods pretty :: ModuleName -> StyleDoc Source #
Pretty PrettyException Source #
Instance details Defined in RIO.PrettyPrint.PrettyException Methods pretty :: PrettyException -> StyleDoc Source #
Pretty StyleDoc Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods pretty :: StyleDoc -> StyleDoc Source #
Pretty (Path b Dir) Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods pretty :: Path b Dir -> StyleDoc Source #
Pretty (Path b File) Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods pretty :: Path b File -> StyleDoc Source #

Ansi terminal Doc

newtype StyleDoc Source #

A document annotated by a style

Constructors

StyleDoc
Fields unStyleDoc :: Doc StyleAnn

Instances

Instances details

IsString StyleDoc Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods fromString :: String -> StyleDoc #
Monoid StyleDoc Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods mempty :: StyleDoc # mappend :: StyleDoc -> StyleDoc -> StyleDoc # mconcat :: [StyleDoc] -> StyleDoc #
Semigroup StyleDoc Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods (<>) :: StyleDoc -> StyleDoc -> StyleDoc # sconcat :: NonEmpty StyleDoc -> StyleDoc # stimes :: Integral b => b -> StyleDoc -> StyleDoc #
Show StyleDoc Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods showsPrec :: Int -> StyleDoc -> ShowS # show :: StyleDoc -> String # showList :: [StyleDoc] -> ShowS #
Pretty StyleDoc Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods pretty :: StyleDoc -> StyleDoc Source #

newtype StyleAnn Source #

A style annotation.

Constructors

StyleAnn (Maybe Style)

Instances

Instances details

Monoid StyleAnn Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods mempty :: StyleAnn # mappend :: StyleAnn -> StyleAnn -> StyleAnn # mconcat :: [StyleAnn] -> StyleAnn #
Semigroup StyleAnn Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods (<>) :: StyleAnn -> StyleAnn -> StyleAnn # sconcat :: NonEmpty StyleAnn -> StyleAnn # stimes :: Integral b => b -> StyleAnn -> StyleAnn #
Show StyleAnn Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods showsPrec :: Int -> StyleAnn -> ShowS # show :: StyleAnn -> String # showList :: [StyleAnn] -> ShowS #
Eq StyleAnn Source #
Instance details Defined in Text.PrettyPrint.Leijen.Extended Methods (==) :: StyleAnn -> StyleAnn -> Bool # (/=) :: StyleAnn -> StyleAnn -> Bool #

displayAnsi :: (Pretty a, HasLogFunc env, HasStylesUpdate env, MonadReader env m, HasCallStack) => Int -> a -> m Utf8Builder Source #

displayPlain :: (Pretty a, HasLogFunc env, HasStylesUpdate env, MonadReader env m, HasCallStack) => Int -> a -> m Utf8Builder Source #

renderDefault :: Int -> Doc a -> SimpleDoc a Source #

Selective re-exports from Text.PrettyPrint.Annotated.Leijen

Documents, parametrized by their annotations

Basic combinators

nest :: Int -> StyleDoc -> StyleDoc Source #

line :: StyleDoc Source #

linebreak :: StyleDoc Source #

group :: StyleDoc -> StyleDoc Source #

softline :: StyleDoc Source #

softbreak :: StyleDoc Source #

Alignment

align :: StyleDoc -> StyleDoc Source #

hang :: Int -> StyleDoc -> StyleDoc Source #

indent :: Int -> StyleDoc -> StyleDoc Source #

encloseSep :: StyleDoc -> StyleDoc -> StyleDoc -> [StyleDoc] -> StyleDoc Source #

Operators

(<+>) :: StyleDoc -> StyleDoc -> StyleDoc Source #

List combinators

hsep :: [StyleDoc] -> StyleDoc Source #

vsep :: [StyleDoc] -> StyleDoc Source #

fillSep :: [StyleDoc] -> StyleDoc Source #

sep :: [StyleDoc] -> StyleDoc Source #

hcat :: [StyleDoc] -> StyleDoc Source #

vcat :: [StyleDoc] -> StyleDoc Source #

fillCat :: [StyleDoc] -> StyleDoc Source #

cat :: [StyleDoc] -> StyleDoc Source #

punctuate :: StyleDoc -> [StyleDoc] -> [StyleDoc] Source #

Fillers

fill :: Int -> StyleDoc -> StyleDoc Source #

fillBreak :: Int -> StyleDoc -> StyleDoc Source #

Bracketing combinators

enclose :: StyleDoc -> StyleDoc -> StyleDoc -> StyleDoc Source #

squotes :: StyleDoc -> StyleDoc Source #

dquotes :: StyleDoc -> StyleDoc Source #

parens :: StyleDoc -> StyleDoc Source #

angles :: StyleDoc -> StyleDoc Source #

braces :: StyleDoc -> StyleDoc Source #

brackets :: StyleDoc -> StyleDoc Source #

Character documents

Primitive type documents

string :: String -> StyleDoc Source #

The document string s concatenates all characters in s using line for newline characters and char for all other characters. It is used whenever the text contains newline characters.

Since: 0.1.4.0