LineReaderImpl (JLine Reader 3.6.0 API)

java.lang.Object
- org.jline.reader.impl.LineReaderImpl

All Implemented Interfaces:

Flushable, LineReader
```
public class LineReaderImpl
extends Object
implements LineReader, Flushable
```
A reader for terminal applications. It supports custom tab-completion, saveable command history, and command line editing.

Author:

Marc Prud'hommeaux, Jason Dillon, Guillaume Nodet

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`LineReaderImpl.BellType`
`protected static class`	`LineReaderImpl.CompletionType`
`protected static class`	`LineReaderImpl.PostResult`
`protected static class`	`LineReaderImpl.State` Possible states in which the current readline operation may be in.
`protected static class`	`LineReaderImpl.ViMoveMode`

Nested classes/interfaces inherited from interface org.jline.reader.LineReader
LineReader.Option, LineReader.RegionType

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`appName` The application name
`protected BindingReader`	`bindingReader`
`static String`	`BRACKETED_PASTE_BEGIN`
`static String`	`BRACKETED_PASTE_END`
`static String`	`BRACKETED_PASTE_OFF`
`static String`	`BRACKETED_PASTE_ON`
`protected Buffer`	`buf`
`protected Map<String,Widget>`	`builtinWidgets`
`protected Completer`	`completer`
`protected int`	`count`
`static long`	`DEFAULT_AMBIGUOUS_BINDING`
`static String`	`DEFAULT_BELL_STYLE`
`static long`	`DEFAULT_BLINK_MATCHING_PAREN`
`static String`	`DEFAULT_COMMENT_BEGIN`
`static String`	`DEFAULT_COMPLETION_STYLE_DESCRIPTION`
`static String`	`DEFAULT_COMPLETION_STYLE_GROUP`
`static String`	`DEFAULT_COMPLETION_STYLE_SELECTION`
`static String`	`DEFAULT_COMPLETION_STYLE_STARTING`
`static int`	`DEFAULT_ERRORS`
`static int`	`DEFAULT_LIST_MAX`
`static String`	`DEFAULT_ORIGINAL_GROUP_NAME`
`static String`	`DEFAULT_OTHERS_GROUP_NAME`
`static String`	`DEFAULT_REMOVE_SUFFIX_CHARS`
`static String`	`DEFAULT_SEARCH_TERMINATORS`
`static String`	`DEFAULT_SECONDARY_PROMPT_PATTERN`
`static String`	`DEFAULT_WORDCHARS`
`protected Display`	`display`
`protected Expander`	`expander`
`protected int`	`findChar` VI character find
`protected int`	`findDir`
`protected int`	`findTailAdd`
`static String`	`FOCUS_IN_SEQ`
`static String`	`FOCUS_OUT_SEQ`
`protected Highlighter`	`highlighter`
`protected History`	`history`
`protected Buffer`	`historyBuffer`
`protected boolean`	`isArgDigit`
`protected boolean`	`isUndo`
`protected String`	`keyMap`
`protected Map<String,KeyMap<Binding>>`	`keyMaps` The terminal keys mapping
`protected KillRing`	`killRing`
`protected MaskingCallback`	`maskingCallback`
`protected Map<Integer,String>`	`modifiedHistory`
`protected int`	`mult`
`static char`	`NULL_MASK`
`protected Map<LineReader.Option,Boolean>`	`options`
`protected boolean`	`overTyping`
`protected ParsedLine`	`parsedLine`
`protected Parser`	`parser`
`protected Supplier<AttributedString>`	`post`
`protected AttributedString`	`prompt`
`protected boolean`	`reading`
`protected LineReader.RegionType`	`regionActive`
`protected int`	`regionMark` Region state
`protected int`	`repeatCount`
`protected AttributedString`	`rightPrompt`
`protected CharSequence`	`searchBuffer`
`protected int`	`searchIndex`
`protected StringBuffer`	`searchTerm`
`protected Size`	`size`
`protected boolean`	`skipRedisplay`
`protected int`	`smallTerminalOffset`
`protected LineReaderImpl.State`	`state`
`static int`	`TAB_WIDTH`
`protected Terminal`	`terminal` The terminal to use
`protected UndoTree<Buffer>`	`undo`
`protected int`	`universal`
`protected Map<String,Object>`	`variables`
`protected LineReaderImpl.ViMoveMode`	`viMoveMode`
`protected Map<String,Widget>`	`widgets`
`protected String`	`yankBuffer` The vi yank buffer

Fields inherited from interface org.jline.reader.LineReader
ACCEPT_LINE, AMBIGUOUS_BINDING, ARGUMENT_BASE, BACKWARD_CHAR, BACKWARD_DELETE_CHAR, BACKWARD_DELETE_WORD, BACKWARD_KILL_LINE, BACKWARD_KILL_WORD, BACKWARD_WORD, BEEP, BEGIN_PASTE, BEGINNING_OF_BUFFER_OR_HISTORY, BEGINNING_OF_HISTORY, BEGINNING_OF_LINE, BEGINNING_OF_LINE_HIST, BELL_STYLE, BIND_TTY_SPECIAL_CHARS, BLINK_MATCHING_PAREN, CALLBACK_FINISH, CALLBACK_INIT, CALLBACK_KEYMAP, CAPITALIZE_WORD, CHARACTER_SEARCH, CHARACTER_SEARCH_BACKWARD, CLEAR, CLEAR_SCREEN, COMMENT_BEGIN, COMPLETE_PREFIX, COMPLETE_WORD, COMPLETION_STYLE_DESCRIPTION, COMPLETION_STYLE_GROUP, COMPLETION_STYLE_SELECTION, COMPLETION_STYLE_STARTING, COPY_PREV_WORD, COPY_REGION_AS_KILL, DELETE_CHAR, DELETE_CHAR_OR_LIST, DELETE_WORD, DIGIT_ARGUMENT, DISABLE_COMPLETION, DISABLE_HISTORY, DO_LOWERCASE_VERSION, DOWN_CASE_WORD, DOWN_HISTORY, DOWN_LINE, DOWN_LINE_OR_HISTORY, DOWN_LINE_OR_SEARCH, EDITING_MODE, EMACS, EMACS_BACKWARD_WORD, EMACS_EDITING_MODE, EMACS_FORWARD_WORD, END_OF_BUFFER_OR_HISTORY, END_OF_HISTORY, END_OF_LINE, END_OF_LINE_HIST, ERRORS, EXCHANGE_POINT_AND_MARK, EXECUTE_NAMED_CMD, EXPAND_HISTORY, EXPAND_OR_COMPLETE, EXPAND_OR_COMPLETE_PREFIX, EXPAND_WORD, FOCUS_IN, FOCUS_OUT, FORWARD_CHAR, FORWARD_WORD, FRESH_LINE, HISTORY_BEGINNING_SEARCH_BACKWARD, HISTORY_BEGINNING_SEARCH_FORWARD, HISTORY_FILE, HISTORY_FILE_SIZE, HISTORY_IGNORE, HISTORY_INCREMENTAL_PATTERN_SEARCH_BACKWARD, HISTORY_INCREMENTAL_PATTERN_SEARCH_FORWARD, HISTORY_INCREMENTAL_SEARCH_BACKWARD, HISTORY_INCREMENTAL_SEARCH_FORWARD, HISTORY_SEARCH_BACKWARD, HISTORY_SEARCH_FORWARD, HISTORY_SIZE, INFER_NEXT_HISTORY, INSERT_CLOSE_CURLY, INSERT_CLOSE_PAREN, INSERT_CLOSE_SQUARE, INSERT_COMMENT, INSERT_LAST_WORD, KEYMAP, KILL_BUFFER, KILL_LINE, KILL_REGION, KILL_WHOLE_LINE, KILL_WORD, LINE_OFFSET, LIST_CHOICES, LIST_EXPAND, LIST_MAX, MAGIC_SPACE, MAIN, MENU, MENU_COMPLETE, MENU_EXPAND_OR_COMPLETE, MENU_SELECT, MOUSE, NEG_ARGUMENT, ORIGINAL_GROUP_NAME, OTHERS_GROUP_NAME, OVERWRITE_MODE, PREFER_VISIBLE_BELL, PUT_REPLACE_SELECTION, QUOTED_INSERT, READ_COMMAND, RECURSIVE_EDIT, REDISPLAY, REDO, REDRAW_LINE, REMOVE_SUFFIX_CHARS, REVERSE_MENU_COMPLETE, SAFE, SEARCH_TERMINATORS, SECONDARY_PROMPT_PATTERN, SELF_INSERT, SELF_INSERT_UNMETA, SEND_BREAK, SET_LOCAL_HISTORY, SET_MARK_COMMAND, SPELL_WORD, SPLIT_UNDO, TRANSPOSE_CHARS, TRANSPOSE_WORDS, UNDEFINED_KEY, UNDO, UNIVERSAL_ARGUMENT, UP_CASE_WORD, UP_HISTORY, UP_LINE, UP_LINE_OR_HISTORY, UP_LINE_OR_SEARCH, VI_ADD_EOL, VI_ADD_NEXT, VI_BACKWARD_BLANK_WORD, VI_BACKWARD_BLANK_WORD_END, VI_BACKWARD_CHAR, VI_BACKWARD_DELETE_CHAR, VI_BACKWARD_KILL_WORD, VI_BACKWARD_WORD, VI_BACKWARD_WORD_END, VI_BEGINNING_OF_LINE, VI_CHANGE, VI_CHANGE_EOL, VI_CHANGE_WHOLE_LINE, VI_CMD_MODE, VI_DELETE, VI_DELETE_CHAR, VI_DIGIT_OR_BEGINNING_OF_LINE, VI_DOWN_LINE_OR_HISTORY, VI_END_OF_LINE, VI_FETCH_HISTORY, VI_FIND_NEXT_CHAR, VI_FIND_NEXT_CHAR_SKIP, VI_FIND_PREV_CHAR, VI_FIND_PREV_CHAR_SKIP, VI_FIRST_NON_BLANK, VI_FORWARD_BLANK_WORD, VI_FORWARD_BLANK_WORD_END, VI_FORWARD_CHAR, VI_FORWARD_WORD, VI_FORWARD_WORD_END, VI_GOTO_COLUMN, VI_HISTORY_SEARCH_BACKWARD, VI_HISTORY_SEARCH_FORWARD, VI_INSERT, VI_INSERT_BOL, VI_INSERT_COMMENT, VI_JOIN, VI_KILL_EOL, VI_KILL_LINE, VI_MATCH_BRACKET, VI_OPEN_LINE_ABOVE, VI_OPEN_LINE_BELOW, VI_OPER_SWAP_CASE, VI_PUT_AFTER, VI_PUT_BEFORE, VI_QUOTED_INSERT, VI_REPEAT_CHANGE, VI_REPEAT_FIND, VI_REPEAT_SEARCH, VI_REPLACE, VI_REPLACE_CHARS, VI_REV_REPEAT_FIND, VI_REV_REPEAT_SEARCH, VI_SET_BUFFER, VI_SUBSTITUTE, VI_SWAP_CASE, VI_UNDO_CHANGE, VI_UP_LINE_OR_HISTORY, VI_YANK, VI_YANK_EOL, VI_YANK_WHOLE_LINE, VICMD, VIINS, VIOPP, VISUAL, VISUAL_LINE_MODE, VISUAL_MODE, WHAT_CURSOR_POSITION, WORDCHARS, YANK, YANK_POP

Constructor Summary

Constructors
Constructor and Description
`LineReaderImpl(Terminal terminal)`
`LineReaderImpl(Terminal terminal, String appName)`
`LineReaderImpl(Terminal terminal, String appName, Map<String,Object> variables)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`acceptLine()`
`protected boolean`	`argumentBase()`
`protected boolean`	`backwardChar()`
`protected boolean`	`backwardDeleteChar()`
`protected boolean`	`backwardDeleteWord()`
`boolean`	`backwardKillLine()`
`protected boolean`	`backwardKillWord()`
`protected boolean`	`backwardWord()`
`boolean`	`beep()` Issue an audible keyboard bell.
`protected boolean`	`beginningOfBufferOrHistory()`
`protected boolean`	`beginningOfHistory()`
`protected boolean`	`beginningOfLine()`
`protected boolean`	`beginningOfLineHist()`
`boolean`	`beginPaste()`
`protected AttributedStyle`	`buildStyle(String str)`
`protected Map<String,Widget>`	`builtinWidgets()`
`void`	`callWidget(String name)`
`protected boolean`	`capitalizeWord()`
`protected void`	`cleanup()`
`boolean`	`clear()` Clean the used display
`boolean`	`clearScreen()` Clear the screen by issuing the ANSI "clear screen" code.
`protected boolean`	`completePrefix()`
`protected boolean`	`completeWord()`
`protected LineReaderImpl.PostResult`	`computePost(List<Candidate> possible, Candidate selection, List<Candidate> ordered, String completed)`
`protected LineReaderImpl.PostResult`	`computePost(List<Candidate> possible, Candidate selection, List<Candidate> ordered, String completed, Function<String,Integer> wcwidth, int width, boolean autoGroup, boolean groupName, boolean rowsFirst)`
`protected boolean`	`copyPrevWord()`
`boolean`	`copyRegionAsKill()`
`protected boolean`	`deactivateRegion()`
`Map<String,KeyMap<Binding>>`	`defaultKeyMaps()`
`protected boolean`	`deleteChar()`
`protected boolean`	`deleteCharOrList()`
`protected boolean`	`deleteWord()`
`protected boolean`	`digitArgument()`
`protected void`	`doCleanup()`
`protected boolean`	`doComplete(LineReaderImpl.CompletionType lst, boolean useMenu, boolean prefix)`
`protected boolean`	`doInsertComment(boolean isViMode)`
`protected boolean`	`doList(List<Candidate> possible, String completed, boolean runLoop)`
`protected boolean`	`doLowercaseVersion()`
`protected boolean`	`doMenu(List<Candidate> original, String completed)`
`protected boolean`	`doSearchHistory(boolean backward)`
`protected boolean`	`doViDeleteOrChange(int startPos, int endPos, boolean isChange)` Performs the vi "delete-to" action, deleting characters between a given span of the input line.
`protected boolean`	`doViMatchBracket()` Implements vi style bracket matching ("%" command).
`protected boolean`	`downCaseWord()`
`protected boolean`	`downHistory()`
`protected boolean`	`downLine()`
`protected boolean`	`downLineOrHistory()`
`protected boolean`	`downLineOrSearch()`
`KeyMap<Binding>`	`emacs()`
`protected boolean`	`emacsBackwardWord()`
`protected boolean`	`emacsEditingMode()`
`protected boolean`	`emacsForwardWord()`
`protected boolean`	`endOfBufferOrHistory()`
`protected boolean`	`endOfHistory()`
`protected boolean`	`endOfLine()`
`protected boolean`	`endOfLineHist()`
`protected boolean`	`exchangePointAndMark()`
`protected boolean`	`expandHistory()`
`protected boolean`	`expandOrComplete()`
`protected boolean`	`expandOrCompletePrefix()`
`protected boolean`	`expandWord()`
`protected String`	`finishBuffer()` Clear the buffer and add its contents to the history.
`void`	`flush()` Flush the terminal output stream.
`boolean`	`focusIn()`
`boolean`	`focusOut()`
`protected boolean`	`forwardChar()`
`protected boolean`	`forwardWord()`
`protected boolean`	`freshLine()` Make sure we position the cursor on column 0
`String`	`getAppName()`
`protected int`	`getBracketType(int ch)` Given a character determines what type of bracket it is (paren, square, curly, or none).
`Buffer`	`getBuffer()`
`Map<String,Widget>`	`getBuiltinWidgets()`
`protected Comparator<Candidate>`	`getCandidateComparator(boolean caseInsensitive, String word)`
`Completer`	`getCompleter()` Returns the completer.
`protected AttributedStyle`	`getCompletionStyle(String name, String value)`
`protected AttributedStyle`	`getCompletionStyleDescription()`
`protected AttributedStyle`	`getCompletionStyleGroup()`
`protected AttributedStyle`	`getCompletionStyleSelection()`
`AttributedString`	`getDisplayedBufferWithPrompts(List<AttributedString> secondaryPrompts)` Compute the full string to be displayed with the left, right and secondary prompts
`Expander`	`getExpander()`
`protected Comparator<String>`	`getGroupComparator()`
`Highlighter`	`getHighlighter()`
`History`	`getHistory()`
`String`	`getKeyMap()` Returns the name of the current key mapping.
`Map<String,KeyMap<Binding>>`	`getKeyMaps()`
`KeyMap<Binding>`	`getKeys()`
`String`	`getLastBinding()`
`protected String`	`getOriginalGroupName()`
`protected String`	`getOthersGroupName()`
`ParsedLine`	`getParsedLine()`
`Parser`	`getParser()`
`LineReader.RegionType`	`getRegionActive()`
`int`	`getRegionMark()`
`String`	`getSearchTerm()`
`Terminal`	`getTerminal()`
`Object`	`getVariable(String name)`
`Map<String,Object>`	`getVariables()`
`protected Widget`	`getWidget(Object binding)`
`Map<String,Widget>`	`getWidgets()`
`protected void`	`handleSignal(Terminal.Signal signal)`
`protected boolean`	`historyIncrementalSearchBackward()`
`protected boolean`	`historyIncrementalSearchForward()`
`protected boolean`	`historySearchBackward()`
`protected boolean`	`historySearchForward()`
`protected boolean`	`insertClose(String s)`
`protected boolean`	`insertCloseCurly()`
`protected boolean`	`insertCloseParen()`
`protected boolean`	`insertCloseSquare()`
`protected boolean`	`insertComment()`
`protected boolean`	`insertTab()`
`protected boolean`	`isAlpha(int c)`
`protected boolean`	`isDelimiter(int c)` Checks to see if the specified character is a delimiter.
`protected boolean`	`isInViChangeOperation()`
`protected boolean`	`isInViCmdMode()`
`protected boolean`	`isInViMoveOperation()`
`boolean`	`isKeyMap(String name)`
`boolean`	`isSet(LineReader.Option option)`
`protected boolean`	`isViAlphaNum(int c)`
`protected boolean`	`isWhitespace(int c)` Checks to see if a character is a whitespace character.
`protected boolean`	`isWord(int c)`
`protected boolean`	`killBuffer()`
`boolean`	`killLine()` Kill the buffer ahead of the current cursor position.
`boolean`	`killRegion()`
`protected boolean`	`killWholeLine()`
`protected boolean`	`killWord()`
`protected boolean`	`listChoices()`
`KeyMap<Binding>`	`menu()`
`protected boolean`	`menuComplete()`
`protected boolean`	`menuExpandOrComplete()`
`boolean`	`mouse()`
`protected boolean`	`moveHistory(boolean next)` Move up or down the history tree.
`protected boolean`	`moveHistory(boolean next, int count)` Used in "vi" mode for argumented history move, to move a specific number of history entries forward or back.
`protected boolean`	`negArgument()`
`protected boolean`	`nextBindingIsComplete()`
`LineReader`	`option(LineReader.Option option, boolean value)`
`protected boolean`	`overwriteMode()`
`int`	`peekCharacter(long timeout)`
`void`	`printSearchStatus(String searchTerm, String match, boolean backward)`
`void`	`putString(CharSequence str)` Write out the specified string to the buffer and the output stream.
`protected boolean`	`quit()`
`protected boolean`	`quotedInsert()`
`Binding`	`readBinding(KeyMap<Binding> keys)` Read from the input stream and decode an operation from the key map.
`Binding`	`readBinding(KeyMap<Binding> keys, KeyMap<Binding> local)`
`int`	`readCharacter()` Read a character from the terminal.
`String`	`readLine()` Read the next line and return the contents of the buffer.
`String`	`readLine(Character mask)` Read the next line with the specified character mask.
`String`	`readLine(String prompt)` Read the next line with the specified prompt.
`String`	`readLine(String prompt, Character mask)` Read a line from the in `InputStream`, and return the line (without any trailing newlines).
`String`	`readLine(String prompt, Character mask, String buffer)` Read a line from the in `InputStream`, and return the line (without any trailing newlines).
`String`	`readLine(String prompt, String rightPrompt, Character mask, String buffer)` Read a line from the in `InputStream`, and return the line (without any trailing newlines).
`String`	`readLine(String prompt, String rightPrompt, MaskingCallback maskingCallback, String buffer)` Read a line from the in `InputStream`, and return the line (without any trailing newlines).
`MouseEvent`	`readMouseEvent()` Read a mouse event when the `InfoCmp.Capability.key_mouse` sequence has just been read on the input stream.
`boolean`	`redisplay()`
`protected void`	`redisplay(boolean flush)`
`protected boolean`	`redo()`
`boolean`	`redrawLine()` Clear the line and redraw it.
`void`	`runMacro(String macro)` Push back a key sequence that will be later consumed by the line reader.
`KeyMap<Binding>`	`safe()`
`int`	`searchBackwards(String searchTerm)` Search backwards in history from the current position.
`int`	`searchBackwards(String searchTerm, int startIndex)` Search backward in history from a given position.
`int`	`searchBackwards(String searchTerm, int startIndex, boolean startsWith)`
`int`	`searchForwards(String searchTerm)` Search forwards in history from the current position.
`int`	`searchForwards(String searchTerm, int startIndex)` Search forward in history from a given position.
`int`	`searchForwards(String searchTerm, int startIndex, boolean startsWith)`
`protected boolean`	`selfInsert()`
`protected boolean`	`selfInsertUnmeta()`
`protected boolean`	`sendBreak()`
`protected void`	`setBuffer(Buffer buffer)`
`protected void`	`setBuffer(String buffer)` Set the current buffer's content to the specified `String`.
`void`	`setCompleter(Completer completer)` Set the completer.
`void`	`setExpander(Expander expander)`
`void`	`setHighlighter(Highlighter highlighter)`
`void`	`setHistory(History history)`
`boolean`	`setKeyMap(String name)` Sets the current keymap by name.
`protected boolean`	`setMarkCommand()`
`void`	`setOpt(LineReader.Option option)`
`void`	`setParser(Parser parser)`
`protected void`	`setPrompt(String prompt)`
`protected void`	`setRightPrompt(String rightPrompt)`
`void`	`setVariable(String name, Object value)`
`protected int`	`switchCase(int ch)`
`protected LineReaderImpl.PostResult`	`toColumns(List<Object> items, Candidate selection, String completed, Function<String,Integer> wcwidth, int width, boolean rowsFirst)`
`protected void`	`toColumns(Object items, int width, int maxWidth, AttributedStringBuilder sb, Candidate selection, String completed, boolean rowsFirst, int[] out)`
`protected boolean`	`transposeChars()` Performs character transpose.
`protected boolean`	`transposeWords()`
`protected boolean`	`undefinedKey()`
`protected boolean`	`undo()`
`protected boolean`	`universalArgument()`
`void`	`unsetOpt(LineReader.Option option)`
`protected boolean`	`upCaseWord()`
`protected boolean`	`upHistory()`
`protected boolean`	`upLine()`
`protected boolean`	`upLineOrHistory()`
`protected boolean`	`upLineOrSearch()`
`LineReader`	`variable(String name, Object value)`
`protected boolean`	`viAddEol()`
`protected boolean`	`viAddNext()`
`protected boolean`	`viBackwardBlankWord()`
`protected boolean`	`viBackwardBlankWordEnd()`
`protected boolean`	`viBackwardChar()`
`protected boolean`	`viBackwardDeleteChar()` Deletes the previous character from the cursor position
`protected boolean`	`viBackwardKillWord()`
`protected boolean`	`viBackwardWord()`
`protected boolean`	`viBackwardWordEnd()`
`protected boolean`	`viBeginningOfLine()`
`protected boolean`	`viChange()`
`protected boolean`	`viChange(int startPos, int endPos)`
`protected boolean`	`viChangeEol()`
`protected boolean`	`viChangeWholeLine()`
`KeyMap<Binding>`	`viCmd()`
`protected boolean`	`viCmdMode()`
`protected boolean`	`viDelete()`
`protected String`	`viDeleteChangeYankToRemap(String op)` This method is calling while doing a delete-to ("d"), change-to ("c"), or yank-to ("y") and it filters out only those movement operations that are allowable during those operations.
`protected boolean`	`viDeleteChar()` Deletes the character you are sitting on and sucks the rest of the line in from the right.
`protected boolean`	`viDeleteTo(int startPos, int endPos)`
`protected boolean`	`viDigitOrBeginningOfLine()`
`protected boolean`	`viDownLineOrHistory()`
`protected boolean`	`viEndOfLine()`
`protected boolean`	`viFindNextChar()`
`protected boolean`	`viFindNextCharSkip()`
`protected boolean`	`viFindPrevChar()`
`protected boolean`	`viFindPrevCharSkip()`
`protected boolean`	`viFirstNonBlank()`
`protected boolean`	`viForwardBlankWord()`
`protected boolean`	`viForwardBlankWordEnd()`
`protected boolean`	`viForwardChar()`
`protected boolean`	`viForwardWord()`
`protected boolean`	`viForwardWordEnd()`
`protected boolean`	`viHistorySearchBackward()`
`protected boolean`	`viHistorySearchForward()` Implements vi search ("/" or "?").
`protected boolean`	`viInsert()`
`protected boolean`	`viInsertBol()`
`protected boolean`	`viInsertComment()`
`KeyMap<Binding>`	`viInsertion()`
`protected boolean`	`viJoin()`
`protected boolean`	`viKillEol()`
`protected boolean`	`viKillWholeLine()`
`protected boolean`	`viMatchBracket()`
`protected boolean`	`viOpenLineAbove()`
`protected boolean`	`viOpenLineBelow()`
`KeyMap<Binding>`	`viOpp()`
`protected boolean`	`viPutAfter()` Pasts the yank buffer to the right of the current cursor position and moves the cursor to the end of the pasted region.
`protected boolean`	`viPutBefore()`
`protected boolean`	`viRepeatFind()`
`protected boolean`	`viRepeatSearch()`
`protected boolean`	`viReplaceChars()` Implements the vi change character command (in move-mode "r" followed by the character to change to).
`protected boolean`	`viRevRepeatFind()`
`protected boolean`	`viRevRepeatSearch()`
`KeyMap<Binding>`	`visual()`
`protected boolean`	`visualLineMode()`
`protected boolean`	`visualMode()`
`protected boolean`	`viSwapCase()` Switches the case of the current character from upper to lower or lower to upper as necessary and advances the cursor one position to the right.
`protected boolean`	`viUpLineOrHistory()`
`protected boolean`	`viYankTo()`
`protected boolean`	`viYankTo(int startPos, int endPos)` Implement the "vi" yank-to operation.
`protected boolean`	`viYankWholeLine()`
`protected boolean`	`whatCursorPosition()`
`boolean`	`yank()`
`boolean`	`yankPop()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NULL_MASK
```
public static final char NULL_MASK
```
See Also:

Constant Field Values

TAB_WIDTH
```
public static final int TAB_WIDTH
```
See Also:

Constant Field Values

DEFAULT_WORDCHARS

public static final String DEFAULT_WORDCHARS

See Also:: Constant Field Values

DEFAULT_REMOVE_SUFFIX_CHARS

public static final String DEFAULT_REMOVE_SUFFIX_CHARS

See Also:: Constant Field Values

DEFAULT_COMMENT_BEGIN

public static final String DEFAULT_COMMENT_BEGIN

See Also:: Constant Field Values

DEFAULT_SEARCH_TERMINATORS

public static final String DEFAULT_SEARCH_TERMINATORS

See Also:: Constant Field Values

DEFAULT_BELL_STYLE

public static final String DEFAULT_BELL_STYLE

See Also:: Constant Field Values

DEFAULT_LIST_MAX
```
public static final int DEFAULT_LIST_MAX
```
See Also:

Constant Field Values

DEFAULT_ERRORS
```
public static final int DEFAULT_ERRORS
```
See Also:

Constant Field Values

DEFAULT_BLINK_MATCHING_PAREN
```
public static final long DEFAULT_BLINK_MATCHING_PAREN
```
See Also:

Constant Field Values

DEFAULT_AMBIGUOUS_BINDING
```
public static final long DEFAULT_AMBIGUOUS_BINDING
```
See Also:

Constant Field Values

DEFAULT_SECONDARY_PROMPT_PATTERN

public static final String DEFAULT_SECONDARY_PROMPT_PATTERN

See Also:: Constant Field Values

DEFAULT_OTHERS_GROUP_NAME

public static final String DEFAULT_OTHERS_GROUP_NAME

See Also:: Constant Field Values

DEFAULT_ORIGINAL_GROUP_NAME

public static final String DEFAULT_ORIGINAL_GROUP_NAME

See Also:: Constant Field Values

DEFAULT_COMPLETION_STYLE_STARTING

public static final String DEFAULT_COMPLETION_STYLE_STARTING

See Also:: Constant Field Values

DEFAULT_COMPLETION_STYLE_DESCRIPTION

public static final String DEFAULT_COMPLETION_STYLE_DESCRIPTION

See Also:: Constant Field Values

DEFAULT_COMPLETION_STYLE_GROUP

public static final String DEFAULT_COMPLETION_STYLE_GROUP

See Also:: Constant Field Values

DEFAULT_COMPLETION_STYLE_SELECTION

public static final String DEFAULT_COMPLETION_STYLE_SELECTION

See Also:: Constant Field Values

BRACKETED_PASTE_ON

public static final String BRACKETED_PASTE_ON

See Also:: Constant Field Values

BRACKETED_PASTE_OFF

public static final String BRACKETED_PASTE_OFF

See Also:: Constant Field Values

BRACKETED_PASTE_BEGIN

public static final String BRACKETED_PASTE_BEGIN

See Also:: Constant Field Values

BRACKETED_PASTE_END

public static final String BRACKETED_PASTE_END

See Also:: Constant Field Values

FOCUS_IN_SEQ

public static final String FOCUS_IN_SEQ

See Also:: Constant Field Values

FOCUS_OUT_SEQ

public static final String FOCUS_OUT_SEQ

See Also:: Constant Field Values

terminal
```
protected final Terminal terminal
```
The terminal to use

appName
```
protected final String appName
```
The application name

keyMaps

protected final Map<String,KeyMap<Binding>> keyMaps

The terminal keys mapping

variables

protected final Map<String,Object> variables

history
```
protected History history
```

completer
```
protected Completer completer
```

highlighter
```
protected Highlighter highlighter
```

parser
```
protected Parser parser
```

expander
```
protected Expander expander
```

options

protected final Map<LineReader.Option,Boolean> options

buf
```
protected final Buffer buf
```

size
```
protected final Size size
```

prompt
```
protected AttributedString prompt
```

rightPrompt
```
protected AttributedString rightPrompt
```

maskingCallback

protected MaskingCallback maskingCallback

modifiedHistory

protected Map<Integer,String> modifiedHistory

historyBuffer
```
protected Buffer historyBuffer
```

searchBuffer
```
protected CharSequence searchBuffer
```

searchTerm
```
protected StringBuffer searchTerm
```

searchIndex
```
protected int searchIndex
```

bindingReader

protected final BindingReader bindingReader

findChar
```
protected int findChar
```
VI character find

findDir
```
protected int findDir
```

findTailAdd
```
protected int findTailAdd
```

regionMark
```
protected int regionMark
```
Region state

regionActive

protected LineReader.RegionType regionActive

yankBuffer
```
protected String yankBuffer
```
The vi yank buffer

viMoveMode

protected LineReaderImpl.ViMoveMode viMoveMode

killRing
```
protected KillRing killRing
```

undo
```
protected UndoTree<Buffer> undo
```

isUndo
```
protected boolean isUndo
```

state
```
protected LineReaderImpl.State state
```

reading
```
protected boolean reading
```

post

protected Supplier<AttributedString> post

builtinWidgets

protected Map<String,Widget> builtinWidgets

widgets
```
protected Map<String,Widget> widgets
```

count
```
protected int count
```

mult
```
protected int mult
```

universal
```
protected int universal
```

repeatCount
```
protected int repeatCount
```

isArgDigit
```
protected boolean isArgDigit
```

parsedLine
```
protected ParsedLine parsedLine
```

skipRedisplay
```
protected boolean skipRedisplay
```

display
```
protected Display display
```

overTyping
```
protected boolean overTyping
```

keyMap
```
protected String keyMap
```

smallTerminalOffset
```
protected int smallTerminalOffset
```

Constructor Detail

LineReaderImpl

public LineReaderImpl(Terminal terminal)
               throws IOException

Throws:: IOException

LineReaderImpl

public LineReaderImpl(Terminal terminal,
                      String appName)
               throws IOException

Throws:: IOException

LineReaderImpl

public LineReaderImpl(Terminal terminal,
                      String appName,
                      Map<String,Object> variables)

Method Detail

getTerminal
```
public Terminal getTerminal()
```
Specified by:

getTerminal in interface LineReader

getAppName
```
public String getAppName()
```

getKeyMaps
```
public Map<String,KeyMap<Binding>> getKeyMaps()
```
Specified by:

getKeyMaps in interface LineReader

getKeys
```
public KeyMap<Binding> getKeys()
```
Specified by:

getKeys in interface LineReader

getWidgets
```
public Map<String,Widget> getWidgets()
```
Specified by:

getWidgets in interface LineReader

getBuiltinWidgets
```
public Map<String,Widget> getBuiltinWidgets()
```
Specified by:

getBuiltinWidgets in interface LineReader

getBuffer
```
public Buffer getBuffer()
```
Specified by:

getBuffer in interface LineReader

runMacro
```
public void runMacro(String macro)
```
Description copied from interface: LineReader

Push back a key sequence that will be later consumed by the line reader. This method can be used after reading the cursor position using Terminal.getCursorPosition(IntConsumer).

Specified by:

runMacro in interface LineReader

Parameters:

macro - the key sequence to push back

See Also:

Terminal.getCursorPosition(IntConsumer), LineReader.readMouseEvent()

readMouseEvent
```
public MouseEvent readMouseEvent()
```
Description copied from interface: LineReader

Read a mouse event when the InfoCmp.Capability.key_mouse sequence has just been read on the input stream. Compared to Terminal.readMouseEvent(), this method takes into account keys that have been pushed back using LineReader.runMacro(String).

Specified by:

readMouseEvent in interface LineReader

Returns:

the mouse event

See Also:

LineReader.runMacro(String), Terminal.getCursorPosition(IntConsumer)

setCompleter

public void setCompleter(Completer completer)

Set the completer.

getCompleter
```
public Completer getCompleter()
```
Returns the completer.

setHistory

public void setHistory(History history)

getHistory
```
public History getHistory()
```
Specified by:

getHistory in interface LineReader

setHighlighter

public void setHighlighter(Highlighter highlighter)

getHighlighter
```
public Highlighter getHighlighter()
```
Specified by:

getHighlighter in interface LineReader

getParser
```
public Parser getParser()
```
Specified by:

getParser in interface LineReader

setParser
```
public void setParser(Parser parser)
```

getExpander
```
public Expander getExpander()
```
Specified by:

getExpander in interface LineReader

setExpander

public void setExpander(Expander expander)

readLine
```
public String readLine()
                throws UserInterruptException,
                       EndOfFileException
```
Read the next line and return the contents of the buffer.

Specified by:

readLine in interface LineReader

Throws:

UserInterruptException

EndOfFileException

readLine
```
public String readLine(Character mask)
                throws UserInterruptException,
                       EndOfFileException
```
Read the next line with the specified character mask. If null, then characters will be echoed. If 0, then no characters will be echoed.

Specified by:

readLine in interface LineReader

Throws:

UserInterruptException

EndOfFileException

readLine
```
public String readLine(String prompt)
                throws UserInterruptException,
                       EndOfFileException
```
Description copied from interface: LineReader

Read the next line with the specified prompt. If null, then the default prompt will be used. Equivalent to readLine(prompt, null, null)

Specified by:

readLine in interface LineReader

Throws:

UserInterruptException

EndOfFileException

readLine
```
public String readLine(String prompt,
                       Character mask)
                throws UserInterruptException,
                       EndOfFileException
```
Read a line from the in InputStream, and return the line (without any trailing newlines).

Specified by:

readLine in interface LineReader

Parameters:

prompt - The prompt to issue to the terminal, may be null.

Returns:

A line that is read from the terminal, or null if there was null input (e.g., CTRL-D was pressed).

Throws:

UserInterruptException

EndOfFileException

readLine
```
public String readLine(String prompt,
                       Character mask,
                       String buffer)
                throws UserInterruptException,
                       EndOfFileException
```
Read a line from the in InputStream, and return the line (without any trailing newlines).

Specified by:

readLine in interface LineReader

Parameters:

prompt - The prompt to issue to the terminal, may be null.

mask - The character mask, may be null.

buffer - The default value presented to the user to edit, may be null.

Returns:

A line that is read from the terminal, or null if there was null input (e.g., CTRL-D was pressed).

Throws:

UserInterruptException

EndOfFileException

readLine
```
public String readLine(String prompt,
                       String rightPrompt,
                       Character mask,
                       String buffer)
                throws UserInterruptException,
                       EndOfFileException
```
Read a line from the in InputStream, and return the line (without any trailing newlines).

Specified by:

readLine in interface LineReader

Parameters:

prompt - The prompt to issue to the terminal, may be null.

rightPrompt - The right prompt This is a template, with optional '%' escapes, as described in the class header.

mask - The character mask, may be null.

buffer - The default value presented to the user to edit, may be null.

Returns:

A line that is read from the terminal, or null if there was null input (e.g., CTRL-D was pressed).

Throws:

UserInterruptException - if readLine was interrupted (using Ctrl-C for example)

EndOfFileException - if an EOF has been found (using Ctrl-D for example)

readLine
```
public String readLine(String prompt,
                       String rightPrompt,
                       MaskingCallback maskingCallback,
                       String buffer)
                throws UserInterruptException,
                       EndOfFileException
```
Description copied from interface: LineReader

Read a line from the in InputStream, and return the line (without any trailing newlines).

Specified by:

readLine in interface LineReader

Parameters:

prompt - The prompt to issue to the terminal, may be null. This is a template, with optional '%' escapes, as described in the class header.

rightPrompt - The right prompt This is a template, with optional '%' escapes, as described in the class header.

maskingCallback - The MaskingCallback to use when displaying lines and adding them to the line History

buffer - The default value presented to the user to edit, may be null.

Returns:

A line that is read from the terminal, can never be null.

Throws:

UserInterruptException - if readLine was interrupted (using Ctrl-C for example)

EndOfFileException - if an EOF has been found (using Ctrl-D for example)

freshLine
```
protected boolean freshLine()
```
Make sure we position the cursor on column 0

callWidget
```
public void callWidget(String name)
```
Specified by:

callWidget in interface LineReader

redrawLine
```
public boolean redrawLine()
```
Clear the line and redraw it.

putString
```
public void putString(CharSequence str)
```
Write out the specified string to the buffer and the output stream.

flush
```
public void flush()
```
Flush the terminal output stream. This is important for printout out single characters (like a buf.backspace or keyboard) that we want the terminal to handle immediately.

Specified by:

flush in interface Flushable

isKeyMap
```
public boolean isKeyMap(String name)
```

readCharacter
```
public int readCharacter()
```
Read a character from the terminal.

Returns:

the character, or -1 if an EOF is received.

peekCharacter

public int peekCharacter(long timeout)

readBinding
```
public Binding readBinding(KeyMap<Binding> keys)
```
Read from the input stream and decode an operation from the key map. The input stream will be read character by character until a matching binding can be found. Characters that can't possibly be matched to any binding will be discarded.

Parameters:

keys - the KeyMap to use for decoding the input stream

Returns:

the decoded binding or null if the end of stream has been reached

readBinding

public Binding readBinding(KeyMap<Binding> keys,
                           KeyMap<Binding> local)

getParsedLine
```
public ParsedLine getParsedLine()
```
Specified by:

getParsedLine in interface LineReader

getLastBinding
```
public String getLastBinding()
```

getSearchTerm
```
public String getSearchTerm()
```
Specified by:

getSearchTerm in interface LineReader

getRegionActive
```
public LineReader.RegionType getRegionActive()
```
Specified by:

getRegionActive in interface LineReader

getRegionMark
```
public int getRegionMark()
```
Specified by:

getRegionMark in interface LineReader

setKeyMap
```
public boolean setKeyMap(String name)
```
Sets the current keymap by name. Supported keymaps are "emacs", "viins", "vicmd".

Specified by:

setKeyMap in interface LineReader

Parameters:

name - The name of the keymap to switch to

Returns:

true if the keymap was set, or false if the keymap is not recognized.

getKeyMap
```
public String getKeyMap()
```
Returns the name of the current key mapping.

Specified by:

getKeyMap in interface LineReader

Returns:

the name of the key mapping. This will be the canonical name of the current mode of the key map and may not reflect the name that was used with setKeyMap(String).

variable

public LineReader variable(String name,
                           Object value)

Specified by:: variable in interface LineReader

getVariables
```
public Map<String,Object> getVariables()
```
Specified by:

getVariables in interface LineReader

getVariable
```
public Object getVariable(String name)
```
Specified by:

getVariable in interface LineReader

setVariable

public void setVariable(String name,
                        Object value)

Specified by:: setVariable in interface LineReader

option

public LineReader option(LineReader.Option option,
                         boolean value)

Specified by:: option in interface LineReader

isSet

public boolean isSet(LineReader.Option option)

Specified by:: isSet in interface LineReader

setOpt

public void setOpt(LineReader.Option option)

Specified by:: setOpt in interface LineReader

unsetOpt

public void unsetOpt(LineReader.Option option)

Specified by:: unsetOpt in interface LineReader

finishBuffer
```
protected String finishBuffer()
```
Clear the buffer and add its contents to the history.

Returns:

the former contents of the buffer.

handleSignal

protected void handleSignal(Terminal.Signal signal)

getWidget

protected Widget getWidget(Object binding)

setPrompt

protected void setPrompt(String prompt)

setRightPrompt

protected void setRightPrompt(String rightPrompt)

setBuffer

protected void setBuffer(Buffer buffer)

setBuffer
```
protected void setBuffer(String buffer)
```
Set the current buffer's content to the specified String. The visual terminal will be modified to show the current buffer.

Parameters:

buffer - the new contents of the buffer.

viDeleteChangeYankToRemap
```
protected String viDeleteChangeYankToRemap(String op)
```
This method is calling while doing a delete-to ("d"), change-to ("c"), or yank-to ("y") and it filters out only those movement operations that are allowable during those operations. Any operation that isn't allow drops you back into movement mode.

Parameters:

op - The incoming operation to remap

Returns:

The remaped operation

switchCase
```
protected int switchCase(int ch)
```

isInViMoveOperation
```
protected boolean isInViMoveOperation()
```
Returns:

true if line reader is in the middle of doing a change-to delete-to or yank-to.

isInViChangeOperation

protected boolean isInViChangeOperation()

isInViCmdMode
```
protected boolean isInViCmdMode()
```

viForwardChar
```
protected boolean viForwardChar()
```

viBackwardChar
```
protected boolean viBackwardChar()
```

forwardWord
```
protected boolean forwardWord()
```

viForwardWord
```
protected boolean viForwardWord()
```

viForwardBlankWord

protected boolean viForwardBlankWord()

emacsForwardWord
```
protected boolean emacsForwardWord()
```

viForwardBlankWordEnd

protected boolean viForwardBlankWordEnd()

viForwardWordEnd
```
protected boolean viForwardWordEnd()
```

backwardWord
```
protected boolean backwardWord()
```

viBackwardWord
```
protected boolean viBackwardWord()
```

viBackwardBlankWord

protected boolean viBackwardBlankWord()

viBackwardWordEnd
```
protected boolean viBackwardWordEnd()
```

viBackwardBlankWordEnd

protected boolean viBackwardBlankWordEnd()

emacsBackwardWord
```
protected boolean emacsBackwardWord()
```

backwardDeleteWord

protected boolean backwardDeleteWord()

viBackwardKillWord

protected boolean viBackwardKillWord()

backwardKillWord
```
protected boolean backwardKillWord()
```

copyPrevWord
```
protected boolean copyPrevWord()
```

upCaseWord
```
protected boolean upCaseWord()
```

downCaseWord
```
protected boolean downCaseWord()
```

capitalizeWord
```
protected boolean capitalizeWord()
```

deleteWord
```
protected boolean deleteWord()
```

killWord
```
protected boolean killWord()
```

transposeWords
```
protected boolean transposeWords()
```

insertComment
```
protected boolean insertComment()
```

viInsertComment
```
protected boolean viInsertComment()
```

doInsertComment

protected boolean doInsertComment(boolean isViMode)

viFindNextChar
```
protected boolean viFindNextChar()
```

viFindPrevChar
```
protected boolean viFindPrevChar()
```

viFindNextCharSkip

protected boolean viFindNextCharSkip()

viFindPrevCharSkip

protected boolean viFindPrevCharSkip()

viRepeatFind
```
protected boolean viRepeatFind()
```

viRevRepeatFind
```
protected boolean viRevRepeatFind()
```

viHistorySearchForward
```
protected boolean viHistorySearchForward()
```
Implements vi search ("/" or "?").

viHistorySearchBackward

protected boolean viHistorySearchBackward()

viRepeatSearch
```
protected boolean viRepeatSearch()
```

viRevRepeatSearch
```
protected boolean viRevRepeatSearch()
```

insertCloseCurly
```
protected boolean insertCloseCurly()
```

insertCloseParen
```
protected boolean insertCloseParen()
```

insertCloseSquare
```
protected boolean insertCloseSquare()
```

insertClose

protected boolean insertClose(String s)

viMatchBracket
```
protected boolean viMatchBracket()
```

undefinedKey
```
protected boolean undefinedKey()
```

doViMatchBracket
```
protected boolean doViMatchBracket()
```
Implements vi style bracket matching ("%" command). The matching bracket for the current bracket type that you are sitting on is matched. The logic works like so:

Returns:

true if it worked, false if the cursor was not on a bracket character or if there was no matching bracket.

getBracketType
```
protected int getBracketType(int ch)
```
Given a character determines what type of bracket it is (paren, square, curly, or none).

Parameters:

ch - The character to check

Returns:

1 is square, 2 curly, 3 parent, or zero for none. The value will be negated if it is the closing form of the bracket.

transposeChars
```
protected boolean transposeChars()
```
Performs character transpose. The character prior to the cursor and the character under the cursor are swapped and the cursor is advanced one. Do not cross line breaks.

undo
```
protected boolean undo()
```

redo
```
protected boolean redo()
```

sendBreak
```
protected boolean sendBreak()
```

backwardChar
```
protected boolean backwardChar()
```

forwardChar
```
protected boolean forwardChar()
```

viDigitOrBeginningOfLine

protected boolean viDigitOrBeginningOfLine()

universalArgument
```
protected boolean universalArgument()
```

argumentBase
```
protected boolean argumentBase()
```

negArgument
```
protected boolean negArgument()
```

digitArgument
```
protected boolean digitArgument()
```

viDelete
```
protected boolean viDelete()
```

viYankTo
```
protected boolean viYankTo()
```

viYankWholeLine
```
protected boolean viYankWholeLine()
```

viChange
```
protected boolean viChange()
```

cleanup
```
protected void cleanup()
```

doCleanup
```
protected void doCleanup()
```

historyIncrementalSearchForward

protected boolean historyIncrementalSearchForward()

historyIncrementalSearchBackward

protected boolean historyIncrementalSearchBackward()

doSearchHistory

protected boolean doSearchHistory(boolean backward)

historySearchForward

protected boolean historySearchForward()

historySearchBackward

protected boolean historySearchBackward()

searchBackwards
```
public int searchBackwards(String searchTerm,
                           int startIndex)
```
Search backward in history from a given position.

Parameters:

searchTerm - substring to search for.

startIndex - the index from which on to search

Returns:

index where this substring has been found, or -1 else.

searchBackwards
```
public int searchBackwards(String searchTerm)
```
Search backwards in history from the current position.

Parameters:

searchTerm - substring to search for.

Returns:

index where the substring has been found, or -1 else.

searchBackwards

public int searchBackwards(String searchTerm,
                           int startIndex,
                           boolean startsWith)

searchForwards

public int searchForwards(String searchTerm,
                          int startIndex,
                          boolean startsWith)

searchForwards
```
public int searchForwards(String searchTerm,
                          int startIndex)
```
Search forward in history from a given position.

Parameters:

searchTerm - substring to search for.

startIndex - the index from which on to search

Returns:

index where this substring has been found, or -1 else.

searchForwards
```
public int searchForwards(String searchTerm)
```
Search forwards in history from the current position.

Parameters:

searchTerm - substring to search for.

Returns:

index where the substring has been found, or -1 else.

printSearchStatus

public void printSearchStatus(String searchTerm,
                              String match,
                              boolean backward)

quit
```
protected boolean quit()
```

acceptLine
```
protected boolean acceptLine()
```

selfInsert
```
protected boolean selfInsert()
```

selfInsertUnmeta
```
protected boolean selfInsertUnmeta()
```

overwriteMode
```
protected boolean overwriteMode()
```

beginningOfBufferOrHistory

protected boolean beginningOfBufferOrHistory()

beginningOfHistory

protected boolean beginningOfHistory()

endOfBufferOrHistory

protected boolean endOfBufferOrHistory()

endOfHistory
```
protected boolean endOfHistory()
```

beginningOfLineHist

protected boolean beginningOfLineHist()

endOfLineHist
```
protected boolean endOfLineHist()
```

upHistory
```
protected boolean upHistory()
```

downHistory
```
protected boolean downHistory()
```

viUpLineOrHistory
```
protected boolean viUpLineOrHistory()
```

viDownLineOrHistory

protected boolean viDownLineOrHistory()

upLine
```
protected boolean upLine()
```

downLine
```
protected boolean downLine()
```

upLineOrHistory
```
protected boolean upLineOrHistory()
```

upLineOrSearch
```
protected boolean upLineOrSearch()
```

downLineOrHistory
```
protected boolean downLineOrHistory()
```

downLineOrSearch
```
protected boolean downLineOrSearch()
```

viCmdMode
```
protected boolean viCmdMode()
```

viInsert
```
protected boolean viInsert()
```

viAddNext
```
protected boolean viAddNext()
```

viAddEol
```
protected boolean viAddEol()
```

emacsEditingMode
```
protected boolean emacsEditingMode()
```

viChangeWholeLine
```
protected boolean viChangeWholeLine()
```

viChangeEol
```
protected boolean viChangeEol()
```

viKillEol
```
protected boolean viKillEol()
```

quotedInsert
```
protected boolean quotedInsert()
```

viJoin
```
protected boolean viJoin()
```

viKillWholeLine
```
protected boolean viKillWholeLine()
```

viInsertBol
```
protected boolean viInsertBol()
```

backwardDeleteChar

protected boolean backwardDeleteChar()

viFirstNonBlank
```
protected boolean viFirstNonBlank()
```

viBeginningOfLine
```
protected boolean viBeginningOfLine()
```

viEndOfLine
```
protected boolean viEndOfLine()
```

beginningOfLine
```
protected boolean beginningOfLine()
```

endOfLine
```
protected boolean endOfLine()
```

deleteChar
```
protected boolean deleteChar()
```

viBackwardDeleteChar
```
protected boolean viBackwardDeleteChar()
```
Deletes the previous character from the cursor position

viDeleteChar
```
protected boolean viDeleteChar()
```
Deletes the character you are sitting on and sucks the rest of the line in from the right.

viSwapCase
```
protected boolean viSwapCase()
```
Switches the case of the current character from upper to lower or lower to upper as necessary and advances the cursor one position to the right.

viReplaceChars
```
protected boolean viReplaceChars()
```
Implements the vi change character command (in move-mode "r" followed by the character to change to).

viChange

protected boolean viChange(int startPos,
                           int endPos)

viDeleteTo

protected boolean viDeleteTo(int startPos,
                             int endPos)

doViDeleteOrChange
```
protected boolean doViDeleteOrChange(int startPos,
                                     int endPos,
                                     boolean isChange)
```
Performs the vi "delete-to" action, deleting characters between a given span of the input line.

Parameters:

startPos - The start position

endPos - The end position.

isChange - If true, then the delete is part of a change operationg (e.g. "c$" is change-to-end-of line, so we first must delete to end of line to start the change

Returns:

true if it succeeded, false otherwise

viYankTo
```
protected boolean viYankTo(int startPos,
                           int endPos)
```
Implement the "vi" yank-to operation. This operation allows you to yank the contents of the current line based upon a move operation, for example "yw" yanks the current word, "3yw" yanks 3 words, etc.

Parameters:

startPos - The starting position from which to yank

endPos - The ending position to which to yank

Returns:

true if the yank succeeded

viOpenLineAbove
```
protected boolean viOpenLineAbove()
```

viOpenLineBelow
```
protected boolean viOpenLineBelow()
```

viPutAfter
```
protected boolean viPutAfter()
```
Pasts the yank buffer to the right of the current cursor position and moves the cursor to the end of the pasted region.

viPutBefore
```
protected boolean viPutBefore()
```

doLowercaseVersion

protected boolean doLowercaseVersion()

setMarkCommand
```
protected boolean setMarkCommand()
```

exchangePointAndMark

protected boolean exchangePointAndMark()

visualMode
```
protected boolean visualMode()
```

visualLineMode
```
protected boolean visualLineMode()
```

deactivateRegion
```
protected boolean deactivateRegion()
```

whatCursorPosition

protected boolean whatCursorPosition()

builtinWidgets

protected Map<String,Widget> builtinWidgets()

redisplay
```
public boolean redisplay()
```

redisplay

protected void redisplay(boolean flush)

getDisplayedBufferWithPrompts
```
public AttributedString getDisplayedBufferWithPrompts(List<AttributedString> secondaryPrompts)
```
Compute the full string to be displayed with the left, right and secondary prompts

Parameters:

secondaryPrompts - a list to store the secondary prompts

Returns:

insertTab
```
protected boolean insertTab()
```

expandHistory
```
protected boolean expandHistory()
```

expandWord
```
protected boolean expandWord()
```

expandOrComplete
```
protected boolean expandOrComplete()
```

expandOrCompletePrefix

protected boolean expandOrCompletePrefix()

completeWord
```
protected boolean completeWord()
```

menuComplete
```
protected boolean menuComplete()
```

menuExpandOrComplete

protected boolean menuExpandOrComplete()

completePrefix
```
protected boolean completePrefix()
```

listChoices
```
protected boolean listChoices()
```

deleteCharOrList
```
protected boolean deleteCharOrList()
```

doComplete

protected boolean doComplete(LineReaderImpl.CompletionType lst,
                             boolean useMenu,
                             boolean prefix)

getCandidateComparator

protected Comparator<Candidate> getCandidateComparator(boolean caseInsensitive,
                                                       String word)

getOthersGroupName
```
protected String getOthersGroupName()
```

getOriginalGroupName

protected String getOriginalGroupName()

getGroupComparator

protected Comparator<String> getGroupComparator()

nextBindingIsComplete

protected boolean nextBindingIsComplete()

doMenu

protected boolean doMenu(List<Candidate> original,
                         String completed)

doList

protected boolean doList(List<Candidate> possible,
                         String completed,
                         boolean runLoop)

computePost

protected LineReaderImpl.PostResult computePost(List<Candidate> possible,
                                                Candidate selection,
                                                List<Candidate> ordered,
                                                String completed)

computePost

protected LineReaderImpl.PostResult computePost(List<Candidate> possible,
                                                Candidate selection,
                                                List<Candidate> ordered,
                                                String completed,
                                                Function<String,Integer> wcwidth,
                                                int width,
                                                boolean autoGroup,
                                                boolean groupName,
                                                boolean rowsFirst)

toColumns

protected LineReaderImpl.PostResult toColumns(List<Object> items,
                                              Candidate selection,
                                              String completed,
                                              Function<String,Integer> wcwidth,
                                              int width,
                                              boolean rowsFirst)

toColumns

protected void toColumns(Object items,
                         int width,
                         int maxWidth,
                         AttributedStringBuilder sb,
                         Candidate selection,
                         String completed,
                         boolean rowsFirst,
                         int[] out)

getCompletionStyleDescription

protected AttributedStyle getCompletionStyleDescription()

getCompletionStyleGroup

protected AttributedStyle getCompletionStyleGroup()

getCompletionStyleSelection

protected AttributedStyle getCompletionStyleSelection()

getCompletionStyle

protected AttributedStyle getCompletionStyle(String name,
                                             String value)

buildStyle

protected AttributedStyle buildStyle(String str)

moveHistory
```
protected boolean moveHistory(boolean next,
                              int count)
```
Used in "vi" mode for argumented history move, to move a specific number of history entries forward or back.

Parameters:

next - If true, move forward

count - The number of entries to move

Returns:

true if the move was successful

moveHistory

protected boolean moveHistory(boolean next)

Move up or down the history tree.

killBuffer
```
protected boolean killBuffer()
```

killWholeLine
```
protected boolean killWholeLine()
```

killLine
```
public boolean killLine()
```
Kill the buffer ahead of the current cursor position.

Returns:

true if successful

backwardKillLine
```
public boolean backwardKillLine()
```

killRegion
```
public boolean killRegion()
```

copyRegionAsKill
```
public boolean copyRegionAsKill()
```

yank
```
public boolean yank()
```

yankPop
```
public boolean yankPop()
```

mouse
```
public boolean mouse()
```

beginPaste
```
public boolean beginPaste()
```

focusIn
```
public boolean focusIn()
```

focusOut
```
public boolean focusOut()
```

clear
```
public boolean clear()
```
Clean the used display

clearScreen
```
public boolean clearScreen()
```
Clear the screen by issuing the ANSI "clear screen" code.

beep
```
public boolean beep()
```
Issue an audible keyboard bell.

isDelimiter
```
protected boolean isDelimiter(int c)
```
Checks to see if the specified character is a delimiter. We consider a character a delimiter if it is anything but a letter or digit.

Parameters:

c - The character to test

Returns:

True if it is a delimiter

isWhitespace
```
protected boolean isWhitespace(int c)
```
Checks to see if a character is a whitespace character. Currently this delegates to Character.isWhitespace(char), however eventually it should be hooked up so that the definition of whitespace can be configured, as readline does.

Parameters:

c - The character to check

Returns:

true if the character is a whitespace

isViAlphaNum

protected boolean isViAlphaNum(int c)

isAlpha
```
protected boolean isAlpha(int c)
```

isWord
```
protected boolean isWord(int c)
```

defaultKeyMaps
```
public Map<String,KeyMap<Binding>> defaultKeyMaps()
```
Specified by:

defaultKeyMaps in interface LineReader

emacs
```
public KeyMap<Binding> emacs()
```

viInsertion
```
public KeyMap<Binding> viInsertion()
```

viCmd
```
public KeyMap<Binding> viCmd()
```

menu
```
public KeyMap<Binding> menu()
```

safe
```
public KeyMap<Binding> safe()
```

visual
```
public KeyMap<Binding> visual()
```

viOpp
```
public KeyMap<Binding> viOpp()
```

Class LineReaderImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.jline.reader.LineReader

Field Summary

Fields inherited from interface org.jline.reader.LineReader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL_MASK

TAB_WIDTH

DEFAULT_WORDCHARS

DEFAULT_REMOVE_SUFFIX_CHARS

DEFAULT_COMMENT_BEGIN

DEFAULT_SEARCH_TERMINATORS

DEFAULT_BELL_STYLE

DEFAULT_LIST_MAX

DEFAULT_ERRORS

DEFAULT_BLINK_MATCHING_PAREN

DEFAULT_AMBIGUOUS_BINDING

DEFAULT_SECONDARY_PROMPT_PATTERN

DEFAULT_OTHERS_GROUP_NAME

DEFAULT_ORIGINAL_GROUP_NAME

DEFAULT_COMPLETION_STYLE_STARTING

DEFAULT_COMPLETION_STYLE_DESCRIPTION

DEFAULT_COMPLETION_STYLE_GROUP

DEFAULT_COMPLETION_STYLE_SELECTION

BRACKETED_PASTE_ON

BRACKETED_PASTE_OFF

BRACKETED_PASTE_BEGIN

BRACKETED_PASTE_END

FOCUS_IN_SEQ

FOCUS_OUT_SEQ

terminal

appName

keyMaps

variables

history

completer

highlighter

parser

expander

options

buf

size

prompt

rightPrompt

maskingCallback

modifiedHistory

historyBuffer

searchBuffer

searchTerm

searchIndex

bindingReader

findChar

findDir

findTailAdd

regionMark

regionActive

yankBuffer

viMoveMode

killRing

undo

isUndo

state

reading

post

builtinWidgets

widgets

count

mult

universal

repeatCount

isArgDigit

parsedLine

skipRedisplay

display

overTyping

keyMap

smallTerminalOffset