Modifier and Type	Class and Description
private static class	JLineConsole.HistoryCloser
private class	JLineConsole.Stream Class to wrap the line-oriented interface to JLine with an InputStream that can replace System.in.

Field Summary

Modifier and Type	Field and Description
protected static final String	CTRL_Z The ctrl-z character String.
private ConsoleOutputStream	outWrapper Stream wrapping System.out in order to capture the last prompt.
protected PyObject	pre_input_hook Not currently set by `readline.set_pre_input_hook`.
public ConsoleReader	reader Main interface to JLine.
protected PyObject	startup_hook Callable object set by `readline.set_startup_hook`.
private static final List<String>	SUSPENDED_STRERRORS Errno strerrors possibly caused by a SIGSTP (ctrl-z).
private boolean	windows Whether reader is a WindowsTerminal.

Inherited from org.python.core.PlainConsole:: encoding encodingCharset

Constructor Summary

Access	Constructor and Description
public	JLineConsole(String name of a supported encoding or `null` for `Charset.defaultCharset()` encoding) Construct an instance of the console class specifying the character encoding.

Method Summary

Modifier and Type	Method and Description
private boolean	fromSuspend(IOException ioe) Determine if the IOException was likely caused by a SIGSTP (ctrl-z).
public ConsoleReader	Returns: the JLine console reader associated with this interpreter getReader()
public PyObject	Returns: the startup hook (called prior to each readline) getStartupHook()
public void	install() Overrides org.python.core.PlainConsole.install. Implements org.python.core.Console.install. Complete initialization and (optionally) install a stream object with line-editing as the replacement for `System.in`.
private boolean	isEOF(String line) Determine if line denotes an EOF.
private String	Returns: line of text read in readerReadLine(String to display prompt) Wrapper on reader.readLine(prompt) that deals with retries (on Unix) when the user enters ctrl-Z to background Jython, then brings it back to the foreground.
public void	setStartupHook(PyObject hook) Sets the startup hook (called prior to each readline)

Inherited from org.python.core.PlainConsole:: getEncoding getEncodingCharset uninstall

Field Detail

CTRL_Z	back to summary
protected static final String CTRL_Z The ctrl-z character String.

outWrapper	back to summary
private ConsoleOutputStream outWrapper Stream wrapping System.out in order to capture the last prompt.

pre_input_hook	back to summary
protected PyObject pre_input_hook Not currently set by `readline.set_pre_input_hook`. Why not?

reader	back to summary
public ConsoleReader reader Main interface to JLine.

startup_hook	back to summary
protected PyObject startup_hook Callable object set by `readline.set_startup_hook`.

SUSPENDED_STRERRORS	back to summary
private static final List<String> SUSPENDED_STRERRORS Errno strerrors possibly caused by a SIGSTP (ctrl-z). They may propagate up to IOException messages.

windows	back to summary
private boolean windows Whether reader is a WindowsTerminal.

Constructor Detail

JLineConsole back to summary

JLineConsole	back to summary
public JLineConsole(String encoding) Construct an instance of the console class specifying the character encoding. This encoding must be one supported by the JVM. Most of the initialisation is deferred to the `install()` method so that any prior console can uninstall itself before we change system console settings and `System.in`. Parameters encoding:String name of a supported encoding or `null` for `Charset.defaultCharset()`

public JLineConsole(String encoding)

Construct an instance of the console class specifying the character encoding. This encoding must be one supported by the JVM.

Most of the initialisation is deferred to the install() method so that any prior console can uninstall itself before we change system console settings and System.in.

Parameters

encoding:String: name of a supported encoding or null for Charset.defaultCharset()

Method Detail

fromSuspend	back to summary
private boolean fromSuspend(IOException ioe) Determine if the IOException was likely caused by a SIGSTP (ctrl-z). Seems only applicable to BSD platforms.

getReader	back to summary
public ConsoleReader getReader() Returns:ConsoleReader the JLine console reader associated with this interpreter

getStartupHook	back to summary
public PyObject getStartupHook() Returns:PyObject the startup hook (called prior to each readline)

install back to summary

install	back to summary
public void install() Overrides org.python.core.PlainConsole.install. Implements org.python.core.Console.install. Doc from org.python.core.Console.install. Complete initialization and (optionally) install a stream object with line-editing as the replacement for `System.in`. This implementation overrides that by setting `System.in` to a `FilterInputStream` object that wraps JLine, and `System.out` with a layer that buffers incomplete lines for use as the console prompt. Annotations @Override

public void install()

Overrides org.python.core.PlainConsole.install.

Implements org.python.core.Console.install.

Doc from org.python.core.Console.install.

Complete initialization and (optionally) install a stream object with line-editing as the replacement for System.in.

This implementation overrides that by setting System.in to a FilterInputStream object that wraps JLine, and System.out with a layer that buffers incomplete lines for use as the console prompt.

Annotations

@Override

isEOF	back to summary
private boolean isEOF(String line) Determine if line denotes an EOF.

readerReadLine	back to summary
private String readerReadLine(String prompt) throws IOException, EOFException Wrapper on reader.readLine(prompt) that deals with retries (on Unix) when the user enters ctrl-Z to background Jython, then brings it back to the foreground. The inherited implementation says this is necessary and effective on BSD Unix. Parameters prompt:String to display Returns:String line of text read in Exceptions IOException: if an error occurs (other than an end of suspension) EOFException: if an EOF is detected

readerReadLine

back to summary

private String readerReadLine(String prompt) throws IOException, EOFException

Wrapper on reader.readLine(prompt) that deals with retries (on Unix) when the user enters ctrl-Z to background Jython, then brings it back to the foreground. The inherited implementation says this is necessary and effective on BSD Unix.

Parameters

prompt:String: to display

Returns:String

line of text read in

Exceptions

IOException:: if an error occurs (other than an end of suspension)
EOFException:: if an EOF is detected

setStartupHook	back to summary
public void setStartupHook(PyObject hook) Sets the startup hook (called prior to each readline)

org.python.util back to summary

private Class JLineConsole.HistoryCloser

Class Inheritance

extends Object
implements Runnable

java.lang.Object
org.python.util.JLineConsole.HistoryCloser

All Implemented Interfaces

java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
pack-priv FileHistory	history

Constructor Summary

Access	Constructor and Description
public	HistoryCloser(FileHistory history)

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. Runs this operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

history	back to summary
pack-priv FileHistory history

Constructor Detail

HistoryCloser	back to summary
public HistoryCloser(FileHistory history)

Method Detail

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

org.python.util back to summary

private Class JLineConsole.Stream

Class Inheritance

extends ConsoleInputStream

Class to wrap the line-oriented interface to JLine with an InputStream that can replace System.in.

Field Summary

Inherited from org.python.util.ConsoleInputStream:: EMPTY_BUF encoding eol eolPolicy LINE_SEPARATOR

Constructor Summary

Access	Constructor and Description
pack-priv	Stream() Create a System.in replacement with JLine that adds system-specific line endings

Method Summary

Modifier and Type	Method and Description
protected CharSequence	getLine() Implements abstract org.python.util.ConsoleInputStream.getLine. Get one line of input from the console.

Inherited from org.python.util.ConsoleInputStream:: available mark markSupported read read reset skip

Constructor Detail

Stream	back to summary
pack-priv Stream() Create a System.in replacement with JLine that adds system-specific line endings

Method Detail

getLine	back to summary
protected CharSequence getLine() throws IOException, EOFException Implements abstract org.python.util.ConsoleInputStream.getLine. Doc from org.python.util.ConsoleInputStream.getLine. Get one line of input from the console. Override this method with the actions specific to the library in use. Returns:CharSequence Line entered by user Annotations @Override Exceptions IOException: in case of an error EOFException: if the library recognises an end-of-file condition

getLine

back to summary

protected CharSequence getLine() throws IOException, EOFException

Implements abstract org.python.util.ConsoleInputStream.getLine.

Doc from org.python.util.ConsoleInputStream.getLine.

Get one line of input from the console. Override this method with the actions specific to the library in use.

Returns:CharSequence

Line entered by user

Annotations