GI.Vte.Objects.Pty

No description available in the introspection data.

Exported types

newtype Pty

Memory-managed wrapper type.

Constructors

Pty (ManagedPtr Pty)

Instances

Eq Pty

Defined in GI.Vte.Objects.Pty

Methods

(==) :: Pty -> Pty -> Bool

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

GObject Pty

Defined in GI.Vte.Objects.Pty

ManagedPtrNewtype Pty

Defined in GI.Vte.Objects.Pty

Methods

toManagedPtr :: Pty -> ManagedPtr Pty

TypedObject Pty

Defined in GI.Vte.Objects.Pty

Methods

glibType :: IO GType

IsGValue Pty

Convert Pty to and from GValue with toGValue and fromGValue.

Defined in GI.Vte.Objects.Pty

Methods

toGValue :: Pty -> IO GValue

fromGValue :: GValue -> IO Pty

HasParentTypes Pty

Defined in GI.Vte.Objects.Pty

type ParentTypes Pty

Defined in GI.Vte.Objects.Pty

type ParentTypes Pty = '[Object, Initable]

class (GObject o, IsDescendantOf Pty o) => IsPty o

Type class for types which can be safely cast to Pty, for instance with toPty.

Instances

(GObject o, IsDescendantOf Pty o) => IsPty o

Defined in GI.Vte.Objects.Pty

toPty :: (MonadIO m, IsPty o) => o -> m Pty

Cast to Pty, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

childSetup

ptyChildSetup

Arguments

:: (HasCallStack, MonadIO m, IsPty a)

=> a

pty: a Pty

-> m ()

FIXMEchpe

close

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

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 or have its flags changed

No description available in the introspection data.

getSize

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.

Note that you should set the PTY's size using ptySetSize before spawning the child process, so that the child process has the correct size from the start instead of starting with a default size and then shortly afterwards receiving a SIGWINCH signal. You should prefer using terminalPtyNewSync which does this automatically.

setSize

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

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.

spawnAsync

ptySpawnAsync

Arguments

:: (HasCallStack, MonadIO m, IsPty a, IsCancellable b)

=> a

pty: a Pty

-> Maybe Text

workingDirectory: the name of a directory the command should start in, or Nothing to use the current working directory

-> [[Char]]

argv: child's argument vector

-> Maybe [[Char]]

envv: a list of environment variables to be added to the environment before starting the process, or Nothing

-> [SpawnFlags]

spawnFlags: flags from SpawnFlags

-> Maybe SpawnChildSetupFunc

childSetup: an extra child setup function to run in the child just before exec(), or Nothing

-> Int32

timeout: a timeout value in ms, or -1 to wait indefinitely

-> Maybe b

cancellable: a Cancellable, or Nothing

-> Maybe AsyncReadyCallback

-> m ()

Starts the specified command under the pseudo-terminal pty. The argv and envv lists should be Nothing-terminated. The "TERM" environment variable is automatically set to a default value, but can be overridden from envv. ptyFlags controls logging the session to the specified system log files.

Note that SpawnFlagsDoNotReapChild will always be added to spawnFlags.

Note that all open file descriptors will be closed in the child. If you want to keep some file descriptor open for use in the child process, you need to use a child setup function that unsets the FD_CLOEXEC flag on that file descriptor.

Beginning with 0.60, and on linux only, and unless SPAWN_NO_SYSTEMD_SCOPE is passed in spawnFlags, the newly created child process will be moved to its own systemd user scope; and if SPAWN_REQUIRE_SYSTEMD_SCOPE is passed, and creation of the systemd user scope fails, the whole spawn will fail. You can override the options used for the systemd user scope by providing a systemd override file for 'vte-spawn-.scope' unit. See man:systemd.unit(5) for further information.

See vte_pty_new(), spawnAsync and terminalWatchChild for more information.

Since: 0.48

spawnFinish

ptySpawnFinish

Arguments

:: (HasCallStack, MonadIO m, IsPty a, IsAsyncResult b)

=> a

pty: a Pty

-> b

result: a AsyncResult

-> m Int32

(Can throw GError)

No description available in the introspection data.

Since: 0.48

Properties

fd

The file descriptor of the PTY master.

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

Construct a GValueConstruct with valid value for the “fd” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “fd” property. When overloading is enabled, this is equivalent to

get pty #fd

flags

Flags.

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

Construct a GValueConstruct with valid value for the “flags” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “flags” property. When overloading is enabled, this is equivalent to

get pty #flags