-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | A simple terminal UI library -- -- vty is terminal GUI library in the niche of ncurses. It is intended to -- be easy to use and to provide good support for common terminal types. -- -- See the vty-examples package as well as the program -- examples/interactive_terminal_test.hs included in the -- vty repository for examples on how to use the library. -- -- Import the Graphics.Vty convenience module to get access to -- the core parts of the library. -- -- © 2006-2007 Stefan O'Rear; BSD3 license. -- -- © Corey O'Connor; BSD3 license. -- -- © Jonathan Daugherty; BSD3 license. @package vty @version 5.39 -- | This module provides functions to measure the terminal column width of -- characters and strings. -- -- The functions provided in this module all ultimately make calls to the -- C implementation in cbits/mk_wcwidth.c. That code manages -- some global state that carries a table of Unicode character widths. -- For more details, see Install, the C code, and the -- "Multi-Column Character Support" section of the project -- README. module Graphics.Text.Width wcwidth :: Char -> Int wcswidth :: String -> Int wctwidth :: Text -> Int wctlwidth :: Text -> Int -- | Returns the display width of a character. Assumes all characters with -- unknown widths are 0 width. safeWcwidth :: Char -> Int -- | Returns the display width of a string. Assumes all characters with -- unknown widths are 0 width. safeWcswidth :: String -> Int -- | Returns the display width of a text. Assumes all characters with -- unknown widths are 0 width. safeWctwidth :: Text -> Int -- | Returns the display width of a lazy text. Assumes all characters with -- unknown widths are 0 width. safeWctlwidth :: Text -> Int module Graphics.Vty.Attributes.Color240 -- | Create a value in the Color240 set from an RGB triple. This maps the -- input arguments to an entry in the 240-color palette depicted at: -- -- https://rich.readthedocs.io/en/stable/appendix/colors.html rgbColorToColor240 :: Integral i => i -> i -> i -> Word8 -- | Create a RGB triple from a value in the Color240 set. color240CodeToRGB :: Word8 -> Maybe (Int, Int, Int) module Graphics.Vty.Attributes.Color -- | Abstract data type representing a color. -- -- Currently the foreground and background color are specified as points -- in either a: -- -- -- -- The 8 ISO 6429 (ANSI) colors are as follows: -- --
    --
  1. black
    2. --
  2. red
    3. --
  3. green
    4. --
  4. yellow
    5. --
  5. blue
    6. --
  6. magenta
    7. --
  7. cyan
    8. --
  8. white
    9. --
-- -- The mapping from points in the 240 color palette to colors actually -- displayable by the terminal depends on the number of colors the -- terminal claims to support. Which is usually determined by the -- terminfo "colors" property. If this property is not being accurately -- reported then the color reproduction will be incorrect. -- -- If the terminal reports <= 16 colors then the 240 color palette -- points are only mapped to the 8 color palette. I'm not sure of the RGB -- points for the "bright" colors which is why they are not addressable -- via the 240 color palette. -- -- If the terminal reports > 16 colors then the 240 color palette -- points are mapped to the nearest points in a ("color count" - 16) -- subsampling of the 240 color palette. -- -- All of this assumes the terminals are behaving similarly to xterm and -- rxvt when handling colors. And that the individual colors have not -- been remapped by the user. There may be a way to verify this through -- terminfo but I don't know it. -- -- Seriously, terminal color support is INSANE. data Color ISOColor :: !Word8 -> Color Color240 :: !Word8 -> Color RGBColor :: !Word8 -> !Word8 -> !Word8 -> Color data ColorMode NoColor :: ColorMode ColorMode8 :: ColorMode ColorMode16 :: ColorMode ColorMode240 :: !Word8 -> ColorMode FullColor :: ColorMode detectColorMode :: String -> IO ColorMode black :: Color red :: Color green :: Color yellow :: Color blue :: Color magenta :: Color cyan :: Color white :: Color brightBlack :: Color brightRed :: Color brightGreen :: Color brightYellow :: Color brightBlue :: Color brightMagenta :: Color brightCyan :: Color brightWhite :: Color -- | Create a color value from RGB values in the 0..255 range inclusive. No -- transformation of the input values is done; a color is created -- directly from the RGB values specified, unlike the srgbColor -- and color240 functions. linearColor :: Integral i => i -> i -> i -> Color -- | Given RGB values in the range 0..255 inclusive, create a color using -- the sRGB transformation described at -- -- https://en.wikipedia.org/wiki/SRGB#The_reverse_transformation srgbColor :: Integral i => i -> i -> i -> Color -- | Create a Vty Color (in the 240 color set) from an RGB triple. -- This is a synonym for color240. This function is lossy in the -- sense that we only internally support 240 colors but the #RRGGBB -- format supports 16^3 colors. rgbColor :: Integral i => i -> i -> i -> Color color240 :: Integral i => i -> i -> i -> Color instance Control.DeepSeq.NFData Graphics.Vty.Attributes.Color.Color instance GHC.Generics.Generic Graphics.Vty.Attributes.Color.Color instance GHC.Read.Read Graphics.Vty.Attributes.Color.Color instance GHC.Show.Show Graphics.Vty.Attributes.Color.Color instance GHC.Classes.Eq Graphics.Vty.Attributes.Color.Color instance GHC.Show.Show Graphics.Vty.Attributes.Color.ColorMode instance GHC.Classes.Eq Graphics.Vty.Attributes.Color.ColorMode -- | Display attributes -- -- Attributes have three components: a foreground color, a background -- color, and a style mask. The simplest attribute is the default -- attribute, or defAttr. Attributes can be modified with -- withForeColor, withBackColor, and withStyle, -- e.g., -- -- 
--   defAttr `withForeColor` red
--
-- -- Image constructors often require an Attr to indicate -- the attributes used in the image, e.g., -- -- 
--   string (defAttr `withForeColor` red) "this text will be red"
--
-- -- The appearance of Images using defAttr is determined -- by the The terminal, so this is not something VTY can control. The -- user is free to The define the color scheme of the terminal as they -- see fit. -- -- The value currentAttr will keep the attributes of whatever was -- output previously. module Graphics.Vty.Attributes -- | A display attribute defines the Color and Style of all the characters -- rendered after the attribute is applied. -- -- At most 256 colors, picked from a 240 and 16 color palette, are -- possible for the background and foreground. The 240 colors and 16 -- colors are points in different palettes. See Color for more -- information. data Attr Attr :: !MaybeDefault Style -> !MaybeDefault Color -> !MaybeDefault Color -> !MaybeDefault Text -> Attr [attrStyle] :: Attr -> !MaybeDefault Style [attrForeColor] :: Attr -> !MaybeDefault Color [attrBackColor] :: Attr -> !MaybeDefault Color [attrURL] :: Attr -> !MaybeDefault Text -- | Specifies the display attributes such that the final style and color -- values do not depend on the previously applied display attribute. The -- display attributes can still depend on the terminal's default colors -- (unfortunately). data FixedAttr FixedAttr :: !Style -> !Maybe Color -> !Maybe Color -> !Maybe Text -> FixedAttr [fixedStyle] :: FixedAttr -> !Style [fixedForeColor] :: FixedAttr -> !Maybe Color [fixedBackColor] :: FixedAttr -> !Maybe Color [fixedURL] :: FixedAttr -> !Maybe Text -- | The style and color attributes can either be the terminal defaults. Or -- be equivalent to the previously applied style. Or be a specific value. data MaybeDefault v Default :: MaybeDefault v KeepCurrent :: MaybeDefault v SetTo :: !v -> MaybeDefault v -- | Sets the style, background color and foreground color to the default -- values for the terminal. There is no easy way to determine what the -- default background and foreground colors are. defAttr :: Attr -- | Keeps the style, background color and foreground color that was -- previously set. Used to override some part of the previous style. -- -- EG: current_style withForeColor brightMagenta -- -- Would be the currently applied style (be it underline, bold, etc) but -- with the foreground color set to brightMagenta. currentAttr :: Attr -- | Styles are represented as an 8 bit word. Each bit in the word is 1 if -- the style attribute assigned to that bit should be applied and 0 if -- the style attribute should not be applied. type Style = Word8 -- | Add the given style attribute withStyle :: Attr -> Style -> Attr -- | Valid style attributes include: -- -- -- -- (The invisible, protect, and altcharset display attributes some -- terminals support are not supported via VTY.) standout :: Style -- | Valid style attributes include: -- -- -- -- (The invisible, protect, and altcharset display attributes some -- terminals support are not supported via VTY.) italic :: Style -- | Valid style attributes include: -- -- -- -- (The invisible, protect, and altcharset display attributes some -- terminals support are not supported via VTY.) strikethrough :: Style -- | Valid style attributes include: -- -- -- -- (The invisible, protect, and altcharset display attributes some -- terminals support are not supported via VTY.) underline :: Style -- | Valid style attributes include: -- -- -- -- (The invisible, protect, and altcharset display attributes some -- terminals support are not supported via VTY.) reverseVideo :: Style -- | Valid style attributes include: -- -- -- -- (The invisible, protect, and altcharset display attributes some -- terminals support are not supported via VTY.) blink :: Style -- | Valid style attributes include: -- -- -- -- (The invisible, protect, and altcharset display attributes some -- terminals support are not supported via VTY.) dim :: Style -- | Valid style attributes include: -- -- -- -- (The invisible, protect, and altcharset display attributes some -- terminals support are not supported via VTY.) bold :: Style defaultStyleMask :: Style styleMask :: Attr -> Word8 -- | true if the given Style value has the specified Style set. hasStyle :: Style -> Style -> Bool -- | Set the foreground color of an Attr. withForeColor :: Attr -> Color -> Attr -- | Set the background color of an Attr. withBackColor :: Attr -> Color -> Attr -- | Add a hyperlinked URL using the proposed escape sequences for -- hyperlinked URLs. These escape sequences are comparatively new and -- aren't widely supported in terminal emulators yet, but most terminal -- emulators that don't know about these sequences will ignore these -- sequences, and therefore this should fall back sensibly. In some cases -- they won't and this will result in garbage, so this is why -- hyperlinking is disabled by default, in which case this combinator has -- no observable effect. To enable it, enable Hyperlink mode on -- your Vty output interface. withURL :: Attr -> Text -> Attr instance GHC.Show.Show v => GHC.Show.Show (Graphics.Vty.Attributes.MaybeDefault v) instance GHC.Read.Read v => GHC.Read.Read (Graphics.Vty.Attributes.MaybeDefault v) instance GHC.Classes.Eq v => GHC.Classes.Eq (Graphics.Vty.Attributes.MaybeDefault v) instance GHC.Show.Show Graphics.Vty.Attributes.FixedAttr instance GHC.Classes.Eq Graphics.Vty.Attributes.FixedAttr instance Control.DeepSeq.NFData Graphics.Vty.Attributes.Attr instance GHC.Generics.Generic Graphics.Vty.Attributes.Attr instance GHC.Read.Read Graphics.Vty.Attributes.Attr instance GHC.Show.Show Graphics.Vty.Attributes.Attr instance GHC.Classes.Eq Graphics.Vty.Attributes.Attr instance Control.DeepSeq.NFData v => Control.DeepSeq.NFData (Graphics.Vty.Attributes.MaybeDefault v) module Graphics.Vty.DisplayAttributes -- | difference between two display attributes. Used in the calculation of -- the operations required to go from one display attribute to the next. -- -- Previously, vty would reset display attributes to default then apply -- the new display attributes. This turned out to be very expensive: A -- *lot* more data would be sent to the terminal than required. data DisplayAttrDiff DisplayAttrDiff :: [StyleStateChange] -> DisplayColorDiff -> DisplayColorDiff -> URLDiff -> DisplayAttrDiff [styleDiffs] :: DisplayAttrDiff -> [StyleStateChange] [foreColorDiff] :: DisplayAttrDiff -> DisplayColorDiff [backColorDiff] :: DisplayAttrDiff -> DisplayColorDiff [urlDiff] :: DisplayAttrDiff -> URLDiff -- | Style attribute changes are transformed into a sequence of -- apply/removes of the individual attributes. data StyleStateChange ApplyStandout :: StyleStateChange RemoveStandout :: StyleStateChange ApplyItalic :: StyleStateChange RemoveItalic :: StyleStateChange ApplyStrikethrough :: StyleStateChange RemoveStrikethrough :: StyleStateChange ApplyUnderline :: StyleStateChange RemoveUnderline :: StyleStateChange ApplyReverseVideo :: StyleStateChange RemoveReverseVideo :: StyleStateChange ApplyBlink :: StyleStateChange RemoveBlink :: StyleStateChange ApplyDim :: StyleStateChange RemoveDim :: StyleStateChange ApplyBold :: StyleStateChange RemoveBold :: StyleStateChange -- | Difference between two display color attribute changes. data DisplayColorDiff ColorToDefault :: DisplayColorDiff NoColorChange :: DisplayColorDiff SetColor :: !Color -> DisplayColorDiff data URLDiff LinkTo :: !ByteString -> URLDiff NoLinkChange :: URLDiff EndLink :: URLDiff -- | Given the previously applied display attributes as a FixedAttr and the -- current display attributes as an Attr produces a FixedAttr that -- represents the current display attributes. This is done by using the -- previously applied display attributes to remove the KeepCurrent -- abstraction. fixDisplayAttr :: FixedAttr -> Attr -> FixedAttr -- | Determines the diff between two display&color attributes. This -- diff determines the operations that actually get output to the -- terminal. displayAttrDiffs :: FixedAttr -> FixedAttr -> DisplayAttrDiff instance GHC.Classes.Eq Graphics.Vty.DisplayAttributes.DisplayColorDiff instance GHC.Show.Show Graphics.Vty.DisplayAttributes.DisplayColorDiff instance GHC.Classes.Eq Graphics.Vty.DisplayAttributes.StyleStateChange instance GHC.Show.Show Graphics.Vty.DisplayAttributes.StyleStateChange instance GHC.Classes.Eq Graphics.Vty.DisplayAttributes.URLDiff instance GHC.Show.Show Graphics.Vty.DisplayAttributes.URLDiff instance GHC.Show.Show Graphics.Vty.DisplayAttributes.DisplayAttrDiff instance GHC.Base.Semigroup Graphics.Vty.DisplayAttributes.DisplayAttrDiff instance GHC.Base.Monoid Graphics.Vty.DisplayAttributes.DisplayAttrDiff module Graphics.Vty.Error -- | The type of exceptions specific to vty. -- -- These have fully qualified names by default since, IMO, exception -- handling requires this. data VtyException -- | Uncategorized failure specific to vty. VtyFailure :: String -> VtyException -- | A Vty program makes Pictures from Images. This module -- provides the core constructors for creating, combining, and modifying -- Images. module Graphics.Vty.Image -- | This is the internal representation of Images. Use the constructors in -- Graphics.Vty.Image to create instances. -- -- Images are: -- -- data Image -- | The width of an Image. This is the number display columns the image -- will occupy. imageWidth :: Image -> Int -- | The height of an Image. This is the number of display rows the image -- will occupy. imageHeight :: Image -> Int -- | The empty image. Useful for fold combinators. These occupy no space -- and do not affect display attributes. emptyImage :: Image -- | Make an image from a single character. This is a standard Haskell -- 31-bit character assumed to be in the ISO-10646 encoding. char :: Attr -> Char -> Image -- | Make an Image from a String. -- -- This is an alias for iso10646String since the usual case is that a -- literal string like "foo" is represented internally as a list of ISO -- 10646 31 bit characters. -- -- Note: Keep in mind that GHC will compile source encoded as UTF-8 but -- the literal strings, while UTF-8 encoded in the source, will be -- transcoded to a ISO 10646 31 bit characters runtime representation. string :: Attr -> String -> Image -- | Make an image from a string of characters laid out on a single row -- with the same display attribute. The string is assumed to be a -- sequence of ISO-10646 characters. The input string should be sanitized -- of escape sequences (ASCII 27) and carriage returns; otherwise layout -- and attribute problems may result. -- -- Note: depending on how the Haskell compiler represents string -- literals, a string literal in a UTF-8 encoded source file, for -- example, may be represented as a ISO-10646 string. That is, I think, -- the case with GHC 6.10. This means, for the most part, you don't need -- to worry about the encoding format when outputting string literals. -- Just provide the string literal directly to iso10646String or string. iso10646String :: Attr -> String -> Image -- | Make an Image from a string of characters layed out on a single -- row. The input is assumed to be the bytes for UTF-8 encoded text. utf8String :: Attr -> [Word8] -> Image -- | Make an Image from a lazy text value. The text value should be -- sanitized of escape sequences (ASCII 27) and carriage returns; -- otherwise layout and attribute problems may result. text :: Attr -> Text -> Image -- | Make an Image from a text value. The text value should be -- sanitized of escape sequences (ASCII 27) and carriage returns; -- otherwise layout and attribute problems may result. text' :: Attr -> Text -> Image -- | An area of the picture's background (See Background). backgroundFill :: Int -> Int -> Image -- | Make an Image from a UTF-8 encoded lazy bytestring. utf8Bytestring :: Attr -> ByteString -> Image -- | Make an Image from a UTF-8 encoded strict bytestring. utf8Bytestring' :: Attr -> ByteString -> Image -- | Make an image filling a region with the specified character. -- -- If either the width or height are less than or equal to 0, then the -- result is the empty image. charFill :: Integral d => Attr -> Char -> d -> d -> Image -- | combines two images side by side -- -- Combines text chunks where possible. Assures outputWidth and -- outputHeight properties are not violated. -- -- The result image will have a width equal to the sum of the two images -- width. And the height will equal the largest height of the two images. -- The area not defined in one image due to a height mismatch will be -- filled with the background pattern. horizJoin :: Image -> Image -> Image -- | Combines two images horizontally. This is an alias for -- horizJoin. -- -- infixr 5 (<|>) :: Image -> Image -> Image infixr 5 <|> -- | combines two images vertically -- -- The result image will have a height equal to the sum of the heights of -- both images. The width will equal the largest width of the two images. -- The area not defined in one image due to a width mismatch will be -- filled with the background pattern. vertJoin :: Image -> Image -> Image -- | Combines two images vertically. This is an alias for vertJoin. -- -- infixr 4 (<->) :: Image -> Image -> Image infixr 4 <-> -- | Compose any number of images together horizontally, with the first in -- the list being leftmost. horizCat :: [Image] -> Image -- | Compose any number of images vertically, with the first in the list -- being topmost. vertCat :: [Image] -> Image -- | Ensure an image is no larger than the provided size. If the image is -- larger then crop the right or bottom. -- -- This is equivalent to a vertical crop from the bottom followed by -- horizontal crop from the right. crop :: Int -> Int -> Image -> Image -- | Crop an image's width. If the image's width is less than or equal to -- the specified width then this operation has no effect. Otherwise the -- image is cropped from the right. cropRight :: Int -> Image -> Image -- | Crop an image's width. If the image's width is less than or equal to -- the specified width then this operation has no effect. Otherwise the -- image is cropped from the left. cropLeft :: Int -> Image -> Image -- | Crop an image's height. If the image's height is less than or equal to -- the specified height then this operation has no effect. Otherwise the -- image is cropped from the bottom. cropBottom :: Int -> Image -> Image -- | Crop an image's height. If the image's height is less than or equal to -- the specified height then this operation has no effect. Otherwise the -- image is cropped from the top. cropTop :: Int -> Image -> Image -- | Pad the given image. This adds background character fills to the left, -- top, right, bottom. pad :: Int -> Int -> Int -> Int -> Image -> Image -- | Generic resize. Pads and crops are added to ensure that the resulting -- image matches the specified dimensions. This is biased to pad/crop the -- right and bottom. resize :: Int -> Int -> Image -> Image -- | Resize the width. Pads and crops as required to assure the given -- display width. This is biased to pad/crop on the right. resizeWidth :: Int -> Image -> Image -- | Resize the height. Pads and crops as required to assure the given -- display height. This is biased to pad/crop on the bottom. resizeHeight :: Int -> Image -> Image -- | Translates an image by padding or cropping the left and top. -- -- If translation offsets are negative then the image is cropped. translate :: Int -> Int -> Image -> Image -- | Translates an image by padding or cropping its left side. translateX :: Int -> Image -> Image -- | Translates an image by padding or cropping its top. translateY :: Int -> Image -> Image -- | Returns the display width of a character. Assumes all characters with -- unknown widths are 0 width. safeWcwidth :: Char -> Int -- | Returns the display width of a string. Assumes all characters with -- unknown widths are 0 width. safeWcswidth :: String -> Int -- | Returns the display width of a text. Assumes all characters with -- unknown widths are 0 width. safeWctwidth :: Text -> Int -- | Returns the display width of a lazy text. Assumes all characters with -- unknown widths are 0 width. safeWctlwidth :: Text -> Int wcwidth :: Char -> Int wcswidth :: String -> Int wctwidth :: Text -> Int wctlwidth :: Text -> Int -- | A region of the display (first width, then height) type DisplayRegion = (Int, Int) regionWidth :: DisplayRegion -> Int regionHeight :: DisplayRegion -> Int module Graphics.Vty.Input.Events -- | Representations of non-modifier keys. -- -- data Key KEsc :: Key KChar :: {-# UNPACK #-}Char -> Key KBS :: Key KEnter :: Key KLeft :: Key KRight :: Key KUp :: Key KDown :: Key KUpLeft :: Key KUpRight :: Key KDownLeft :: Key KDownRight :: Key KCenter :: Key KFun :: {-# UNPACK #-}Int -> Key KBackTab :: Key KPrtScr :: Key KPause :: Key KIns :: Key KHome :: Key KPageUp :: Key KDel :: Key KEnd :: Key KPageDown :: Key KBegin :: Key KMenu :: Key -- | Modifier keys. Key codes are interpreted such that users are more -- likely to have Meta than Alt; for instance on the PC Linux console, -- MMeta will generally correspond to the physical Alt key. data Modifier MShift :: Modifier MCtrl :: Modifier MMeta :: Modifier MAlt :: Modifier -- | Events. data Event -- | A keyboard key was pressed with the specified modifiers. EvKey :: Key -> [Modifier] -> Event -- | A mouse button was pressed at the specified column and row. Any -- modifiers available in the event are also provided. EvMouseDown :: Int -> Int -> Button -> [Modifier] -> Event -- | A mouse button was released at the specified column and row. Some -- terminals report only that a button was released without specifying -- which one; in that case, Nothing is provided. Otherwise Just the -- button released is included in the event. EvMouseUp :: Int -> Int -> Maybe Button -> Event EvResize :: Int -> Int -> Event -- | A paste event occurs when a bracketed paste input sequence is -- received. For terminals that support bracketed paste mode, these -- events will be triggered on a paste event. Terminals that do not -- support bracketed pastes will send the paste contents as ordinary -- input (which is probably bad, so beware!) Note that the data is -- provided in raw form and you'll have to decode (e.g. as UTF-8) if -- that's what your application expects. EvPaste :: ByteString -> Event -- | The terminal running the application lost input focus. EvLostFocus :: Event -- | The terminal running the application gained input focus. EvGainedFocus :: Event -- | Mouse buttons. data Button BLeft :: Button BMiddle :: Button BRight :: Button BScrollUp :: Button BScrollDown :: Button type ClassifyMap = [(String, Event)] -- | The type of internal events that drive the internal Vty event -- dispatching to the application. data InternalEvent -- | Vty resumed operation after the process was interrupted with a signal. -- In practice this translates into a screen redraw in the input event -- loop. ResumeAfterSignal :: InternalEvent -- | An input event was received. InputEvent :: Event -> InternalEvent instance GHC.Generics.Generic Graphics.Vty.Input.Events.Key instance GHC.Classes.Ord Graphics.Vty.Input.Events.Key instance GHC.Read.Read Graphics.Vty.Input.Events.Key instance GHC.Show.Show Graphics.Vty.Input.Events.Key instance GHC.Classes.Eq Graphics.Vty.Input.Events.Key instance GHC.Generics.Generic Graphics.Vty.Input.Events.Modifier instance GHC.Classes.Ord Graphics.Vty.Input.Events.Modifier instance GHC.Read.Read Graphics.Vty.Input.Events.Modifier instance GHC.Show.Show Graphics.Vty.Input.Events.Modifier instance GHC.Classes.Eq Graphics.Vty.Input.Events.Modifier instance GHC.Generics.Generic Graphics.Vty.Input.Events.Button instance GHC.Classes.Ord Graphics.Vty.Input.Events.Button instance GHC.Read.Read Graphics.Vty.Input.Events.Button instance GHC.Show.Show Graphics.Vty.Input.Events.Button instance GHC.Classes.Eq Graphics.Vty.Input.Events.Button instance GHC.Generics.Generic Graphics.Vty.Input.Events.Event instance GHC.Classes.Ord Graphics.Vty.Input.Events.Event instance GHC.Read.Read Graphics.Vty.Input.Events.Event instance GHC.Show.Show Graphics.Vty.Input.Events.Event instance GHC.Classes.Eq Graphics.Vty.Input.Events.Event instance Control.DeepSeq.NFData Graphics.Vty.Input.Events.Event instance Control.DeepSeq.NFData Graphics.Vty.Input.Events.Button instance Control.DeepSeq.NFData Graphics.Vty.Input.Events.Modifier instance Control.DeepSeq.NFData Graphics.Vty.Input.Events.Key -- | This module exports the input classification type to avoid import -- cycles between other modules that need this. module Graphics.Vty.Input.Classify.Types data KClass -- | A valid event was parsed. Any unused characters from the input stream -- are also provided. Valid :: Event -> ByteString -> KClass -- | The input characters did not represent a valid event. Invalid :: KClass -- | The input characters form the prefix of a valid event character -- sequence. Prefix :: KClass -- | The input characters are either start of a bracketed paste chunk or in -- the middle of a bracketed paste chunk. Chunk :: KClass instance GHC.Classes.Eq Graphics.Vty.Input.Classify.Types.KClass instance GHC.Show.Show Graphics.Vty.Input.Classify.Types.KClass -- | This module provides a simple parser for parsing input event control -- sequences. module Graphics.Vty.Input.Classify.Parse type Parser a = MaybeT (State ByteString) a -- | Run a parser on a given input string. If the parser fails, return -- Invalid. Otherwise return the valid event (Valid) and -- the remaining unparsed characters. runParser :: ByteString -> Parser Event -> KClass -- | Fail a parsing operation. failParse :: Parser a -- | Read an integer from the input stream. If an integer cannot be read, -- fail parsing. E.g. calling readInt on an input of "123abc" will return -- '123' and consume those characters. readInt :: Parser Int -- | Read a character from the input stream. If one cannot be read (e.g. we -- are out of characters), fail parsing. readChar :: Parser Char -- | Read a character from the input stream and fail parsing if it is not -- the specified character. expectChar :: Char -> Parser () -- | Vty supports a configuration file format and associated Config -- data type. The Config can be provided to mkVty to -- customize the application's use of Vty. -- -- Lines in config files that fail to parse are ignored. Later entries -- take precedence over earlier ones. -- --

Debug

-- --

debugLog

-- -- Format: -- -- 
--   "debugLog" string
--
-- -- The value of the environment variable VTY_DEBUG_LOG is -- equivalent to a debugLog entry at the end of the last config file. -- --

Input Processing

-- --

map

-- -- Format: -- -- 
--   "map" term string key modifier_list
--   where
--       key := KEsc | KChar Char | KBS ... (same as Key)
--       modifier_list := "[" modifier+ "]"
--       modifier := MShift | MCtrl | MMeta | MAlt
--       term := "_" | string
--
-- -- E.g., if the contents are -- -- 
--   map _       "\ESC[B"    KUp   []
--   map _       "\ESC[1;3B" KDown [MAlt]
--   map "xterm" "\ESC[D"    KLeft []
--
-- -- Then the bytes "\ESC[B" will result in the KUp event on all -- terminals. The bytes "\ESC[1;3B" will result in the event -- KDown with the MAlt modifier on all terminals. The bytes -- "\ESC[D" will result in the KLeft event when TERM is -- xterm. -- -- If a debug log is requested then vty will output the current input -- table to the log in the above format. A workflow for using this is to -- set VTY_DEBUG_LOG. Run the application. Check the debug log -- for incorrect mappings. Add corrected mappings to -- $HOME/.vty/config. -- --

Unicode Character Width Maps

-- --

widthMap

-- -- Format: -- -- 
--   "widthMap" string string
--
-- -- E.g., -- -- 
--   widthMap "xterm" "/home/user/.vty/xterm_map.dat"
--
-- -- This directive specifies the path to a Unicode character width map -- (the second argument) that should be loaded and used when the value of -- TERM matches the first argument. Unicode character width maps can be -- produced either by running the provided binary -- vty-build-width-table or by calling the library routine -- buildUnicodeWidthTable. The mkVty function will use -- these configuration settings to attempt to load and install the -- specified width map. See the documentation for mkVty for -- details. module Graphics.Vty.Config -- | Mappings from input bytes to event in the order specified. Later -- entries take precedence over earlier in the case multiple entries have -- the same byte string. type InputMap = [(Maybe String, String, Event)] -- | A Vty configuration. data Config Config :: Maybe Int -> Maybe Int -> Maybe Bool -> Maybe Bool -> Maybe FilePath -> InputMap -> Maybe Fd -> Maybe Fd -> Maybe String -> [(String, FilePath)] -> Maybe Bool -> Maybe ColorMode -> Config -- | The default is 1 character. [vmin] :: Config -> Maybe Int -- | The default is 100 milliseconds, 0.1 seconds. [vtime] :: Config -> Maybe Int -- | The default is False. [mouseMode] :: Config -> Maybe Bool -- | The default is False. [bracketedPasteMode] :: Config -> Maybe Bool -- | Debug information is appended to this file if not Nothing. [debugLog] :: Config -> Maybe FilePath -- | The (input byte, output event) pairs extend the internal input table -- of VTY and the table from terminfo. -- -- See Graphics.Vty.Config module documentation for documentation -- of the map directive. [inputMap] :: Config -> InputMap -- | The input file descriptor to use. The default is stdInput [inputFd] :: Config -> Maybe Fd -- | The output file descriptor to use. The default is stdOutput [outputFd] :: Config -> Maybe Fd -- | The terminal name used to look up terminfo capabilities. The default -- is the value of the TERM environment variable. [termName] :: Config -> Maybe String -- | Terminal width map files. [termWidthMaps] :: Config -> [(String, FilePath)] -- | Whether to permit custom Unicode width table loading by mkVty. -- Just False indicates that table loading should -- not be performed. Other values permit table loading. -- -- If a table load is attempted and fails, information about the failure -- will be logged to the debug log if the configuration specifies one. If -- no custom table is loaded (or if a load fails), the built-in character -- width table will be used. [allowCustomUnicodeWidthTables] :: Config -> Maybe Bool -- | The color mode used to know how many colors the terminal supports. [colorMode] :: Config -> Maybe ColorMode -- | Type of errors that can be thrown when configuring VTY data VtyConfigurationError -- | TERM environment variable not set VtyMissingTermEnvVar :: VtyConfigurationError -- | Load a configuration from vtyConfigPath and -- $VTY_CONFIG_FILE. userConfig :: IO Config overrideEnvConfig :: IO Config -- | Configures VTY using defaults suitable for terminals. This function -- can raise VtyConfigurationError. standardIOConfig :: IO Config runParseConfig :: String -> ByteString -> Config parseConfigFile :: FilePath -> IO Config defaultConfig :: Config -- | Get the "erase" character for the terminal attached to the specified -- file descriptor. This is the character configured by 'stty erase'. If -- the call to tcgetattr fails, this will return Nothing. -- Otherwise it will return the character that has been configured to -- indicate the canonical mode ERASE behavior. That character can then be -- added to the table of strings that we interpret to mean Backspace. -- -- For more details, see: -- -- getTtyEraseChar :: Fd -> IO (Maybe Char) currentTerminalName :: IO (Maybe String) vtyConfigPath :: IO FilePath widthTableFilename :: String -> String vtyDataDirectory :: IO FilePath terminalWidthTablePath :: IO (Maybe FilePath) vtyConfigFileEnvName :: String data ConfigUpdateResult ConfigurationCreated :: ConfigUpdateResult ConfigurationModified :: ConfigUpdateResult ConfigurationConflict :: String -> ConfigUpdateResult ConfigurationRedundant :: ConfigUpdateResult -- | Add a widthMap directive to the Vty configuration file at the -- specified path. -- -- If the configuration path refers to a configuration that already -- contains the directive for the specified map and terminal type, the -- configuration file will not be modified. If the file does not contain -- the directive, it will be appended to the file. -- -- If the configuration path does not exist, a new configuration file -- will be created and any directories in the path will also be created. -- -- This returns True if the configuration was created or -- modified and False otherwise. This does not handle exceptions -- raised by file or directory permissions issues. addConfigWidthMap :: FilePath -> String -> FilePath -> IO ConfigUpdateResult instance GHC.Classes.Eq Graphics.Vty.Config.VtyConfigurationError instance GHC.Show.Show Graphics.Vty.Config.VtyConfigurationError instance GHC.Classes.Eq Graphics.Vty.Config.Config instance GHC.Show.Show Graphics.Vty.Config.Config instance GHC.Show.Show Graphics.Vty.Config.ConfigUpdateResult instance GHC.Classes.Eq Graphics.Vty.Config.ConfigUpdateResult instance Graphics.Vty.Config.GParseAlts f => Graphics.Vty.Config.GParse (GHC.Generics.M1 GHC.Generics.D i f) instance (GHC.Generics.Constructor i, Graphics.Vty.Config.GParse f) => Graphics.Vty.Config.GParseAlts (GHC.Generics.M1 GHC.Generics.C i f) instance (Graphics.Vty.Config.GParseAlts f, Graphics.Vty.Config.GParseAlts g) => Graphics.Vty.Config.GParseAlts (f GHC.Generics.:+: g) instance Graphics.Vty.Config.GParseAlts GHC.Generics.V1 instance Graphics.Vty.Config.GParse f => Graphics.Vty.Config.GParse (GHC.Generics.M1 GHC.Generics.S i f) instance Graphics.Vty.Config.GParse GHC.Generics.U1 instance Graphics.Vty.Config.Parse a => Graphics.Vty.Config.GParse (GHC.Generics.K1 i a) instance (Graphics.Vty.Config.GParse f, Graphics.Vty.Config.GParse g) => Graphics.Vty.Config.GParse (f GHC.Generics.:*: g) instance Graphics.Vty.Config.Parse GHC.Types.Char instance Graphics.Vty.Config.Parse GHC.Types.Int instance Graphics.Vty.Config.Parse Graphics.Vty.Input.Events.Key instance Graphics.Vty.Config.Parse Graphics.Vty.Input.Events.Modifier instance Graphics.Vty.Config.Parse a => Graphics.Vty.Config.Parse [a] instance GHC.Base.Semigroup Graphics.Vty.Config.Config instance GHC.Base.Monoid Graphics.Vty.Config.Config instance GHC.Exception.Type.Exception Graphics.Vty.Config.VtyConfigurationError module Graphics.Vty.Input.Focus -- | These sequences set xterm-based terminals to send focus event -- sequences. requestFocusEvents :: ByteString -- | These sequences disable focus events. disableFocusEvents :: ByteString -- | Does the specified string begin with a focus event? isFocusEvent :: ByteString -> Bool -- | Attempt to classify an input string as a focus event. classifyFocusEvent :: ByteString -> KClass -- | This module provides parsers for mouse events for both "normal" and -- "extended" modes. This implementation was informed by -- -- -- http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking module Graphics.Vty.Input.Mouse -- | These sequences set xterm-based terminals to send mouse event -- sequences. requestMouseEvents :: ByteString -- | These sequences disable mouse events. disableMouseEvents :: ByteString -- | Does the specified string begin with a mouse event? isMouseEvent :: ByteString -> Bool -- | Attempt to classify an input string as a mouse event. classifyMouseEvent :: ByteString -> KClass -- | This module provides bracketed paste support as described at -- -- http://cirw.in/blog/bracketed-paste module Graphics.Vty.Input.Paste -- | Parse a bracketed paste. This should only be called on a string if -- both bracketedPasteStarted and bracketedPasteFinished -- return True. parseBracketedPaste :: ByteString -> KClass -- | Does the input start a bracketed paste? bracketedPasteStarted :: ByteString -> Bool -- | Does the input contain a complete bracketed paste? bracketedPasteFinished :: ByteString -> Bool module Graphics.Vty.Input.Terminfo -- | Queries the terminal for all capability-based input sequences and then -- adds on a terminal-dependent input sequence mapping. -- -- For reference see: -- -- -- -- Terminfo is incomplete. The vim source implies that terminfo is also -- incorrect. Vty assumes that the internal terminfo table added to the -- system-provided terminfo table is correct. -- -- The procedure used here is: -- --
    --
  1. Build terminfo table for all caps. Missing caps are not -- added.
    2. --
  2. Add tables for visible chars, esc, del, ctrl, and meta.
    3. --
  3. Add internally-defined table for given terminal type.
    4. --
-- -- Precedence is currently implicit in the compile algorithm. classifyMapForTerm :: String -> Terminal -> ClassifyMap -- | Esc, meta-esc, delete, meta-delete, enter, meta-enter. specialSupportKeys :: ClassifyMap capsClassifyMap :: Terminal -> [(String, Event)] -> ClassifyMap -- | A classification table directly generated from terminfo cap strings. -- These are: -- -- keysFromCapsTable :: ClassifyMap -- | The key table applicable to all terminals. -- -- Note that some of these entries are probably only applicable to -- ANSI/VT100 terminals. universalTable :: ClassifyMap -- | Visible characters in the ISO-8859-1 and UTF-8 common set. -- -- We limit to < 0xC1. The UTF8 sequence detector will catch all -- values 0xC2 and above before this classify table is reached. visibleChars :: ClassifyMap -- | This module provides the input layer for Vty, including methods for -- initializing an Input structure and reading Events from -- the terminal. -- -- Note that due to the evolution of terminal emulators, some keys and -- combinations will not reliably map to the expected events by any -- terminal program. There is no 1:1 mapping from key events to bytes -- read from the terminal input device. In very limited cases the -- terminal and vty's input process can be customized to resolve these -- issues; see Graphics.Vty.Config for how to configure vty's -- input processing. -- --

VTY's Implementation

-- -- There are two input modes: -- --
    --
  1. 7-bit
    2. --
  2. 8-bit
    3. --
-- -- The 7-bit input mode is the default and the expected mode in most use -- cases. This is what Vty uses. -- --

7-bit input encoding

-- -- Control key combinations are represented by masking the two high bits -- of the 7-bit input. Historically the control key actually grounded the -- two high bit wires: 6 and 7. This is why control key combos map to -- single character events: the input bytes are identical. The input byte -- is the bit encoding of the character with bits 6 and 7 masked. Bit 6 -- is set by shift. Bit 6 and 7 are masked by control. For example, -- -- -- --

8-bit encoding

-- -- The 8th bit was originally used for parity checking which is useless -- for terminal emulators. Some terminal emulators support an 8-bit input -- encoding. While this provides some advantages, the actual usage is -- low. Most systems use 7-bit mode but recognize 8-bit control -- characters when escaped. This is what Vty does. -- --

Escaped Control Keys

-- -- Using 7-bit input encoding, the ESC byte can signal the start -- of an encoded control key. To differentiate a single ESC -- event from a control key, the timing of the input is used. -- --
    --
  1. ESC individually: ESC byte; no bytes following -- for a period of VMIN milliseconds.
    2. --
  2. Control keys that contain ESC in their encoding: The @ESC -- byte is followed by more bytes read within VMIN milliseconds. -- All bytes up until the next valid input block are passed to the -- classifier.
    3. --
-- -- If the current runtime is the threaded runtime then the terminal's -- VMIN and VTIME behavior reliably implement the above -- rules. If the current runtime does not support forkOS then -- there is currently no implementation. -- --

Unicode Input and Escaped Control Key Sequences

-- -- The input encoding determines how UTF-8 encoded characters are -- recognized. -- -- -- --

Terminfo

-- -- The terminfo system is used to determine how some keys are encoded. -- Terminfo is incomplete and in some cases terminfo is incorrect. Vty -- assumes terminfo is correct but provides a mechanism to override -- terminfo; see Graphics.Vty.Config, specifically -- inputOverrides. -- --

Terminal Input is Broken

-- -- Clearly terminal input has fundamental issues. There is no easy way to -- reliably resolve these issues. -- -- One resolution would be to ditch standard terminal interfaces entirely -- and just go directly to scancodes. This would be a reasonable option -- for Vty if everybody used the linux kernel console but for obvious -- reasons this is not possible. -- -- The Graphics.Vty.Config module supports customizing the -- input-byte-to-event mapping and xterm supports customizing the -- scancode-to-input-byte mapping. With a lot of work a user's system can -- be set up to encode all the key combos in an almost-sane manner. -- --

See also

-- -- module Graphics.Vty.Input -- | Representations of non-modifier keys. -- -- data Key KEsc :: Key KChar :: {-# UNPACK #-}Char -> Key KBS :: Key KEnter :: Key KLeft :: Key KRight :: Key KUp :: Key KDown :: Key KUpLeft :: Key KUpRight :: Key KDownLeft :: Key KDownRight :: Key KCenter :: Key KFun :: {-# UNPACK #-}Int -> Key KBackTab :: Key KPrtScr :: Key KPause :: Key KIns :: Key KHome :: Key KPageUp :: Key KDel :: Key KEnd :: Key KPageDown :: Key KBegin :: Key KMenu :: Key -- | Modifier keys. Key codes are interpreted such that users are more -- likely to have Meta than Alt; for instance on the PC Linux console, -- MMeta will generally correspond to the physical Alt key. data Modifier MShift :: Modifier MCtrl :: Modifier MMeta :: Modifier MAlt :: Modifier -- | Mouse buttons. data Button BLeft :: Button BMiddle :: Button BRight :: Button BScrollUp :: Button BScrollDown :: Button -- | Events. data Event -- | A keyboard key was pressed with the specified modifiers. EvKey :: Key -> [Modifier] -> Event -- | A mouse button was pressed at the specified column and row. Any -- modifiers available in the event are also provided. EvMouseDown :: Int -> Int -> Button -> [Modifier] -> Event -- | A mouse button was released at the specified column and row. Some -- terminals report only that a button was released without specifying -- which one; in that case, Nothing is provided. Otherwise Just the -- button released is included in the event. EvMouseUp :: Int -> Int -> Maybe Button -> Event EvResize :: Int -> Int -> Event -- | A paste event occurs when a bracketed paste input sequence is -- received. For terminals that support bracketed paste mode, these -- events will be triggered on a paste event. Terminals that do not -- support bracketed pastes will send the paste contents as ordinary -- input (which is probably bad, so beware!) Note that the data is -- provided in raw form and you'll have to decode (e.g. as UTF-8) if -- that's what your application expects. EvPaste :: ByteString -> Event -- | The terminal running the application lost input focus. EvLostFocus :: Event -- | The terminal running the application gained input focus. EvGainedFocus :: Event data Input Input :: TChan InternalEvent -> IO () -> IO () -> IORef Config -> Maybe Handle -> Input -- | Channel of events direct from input processing. Unlike -- nextEvent this will not refresh the display if the next event -- is an EvResize. [_eventChannel] :: Input -> TChan InternalEvent -- | Shuts down the input processing. As part of shutting down the input, -- this should also restore the input state. [shutdownInput] :: Input -> IO () -- | Restore the terminal's input state to what it was prior to configuring -- input for Vty. This should be done as part of shutdownInput but -- is exposed in case you need to access it directly. [restoreInputState] :: Input -> IO () -- | Changes to this value are reflected after the next event. [_configRef] :: Input -> IORef Config -- | input debug log [_inputDebug] :: Input -> Maybe Handle -- | Set up the terminal with file descriptor inputFd for input. -- Returns an Input. -- -- The table used to determine the Events to produce for the -- input bytes comes from classifyMapForTerm which is then -- overridden by the the applicable entries from the configuration's -- inputMap. -- -- The terminal device's mode flags are configured by the -- attributeControl function. inputForConfig :: Config -> IO Input -- | Construct two IO actions: one to configure the terminal for Vty and -- one to restore the terminal mode flags to the values they had at the -- time this function was called. -- -- This function constructs a configuration action to clear the following -- terminal mode flags: -- -- -- -- The configuration action also explicitly sets these flags: -- -- attributeControl :: Fd -> IO (IO (), IO ()) module Graphics.Vty.Picture -- | A Vty picture. -- -- These can be constructed directly or using picForImage. data Picture Picture :: Cursor -> [Image] -> Background -> Picture -- | The picture's cursor. [picCursor] :: Picture -> Cursor -- | The picture's image layers (top-most first). [picLayers] :: Picture -> [Image] -- | The picture's background to be displayed in locations with no Image -- data. [picBackground] :: Picture -> Background -- | A picture can be configured to hide the cursor or to show the cursor -- at the specified character position. -- -- There is not a 1:1 map from character positions to a row and column on -- the screen due to characters that take more than 1 column. data Cursor -- | Hide the cursor NoCursor :: Cursor -- | Set the terminal's cursor position without displaying a cursor -- character. This is important for accessibility with screen readers -- where a cursor position needs to be reported but we may not want to -- show a block cursor in that location for cosmetic reasons. The boolean -- argument indicates whether the positioning should be absolute as with -- AbsoluteCursor (True) or logical as with Cursor -- (False). PositionOnly :: !Bool -> !Int -> !Int -> Cursor -- | Show the cursor at the given logical column accounting for character -- width in the presence of multi-column characters. Cursor :: !Int -> !Int -> Cursor -- | Show the cursor at the given absolute terminal column and row AbsoluteCursor :: !Int -> !Int -> Cursor -- | A Picture has a background pattern. The background is either: -- -- -- -- If the display attribute used previously should be used for a -- background fill then use currentAttr for the background -- attribute. data Background Background :: Char -> Attr -> Background [backgroundChar] :: Background -> Char [backgroundAttr] :: Background -> Attr -- | A ClearBackground is: -- -- ClearBackground :: Background -- | A picture with no cursor, background or image layers. emptyPicture :: Picture -- | Add an Image as the top-most layer of a Picture. addToTop :: Picture -> Image -> Picture -- | Add an Image as the bottom-most layer of a Picture. addToBottom :: Picture -> Image -> Picture -- | Create a picture from the given image. The picture will not have a -- displayed cursor and no background pattern (ClearBackground) will be -- used. picForImage :: Image -> Picture -- | Create a picture with the given layers, top-most first. -- -- The picture will not have a displayed cursor and no background pattern -- (ClearBackgroun) will be used. picForLayers :: [Image] -> Picture -- | Return the top-most Image layer for a picture. This is unsafe -- for Pictures without at least one layer. -- -- This is provided for compatibility with applications that do not use -- more than a single layer. picImage :: Picture -> Image instance GHC.Show.Show Graphics.Vty.Picture.Cursor instance GHC.Classes.Eq Graphics.Vty.Picture.Cursor instance GHC.Show.Show Graphics.Vty.Picture.Background instance GHC.Classes.Eq Graphics.Vty.Picture.Background instance GHC.Show.Show Graphics.Vty.Picture.Picture instance GHC.Classes.Eq Graphics.Vty.Picture.Picture instance Control.DeepSeq.NFData Graphics.Vty.Picture.Picture instance Control.DeepSeq.NFData Graphics.Vty.Picture.Background instance Control.DeepSeq.NFData Graphics.Vty.Picture.Cursor -- | A picture is translated into a sequences of state changes and -- character spans. The attribute is applied to all following spans, -- including spans of the next row. The nth element of the sequence -- represents the nth row (from top to bottom) of the picture to render. -- -- A span op sequence will be defined for all rows and columns (and no -- more) of the region provided with the picture to spansForPic. module Graphics.Vty.Span -- | This represents an operation on the terminal: either an attribute -- change or the output of a text string. data SpanOp -- | A span of UTF-8 text occupies a specific number of screen space -- columns. A single UTF character does not necessarily represent 1 -- colunm. See Codec.Binary.UTF8.Width TextSpan [Attr] [output width in -- columns] [number of characters] [data] TextSpan :: !Attr -> !Int -> !Int -> Text -> SpanOp [textSpanAttr] :: SpanOp -> !Attr [textSpanOutputWidth] :: SpanOp -> !Int [textSpanCharWidth] :: SpanOp -> !Int [textSpanText] :: SpanOp -> Text -- | Skips the given number of columns. Skip :: !Int -> SpanOp -- | Marks the end of a row. Specifies how many columns are remaining. -- These columns will not be explicitly overwritten with the span ops. -- The terminal is require to assure the remaining columns are clear. RowEnd :: !Int -> SpanOp -- | The number of columns to the character at the given position in the -- span op. columnsToCharOffset :: Int -> SpanOp -> Int -- | The width of a single SpanOp in columns. spanOpHasWidth :: SpanOp -> Maybe (Int, Int) -- | A vector of span operations executed in succession. This represents -- the operations required to render a row of the terminal. The -- operations in one row may affect subsequent rows. For example, setting -- the foreground color in one row will affect all subsequent rows until -- the foreground color is changed. type SpanOps = Vector SpanOp -- | The number of columns a SpanOps affects. spanOpsAffectedColumns :: SpanOps -> Int splitOpsAt :: Int -> SpanOps -> (SpanOps, SpanOps) dropOps :: Int -> SpanOps -> SpanOps -- | A vector of span operation vectors for display, one per row of the -- output region. type DisplayOps = Vector SpanOps -- | The number of rows the DisplayOps are defined for. displayOpsRows :: DisplayOps -> Int -- | The number of columns the DisplayOps are defined for. -- -- All spans are verified to define same number of columns. displayOpsColumns :: DisplayOps -> Int affectedRegion :: DisplayOps -> DisplayRegion instance GHC.Classes.Eq Graphics.Vty.Span.SpanOp instance GHC.Show.Show Graphics.Vty.Span.SpanOp -- | Transforms an image into rows of operations. module Graphics.Vty.PictureToSpans -- | Produces the span ops that will render the given picture, possibly -- cropped or padded, into the specified region. displayOpsForPic :: Picture -> DisplayRegion -> DisplayOps -- | This module provides an abstract interface for performing terminal -- output. The only user-facing part of this API is Output. module Graphics.Vty.Output.Interface -- | The Vty terminal output interface. data Output Output :: String -> IO () -> IO () -> IO () -> ((Int, Int) -> IO ()) -> IO DisplayRegion -> (ByteString -> IO ()) -> Bool -> (Mode -> Bool) -> (Mode -> Bool -> IO ()) -> (Mode -> IO Bool) -> IORef AssumedState -> (Output -> DisplayRegion -> IO DisplayContext) -> IO () -> IO Bool -> IO Bool -> IO Bool -> ColorMode -> Output -- | Text identifier for the output device. Used for debugging. [terminalID] :: Output -> String -- | Release the terminal just prior to application exit and reset it to -- its state prior to application startup. [releaseTerminal] :: Output -> IO () -- | Clear the display and initialize the terminal to some initial display -- state. -- -- The expectation of a program is that the display starts in some The -- initial state. initial state would consist of fixed values: -- -- [reserveDisplay] :: Output -> IO () -- | Return the display to the state before reserveDisplay If no -- previous state then set the display state to the initial state. [releaseDisplay] :: Output -> IO () -- | Sets the current display bounds (width, height). [setDisplayBounds] :: Output -> (Int, Int) -> IO () -- | Returns the current display bounds. [displayBounds] :: Output -> IO DisplayRegion -- | Output the bytestring to the terminal device. [outputByteBuffer] :: Output -> ByteString -> IO () -- | Specifies whether the cursor can be shown / hidden. [supportsCursorVisibility] :: Output -> Bool -- | Indicates support for terminal modes for this output device. [supportsMode] :: Output -> Mode -> Bool -- | Enables or disables a mode (does nothing if the mode is unsupported). [setMode] :: Output -> Mode -> Bool -> IO () -- | Returns whether a mode is enabled. [getModeStatus] :: Output -> Mode -> IO Bool [assumedStateRef] :: Output -> IORef AssumedState -- | Acquire display access to the given region of the display. Currently -- all regions have the upper left corner of (0,0) and the lower right -- corner at (max displayWidth providedWidth, max displayHeight -- providedHeight) [mkDisplayContext] :: Output -> Output -> DisplayRegion -> IO DisplayContext -- | Ring the terminal bell if supported. [ringTerminalBell] :: Output -> IO () -- | Returns whether the terminal has an audio bell feature. [supportsBell] :: Output -> IO Bool -- | Returns whether the terminal supports italicized text. -- -- This is terminal-dependent and should make a best effort to determine -- whether this feature is supported, but even if the terminal advertises -- support (e.g. via terminfo) that might not be a reliable indicator of -- whether the feature will work as desired. [supportsItalics] :: Output -> IO Bool -- | Returns whether the terminal supports strikethrough text. -- -- This is terminal-dependent and should make a best effort to determine -- whether this feature is supported, but even if the terminal advertises -- support (e.g. via terminfo) that might not be a reliable indicator of -- whether the feature will work as desired. [supportsStrikethrough] :: Output -> IO Bool -- | Returns how many colors the terminal supports. [outputColorMode] :: Output -> ColorMode data AssumedState AssumedState :: Maybe FixedAttr -> Maybe DisplayOps -> AssumedState [prevFattr] :: AssumedState -> Maybe FixedAttr [prevOutputOps] :: AssumedState -> Maybe DisplayOps data DisplayContext DisplayContext :: Output -> DisplayRegion -> (Int -> Int -> Write) -> Write -> Write -> (Bool -> FixedAttr -> Attr -> DisplayAttrDiff -> Write) -> (Bool -> Write) -> Write -> IO () -> DisplayContext [contextDevice] :: DisplayContext -> Output -- | Provide the bounds of the display context. [contextRegion] :: DisplayContext -> DisplayRegion -- | Sets the output position to the specified row and column where the -- number of bytes required for the control codes can be specified -- seperate from the actual byte sequence. [writeMoveCursor] :: DisplayContext -> Int -> Int -> Write [writeShowCursor] :: DisplayContext -> Write [writeHideCursor] :: DisplayContext -> Write [writeSetAttr] :: DisplayContext -> Bool -> FixedAttr -> Attr -> DisplayAttrDiff -> Write -- | Reset the display attributes to the default display attributes. [writeDefaultAttr] :: DisplayContext -> Bool -> Write [writeRowEnd] :: DisplayContext -> Write -- | See inlineHack [inlineHack] :: DisplayContext -> IO () -- | Modal terminal features that can be enabled and disabled. data Mode -- | Mouse mode (whether the terminal is configured to provide mouse input -- events) Mouse :: Mode -- | Paste mode (whether the terminal is configured to provide events on OS -- pastes) BracketedPaste :: Mode -- | Focus-in/focus-out events (whether the terminal is configured to -- provide events on focus change) Focus :: Mode -- | Hyperlink mode via the withURL attribute modifier (see -- https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda). -- Note that this may not work gracefully in all terminal emulators so be -- sure to test this mode with the terminals you intend to support. It is -- off by default. Hyperlink :: Mode displayContext :: Output -> DisplayRegion -> IO DisplayContext -- | Displays the given Picture. -- --
    --
  1. The image is cropped to the display size.
    2. --
  2. Converted into a sequence of attribute changes and text -- spans.
    3. --
  3. The cursor is hidden.
    4. --
  4. Serialized to the display.
    5. --
  5. The cursor is then shown and positioned or kept hidden.
    6. --
outputPicture :: DisplayContext -> Picture -> IO () initialAssumedState :: AssumedState -- | Not all terminals support all display attributes. This filters a -- display attribute to what the given terminal can display. limitAttrForDisplay :: Output -> Attr -> Attr instance GHC.Show.Show Graphics.Vty.Output.Interface.Mode instance GHC.Read.Read Graphics.Vty.Output.Interface.Mode instance GHC.Classes.Eq Graphics.Vty.Output.Interface.Mode -- | Terminfo-based terminal output driver. -- -- Copyright Corey O'Connor (coreyoconnor@gmail.com) module Graphics.Vty.Output.TerminfoBased -- | Constructs an output driver that uses terminfo for all control codes. -- While this should provide the most compatible terminal, terminfo does -- not support some features that would increase efficiency and improve -- compatibility: -- -- reserveTerminal :: String -> Fd -> ColorMode -> IO Output setWindowSize :: Fd -> (Int, Int) -> IO () -- | Xterm output driver. This uses the Terminfo driver with some -- extensions for Xterm. module Graphics.Vty.Output.XTermColor -- | Construct an Xterm output driver. Initialize the display to UTF-8. reserveTerminal :: (Applicative m, MonadIO m) => String -> Fd -> ColorMode -> m Output -- | This provides a mock terminal implementation that is nice for testing. -- This transforms the output operations to visible characters which is -- useful for testing. module Graphics.Vty.Output.Mock type MockData = IORef (UTF8 ByteString) -- | The mock display terminal produces a string representation of the -- requested picture. There is *not* an isomorphism between the string -- representation and the picture. The string representation is a -- simplification of the picture that is only useful in debugging VTY -- without considering terminal specific issues. -- -- The mock implementation is useful in manually determining if the -- sequence of terminal operations matches the expected sequence. The -- requirement of the produced representation is simplicity in parsing -- the text representation and determining how the picture was mapped to -- terminal operations. -- -- The string representation is a sequence of identifiers where each -- identifier is the name of an operation in the algebra. mockTerminal :: (Applicative m, MonadIO m) => DisplayRegion -> m (MockData, Output) -- | This module provides functions for accessing the current terminal or a -- specific terminal device. -- -- See also: -- --
    --
  1. Graphics.Vty.Output: This instantiates an abtract interface -- to the terminal based on the TERM and COLORTERM -- environment variables.
    2. --
  2. Graphics.Vty.Output.Interface: Defines the generic -- interface all terminal modules need to implement.
    3. --
  3. Graphics.Vty.Output.TerminfoBased: Defines a terminal -- instance that uses terminfo for all control strings. No attempt is -- made to change the character set to UTF-8 for these terminals.
    4. --
  4. Graphics.Vty.Output.XTermColor: This module contains an -- interface suitable for xterm-like terminals. These are the terminals -- where TERM begins with xterm. This does use terminfo -- for as many control codes as possible.
    5. --
module Graphics.Vty.Output -- | Returns an Output for the terminal specified in Config. -- -- The specific Output implementation used is hidden from the API user. -- All terminal implementations are assumed to perform more, or less, the -- same. Currently, all implementations use terminfo for at least some -- terminal specific information. -- -- If a terminal implementation is developed for a terminal without -- terminfo support then Vty should work as expected on that terminal. -- -- Selection of a terminal is done as follows: -- -- outputForConfig :: Config -> IO Output -- | Sets the cursor position to the given output column and row. -- -- This is not necessarily the same as the character position with the -- same coordinates. Characters can be a variable number of columns in -- width. -- -- Currently, the only way to set the cursor position to a given -- character coordinate is to specify the coordinate in the Picture -- instance provided to outputPicture or refresh. setCursorPos :: Output -> Int -> Int -> IO () -- | Hides the cursor. hideCursor :: Output -> IO () -- | Shows the cursor. showCursor :: Output -> IO () module Graphics.Vty.Debug data MockWindow MockWindow :: Int -> Int -> MockWindow regionForWindow :: MockWindow -> DisplayRegion allSpansHaveWidth :: DisplayOps -> Int -> Bool -- | The number of columns a SpanOps affects. spanOpsAffectedColumns :: SpanOps -> Int spanOpsAffectedRows :: DisplayOps -> Int instance GHC.Classes.Eq Graphics.Vty.Debug.MockWindow instance GHC.Show.Show Graphics.Vty.Debug.MockWindow module Graphics.Vty.UnicodeWidthTable.Types -- | A run-length-encoded table of Unicode character widths. data UnicodeWidthTable UnicodeWidthTable :: [WidthTableRange] -> UnicodeWidthTable -- | The ranges in the table. [unicodeWidthTableRanges] :: UnicodeWidthTable -> [WidthTableRange] -- | A range of code points in a width table. data WidthTableRange WidthTableRange :: Word32 -> Word32 -> Word8 -> WidthTableRange -- | The range's starting code point. [rangeStart] :: WidthTableRange -> Word32 -- | The number of code points in the contiguous range, beginning with the -- starting code point (rangeStart). [rangeSize] :: WidthTableRange -> Word32 -- | The terminal width, in columns, of all of the characters corresponding -- to the code points in this range. [rangeColumns] :: WidthTableRange -> Word8 instance GHC.Show.Show Graphics.Vty.UnicodeWidthTable.Types.WidthTableRange instance GHC.Classes.Eq Graphics.Vty.UnicodeWidthTable.Types.WidthTableRange instance GHC.Show.Show Graphics.Vty.UnicodeWidthTable.Types.UnicodeWidthTable module Graphics.Vty.UnicodeWidthTable.Query -- | Construct a unicode character width table by querying the terminal -- connected to stdout. This works by emitting characters to stdout and -- then querying the terminal to determine the resulting cursor position -- in order to measure character widths. Consequently this will generate -- a lot of output and may take a while, depending on your system -- performance. This should not be run in a terminal while it is -- controlled by Vty. -- -- The argument specifies the upper bound code point to test when -- building the table. This allows callers to decide how much of the -- Unicode code point space to scan when building the table. -- -- This does not handle exceptions. buildUnicodeWidthTable :: Char -> IO UnicodeWidthTable defaultUnicodeTableUpperBound :: Char module Graphics.Vty.UnicodeWidthTable.Install -- | Exception type raised by installUnicodeWidthTable. data TableInstallException -- | The width table could not be initialized. Args: failure status, -- requested table size. TableInitFailure :: Int -> Int -> TableInstallException -- | A code point range could not be configured. Args: failure status, -- offending range. TableRangeFailure :: Int -> WidthTableRange -> TableInstallException -- | The table could not be activated. Args: failure status. TableActivationFailure :: Int -> TableInstallException -- | Install a custom unicode character width table. Such tables are -- obtained with buildUnicodeWidthTable and -- readUnicodeWidthTable. -- -- ALERT! This function is probably not what you want to use because it -- is automatically called by mkVty. You will only ever need to -- call this function if you want to use functions in Width -- without controlling the terminal with mkVty. -- -- This affects the behavior of the wcwidth function and functions -- that call it. It does so by changing global state available to the C -- implementation of wcwidth. To ensure that your program gets -- consistent results from evaluating calls to wcwidth, the -- installation of a custom table should be performed before you call -- wcwidth in your program. -- -- This is best done at Vty startup, and if you use mkVty, that -- function calls this automatically based on the Vty configuration's -- declared width tables. It is exposed as part of the public API so that -- applications can call this as needed if they don't want to control the -- terminal with mkVty but do want to make calls to -- wcwidth. -- -- It's also important to note that once a custom table has been -- installed, it is permanent for the life of the process. No new table -- can be installed, and the new custom table cannot be removed. -- -- If this function fails for any reason -- if the table cannot be -- installed or is invalid, or if a custom table already exists -- this -- will raise a TableInstallException exception. -- -- This function is thread-safe. installUnicodeWidthTable :: UnicodeWidthTable -> IO () -- | Returns True if and only if a custom table has been allocated and -- marked as ready for use. -- -- This function is thread-safe. isCustomTableReady :: IO Bool instance GHC.Show.Show Graphics.Vty.UnicodeWidthTable.Install.TableInstallException instance GHC.Classes.Eq Graphics.Vty.UnicodeWidthTable.Install.TableInstallException instance GHC.Exception.Type.Exception Graphics.Vty.UnicodeWidthTable.Install.TableInstallException module Graphics.Vty.UnicodeWidthTable.IO -- | Load a binary unicode width table from the specified file. -- -- This either returns a successfully parsed table or a table parsing -- error message. This does not handle I/O exceptions. readUnicodeWidthTable :: FilePath -> IO (Either String UnicodeWidthTable) -- | Parse a binary unicode width table. parseUnicodeWidthTable :: ByteString -> Either String UnicodeWidthTable -- | Write the unicode width table to the specified path. -- -- This does not handle I/O exceptions. writeUnicodeWidthTable :: FilePath -> UnicodeWidthTable -> IO () -- | Vty provides interfaces for both terminal input and terminal output. -- -- -- -- Vty uses threads internally, so programs made with Vty need to be -- compiled with the threaded runtime using the GHC -threaded -- option. -- -- 
--   import Graphics.Vty
--   
--   main = do
--       cfg <- standardIOConfig
--       vty <- mkVty cfg
--       let line0 = string (defAttr ` withForeColor ` green) "first line"
--           line1 = string (defAttr ` withBackColor ` blue) "second line"
--           img = line0 <-> line1
--           pic = picForImage img
--       update vty pic
--       e <- nextEvent vty
--       shutdown vty
--       print ("Last event was: " ++ show e)
--
module Graphics.Vty -- | A Vty value represents a handle to the Vty library that the -- application must create in order to use Vty. -- -- The use of Vty typically follows this process: -- --
    --
  1. Initialize vty with mkVty (this takes control of the -- terminal).
    2. --
  2. Use update to display a picture.
    3. --
  3. Use nextEvent to get the next input event.
    4. --
  4. Depending on the event, go to 2 or 5.
    5. --
  5. Shutdown vty and restore the terminal state with shutdown. -- At this point the Vty handle cannot be used again.
    6. --
-- -- Operations on Vty handles are not thread-safe. data Vty Vty :: (Picture -> IO ()) -> IO Event -> IO (Maybe Event) -> Input -> Output -> IO () -> IO () -> IO Bool -> Vty -- | Outputs the given Picture. [update] :: Vty -> Picture -> IO () -- | Return the next Event or block until one becomes available. [nextEvent] :: Vty -> IO Event -- | Non-blocking version of nextEvent. [nextEventNonblocking] :: Vty -> IO (Maybe Event) -- | The input interface. See Input. [inputIface] :: Vty -> Input -- | The output interface. See Output. [outputIface] :: Vty -> Output -- | Refresh the display. If other programs output to the terminal and mess -- up the display then the application might want to force a refresh -- using this function. [refresh] :: Vty -> IO () -- | Clean up after vty. A call to this function is necessary to cleanly -- restore the terminal state before application exit. The above methods -- will throw an exception if executed after this is executed. -- Idempotent. [shutdown] :: Vty -> IO () [isShutdown] :: Vty -> IO Bool -- | Create a Vty handle. At most one handle should be created at a time -- for a given terminal device. -- -- The specified configuration is added to the the configuration loaded -- by userConfig with the userConfig configuration taking -- precedence. See Graphics.Vty.Config. -- -- For most applications mkVty defaultConfig is sufficient. mkVty :: Config -> IO Vty -- | Set the terminal window title string. -- -- This function emits an Xterm-compatible escape sequence that we -- anticipate will work for essentially all modern terminal emulators. -- Ideally we'd use a terminal capability for this, but there does not -- seem to exist a termcap for setting window titles. If you find that -- this function does not work for a given terminal emulator, please -- report the issue. -- -- For details, see: -- -- https://tldp.org/HOWTO/Xterm-Title-3.html setWindowTitle :: Vty -> String -> IO () -- | Modal terminal features that can be enabled and disabled. data Mode -- | Mouse mode (whether the terminal is configured to provide mouse input -- events) Mouse :: Mode -- | Paste mode (whether the terminal is configured to provide events on OS -- pastes) BracketedPaste :: Mode -- | Focus-in/focus-out events (whether the terminal is configured to -- provide events on focus change) Focus :: Mode -- | Hyperlink mode via the withURL attribute modifier (see -- https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda). -- Note that this may not work gracefully in all terminal emulators so be -- sure to test this mode with the terminals you intend to support. It is -- off by default. Hyperlink :: Mode -- | The inline module provides a limited interface to changing the style -- of terminal output. The intention is for this interface to be used -- inline with other output systems. -- -- The changes specified by the InlineM monad are applied to the -- terminal's display attributes. These display attributes affect the -- display of all following text output to the terminal file descriptor. -- -- For example, in an IO monad the following code will print the text -- "Not styled. " Followed by the text " Styled! " drawn over a red -- background and underlined. -- -- 
--   putStr "Not styled. "
--   putAttrChange_ $ do
--       backColor red
--       applyStyle underline
--   putStr " Styled! "
--   putAttrChange_ $ defaultAll
--   putStrLn "Not styled."
--
-- -- putAttrChange emits the control codes to the terminal device -- attached to Handle. This is a duplicate of the stdout -- handle when the terminalHandle was (first) acquired. If -- stdout has since been changed then putStr, -- putStrLn, print etc. will output to a different -- Handle than putAttrChange. -- -- Copyright 2009-2010 Corey O'Connor module Graphics.Vty.Inline data InlineState InlineState :: Attr -> Bool -> InlineState [inlineAttr] :: InlineState -> Attr [inlineUrlsEnabled] :: InlineState -> Bool type InlineM v = State InlineState v -- | Set the background color to the provided Color. backColor :: Color -> InlineM () -- | Set the foreground color to the provided Color. foreColor :: Color -> InlineM () -- | Attempt to change the Style of the following text.. -- -- If the terminal does not support the style change then no error is -- produced. The style can still be removed. applyStyle :: Style -> InlineM () -- | Attempt to remove the specified Style from the display of the -- following text. -- -- This will fail if applyStyle for the given style has not been -- previously called. removeStyle :: Style -> InlineM () -- | Reset the display attributes. defaultAll :: InlineM () -- | Apply the provided display attribute changes to the given terminal -- output device. -- -- This does not flush the terminal. putAttrChange :: (Applicative m, MonadIO m) => Output -> InlineM () -> m () -- | Apply the provided display attributes changes to the terminal output -- device. -- -- This will flush the terminal output. putAttrChange_ :: (Applicative m, MonadIO m) => InlineM () -> m () -- | This will create a Vty instance using mkVty and execute an IO -- action provided that instance. The created Vty instance will be stored -- to the unsafe IORef globalVty. -- -- This instance will use duplicates of the stdin and stdout Handles. withVty :: (Vty -> IO b) -> IO b