Package org.jline.reader.impl

Class InputRC

java.lang.Object

org.jline.reader.impl.InputRC

public final class InputRC
extends Object

Handles inputrc configuration files for JLine.

This class provides functionality for parsing and applying inputrc configuration files, which are used to customize key bindings and other behavior of the LineReader. The format is compatible with GNU Readline's inputrc files.

Key features include:

• Binding keys to functions or macros
• Setting variables that control LineReader behavior
• Conditional configuration based on terminal type

The configuration is typically loaded from a file specified by the LineReader.INPUT_RC_FILE_NAME variable, but can also be loaded from any input stream.

See Also:

• LineReader.INPUT_RC_FILE_NAME
• LineReader.getKeyMaps()

Field Summary

Fields

Modifier and Type	Field	Description
private final LineReader	reader

Constructor Summary

Constructors

Modifier	Constructor	Description
private	InputRC(LineReader reader)

Method Summary

Modifier and Type	Method	Description
static void	configure(LineReader reader, InputStream is)	Configures a LineReader from an inputrc file.
static void	configure(LineReader reader, Reader r)	Configures a LineReader from an inputrc file.
static void	configure(LineReader reader, URL url)	Configures a LineReader from an inputrc file at the specified URL.
private static char	getKeyFromName(String name)
private void	parse(BufferedReader br)
(package private) static void	setVar(LineReader reader, String key, String val)	Sets a variable in the LineReader.
private static String	translateQuoted(String keySeq)

Methods inherited from class java.lang.Object

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

Field Details

reader

private final LineReader reader

Constructor Details

InputRC

private InputRC(LineReader reader)

Method Details

configure

public static void configure(LineReader reader,
 URL url)
                      throws IOException

Configures a LineReader from an inputrc file at the specified URL.

This method opens the URL and passes the resulting input stream to configure(LineReader, InputStream).

Parameters:

reader - the LineReader to configure

url - the URL of the inputrc file

Throws:

IOException - if an I/O error occurs while reading the configuration

configure

public static void configure(LineReader reader,
 InputStream is)
                      throws IOException

Configures a LineReader from an inputrc file.

This method reads configuration commands from the provided input stream and passes them to configure(LineReader, Reader).

Parameters:

reader - the LineReader to configure

is - the input stream containing the configuration

Throws:

IOException - if an I/O error occurs while reading the configuration

configure

public static void configure(LineReader reader,
 Reader r)
                      throws IOException

Configures a LineReader from an inputrc file.

This method reads configuration commands from the provided reader and applies them to the LineReader. The format of the input is compatible with GNU Readline's inputrc files.

Parameters:

reader - the LineReader to configure

r - the reader containing the configuration

Throws:

IOException - if an I/O error occurs while reading the configuration

parse

private void parse(BufferedReader br)
            throws IOException,
IllegalArgumentException

Throws:

IOException

IllegalArgumentException

translateQuoted

private static String translateQuoted(String keySeq)

getKeyFromName

private static char getKeyFromName(String name)

setVar

static void setVar(LineReader reader,
 String key,
 String val)

Sets a variable in the LineReader.

This method handles special cases for certain variables, such as the keymap, and options that can be turned on or off.

Parameters:

reader - the LineReader to modify

key - the name of the variable to set

val - the value to set