Safe Haskell	Safe
Language	Haskell98

Options.Applicative.Help.Chunk

Synopsis

Documentation

mappendWith :: Monoid a => a -> a -> a -> a Source #

newtype Chunk a Source #

The free monoid on a semigroup a.

Constructors

Chunk
Fields unChunk :: Maybe a

Instances

Monad Chunk Source #
Methods (>>=) :: Chunk a -> (a -> Chunk b) -> Chunk b # (>>) :: Chunk a -> Chunk b -> Chunk b # return :: a -> Chunk a # fail :: String -> Chunk a #
Functor Chunk Source #
Methods fmap :: (a -> b) -> Chunk a -> Chunk b # (<$) :: a -> Chunk b -> Chunk a #
Applicative Chunk Source #
Methods pure :: a -> Chunk a # (<>) :: Chunk (a -> b) -> Chunk a -> Chunk b # liftA2 :: (a -> b -> c) -> Chunk a -> Chunk b -> Chunk c # (>) :: Chunk a -> Chunk b -> Chunk b # (<*) :: Chunk a -> Chunk b -> Chunk a #
Alternative Chunk Source #
Methods empty :: Chunk a # (<\|>) :: Chunk a -> Chunk a -> Chunk a # some :: Chunk a -> Chunk [a] # many :: Chunk a -> Chunk [a] #
MonadPlus Chunk Source #
Methods mzero :: Chunk a # mplus :: Chunk a -> Chunk a -> Chunk a #
Eq a => Eq (Chunk a) Source #
Methods (==) :: Chunk a -> Chunk a -> Bool # (/=) :: Chunk a -> Chunk a -> Bool #
Show a => Show (Chunk a) Source #
Methods showsPrec :: Int -> Chunk a -> ShowS # show :: Chunk a -> String # showList :: [Chunk a] -> ShowS #
Monoid a => Semigroup (Chunk a) Source #
Methods (<>) :: Chunk a -> Chunk a -> Chunk a # sconcat :: NonEmpty (Chunk a) -> Chunk a # stimes :: Integral b => b -> Chunk a -> Chunk a #
Monoid a => Monoid (Chunk a) Source #
Methods mempty :: Chunk a # mappend :: Chunk a -> Chunk a -> Chunk a # mconcat :: [Chunk a] -> Chunk a #

chunked :: (a -> a -> a) -> Chunk a -> Chunk a -> Chunk a Source #

Given a semigroup structure on a, return a monoid structure on 'Chunk a'.

Note that this is not the same as liftA2.

listToChunk :: Monoid a => [a] -> Chunk a Source #

Concatenate a list into a Chunk. listToChunk satisfies:

isEmpty . listToChunk = null
listToChunk = mconcat . fmap pure

(<<+>>) :: Chunk Doc -> Chunk Doc -> Chunk Doc Source #

Concatenate two Chunks with a space in between. If one is empty, this just returns the other one.

Unlike <+> for Doc, this operation has a unit element, namely the empty Chunk.

(<</>>) :: Chunk Doc -> Chunk Doc -> Chunk Doc Source #

Concatenate two Chunks with a softline in between. This is exactly like <<+>>, but uses a softline instead of a space.

vcatChunks :: [Chunk Doc] -> Chunk Doc Source #

Concatenate Chunks vertically.

vsepChunks :: [Chunk Doc] -> Chunk Doc Source #

Concatenate Chunks vertically separated by empty lines.

isEmpty :: Chunk a -> Bool Source #

Whether a Chunk is empty. Note that something like 'pure mempty' is not considered an empty chunk, even though the underlying Doc is empty.

stringChunk :: String -> Chunk Doc Source #

Convert a String into a Chunk. This satisfies:

isEmpty . stringChunk = null
extractChunk . stringChunk = string

paragraph :: String -> Chunk Doc Source #

Convert a paragraph into a Chunk. The resulting chunk is composed by the words of the original paragraph separated by softlines, so it will be automatically word-wrapped when rendering the underlying document.

This satisfies:

isEmpty . paragraph = null . words

extractChunk :: Monoid a => Chunk a -> a Source #

Part of a constrained comonad instance.

This is the counit of the adjunction between Chunk and the forgetful functor from monoids to semigroups. It satisfies:

extractChunk . pure = id
extractChunk . fmap pure = id

tabulate :: [(Doc, Doc)] -> Chunk Doc Source #

Display pairs of strings in a table.