Package org.jline.builtins

Class Nano

java.lang.Object

org.jline.builtins.Nano

All Implemented Interfaces:

Editor

public class Nano
extends Object
implements Editor

A terminal text editor similar to the 'nano' Unix command.

This class provides a text editor with features including:

• File editing with save functionality
• Cut, copy, and paste operations
• Search and replace functionality
• Syntax highlighting
• Undo/redo support
• Line numbering

The implementation supports many of the key bindings and features of the traditional Unix 'nano' editor, adapted for JLine's terminal handling. It implements the JLine Editor interface for integration with other components.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	Nano.Buffer
protected static enum	Nano.CursorMovement
static interface	Nano.Diagnostic	Interface representing a diagnostic message for code in the editor.
protected static enum	Nano.Operation
protected static class	Nano.PatternHistory
protected static enum	Nano.WriteFormat
protected static enum	Nano.WriteMode

Field Summary

Fields

Modifier and Type	Field	Description
protected final BindingReader	bindingReader
String	brackets
protected Nano.Buffer	buffer
protected int	bufferIndex
protected final List<Nano.Buffer>	buffers
boolean	constantCursor
protected List<String>	cutbuffer
protected final org.jline.utils.Display	display
protected final StringBuilder	editBuffer
protected String	editMessage
protected String	errorMessage
protected boolean	highlight
protected KeyMap<Nano.Operation>	keys
protected boolean	mark
String	matchBrackets
protected int	matchedLength
protected String	message
boolean	mouseSupport
org.jline.terminal.Terminal.MouseTracking	mouseTracking
protected int	nbBindings
boolean	oneMoreLine
protected Nano.PatternHistory	patternHistory
boolean	printLineNumbers
String	punct
boolean	quickBlank
String	quoteStr
protected boolean	readNewBuffer
protected final Path	root
protected boolean	searchBackwards
protected boolean	searchCaseSensitive
protected boolean	searchRegexp
protected String	searchTerm
protected LinkedHashMap<String,String>	shortcuts
protected final org.jline.terminal.Size	size
boolean	smoothScrolling
int	tabs
protected final org.jline.terminal.Terminal	terminal
String	title
protected final int	vsusp
boolean	wrapping
protected Nano.WriteMode	writeMode

Constructor Summary

Constructors

Constructor	Description
Nano(org.jline.terminal.Terminal terminal, File root)
Nano(org.jline.terminal.Terminal terminal, Path root)
Nano(org.jline.terminal.Terminal terminal, Path root, Options opts)
Nano(org.jline.terminal.Terminal terminal, Path root, Options opts, ConfigurationPath configPath)

Method Summary

Modifier and Type	Method	Description
protected void	bindKeys()
protected List<Nano.Diagnostic>	computeDiagnostic()	Computes the list of diagnostics for the current buffer.
protected List<org.jline.utils.AttributedString>	computeFooter()
protected LinkedHashMap<org.jline.utils.AttributedString,List<org.jline.utils.AttributedString>>	computeSuggestions()	Initializes the suggestions map.
String	getTitle()
protected void	handle(org.jline.terminal.Terminal.Signal signal)
protected void	insertHelp(int selected)	Inserts the selected suggestion into the text.
void	open(String... files)
void	open(List<String> files)
void	run()
void	setRestricted(boolean restricted)
static String[]	usage()

Methods inherited from class java.lang.Object

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

Field Details

terminal

protected final org.jline.terminal.Terminal terminal

display

protected final org.jline.utils.Display display

bindingReader

protected final BindingReader bindingReader

size

protected final org.jline.terminal.Size size

root

protected final Path root

vsusp

protected final int vsusp

keys

protected KeyMap<Nano.Operation> keys

title

public String title

printLineNumbers

public boolean printLineNumbers

wrapping

public boolean wrapping

smoothScrolling

public boolean smoothScrolling

mouseSupport

public boolean mouseSupport

mouseTracking

public org.jline.terminal.Terminal.MouseTracking mouseTracking

oneMoreLine

public boolean oneMoreLine

constantCursor

public boolean constantCursor

quickBlank

public boolean quickBlank

tabs

public int tabs

brackets

public String brackets

matchBrackets

public String matchBrackets

punct

public String punct

quoteStr

public String quoteStr

buffers

protected final List<Nano.Buffer> buffers

bufferIndex

protected int bufferIndex

buffer

protected Nano.Buffer buffer

message

protected String message

errorMessage

protected String errorMessage

nbBindings

protected int nbBindings

shortcuts

protected LinkedHashMap<String,String> shortcuts

editMessage

protected String editMessage

editBuffer

protected final StringBuilder editBuffer

searchCaseSensitive

protected boolean searchCaseSensitive

searchRegexp

protected boolean searchRegexp

searchBackwards

protected boolean searchBackwards

searchTerm

protected String searchTerm

matchedLength

protected int matchedLength

patternHistory

protected Nano.PatternHistory patternHistory

writeMode

protected Nano.WriteMode writeMode

cutbuffer

protected List<String> cutbuffer

mark

protected boolean mark

highlight

protected boolean highlight

readNewBuffer

protected boolean readNewBuffer

Constructor Details

Nano

public Nano(org.jline.terminal.Terminal terminal,
 File root)

Nano

public Nano(org.jline.terminal.Terminal terminal,
 Path root)

Nano

public Nano(org.jline.terminal.Terminal terminal,
 Path root,
 Options opts)

Nano

public Nano(org.jline.terminal.Terminal terminal,
 Path root,
 Options opts,
 ConfigurationPath configPath)

Method Details

usage

public static String[] usage()

setRestricted

public void setRestricted(boolean restricted)

Specified by:

setRestricted in interface Editor

open

public void open(String... files)
          throws IOException

Throws:

IOException

open

public void open(List<String> files)
          throws IOException

Specified by:

open in interface Editor

Throws:

IOException

run

public void run()
         throws IOException

Specified by:

run in interface Editor

Throws:

IOException

getTitle

public String getTitle()

insertHelp

protected void insertHelp(int selected)

Inserts the selected suggestion into the text.

This method is called when a suggestion is selected and should be inserted into the text. Subclasses should override this method to implement the insertion logic based on the selected suggestion index.

The selected suggestion can be retrieved from the suggestions map using: new ArrayList<>(suggestions.keySet()).get(selected)

Parameters:

selected - the index of the selected suggestion in the suggestions list

computeSuggestions

protected LinkedHashMap<org.jline.utils.AttributedString,List<org.jline.utils.AttributedString>> computeSuggestions()

Initializes the suggestions map.

This method is called when suggestions need to be displayed. Subclasses should override this method to return a map of suggestions to their documentation.

The keys in the map are AttributedString objects representing the available suggestions. The values are lists of AttributedString objects containing the documentation lines for each suggestion.

It is recommended to use a LinkedHashMap to preserve the order of suggestions, as this order will be used when displaying the suggestions to the user.

The default implementation returns an empty map, indicating no suggestions are available.

Returns:

a map of suggestions to their documentation, or an empty map if no suggestions are available

computeDiagnostic

protected List<Nano.Diagnostic> computeDiagnostic()

Computes the list of diagnostics for the current buffer.

This method is called when rendering the buffer to determine if there are any diagnostics (errors, warnings, etc.) that should be displayed. Subclasses should override this method to provide diagnostics based on the current buffer content.

Diagnostics are used to highlight issues in the code and display tooltips with error messages or warnings when hovering over the highlighted regions.

Returns:

a list of Diagnostic objects, or an empty list if there are no diagnostics

computeFooter

protected List<org.jline.utils.AttributedString> computeFooter()

handle

protected void handle(org.jline.terminal.Terminal.Signal signal)

bindKeys

protected void bindKeys()