System.Console.ANSI.Types

ansi-terminal-0.8.2: Simple ANSI terminal support, with Windows compatibility

Safe Haskell | Safe
Language | Haskell98

System.Console.ANSI.Types

Description

Types used to represent SELECT GRAPHIC RENDITION (SGR) aspects.

Synopsis

- data SGR
  - = Reset
  - | SetConsoleIntensity !ConsoleIntensity
  - | SetItalicized !Bool
  - | SetUnderlining !Underlining
  - | SetBlinkSpeed !BlinkSpeed
  - | SetVisible !Bool
  - | SetSwapForegroundBackground !Bool
  - | SetColor !ConsoleLayer !ColorIntensity !Color
  - | SetRGBColor !ConsoleLayer !(Colour Float)
- data ConsoleLayer
  - = Foreground
  - | Background
- data Color
  - = Black
  - | Red
  - | Green
  - | Yellow
  - | Blue
  - | Magenta
  - | Cyan
  - | White
- data ColorIntensity
  - = Dull
  - | Vivid
- data ConsoleIntensity
  - = BoldIntensity
  - | FaintIntensity
  - | NormalIntensity
- data Underlining
  - = SingleUnderline
  - | DoubleUnderline
  - | NoUnderline
- data BlinkSpeed
  - = SlowBlink
  - | RapidBlink
  - | NoBlink

# Documentation

data SGR #

ANSI Select Graphic Rendition command

Constructors

Reset |
SetConsoleIntensity !ConsoleIntensity |
SetItalicized !Bool | Not widely supported: sometimes treated as swapping foreground and background
SetUnderlining !Underlining |
SetBlinkSpeed !BlinkSpeed |
SetVisible !Bool | Not widely supported
SetSwapForegroundBackground !Bool |
SetColor !ConsoleLayer !ColorIntensity !Color |
SetRGBColor !ConsoleLayer !(Colour Float) | Supported from Windows 10 Creators Update

Instances

Eq SGR # |
Instance details Defined in System.Console.ANSI.Types Methods (==) :: SGR -> SGR -> Bool # (/=) :: SGR -> SGR -> Bool #
Read SGR # |
Instance details Defined in System.Console.ANSI.Types Methods readsPrec :: Int -> ReadS SGR # readList :: ReadS [SGR] # readPrec :: ReadPrec SGR # readListPrec :: ReadPrec [SGR] #
Show SGR # |
Instance details Defined in System.Console.ANSI.Types Methods showsPrec :: Int -> SGR -> ShowS # show :: SGR -> String # showList :: [SGR] -> ShowS #

data ConsoleLayer #

ANSI colors can be set on two different layers

Constructors

Foreground |
Background |

Instances

Bounded ConsoleLayer # |
Instance details Defined in System.Console.ANSI.Types Methods minBound :: ConsoleLayer # maxBound :: ConsoleLayer #
Enum ConsoleLayer # |
Instance details Defined in System.Console.ANSI.Types Methods succ :: ConsoleLayer -> ConsoleLayer # pred :: ConsoleLayer -> ConsoleLayer # toEnum :: Int -> ConsoleLayer # fromEnum :: ConsoleLayer -> Int # enumFrom :: ConsoleLayer -> [ConsoleLayer] # enumFromThen :: ConsoleLayer -> ConsoleLayer -> [ConsoleLayer] # enumFromTo :: ConsoleLayer -> ConsoleLayer -> [ConsoleLayer] # enumFromThenTo :: ConsoleLayer -> ConsoleLayer -> ConsoleLayer -> [ConsoleLayer] #
Eq ConsoleLayer # |
Instance details Defined in System.Console.ANSI.Types Methods (==) :: ConsoleLayer -> ConsoleLayer -> Bool # (/=) :: ConsoleLayer -> ConsoleLayer -> Bool #
Ord ConsoleLayer # |
Instance details Defined in System.Console.ANSI.Types Methods compare :: ConsoleLayer -> ConsoleLayer -> Ordering # (<) :: ConsoleLayer -> ConsoleLayer -> Bool # (<=) :: ConsoleLayer -> ConsoleLayer -> Bool # (>) :: ConsoleLayer -> ConsoleLayer -> Bool # (>=) :: ConsoleLayer -> ConsoleLayer -> Bool # max :: ConsoleLayer -> ConsoleLayer -> ConsoleLayer # min :: ConsoleLayer -> ConsoleLayer -> ConsoleLayer #
Read ConsoleLayer # |
Instance details Defined in System.Console.ANSI.Types Methods readsPrec :: Int -> ReadS ConsoleLayer # readList :: ReadS [ConsoleLayer] # readPrec :: ReadPrec ConsoleLayer # readListPrec :: ReadPrec [ConsoleLayer] #
Show ConsoleLayer # |
Instance details Defined in System.Console.ANSI.Types Methods showsPrec :: Int -> ConsoleLayer -> ShowS # show :: ConsoleLayer -> String # showList :: [ConsoleLayer] -> ShowS #
Ix ConsoleLayer # |
Instance details Defined in System.Console.ANSI.Types Methods range :: (ConsoleLayer, ConsoleLayer) -> [ConsoleLayer] # index :: (ConsoleLayer, ConsoleLayer) -> ConsoleLayer -> Int # unsafeIndex :: (ConsoleLayer, ConsoleLayer) -> ConsoleLayer -> Int inRange :: (ConsoleLayer, ConsoleLayer) -> ConsoleLayer -> Bool # rangeSize :: (ConsoleLayer, ConsoleLayer) -> Int # unsafeRangeSize :: (ConsoleLayer, ConsoleLayer) -> Int

data Color #

ANSI colors: come in various intensities, which are controlled by `ColorIntensity`

Constructors

Black |
Red |
Green |
Yellow |
Blue |
Magenta |
Cyan |
White |

Instances

Bounded Color # |
Instance details Defined in System.Console.ANSI.Types Methods minBound :: Color # maxBound :: Color #
Enum Color # |
Instance details Defined in System.Console.ANSI.Types Methods succ :: Color -> Color # pred :: Color -> Color # toEnum :: Int -> Color # fromEnum :: Color -> Int # enumFrom :: Color -> [Color] # enumFromThen :: Color -> Color -> [Color] # enumFromTo :: Color -> Color -> [Color] # enumFromThenTo :: Color -> Color -> Color -> [Color] #
Eq Color # |
Instance details Defined in System.Console.ANSI.Types Methods (==) :: Color -> Color -> Bool # (/=) :: Color -> Color -> Bool #
Ord Color # |
Instance details Defined in System.Console.ANSI.Types Methods compare :: Color -> Color -> Ordering # (<) :: Color -> Color -> Bool # (<=) :: Color -> Color -> Bool # (>) :: Color -> Color -> Bool # (>=) :: Color -> Color -> Bool # max :: Color -> Color -> Color # min :: Color -> Color -> Color #
Read Color # |
Instance details Defined in System.Console.ANSI.Types Methods readsPrec :: Int -> ReadS Color # readList :: ReadS [Color] # readPrec :: ReadPrec Color # readListPrec :: ReadPrec [Color] #
Show Color # |
Instance details Defined in System.Console.ANSI.Types Methods showsPrec :: Int -> Color -> ShowS # show :: Color -> String # showList :: [Color] -> ShowS #
Ix Color # |
Instance details Defined in System.Console.ANSI.Types Methods range :: (Color, Color) -> [Color] # index :: (Color, Color) -> Color -> Int # unsafeIndex :: (Color, Color) -> Color -> Int inRange :: (Color, Color) -> Color -> Bool # rangeSize :: (Color, Color) -> Int # unsafeRangeSize :: (Color, Color) -> Int

data ColorIntensity #

ANSI colors come in two intensities

Constructors

Dull |
Vivid |

Instances

Bounded ColorIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods minBound :: ColorIntensity # maxBound :: ColorIntensity #
Enum ColorIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods succ :: ColorIntensity -> ColorIntensity # pred :: ColorIntensity -> ColorIntensity # toEnum :: Int -> ColorIntensity # fromEnum :: ColorIntensity -> Int # enumFrom :: ColorIntensity -> [ColorIntensity] # enumFromThen :: ColorIntensity -> ColorIntensity -> [ColorIntensity] # enumFromTo :: ColorIntensity -> ColorIntensity -> [ColorIntensity] # enumFromThenTo :: ColorIntensity -> ColorIntensity -> ColorIntensity -> [ColorIntensity] #
Eq ColorIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods (==) :: ColorIntensity -> ColorIntensity -> Bool # (/=) :: ColorIntensity -> ColorIntensity -> Bool #
Ord ColorIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods compare :: ColorIntensity -> ColorIntensity -> Ordering # (<) :: ColorIntensity -> ColorIntensity -> Bool # (<=) :: ColorIntensity -> ColorIntensity -> Bool # (>) :: ColorIntensity -> ColorIntensity -> Bool # (>=) :: ColorIntensity -> ColorIntensity -> Bool # max :: ColorIntensity -> ColorIntensity -> ColorIntensity # min :: ColorIntensity -> ColorIntensity -> ColorIntensity #
Read ColorIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods readsPrec :: Int -> ReadS ColorIntensity # readList :: ReadS [ColorIntensity] # readPrec :: ReadPrec ColorIntensity # readListPrec :: ReadPrec [ColorIntensity] #
Show ColorIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods showsPrec :: Int -> ColorIntensity -> ShowS # show :: ColorIntensity -> String # showList :: [ColorIntensity] -> ShowS #
Ix ColorIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods range :: (ColorIntensity, ColorIntensity) -> [ColorIntensity] # index :: (ColorIntensity, ColorIntensity) -> ColorIntensity -> Int # unsafeIndex :: (ColorIntensity, ColorIntensity) -> ColorIntensity -> Int inRange :: (ColorIntensity, ColorIntensity) -> ColorIntensity -> Bool # rangeSize :: (ColorIntensity, ColorIntensity) -> Int # unsafeRangeSize :: (ColorIntensity, ColorIntensity) -> Int

data ConsoleIntensity #

ANSI general console intensity: usually treated as setting the font style (e.g. `BoldIntensity` causes text to be bold)

Constructors

BoldIntensity |
FaintIntensity | Not widely supported: sometimes treated as concealing text
NormalIntensity |

Instances

Bounded ConsoleIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods minBound :: ConsoleIntensity # maxBound :: ConsoleIntensity #
Enum ConsoleIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods succ :: ConsoleIntensity -> ConsoleIntensity # pred :: ConsoleIntensity -> ConsoleIntensity # toEnum :: Int -> ConsoleIntensity # fromEnum :: ConsoleIntensity -> Int # enumFrom :: ConsoleIntensity -> [ConsoleIntensity] # enumFromThen :: ConsoleIntensity -> ConsoleIntensity -> [ConsoleIntensity] # enumFromTo :: ConsoleIntensity -> ConsoleIntensity -> [ConsoleIntensity] # enumFromThenTo :: ConsoleIntensity -> ConsoleIntensity -> ConsoleIntensity -> [ConsoleIntensity] #
Eq ConsoleIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods (==) :: ConsoleIntensity -> ConsoleIntensity -> Bool # (/=) :: ConsoleIntensity -> ConsoleIntensity -> Bool #
Ord ConsoleIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods compare :: ConsoleIntensity -> ConsoleIntensity -> Ordering # (<) :: ConsoleIntensity -> ConsoleIntensity -> Bool # (<=) :: ConsoleIntensity -> ConsoleIntensity -> Bool # (>) :: ConsoleIntensity -> ConsoleIntensity -> Bool # (>=) :: ConsoleIntensity -> ConsoleIntensity -> Bool # max :: ConsoleIntensity -> ConsoleIntensity -> ConsoleIntensity # min :: ConsoleIntensity -> ConsoleIntensity -> ConsoleIntensity #
Read ConsoleIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods readsPrec :: Int -> ReadS ConsoleIntensity # readList :: ReadS [ConsoleIntensity] # readPrec :: ReadPrec ConsoleIntensity # readListPrec :: ReadPrec [ConsoleIntensity] #
Show ConsoleIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods showsPrec :: Int -> ConsoleIntensity -> ShowS # show :: ConsoleIntensity -> String # showList :: [ConsoleIntensity] -> ShowS #
Ix ConsoleIntensity # |
Instance details Defined in System.Console.ANSI.Types Methods range :: (ConsoleIntensity, ConsoleIntensity) -> [ConsoleIntensity] # index :: (ConsoleIntensity, ConsoleIntensity) -> ConsoleIntensity -> Int # unsafeIndex :: (ConsoleIntensity, ConsoleIntensity) -> ConsoleIntensity -> Int inRange :: (ConsoleIntensity, ConsoleIntensity) -> ConsoleIntensity -> Bool # rangeSize :: (ConsoleIntensity, ConsoleIntensity) -> Int # unsafeRangeSize :: (ConsoleIntensity, ConsoleIntensity) -> Int

data Underlining #

ANSI text underlining

Constructors

SingleUnderline |
DoubleUnderline | Not widely supported
NoUnderline |

Instances

Bounded Underlining # |
Instance details Defined in System.Console.ANSI.Types Methods minBound :: Underlining # maxBound :: Underlining #
Enum Underlining # |
Instance details Defined in System.Console.ANSI.Types Methods succ :: Underlining -> Underlining # pred :: Underlining -> Underlining # toEnum :: Int -> Underlining # fromEnum :: Underlining -> Int # enumFrom :: Underlining -> [Underlining] # enumFromThen :: Underlining -> Underlining -> [Underlining] # enumFromTo :: Underlining -> Underlining -> [Underlining] # enumFromThenTo :: Underlining -> Underlining -> Underlining -> [Underlining] #
Eq Underlining # |
Instance details Defined in System.Console.ANSI.Types Methods (==) :: Underlining -> Underlining -> Bool # (/=) :: Underlining -> Underlining -> Bool #
Ord Underlining # |
Instance details Defined in System.Console.ANSI.Types Methods compare :: Underlining -> Underlining -> Ordering # (<) :: Underlining -> Underlining -> Bool # (<=) :: Underlining -> Underlining -> Bool # (>) :: Underlining -> Underlining -> Bool # (>=) :: Underlining -> Underlining -> Bool # max :: Underlining -> Underlining -> Underlining # min :: Underlining -> Underlining -> Underlining #
Read Underlining # |
Instance details Defined in System.Console.ANSI.Types Methods readsPrec :: Int -> ReadS Underlining # readList :: ReadS [Underlining] # readPrec :: ReadPrec Underlining # readListPrec :: ReadPrec [Underlining] #
Show Underlining # |
Instance details Defined in System.Console.ANSI.Types Methods showsPrec :: Int -> Underlining -> ShowS # show :: Underlining -> String # showList :: [Underlining] -> ShowS #
Ix Underlining # |
Instance details Defined in System.Console.ANSI.Types Methods range :: (Underlining, Underlining) -> [Underlining] # index :: (Underlining, Underlining) -> Underlining -> Int # unsafeIndex :: (Underlining, Underlining) -> Underlining -> Int inRange :: (Underlining, Underlining) -> Underlining -> Bool # rangeSize :: (Underlining, Underlining) -> Int # unsafeRangeSize :: (Underlining, Underlining) -> Int

data BlinkSpeed #

ANSI blink speeds: values other than `NoBlink` are not widely supported

Constructors

SlowBlink | Less than 150 blinks per minute
RapidBlink | More than 150 blinks per minute
NoBlink |

Instances

Bounded BlinkSpeed # |
Instance details Defined in System.Console.ANSI.Types Methods minBound :: BlinkSpeed # maxBound :: BlinkSpeed #
Enum BlinkSpeed # |
Instance details Defined in System.Console.ANSI.Types Methods succ :: BlinkSpeed -> BlinkSpeed # pred :: BlinkSpeed -> BlinkSpeed # toEnum :: Int -> BlinkSpeed # fromEnum :: BlinkSpeed -> Int # enumFrom :: BlinkSpeed -> [BlinkSpeed] # enumFromThen :: BlinkSpeed -> BlinkSpeed -> [BlinkSpeed] # enumFromTo :: BlinkSpeed -> BlinkSpeed -> [BlinkSpeed] # enumFromThenTo :: BlinkSpeed -> BlinkSpeed -> BlinkSpeed -> [BlinkSpeed] #
Eq BlinkSpeed # |
Instance details Defined in System.Console.ANSI.Types Methods (==) :: BlinkSpeed -> BlinkSpeed -> Bool # (/=) :: BlinkSpeed -> BlinkSpeed -> Bool #
Ord BlinkSpeed # |
Instance details Defined in System.Console.ANSI.Types Methods compare :: BlinkSpeed -> BlinkSpeed -> Ordering # (<) :: BlinkSpeed -> BlinkSpeed -> Bool # (<=) :: BlinkSpeed -> BlinkSpeed -> Bool # (>) :: BlinkSpeed -> BlinkSpeed -> Bool # (>=) :: BlinkSpeed -> BlinkSpeed -> Bool # max :: BlinkSpeed -> BlinkSpeed -> BlinkSpeed # min :: BlinkSpeed -> BlinkSpeed -> BlinkSpeed #
Read BlinkSpeed # |
Instance details Defined in System.Console.ANSI.Types Methods readsPrec :: Int -> ReadS BlinkSpeed # readList :: ReadS [BlinkSpeed] # readPrec :: ReadPrec BlinkSpeed # readListPrec :: ReadPrec [BlinkSpeed] #
Show BlinkSpeed # |
Instance details Defined in System.Console.ANSI.Types Methods showsPrec :: Int -> BlinkSpeed -> ShowS # show :: BlinkSpeed -> String # showList :: [BlinkSpeed] -> ShowS #
Ix BlinkSpeed # |
Instance details Defined in System.Console.ANSI.Types Methods range :: (BlinkSpeed, BlinkSpeed) -> [BlinkSpeed] # index :: (BlinkSpeed, BlinkSpeed) -> BlinkSpeed -> Int # unsafeIndex :: (BlinkSpeed, BlinkSpeed) -> BlinkSpeed -> Int inRange :: (BlinkSpeed, BlinkSpeed) -> BlinkSpeed -> Bool # rangeSize :: (BlinkSpeed, BlinkSpeed) -> Int # unsafeRangeSize :: (BlinkSpeed, BlinkSpeed) -> Int