git.iko.soy/vty
on cd6747c help sign in
vty/src/Graphics/Vty/Terminal.hs
140 lines 6.5 kB history raw
1-- | Generic Terminal interface.
2--
3-- Defines the common interface supported by all terminals.
4--
5-- See also:
6--
7-- 1. Graphics.Vty.Terminal: This instantiates an abtract interface to the terminal interface based
8-- on the TERM and COLORTERM environment variables.
9--
10-- 2. Graphics.Vty.Terminal.Generic: Defines the generic interface all terminals need to implement.
11--
12-- 3. Graphics.Vty.Terminal.TerminfoBased: Defines a terminal instance that uses terminfo for all
13-- control strings. No attempt is made to change the character set to UTF-8 for these terminals.
14-- I don't know a way to reliably determine if that is required or how to do so.
15--
16-- 4. Graphics.Vty.Terminal.XTermColor: This module contains an interface suitable for xterm-like
17-- terminals. These are the terminals where TERM == xterm. This does use terminfo for as many
18-- control codes as possible.
19--
20-- Copyright 2009-2010 Corey O'Connor
21{-# LANGUAGE ScopedTypeVariables #-}
22module Graphics.Vty.Terminal ( module Graphics.Vty.Terminal
23 , Terminal(..)
24 , TerminalHandle(..)
25 , DisplayHandle(..)
26 , output_picture
27 , display_context
28 )
29 where
32import Graphics.Vty.DisplayRegion
33import Graphics.Vty.Terminal.Generic
34import Graphics.Vty.Terminal.MacOSX as MacOSX
35import Graphics.Vty.Terminal.XTermColor as XTermColor
36import Graphics.Vty.Terminal.TerminfoBased as TerminfoBased
38import Control.Applicative
39import Control.Exception ( SomeException, try )
40import Control.Monad
41import Control.Monad.Trans
43import Data.List ( isPrefixOf )
44import Data.Word
46import System.Environment
48-- | Returns a TerminalHandle (an abstract Terminal instance) for the current terminal.
49--
50-- The specific Terminal implementation used is hidden from the API user. All terminal
51-- implementations are assumed to perform more, or less, the same. Currently all implementations use
52-- terminfo for at least some terminal specific information. This is why platforms without terminfo
53-- are not supported. However, as mentioned before, any specifics about it being based on terminfo
54-- are hidden from the API user. If a terminal implementation is developed for a terminal for a
55-- platform without terminfo support then Vty should work as expected on that terminal.
56--
57-- Selection of a terminal is done as follows:
58--
59-- * If TERM == xterm
60-- then the terminal might be one of the Mac OS X .app terminals. Check if that might be
61-- the case and use MacOSX if so.
62-- otherwise use XTermColor.
63--
64-- * for any other TERM value TerminfoBased is used.
65--
66--
67-- The terminal has to be determined dynamically at runtime. To satisfy this requirement all
68-- terminals instances are lifted into an abstract terminal handle via existential qualification.
69-- This implies that the only equations that can used are those in the terminal class.
70--
71-- To differentiate between Mac OS X terminals this uses the TERM_PROGRAM environment variable.
72-- However, an xterm started by Terminal or iTerm *also* has TERM_PROGRAM defined since the
73-- environment variable is not reset/cleared by xterm. However a Terminal.app or iTerm.app started
74-- from an xterm under X11 on mac os x will likely be done via open. Since this does not propogate
75-- environment variables (I think?) this assumes that XTERM_VERSION will never be set for a true
76-- Terminal.app or iTerm.app session.
77--
78--
79-- The file descriptor used for output will a duplicate of the current stdout file descriptor.
80--
81-- todo: add an implementation for windows that does not depend on terminfo. Should be installable
82-- with only what is provided in the haskell platform.
83--
84-- todo: The Terminal interface does not provide any input support.
85terminal_handle :: ( Applicative m, MonadIO m ) => m TerminalHandle
86terminal_handle = do
87 term_type <- liftIO $ getEnv "TERM"
88 t <- if "xterm" `isPrefixOf` term_type
89 then do
90 maybe_terminal_app <- get_env "TERM_PROGRAM"
91 case maybe_terminal_app of
92 Nothing
93 -> XTermColor.terminal_instance term_type >>= new_terminal_handle
94 Just v | v == "Apple_Terminal" || v == "iTerm.app"
95 -> do
96 maybe_xterm <- get_env "XTERM_VERSION"
97 case maybe_xterm of
98 Nothing -> MacOSX.terminal_instance v >>= new_terminal_handle
99 Just _ -> XTermColor.terminal_instance term_type >>= new_terminal_handle
100 -- Assume any other terminal that sets TERM_PROGRAM to not be an OS X terminal.app
101 -- like terminal?
102 _ -> XTermColor.terminal_instance term_type >>= new_terminal_handle
103 -- Not an xterm-like terminal. try for generic terminfo.
104 else TerminfoBased.terminal_instance term_type >>= new_terminal_handle
105 return t
106 where
107 get_env var = do
108 mv <- liftIO $ try $ getEnv var
109 case mv of
110 Left (_e :: SomeException) -> return $ Nothing
111 Right v -> return $ Just v
113-- | Sets the cursor position to the given output column and row.
114--
115-- This is not necessarially the same as the character position with the same coordinates.
116-- Characters can be a variable number of columns in width.
117--
118-- Currently, the only way to set the cursor position to a given character coordinate is to specify
119-- the coordinate in the Picture instance provided to output_picture or refresh.
120set_cursor_pos :: MonadIO m => TerminalHandle -> Int -> Int -> m ()
121set_cursor_pos t x y = do
122 bounds <- display_bounds t
123 when (x >= 0 && x < region_width bounds && y >= 0 && y < region_height bounds) $ do
124 d <- display_context t bounds
125 liftIO $ marshall_to_terminal t (move_cursor_required_bytes d x y) (serialize_move_cursor d x y)
127-- | Hides the cursor
128hide_cursor :: MonadIO m => TerminalHandle -> m ()
129hide_cursor t = do
130 bounds <- display_bounds t
131 d <- display_context t bounds
132 liftIO $ marshall_to_terminal t (hide_cursor_required_bytes d) (serialize_hide_cursor d)
134-- | Shows the cursor
135show_cursor :: MonadIO m => TerminalHandle -> m ()
136show_cursor t = do
137 bounds <- display_bounds t
138 d <- display_context t bounds
139 liftIO $ marshall_to_terminal t (show_cursor_required_bytes d) (serialize_show_cursor d)