System.Posix.Terminal

POSIX Terminal support

Terminal support

Terminal attributes

data TerminalAttributes

getTerminalAttributes :: Fd -> IO TerminalAttributes

getTerminalAttributes fd calls tcgetattr to obtain the TerminalAttributes associated with Fd fd.

data TerminalState

Constructors

Immediately

WhenDrained

WhenFlushed

setTerminalAttributes :: Fd -> TerminalAttributes -> TerminalState -> IO ()

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.

data TerminalMode

Constructors

InterruptOnBreak

BRKINT - Signal interrupt on break

MapCRtoLF

ICRNL - Map CR to NL on input

IgnoreBreak

IGNBRK - Ignore break condition

IgnoreCR

IGNCR - Ignore CR

IgnoreParityErrors

IGNPAR - Ignore characters with parity errors

MapLFtoCR

INLCR - Map NL to CR on input

CheckParity

INPCK - Enable input parity check

StripHighBit

ISTRIP - Strip character

RestartOnAny

IXANY - Enable any character to restart output

StartStopInput

IXOFF - Enable start/stop input control

StartStopOutput

IXON - Enable start/stop output control

MarkParityErrors

PARMRK - Mark parity errors

ProcessOutput

OPOST - Post-process output

MapLFtoCRLF

ONLCR - (XSI) Map NL to CR-NL on output

Since: 2.8.0.0

OutputMapCRtoLF

OCRNL - (XSI) Map CR to NL on output

Since: 2.8.0.0

NoCRAtColumnZero

ONOCR - (XSI) No CR output at column 0

Since: 2.8.0.0

ReturnMeansLF

ONLRET - (XSI) NL performs CR function

Since: 2.8.0.0

TabDelayMask0

TABDLY(TAB0) - (XSI) Select horizontal-tab delays: type 0

Since: 2.8.0.0

TabDelayMask3

TABDLY(TAB3) - (XSI) Select horizontal-tab delays: type 3

Since: 2.8.0.0

LocalMode

CLOCAL - Ignore modem status lines

ReadEnable

CREAD - Enable receiver

TwoStopBits

CSTOPB - Send two stop bits, else one

HangupOnClose

HUPCL - Hang up on last close

EnableParity

PARENB - Parity enable

OddParity

PARODD - Odd parity, else even

EnableEcho

ECHO - Enable echo

EchoErase

ECHOE - Echo erase character as error-correcting backspace

EchoKill

ECHOK - Echo KILL

EchoLF

ECHONL - Echo NL

ProcessInput

ICANON - Canonical input (erase and kill processing)

ExtendedFunctions

IEXTEN - Enable extended input character processing

KeyboardInterrupts

ISIG - Enable signals

NoFlushOnInterrupt

NOFLSH - Disable flush after interrupt or quit

BackgroundWriteInterrupt

TOSTOP - Send SIGTTOU for background output

withoutMode :: TerminalAttributes -> TerminalMode -> TerminalAttributes

withMode :: TerminalAttributes -> TerminalMode -> TerminalAttributes

terminalMode :: TerminalMode -> TerminalAttributes -> Bool

bitsPerByte :: TerminalAttributes -> Int

withBits :: TerminalAttributes -> Int -> TerminalAttributes

data ControlCharacter

Constructors

EndOfFile

EndOfLine

Erase

Interrupt

Kill

Quit

Start

Stop

Suspend

controlChar :: TerminalAttributes -> ControlCharacter -> Maybe Char

withCC :: TerminalAttributes -> (ControlCharacter, Char) -> TerminalAttributes

withoutCC :: TerminalAttributes -> ControlCharacter -> TerminalAttributes

inputTime :: TerminalAttributes -> Int

withTime :: TerminalAttributes -> Int -> TerminalAttributes

minInput :: TerminalAttributes -> Int

withMinInput :: TerminalAttributes -> Int -> TerminalAttributes

newtype BaudRate

Serial line baudrate. The set of supported speeds is system-dependent. Portable use of the provided pattern synonyms that are outside the list mandated by POSIX requires #ifdef guards.

Applications may need to be prepared to encounter speeds not known at compile time, these can be handled generically via the BaudRate constructor. In other words, the provided pattern synonyms are not necessarily a COMPLETE set.

All non-zero pseudo-terminal baud rates are functionally equivalent, and the pty driver may accept any speed within a suitable range. Requested speeds may be rounded up or down to fit into the supported range.

Constructors

BaudRate CSpeed

Bundled Patterns

pattern B0 :: BaudRate

Hang up

pattern B50 :: BaudRate

50 baud

pattern B75 :: BaudRate

75 baud

pattern B110 :: BaudRate

110 baud

pattern B134 :: BaudRate

134. 5 baud

pattern B150 :: BaudRate

150 baud

pattern B200 :: BaudRate

200 baud

pattern B300 :: BaudRate

300 baud

pattern B600 :: BaudRate

600 baud

pattern B1200 :: BaudRate

1200 baud

pattern B1800 :: BaudRate

1800 baud

pattern B2400 :: BaudRate

2400 baud

pattern B4800 :: BaudRate

4800 baud

pattern B9600 :: BaudRate

9600 baud

pattern B19200 :: BaudRate

19200 baud

pattern B38400 :: BaudRate

38400 baud

pattern B57600 :: BaudRate

57600 baud, non-POSIX system-dependent extension

pattern B115200 :: BaudRate

115200 baud, non-POSIX system-dependent extension

pattern B230400 :: BaudRate

230400 baud, non-POSIX system-dependent extension

pattern B460800 :: BaudRate

460800 baud, non-POSIX system-dependent extension

pattern B500000 :: BaudRate

500000 baud, non-POSIX system-dependent extension

pattern B576000 :: BaudRate

576000 baud, non-POSIX system-dependent extension

pattern B921600 :: BaudRate

921600 baud, non-POSIX system-dependent extension

pattern B1000000 :: BaudRate

1000000 baud, non-POSIX system-dependent extension

pattern B1152000 :: BaudRate

1152000 baud, non-POSIX system-dependent extension

pattern B1500000 :: BaudRate

1500000 baud, non-POSIX system-dependent extension

pattern B2000000 :: BaudRate

2000000 baud, non-POSIX system-dependent extension

pattern B2500000 :: BaudRate

2500000 baud, non-POSIX system-dependent extension

pattern B3000000 :: BaudRate

3000000 baud, non-POSIX system-dependent extension

pattern B3500000 :: BaudRate

3500000 baud, non-POSIX system-dependent extension

pattern B4000000 :: BaudRate

4000000 baud, non-POSIX system-dependent extension

Instances

Enum BaudRate

Defined in System.Posix.Terminal.Common

Methods

succ :: BaudRate -> BaudRate

pred :: BaudRate -> BaudRate

toEnum :: Int -> BaudRate

fromEnum :: BaudRate -> Int

enumFrom :: BaudRate -> [BaudRate]

enumFromThen :: BaudRate -> BaudRate -> [BaudRate]

enumFromTo :: BaudRate -> BaudRate -> [BaudRate]

enumFromThenTo :: BaudRate -> BaudRate -> BaudRate -> [BaudRate]

Num BaudRate

Defined in System.Posix.Terminal.Common

Methods

(+) :: BaudRate -> BaudRate -> BaudRate

(-) :: BaudRate -> BaudRate -> BaudRate

(*) :: BaudRate -> BaudRate -> BaudRate

negate :: BaudRate -> BaudRate

abs :: BaudRate -> BaudRate

signum :: BaudRate -> BaudRate

fromInteger :: Integer -> BaudRate

Real BaudRate

Defined in System.Posix.Terminal.Common

Methods

toRational :: BaudRate -> Rational

Show BaudRate

Defined in System.Posix.Terminal.Common

Methods

showsPrec :: Int -> BaudRate -> ShowS

show :: BaudRate -> String

showList :: [BaudRate] -> ShowS

Eq BaudRate

Defined in System.Posix.Terminal.Common

Methods

(==) :: BaudRate -> BaudRate -> Bool

(/=) :: BaudRate -> BaudRate -> Bool

Ord BaudRate

Defined in System.Posix.Terminal.Common

Methods

compare :: BaudRate -> BaudRate -> Ordering

(<) :: BaudRate -> BaudRate -> Bool

(<=) :: BaudRate -> BaudRate -> Bool

(>) :: BaudRate -> BaudRate -> Bool

(>=) :: BaudRate -> BaudRate -> Bool

max :: BaudRate -> BaudRate -> BaudRate

min :: BaudRate -> BaudRate -> BaudRate

inputSpeed :: TerminalAttributes -> BaudRate

withInputSpeed :: TerminalAttributes -> BaudRate -> TerminalAttributes

outputSpeed :: TerminalAttributes -> BaudRate

withOutputSpeed :: TerminalAttributes -> BaudRate -> TerminalAttributes

Terminal operations

sendBreak :: Fd -> Int -> IO ()

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 ()

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).

data QueueSelector

Constructors

InputQueue

OutputQueue

BothQueues

discardData :: Fd -> QueueSelector -> IO ()

discardData fd queues calls tcflush to discard pending input and/or output for Fd fd, as indicated by the QueueSelector queues.

data FlowAction

Constructors

SuspendOutput

TCOOFF

RestartOutput

TCOON

TransmitStop

TCIOFF

TransmitStart

TCION

controlFlow :: Fd -> FlowAction -> IO ()

controlFlow fd action calls tcflow to control the flow of data on Fd fd, as indicated by action.

Process groups

getTerminalProcessGroupID :: Fd -> IO ProcessGroupID

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 ()

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 -> IO Bool

queryTerminal fd calls isatty to determine whether or not Fd fd is associated with a terminal.

getTerminalName :: Fd -> IO FilePath

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 :: IO FilePath

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).

Pseudoterminal operations

openPseudoTerminal :: IO (Fd, Fd)

openPseudoTerminal creates a pseudoterminal (pty) pair, and returns the newly created pair as a (master, slave) tuple.

getSlaveTerminalName :: Fd -> IO FilePath

getSlaveTerminalName calls ptsname to obtain the name of the slave terminal associated with a pseudoterminal pair. The file descriptor to pass in must be that of the master.