@@ -1,4 +1,3 @@
1−{-# LANGUAGE RecordWildCards #-}
21{-# LANGUAGE FlexibleInstances #-}
32{-# LANGUAGE OverloadedStrings #-}
43{-# LANGUAGE CPP #-}
@@ -10,10 +9,12 @@
109-- Copyright Corey O'Connor (coreyoconnor@gmail.com)
1110module Graphics.Vty.Output.TerminfoBased
1211 ( reserveTerminal
12+ , setWindowSize
1313 )
1414where
1515
1616import Control.Monad (when)
17+import Data.Bits (shiftL, (.&.))
1718import qualified Data.ByteString as BS
1819import Data.ByteString.Internal (toForeignPtr)
1920import Data.Terminfo.Parse
@@ -24,9 +25,8 @@ import Graphics.Vty.Image (DisplayRegion)
2425import Graphics.Vty.DisplayAttributes
2526import Graphics.Vty.Output.Interface
2627
27−import Blaze.ByteString.Builder (Write, writeToByteString, writeStorable)
28+import Blaze.ByteString.Builder (Write, writeToByteString, writeStorable, writeWord8)
2829
29−import Data.Bits ((.&.))
3030import Data.IORef
3131import Data.Maybe (isJust, isNothing, fromJust)
3232import Data.Word
@@ -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
@@ -66,6 +65,8 @@ data DisplayAttrCaps = DisplayAttrCaps
6665 , exitStandout :: Maybe CapExpression
6766 , enterItalic :: Maybe CapExpression
6867 , exitItalic :: Maybe CapExpression
68+ , enterStrikethrough :: Maybe CapExpression
69+ , exitStrikethrough :: Maybe CapExpression
6970 , enterUnderline :: Maybe CapExpression
7071 , exitUnderline :: Maybe CapExpression
7172 , enterReverseVideo :: Maybe CapExpression
@@ -102,28 +103,28 @@ sendCapToTerminal t cap capParams = do
102103--
103104-- * Providing independent string capabilities for all display
104105-- attributes.
105−reserveTerminal :: String -> Fd -> IO Output
106−reserveTerminal termName outFd = do
106+reserveTerminal :: String -> Fd -> ColorMode -> IO Output
107+reserveTerminal termName outFd colorMode = do
107108 ti <- Terminfo.setupTerm termName
108109 -- assumes set foreground always implies set background exists.
109110 -- if set foreground is not set then all color changing style
110111 -- attributes are filtered.
111112 msetaf <- probeCap ti "setaf"
112113 msetf <- probeCap ti "setf"
113− let (noColors, useAlt, setForeCap)
114+ let (useAlt, setForeCap)
114115 = case msetaf of
115− Just setaf -> (False, False, setaf)
116+ Just setaf -> (False, setaf)
116117 Nothing -> case msetf of
117− Just setf -> (False, True, setf)
118− 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)
119120 msetab <- probeCap ti "setab"
120121 msetb <- probeCap ti "setb"
121− let set_back_cap
122+ let setBackCap
122123 = case msetab of
124+ Just setab -> setab
123125 Nothing -> case msetb of
124126 Just setb -> setb
125127 Nothing -> error $ "no back color support for terminal " ++ termName
126− Just setab -> setab
127128
128129 hyperlinkModeStatus <- newIORef False
129130 newAssumedStateRef <- newIORef initialAssumedState
@@ -149,10 +150,9 @@ reserveTerminal termName outFd = do
149150 <*> requireCap ti "cup"
150151 <*> probeCap ti "cnorm"
151152 <*> probeCap ti "civis"
152− <*> pure noColors
153153 <*> pure useAlt
154154 <*> pure setForeCap
155− <*> pure set_back_cap
155+ <*> pure setBackCap
156156 <*> requireCap ti "sgr0"
157157 <*> requireCap ti "clear"
158158 <*> requireCap ti "el"
@@ -164,6 +164,10 @@ reserveTerminal termName outFd = do
164164 sendCap setDefaultAttr []
165165 maybeSendCap cnorm []
166166 , supportsBell = return $ isJust $ ringBellAudio terminfoCaps
167+ , supportsItalics = return $ (isJust $ enterItalic (displayAttrCaps terminfoCaps)) &&
168+ (isJust $ exitItalic (displayAttrCaps terminfoCaps))
169+ , supportsStrikethrough = return $ (isJust $ enterStrikethrough (displayAttrCaps terminfoCaps)) &&
170+ (isJust $ exitStrikethrough (displayAttrCaps terminfoCaps))
167171 , ringTerminalBell = maybeSendCap ringBellAudio []
168172 , reserveDisplay = do
169173 -- If there is no support for smcup: Clear the screen
@@ -174,6 +178,8 @@ reserveTerminal termName outFd = do
174178 , releaseDisplay = do
175179 maybeSendCap rmcup []
176180 maybeSendCap cnorm []
181+ , setDisplayBounds = \(w, h) ->
182+ setWindowSize outFd (w, h)
177183 , displayBounds = do
178184 rawSize <- getWindowSize outFd
179185 case rawSize of
@@ -186,20 +192,15 @@ reserveTerminal termName outFd = do
186192 when (toEnum len /= actualLen) $ fail $ "Graphics.Vty.Output: outputByteBuffer "
187193 ++ "length mismatch. " ++ show len ++ " /= " ++ show actualLen
188194 ++ " Please report this bug to vty project."
189− , contextColorCount
190− = case supportsNoColors terminfoCaps of
191− False -> case Terminfo.getCapability ti (Terminfo.tiGetNum "colors" ) of
192− Nothing -> 8
193− Just v -> toEnum v
194− True -> 1
195195 , supportsCursorVisibility = isJust $ civis terminfoCaps
196196 , supportsMode = terminfoModeSupported
197197 , setMode = terminfoSetMode
198198 , getModeStatus = terminfoModeStatus
199199 , assumedStateRef = newAssumedStateRef
200+ , outputColorMode = colorMode
200201 -- I think fix would help assure tActual is the only
201202 -- reference. I was having issues tho.
202− , mkDisplayContext = \tActual -> terminfoDisplayContext tActual terminfoCaps
203+ , mkDisplayContext = (`terminfoDisplayContext` terminfoCaps)
203204 }
204205 sendCap s = sendCapToTerminal t (s terminfoCaps)
205206 maybeSendCap s = when (isJust $ s terminfoCaps) . sendCap (fromJust . s)
@@ -231,6 +232,8 @@ currentDisplayAttrCaps ti
231232 <*> probeCap ti "rmso"
232233 <*> probeCap ti "sitm"
233234 <*> probeCap ti "ritm"
235+ <*> probeCap ti "smxx"
236+ <*> probeCap ti "rmxx"
234237 <*> probeCap ti "smul"
235238 <*> probeCap ti "rmul"
236239 <*> probeCap ti "rev"
@@ -244,6 +247,13 @@ getWindowSize fd = do
244247 (a,b) <- (`divMod` 65536) `fmap` c_getWindowSize fd
245248 return (fromIntegral b, fromIntegral a)
246249
250+foreign import ccall "gwinsz.h vty_c_set_window_size" c_setWindowSize :: Fd -> CLong -> IO ()
251+
252+setWindowSize :: Fd -> (Int, Int) -> IO ()
253+setWindowSize fd (w, h) = do
254+ let val = (h `shiftL` 16) + w
255+ c_setWindowSize fd $ fromIntegral val
256+
247257terminfoDisplayContext :: Output -> TerminfoCaps -> DisplayRegion -> IO DisplayContext
248258terminfoDisplayContext tActual terminfoCaps r = return dc
249259 where dc = DisplayContext
@@ -259,7 +269,11 @@ terminfoDisplayContext tActual terminfoCaps r = return dc
259269 , writeSetAttr = terminfoWriteSetAttr dc terminfoCaps
260270 , writeDefaultAttr = \urlsEnabled ->
261271 writeCapExpr (setDefaultAttr terminfoCaps) [] `mappend`
262− (if urlsEnabled then writeURLEscapes EndLink else mempty)
272+ (if urlsEnabled then writeURLEscapes EndLink else mempty) `mappend`
273+ (case exitStrikethrough $ displayAttrCaps terminfoCaps of
274+ Just cap -> writeCapExpr cap []
275+ Nothing -> mempty
276+ )
263277 , writeRowEnd = writeCapExpr (clearEol terminfoCaps) []
264278 , inlineHack = return ()
265279 }
@@ -281,7 +295,7 @@ writeURLEscapes NoLinkChange =
281295-- | Portably setting the display attributes is a giant pain in the ass.
282296--
283297-- If the terminal supports the sgr capability (which sets the on/off
284−-- 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
285299-- colors to the default) this procedure is used:
286300--
287301-- 0. set the style attributes. This resets the fore and back color.
@@ -320,9 +334,9 @@ terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =
320334 -- The only way to reset either color, portably, to the default
321335 -- is to use either the set state capability or the set default
322336 -- capability.
323− True -> do
337+ True -> do
324338 case reqDisplayCapSeqFor (displayAttrCaps terminfoCaps)
325− (fixedStyle attr )
339+ (fixedStyle attr)
326340 (styleToApplySeq $ fixedStyle attr) of
327341 -- only way to reset a color to the defaults
328342 EnterExitSeq caps -> writeDefaultAttr dc urlsEnabled
@@ -332,11 +346,11 @@ terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =
332346 setColors
333347 -- implicitly resets the colors to the defaults
334348 SetState state -> writeCapExpr (fromJust $ setAttrStates
335− $ displayAttrCaps
336− $ terminfoCaps
349+ $ displayAttrCaps terminfoCaps
337350 )
338351 (sgrArgsForState state)
339352 `mappend` setItalics
353+ `mappend` setStrikethrough
340354 `mappend` setColors
341355 -- Otherwise the display colors are not changing or changing
342356 -- between two non-default points.
@@ -355,15 +369,16 @@ terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =
355369 -- applied states.
356370 EnterExitSeq caps -> foldMap (\cap -> writeCapExpr cap []) caps
357371 `mappend`
358− writeColorDiff setForeColor (foreColorDiff diffs)
372+ writeColorDiff Foreground (foreColorDiff diffs)
359373 `mappend`
360− writeColorDiff setBackColor (backColorDiff diffs)
374+ writeColorDiff Background (backColorDiff diffs)
361375 -- implicitly resets the colors to the defaults
362376 SetState state -> writeCapExpr (fromJust $ setAttrStates
363377 $ displayAttrCaps terminfoCaps
364378 )
365379 (sgrArgsForState state)
366380 `mappend` setItalics
381+ `mappend` setStrikethrough
367382 `mappend` setColors
368383 where
369384 urlAttrs True = writeURLEscapes (urlDiff diffs)
@@ -381,31 +396,72 @@ terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =
381396 , Just sitm <- enterItalic (displayAttrCaps terminfoCaps)
382397 = writeCapExpr sitm []
383398 | otherwise = mempty
399+ setStrikethrough
400+ | hasStyle (fixedStyle attr) strikethrough
401+ , Just smxx <- enterStrikethrough (displayAttrCaps terminfoCaps)
402+ = writeCapExpr smxx []
403+ | otherwise = mempty
384404 setColors =
385405 (case fixedForeColor attr of
386− Just c -> writeCapExpr (setForeColor terminfoCaps)
387− [toEnum $ colorMap c]
406+ Just c -> writeColor Foreground c
388407 Nothing -> mempty)
389408 `mappend`
390409 (case fixedBackColor attr of
391− Just c -> writeCapExpr (setBackColor terminfoCaps)
392− [toEnum $ colorMap c]
410+ Just c -> writeColor Background c
393411 Nothing -> mempty)
394− writeColorDiff _f NoColorChange
412+ writeColorDiff _side NoColorChange
395413 = mempty
396− writeColorDiff _f ColorToDefault
414+ writeColorDiff _side ColorToDefault
397415 = error "ColorToDefault is not a possible case for applyColorDiffs"
398− writeColorDiff f (SetColor c)
399− = 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"
400452
401453-- | The color table used by a terminal is a 16 color set followed by a
402454-- 240 color set that might not be supported by the terminal.
403455--
404−-- This takes a Color which clearly identifies which pallete to use and
405−-- 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.
406458ansiColorIndex :: Color -> Int
407459ansiColorIndex (ISOColor v) = fromEnum v
408460ansiColorIndex (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+ ]
409465
410466-- | For terminals without setaf/setab
411467--
@@ -422,6 +478,10 @@ altColorIndex (ISOColor 6) = 3
422478altColorIndex (ISOColor 7) = 7
423479altColorIndex (ISOColor v) = fromEnum v
424480altColorIndex (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+ ]
425485
426486{- | The sequence of terminfo caps to apply a given style are determined
427487 - according to these rules.
@@ -449,6 +509,7 @@ data DisplayAttrState = DisplayAttrState
449509 { applyStandout :: Bool
450510 , applyUnderline :: Bool
451511 , applyItalic :: Bool
512+ , applyStrikethrough :: Bool
452513 , applyReverseVideo :: Bool
453514 , applyBlink :: Bool
454515 , applyDim :: Bool
@@ -485,6 +546,8 @@ reqDisplayCapSeqFor caps s diffs
485546 -- set state cap then just use the set state cap.
486547 ( True, True ) -> SetState $ stateForStyle s
487548 where
549+ noEnterExitCap ApplyStrikethrough = isNothing $ enterStrikethrough caps
550+ noEnterExitCap RemoveStrikethrough = isNothing $ exitStrikethrough caps
488551 noEnterExitCap ApplyItalic = isNothing $ enterItalic caps
489552 noEnterExitCap RemoveItalic = isNothing $ exitItalic caps
490553 noEnterExitCap ApplyStandout = isNothing $ enterStandout caps
@@ -499,6 +562,8 @@ reqDisplayCapSeqFor caps s diffs
499562 noEnterExitCap RemoveDim = True
500563 noEnterExitCap ApplyBold = isNothing $ enterBoldMode caps
501564 noEnterExitCap RemoveBold = True
565+ enterExitCap ApplyStrikethrough = fromJust $ enterStrikethrough caps
566+ enterExitCap RemoveStrikethrough = fromJust $ exitStrikethrough caps
502567 enterExitCap ApplyItalic = fromJust $ enterItalic caps
503568 enterExitCap RemoveItalic = fromJust $ exitItalic caps
504569 enterExitCap ApplyStandout = fromJust $ enterStandout caps
@@ -515,6 +580,7 @@ stateForStyle s = DisplayAttrState
515580 { applyStandout = isStyleSet standout
516581 , applyUnderline = isStyleSet underline
517582 , applyItalic = isStyleSet italic
583+ , applyStrikethrough = isStyleSet strikethrough
518584 , applyReverseVideo = isStyleSet reverseVideo
519585 , applyBlink = isStyleSet blink
520586 , applyDim = isStyleSet dim
@@ -527,6 +593,7 @@ styleToApplySeq s = concat
527593 [ applyIfRequired ApplyStandout standout
528594 , applyIfRequired ApplyUnderline underline
529595 , applyIfRequired ApplyItalic italic
596+ , applyIfRequired ApplyStrikethrough strikethrough
530597 , applyIfRequired ApplyReverseVideo reverseVideo
531598 , applyIfRequired ApplyBlink blink
532599 , applyIfRequired ApplyDim dim