dist/build/System/Posix/Terminal/ByteString.hs

{-# LINE 1 "System/Posix/Terminal/ByteString.hsc" #-}

{-# LINE 2 "System/Posix/Terminal/ByteString.hsc" #-}
{-# LANGUAGE Trustworthy #-}

{-# LINE 4 "System/Posix/Terminal/ByteString.hsc" #-}
-----------------------------------------------------------------------------
-- |
-- Module : System.Posix.Terminal.ByteString
-- 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)
--
-- POSIX Terminal support
--
-----------------------------------------------------------------------------

module System.Posix.Terminal.ByteString (
 -- * Terminal support

 -- ** Terminal attributes
 TerminalAttributes,
 getTerminalAttributes,
 TerminalState(..),
 setTerminalAttributes,

 TerminalMode(..),
 withoutMode,
 withMode,
 terminalMode,
 bitsPerByte,
 withBits,

 ControlCharacter(..),
 controlChar,
 withCC,
 withoutCC,

 inputTime,
 withTime,
 minInput,
 withMinInput,

 BaudRate(..),
 inputSpeed,
 withInputSpeed,
 outputSpeed,
 withOutputSpeed,

 -- ** Terminal operations
 sendBreak,
 drainOutput,
 QueueSelector(..),
 discardData,
 FlowAction(..),
 controlFlow,

 -- ** Process groups
 getTerminalProcessGroupID,
 setTerminalProcessGroupID,

 -- ** Testing a file descriptor
 queryTerminal,
 getTerminalName,
 getControllingTerminalName,

 -- ** Pseudoterminal operations
 openPseudoTerminal,
 getSlaveTerminalName
 ) where


{-# LINE 73 "System/Posix/Terminal/ByteString.hsc" #-}

import Foreign
import System.Posix.Types
import System.Posix.Terminal.Common

{-# LINE 81 "System/Posix/Terminal/ByteString.hsc" #-}

import Foreign.C hiding (
 throwErrnoPath,
 throwErrnoPathIf,
 throwErrnoPathIf_,
 throwErrnoPathIfNull,
 throwErrnoPathIfMinus1,
 throwErrnoPathIfMinus1_ )

import System.Posix.ByteString.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.
getTerminalName :: Fd -> IO RawFilePath
getTerminalName (Fd fd) = do
 s <- throwErrnoIfNull "getTerminalName" (c_ttyname fd)
 peekFilePath s

foreign import ccall unsafe "ttyname"
 c_ttyname :: CInt -> IO CString

-- | @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.
getControllingTerminalName :: IO RawFilePath
getControllingTerminalName = do
 s <- throwErrnoIfNull "getControllingTerminalName" (c_ctermid nullPtr)
 peekFilePath s

foreign import ccall unsafe "ctermid"
 c_ctermid :: CString -> IO CString

-- | @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.
getSlaveTerminalName :: Fd -> IO RawFilePath


{-# LINE 124 "System/Posix/Terminal/ByteString.hsc" #-}
getSlaveTerminalName (Fd fd) = do
 s <- throwErrnoIfNull "getSlaveTerminalName" (c_ptsname fd)
 peekFilePath s

foreign import ccall unsafe "__hsunix_ptsname"
 c_ptsname :: CInt -> IO CString

{-# LINE 134 "System/Posix/Terminal/ByteString.hsc" #-}

-- -----------------------------------------------------------------------------
-- openPseudoTerminal needs to be here because it depends on
-- getSlaveTerminalName.

-- | @openPseudoTerminal@ creates a pseudoterminal (pty) pair, and
-- returns the newly created pair as a (@master@, @slave@) tuple.
openPseudoTerminal :: IO (Fd, Fd)


{-# LINE 144 "System/Posix/Terminal/ByteString.hsc" #-}
openPseudoTerminal =
 alloca $ \p_master ->
 alloca $ \p_slave -> do
 throwErrnoIfMinus1_ "openPty"
 (c_openpty p_master p_slave nullPtr nullPtr nullPtr)
 master <- peek p_master
 slave <- peek p_slave
 return (Fd master, Fd slave)

foreign import ccall unsafe "openpty"
 c_openpty :: Ptr CInt -> Ptr CInt -> CString -> Ptr CTermios -> Ptr a
 -> IO CInt

{-# LINE 195 "System/Posix/Terminal/ByteString.hsc" #-}