Package org.jline.nativ

Class CLibrary

java.lang.Object

org.jline.nativ.CLibrary

public class CLibrary
extends Object

Interface to access some low level POSIX functions,.

See Also:

• JLineNativeLoader

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CLibrary.Termios	termios structure for termios functions, describing a general terminal interface that is provided to control asynchronous communications ports
static class	CLibrary.WinSize	Window sizes.

Field Summary

Fields

Modifier and Type	Field	Description
static int	TCSADRAIN
static int	TCSAFLUSH
static int	TCSANOW
static long	TIOCGWINSZ
static long	TIOCSWINSZ

Method Summary

Modifier and Type	Method	Description
static short	getTerminalWidth(int fd)
static int	ioctl(int filedes, long request, int[] params)	Control a STREAMS device.
static int	ioctl(int filedes, long request, CLibrary.WinSize params)
static int	isatty(int fd)	test whether a file descriptor refers to a terminal
static int	openpty(int[] amaster, int[] aslave, byte[] name, CLibrary.Termios termios, CLibrary.WinSize winsize)	The openpty() function finds an available pseudoterminal and returns file descriptors for the master and slave in amaster and aslave.
static int	pollForInput(int fd, int timeoutMs)	Polls a single file descriptor for input readability using poll(2).
static int	tcgetattr(int filedes, CLibrary.Termios termios)
static int	tcsetattr(int filedes, int optional_actions, CLibrary.Termios termios)
static String	ttyname(int filedes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TCSANOW

public static int TCSANOW

TCSADRAIN

public static int TCSADRAIN

TCSAFLUSH

public static int TCSAFLUSH

TIOCGWINSZ

public static long TIOCGWINSZ

TIOCSWINSZ

public static long TIOCSWINSZ

Method Details

isatty

public static int isatty(int fd)

test whether a file descriptor refers to a terminal

Parameters:

fd - file descriptor

Returns:

isatty() returns 1 if fd is an open file descriptor referring to a terminal; otherwise 0 is returned, and errno is set to indicate the error

See Also:

• ISATTY(3) man-page
• ISATTY(3P) man-page

pollForInput

public static int pollForInput(int fd,
 int timeoutMs)

Polls a single file descriptor for input readability using poll(2). Retries automatically on EINTR (signal interruption).

Parameters:

fd - file descriptor to poll (e.g. 0 for stdin)

timeoutMs - timeout in milliseconds; 0 = immediate, −1 = infinite

Returns:

positive if data is ready, 0 on timeout, −1 on permanent error

ttyname

public static String ttyname(int filedes)

openpty

public static int openpty(int[] amaster,
 int[] aslave,
 byte[] name,
 CLibrary.Termios termios,
 CLibrary.WinSize winsize)

The openpty() function finds an available pseudoterminal and returns file descriptors for the master and slave in amaster and aslave.

Parameters:

amaster - master return value

aslave - slave return value

name - filename return value

termios - optional pty attributes

winsize - optional size

Returns:

0 on success

See Also:

• OPENPTY(3) man-page

tcgetattr

public static int tcgetattr(int filedes,
 CLibrary.Termios termios)

tcsetattr

public static int tcsetattr(int filedes,
 int optional_actions,
 CLibrary.Termios termios)

ioctl

public static int ioctl(int filedes,
 long request,
 int[] params)

Control a STREAMS device.

See Also:

• IOCTL(3P) man-page

ioctl

public static int ioctl(int filedes,
 long request,
 CLibrary.WinSize params)

getTerminalWidth

public static short getTerminalWidth(int fd)