Safe Haskell	Safe-Inferred
Language	Haskell2010

Patat.PrettyPrint.Internal

Description

This is a small pretty-printing library.

Synopsis

data Control
- = ClearScreenControl
- | GoToLineControl Int
data Chunk
- = StringChunk [SGR] String
- | NewlineChunk
- | ControlChunk Control
type Chunks = [Chunk]
chunkToString :: Chunk -> String
chunkLines :: Chunks -> [Chunks]
data DocE d
- = String String
- | Softspace
- | Hardspace
- | Softline
- | Hardline
- | WrapAt {
  - wrapAtCol :: Maybe Int
  - wrapDoc :: d
  }
- | Ansi {
  - ansiCode :: [SGR] -> [SGR]
  - ansiDoc :: d
  }
- | Indent {
  - indentFirstLine :: Indentation [Chunk]
  - indentOtherLines :: Indentation [Chunk]
  - indentDoc :: d
  }
- | Control Control
chunkToDocE :: Chunk -> DocE Doc
data Indentation a = Indentation Int a
newtype Doc = Doc {
- unDoc :: [DocE Doc]
}
docToChunks :: Doc -> Chunks
toString :: Doc -> String
dimensions :: Doc -> (Int, Int)
null :: Doc -> Bool
hPutDoc :: Handle -> Doc -> IO ()
putDoc :: Doc -> IO ()
mkDoc :: DocE Doc -> Doc
string :: String -> Doc

Documentation

data Control Source #

Control actions for the terminal.

Constructors

ClearScreenControl
GoToLineControl Int

Instances

Instances details

Show Control Source #
Instance details Defined in Patat.PrettyPrint.Internal Methods showsPrec :: Int -> Control -> ShowS # show :: Control -> String # showList :: [Control] -> ShowS #
Eq Control Source #
Instance details Defined in Patat.PrettyPrint.Internal Methods (==) :: Control -> Control -> Bool # (/=) :: Control -> Control -> Bool #

data Chunk Source #

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

Constructors

StringChunk [SGR] String
NewlineChunk
ControlChunk Control

Instances

Instances details

Show Chunk Source #
Instance details Defined in Patat.PrettyPrint.Internal Methods showsPrec :: Int -> Chunk -> ShowS # show :: Chunk -> String # showList :: [Chunk] -> ShowS #
Eq Chunk Source #
Instance details Defined in Patat.PrettyPrint.Internal Methods (==) :: Chunk -> Chunk -> Bool # (/=) :: Chunk -> Chunk -> Bool #

type Chunks = [Chunk] Source #

chunkToString :: Chunk -> String Source #

chunkLines :: Chunks -> [Chunks] Source #

data DocE d Source #

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 :: Indentation [Chunk] indentOtherLines :: Indentation [Chunk] indentDoc :: d
Control Control

Instances

Instances details

Functor DocE Source #
Instance details Defined in Patat.PrettyPrint.Internal Methods fmap :: (a -> b) -> DocE a -> DocE b # (<$) :: a -> DocE b -> DocE a #

chunkToDocE :: Chunk -> DocE 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 #

newtype Doc Source #

Constructors

Doc
Fields unDoc :: [DocE Doc]

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 #

docToChunks :: Doc -> Chunks Source #

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 #

mkDoc :: DocE Doc -> Doc Source #

string :: String -> Doc Source #