Maintainer	judah.jacobson@gmail.com
Stability	experimental
Portability	portable (FFI)
Safe Haskell	Trustworthy
Language	Haskell2010

System.Console.Terminfo.Base

Contents

Initialization
Capabilities
Output
- TermOutput
- Monoid functions

Description

This module provides a low-level interface to the C functions of the terminfo library.

NOTE: Since this library is built on top of the curses interface, it is not thread-safe.

Synopsis

data Terminal
setupTerm :: String -> IO Terminal
setupTermFromEnv :: IO Terminal
data SetupTermError
data Capability a
getCapability :: Terminal -> Capability a -> Maybe a
tiGetFlag :: String -> Capability Bool
tiGuardFlag :: String -> Capability ()
tiGetNum :: String -> Capability Int
tiGetStr :: String -> Capability String
tiGetOutput1 :: forall f. OutputCap f => String -> Capability f
class OutputCap f
class (Monoid s, OutputCap s) => TermStr s
data TermOutput
runTermOutput :: Terminal -> TermOutput -> IO ()
hRunTermOutput :: Handle -> Terminal -> TermOutput -> IO ()
termText :: String -> TermOutput
tiGetOutput :: String -> Capability ([Int] -> LinesAffected -> TermOutput)
type LinesAffected = Int
class Semigroup a => Monoid a where
- mempty :: a
- mappend :: a -> a -> a
- mconcat :: [a] -> a
(<#>) :: Monoid m => m -> m -> m

Initialization

data Terminal Source #

Terminal objects are automatically freed by the garbage collector. Hence, there is no equivalent of del_curterm here.

setupTerm :: String -> IO Terminal Source #

Initialize the terminfo library to the given terminal entry.

Throws a SetupTermError if the terminfo database could not be read.

Note:* ncurses is not thread-safe; initializing or using multiple Terminals in different threads at the same time can result in memory unsafety.

setupTermFromEnv :: IO Terminal Source #

Initialize the terminfo library, using the TERM environmental variable. If TERM is not set, we use the generic, minimal entry dumb.

Throws a SetupTermError if the terminfo database could not be read.

data SetupTermError Source #

Instances

Instances details

Exception SetupTermError Source #
Instance details Defined in System.Console.Terminfo.Base Methods toException :: SetupTermError -> SomeException # fromException :: SomeException -> Maybe SetupTermError # displayException :: SetupTermError -> String #
Show SetupTermError Source #
Instance details Defined in System.Console.Terminfo.Base Methods showsPrec :: Int -> SetupTermError -> ShowS # show :: SetupTermError -> String # showList :: [SetupTermError] -> ShowS #

Capabilities

data Capability a Source #

A feature or operation which a Terminal may define.

Instances

Instances details

Alternative Capability Source #
Instance details Defined in System.Console.Terminfo.Base Methods empty :: Capability a # (<\|>) :: Capability a -> Capability a -> Capability a # some :: Capability a -> Capability [a] # many :: Capability a -> Capability [a] #
Applicative Capability Source #
Instance details Defined in System.Console.Terminfo.Base Methods pure :: a -> Capability a # (<>) :: Capability (a -> b) -> Capability a -> Capability b # liftA2 :: (a -> b -> c) -> Capability a -> Capability b -> Capability c # (>) :: Capability a -> Capability b -> Capability b # (<*) :: Capability a -> Capability b -> Capability a #
Functor Capability Source #
Instance details Defined in System.Console.Terminfo.Base Methods fmap :: (a -> b) -> Capability a -> Capability b # (<$) :: a -> Capability b -> Capability a #
Monad Capability Source #
Instance details Defined in System.Console.Terminfo.Base Methods (>>=) :: Capability a -> (a -> Capability b) -> Capability b # (>>) :: Capability a -> Capability b -> Capability b # return :: a -> Capability a #
MonadPlus Capability Source #
Instance details Defined in System.Console.Terminfo.Base Methods mzero :: Capability a # mplus :: Capability a -> Capability a -> Capability a #

getCapability :: Terminal -> Capability a -> Maybe a Source #

tiGetFlag :: String -> Capability Bool Source #

Look up a boolean capability in the terminfo database.

Unlike tiGuardFlag, this capability never fails; it returns False if the capability is absent or set to false, and returns True otherwise.

tiGuardFlag :: String -> Capability () Source #

Look up a boolean capability in the terminfo database, and fail if it's not defined.

tiGetNum :: String -> Capability Int Source #

Look up a numeric capability in the terminfo database.

tiGetStr :: String -> Capability String Source #

Deprecated: use tiGetOutput instead.

Look up a string capability in the terminfo database. NOTE: This function is deprecated; use tiGetOutput1 instead.

Output

Terminfo contains many string capabilities for special effects. For example, the cuu1 capability moves the cursor up one line; on ANSI terminals this is accomplished by printing the control sequence "\ESC[A". However, some older terminals also require "padding", or short pauses, after certain commands. For example, when TERM=vt100 the cuu1 capability is "\ESC[A$<2>", which instructs terminfo to pause for two milliseconds after outputting the control sequence.

The TermOutput monoid abstracts away all padding and control sequence output. Unfortunately, that datatype is difficult to integrate into existing String-based APIs such as pretty-printers. Thus, as a workaround, tiGetOutput1 also lets us access the control sequences as Strings. The one caveat is that it will not allow you to access padded control sequences as Strings. For example:

> t <- setupTerm "vt100"
> isJust (getCapability t (tiGetOutput1 "cuu1") :: Maybe String)
False
> isJust (getCapability t (tiGetOutput1 "cuu1") :: Maybe TermOutput)
True

String capabilities will work with software-based terminal types such as xterm and linux. However, you should use TermOutput if compatibility with older terminals is important. Additionally, the visualBell capability which flashes the screen usually produces its effect with a padding directive, so it will only work with TermOutput.

tiGetOutput1 :: forall f. OutputCap f => String -> Capability f Source #

Look up an output capability which takes a fixed number of parameters (for example, Int -> Int -> TermOutput).

For capabilities which may contain variable-length padding, use tiGetOutput instead.

class OutputCap f Source #

Minimal complete definition

hasOkPadding, outputCap

Instances

Instances details

OutputCap TermOutput Source #
Instance details Defined in System.Console.Terminfo.Base Methods hasOkPadding :: TermOutput -> String -> Bool outputCap :: ([Int] -> String) -> [Int] -> TermOutput
OutputCap [Char] Source #
Instance details Defined in System.Console.Terminfo.Base Methods hasOkPadding :: [Char] -> String -> Bool outputCap :: ([Int] -> String) -> [Int] -> [Char]
(Enum p, OutputCap f) => OutputCap (p -> f) Source #
Instance details Defined in System.Console.Terminfo.Base Methods hasOkPadding :: (p -> f) -> String -> Bool outputCap :: ([Int] -> String) -> [Int] -> p -> f

class (Monoid s, OutputCap s) => TermStr s Source #

Instances

Instances details

TermStr TermOutput Source #
Instance details Defined in System.Console.Terminfo.Base
TermStr [Char] Source #
Instance details Defined in System.Console.Terminfo.Base

TermOutput

data TermOutput Source #

An action which sends output to the terminal. That output may mix plain text with control characters and escape sequences, along with delays (called "padding") required by some older terminals.

Instances

Instances details

Monoid TermOutput Source #
Instance details Defined in System.Console.Terminfo.Base Methods mempty :: TermOutput # mappend :: TermOutput -> TermOutput -> TermOutput # mconcat :: [TermOutput] -> TermOutput #
Semigroup TermOutput Source #
Instance details Defined in System.Console.Terminfo.Base Methods (<>) :: TermOutput -> TermOutput -> TermOutput # sconcat :: NonEmpty TermOutput -> TermOutput # stimes :: Integral b => b -> TermOutput -> TermOutput #
OutputCap TermOutput Source #
Instance details Defined in System.Console.Terminfo.Base Methods hasOkPadding :: TermOutput -> String -> Bool outputCap :: ([Int] -> String) -> [Int] -> TermOutput
TermStr TermOutput Source #
Instance details Defined in System.Console.Terminfo.Base

runTermOutput :: Terminal -> TermOutput -> IO () Source #

Write the terminal output to the standard output device.

hRunTermOutput :: Handle -> Terminal -> TermOutput -> IO () Source #

Write the terminal output to the terminal or file managed by the given Handle.

termText :: String -> TermOutput Source #

tiGetOutput :: String -> Capability ([Int] -> LinesAffected -> TermOutput) Source #

Look up an output capability in the terminfo database.

type LinesAffected = Int Source #

A parameter to specify the number of lines affected. Some capabilities (e.g., clear and dch1) use this parameter on some terminals to compute variable-length padding.

Monoid functions

class Semigroup a => Monoid a where #

The class of monoids (types with an associative binary operation that has an identity). Instances should satisfy the following:

Right identity: x <> mempty = x
Left identity: mempty <> x = x
Associativity: x <> (y <> z) = (x <> y) <> z (Semigroup law)
Concatenation: mconcat = foldr (<>) mempty

The method names refer to the monoid of lists under concatenation, but there are many other instances.

Some types can be viewed as a monoid in more than one way, e.g. both addition and multiplication on numbers. In such cases we often define newtypes and make those instances of Monoid, e.g. Sum and Product.

NOTE: Semigroup is a superclass of Monoid since base-4.11.0.0.

Minimal complete definition

mempty

Methods

mempty :: a #

Identity of mappend

>>> "Hello world" <> mempty
"Hello world"

mappend :: a -> a -> a #

An associative operation

NOTE: This method is redundant and has the default implementation mappend = (<>) since base-4.11.0.0. Should it be implemented manually, since mappend is a synonym for (<>), it is expected that the two functions are defined the same way. In a future GHC release mappend will be removed from Monoid.

mconcat :: [a] -> a #

Fold a list using the monoid.

For most types, the default definition for mconcat will be used, but the function is included in the class definition so that an optimized version can be provided for specific types.

>>> mconcat ["Hello", " ", "Haskell", "!"]
"Hello Haskell!"

Instances

Instances details

Monoid All	Since: base-2.1
Instance details Defined in Data.Semigroup.Internal Methods mempty :: All # mappend :: All -> All -> All # mconcat :: [All] -> All #
Monoid Any	Since: base-2.1
Instance details Defined in Data.Semigroup.Internal Methods mempty :: Any # mappend :: Any -> Any -> Any # mconcat :: [Any] -> Any #
Monoid Ordering	Since: base-2.1
Instance details Defined in GHC.Base Methods mempty :: Ordering # mappend :: Ordering -> Ordering -> Ordering # mconcat :: [Ordering] -> Ordering #
Monoid TermOutput Source #
Instance details Defined in System.Console.Terminfo.Base Methods mempty :: TermOutput # mappend :: TermOutput -> TermOutput -> TermOutput # mconcat :: [TermOutput] -> TermOutput #
Monoid ()	Since: base-2.1
Instance details Defined in GHC.Base Methods mempty :: () # mappend :: () -> () -> () # mconcat :: [()] -> () #
(Ord a, Bounded a) => Monoid (Max a)	Since: base-4.9.0.0
Instance details Defined in Data.Semigroup Methods mempty :: Max a # mappend :: Max a -> Max a -> Max a # mconcat :: [Max a] -> Max a #
(Ord a, Bounded a) => Monoid (Min a)	Since: base-4.9.0.0
Instance details Defined in Data.Semigroup Methods mempty :: Min a # mappend :: Min a -> Min a -> Min a # mconcat :: [Min a] -> Min a #
Monoid m => Monoid (WrappedMonoid m)	Since: base-4.9.0.0
Instance details Defined in Data.Semigroup Methods mempty :: WrappedMonoid m # mappend :: WrappedMonoid m -> WrappedMonoid m -> WrappedMonoid m # mconcat :: [WrappedMonoid m] -> WrappedMonoid m #
Monoid a => Monoid (Dual a)	Since: base-2.1
Instance details Defined in Data.Semigroup.Internal Methods mempty :: Dual a # mappend :: Dual a -> Dual a -> Dual a # mconcat :: [Dual a] -> Dual a #
Monoid (Endo a)	Since: base-2.1
Instance details Defined in Data.Semigroup.Internal Methods mempty :: Endo a # mappend :: Endo a -> Endo a -> Endo a # mconcat :: [Endo a] -> Endo a #
Num a => Monoid (Product a)	Since: base-2.1
Instance details Defined in Data.Semigroup.Internal Methods mempty :: Product a # mappend :: Product a -> Product a -> Product a # mconcat :: [Product a] -> Product a #
Num a => Monoid (Sum a)	Since: base-2.1
Instance details Defined in Data.Semigroup.Internal Methods mempty :: Sum a # mappend :: Sum a -> Sum a -> Sum a # mconcat :: [Sum a] -> Sum a #
Monoid a => Monoid (IO a)	Since: base-4.9.0.0
Instance details Defined in GHC.Base Methods mempty :: IO a # mappend :: IO a -> IO a -> IO a # mconcat :: [IO a] -> IO a #
Semigroup a => Monoid (Maybe a)	Lift a semigroup into `Maybe` forming a `Monoid` according to http://en.wikipedia.org/wiki/Monoid: "Any semigroup `S` may be turned into a monoid simply by adjoining an element `e` not in `S` and defining `ee = e` and `es = s = se` for all `s ∈ S`." Since 4.11.0: constraint on inner `a` value generalised from `Monoid` to `Semigroup`. Since: base-2.1*
Instance details Defined in GHC.Base Methods mempty :: Maybe a # mappend :: Maybe a -> Maybe a -> Maybe a # mconcat :: [Maybe a] -> Maybe a #
Monoid a => Monoid (a)	Since: base-4.15
Instance details Defined in GHC.Base Methods mempty :: (a) # mappend :: (a) -> (a) -> (a) # mconcat :: [(a)] -> (a) #
Monoid [a]	Since: base-2.1
Instance details Defined in GHC.Base Methods mempty :: [a] # mappend :: [a] -> [a] -> [a] # mconcat :: [[a]] -> [a] #
Monoid (Proxy s)	Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods mempty :: Proxy s # mappend :: Proxy s -> Proxy s -> Proxy s # mconcat :: [Proxy s] -> Proxy s #
Monoid b => Monoid (a -> b)	Since: base-2.1
Instance details Defined in GHC.Base Methods mempty :: a -> b # mappend :: (a -> b) -> (a -> b) -> a -> b # mconcat :: [a -> b] -> a -> b #
(Monoid a, Monoid b) => Monoid (a, b)	Since: base-2.1
Instance details Defined in GHC.Base Methods mempty :: (a, b) # mappend :: (a, b) -> (a, b) -> (a, b) # mconcat :: [(a, b)] -> (a, b) #
Monoid a => Monoid (Const a b)	Since: base-4.9.0.0
Instance details Defined in Data.Functor.Const Methods mempty :: Const a b # mappend :: Const a b -> Const a b -> Const a b # mconcat :: [Const a b] -> Const a b #
Alternative f => Monoid (Alt f a)	Since: base-4.8.0.0
Instance details Defined in Data.Semigroup.Internal Methods mempty :: Alt f a # mappend :: Alt f a -> Alt f a -> Alt f a # mconcat :: [Alt f a] -> Alt f a #
(Monoid a, Monoid b, Monoid c) => Monoid (a, b, c)	Since: base-2.1
Instance details Defined in GHC.Base Methods mempty :: (a, b, c) # mappend :: (a, b, c) -> (a, b, c) -> (a, b, c) # mconcat :: [(a, b, c)] -> (a, b, c) #
(Monoid a, Monoid b, Monoid c, Monoid d) => Monoid (a, b, c, d)	Since: base-2.1
Instance details Defined in GHC.Base Methods mempty :: (a, b, c, d) # mappend :: (a, b, c, d) -> (a, b, c, d) -> (a, b, c, d) # mconcat :: [(a, b, c, d)] -> (a, b, c, d) #
(Monoid a, Monoid b, Monoid c, Monoid d, Monoid e) => Monoid (a, b, c, d, e)	Since: base-2.1
Instance details Defined in GHC.Base Methods mempty :: (a, b, c, d, e) # mappend :: (a, b, c, d, e) -> (a, b, c, d, e) -> (a, b, c, d, e) # mconcat :: [(a, b, c, d, e)] -> (a, b, c, d, e) #

(<#>) :: Monoid m => m -> m -> m infixl 2 Source #

An operator version of mappend.