Options.Applicative.Help.Chunk

Documentation

mappendWith :: Monoid a => a -> a -> a -> a

newtype Chunk a

The free monoid on a semigroup a.

Constructors

Chunk

Fields

unChunk :: Maybe a

Instances

Monad Chunk

Functor Chunk

MonadPlus Chunk

Applicative Chunk

Eq a => Eq (Chunk a)

Show a => Show (Chunk a)

Monoid a => Monoid (Chunk a)

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

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

Concatenate a list into a Chunk. listToChunk satisfies:

 isEmpty . listToChunk = null
 listToChunk = mconcat . fmap pure

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

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

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

Concatenate Chunks vertically.

vsepChunks :: [Chunk Doc] -> Chunk Doc

Concatenate Chunks vertically separated by empty lines.

isEmpty :: Chunk a -> Bool

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

Convert a String into a Chunk. This satisfies:

 isEmpty . stringChunk = null
 extractChunk . stringChunk = string

paragraph :: String -> Chunk Doc

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

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

Display pairs of strings in a table.