Safe Haskell	Safe-Inferred
Language	Haskell2010

Patat.PrettyPrint

Contents

Exotic combinators
Control codes

Description

This is a small pretty-printing library.

Synopsis

data Doc
toString :: Doc -> String
dimensions :: Doc -> (Int, Int)
null :: Doc -> Bool
hPutDoc :: Handle -> Doc -> IO ()
putDoc :: Doc -> IO ()
char :: Char -> Doc
string :: String -> Doc
text :: Text -> Doc
space :: Doc
spaces :: Int -> Doc
softline :: Doc
hardline :: Doc
wrapAt :: Maybe Int -> Doc -> Doc
data Indentation a = Indentation Int a
indent :: Indentation Doc -> Indentation Doc -> Doc -> Doc
deindent :: Doc -> Doc
ansi :: [SGR] -> Doc -> Doc
(<+>) :: Doc -> Doc -> Doc
(<$$>) :: Doc -> Doc -> Doc
vcat :: [Doc] -> Doc
intersperse :: Doc -> [Doc] -> Doc
data Alignment
- = AlignLeft
- | AlignCenter
- | AlignRight
align :: Int -> Alignment -> Doc -> Doc
paste :: [Doc] -> Doc
removeControls :: Doc -> Doc
clearScreen :: Doc
goToLine :: Int -> Doc

Documentation

data Doc Source #

Instances

Instances details

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

toString :: Doc -> String Source #

dimensions :: Doc -> (Int, Int) Source #

Returns the rows and columns necessary to render this document

null :: Doc -> Bool Source #

hPutDoc :: Handle -> Doc -> IO () Source #

putDoc :: Doc -> IO () Source #

char :: Char -> Doc Source #

string :: String -> Doc Source #

text :: Text -> Doc Source #

space :: Doc Source #

spaces :: Int -> Doc Source #

softline :: Doc Source #

hardline :: Doc Source #

wrapAt :: Maybe Int -> Doc -> Doc Source #

data Indentation a Source #

Constructors

Indentation Int a

Instances

Instances details

Foldable Indentation Source #
Instance details Defined in Patat.PrettyPrint.Internal Methods fold :: Monoid m => Indentation m -> m # foldMap :: Monoid m => (a -> m) -> Indentation a -> m # foldMap' :: Monoid m => (a -> m) -> Indentation a -> m # foldr :: (a -> b -> b) -> b -> Indentation a -> b # foldr' :: (a -> b -> b) -> b -> Indentation a -> b # foldl :: (b -> a -> b) -> b -> Indentation a -> b # foldl' :: (b -> a -> b) -> b -> Indentation a -> b # foldr1 :: (a -> a -> a) -> Indentation a -> a # foldl1 :: (a -> a -> a) -> Indentation a -> a # toList :: Indentation a -> [a] # null :: Indentation a -> Bool # length :: Indentation a -> Int # elem :: Eq a => a -> Indentation a -> Bool # maximum :: Ord a => Indentation a -> a # minimum :: Ord a => Indentation a -> a # sum :: Num a => Indentation a -> a # product :: Num a => Indentation a -> a #
Traversable Indentation Source #
Instance details Defined in Patat.PrettyPrint.Internal Methods traverse :: Applicative f => (a -> f b) -> Indentation a -> f (Indentation b) # sequenceA :: Applicative f => Indentation (f a) -> f (Indentation a) # mapM :: Monad m => (a -> m b) -> Indentation a -> m (Indentation b) # sequence :: Monad m => Indentation (m a) -> m (Indentation a) #
Functor Indentation Source #
Instance details Defined in Patat.PrettyPrint.Internal Methods fmap :: (a -> b) -> Indentation a -> Indentation b # (<$) :: a -> Indentation b -> Indentation a #

indent :: Indentation Doc -> Indentation Doc -> Doc -> Doc Source #

deindent :: Doc -> Doc Source #

Only strips leading spaces

ansi :: [SGR] -> Doc -> Doc Source #

(<+>) :: Doc -> Doc -> Doc infixr 6 Source #

(<$$>) :: Doc -> Doc -> Doc infixr 5 Source #

vcat :: [Doc] -> Doc Source #

intersperse :: Doc -> [Doc] -> Doc Source #

Exotic combinators

data Alignment Source #

Constructors

AlignLeft
AlignCenter
AlignRight

Instances

Instances details

Show Alignment Source #
Instance details Defined in Patat.PrettyPrint Methods showsPrec :: Int -> Alignment -> ShowS # show :: Alignment -> String # showList :: [Alignment] -> ShowS #
Eq Alignment Source #
Instance details Defined in Patat.PrettyPrint Methods (==) :: Alignment -> Alignment -> Bool # (/=) :: Alignment -> Alignment -> Bool #
Ord Alignment Source #
Instance details Defined in Patat.PrettyPrint Methods compare :: Alignment -> Alignment -> Ordering # (<) :: Alignment -> Alignment -> Bool # (<=) :: Alignment -> Alignment -> Bool # (>) :: Alignment -> Alignment -> Bool # (>=) :: Alignment -> Alignment -> Bool # max :: Alignment -> Alignment -> Alignment # min :: Alignment -> Alignment -> Alignment #

align :: Int -> Alignment -> Doc -> Doc Source #

paste :: [Doc] -> Doc Source #

Like the unix program paste.

Control codes

removeControls :: Doc -> Doc Source #

clearScreen :: Doc Source #

goToLine :: Int -> Doc Source #