4969735...master · vty

CHANGELOG.md+38

@@ -1,4 +1,42 @@

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+

2405.34

341----

442

demos/Demo.hs+12−4

@@ -31,7 +31,8 @@ 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 pallete."

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

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

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

3637 , "claims 240 colors are not supported."

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

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

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

4344 ]

4445

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+

4555colorbox_240 :: Image

4656colorbox_240 = vertCat $ map horizCat $ splitColorImages colorImages

4757 where

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

49− splitColorImages [] = []

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

5159

5260colorbox_16 :: Image

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

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

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

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

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

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

7482 vty <- ask

7583 liftIO $ update vty pic

7684

src/Graphics/Vty.hs+11−8

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

4848

4949import Graphics.Vty.Config

5050import Graphics.Vty.Input

51+import Graphics.Vty.Input.Events

5152import Graphics.Vty.Output

5253import Graphics.Vty.Output.Interface

5354import Graphics.Vty.Picture

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

209210 maybe (return ()) innerUpdate mPic

210211

211212 let mkResize = uncurry EvResize <$> displayBounds out

213+

214+ translateInternalEvent ResumeAfterSignal = mkResize

215+ translateInternalEvent (InputEvent e) = return e

216+

212217 gkey = do

213− k <- atomically $ readTChan $ _eventChannel input

214− case k of

215− (EvResize _ _) -> mkResize

216− _ -> return k

218+ e <- atomically $ readTChan $ _eventChannel input

219+ translateInternalEvent e

217220 gkey' = do

218− k <- atomically $ tryReadTChan $ _eventChannel input

219− case k of

220− (Just (EvResize _ _)) -> Just <$> mkResize

221− _ -> return k

221+ mEv <- atomically $ tryReadTChan $ _eventChannel input

222+ case mEv of

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

224+ Nothing -> return Nothing

222225

223226 return $ Vty { update = innerUpdate

224227 , nextEvent = gkey

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

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

11{-# LANGUAGE DeriveGeneric #-}

22{-# LANGUAGE DeriveAnyClass #-}

3+{-# LANGUAGE MultiWayIf #-}

4+{-# LANGUAGE ScopedTypeVariables #-}

35

46module Graphics.Vty.Attributes.Color

57 ( Color(..)

8+ , ColorMode(..)

9+

10+ -- * Detecting Terminal Color Support

11+ , detectColorMode

612

713 -- ** Fixed Colors

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

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

3238 , brightCyan

3339 , brightWhite

3440 -- ** Creating Colors From RGB

41+ , linearColor

42+ , srgbColor

3543 , rgbColor

44+ , color240

3645 , module Graphics.Vty.Attributes.Color240

3746 )

3847where

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

4049import Data.Word

4150import GHC.Generics

4251import 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

4357

4458import Graphics.Vty.Attributes.Color240

4559

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

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

8296--

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

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

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

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

86100-- addressable via the 240 color palette.

87101--

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

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

96110--

97111-- Seriously, terminal color support is INSANE.

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

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

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

100114

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+

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

102140black = ISOColor 0

103141red = ISOColor 1

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

119157brightCyan = ISOColor 14

120158brightWhite = ISOColor 15

121159

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)

122186

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

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

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

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

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

191+rgbColor = color240

src/Graphics/Vty/Config.hs+10−1

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

33{-# LANGUAGE FlexibleContexts, FlexibleInstances #-}

44{-# LANGUAGE TypeOperators #-}

55{-# LANGUAGE ScopedTypeVariables #-}

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

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

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

89-- application's use of Vty.

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

122123import Data.Typeable (Typeable)

123124

124125import Graphics.Vty.Input.Events

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

125127

126128import GHC.Generics

127129

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

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

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

195197 -- will be used.

198+ , colorMode :: Maybe ColorMode

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

200+ -- supports.

196201 }

197202 deriving (Show, Eq)

198203

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

214219 , termWidthMaps = termWidthMaps c1 <|> termWidthMaps c0

215220 , allowCustomUnicodeWidthTables =

216221 allowCustomUnicodeWidthTables c1 <|> allowCustomUnicodeWidthTables c0

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

217223 }

218224

219225instance Monoid Config where

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

229235 , termName = Nothing

230236 , termWidthMaps = []

231237 , allowCustomUnicodeWidthTables = Nothing

238+ , colorMode = Nothing

232239 }

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

234241 mappend = (<>)

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

284291 mb <- lookupEnv termVariable

285292 case mb of

286293 Nothing -> throwIO VtyMissingTermEnvVar

287− Just t ->

294+ Just t -> do

295+ mcolorMode <- detectColorMode t

288296 return defaultConfig

289297 { vmin = Just 1

290298 , mouseMode = Just False

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

293301 , inputFd = Just stdInput

294302 , outputFd = Just stdOutput

295303 , termName = Just t

304+ , colorMode = Just mcolorMode

296305 }

297306

298307parseConfigFile :: 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 layed out on a single

140+-- | Make an image from a string of characters laid 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 missmatch

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

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 missmatch

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

263263-- will be filled with the background pattern.

264264vertJoin :: Image -> Image -> Image

265265vertJoin EmptyImage i = i

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

@@ -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 unambiguiously. UTF-8 input is

80+-- * 7-bit mode: UTF-8 can be input unambiguously. 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 fundemental issues. There is no easy way

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

9999-- to reliably resolve these issues.

100100--

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

@@ -158,9 +158,8 @@ 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"

162161 setAttrs

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

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

164163 _ <- installHandler windowChange pokeIO Nothing

165164 _ <- installHandler continueProcess pokeIO Nothing

166165

src/Graphics/Vty/Input/Events.hs+13−8

@@ -51,14 +51,9 @@ data Event

5151 -- row. Some terminals report only that a button was released

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

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

54− | EvResize ~Int ~Int

55− -- ^ If read from 'eventChannel' this is the size at the time of the

56− -- signal. If read from 'nextEvent' this is the size at the time the

57− -- event was processed by Vty. Typically these are the same, but if

58− -- somebody is resizing the terminal quickly they can be different.

59− --

60− -- Note: this is a lazy constructor to support bottom/error values

61− -- passing through the input events channel.

54+ | EvResize Int Int

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

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

6257 | EvPaste ByteString

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

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

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

7671instance NFData Event

7772

7873type 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/Loop.hs+2−2

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

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

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

5757 -- is an 'EvResize'.

58− _eventChannel :: TChan Event

58+ _eventChannel :: TChan InternalEvent

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

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

6161 , shutdownInput :: IO ()

@@ -115,7 +115,7 @@ addBytesToProcess block = unprocessedBytes <>= block

115115emit :: Event -> InputM ()

116116emit event = do

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

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

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

119119

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

121121-- device.

src/Graphics/Vty/Input/Mouse.hs+2−2

@@ -89,7 +89,7 @@ scrollDown = 65

8989hasBitSet :: Int -> Int -> Bool

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

9191

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

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

9393classifyMouseEvent :: ByteString -> KClass

9494classifyMouseEvent s = runParser s $ do

9595 when (not $ isMouseEvent s) failParse

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

102102 'M' -> classifyNormalMouseEvent

103103 _ -> failParse

104104

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

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

106106getSGRButton :: Int -> Parser Button

107107getSGRButton mods =

108108 let buttonMap = [ (leftButton, BLeft)

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

@@ -58,11 +58,12 @@ 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, .. } = do

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

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

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

63− then XTermColor.reserveTerminal termName fd

64+ then XTermColor.reserveTerminal termName fd colorMode

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

65− else TerminfoBased.reserveTerminal termName fd

66+ else TerminfoBased.reserveTerminal termName fd colorMode

6667

6768 case mouseMode of

6869 Just s -> setMode t Mouse s

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

7778

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

7980--

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

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

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

8283-- width.

8384--

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

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

7979 , displayBounds :: IO DisplayRegion

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

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

82− -- | Specifies the maximum number of colors supported by the

83− -- context.

84− , contextColorCount :: Int

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

8683 , supportsCursorVisibility :: Bool

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

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

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

118115 -- desired.

119116 , supportsStrikethrough :: IO Bool

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

118+ , outputColorMode :: ColorMode

120119 }

121120

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

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

310309 where

311310 clampColor Default = Default

312311 clampColor KeepCurrent = KeepCurrent

313− clampColor (SetTo c) = clampColor' c

314− clampColor' (ISOColor v)

315− | contextColorCount t < 8 = Default

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

317− | otherwise = SetTo $ ISOColor v

318− clampColor' (Color240 v)

319− -- Should we choose closest ISO color?

320− | contextColorCount t < 8 = Default

321− | contextColorCount t < 16 = Default

322− | contextColorCount t <= 256 = SetTo $ Color240 v

323− | otherwise

324− = let p :: Double = fromIntegral v / 240.0

325− v' = floor $ p * (fromIntegral $ contextColorCount t)

326− in SetTo $ Color240 v'

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

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

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

1111where

1212

1313import Graphics.Vty.Image (DisplayRegion)

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

1415import Graphics.Vty.Output.Interface

1516

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

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

3031-- without considering terminal specific issues.

3132--

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

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

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

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

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

3637-- terminal operations.

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

5556 , outputByteBuffer = \bytes -> do

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

5758 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

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

6566 { contextRegion = rActual

6667 , contextDevice = tActual

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

@@ -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)

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

2929

3030import Data.IORef

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

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

4949 , cup :: CapExpression

5050 , cnorm :: Maybe CapExpression

5151 , civis :: Maybe CapExpression

52− , supportsNoColors :: Bool

5352 , useAltColorMap :: Bool

5453 , setForeColor :: CapExpression

5554 , setBackColor :: CapExpression

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

104103--

105104-- * Providing independent string capabilities for all display

106105-- attributes.

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

108−reserveTerminal termName outFd = do

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

107+reserveTerminal termName outFd colorMode = do

109108 ti <- Terminfo.setupTerm termName

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

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

112111 -- attributes are filtered.

113112 msetaf <- probeCap ti "setaf"

114113 msetf <- probeCap ti "setf"

115− let (noColors, useAlt, setForeCap)

114+ let (useAlt, setForeCap)

116115 = case msetaf of

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

116+ Just setaf -> (False, setaf)

118117 Nothing -> case msetf of

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

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

118+ Just setf -> (True, setf)

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

121120 msetab <- probeCap ti "setab"

122121 msetb <- probeCap ti "setb"

123− let set_back_cap

122+ let setBackCap

124123 = 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

129128

130129 hyperlinkModeStatus <- newIORef False

131130 newAssumedStateRef <- newIORef initialAssumedState

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

151150 <*> requireCap ti "cup"

152151 <*> probeCap ti "cnorm"

153152 <*> probeCap ti "civis"

154− <*> pure noColors

155153 <*> pure useAlt

156154 <*> pure setForeCap

157− <*> pure set_back_cap

155+ <*> pure setBackCap

158156 <*> requireCap ti "sgr0"

159157 <*> requireCap ti "clear"

160158 <*> requireCap ti "el"

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

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

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

196194 ++ " 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

203195 , supportsCursorVisibility = isJust $ civis terminfoCaps

204196 , supportsMode = terminfoModeSupported

205197 , setMode = terminfoSetMode

206198 , getModeStatus = terminfoModeStatus

207199 , assumedStateRef = newAssumedStateRef

200+ , outputColorMode = colorMode

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

209202 -- reference. I was having issues tho.

210203 , mkDisplayContext = (`terminfoDisplayContext` terminfoCaps)

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

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

303296--

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

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

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

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

307300--

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

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

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

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

343336 -- capability.

344− True -> do

337+ True -> do

345338 case reqDisplayCapSeqFor (displayAttrCaps terminfoCaps)

346− (fixedStyle attr )

339+ (fixedStyle attr)

347340 (styleToApplySeq $ fixedStyle attr) of

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

349342 EnterExitSeq caps -> writeDefaultAttr dc urlsEnabled

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

376369 -- applied states.

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

378371 `mappend`

379− writeColorDiff setForeColor (foreColorDiff diffs)

372+ writeColorDiff Foreground (foreColorDiff diffs)

380373 `mappend`

381− writeColorDiff setBackColor (backColorDiff diffs)

374+ writeColorDiff Background (backColorDiff diffs)

382375 -- implicitly resets the colors to the defaults

383376 SetState state -> writeCapExpr (fromJust $ setAttrStates

384377 $ displayAttrCaps terminfoCaps

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

410403 | otherwise = mempty

411404 setColors =

412405 (case fixedForeColor attr of

413− Just c -> writeCapExpr (setForeColor terminfoCaps)

414− [toEnum $ colorMap c]

406+ Just c -> writeColor Foreground c

415407 Nothing -> mempty)

416408 `mappend`

417409 (case fixedBackColor attr of

418− Just c -> writeCapExpr (setBackColor terminfoCaps)

419− [toEnum $ colorMap c]

410+ Just c -> writeColor Background c

420411 Nothing -> mempty)

421− writeColorDiff _f NoColorChange

412+ writeColorDiff _side NoColorChange

422413 = mempty

423− writeColorDiff _f ColorToDefault

414+ writeColorDiff _side ColorToDefault

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

425− writeColorDiff f (SetColor c)

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

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"

427452

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

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

430455--

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

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

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

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

433458ansiColorIndex :: Color -> Int

434459ansiColorIndex (ISOColor v) = fromEnum v

435460ansiColorIndex (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+ ]

436465

437466-- | For terminals without setaf/setab

438467--

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

449478altColorIndex (ISOColor 7) = 7

450479altColorIndex (ISOColor v) = fromEnum v

451480altColorIndex (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+ ]

452485

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

454487 - according to these rules.

src/Graphics/Vty/Output/XTermColor.hs+4−3

@@ -10,6 +10,7 @@ where

1010import Graphics.Vty.Output.Interface

1111import Graphics.Vty.Input.Mouse

1212import Graphics.Vty.Input.Focus

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

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

1415

1516import Blaze.ByteString.Builder (writeToByteString)

@@ -42,8 +43,8 @@ fdWrite fd s =

4243 fdWriteBuf fd (castPtr buf) (fromIntegral len)

4344

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

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

46−reserveTerminal variant outFd = liftIO $ do

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

47+reserveTerminal variant outFd colorMode = liftIO $ do

4748 let flushedPut = void . fdWrite outFd

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

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

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

5152

5253 utf8a <- utf8Active

5354 when (not utf8a) $ flushedPut setUtf8CharSet

54− t <- TerminfoBased.reserveTerminal variant' outFd

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

5556

5657 mouseModeStatus <- newIORef False

5758 focusModeStatus <- newIORef False

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−-- largerly used only for debugging.

75+-- largely used only for debugging.

7676displayOpsForImage :: Image -> DisplayOps

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

7878

test/VerifyImageOps.hs+1−1

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

137137cropBottomLimitsHeight i v = v >= 0 ==>

138138 v >= imageHeight (cropBottom v i)

139139

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

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

141141canShowImage :: Image -> Bool

142142canShowImage i = length (show i) > 0

143143

test/VerifyOutput.hs+6−2

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

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

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

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

33-- for the terminals of interest.

44{-# LANGUAGE ScopedTypeVariables #-}

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

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

3636smokeTestTerm termName i = do

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

38− t <- outputForConfig $ defaultConfig { outputFd = Just nullOut, termName = Just termName }

38+ t <- outputForConfig $ defaultConfig

39+ { outputFd = Just nullOut

40+ , termName = Just termName

41+ , colorMode = Just NoColor

42+ }

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

4044 reserveDisplay t

4145 dc <- displayContext t (100,100)

test/VerifyUsingMockInput.hs+3−1

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

132132 readLoop 0 = return ()

133133 readLoop n = do

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

135− modifyIORef eventsRef ((:) e)

135+ case e of

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

137+ ResumeAfterSignal -> return ()

136138 readLoop (n - 1)

137139 genEventsUsingIoActions maxDuration writeWaitClose readEvents

138140 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−-- Explicitely definethe bytes that encode each example text.

367+-- Explicitly define the 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+1−1

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

11name: vty

2−version: 5.34

2+version: 5.35.1

33license: BSD3

44license-file: LICENSE

55author: AUTHORS