hscolour-1.24.1: Colourise Haskell code.

Safe Haskell | Safe
Language | Haskell98

Language.Haskell.HsColour.ANSI

Contents

- Orphan instances

Description

Partially taken from Hugs AnsiScreen.hs library:

Synopsis

- highlightOnG :: TerminalType -> [Highlight] -> String
- highlightOn :: [Highlight] -> String
- highlightOff :: [Char]
- highlightG :: TerminalType -> [Highlight] -> String -> String
- highlight :: [Highlight] -> String -> String
- cleareol :: [Char]
- clearbol :: [Char]
- clearline :: [Char]
- clearDown :: [Char]
- clearUp :: [Char]
- cls :: String
- goto :: Int -> Int -> String
- cursorUp :: [Char]
- cursorDown :: [Char]
- cursorLeft :: [Char]
- cursorRight :: [Char]
- savePosition :: [Char]
- restorePosition :: [Char]
- data Highlight
  - = Normal
  - | Bold
  - | Dim
  - | Underscore
  - | Blink
  - | ReverseVideo
  - | Concealed
  - | Foreground Colour
  - | Background Colour
  - | Italic
- data Colour
  - = Black
  - | Red
  - | Green
  - | Yellow
  - | Blue
  - | Magenta
  - | Cyan
  - | White
  - | Rgb Word8 Word8 Word8
- colourCycle :: [Colour]
- enableScrollRegion :: Int -> Int -> String
- scrollUp :: String
- scrollDown :: String
- lineWrap :: Bool -> [Char]
- data TerminalType
  - = Ansi16Colour
  - | XTerm256Compatible

# Documentation

highlightOnG :: TerminalType -> [Highlight] -> String #

highlightOn :: [Highlight] -> String #

# `highlightOn` `Ansi16Colour`

highlightOff :: [Char] #

highlightG :: TerminalType -> [Highlight] -> String -> String #

Make the given string appear with all of the listed highlights

highlight :: [Highlight] -> String -> String #

# `highlightG` `Ansi16Colour`

cleareol :: [Char] #

clearbol :: [Char] #

clearline :: [Char] #

clearDown :: [Char] #

clearUp :: [Char] #

cls :: String #

Clear the screen.

goto :: Int -> Int -> String #

Move the screen cursor to the given position.

cursorUp :: [Char] #

cursorDown :: [Char] #

cursorLeft :: [Char] #

cursorRight :: [Char] #

savePosition :: [Char] #

restorePosition :: [Char] #

data Highlight #

Types of highlighting supported by ANSI codes (and some extra styles).

Constructors

Normal |
Bold |
Dim |
Underscore |
Blink |
ReverseVideo |
Concealed |
Foreground Colour |
Background Colour |
Italic |

Instances

Eq Highlight # |
Methods (==) :: Highlight -> Highlight -> Bool # (/=) :: Highlight -> Highlight -> Bool #
Read Highlight # |
Methods readsPrec :: Int -> ReadS Highlight # readList :: ReadS [Highlight] # readPrec :: ReadPrec Highlight # readListPrec :: ReadPrec [Highlight] #
Show Highlight # |
Methods showsPrec :: Int -> Highlight -> ShowS # show :: Highlight -> String # showList :: [Highlight] -> ShowS #

data Colour #

Colours supported by ANSI codes.

Constructors

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

Instances

Enum Colour # |
Methods succ :: Colour -> Colour # pred :: Colour -> Colour # toEnum :: Int -> Colour # fromEnum :: Colour -> Int # enumFrom :: Colour -> [Colour] # enumFromThen :: Colour -> Colour -> [Colour] # enumFromTo :: Colour -> Colour -> [Colour] # enumFromThenTo :: Colour -> Colour -> Colour -> [Colour] #
Eq Colour # |
Methods (==) :: Colour -> Colour -> Bool # (/=) :: Colour -> Colour -> Bool #
Read Colour # |
Methods readsPrec :: Int -> ReadS Colour # readList :: ReadS [Colour] # readPrec :: ReadPrec Colour # readListPrec :: ReadPrec [Colour] #
Show Colour # |
Methods showsPrec :: Int -> Colour -> ShowS # show :: Colour -> String # showList :: [Colour] -> ShowS #

colourCycle :: [Colour] #

An infinite supply of colours.

enableScrollRegion :: Int -> Int -> String #

Scrolling

scrollUp :: String #

scrollDown :: String #

lineWrap :: Bool -> [Char] #

data TerminalType #

Constructors

Ansi16Colour | `\033[Xm`-style escape sequences (with X =~ [34][0-7])
XTerm256Compatible | `Ansi16Colour`, and also `\033[Y8;5;Zm]`-style escape sequences (with Y =~ [3,4] and Z an integer in [0,255] with the XTerm colour cube semantics).

Instances

Eq TerminalType # |
Methods (==) :: TerminalType -> TerminalType -> Bool # (/=) :: TerminalType -> TerminalType -> Bool #
Ord TerminalType # |
Methods compare :: TerminalType -> TerminalType -> Ordering # (<) :: TerminalType -> TerminalType -> Bool # (<=) :: TerminalType -> TerminalType -> Bool # (>) :: TerminalType -> TerminalType -> Bool # (>=) :: TerminalType -> TerminalType -> Bool # max :: TerminalType -> TerminalType -> TerminalType # min :: TerminalType -> TerminalType -> TerminalType #
Show TerminalType # |
Methods showsPrec :: Int -> TerminalType -> ShowS # show :: TerminalType -> String # showList :: [TerminalType] -> ShowS #

# Orphan instances

Enum Highlight # |
Methods succ :: Highlight -> Highlight # pred :: Highlight -> Highlight # toEnum :: Int -> Highlight # fromEnum :: Highlight -> Int # enumFrom :: Highlight -> [Highlight] # enumFromThen :: Highlight -> Highlight -> [Highlight] # enumFromTo :: Highlight -> Highlight -> [Highlight] # enumFromThenTo :: Highlight -> Highlight -> Highlight -> [Highlight] #