Copyright | (c) The University of Glasgow 2002 |
---|---|
License | BSD-style (see the file libraries/base/LICENSE) |
Maintainer | libraries@haskell.org |
Stability | provisional |
Portability | non-portable (requires POSIX) |
Safe Haskell | Safe |
Language | Haskell2010 |
System.Posix.Terminal
Description
POSIX Terminal support
Synopsis
- dataTerminalAttributes
- getTerminalAttributes :: Fd -> IOTerminalAttributes
- dataTerminalState
- setTerminalAttributes :: Fd -> TerminalAttributes -> TerminalState -> IO ()
- dataTerminalMode
- = InterruptOnBreak
- | MapCRtoLF
- | IgnoreBreak
- | IgnoreCR
- | IgnoreParityErrors
- | MapLFtoCR
- | CheckParity
- | StripHighBit
- | StartStopInput
- | StartStopOutput
- | MarkParityErrors
- | ProcessOutput
- | LocalMode
- | ReadEnable
- | TwoStopBits
- | HangupOnClose
- | EnableParity
- | OddParity
- | EnableEcho
- | EchoErase
- | EchoKill
- | EchoLF
- | ProcessInput
- | ExtendedFunctions
- | KeyboardInterrupts
- | NoFlushOnInterrupt
- | BackgroundWriteInterrupt
- withoutMode :: TerminalAttributes -> TerminalMode -> TerminalAttributes
- withMode :: TerminalAttributes -> TerminalMode -> TerminalAttributes
- terminalMode :: TerminalMode -> TerminalAttributes -> Bool
- bitsPerByte :: TerminalAttributes -> Int
- withBits :: TerminalAttributes -> Int -> TerminalAttributes
- dataControlCharacter
- controlChar :: TerminalAttributes -> ControlCharacter -> MaybeChar
- withCC :: TerminalAttributes -> (ControlCharacter, Char) -> TerminalAttributes
- withoutCC :: TerminalAttributes -> ControlCharacter -> TerminalAttributes
- inputTime :: TerminalAttributes -> Int
- withTime :: TerminalAttributes -> Int -> TerminalAttributes
- minInput :: TerminalAttributes -> Int
- withMinInput :: TerminalAttributes -> Int -> TerminalAttributes
- dataBaudRate
- inputSpeed :: TerminalAttributes -> BaudRate
- withInputSpeed :: TerminalAttributes -> BaudRate -> TerminalAttributes
- outputSpeed :: TerminalAttributes -> BaudRate
- withOutputSpeed :: TerminalAttributes -> BaudRate -> TerminalAttributes
- sendBreak :: Fd -> Int -> IO ()
- drainOutput :: Fd -> IO ()
- dataQueueSelector
- discardData :: Fd -> QueueSelector -> IO ()
- dataFlowAction
- controlFlow :: Fd -> FlowAction -> IO ()
- getTerminalProcessGroupID :: Fd -> IOProcessGroupID
- setTerminalProcessGroupID :: Fd -> ProcessGroupID -> IO ()
- queryTerminal :: Fd -> IOBool
- getTerminalName :: Fd -> IOFilePath
- getControllingTerminalName :: IOFilePath
- openPseudoTerminal :: IO (Fd, Fd)
- getSlaveTerminalName :: Fd -> IOFilePath
Terminal support
Terminal attributes
getTerminalAttributes :: Fd -> IOTerminalAttributesSource#
getTerminalAttributes fd
calls tcgetattr
to obtain the TerminalAttributes
associated with Fd
fd
.
Constructors
Immediately | |
WhenDrained | |
WhenFlushed |
setTerminalAttributes :: Fd -> TerminalAttributes -> TerminalState -> IO () Source#
setTerminalAttributes fd attr ts
calls tcsetattr
to change the TerminalAttributes
associated with Fd
fd
to attr
, when the terminal is in the state indicated by ts
.
Constructors
Constructors
B0 | |
B50 | |
B75 | |
B110 | |
B134 | |
B150 | |
B200 | |
B300 | |
B600 | |
B1200 | |
B1800 | |
B2400 | |
B4800 | |
B9600 | |
B19200 | |
B38400 | |
B57600 | |
B115200 |
Terminal operations
sendBreak :: Fd -> Int -> IO () Source#
sendBreak fd duration
calls tcsendbreak
to transmit a continuous stream of zero-valued bits on Fd
fd
for the specified implementation-dependent duration
.
drainOutput :: Fd -> IO () Source#
drainOutput fd
calls tcdrain
to block until all output written to Fd
fd
has been transmitted.
Throws IOError
("unsupported operation") if platform does not provide tcdrain(3)
(use #if HAVE_TCDRAIN
CPP guard to detect availability).
Constructors
InputQueue | |
OutputQueue | |
BothQueues |
discardData :: Fd -> QueueSelector -> IO () Source#
discardData fd queues
calls tcflush
to discard pending input and/or output for Fd
fd
, as indicated by the QueueSelector
queues
.
Constructors
SuspendOutput | TCOOFF |
RestartOutput | TCOON |
TransmitStop | TCIOFF |
TransmitStart | TCION |
controlFlow :: Fd -> FlowAction -> IO () Source#
controlFlow fd action
calls tcflow
to control the flow of data on Fd
fd
, as indicated by action
.
Process groups
getTerminalProcessGroupID :: Fd -> IOProcessGroupIDSource#
getTerminalProcessGroupID fd
calls tcgetpgrp
to obtain the ProcessGroupID
of the foreground process group associated with the terminal attached to Fd
fd
.
setTerminalProcessGroupID :: Fd -> ProcessGroupID -> IO () Source#
setTerminalProcessGroupID fd pgid
calls tcsetpgrp
to set the ProcessGroupID
of the foreground process group associated with the terminal attached to Fd
fd
to pgid
.
Testing a file descriptor
queryTerminal :: Fd -> IOBoolSource#
queryTerminal fd
calls isatty
to determine whether or not Fd
fd
is associated with a terminal.
getTerminalName :: Fd -> IOFilePathSource#
getTerminalName fd
calls ttyname
to obtain a name associated with the terminal for Fd
fd
. If fd
is associated with a terminal, getTerminalName
returns the name of the terminal.
getControllingTerminalName :: IOFilePathSource#
getControllingTerminalName
calls ctermid
to obtain a name associated with the controlling terminal for the process. If a controlling terminal exists, getControllingTerminalName
returns the name of the controlling terminal.
Throws IOError
("unsupported operation") if platform does not provide ctermid(3)
(use #if HAVE_CTERMID
CPP guard to detect availability).