Package org.jline.widget

Class AutopairWidgets

java.lang.Object

org.jline.widget.Widgets

org.jline.widget.AutopairWidgets

public class AutopairWidgets
extends Widgets

Creates and manages widgets that intelligently handle matching delimiters in the console.

AutopairWidgets provides functionality for automatically:

• Closing matching delimiters (brackets, quotes, etc.) when the opening delimiter is typed
• Deleting matching delimiter pairs when backspace is pressed
• Skipping over closing delimiters when they are typed and already present

This behavior is similar to what many modern code editors provide, making it easier to work with paired delimiters in the console.

Inspired by zsh-autopair: https://github.com/hlissner/zsh-autopair

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,Binding>	defaultBindings
private boolean	enabled
private static final Map<String,String>	LBOUNDS
private final Map<String,String>	pairs
private static final Map<String,String>	RBOUNDS

Fields inherited from class org.jline.widget.Widgets

AP_BACKWARD_DELETE_CHAR, AP_INSERT, AUTOPAIR_TOGGLE, AUTOSUGGEST_TOGGLE, reader, TAILTIP_PANE, TAILTIP_TOGGLE, TT_ACCEPT_LINE

Constructor Summary

Constructors

Constructor	Description
AutopairWidgets(LineReader reader)
AutopairWidgets(LineReader reader, boolean addCurlyBrackets)

Method Summary

Modifier and Type	Method	Description
boolean	autopairClose()
boolean	autopairDelete()
boolean	autopairInsert()
private boolean	balanced(String d)
private boolean	boundary(String lb, String rb)
private boolean	canDelete(String d)
private boolean	canPair(String d)
private boolean	canSkip(String d)
private void	customBindings()
private void	defaultBindings()
void	disable()
void	enable()
private boolean	nexToBoundary(String d)
private boolean	tailtipEnabled()
boolean	toggle()
boolean	toggleKeyBindings()

Methods inherited from class org.jline.widget.Widgets

addWidget, aliasWidget, args, buffer, callWidget, clearDescription, clearTailTip, currChar, destroyDescription, executeWidget, existsWidget, getKeyMap, getWidget, lastBinding, parser, prevChar, putString, replaceBuffer, setDescription, setErrorIndex, setErrorPattern, setSuggestionType, setTailTip, tailTip

Methods inherited from class java.lang.Object

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

Field Details

LBOUNDS

private static final Map<String,String> LBOUNDS

RBOUNDS

private static final Map<String,String> RBOUNDS

pairs

private final Map<String,String> pairs

defaultBindings

private final Map<String,Binding> defaultBindings

enabled

private boolean enabled

Constructor Details

AutopairWidgets

public AutopairWidgets(LineReader reader)

AutopairWidgets

public AutopairWidgets(LineReader reader,
 boolean addCurlyBrackets)

Method Details

enable

public void enable()

disable

public void disable()

toggle

public boolean toggle()

autopairInsert

public boolean autopairInsert()

autopairClose

public boolean autopairClose()

autopairDelete

public boolean autopairDelete()

toggleKeyBindings

public boolean toggleKeyBindings()

customBindings

private void customBindings()

defaultBindings

private void defaultBindings()

tailtipEnabled

private boolean tailtipEnabled()

canPair

private boolean canPair(String d)

canSkip

private boolean canSkip(String d)

canDelete

private boolean canDelete(String d)

balanced

private boolean balanced(String d)

boundary

private boolean boundary(String lb,
 String rb)

nexToBoundary

private boolean nexToBoundary(String d)