optparse-applicative-fork-0.16.1.0: Utilities and combinators for parsing command line options
Safe Haskell Safe-Inferred
Language Haskell98

Options.Applicative.Help.Pretty

Synopsis

Documentation

module Prettyprinter

(.$.) :: Doc -> Doc -> Doc Source #

groupOrNestLine :: Doc -> Doc Source #

Render flattened text on this line, or start a new line before rendering any text.

This will also nest subsequent lines in the group.

altSep :: Doc -> Doc -> Doc Source #

Separate items in an alternative with a pipe.

If the first document and the pipe don't fit on the line, then mandatorily flow the next entry onto the following line.

The ( // ) softbreak ensures that if the document does fit on the line, there is at least a space, but it's possible for y to still appear on the next line.

data Ann Source #

Constructors

AnnTrace Int String
AnnStyle SetStyle

Instances

Instances details
Eq Ann Source #
Instance details

Defined in Options.Applicative.Help.Ann

Methods

(==) :: Ann -> Ann -> Bool Source #

(/=) :: Ann -> Ann -> Bool Source #

Show Ann Source #
Instance details

Defined in Options.Applicative.Help.Ann

Methods

showsPrec :: Int -> Ann -> ShowS Source #

show :: Ann -> String Source #

showList :: [ Ann ] -> ShowS Source #

CanAnnotate ( Doc Ann ) Source #
Instance details

Defined in Options.Applicative.Help.Ann

Methods

annTrace :: Int -> String -> Doc Ann -> Doc Ann Source #

CanAnnotate ( Chunk Doc ) Source #
Instance details

Defined in Options.Applicative.Help.Chunk

Methods

annTrace :: Int -> String -> Chunk Doc -> Chunk Doc Source #

type Doc = Doc Ann Source #

enclose Source #

Arguments

:: Doc

L

-> Doc

R

-> Doc

x

-> Doc

LxR

Traced version of enclose .

parens :: Doc -> Doc Source #

Traced version of parens .

brackets :: Doc -> Doc Source #

Traced version of brackets .

hang :: Int -> Doc -> Doc Source #

Traced version of hang .

indent :: Int -> Doc -> Doc Source #

Traced version of indent .

nest :: Int -> Doc -> Doc Source #

Traced version of nest .

text :: String -> Doc Source #

plain :: Doc -> Doc Source #

deunderline :: Doc -> Doc Source #

underline :: Doc -> Doc Source #

debold :: Doc -> Doc Source #

bold :: Doc -> Doc Source #

ondullwhite :: Doc -> Doc Source #

onwhite :: Doc -> Doc Source #

ondullcyan :: Doc -> Doc Source #

oncyan :: Doc -> Doc Source #

ondullmagenta :: Doc -> Doc Source #

onmagenta :: Doc -> Doc Source #

ondullblue :: Doc -> Doc Source #

onblue :: Doc -> Doc Source #

ondullyellow :: Doc -> Doc Source #

onyellow :: Doc -> Doc Source #

ondullgreen :: Doc -> Doc Source #

ongreen :: Doc -> Doc Source #

ondullred :: Doc -> Doc Source #

onred :: Doc -> Doc Source #

ondullblack :: Doc -> Doc Source #

onblack :: Doc -> Doc Source #

dullwhite :: Doc -> Doc Source #

white :: Doc -> Doc Source #

dullcyan :: Doc -> Doc Source #

cyan :: Doc -> Doc Source #

dullmagenta :: Doc -> Doc Source #

magenta :: Doc -> Doc Source #

dullblue :: Doc -> Doc Source #

blue :: Doc -> Doc Source #

dullyellow :: Doc -> Doc Source #

yellow :: Doc -> Doc Source #

dullgreen :: Doc -> Doc Source #

green :: Doc -> Doc Source #

dullred :: Doc -> Doc Source #

red :: Doc -> Doc Source #

dullblack :: Doc -> Doc Source #

black :: Doc -> Doc Source #

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

(<$$>) :: Doc -> Doc -> Doc Source #

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

string :: String -> Doc Source #

Traced version of string .

isEffectivelyEmpty :: Doc -> Bool Source #

Determine if the document is empty when rendered

renderShowS :: SimpleDocStream ann -> ShowS Source #

Render a SimpleDocStream to a ShowS , useful to write Show instances based on the prettyprinter. 

instance Show MyType where
    showsPrec _ = renderShowS . layoutPretty defaultLayoutOptions . pretty