master..9891504 · vty · git.iko.soy

CHANGELOG.md−67

@@ -1,71 +1,4 @@

11

2−5.35.1

3−------

4−

5−Bug fixes:

6− * Fixed a build issue with a test program.

7−

8−5.35

9−----

10−

11−New features:

12− * Add support for 24-bit color (thanks @u-quark). This change

13− updates Vty to look at the `COLORTERM` environment variable that is

14− conventionally used to advertise support for truecolor escape

15− sequences. The change also updates the Vty demo to demonstrate

16− 24-bit colors. This change also adds a new data type, `ColorMode`,

17− to represent the color mode in use, as well as an `Output` interface

18− field, `outputColorMode`, to track the active color mode and use it

19− to clamp emitted color escape sequences to the active color range.

20−

21−API changes:

22− * All types in `Graphics.Vty.Input.Events` now have strict constructor

23− fields.

24− * Internal events are now wrapped in a new `InternalEvent` type to

25− improve how signal handling is done. This change modifies the `Input`

26− type's event channel API to produce `InternalEvents`, not `Events`.

27− The new `InternalEvent` either wraps `Event` with the `InputEvent`

28− constructor (the previous behavior) or indicates that Vty resumed

29− after handling a signal using the `ResumeAfterSignal` constructor.

30− This change avoids the previous use of `EvResize` with lazy exception

31− arguments as a sentinel value for `ResumeAfterSignal`.

32−

33−Other enhancements:

34− * Bracketed paste parsing performance has been greatly improved thanks

35− to benchmarking and optimization work by @iphydf. As part of that

36− work, Vty now uses bytestrings rather than Strings internally when

37− parsing input to look for events.

38− * The `\b` value is now interpreted as `KBS` (thanks @vglfr)

39−

40−5.34

41−----

42−

43−API changes:

44− * Added an `NFData` instance for `Event` (thanks Mario Lang)

45− * Removed `Monoid` and `Semigroup` instances for `Attr` and

46− `MaybeDefault`. This change removed the instances because they were

47− misbehaved; merging `Attr` and `MaybeDefault` values with these

48− instances resulted in field value losses. For example, before this

49− change,

50−```

51−(defAttr `withForeColor` blue) <> (defAttr `withBackColor` green)

52−```

53− would result in just

54−```

55− (defAttr `withBackColor` green)

56−```

57− because the instances were designed to favor the right-hand

58− arguments' fields even if they had not been explicitly set

59− (a consequence of the `MaybeDefault` `Semigroup` instance).

60− While that behavior was sensible specifically in the context of

61− `Graphics.Vty.Inline`, it wasn't a useful user-facing API and it made

62− for surprising instance behavior. Since there is actually no good way

63− to handle this in a `Semigroup` instance for `Attr` -- some choices

64− have to be made about how to merge two attributes' foreground colors,

65− and that won't be much better than what we had -- the instance was

66− just removed.

67−

68−

6925.33

703----

714

demos/Demo.hs+4−12

@@ -31,8 +31,7 @@ introText = vertCat $ map (string defAttr)

3131 [ "this line is hidden by the top layer"

3232 , "The vty demo program will echo the events generated by the pressed keys."

3333 , "Below there is a 240 color box."

34− , "Followed by a description of the 16 color palette."

35− , "Followed by tones of red using a 24-bit palette."

34+ , "Followed by a description of the 16 color pallete."

3635 , "If the 240 color box is not visible then the terminal"

3736 , "claims 240 colors are not supported."

3837 , "Try setting TERM to xterm-256color"

@@ -43,19 +42,12 @@ introText = vertCat $ map (string defAttr)

4342 , "¯\\_(ツ)_/¯ ¯\\_(ツ)_/¯ ¯\\_(ツ)_/¯ ¯\\_(ツ)_/¯"

4443 ]

4544

46−splitColorImages :: [Image] -> [[Image]]

47−splitColorImages [] = []

48−splitColorImages is = (take 20 is ++ [string defAttr " "]) : (splitColorImages (drop 20 is))

49−

50−fullcolorbox :: Image

51−fullcolorbox = vertCat $ map horizCat $ splitColorImages colorImages

52− where

53− colorImages = map (\i -> string (currentAttr `withBackColor` linearColor i 0 0) " ") [0..255]

54−

5545colorbox_240 :: Image

5646colorbox_240 = vertCat $ map horizCat $ splitColorImages colorImages

5747 where

5848 colorImages = map (\i -> string (currentAttr `withBackColor` Color240 i) " ") [0..239]

49+ splitColorImages [] = []

50+ splitColorImages is = (take 20 is ++ [string defAttr " "]) : (splitColorImages (drop 20 is))

5951

6052colorbox_16 :: Image

@@ -78,7 +70,7 @@ updateDisplay = do

7870 "Press ESC to exit. Events for keys below."

7971 eventLog <- foldMap (string defAttr) <$> get

8072 let pic = picForImage (info <-> eventLog)

81− `addToBottom` (introText <-> colorbox_240 <|> colorbox_16 <|> fullcolorbox)

73+ `addToBottom` (introText <-> colorbox_240 <|> colorbox_16)

8274 vty <- ask

8375 liftIO $ update vty pic

8476

src/Data/Terminfo/Parse.hs+1−2

@@ -1,9 +1,8 @@

11{-# LANGUAGE BangPatterns #-}

22{-# LANGUAGE CPP #-}

3+{-# OPTIONS_HADDOCK hide #-}

34{-# LANGUAGE NoMonomorphismRestriction #-}

4−{-# LANGUAGE ScopedTypeVariables #-}

55{-# OPTIONS_GHC -funbox-strict-fields -O #-}

6−{-# OPTIONS_HADDOCK hide #-}

76

87module Data.Terminfo.Parse

98 ( module Data.Terminfo.Parse

src/Graphics/Vty.hs+8−12

@@ -1,5 +1,4 @@

11{-# LANGUAGE CPP #-}

2−{-# LANGUAGE ScopedTypeVariables #-}

32

43-- | Vty provides interfaces for both terminal input and terminal

54-- output.

@@ -48,7 +47,6 @@ where

4847

4948import Graphics.Vty.Config

5049import Graphics.Vty.Input

51−import Graphics.Vty.Input.Events

5250import Graphics.Vty.Output

5351import Graphics.Vty.Output.Interface

5452import Graphics.Vty.Picture

@@ -210,18 +208,16 @@ internalMkVty input out = do

210208 maybe (return ()) innerUpdate mPic

211209

212210 let mkResize = uncurry EvResize <$> displayBounds out

213−

214− translateInternalEvent ResumeAfterSignal = mkResize

215− translateInternalEvent (InputEvent e) = return e

216−

217211 gkey = do

218− e <- atomically $ readTChan $ _eventChannel input

219− translateInternalEvent e

212+ k <- atomically $ readTChan $ _eventChannel input

213+ case k of

214+ (EvResize _ _) -> mkResize

215+ _ -> return k

220216 gkey' = do

221− mEv <- atomically $ tryReadTChan $ _eventChannel input

222− case mEv of

223− Just e -> Just <$> translateInternalEvent e

224− Nothing -> return Nothing

217+ k <- atomically $ tryReadTChan $ _eventChannel input

218+ case k of

219+ (Just (EvResize _ _)) -> Just <$> mkResize

220+ _ -> return k

225221

226222 return $ Vty { update = innerUpdate

227223 , nextEvent = gkey

src/Graphics/Vty/Attributes/Color.hs+3−67

@@ -1,14 +1,8 @@

11{-# LANGUAGE DeriveGeneric #-}

22{-# LANGUAGE DeriveAnyClass #-}

3−{-# LANGUAGE MultiWayIf #-}

4−{-# LANGUAGE ScopedTypeVariables #-}

53

64module Graphics.Vty.Attributes.Color

75 ( Color(..)

8− , ColorMode(..)

9−

10− -- * Detecting Terminal Color Support

11− , detectColorMode

126

137 -- ** Fixed Colors

148 -- | Standard 8-color ANSI terminal color codes.

@@ -38,10 +32,7 @@ module Graphics.Vty.Attributes.Color

3832 , brightCyan

3933 , brightWhite

4034 -- ** Creating Colors From RGB

41− , linearColor

42− , srgbColor

4335 , rgbColor

44− , color240

4536 , module Graphics.Vty.Attributes.Color240

4637 )

4738where

@@ -49,11 +40,6 @@ where

4940import Data.Word

5041import GHC.Generics

5142import Control.DeepSeq

52−import System.Environment (lookupEnv)

53−

54−import qualified System.Console.Terminfo as Terminfo

55−import Control.Exception (catch)

56−import Data.Maybe

5743

5844import Graphics.Vty.Attributes.Color240

5945

@@ -95,7 +81,7 @@ import Graphics.Vty.Attributes.Color240

9581-- reported then the color reproduction will be incorrect.

9682--

9783-- If the terminal reports <= 16 colors then the 240 color palette

98−-- points are only mapped to the 8 color palette. I'm not sure of

84+-- points are only mapped to the 8 color pallete. I'm not sure of

9985-- the RGB points for the "bright" colors which is why they are not

10086-- addressable via the 240 color palette.

10187--

@@ -109,33 +95,9 @@ import Graphics.Vty.Attributes.Color240

10995-- terminfo but I don't know it.

11096--

11197-- Seriously, terminal color support is INSANE.

112−data Color = ISOColor !Word8 | Color240 !Word8 | RGBColor !Word8 !Word8 !Word8

98+data Color = ISOColor !Word8 | Color240 !Word8

11399 deriving ( Eq, Show, Read, Generic, NFData )

114100

115−data ColorMode

116− = NoColor

117− | ColorMode8

118− | ColorMode16

119− | ColorMode240 !Word8

120− | FullColor

121− deriving ( Eq, Show )

122−

123−detectColorMode :: String -> IO ColorMode

124−detectColorMode termName' = do

125− term <- catch (Just <$> Terminfo.setupTerm termName')

126− (\(_ :: Terminfo.SetupTermError) -> return Nothing)

127− let getCap cap = term >>= \t -> Terminfo.getCapability t cap

128− termColors = fromMaybe 0 $ getCap (Terminfo.tiGetNum "colors")

129− colorterm <- lookupEnv "COLORTERM"

130− return $ if

131− | termColors < 8 -> NoColor

132− | termColors < 16 -> ColorMode8

133− | termColors == 16 -> ColorMode16

134− | termColors < 256 -> ColorMode240 (fromIntegral termColors - 16)

135− | colorterm == Just "truecolor" -> FullColor

136− | colorterm == Just "24bit" -> FullColor

137− | otherwise -> ColorMode240 240

138−

139101black, red, green, yellow, blue, magenta, cyan, white :: Color

140102black = ISOColor 0

141103red = ISOColor 1

@@ -157,35 +119,9 @@ brightMagenta= ISOColor 13

157119brightCyan = ISOColor 14

158120brightWhite = ISOColor 15

159121

160−linearColor :: Integral i => i -> i -> i -> Color

161−linearColor r g b = RGBColor r' g' b'

162− where

163− r' = fromIntegral (clamp r) :: Word8

164− g' = fromIntegral (clamp g) :: Word8

165− b' = fromIntegral (clamp b) :: Word8

166− clamp = min 255 . max 0

167−

168−srgbColor :: Integral i => i -> i -> i -> Color

169−srgbColor r g b =

170− -- srgb to rgb transformation as described at

171− -- https://en.wikipedia.org/wiki/SRGB#The_reverse_transformation

172− --

173− -- TODO: it may be worth translating this to a lookup table, as with color240

174− let shrink n = fromIntegral n / 255 :: Double

175− -- called gamma^-1 in wiki

176− gamma u

177− | u <= 0.04045 = u/12.92

178− | otherwise = ((u + 0.055) / 1.055) ** 2.4

179− -- TODO: this is a slightly inaccurate conversion. is it worth doing proterly?

180− expand n = round (255 * n)

181− convert = expand . gamma . shrink

182− in RGBColor (convert r) (convert g) (convert b)

183−

184−color240 :: Integral i => i -> i -> i -> Color

185−color240 r g b = Color240 (rgbColorToColor240 r g b)

186122

187123-- | Create a Vty 'Color' (in the 240 color set) from an RGB triple.

188124-- This function is lossy in the sense that we only internally support 240 colors but the

189125-- #RRGGBB format supports 16^3 colors.

190126rgbColor :: Integral i => i -> i -> i -> Color

191−rgbColor = color240

127+rgbColor r g b = Color240 (rgbColorToColor240 r g b)

src/Graphics/Vty/Config.hs+2−11

@@ -3,7 +3,6 @@

33{-# LANGUAGE FlexibleContexts, FlexibleInstances #-}

44{-# LANGUAGE TypeOperators #-}

55{-# LANGUAGE ScopedTypeVariables #-}

6−{-# LANGUAGE LambdaCase, MultiWayIf #-}

76-- | Vty supports a configuration file format and associated 'Config'

87-- data type. The 'Config' can be provided to 'mkVty' to customize the

98-- application's use of Vty.

@@ -55,7 +54,7 @@

5554-- If a debug log is requested then vty will output the current input

5655-- table to the log in the above format. A workflow for using this is

5756-- to set @VTY_DEBUG_LOG@. Run the application. Check the debug log for

58−-- incorrect mappings. Add corrected mappings to @$HOME\/.vty\/config@.

57+-- incorrect mappings. Add corrected mappings to @$HOME/.vty/config@.

5958--

6059-- = Unicode Character Width Maps

6160--

@@ -123,7 +122,6 @@ import Data.Semigroup (Semigroup(..))

123122import Data.Typeable (Typeable)

124123

125124import Graphics.Vty.Input.Events

126−import Graphics.Vty.Attributes.Color (ColorMode(..), detectColorMode)

127125

128126import GHC.Generics

129127

@@ -195,9 +193,6 @@ data Config =

195193 -- configuration specifies one. If no custom table is loaded

196194 -- (or if a load fails), the built-in character width table

197195 -- will be used.

198− , colorMode :: Maybe ColorMode

199− -- ^ The color mode used to know how many colors the terminal

200− -- supports.

201196 }

202197 deriving (Show, Eq)

203198

@@ -219,7 +214,6 @@ instance Semigroup Config where

219214 , termWidthMaps = termWidthMaps c1 <|> termWidthMaps c0

220215 , allowCustomUnicodeWidthTables =

221216 allowCustomUnicodeWidthTables c1 <|> allowCustomUnicodeWidthTables c0

222− , colorMode = colorMode c1 <|> colorMode c0

223217 }

224218

225219instance Monoid Config where

@@ -235,7 +229,6 @@ instance Monoid Config where

235229 , termName = Nothing

236230 , termWidthMaps = []

237231 , allowCustomUnicodeWidthTables = Nothing

238− , colorMode = Nothing

239232 }

240233#if !(MIN_VERSION_base(4,11,0))

241234 mappend = (<>)

@@ -291,8 +284,7 @@ standardIOConfig = do

291284 mb <- lookupEnv termVariable

292285 case mb of

293286 Nothing -> throwIO VtyMissingTermEnvVar

294− Just t -> do

295− mcolorMode <- detectColorMode t

287+ Just t ->

296288 return defaultConfig

297289 { vmin = Just 1

298290 , mouseMode = Just False

@@ -301,7 +293,6 @@ standardIOConfig = do

301293 , inputFd = Just stdInput

302294 , outputFd = Just stdOutput

303295 , termName = Just t

304− , colorMode = Just mcolorMode

305296 }

306297

307298parseConfigFile :: FilePath -> IO Config

src/Graphics/Vty/Image.hs+1−1

@@ -137,7 +137,7 @@ char a c =

137137 let displayWidth = safeWcwidth c

138138 in HorizText a (TL.singleton c) displayWidth 1

139139

140−-- | Make an image from a string of characters laid out on a single

140+-- | Make an image from a string of characters layed out on a single

141141-- row with the same display attribute. The string is assumed to be a

142142-- sequence of ISO-10646 characters. The input string should be

143143-- sanitized of escape sequences (ASCII 27) and carriage returns;

src/Graphics/Vty/Image/Internal.hs+2−2

@@ -228,7 +228,7 @@ instance Monoid Image where

228228--

229229-- The result image will have a width equal to the sum of the two images

230230-- width. And the height will equal the largest height of the two

231−-- images. The area not defined in one image due to a height mismatch

231+-- images. The area not defined in one image due to a height missmatch

232232-- will be filled with the background pattern.

233233horizJoin :: Image -> Image -> Image

234234horizJoin EmptyImage i = i

@@ -259,7 +259,7 @@ horizJoin _ _ = error "horizJoin applied to undefined values."

259259--

260260-- The result image will have a height equal to the sum of the heights

261261-- of both images. The width will equal the largest width of the two

262−-- images. The area not defined in one image due to a width mismatch

262+-- images. The area not defined in one image due to a width missmatch

263263-- will be filled with the background pattern.

264264vertJoin :: Image -> Image -> Image

265265vertJoin EmptyImage i = i

src/Graphics/Vty/Input.hs+4−3

@@ -77,7 +77,7 @@

7777-- The input encoding determines how UTF-8 encoded characters are

7878-- recognized.

7979--

80−-- * 7-bit mode: UTF-8 can be input unambiguously. UTF-8 input is

80+-- * 7-bit mode: UTF-8 can be input unambiguiously. UTF-8 input is

8181-- a superset of ASCII. UTF-8 does not overlap escaped control key

8282-- sequences. However, the escape key must be differentiated from

8383-- escaped control key sequences by the timing of the input bytes.

@@ -95,7 +95,7 @@

9595--

9696-- == Terminal Input is Broken

9797--

98−-- Clearly terminal input has fundamental issues. There is no easy way

98+-- Clearly terminal input has fundemental issues. There is no easy way

9999-- to reliably resolve these issues.

100100--

101101-- One resolution would be to ditch standard terminal interfaces

@@ -158,8 +158,9 @@ inputForConfig config@Config{ termName = Just termName

158158 setAttrs

159159 input <- initInput config activeInputMap

160160 let pokeIO = Catch $ do

161+ let e = error "vty internal failure: this value should not propagate to users"

161162 setAttrs

162− atomically $ writeTChan (input^.eventChannel) ResumeAfterSignal

163+ atomically $ writeTChan (input^.eventChannel) (EvResize e e)

163164 _ <- installHandler windowChange pokeIO Nothing

164165 _ <- installHandler continueProcess pokeIO Nothing

165166

src/Graphics/Vty/Input/Classify.hs+29−53

@@ -1,11 +1,10 @@

11{-# OPTIONS_HADDOCK hide #-}

2−-- This makes a kind of trie. Has space efficiency issues with large

2+-- This makes a kind of tri. Has space efficiency issues with large

33-- input blocks. Likely building a parser and just applying that would

44-- be better.

55module Graphics.Vty.Input.Classify

66 ( classify

77 , KClass(..)

8− , ClassifierState(..)

98 )

109where

1110

@@ -17,39 +16,25 @@ import Graphics.Vty.Input.Classify.Types

1716

1817import Codec.Binary.UTF8.Generic (decode)

1918

20−import Control.Arrow (first)

19+import Data.List (inits)

2120import qualified Data.Map as M( fromList, lookup )

2221import Data.Maybe ( mapMaybe )

2322import qualified Data.Set as S( fromList, member )

2423

24+import Data.Char

2525import Data.Word

2626

27−import qualified Data.ByteString as BS

28−import qualified Data.ByteString.Char8 as BS8

29−import Data.ByteString.Char8 (ByteString)

30−

31−-- | Whether the classifier is currently processing a chunked format.

32−-- Currently, only bracketed pastes use this.

33−data ClassifierState

34− = ClassifierStart

35− -- ^ Not processing a chunked format.

36− | ClassifierInChunk ByteString [ByteString]

37− -- ^ Currently processing a chunked format. The initial chunk is in the

38− -- first argument and a reversed remainder of the chunks is collected in

39− -- the second argument. At the end of the processing, the chunks are

40− -- reversed and concatenated with the final chunk.

41−

42−compile :: ClassifyMap -> ByteString -> KClass

27+compile :: ClassifyMap -> String -> KClass

4328compile table = cl' where

4429 -- take all prefixes and create a set of these

45− prefixSet = S.fromList $ concatMap (init . BS.inits . BS8.pack . fst) table

30+ prefixSet = S.fromList $ concatMap (init . inits . fst) table

4631 maxValidInputLength = maximum (map (length . fst) table)

47− eventForInput = M.fromList $ map (first BS8.pack) table

48− cl' inputBlock | BS8.null inputBlock = Prefix

32+ eventForInput = M.fromList table

33+ cl' [] = Prefix

4934 cl' inputBlock = case M.lookup inputBlock eventForInput of

5035 -- if the inputBlock is exactly what is expected for an

5136 -- event then consume the whole block and return the event

52− Just e -> Valid e BS8.empty

37+ Just e -> Valid e []

5338 Nothing -> case S.member inputBlock prefixSet of

5439 True -> Prefix

5540 -- look up progressively smaller tails of the input

@@ -60,49 +45,40 @@ compile table = cl' where

6045 -- H: There will always be one match. The prefixSet

6146 -- contains, by definition, all prefixes of an event.

6247 False ->

63− let inputPrefixes = reverse . take maxValidInputLength . tail . BS8.inits $ inputBlock

48+ let inputPrefixes = reverse $ take maxValidInputLength $ tail $ inits inputBlock

6449 in case mapMaybe (\s -> (,) s `fmap` M.lookup s eventForInput) inputPrefixes of

65− (s,e) : _ -> Valid e (BS8.drop (BS8.length s) inputBlock)

50+ (s,e) : _ -> Valid e (drop (length s) inputBlock)

6651 -- neither a prefix or a full event.

6752 [] -> Invalid

6853

69−classify :: ClassifyMap -> ClassifierState -> ByteString -> KClass

70−classify table = process

71− where

72− standardClassifier = compile table

73−

74− process ClassifierStart s =

75− case BS.uncons s of

76− _ | bracketedPasteStarted s ->

77− if bracketedPasteFinished s

78− then parseBracketedPaste s

79− else Chunk

80− _ | isMouseEvent s -> classifyMouseEvent s

81− _ | isFocusEvent s -> classifyFocusEvent s

82− Just (c,cs) | c >= 0xC2 -> classifyUtf8 c cs

83− _ -> standardClassifier s

84−

85− process (ClassifierInChunk p ps) s | bracketedPasteStarted p =

54+classify :: ClassifyMap -> String -> KClass

55+classify table =

56+ let standardClassifier = compile table

57+ in \s -> case s of

58+ _ | bracketedPasteStarted s ->

8659 if bracketedPasteFinished s

87− then parseBracketedPaste $ BS.concat $ p:reverse (s:ps)

88− else Chunk

89− process ClassifierInChunk{} _ = Invalid

60+ then parseBracketedPaste s

61+ else Prefix

62+ _ | isMouseEvent s -> classifyMouseEvent s

63+ _ | isFocusEvent s -> classifyFocusEvent s

64+ c:cs | ord c >= 0xC2 -> classifyUtf8 c cs

65+ _ -> standardClassifier s

9066

91−classifyUtf8 :: Word8 -> ByteString -> KClass

67+classifyUtf8 :: Char -> String -> KClass

9268classifyUtf8 c cs =

93− let n = utf8Length c

94− (codepoint,rest) = BS8.splitAt (n - 1) cs

69+ let n = utf8Length (ord c)

70+ (codepoint,rest) = splitAt n (c:cs)

9571

9672 codepoint8 :: [Word8]

97− codepoint8 = c:BS.unpack codepoint

73+ codepoint8 = map (fromIntegral . ord) codepoint

9874

9975 in case decode codepoint8 of

100− _ | n < BS.length codepoint + 1 -> Prefix

101− Just (unicodeChar, _) -> Valid (EvKey (KChar unicodeChar) []) rest

76+ _ | n < length codepoint -> Prefix

77+ Just (unicodeChar, _) -> Valid (EvKey (KChar unicodeChar) []) rest

10278 -- something bad happened; just ignore and continue.

103− Nothing -> Invalid

79+ Nothing -> Invalid

10480

105−utf8Length :: Word8 -> Int

81+utf8Length :: (Num t, Ord a, Num a) => a -> t

10682utf8Length c

10783 | c < 0x80 = 1

10884 | c < 0xE0 = 2

src/Graphics/Vty/Input/Classify/Parse.hs+7−10

@@ -16,15 +16,12 @@ import Graphics.Vty.Input.Classify.Types

1616import Control.Monad.Trans.Maybe

1717import Control.Monad.State

1818

19−import qualified Data.ByteString.Char8 as BS8

20−import Data.ByteString.Char8 (ByteString)

21−

22−type Parser a = MaybeT (State ByteString) a

19+type Parser a = MaybeT (State String) a

2320

2421-- | Run a parser on a given input string. If the parser fails, return

2522-- 'Invalid'. Otherwise return the valid event ('Valid') and the

2623-- remaining unparsed characters.

27−runParser :: ByteString -> Parser Event -> KClass

24+runParser :: String -> Parser Event -> KClass

2825runParser s parser =

2926 case runState (runMaybeT parser) s of

3027 (Nothing, _) -> Invalid

@@ -39,9 +36,9 @@ failParse = fail "invalid parse"

3936-- return '123' and consume those characters.

4037readInt :: Parser Int

4138readInt = do

42− s <- BS8.unpack <$> get

39+ s <- get

4340 case (reads :: ReadS Int) s of

44− [(i, rest)] -> put (BS8.pack rest) >> return i

41+ [(i, rest)] -> put rest >> return i

4542 _ -> failParse

4643

4744-- | Read a character from the input stream. If one cannot be read (e.g.

@@ -49,9 +46,9 @@ readInt = do

4946readChar :: Parser Char

5047readChar = do

5148 s <- get

52− case BS8.uncons s of

53− Just (c,rest) -> put rest >> return c

54− Nothing -> failParse

49+ case s of

50+ c:rest -> put rest >> return c

51+ _ -> failParse

5552

5653-- | Read a character from the input stream and fail parsing if it is

5754-- not the specified character.

src/Graphics/Vty/Input/Classify/Types.hs+1−7

@@ -1,6 +1,5 @@

11-- | This module exports the input classification type to avoid import

22-- cycles between other modules that need this.

3−{-# LANGUAGE StrictData #-}

43module Graphics.Vty.Input.Classify.Types

54 ( KClass(..)

65 )

@@ -8,10 +7,8 @@ where

87

98import Graphics.Vty.Input.Events

109

11−import Data.ByteString.Char8 (ByteString)

12−

1310data KClass

14− = Valid Event ByteString

11+ = Valid Event String

1512 -- ^ A valid event was parsed. Any unused characters from the input

1613 -- stream are also provided.

1714 | Invalid

@@ -19,7 +16,4 @@ data KClass

1916 | Prefix

2017 -- ^ The input characters form the prefix of a valid event character

2118 -- sequence.

22− | Chunk

23− -- ^ The input characters are either start of a bracketed paste chunk

24− -- or in the middle of a bracketed paste chunk.

2519 deriving(Show, Eq)

src/Graphics/Vty/Input/Events.hs+6−15

@@ -1,5 +1,4 @@

11{-# Language DeriveGeneric #-}

2−{-# Language StrictData #-}

32module Graphics.Vty.Input.Events where

43

54import Control.DeepSeq

@@ -16,10 +15,10 @@ import GHC.Generics

1615--

1716-- * Actually, support for most of these but KEsc, KChar, KBS, and

1817-- KEnter vary by terminal and keyboard.

19−data Key = KEsc | KChar {-# UNPACK #-} Char | KBS | KEnter

18+data Key = KEsc | KChar Char | KBS | KEnter

2019 | KLeft | KRight | KUp | KDown

22− | KFun {-# UNPACK #-} Int | KBackTab | KPrtScr | KPause | KIns

2423 deriving (Eq,Show,Read,Ord,Generic)

2524

@@ -52,8 +51,10 @@ data Event

5251 -- without specifying which one; in that case, Nothing is provided.

5352 -- Otherwise Just the button released is included in the event.

5453 | EvResize Int Int

55− -- The terminal window was resized and the size is provided in the

56− -- integer fields (width, height).

54+ -- ^ If read from 'eventChannel' this is the size at the time of the

55+ -- signal. If read from 'nextEvent' this is the size at the time the

56+ -- event was processed by Vty. Typically these are the same, but if

57+ -- somebody is resizing the terminal quickly they can be different.

5758 | EvPaste ByteString

5859 -- ^ A paste event occurs when a bracketed paste input sequence is

5960 -- received. For terminals that support bracketed paste mode, these

@@ -71,13 +72,3 @@ data Event

7172instance NFData Event

7273

7374type ClassifyMap = [(String,Event)]

74−

75−-- | The type of internal events that drive the internal Vty event

76−-- dispatching to the application.

77−data InternalEvent =

78− ResumeAfterSignal

79− -- ^ Vty resumed operation after the process was interrupted with a

80− -- signal. In practice this translates into a screen redraw in the

81− -- input event loop.

82− | InputEvent Event

83− -- ^ An input event was received.

src/Graphics/Vty/Input/Focus.hs+13−15

@@ -11,32 +11,30 @@ import Graphics.Vty.Input.Classify.Types

1111import Graphics.Vty.Input.Classify.Parse

1212

1313import Control.Monad.State

14−

15−import qualified Data.ByteString.Char8 as BS8

16−import Data.ByteString.Char8 (ByteString)

14+import Data.List (isPrefixOf)

1715

1816-- | These sequences set xterm-based terminals to send focus event

1917-- sequences.

20−requestFocusEvents :: ByteString

21−requestFocusEvents = BS8.pack "\ESC[?1004h"

18+requestFocusEvents :: String

19+requestFocusEvents = "\ESC[?1004h"

2220

2321-- | These sequences disable focus events.

24−disableFocusEvents :: ByteString

25−disableFocusEvents = BS8.pack "\ESC[?1004l"

22+disableFocusEvents :: String

23+disableFocusEvents = "\ESC[?1004l"

2624

2725-- | Does the specified string begin with a focus event?

28−isFocusEvent :: ByteString -> Bool

29−isFocusEvent s = BS8.isPrefixOf focusIn s ||

30− BS8.isPrefixOf focusOut s

26+isFocusEvent :: String -> Bool

27+isFocusEvent s = isPrefixOf focusIn s ||

28+ isPrefixOf focusOut s

3129

32−focusIn :: ByteString

33−focusIn = BS8.pack "\ESC[I"

30+focusIn :: String

31+focusIn = "\ESC[I"

3432

35−focusOut :: ByteString

36−focusOut = BS8.pack "\ESC[O"

33+focusOut :: String

34+focusOut = "\ESC[O"

3735

3836-- | Attempt to classify an input string as a focus event.

39−classifyFocusEvent :: ByteString -> KClass

37+classifyFocusEvent :: String -> KClass

4038classifyFocusEvent s = runParser s $ do

4139 when (not $ isFocusEvent s) failParse

4240

src/Graphics/Vty/Input/Loop.hs+22−41

@@ -1,9 +1,8 @@

1−{-# LANGUAGE CPP #-}

2−{-# LANGUAGE NoMonomorphismRestriction #-}

31{-# LANGUAGE RecordWildCards #-}

4−{-# LANGUAGE ScopedTypeVariables #-}

5−{-# LANGUAGE TemplateHaskell #-}

62{-# OPTIONS_HADDOCK hide #-}

3+{-# LANGUAGE NoMonomorphismRestriction #-}

4+{-# LANGUAGE TemplateHaskell #-}

5+{-# LANGUAGE CPP #-}

76-- | The input layer used to be a single function that correctly

87-- accounted for the non-threaded runtime by emulating the terminal

98-- VMIN adn VTIME handling. This has been removed and replace with a

@@ -34,15 +33,12 @@ import Control.Monad.Trans.State (StateT(..), evalStateT)

3433import Control.Monad.State.Class (MonadState, modify)

3534import Control.Monad.Trans.Reader (ReaderT(..))

3635

37−import qualified Data.ByteString.Char8 as BS8

38−import qualified Data.ByteString as BS

39−import Data.ByteString.Char8 (ByteString)

36+import Data.Char

4037import Data.IORef

4138import Data.Word (Word8)

4239

43−import Foreign (allocaArray)

40+import Foreign ( allocaArray, peekArray, Ptr )

4441import Foreign.C.Types (CInt(..))

45−import Foreign.Ptr (Ptr, castPtr)

4642

4743import System.IO

4844import System.Posix.IO (fdReadBuf, setFdOption, FdOption(..))

@@ -55,7 +51,7 @@ data Input = Input

5551 { -- | Channel of events direct from input processing. Unlike

5652 -- 'nextEvent' this will not refresh the display if the next event

5753 -- is an 'EvResize'.

58− _eventChannel :: TChan InternalEvent

54+ _eventChannel :: TChan Event

5955 -- | Shuts down the input processing. As part of shutting down the

6056 -- input, this should also restore the input state.

6157 , shutdownInput :: IO ()

@@ -80,11 +76,10 @@ data InputBuffer = InputBuffer

8076makeLenses ''InputBuffer

8177

8278data InputState = InputState

83− { _unprocessedBytes :: ByteString

84− , _classifierState :: ClassifierState

79+ { _unprocessedBytes :: String

8580 , _appliedConfig :: Config

8681 , _inputBuffer :: InputBuffer

87− , _classifier :: ClassifierState -> ByteString -> KClass

82+ , _classifier :: String -> KClass

8883 }

8984

9085makeLenses ''InputState

@@ -109,20 +104,20 @@ loopInputProcessor = do

109104 dropInvalid

110105 loopInputProcessor

111106

112−addBytesToProcess :: ByteString -> InputM ()

107+addBytesToProcess :: String -> InputM ()

113108addBytesToProcess block = unprocessedBytes <>= block

114109

115110emit :: Event -> InputM ()

116111emit event = do

117112 logMsg $ "parsed event: " ++ show event

118− view eventChannel >>= liftIO . atomically . flip writeTChan (InputEvent event)

113+ view eventChannel >>= liftIO . atomically . flip writeTChan event

119114

120115-- The timing requirements are assured by the VMIN and VTIME set for the

121116-- device.

122117--

123118-- Precondition: Under the threaded runtime. Only current use is from a

124119-- forkOS thread. That case satisfies precondition.

125−readFromDevice :: InputM ByteString

120+readFromDevice :: InputM String

126121readFromDevice = do

127122 newConfig <- view configRef >>= liftIO . readIORef

128123 oldConfig <- use appliedConfig

@@ -142,10 +137,9 @@ readFromDevice = do

142137 threadWaitRead fd

143138 bytesRead <- fdReadBuf fd bufferPtr (fromIntegral maxBytes)

144139 if bytesRead > 0

145− then BS.packCStringLen (castPtr bufferPtr, fromIntegral bytesRead)

146− else return BS.empty

147− when (not $ BS.null stringRep) $

148− logMsg $ "input bytes: " ++ show (BS8.unpack stringRep)

140+ then map (chr . fromIntegral) <$> peekArray (fromIntegral bytesRead) bufferPtr

141+ else return []

142+ when (not $ null stringRep) $ logMsg $ "input bytes: " ++ show stringRep

149143 return stringRep

150144

151145applyConfig :: Fd -> Config -> IO ()

@@ -156,43 +150,30 @@ applyConfig _ _ = fail "(vty) applyConfig was not provided a complete configurat

156150parseEvent :: InputM Event

157151parseEvent = do

158152 c <- use classifier

159− s <- use classifierState

160153 b <- use unprocessedBytes

161− case c s b of

154+ case c b of

162155 Valid e remaining -> do

163156 logMsg $ "valid parse: " ++ show e

164157 logMsg $ "remaining: " ++ show remaining

165− classifierState .= ClassifierStart

166158 unprocessedBytes .= remaining

167159 return e

168− _ -> mzero

160+ _ -> mzero

169161

170162dropInvalid :: InputM ()

171163dropInvalid = do

172164 c <- use classifier

173− s <- use classifierState

174165 b <- use unprocessedBytes

175− case c s b of

176− Chunk -> do

177− classifierState .=

178− case s of

179− ClassifierStart -> ClassifierInChunk b []

180− ClassifierInChunk p bs -> ClassifierInChunk p (b:bs)

181− unprocessedBytes .= BS8.empty

182− Invalid -> do

183− logMsg "dropping input bytes"

184− classifierState .= ClassifierStart

185− unprocessedBytes .= BS8.empty

186− _ -> return ()

166+ when (c b == Invalid) $ do

167+ logMsg "dropping input bytes"

168+ unprocessedBytes .= []

187169

188170runInputProcessorLoop :: ClassifyMap -> Input -> IO ()

189171runInputProcessorLoop classifyTable input = do

190172 let bufferSize = 1024

191173 allocaArray bufferSize $ \(bufferPtr :: Ptr Word8) -> do

192− s0 <- InputState BS8.empty ClassifierStart

193− <$> readIORef (_configRef input)

194− <*> pure (InputBuffer bufferPtr bufferSize)

195− <*> pure (classify classifyTable)

174+ s0 <- InputState [] <$> readIORef (_configRef input)

175+ <*> pure (InputBuffer bufferPtr bufferSize)

176+ <*> pure (classify classifyTable)

196177 runReaderT (evalStateT loopInputProcessor s0) input

197178

198179-- | Construct two IO actions: one to configure the terminal for Vty and

src/Graphics/Vty/Input/Mouse.hs+17−19

@@ -15,12 +15,10 @@ import Graphics.Vty.Input.Classify.Types

1515import Graphics.Vty.Input.Classify.Parse

1616

1717import Control.Monad.State

18+import Data.List (isPrefixOf)

1819import Data.Maybe (catMaybes)

1920import Data.Bits ((.&.))

2021

21−import qualified Data.ByteString.Char8 as BS8

22−import Data.ByteString.Char8 (ByteString)

23−

2422-- A mouse event in SGR extended mode is

2523--

2624-- '\ESC' '[' '<' B ';' X ';' Y ';' ('M'|'m')

@@ -34,28 +32,28 @@ import Data.ByteString.Char8 (ByteString)

3432

3533-- | These sequences set xterm-based terminals to send mouse event

3634-- sequences.

37−requestMouseEvents :: ByteString

38−requestMouseEvents = BS8.pack "\ESC[?1000h\ESC[?1002h\ESC[?1006h"

35+requestMouseEvents :: String

36+requestMouseEvents = "\ESC[?1000h\ESC[?1002h\ESC[?1006h"

3937

4038-- | These sequences disable mouse events.

41−disableMouseEvents :: ByteString

42−disableMouseEvents = BS8.pack "\ESC[?1000l\ESC[?1002l\ESC[?1006l"

39+disableMouseEvents :: String

40+disableMouseEvents = "\ESC[?1000l\ESC[?1002l\ESC[?1006l"

4341

4442-- | Does the specified string begin with a mouse event?

45−isMouseEvent :: ByteString -> Bool

43+isMouseEvent :: String -> Bool

4644isMouseEvent s = isSGREvent s || isNormalEvent s

4745

48−isSGREvent :: ByteString -> Bool

49−isSGREvent = BS8.isPrefixOf sgrPrefix

46+isSGREvent :: String -> Bool

47+isSGREvent = isPrefixOf sgrPrefix

5048

51−sgrPrefix :: ByteString

52−sgrPrefix = BS8.pack "\ESC[M"

49+sgrPrefix :: String

50+sgrPrefix = "\ESC[M"

5351

54−isNormalEvent :: ByteString -> Bool

55−isNormalEvent = BS8.isPrefixOf normalPrefix

52+isNormalEvent :: String -> Bool

53+isNormalEvent = isPrefixOf normalPrefix

5654

57−normalPrefix :: ByteString

58−normalPrefix = BS8.pack "\ESC[<"

55+normalPrefix :: String

56+normalPrefix = "\ESC[<"

5957

6058-- Modifier bits:

6159shiftBit :: Int

@@ -89,8 +87,8 @@ scrollDown = 65

8987hasBitSet :: Int -> Int -> Bool

9088hasBitSet val bit = val .&. bit > 0

9189

92−-- | Attempt to classify an input string as a mouse event.

93−classifyMouseEvent :: ByteString -> KClass

90+-- | Attempt to lassify an input string as a mouse event.

91+classifyMouseEvent :: String -> KClass

9492classifyMouseEvent s = runParser s $ do

9593 when (not $ isMouseEvent s) failParse

9694

@@ -102,7 +100,7 @@ classifyMouseEvent s = runParser s $ do

102100 'M' -> classifyNormalMouseEvent

103101 _ -> failParse

104102

105−-- Given a modifier/button value, determine which button was indicated

103+-- Given a modifer/button value, determine which button was indicated

106104getSGRButton :: Int -> Parser Button

107105getSGRButton mods =

108106 let buttonMap = [ (leftButton, BLeft)

src/Graphics/Vty/Input/Paste.hs+24−16

@@ -9,33 +9,41 @@ module Graphics.Vty.Input.Paste

99where

1010

1111import qualified Data.ByteString.Char8 as BS8

12−import Data.ByteString.Char8 (ByteString)

1312

1413import Graphics.Vty.Input.Events

1514import Graphics.Vty.Input.Classify.Types

1615

17−bracketedPasteStart :: ByteString

18−bracketedPasteStart = BS8.pack "\ESC[200~"

16+import Data.List (isPrefixOf, isInfixOf)

1917

20−bracketedPasteEnd :: ByteString

21−bracketedPasteEnd = BS8.pack "\ESC[201~"

18+bracketedPasteStart :: String

19+bracketedPasteStart = "\ESC[200~"

20+

21+bracketedPasteEnd :: String

22+bracketedPasteEnd = "\ESC[201~"

2223

2324-- | Does the input start a bracketed paste?

24−bracketedPasteStarted :: ByteString -> Bool

25−bracketedPasteStarted = BS8.isPrefixOf bracketedPasteStart

25+bracketedPasteStarted :: String -> Bool

26+bracketedPasteStarted = isPrefixOf bracketedPasteStart

2627

2728-- | Does the input contain a complete bracketed paste?

28−bracketedPasteFinished :: ByteString -> Bool

29−bracketedPasteFinished = BS8.isInfixOf bracketedPasteEnd

29+bracketedPasteFinished :: String -> Bool

30+bracketedPasteFinished = isInfixOf bracketedPasteEnd

3031

3132-- | Parse a bracketed paste. This should only be called on a string if

3233-- both 'bracketedPasteStarted' and 'bracketedPasteFinished' return

3334-- 'True'.

34−parseBracketedPaste :: ByteString -> KClass

35+parseBracketedPaste :: String -> KClass

3536parseBracketedPaste s =

36− Valid (EvPaste p) (BS8.drop endLen rest')

37− where

38− startLen = BS8.length bracketedPasteStart

39− endLen = BS8.length bracketedPasteEnd

40− (_, rest ) = BS8.breakSubstring bracketedPasteStart s

41− (p, rest') = BS8.breakSubstring bracketedPasteEnd . BS8.drop startLen $ rest

37+ let (p, rest) = takeUntil (drop (length bracketedPasteStart) s) bracketedPasteEnd

38+ rest' = if bracketedPasteEnd `isPrefixOf` rest

39+ then drop (length bracketedPasteEnd) rest

40+ else rest

41+ in Valid (EvPaste $ BS8.pack p) rest'

42+

43+takeUntil :: (Eq a) => [a] -> [a] -> ([a],[a])

44+takeUntil [] _ = ([], [])

45+takeUntil cs sub

46+ | length cs < length sub = (cs, [])

47+ | take (length sub) cs == sub = ([], drop (length sub) cs)

48+ | otherwise = let (pre, suf) = takeUntil (tail cs) sub

49+ in (head cs:pre, suf)

src/Graphics/Vty/Input/Terminfo.hs+1−1

@@ -91,7 +91,7 @@ specialSupportKeys =

9191 -- special support for ESC

9292 , ("\ESC",EvKey KEsc []), ("\ESC\ESC",EvKey KEsc [MMeta])

9393 -- Special support for backspace

94− , ("\DEL",EvKey KBS []), ("\ESC\DEL",EvKey KBS [MMeta]), ("\b",EvKey KBS [])

94+ , ("\DEL",EvKey KBS []), ("\ESC\DEL",EvKey KBS [MMeta])

9595 -- Special support for Enter

9696 , ("\ESC\^J",EvKey KEnter [MMeta]), ("\^J",EvKey KEnter [])

9797 -- explicit support for tab

src/Graphics/Vty/Output.hs+4−5

@@ -58,12 +58,11 @@ import Data.Monoid ((<>))

5858-- * If TERM contains "xterm" or "screen", use XTermColor.

5959-- * otherwise use the TerminfoBased driver.

6060outputForConfig :: Config -> IO Output

61−outputForConfig Config{ outputFd = Just fd, termName = Just termName

62− , colorMode = Just colorMode, .. } = do

61+outputForConfig Config{ outputFd = Just fd, termName = Just termName, .. } = do

6362 t <- if "xterm" `isPrefixOf` termName || "screen" `isPrefixOf` termName

64− then XTermColor.reserveTerminal termName fd colorMode

63+ then XTermColor.reserveTerminal termName fd

6564 -- Not an xterm-like terminal. try for generic terminfo.

66− else TerminfoBased.reserveTerminal termName fd colorMode

65+ else TerminfoBased.reserveTerminal termName fd

6766

6867 case mouseMode of

6968 Just s -> setMode t Mouse s

@@ -78,7 +77,7 @@ outputForConfig config = (<> config) <$> standardIOConfig >>= outputForConfig

7877

7978-- | Sets the cursor position to the given output column and row.

8079--

81−-- This is not necessarily the same as the character position with the

80+-- This is not necessarially the same as the character position with the

8281-- same coordinates. Characters can be a variable number of columns in

8382-- width.

8483--

src/Graphics/Vty/Output/Interface.hs+17−23

@@ -3,7 +3,6 @@

33{-# LANGUAGE ExistentialQuantification #-}

44{-# LANGUAGE GADTs #-}

55{-# LANGUAGE FlexibleContexts #-}

6−{-# LANGUAGE ScopedTypeVariables #-}

76-- | This module provides an abstract interface for performing terminal

87-- output. The only user-facing part of this API is 'Output'.

98module Graphics.Vty.Output.Interface

@@ -79,6 +78,9 @@ data Output = Output

7978 , displayBounds :: IO DisplayRegion

8079 -- | Output the bytestring to the terminal device.

8180 , outputByteBuffer :: BS.ByteString -> IO ()

81+ -- | Specifies the maximum number of colors supported by the

82+ -- context.

83+ , contextColorCount :: Int

8284 -- | Specifies whether the cursor can be shown / hidden.

8385 , supportsCursorVisibility :: Bool

8486 -- | Indicates support for terminal modes for this output device.

@@ -114,8 +116,6 @@ data Output = Output

114116 -- be a reliable indicator of whether the feature will work as

115117 -- desired.

116118 , supportsStrikethrough :: IO Bool

117− -- | Returns how many colors the terminal supports.

118− , outputColorMode :: ColorMode

119119 }

120120

121121displayContext :: Output -> DisplayRegion -> IO DisplayContext

@@ -309,23 +309,17 @@ limitAttrForDisplay t attr

309309 where

310310 clampColor Default = Default

311311 clampColor KeepCurrent = KeepCurrent

312− clampColor (SetTo c) = clampColor' (outputColorMode t) c

313−

314− clampColor' NoColor _ = Default

315−

316− clampColor' ColorMode8 (ISOColor v)

317− | v >= 8 = SetTo $ ISOColor (v - 8)

318− | otherwise = SetTo $ ISOColor v

319− clampColor' ColorMode8 _ = Default

320−

321− clampColor' ColorMode16 c@(ISOColor _) = SetTo c

322− clampColor' ColorMode16 _ = Default

323−

324− clampColor' (ColorMode240 _) c@(ISOColor _) = SetTo c

325− clampColor' (ColorMode240 colorCount) c@(Color240 n)

326− | n <= colorCount = SetTo c

327− | otherwise = Default

328− clampColor' colorMode@(ColorMode240 _) (RGBColor r g b) =

329− clampColor' colorMode (color240 r g b)

330−

331− clampColor' FullColor c = SetTo c

312+ clampColor (SetTo c) = clampColor' c

313+ clampColor' (ISOColor v)

314+ | contextColorCount t < 8 = Default

315+ | contextColorCount t < 16 && v >= 8 = SetTo $ ISOColor (v - 8)

316+ | otherwise = SetTo $ ISOColor v

317+ clampColor' (Color240 v)

318+ -- Should we choose closest ISO color?

319+ | contextColorCount t < 8 = Default

320+ | contextColorCount t < 16 = Default

321+ | contextColorCount t <= 256 = SetTo $ Color240 v

322+ | otherwise

323+ = let p :: Double = fromIntegral v / 240.0

324+ v' = floor $ p * (fromIntegral $ contextColorCount t)

325+ in SetTo $ Color240 v'

src/Graphics/Vty/Output/Mock.hs+2−3

@@ -11,7 +11,6 @@ module Graphics.Vty.Output.Mock

1111where

1212

1313import Graphics.Vty.Image (DisplayRegion)

14−import Graphics.Vty.Attributes.Color (ColorMode(ColorMode16))

1514import Graphics.Vty.Output.Interface

1615

1716import Blaze.ByteString.Builder.Word (writeWord8)

@@ -31,7 +30,7 @@ type MockData = IORef (UTF8.UTF8 BS.ByteString)

3130-- without considering terminal specific issues.

3231--

3332-- The mock implementation is useful in manually determining if the

34−-- sequence of terminal operations matches the expected sequence. The

33+-- sequence of terminal operations matche the expected sequence. The

3534-- requirement of the produced representation is simplicity in parsing

3635-- the text representation and determining how the picture was mapped to

3736-- terminal operations.

@@ -56,12 +55,12 @@ mockTerminal r = liftIO $ do

5655 , outputByteBuffer = \bytes -> do

5756 putStrLn $ "mock outputByteBuffer of " ++ show (BS.length bytes) ++ " bytes"

5857 writeIORef outRef $ UTF8.fromRep bytes

58+ , contextColorCount = 16

5959 , supportsCursorVisibility = True

6060 , supportsMode = const False

6161 , setMode = const $ const $ return ()

6262 , getModeStatus = const $ return False

6363 , assumedStateRef = newAssumedStateRef

64− , outputColorMode = ColorMode16

6564 , mkDisplayContext = \tActual rActual -> return $ DisplayContext

6665 { contextRegion = rActual

6766 , contextDevice = tActual

src/Graphics/Vty/Output/TerminfoBased.hs+33−66

@@ -25,7 +25,7 @@ import Graphics.Vty.Image (DisplayRegion)

2525import Graphics.Vty.DisplayAttributes

2626import Graphics.Vty.Output.Interface

2727

28−import Blaze.ByteString.Builder (Write, writeToByteString, writeStorable, writeWord8)

28+import Blaze.ByteString.Builder (Write, writeToByteString, writeStorable)

2929

3030import Data.IORef

3131import Data.Maybe (isJust, isNothing, fromJust)

@@ -49,6 +49,7 @@ data TerminfoCaps = TerminfoCaps

4949 , cup :: CapExpression

5050 , cnorm :: Maybe CapExpression

5151 , civis :: Maybe CapExpression

52+ , supportsNoColors :: Bool

5253 , useAltColorMap :: Bool

5354 , setForeColor :: CapExpression

5455 , setBackColor :: CapExpression

@@ -103,28 +104,28 @@ sendCapToTerminal t cap capParams = do

103104--

104105-- * Providing independent string capabilities for all display

105106-- attributes.

106−reserveTerminal :: String -> Fd -> ColorMode -> IO Output

107−reserveTerminal termName outFd colorMode = do

107+reserveTerminal :: String -> Fd -> IO Output

108+reserveTerminal termName outFd = do

108109 ti <- Terminfo.setupTerm termName

109110 -- assumes set foreground always implies set background exists.

110111 -- if set foreground is not set then all color changing style

111112 -- attributes are filtered.

112113 msetaf <- probeCap ti "setaf"

113114 msetf <- probeCap ti "setf"

114− let (useAlt, setForeCap)

115+ let (noColors, useAlt, setForeCap)

115116 = case msetaf of

116− Just setaf -> (False, setaf)

117+ Just setaf -> (False, False, setaf)

117118 Nothing -> case msetf of

118− Just setf -> (True, setf)

119− Nothing -> (True, error $ "no fore color support for terminal " ++ termName)

119+ Just setf -> (False, True, setf)

120+ Nothing -> (True, True, error $ "no fore color support for terminal " ++ termName)

120121 msetab <- probeCap ti "setab"

121122 msetb <- probeCap ti "setb"

122− let setBackCap

123+ let set_back_cap

123124 = case msetab of

124− Just setab -> setab

125125 Nothing -> case msetb of

126126 Just setb -> setb

127127 Nothing -> error $ "no back color support for terminal " ++ termName

128+ Just setab -> setab

128129

129130 hyperlinkModeStatus <- newIORef False

130131 newAssumedStateRef <- newIORef initialAssumedState

@@ -150,9 +151,10 @@ reserveTerminal termName outFd colorMode = do

150151 <*> requireCap ti "cup"

151152 <*> probeCap ti "cnorm"

152153 <*> probeCap ti "civis"

154+ <*> pure noColors

153155 <*> pure useAlt

154156 <*> pure setForeCap

155− <*> pure setBackCap

157+ <*> pure set_back_cap

156158 <*> requireCap ti "sgr0"

157159 <*> requireCap ti "clear"

158160 <*> requireCap ti "el"

@@ -192,12 +194,17 @@ reserveTerminal termName outFd colorMode = do

192194 when (toEnum len /= actualLen) $ fail $ "Graphics.Vty.Output: outputByteBuffer "

193195 ++ "length mismatch. " ++ show len ++ " /= " ++ show actualLen

194196 ++ " Please report this bug to vty project."

197+ , contextColorCount

198+ = case supportsNoColors terminfoCaps of

199+ False -> case Terminfo.getCapability ti (Terminfo.tiGetNum "colors" ) of

200+ Nothing -> 8

201+ Just v -> toEnum v

202+ True -> 1

195203 , supportsCursorVisibility = isJust $ civis terminfoCaps

196204 , supportsMode = terminfoModeSupported

197205 , setMode = terminfoSetMode

198206 , getModeStatus = terminfoModeStatus

199207 , assumedStateRef = newAssumedStateRef

200− , outputColorMode = colorMode

201208 -- I think fix would help assure tActual is the only

202209 -- reference. I was having issues tho.

203210 , mkDisplayContext = (`terminfoDisplayContext` terminfoCaps)

@@ -295,7 +302,7 @@ writeURLEscapes NoLinkChange =

295302-- | Portably setting the display attributes is a giant pain in the ass.

296303--

297304-- If the terminal supports the sgr capability (which sets the on/off

298−-- state of each style directly; and, for no good reason, resets the

305+-- state of each style directly ; and, for no good reason, resets the

299306-- colors to the default) this procedure is used:

300307--

301308-- 0. set the style attributes. This resets the fore and back color.

@@ -334,9 +341,9 @@ terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =

334341 -- The only way to reset either color, portably, to the default

335342 -- is to use either the set state capability or the set default

336343 -- capability.

337− True -> do

344+ True -> do

338345 case reqDisplayCapSeqFor (displayAttrCaps terminfoCaps)

339− (fixedStyle attr)

346+ (fixedStyle attr )

340347 (styleToApplySeq $ fixedStyle attr) of

341348 -- only way to reset a color to the defaults

342349 EnterExitSeq caps -> writeDefaultAttr dc urlsEnabled

@@ -369,9 +376,9 @@ terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =

369376 -- applied states.

370377 EnterExitSeq caps -> foldMap (\cap -> writeCapExpr cap []) caps

371378 `mappend`

372− writeColorDiff Foreground (foreColorDiff diffs)

379+ writeColorDiff setForeColor (foreColorDiff diffs)

373380 `mappend`

374− writeColorDiff Background (backColorDiff diffs)

381+ writeColorDiff setBackColor (backColorDiff diffs)

375382 -- implicitly resets the colors to the defaults

376383 SetState state -> writeCapExpr (fromJust $ setAttrStates

377384 $ displayAttrCaps terminfoCaps

@@ -403,65 +410,29 @@ terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =

403410 | otherwise = mempty

404411 setColors =

405412 (case fixedForeColor attr of

406− Just c -> writeColor Foreground c

413+ Just c -> writeCapExpr (setForeColor terminfoCaps)

414+ [toEnum $ colorMap c]

407415 Nothing -> mempty)

408416 `mappend`

409417 (case fixedBackColor attr of

410− Just c -> writeColor Background c

418+ Just c -> writeCapExpr (setBackColor terminfoCaps)

419+ [toEnum $ colorMap c]

411420 Nothing -> mempty)

412− writeColorDiff _side NoColorChange

421+ writeColorDiff _f NoColorChange

413422 = mempty

414− writeColorDiff _side ColorToDefault

423+ writeColorDiff _f ColorToDefault

415424 = error "ColorToDefault is not a possible case for applyColorDiffs"

416− writeColorDiff side (SetColor c)

417− = writeColor side c

418−

419− writeColor side (RGBColor r g b) =

420− case outputColorMode (contextDevice dc) of

421− FullColor ->

422− hardcodeColor side (r, g, b)

423− _ ->

424− error "clampColor should remove rgb colors in standard mode"

425− writeColor side c =

426− writeCapExpr (setSideColor side terminfoCaps) [toEnum $ colorMap c]

427−

428−-- a color can either be in the foreground or the background

429−data ColorSide = Foreground | Background

430−

431−-- get the capability for drawing a color on a specific side

432−setSideColor :: ColorSide -> TerminfoCaps -> CapExpression

433−setSideColor Foreground = setForeColor

434−setSideColor Background = setBackColor

435−

436−hardcodeColor :: ColorSide -> (Word8, Word8, Word8) -> Write

437−hardcodeColor side (r, g, b) =

438− -- hardcoded color codes are formatted as "\x1b[{side};2;{r};{g};{b}m"

439− mconcat [ writeStr "\x1b[", sideCode, delimiter, writeChar '2', delimiter

440− , writeColor r, delimiter, writeColor g, delimiter, writeColor b

441− , writeChar 'm']

442− where

443− writeChar = writeWord8 . fromIntegral . fromEnum

444− writeStr = mconcat . map writeChar

445− writeColor = writeStr . show

446− delimiter = writeChar ';'

447− -- 38/48 are used to set whether we should write to the

448− -- foreground/background. I really don't want to know why.

449− sideCode = case side of

450− Foreground -> writeStr "38"

451− Background -> writeStr "48"

425+ writeColorDiff f (SetColor c)

426+ = writeCapExpr (f terminfoCaps) [toEnum $ colorMap c]

452427

453428-- | The color table used by a terminal is a 16 color set followed by a

454429-- 240 color set that might not be supported by the terminal.

455430--

456−-- This takes a Color which clearly identifies which palette to use and

457−-- computes the index into the full 256 color palette.

431+-- This takes a Color which clearly identifies which pallete to use and

432+-- computes the index into the full 256 color pallete.

458433ansiColorIndex :: Color -> Int

459434ansiColorIndex (ISOColor v) = fromEnum v

460435ansiColorIndex (Color240 v) = 16 + fromEnum v

461−ansiColorIndex (RGBColor _ _ _) =

462− error $ unlines [ "Attempted to create color index from rgb color."

463− , "This is currently unsupported, and shouldn't ever happen"

464− ]

465436

466437-- | For terminals without setaf/setab

467438--

@@ -478,10 +449,6 @@ altColorIndex (ISOColor 6) = 3

478449altColorIndex (ISOColor 7) = 7

479450altColorIndex (ISOColor v) = fromEnum v

480451altColorIndex (Color240 v) = 16 + fromEnum v

481−altColorIndex (RGBColor _ _ _) =

482− error $ unlines [ "Attempted to create color index from rgb color."

483− , "This is currently unsupported, and shouldn't ever happen"

484− ]

485452

486453{- | The sequence of terminfo caps to apply a given style are determined

487454 - according to these rules.

src/Graphics/Vty/Output/XTermColor.hs+12−23

@@ -10,23 +10,18 @@ where

1010import Graphics.Vty.Output.Interface

1111import Graphics.Vty.Input.Mouse

1212import Graphics.Vty.Input.Focus

13−import Graphics.Vty.Attributes.Color (ColorMode)

1413import qualified Graphics.Vty.Output.TerminfoBased as TerminfoBased

1514

1615import Blaze.ByteString.Builder (writeToByteString)

1716import Blaze.ByteString.Builder.Word (writeWord8)

1817

19−import qualified Data.ByteString.Char8 as BS8

20−import Data.ByteString.Char8 (ByteString)

21−import Foreign.Ptr (castPtr)

22−

2318import Control.Monad (void, when)

2419import Control.Monad.Trans

2520import Data.Char (toLower)

2621import Data.IORef

2722

28−import System.Posix.IO (fdWriteBuf)

29−import System.Posix.Types (ByteCount, Fd)

23+import System.Posix.IO (fdWrite)

24+import System.Posix.Types (Fd)

3025import System.Posix.Env (getEnv)

3126

3227import Data.List (isInfixOf)

@@ -36,15 +31,9 @@ import Data.Maybe (catMaybes)

3631import Data.Monoid ((<>))

3732#endif

3833

39−-- | Write a 'ByteString' to an 'Fd'.

40−fdWrite :: Fd -> ByteString -> IO ByteCount

41−fdWrite fd s =

42− BS8.useAsCStringLen s $ \(buf,len) -> do

43− fdWriteBuf fd (castPtr buf) (fromIntegral len)

44−

4534-- | Construct an Xterm output driver. Initialize the display to UTF-8.

46−reserveTerminal :: ( Applicative m, MonadIO m ) => String -> Fd -> ColorMode -> m Output

47−reserveTerminal variant outFd colorMode = liftIO $ do

35+reserveTerminal :: ( Applicative m, MonadIO m ) => String -> Fd -> m Output

36+reserveTerminal variant outFd = liftIO $ do

4837 let flushedPut = void . fdWrite outFd

4938 -- If the terminal variant is xterm-color use xterm instead since,

5039 -- more often than not, xterm-color is broken.

@@ -52,7 +41,7 @@ reserveTerminal variant outFd colorMode = liftIO $ do

5241

5342 utf8a <- utf8Active

5443 when (not utf8a) $ flushedPut setUtf8CharSet

55− t <- TerminfoBased.reserveTerminal variant' outFd colorMode

44+ t <- TerminfoBased.reserveTerminal variant' outFd

5645

5746 mouseModeStatus <- newIORef False

5847 focusModeStatus <- newIORef False

@@ -111,19 +100,19 @@ utf8Active = do

111100

112101-- | Enable bracketed paste mode:

113102-- http://cirw.in/blog/bracketed-paste

114−enableBracketedPastes :: ByteString

115−enableBracketedPastes = BS8.pack "\ESC[?2004h"

103+enableBracketedPastes :: String

104+enableBracketedPastes = "\ESC[?2004h"

116105

117106-- | Disable bracketed paste mode:

118−disableBracketedPastes :: ByteString

119−disableBracketedPastes = BS8.pack "\ESC[?2004l"

107+disableBracketedPastes :: String

108+disableBracketedPastes = "\ESC[?2004l"

120109

121110-- | These sequences set xterm based terminals to UTF-8 output.

122111--

123112-- There is no known terminfo capability equivalent to this.

124−setUtf8CharSet, setDefaultCharSet :: ByteString

125−setUtf8CharSet = BS8.pack "\ESC%G"

126−setDefaultCharSet = BS8.pack "\ESC%@"

113+setUtf8CharSet, setDefaultCharSet :: String

114+setUtf8CharSet = "\ESC%G"

115+setDefaultCharSet = "\ESC%@"

127116

128117xtermInlineHack :: Output -> IO ()

129118xtermInlineHack t = do

src/Graphics/Vty/PictureToSpans.hs+1−1

@@ -72,7 +72,7 @@ displayOpsForPic pic r = Vector.create (combinedOpsForLayers pic r)

7272-- | Returns the DisplayOps for an image rendered to a window the size

7373-- of the image.

7474--

75−-- largely used only for debugging.

75+-- largerly used only for debugging.

7676displayOpsForImage :: Image -> DisplayOps

7777displayOpsForImage i = displayOpsForPic (picForImage i) (imageWidth i, imageHeight i)

7878

test/VerifyEmptyImageProps.hs−1

@@ -1,4 +1,3 @@

1−{-# LANGUAGE ScopedTypeVariables #-}

21module VerifyEmptyImageProps where

32

43import Verify

test/VerifyEvalTerminfoCaps.hs−1

@@ -1,6 +1,5 @@

11{-# LANGUAGE BangPatterns #-}

22{-# LANGUAGE NamedFieldPuns #-}

3−{-# LANGUAGE ScopedTypeVariables #-}

43module VerifyEvalTerminfoCaps where

54

65import Blaze.ByteString.Builder.Internal.Write (runWrite, getBound)

test/VerifyImageOps.hs+1−2

@@ -1,4 +1,3 @@

1−{-# LANGUAGE ScopedTypeVariables #-}

21module VerifyImageOps where

32

43import Graphics.Vty.Attributes

@@ -137,7 +136,7 @@ cropBottomLimitsHeight :: Image -> Int -> Property

137136cropBottomLimitsHeight i v = v >= 0 ==>

138137 v >= imageHeight (cropBottom v i)

139138

140−-- ridiculous tests just to satisfy my desire for nice code coverage :-P

139+-- rediculous tests just to satisfy my desire for nice code coverage :-P

141140canShowImage :: Image -> Bool

142141canShowImage i = length (show i) > 0

143142

test/VerifyOutput.hs+2−7

@@ -1,7 +1,6 @@

1−-- We setup the environment to invoke certain terminals of interest.

1+-- We setup the environment to envoke certain terminals of interest.

22-- This assumes appropriate definitions exist in the current environment

33-- for the terminals of interest.

4−{-# LANGUAGE ScopedTypeVariables #-}

54module VerifyOutput where

65

76import Verify

@@ -35,11 +34,7 @@ smokeTestTermNonMac termName i = liftIOResult $ do

3534smokeTestTerm :: String -> Image -> IO Result

3635smokeTestTerm termName i = do

3736 nullOut <- openFd "/dev/null" WriteOnly Nothing defaultFileFlags

38− t <- outputForConfig $ defaultConfig

39− { outputFd = Just nullOut

40− , termName = Just termName

41− , colorMode = Just NoColor

42− }

37+ t <- outputForConfig $ defaultConfig { outputFd = Just nullOut, termName = Just termName }

4338 -- putStrLn $ "context color count: " ++ show (contextColorCount t)

4439 reserveDisplay t

4540 dc <- displayContext t (100,100)

test/VerifyParseTerminfoCaps.hs−1

@@ -1,5 +1,4 @@

11{-# LANGUAGE NamedFieldPuns #-}

2−{-# LANGUAGE ScopedTypeVariables #-}

32module VerifyParseTerminfoCaps where

43

54import Prelude hiding ( catch )

test/VerifyUsingMockInput.hs+1−4

@@ -1,6 +1,5 @@

11{-# LANGUAGE MultiParamTypeClasses #-}

22{-# LANGUAGE FlexibleInstances #-}

3−{-# LANGUAGE ScopedTypeVariables #-}

43-- Generate some input bytes and delays between blocks of input bytes.

54-- Verify the events produced are as expected.

65module Main where

@@ -132,9 +131,7 @@ assertEventsFromSynInput table inputSpec expectedEvents = do

132131 readLoop 0 = return ()

133132 readLoop n = do

134133 e <- atomically $ readTChan $ input^.eventChannel

135− case e of

136− InputEvent ev -> modifyIORef eventsRef ((:) ev)

137− ResumeAfterSignal -> return ()

134+ modifyIORef eventsRef ((:) e)

138135 readLoop (n - 1)

139136 genEventsUsingIoActions maxDuration writeWaitClose readEvents

140137 outEvents <- reverse <$> readIORef eventsRef

test/interactive_terminal_test.hs+1−1

@@ -364,7 +364,7 @@ Did the test output match the description?

364364|]

365365 defaultSuccessConfirmResults

366366

367−-- Explicitly define the bytes that encode each example text.

367+-- Explicitely definethe bytes that encode each example text.

368368-- This avoids any issues with how the compiler represents string literals.

369369--

370370-- This document is UTF-8 encoded so the UTF-8 string is still included for

vty.cabal+21−3

@@ -1,5 +1,5 @@

11name: vty

2−version: 5.35.1

2+version: 5.33

33license: BSD3

44license-file: LICENSE

55author: AUTHORS

@@ -117,6 +117,8 @@ library

117117

118118 hs-source-dirs: src

119119

120+ default-extensions: ScopedTypeVariables

121+

120122 ghc-options: -O2 -funbox-strict-fields -Wall -fspec-constr -fspec-constr-count=10

121123

122124 ghc-prof-options: -O2 -funbox-strict-fields -caf-all -Wall -fspec-constr -fspec-constr-count=10

@@ -141,6 +143,7 @@ executable vty-mode-demo

141143 hs-source-dirs: demos

142144

143145 default-language: Haskell2010

146+ default-extensions: ScopedTypeVariables

144147 ghc-options: -threaded

145148

146149 build-depends: vty,

@@ -155,6 +158,7 @@ executable vty-demo

155158 hs-source-dirs: demos

156159

157160 default-language: Haskell2010

161+ default-extensions: ScopedTypeVariables

158162 ghc-options: -threaded

159163

160164 build-depends: vty,

@@ -166,6 +170,7 @@ executable vty-demo

166170

167171test-suite verify-using-mock-terminal

168172 default-language: Haskell2010

173+ default-extensions: ScopedTypeVariables

169174

170175 type: detailed-0.9

171176

@@ -198,6 +203,7 @@ test-suite verify-using-mock-terminal

198203

199204test-suite verify-terminal

200205 default-language: Haskell2010

206+ default-extensions: ScopedTypeVariables

201207

202208 type: detailed-0.9

203209

@@ -230,6 +236,7 @@ test-suite verify-terminal

230236

231237test-suite verify-display-attributes

232238 default-language: Haskell2010

239+ default-extensions: ScopedTypeVariables

233240

234241 type: detailed-0.9

235242

@@ -261,6 +268,7 @@ test-suite verify-display-attributes

261268

262269test-suite verify-empty-image-props

263270 default-language: Haskell2010

271+ default-extensions: ScopedTypeVariables

264272

265273 type: detailed-0.9

266274

@@ -286,6 +294,7 @@ test-suite verify-empty-image-props

286294

287295test-suite verify-eval-terminfo-caps

288296 default-language: Haskell2010

297+ default-extensions: ScopedTypeVariables

289298

290299 type: detailed-0.9

291300

@@ -314,6 +323,7 @@ test-suite verify-eval-terminfo-caps

314323

315324test-suite verify-image-ops

316325 default-language: Haskell2010

326+ default-extensions: ScopedTypeVariables

317327

318328 type: detailed-0.9

319329

@@ -341,6 +351,7 @@ test-suite verify-image-ops

341351

342352test-suite verify-image-trans

343353 default-language: Haskell2010

354+ default-extensions: ScopedTypeVariables

344355

345356 type: detailed-0.9

346357

@@ -368,6 +379,7 @@ test-suite verify-image-trans

368379

369380test-suite verify-inline

370381 default-language: Haskell2010

382+ default-extensions: ScopedTypeVariables

371383

372384 type: detailed-0.9

373385

@@ -394,6 +406,7 @@ test-suite verify-inline

394406

395407test-suite verify-parse-terminfo-caps

396408 default-language: Haskell2010

409+ default-extensions: ScopedTypeVariables

397410

398411 type: detailed-0.9

399412

@@ -422,6 +435,7 @@ test-suite verify-parse-terminfo-caps

422435

423436test-suite verify-simple-span-generation

424437 default-language: Haskell2010

438+ default-extensions: ScopedTypeVariables

425439

426440 type: detailed-0.9

427441

@@ -453,6 +467,7 @@ test-suite verify-simple-span-generation

453467

454468test-suite verify-crop-span-generation

455469 default-language: Haskell2010

470+ default-extensions: ScopedTypeVariables

456471

457472 type: detailed-0.9

458473

@@ -484,6 +499,7 @@ test-suite verify-crop-span-generation

484499

485500test-suite verify-layers-span-generation

486501 default-language: Haskell2010

502+ default-extensions: ScopedTypeVariables

487503

488504 type: detailed-0.9

489505

@@ -514,6 +530,7 @@ test-suite verify-layers-span-generation

514530

515531test-suite verify-color-mapping

516532 default-language: Haskell2010

533+ default-extensions: ScopedTypeVariables

517534

518535 type: detailed-0.9

519536

@@ -539,6 +556,7 @@ test-suite verify-color-mapping

539556

540557test-suite verify-utf8-width

541558 default-language: Haskell2010

559+ default-extensions: ScopedTypeVariables

542560

543561 type: detailed-0.9

544562

@@ -564,6 +582,7 @@ test-suite verify-utf8-width

564582

565583test-suite verify-using-mock-input

566584 default-language: Haskell2010

585+ default-extensions: ScopedTypeVariables

567586

568587 type: exitcode-stdio-1.0

569588

@@ -571,8 +590,6 @@ test-suite verify-using-mock-input

571590

572591 main-is: VerifyUsingMockInput.hs

573592

574− other-modules: Verify.Graphics.Vty.Output

575−

576593 build-depends: vty,

577594 Cabal >= 1.20,

578595 QuickCheck >= 2.7,

@@ -599,6 +616,7 @@ test-suite verify-using-mock-input

599616

600617test-suite verify-config

601618 default-language: Haskell2010

619+ default-extensions: ScopedTypeVariables

602620

603621 type: exitcode-stdio-1.0

604622