GI.Vte.Objects.Pty

Exported types

newtype Pty

Constructors

Pty (ManagedPtr Pty)

Instances

GObject Pty

Methods

gobjectType :: Pty -> IO GType

IsInitable Pty

IsObject Pty

IsPty Pty

((~) * info (ResolvePtyMethod t Pty), MethodInfo * info Pty p) => IsLabel t (Pty -> p)

Methods

fromLabel :: Proxy# Symbol t -> Pty -> p

((~) * info (ResolvePtyMethod t Pty), MethodInfo * info Pty p) => IsLabelProxy t (Pty -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Pty -> p

HasAttributeList * Pty

type AttributeList Pty

type AttributeList Pty

type SignalList Pty

type SignalList Pty

class GObject o => IsPty o

Instances

(GObject a, UnknownAncestorError Constraint Pty a) => IsPty a

IsPty Pty

toPty :: IsPty o => o -> IO Pty

noPty :: Maybe Pty

Methods

childSetup

data PtyChildSetupMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsPty a) => MethodInfo * PtyChildSetupMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PtyChildSetupMethodInfo a -> signature -> s

ptyChildSetup

Arguments

:: (HasCallStack, MonadIO m, IsPty a)

=> a

pty: a Pty

-> m ()

FIXMEchpe

close

data PtyCloseMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsPty a) => MethodInfo * PtyCloseMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PtyCloseMethodInfo a -> signature -> s

ptyClose

Arguments

:: (HasCallStack, MonadIO m, IsPty a)

=> a

pty: a Pty

-> m ()

Deprecated: (Since version 0.42)

Since 0.42 this is a no-op.

getFd

data PtyGetFdMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsPty a) => MethodInfo * PtyGetFdMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PtyGetFdMethodInfo a -> signature -> s

ptyGetFd

Arguments

:: (HasCallStack, MonadIO m, IsPty a)

=> a

pty: a Pty

-> m Int32

Returns: the file descriptor of the PTY master in pty. The file descriptor belongs to pty and must not be closed

No description available in the introspection data.

getSize

data PtyGetSizeMethodInfo

Instances

((~) * signature (m (Int32, Int32)), MonadIO m, IsPty a) => MethodInfo * PtyGetSizeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PtyGetSizeMethodInfo a -> signature -> s

ptyGetSize

Arguments

:: (HasCallStack, MonadIO m, IsPty a)

=> a

pty: a Pty

-> m (Int32, Int32)

(Can throw GError)

Reads the pseudo terminal's window size.

If getting the window size failed, error will be set to a IOError.

newForeignSync

ptyNewForeignSync

Arguments

:: (HasCallStack, MonadIO m, IsCancellable a)

=> Int32

fd: a file descriptor to the PTY

-> Maybe a

cancellable: a Cancellable, or Nothing

-> m Pty

Returns: a new Pty for fd, or Nothing on error with error filled in (Can throw GError)

Creates a new Pty for the PTY master fd.

No entry will be made in the lastlog, utmp or wtmp system files.

Note that the newly created Pty will take ownership of fd and close it on finalize.

newSync

ptyNewSync

Arguments

:: (HasCallStack, MonadIO m, IsCancellable a)

=> [PtyFlags]

flags: flags from PtyFlags

-> Maybe a

cancellable: a Cancellable, or Nothing

-> m Pty

Returns: a new Pty, or Nothing on error with error filled in (Can throw GError)

Allocates a new pseudo-terminal.

You can later use fork() or the spawnAsync family of functions to start a process on the PTY.

If using fork(), you MUST call ptyChildSetup in the child.

If using spawnAsync and friends, you MUST either use ptyChildSetup directly as the child setup function, or call ptyChildSetup from your own child setup function supplied.

When using terminalSpawnSync with a custom child setup function, ptyChildSetup will be called before the supplied function; you must not call it again.

Also, you MUST pass the SpawnFlagsDoNotReapChild flag.

setSize

data PtySetSizeMethodInfo

Instances

((~) * signature (Int32 -> Int32 -> m ()), MonadIO m, IsPty a) => MethodInfo * PtySetSizeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PtySetSizeMethodInfo a -> signature -> s

ptySetSize

Arguments

:: (HasCallStack, MonadIO m, IsPty a)

=> a

pty: a Pty

-> Int32

rows: the desired number of rows

-> Int32

columns: the desired number of columns

-> m ()

(Can throw GError)

Attempts to resize the pseudo terminal's window size. If successful, the OS kernel will send SIGWINCH to the child process group.

If setting the window size failed, error will be set to a IOError.

setUtf8

data PtySetUtf8MethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsPty a) => MethodInfo * PtySetUtf8MethodInfo a signature

Methods

overloadedMethod :: MethodProxy PtySetUtf8MethodInfo a -> signature -> s

ptySetUtf8

Arguments

:: (HasCallStack, MonadIO m, IsPty a)

=> a

pty: a Pty

-> Bool

utf8: whether or not the pty is in UTF-8 mode

-> m ()

(Can throw GError)

Tells the kernel whether the terminal is UTF-8 or not, in case it can make use of the info. Linux 2.6.5 or so defines IUTF8 to make the line discipline do multibyte backspace correctly.

Properties

fd

data PtyFdPropertyInfo

Instances

AttrInfo PtyFdPropertyInfo

Associated Types

type AttrAllowedOps PtyFdPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint PtyFdPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint PtyFdPropertyInfo :: * -> Constraint

type AttrGetType PtyFdPropertyInfo :: *

type AttrLabel PtyFdPropertyInfo :: Symbol

type AttrOrigin PtyFdPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint PtyFdPropertyInfo o => Proxy * PtyFdPropertyInfo -> o -> IO (AttrGetType PtyFdPropertyInfo)

attrSet :: (AttrBaseTypeConstraint PtyFdPropertyInfo o, AttrSetTypeConstraint PtyFdPropertyInfo b) => Proxy * PtyFdPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint PtyFdPropertyInfo o => Proxy * PtyFdPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint PtyFdPropertyInfo o, AttrSetTypeConstraint PtyFdPropertyInfo b) => Proxy * PtyFdPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin PtyFdPropertyInfo

type AttrOrigin PtyFdPropertyInfo = Pty

type AttrLabel PtyFdPropertyInfo

type AttrLabel PtyFdPropertyInfo = "fd"

type AttrGetType PtyFdPropertyInfo

type AttrGetType PtyFdPropertyInfo = Int32

type AttrBaseTypeConstraint PtyFdPropertyInfo

type AttrBaseTypeConstraint PtyFdPropertyInfo = IsPty

type AttrSetTypeConstraint PtyFdPropertyInfo

type AttrSetTypeConstraint PtyFdPropertyInfo = * ~ Int32

type AttrAllowedOps PtyFdPropertyInfo

type AttrAllowedOps PtyFdPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructPtyFd :: IsPty o => Int32 -> IO (GValueConstruct o)

getPtyFd :: (MonadIO m, IsPty o) => o -> m Int32

ptyFd :: AttrLabelProxy "fd"

flags

data PtyFlagsPropertyInfo

Instances

AttrInfo PtyFlagsPropertyInfo

Associated Types

type AttrAllowedOps PtyFlagsPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint PtyFlagsPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint PtyFlagsPropertyInfo :: * -> Constraint

type AttrGetType PtyFlagsPropertyInfo :: *

type AttrLabel PtyFlagsPropertyInfo :: Symbol

type AttrOrigin PtyFlagsPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint PtyFlagsPropertyInfo o => Proxy * PtyFlagsPropertyInfo -> o -> IO (AttrGetType PtyFlagsPropertyInfo)

attrSet :: (AttrBaseTypeConstraint PtyFlagsPropertyInfo o, AttrSetTypeConstraint PtyFlagsPropertyInfo b) => Proxy * PtyFlagsPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint PtyFlagsPropertyInfo o => Proxy * PtyFlagsPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint PtyFlagsPropertyInfo o, AttrSetTypeConstraint PtyFlagsPropertyInfo b) => Proxy * PtyFlagsPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin PtyFlagsPropertyInfo

type AttrOrigin PtyFlagsPropertyInfo = Pty

type AttrLabel PtyFlagsPropertyInfo

type AttrLabel PtyFlagsPropertyInfo = "flags"

type AttrGetType PtyFlagsPropertyInfo

type AttrGetType PtyFlagsPropertyInfo = [PtyFlags]

type AttrBaseTypeConstraint PtyFlagsPropertyInfo

type AttrBaseTypeConstraint PtyFlagsPropertyInfo = IsPty

type AttrSetTypeConstraint PtyFlagsPropertyInfo

type AttrSetTypeConstraint PtyFlagsPropertyInfo = * ~ [PtyFlags]

type AttrAllowedOps PtyFlagsPropertyInfo

type AttrAllowedOps PtyFlagsPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructPtyFlags :: IsPty o => [PtyFlags] -> IO (GValueConstruct o)

getPtyFlags :: (MonadIO m, IsPty o) => o -> m [PtyFlags]

ptyFlags :: AttrLabelProxy "flags"