org.gnu.readline
public class Readline extends Object
A typical implementation could look like:
try { Readline.load(ReadlineLibrary.GnuReadline); } catch (UnsatisfiedLinkError ignore_me) { System.err.println("couldn't load readline lib. Using simple stdin."); } Readline.initReadline("myapp"); Runtime.getRuntime() // if your version supports .addShutdownHook(new Thread() { // addShutdownHook (since 1.3) public void run() { Readline.cleanup(); } }); while (true) { try { line = Readline.readline("myprompt> "); if (line == null) System.out.println("no input"); else processLine(); } catch (EOFException e) { break; } catch (Exception e) { doSomething(); } } Readline.cleanup(); // see note above about addShutdownHook
Version: $Revision: 1.31 $
Field Summary | |
---|---|
static ReadlineConstInt | HISTORY_BASE
Constant to access history_base using
getVar() or setVar() .
|
static ReadlineConstInt | HISTORY_LENGTH
Constant to access history_length using
getVar() or setVar() .
|
static ReadlineConstInt | HISTORY_MAX_ENTRIES
Constant to access history_max_entries using
getVar() or setVar() .
|
static ReadlineConstString | HISTORY_NO_EXPAND_CHARS
Constant to access history_no_expand_chars using
getVar() or setVar() .
|
static ReadlineConstInt | HISTORY_QUOTES_EXPANSION
Constant to access history_quotes_inhibit_expansion using
getVar() or setVar() .
|
static ReadlineConstString | HISTORY_SEARCH_DELIMITERS
Constant to access history_search_delimiter_chars using
getVar() or setVar() .
|
static ReadlineConstString | HISTORY_WORD_DELIMITERS
Constant to access history_word_delimiters using
getVar() or setVar() .
|
static ReadlineConstInt | RL_ALREADY_PROMPTED
Constant to access rl_already_prompted using
getVar() or setVar() .
|
static ReadlineConstInt | RL_ATTEMPTED_COMPLETION_OVER
Constant to access rl_attempted_completion_over using
getVar() or setVar() .
|
static ReadlineConstString | RL_BASIC_QUOTE_CHARACTERS
Constant to access rl_basic_quote_characters using
getVar() or setVar() .
|
static ReadlineConstString | RL_BASIC_WORD_BREAK_CHARACTERS
Constant to access rl_basic_word_break_characters using
getVar() or setVar() .
|
static ReadlineConstInt | RL_CATCH_SIGNALS
Constant to access rl_catch_signals using
getVar() or setVar() .
|
static ReadlineConstInt | RL_CATCH_SIGWINCH
Constant to access rl_catch_sigwinch using
getVar() or setVar() .
|
static ReadlineConstString | RL_COMPLETER_QUOTE_CHARACTERS
Constant to access rl_completer_quote_characters using
getVar() or setVar() .
|
static ReadlineConstString | RL_COMPLETER_WORD_BREAK_CHARACTERS
Constant to access rl_completer_word_break_characters using
getVar() or setVar() .
|
static ReadlineConstInt | RL_COMPLETION_APPEND_CHARACTER
Constant to access rl_completion_append_character using
getVar() or setVar() .
|
static ReadlineConstInt | RL_COMPLETION_MARK_SYMLINK_DIRS
Constant to access rl_completion_mark_symlink_dirs using
getVar() or setVar() .
|
static ReadlineConstInt | RL_COMPLETION_QUERY_ITEMS
Constant to access rl_completion_query_items using
getVar() or setVar() .
|
static ReadlineConstInt | RL_COMPLETION_SUPPRESS_APPEND
Constant to access rl_completion_suppress_append using
getVar() or setVar() .
|
static ReadlineConstInt | RL_COMPLETION_TYPE
Constant to access rl_completion_type using
getVar() or setVar() .
|
static ReadlineConstInt | RL_DISPATCHING
Constant to access rl_dispatching using
getVar() or setVar() .
|
static ReadlineConstInt | RL_DONE
Constant to access rl_done using
getVar() or setVar() .
|
static ReadlineConstInt | RL_EDITING_MODE
Constant to access rl_editing_mode using
getVar() or setVar() .
|
static ReadlineConstInt | RL_END
Constant to access rl_end using
getVar() or setVar() .
|
static ReadlineConstInt | RL_ERASE_EMPTY_LINE
Constant to access rl_erase_empty_line using
getVar() or setVar() .
|
static ReadlineConstString | RL_EXECUTING_MACRO
Constant to access rl_executing_macro using
getVar() or setVar() .
|
static ReadlineConstInt | RL_EXPLICIT_ARG
Constant to access rl_explicit_arg using
getVar() or setVar() .
|
static ReadlineConstInt | RL_FILENAME_COMPLETION_DESIRED
Constant to access rl_filename_completion_desired using
getVar() or setVar() .
|
static ReadlineConstString | RL_FILENAME_QUOTE_CHARACTERS
Constant to access rl_filename_quote_characters using
getVar() or setVar() .
|
static ReadlineConstInt | RL_FILENAME_QUOTING_DESIRED
Constant to access rl_filename_quoting_desired using
getVar() or setVar() .
|
static ReadlineConstInt | RL_GNU_READLINE_P
Constant to access rl_gnu_readline_p using
getVar() or setVar() .
|
static ReadlineConstInt | RL_IGNORE_COMPLETION_DUPLICATES
Constant to access rl_ignore_completion_duplicates using
getVar() or setVar() .
|
static ReadlineConstInt | RL_INHIBIT_COMPLETION
Constant to access rl_inhibit_completion using
getVar() or setVar() .
|
static ReadlineConstInt | RL_INSERT_MODE
Constant to access rl_insert_mode using
getVar() or setVar() .
|
static ReadlineConstString | RL_LIBRARY_VERSION
Constant to access rl_library_version using
getVar() or setVar() .
|
static ReadlineConstString | RL_LINE_BUFFER
Constant to access rl_line_buffer using
getVar() or setVar() .
|
static ReadlineConstInt | RL_MARK
Constant to access rl_mark using
getVar() or setVar() .
|
static ReadlineConstInt | RL_NUMERIC_ARG
Constant to access rl_numeric_arg using
getVar() or setVar() .
|
static ReadlineConstInt | RL_NUM_CHARS_TO_READ
Constant to access rl_num_chars_to_read using
getVar() or setVar() .
|
static ReadlineConstInt | RL_PENDING_INPUT
Constant to access rl_pending_input using
getVar() or setVar() .
|
static ReadlineConstInt | RL_POINT
Constant to access rl_point using
getVar() or setVar() .
|
static ReadlineConstString | RL_PROMPT
Constant to access rl_prompt using
getVar() or setVar() .
|
static ReadlineConstString | RL_READLINE_NAME
Constant to access rl_readline_name using
getVar() or setVar() .
|
static ReadlineConstInt | RL_READLINE_STATE
Constant to access rl_readline_state using
getVar() or setVar() .
|
static ReadlineConstInt | RL_READLINE_VERSION
Constant to access rl_readline_version using
getVar() or setVar() .
|
static ReadlineConstString | RL_SPECIAL_PREFIXES
Constant to access rl_special_prefixes using
getVar() or setVar() .
|
static ReadlineConstString | RL_TERMINAL_NAME
Constant to access rl_terminal_name using
getVar() or setVar() .
|
Method Summary | |
---|---|
static void | addToHistory(String line)
Add a line to the in-memory history.
|
static void | cleanup()
Reset the readline library and with it, the terminal.
|
static void | clearHistory()
Clear the history buffer.
|
static ReadlineCompleter | getCompleter()
Query current completer function. |
static String | getEncoding()
Query current encoding of fallback BufferedReader. |
static void | getHistory(Collection collection)
Get the history buffer in a supplied Collection.
|
static String | getHistoryLine(int i)
Get the specified entry from the history buffer. |
static int | getHistorySize()
Get the size, in elements (lines), of the history buffer.
|
static String | getLineBuffer()
Query the current line buffer. |
static boolean | getThrowExceptionOnUnsupportedMethod()
Query behavior in case an unsupported method is called. |
static int | getVar(ReadlineConstInt c)
Query integer readline-variable. |
static String | getVar(ReadlineConstString c)
Query string readline-variable. |
static String | getWordBreakCharacters()
Query word break characters.
|
static boolean | hasTerminal()
Return if we have a terminal. |
static void | initReadline(String applicationName)
Initialize the GNU-Readline library. |
static void | load(ReadlineLibrary lib)
Load an implementing backing library. |
static boolean | parseAndBind(String line)
Parse argument string as if it had been read from `inputrc' file
and perform key bindings and variable assignments found.
|
static void | readHistoryFile(String filename)
Reads a history file into memory
Supporting implementations:
|
static void | readInitFile(String filename)
Read keybindings and variable assignments from a file. |
static String | readline(String prompt)
Display a prompt on standard output and read a string from standard
input. |
static String | readline(String prompt, boolean addToHist)
Display a prompt on standard output and read a string from
standard input. |
static void | setCompleter(ReadlineCompleter rlc)
Set your completer implementation. |
static void | setEncoding(String encoding)
Set current encoding of fallback BufferedReader. |
static void | setThrowExceptionOnUnsupportedMethod(boolean flag)
Configure behavior in case an unsupported method is called. |
static int | setVar(ReadlineConstInt c, int value)
Set integer readline-variable. |
static String | setVar(ReadlineConstString c, String value)
Set string readline-variable. |
static void | setWordBreakCharacters(String wordBreakCharacters)
Set word break characters.
|
static void | writeHistoryFile(String filename)
Writes a history file to disc
Supporting implementations:
|
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
getVar()
or setVar()
.
Supporting implementations:
Supporting implementations:
Parameters: line The line to add to the history
Throws: UnsupportOperationException if underlying library doesn't support a history
Supporting implementations:
Supporting implementations:
Returns: Current ReadlineCompleter object
Returns: current encoding
Supporting implementations:
Parameters: collection where to store the history
Throws: UnsupportOperationException if underlying library doesn't support a history
Supporting implementations:
Parameters: i the index of the entry to return
Returns: the line at the specified index in the history buffer
Throws: ArrayIndexOutOfBoundsException index out of range
Supporting implementations:
Returns: the number of lines in the history buffer
Supporting implementations:
Returns: configuration flag
Parameters: c symbolic constant of readline-variable
Returns: value of variable
Parameters: c symbolic constant of readline-variable
Returns: value of variable
Supporting implementations:
Supporting implementations:
Supporting implementations:
Parameters: applicationName Name of application in initialization file
Parameters: lib An object (constant) of type ReadlineLibrary
Throws: UnsatisfiedLinkError if the shared library could not be found. Add it to your LD_LIBRARY_PATH.
See Also: ReadlineLibrary
Supporting implementations:
Parameters: line Simulated line from inputrc file
Returns: boolean False in case of error
Supporting implementations:
Parameters: filename Name of history file to read
Supporting implementations:
Parameters: filename Name of file to read bindings from
Returns: void
Supporting implementations:
Parameters: prompt Prompt to display
Returns: The string the user entered or 'null' if there was no input.
Throws: EOFException on end-of-file, i.e. CTRL-d input.
Parameters: prompt Prompt to display addToHist true to add the line to the history automatically; false to refrain from adding the line to the history. (You can manually add the line to the history by calling addHistory().)
Returns: The string the user entered or 'null' if there was no input.
Throws: EOFException on end-of-file, i.e. CTRL-d input.
null
will result in the default behaviour of readline which is filename
completion.
Supporting implementations:
Parameters: rlc An object implementing the ReadlineCompleter interface
Parameters: encoding encoding to use
Parameters: flag configuration flag
Parameters: c symbolic constant of readline-variable value new value of readline-variable
Returns: old value of readline-variable
Parameters: c symbolic constant of readline-variable value new value of readline-variable
Returns: old value of readline-variable
Supporting implementations:
Parameters: wordBreakCharacters A string of word break characters
Supporting implementations:
Parameters: filename Name of history file to write