-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Haskell bindings to the terminfo library.
--   
--   This library provides an interface to the terminfo database (via
--   bindings to the curses library). Terminfo allows POSIX systems to
--   interact with a variety of terminals using a standard set of
--   capabilities.
@package terminfo
@version 0.3.1.3


-- | 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.
module System.Console.Terminfo.Base
data Terminal

-- | Initialize the terminfo library to the given terminal entry.
--   
--   Throws a <a>SetupTermError</a> if the terminfo database could not be
--   read.
setupTerm :: String -> IO Terminal

-- | Initialize the terminfo library, using the <tt>TERM</tt> environmental
--   variable. If <tt>TERM</tt> is not set, we use the generic, minimal
--   entry <tt>dumb</tt>.
--   
--   Throws a <a>SetupTermError</a> if the terminfo database could not be
--   read.
setupTermFromEnv :: IO Terminal
data SetupTermError

-- | A feature or operation which a <a>Terminal</a> may define.
data Capability a
getCapability :: Terminal -> Capability a -> Maybe a

-- | Look up a boolean capability in the terminfo database.
--   
--   Unlike <a>tiGuardFlag</a>, this capability never fails; it returns
--   <a>False</a> if the capability is absent or set to false, and returns
--   <a>True</a> otherwise.
tiGetFlag :: String -> Capability Bool

-- | Look up a boolean capability in the terminfo database, and fail if
--   it's not defined.
tiGuardFlag :: String -> Capability ()

-- | Look up a numeric capability in the terminfo database.
tiGetNum :: String -> Capability Int

-- | Look up a string capability in the terminfo database. NOTE: This
--   function is deprecated; use <a>tiGetOutput1</a> instead.
tiGetStr :: String -> Capability String

-- | Look up an output capability which takes a fixed number of parameters
--   (for example, <tt>Int -&gt; Int -&gt; TermOutput</tt>).
--   
--   For capabilities which may contain variable-length padding, use
--   <a>tiGetOutput</a> instead.
tiGetOutput1 :: OutputCap f => String -> Capability f
class OutputCap f
class (Monoid s, OutputCap s) => TermStr s

-- | 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.
data TermOutput

-- | Write the terminal output to the standard output device.
runTermOutput :: Terminal -> TermOutput -> IO ()

-- | Write the terminal output to the terminal or file managed by the given
--   <a>Handle</a>.
hRunTermOutput :: Handle -> Terminal -> TermOutput -> IO ()
termText :: String -> TermOutput

-- | Look up an output capability in the terminfo database.
tiGetOutput :: String -> Capability ([Int] -> LinesAffected -> TermOutput)

-- | A parameter to specify the number of lines affected. Some capabilities
--   (e.g., <tt>clear</tt> and <tt>dch1</tt>) use this parameter on some
--   terminals to compute variable-length padding.
type LinesAffected = Int

-- | The class of monoids (types with an associative binary operation that
--   has an identity). Instances should satisfy the following laws:
--   
--   <ul>
--   <li><pre>mappend mempty x = x</pre></li>
--   <li><pre>mappend x mempty = x</pre></li>
--   <li><pre>mappend x (mappend y z) = mappend (mappend x y) z</pre></li>
--   <li><pre>mconcat = <a>foldr</a> mappend mempty</pre></li>
--   </ul>
--   
--   The method names refer to the monoid of lists under concatenation, but
--   there are many other instances.
--   
--   Minimal complete definition: <a>mempty</a> and <a>mappend</a>.
--   
--   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
--   <tt>newtype</tt>s and make those instances of <a>Monoid</a>, e.g.
--   <a>Sum</a> and <a>Product</a>.
class Monoid a
mempty :: Monoid a => a
mappend :: Monoid a => a -> a -> a
mconcat :: Monoid a => [a] -> a

-- | An operator version of <a>mappend</a>.
(<#>) :: Monoid m => m -> m -> m
instance Typeable SetupTermError
instance TermStr TermOutput
instance TermStr [Char]
instance (Enum p, OutputCap f) => OutputCap (p -> f)
instance OutputCap TermOutput
instance OutputCap [Char]
instance MonadPlus Capability
instance Monad Capability
instance Functor Capability
instance Monoid TermOutput
instance Exception SetupTermError
instance Show SetupTermError


-- | The string capabilities in this module are the character sequences
--   corresponding to user input such as arrow keys and function keys.
module System.Console.Terminfo.Keys
keypadOn :: TermStr s => Capability s
keypadOff :: TermStr s => Capability s
keyUp :: Capability String
keyDown :: Capability String
keyLeft :: Capability String
keyRight :: Capability String

-- | Look up the control sequence for a given function sequence. For
--   example, <tt>functionKey 12</tt> retrieves the <tt>kf12</tt>
--   capability.
functionKey :: Int -> Capability String
keyBackspace :: Capability String
keyDeleteChar :: Capability String
keyHome :: Capability String
keyEnd :: Capability String
keyPageUp :: Capability String
keyPageDown :: Capability String
keyEnter :: Capability String


-- | This module provides capabilities for moving the cursor on the
--   terminal.
module System.Console.Terminfo.Cursor
termLines :: Capability Int
termColumns :: Capability Int

-- | This flag specifies that the cursor wraps automatically from the last
--   column of one line to the first column of the next.
autoRightMargin :: Capability Bool

-- | This flag specifies that a backspace at column 0 wraps the cursor to
--   the last column of the previous line.
autoLeftMargin :: Capability Bool

-- | This flag specifies that the terminal does not perform
--   <a>autoRightMargin</a>-style wrapping when the character which would
--   cause the wraparound is a control character. This is also known as the
--   "newline glitch" or "magic wrap".
--   
--   For example, in an 80-column terminal with this behavior, the
--   following will print single-spaced instead of double-spaced:
--   
--   <pre>
--   replicateM_ 5 $ putStr $ replicate 80 'x' ++ "\n"
--   </pre>
wraparoundGlitch :: Capability Bool

-- | The <tt>cr</tt> capability, which moves the cursor to the first column
--   of the current line.
carriageReturn :: TermStr s => Capability s

-- | The <tt>nel</tt> capability, which moves the cursor to the first
--   column of the next line. It behaves like a carriage return followed by
--   a line feed.
--   
--   If <tt>nel</tt> is not defined, this may be built out of other
--   capabilities.
newline :: TermStr s => Capability s
scrollForward :: TermStr s => Capability s
scrollReverse :: TermStr s => Capability s
moveDown :: TermStr s => Capability (Int -> s)
moveLeft :: TermStr s => Capability (Int -> s)
moveRight :: TermStr s => Capability (Int -> s)
moveUp :: TermStr s => Capability (Int -> s)
cursorDown1 :: TermStr s => Capability s
cursorLeft1 :: TermStr s => Capability s
cursorRight1 :: TermStr s => Capability s
cursorUp1 :: TermStr s => Capability s
cursorDown :: TermStr s => Capability (Int -> s)
cursorLeft :: TermStr s => Capability (Int -> s)
cursorRight :: TermStr s => Capability (Int -> s)
cursorUp :: TermStr s => Capability (Int -> s)
cursorHome :: TermStr s => Capability s
cursorToLL :: TermStr s => Capability s
cursorAddress :: TermStr s => Capability (Point -> s)
data Point
Point :: Int -> Int -> Point
row :: Point -> Int
col :: Point -> Int
rowAddress :: TermStr s => Capability (Int -> s)
columnAddress :: TermStr s => Capability (Int -> s)


module System.Console.Terminfo.Effects

-- | Sound the audible bell.
bell :: TermStr s => Capability s

-- | Present a visual alert using the <tt>flash</tt> capability.
visualBell :: Capability TermOutput
data Attributes
Attributes :: Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Attributes
standoutAttr :: Attributes -> Bool
underlineAttr :: Attributes -> Bool
reverseAttr :: Attributes -> Bool
blinkAttr :: Attributes -> Bool
dimAttr :: Attributes -> Bool
boldAttr :: Attributes -> Bool
invisibleAttr :: Attributes -> Bool
protectedAttr :: Attributes -> Bool

-- | These attributes have all properties turned off.
defaultAttributes :: Attributes

-- | Sets the attributes on or off before outputting the given text, and
--   then turns them all off. This capability will always succeed;
--   properties which cannot be set in the current terminal will be
--   ignored.
withAttributes :: TermStr s => Capability (Attributes -> s -> s)

-- | Sets the attributes on or off. This capability will always succeed;
--   properties which cannot be set in the current terminal will be
--   ignored.
setAttributes :: TermStr s => Capability (Attributes -> s)

-- | Turns off all text attributes. This capability will always succeed,
--   but it has no effect in terminals which do not support text
--   attributes.
allAttributesOff :: TermStr s => Capability s

-- | Turns on standout mode before outputting the given text, and then
--   turns it off.
withStandout :: TermStr s => Capability (s -> s)

-- | Turns on underline mode before outputting the given text, and then
--   turns it off.
withUnderline :: TermStr s => Capability (s -> s)

-- | Turns on bold mode before outputting the given text, and then turns
--   all attributes off.
withBold :: TermStr s => Capability (s -> s)
enterStandoutMode :: TermStr s => Capability s
exitStandoutMode :: TermStr s => Capability s
enterUnderlineMode :: TermStr s => Capability s
exitUnderlineMode :: TermStr s => Capability s
reverseOn :: TermStr s => Capability s
blinkOn :: TermStr s => Capability s
boldOn :: TermStr s => Capability s
dimOn :: TermStr s => Capability s
invisibleOn :: TermStr s => Capability s
protectedOn :: TermStr s => Capability s


module System.Console.Terminfo.Edit

-- | Clear the screen, and move the cursor to the upper left.
clearScreen :: Capability (LinesAffected -> TermOutput)

-- | Clear from beginning of line to cursor.
clearBOL :: TermStr s => Capability s

-- | Clear from cursor to end of line.
clearEOL :: TermStr s => Capability s

-- | Clear display after cursor.
clearEOS :: Capability (LinesAffected -> TermOutput)


module System.Console.Terminfo.Color

-- | The maximum number of of colors on the screen.
termColors :: Capability Int
data Color
Black :: Color
Red :: Color
Green :: Color
Yellow :: Color
Blue :: Color
Magenta :: Color
Cyan :: Color
White :: Color
ColorNumber :: Int -> Color

-- | This capability temporarily sets the terminal's foreground color while
--   outputting the given text, and then restores the terminal to its
--   default foreground and background colors.
withForegroundColor :: TermStr s => Capability (Color -> s -> s)

-- | This capability temporarily sets the terminal's background color while
--   outputting the given text, and then restores the terminal to its
--   default foreground and background colors.
withBackgroundColor :: TermStr s => Capability (Color -> s -> s)

-- | Sets the foreground color of all further text output, using either the
--   <tt>setaf</tt> or <tt>setf</tt> capability.
setForegroundColor :: TermStr s => Capability (Color -> s)

-- | Sets the background color of all further text output, using either the
--   <tt>setab</tt> or <tt>setb</tt> capability.
setBackgroundColor :: TermStr s => Capability (Color -> s)

-- | Restores foreground/background colors to their original settings.
restoreDefaultColors :: TermStr s => Capability s


module System.Console.Terminfo
