Patat.PrettyPrint

This is a small pretty-printing library.

Documentation

data Doc

Instances

IsString Doc

Defined in Patat.PrettyPrint

Methods

fromString :: String -> Doc

Monoid Doc

Defined in Patat.PrettyPrint

Methods

mempty :: Doc

mappend :: Doc -> Doc -> Doc

mconcat :: [Doc] -> Doc

Semigroup Doc

Defined in Patat.PrettyPrint

Methods

(<>) :: Doc -> Doc -> Doc

sconcat :: NonEmpty Doc -> Doc

stimes :: Integral b => b -> Doc -> Doc

Show Doc

Defined in Patat.PrettyPrint

Methods

showsPrec :: Int -> Doc -> ShowS

show :: Doc -> String

showList :: [Doc] -> ShowS

toString :: Doc -> String

dimensions :: Doc -> (Int, Int)

Returns the rows and columns necessary to render this document

null :: Doc -> Bool

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

putDoc :: Doc -> IO ()

string :: String -> Doc

text :: Text -> Doc

space :: Doc

spaces :: Int -> Doc

softline :: Doc

hardline :: Doc

wrapAt :: Maybe Int -> Doc -> Doc

data Trimmable a

Constructors

NotTrimmable !a

Trimmable !a

Instances

Foldable Trimmable

Defined in Patat.PrettyPrint

Methods

fold :: Monoid m => Trimmable m -> m

foldMap :: Monoid m => (a -> m) -> Trimmable a -> m

foldMap' :: Monoid m => (a -> m) -> Trimmable a -> m

foldr :: (a -> b -> b) -> b -> Trimmable a -> b

foldr' :: (a -> b -> b) -> b -> Trimmable a -> b

foldl :: (b -> a -> b) -> b -> Trimmable a -> b

foldl' :: (b -> a -> b) -> b -> Trimmable a -> b

foldr1 :: (a -> a -> a) -> Trimmable a -> a

foldl1 :: (a -> a -> a) -> Trimmable a -> a

toList :: Trimmable a -> [a]

null :: Trimmable a -> Bool

length :: Trimmable a -> Int

elem :: Eq a => a -> Trimmable a -> Bool

maximum :: Ord a => Trimmable a -> a

minimum :: Ord a => Trimmable a -> a

sum :: Num a => Trimmable a -> a

product :: Num a => Trimmable a -> a

Traversable Trimmable

Defined in Patat.PrettyPrint

Methods

traverse :: Applicative f => (a -> f b) -> Trimmable a -> f (Trimmable b)

sequenceA :: Applicative f => Trimmable (f a) -> f (Trimmable a)

mapM :: Monad m => (a -> m b) -> Trimmable a -> m (Trimmable b)

sequence :: Monad m => Trimmable (m a) -> m (Trimmable a)

Functor Trimmable

Defined in Patat.PrettyPrint

Methods

fmap :: (a -> b) -> Trimmable a -> Trimmable b

(<$) :: a -> Trimmable b -> Trimmable a

indent :: Trimmable Doc -> Trimmable Doc -> Doc -> Doc

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

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

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

vcat :: [Doc] -> Doc

intersperse :: Doc -> [Doc] -> Doc

Exotic combinators

data Alignment

Constructors

AlignLeft

AlignCenter

AlignRight

Instances

Show Alignment

Defined in Patat.PrettyPrint

Methods

showsPrec :: Int -> Alignment -> ShowS

show :: Alignment -> String

showList :: [Alignment] -> ShowS

Eq Alignment

Defined in Patat.PrettyPrint

Methods

(==) :: Alignment -> Alignment -> Bool

(/=) :: Alignment -> Alignment -> Bool

Ord Alignment

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

paste :: [Doc] -> Doc

Like the unix program paste.

Control codes

removeControls :: Doc -> Doc

clearScreen :: Doc

goToLine :: Int -> Doc