Text.Pretty.Simple.Internal.Color

Documentation

data ColorOptions

These options are for colorizing the output of functions like pPrint.

For example, if you set colorQuote to something like colorVividBlueBold, then the quote character (") will be output as bright blue in bold.

If you don't want to use a color for one of the options, use colorNull.

Constructors

ColorOptions

Fields

• colorQuote :: Builder

  Color to use for quote characters (") around strings.

• colorString :: Builder

  Color to use for strings.

• colorError :: Builder

  (currently not used)

• colorNum :: Builder

  (currently not used)

• colorRainbowParens :: [Builder]

  A list of Builder colors to use for rainbow parenthesis output. Use '[]' if you don't want rainbow parenthesis. Use just a single item if you want all the rainbow parenthesis to be colored the same.

Instances

Eq ColorOptions

Methods

(==) :: ColorOptions -> ColorOptions -> Bool

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

Show ColorOptions

Methods

showsPrec :: Int -> ColorOptions -> ShowS

show :: ColorOptions -> String

showList :: [ColorOptions] -> ShowS

Generic ColorOptions

Associated Types

type Rep ColorOptions :: * -> *

Methods

from :: ColorOptions -> Rep ColorOptions x

to :: Rep ColorOptions x -> ColorOptions

type Rep ColorOptions

type Rep ColorOptions = D1 * (MetaData "ColorOptions" "Text.Pretty.Simple.Internal.Color" "pretty-simple-2.0.2.0-bMG2970Ppb8vQb3vik1PC" False) (C1 * (MetaCons "ColorOptions" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "colorQuote") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Builder)) (S1 * (MetaSel (Just Symbol "colorString") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Builder))) ((:*:) * (S1 * (MetaSel (Just Symbol "colorError") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Builder)) ((:*:) * (S1 * (MetaSel (Just Symbol "colorNum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Builder)) (S1 * (MetaSel (Just Symbol "colorRainbowParens") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Builder]))))))

defaultColorOptionsDarkBg :: ColorOptions

Default color options for use on a dark background.

colorQuote is defaultColorQuoteDarkBg. colorString is defaultColorStringDarkBg. colorError is defaultColorErrorDarkBg. colorNum is defaultColorNumDarkBg. colorRainbowParens is defaultColorRainboxParensDarkBg.

defaultColorQuoteDarkBg :: Builder

Default color for colorQuote for dark backgrounds. This is colorVividWhiteBold.

defaultColorStringDarkBg :: Builder

Default color for colorString for dark backgrounds. This is colorVividBlueBold.

defaultColorErrorDarkBg :: Builder

Default color for colorError for dark backgrounds. This is colorVividRedBold.

defaultColorNumDarkBg :: Builder

Default color for colorNum for dark backgrounds. This is colorVividGreenBold.

defaultColorRainbowParensDarkBg :: [Builder]

Default colors for colorRainbowParens for dark backgrounds.

defaultColorOptionsLightBg :: ColorOptions

Default color options for use on a light background.

colorQuote is defaultColorQuoteLightBg. colorString is defaultColorStringLightBg. colorError is defaultColorErrorLightBg. colorNum is defaultColorNumLightBg. colorRainbowParens is defaultColorRainboxParensLightBg.

defaultColorQuoteLightBg :: Builder

Default color for colorQuote for light backgrounds. This is colorVividWhiteBold.

defaultColorStringLightBg :: Builder

Default color for colorString for light backgrounds. This is colorVividBlueBold.

defaultColorErrorLightBg :: Builder

Default color for colorError for light backgrounds. This is colorVividRedBold.

defaultColorNumLightBg :: Builder

Default color for colorNum for light backgrounds. This is colorVividGreenBold.

defaultColorRainbowParensLightBg :: [Builder]

Default colors for colorRainbowParens for light backgrounds.

colorVividBlackBold :: Builder

colorVividBlueBold :: Builder

colorVividCyanBold :: Builder

colorVividGreenBold :: Builder

colorVividMagentaBold :: Builder

colorVividRedBold :: Builder

colorVividWhiteBold :: Builder

colorVividYellowBold :: Builder

colorDullBlackBold :: Builder

colorDullBlueBold :: Builder

colorDullCyanBold :: Builder

colorDullGreenBold :: Builder

colorDullMagentaBold :: Builder

colorDullRedBold :: Builder

colorDullWhiteBold :: Builder

colorDullYellowBold :: Builder

colorVividBlack :: Builder

colorVividBlue :: Builder

colorVividCyan :: Builder

colorVividGreen :: Builder

colorVividMagenta :: Builder

colorVividRed :: Builder

colorVividWhite :: Builder

colorVividYellow :: Builder

colorDullBlack :: Builder

colorDullBlue :: Builder

colorDullCyan :: Builder

colorDullGreen :: Builder

colorDullMagenta :: Builder

colorDullRed :: Builder

colorDullWhite :: Builder

colorDullYellow :: Builder

colorBold :: Builder

Change the intensity to BoldIntensity.

colorReset :: Builder

Reset the console color back to normal.

colorNull :: Builder

Empty string.

colorHelper :: ColorIntensity -> Color -> Builder

Helper for creating a Builder for an ANSI escape sequence color based on a ColorIntensity and a Color.

setSGRCodeBuilder :: [SGR] -> Builder

Convert a list of SGR to a Builder.