Patat.PrettyPrint.Internal

This is a small pretty-printing library.

Documentation

data Control

Control actions for the terminal.

Constructors

ClearScreenControl

GoToLineControl Int

Instances

Show Control

Defined in Patat.PrettyPrint.Internal

Methods

showsPrec :: Int -> Control -> ShowS

show :: Control -> String

showList :: [Control] -> ShowS

Eq Control

Defined in Patat.PrettyPrint.Internal

Methods

(==) :: Control -> Control -> Bool

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

data Chunk

A simple chunk of text. All ANSI codes are "reset" after printing.

Constructors

StringChunk [SGR] String

NewlineChunk

ControlChunk Control

Instances

Show Chunk

Defined in Patat.PrettyPrint.Internal

Methods

showsPrec :: Int -> Chunk -> ShowS

show :: Chunk -> String

showList :: [Chunk] -> ShowS

Eq Chunk

Defined in Patat.PrettyPrint.Internal

Methods

(==) :: Chunk -> Chunk -> Bool

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

type Chunks = [Chunk]

chunkToString :: Chunk -> String

chunkLines :: Chunks -> [Chunks]

data DocE d

Constructors

String String

Softspace

Hardspace

Softline

Hardline

WrapAt

Fields

• wrapAtCol :: Maybe Int
• wrapDoc :: d

Ansi

Fields

• ansiCode :: [SGR] -> [SGR]

  Modifies current codes.

• ansiDoc :: d

Indent

Fields

• indentFirstLine :: LineBuffer
• indentOtherLines :: LineBuffer
• indentDoc :: d

Control Control

Instances

Functor DocE

Defined in Patat.PrettyPrint.Internal

Methods

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

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

chunkToDocE :: Chunk -> DocE Doc

newtype Doc

Constructors

Doc

Fields

• unDoc :: [DocE Doc]

Instances

IsString Doc

Defined in Patat.PrettyPrint.Internal

Methods

fromString :: String -> Doc

Monoid Doc

Defined in Patat.PrettyPrint.Internal

Methods

mempty :: Doc

mappend :: Doc -> Doc -> Doc

mconcat :: [Doc] -> Doc

Semigroup Doc

Defined in Patat.PrettyPrint.Internal

Methods

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

sconcat :: NonEmpty Doc -> Doc

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

Show Doc

Defined in Patat.PrettyPrint.Internal

Methods

showsPrec :: Int -> Doc -> ShowS

show :: Doc -> String

showList :: [Doc] -> ShowS

docToChunks :: Doc -> Chunks

data Trimmable a

Constructors

NotTrimmable !a

Trimmable !a

Instances

Foldable Trimmable

Defined in Patat.PrettyPrint.Internal

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.Internal

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.Internal

Methods

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

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

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 ()

mkDoc :: DocE Doc -> Doc

string :: String -> Doc