Package org.jline.utils

Class AnsiWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

org.jline.utils.AnsiWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

WindowsAnsiWriter

public class AnsiWriter
extends FilterWriter

A writer that processes ANSI escape sequences.

The AnsiWriter class extends FilterWriter to intercept and process ANSI escape sequences written to the underlying writer. It extracts ANSI escape codes and calls corresponding process* methods for each recognized sequence.

This class just filters out the escape codes so that they are not sent out to the underlying Writer: process* methods are empty. Subclasses should actually perform the ANSI escape behaviors by implementing active code in process* methods.

This class is useful for implementing terminal emulation, where ANSI escape sequences need to be interpreted to control cursor movement, text attributes, colors, and other terminal features.

The class handles various ANSI escape sequences, including:

• Cursor movement (up, down, left, right)
• Cursor positioning (absolute and relative)
• Text attributes (bold, underline, blink, etc.)
• Colors (foreground and background)
• Screen clearing and line manipulation

For more information about ANSI escape codes, see: Wikipedia: ANSI escape code

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	ATTRIBUTE_BLINK_FAST
protected static final int	ATTRIBUTE_BLINK_OFF
protected static final int	ATTRIBUTE_BLINK_SLOW
protected static final int	ATTRIBUTE_CONCEAL_OFF
protected static final int	ATTRIBUTE_CONCEAL_ON
protected static final int	ATTRIBUTE_INTENSITY_BOLD
protected static final int	ATTRIBUTE_INTENSITY_FAINT
protected static final int	ATTRIBUTE_INTENSITY_NORMAL
protected static final int	ATTRIBUTE_ITALIC
protected static final int	ATTRIBUTE_NEGATIVE_Off	Deprecated.
protected static final int	ATTRIBUTE_NEGATIVE_OFF
protected static final int	ATTRIBUTE_NEGATIVE_ON
protected static final int	ATTRIBUTE_UNDERLINE
protected static final int	ATTRIBUTE_UNDERLINE_DOUBLE
protected static final int	ATTRIBUTE_UNDERLINE_OFF
protected static final int	BLACK
protected static final int	BLUE
protected static final int	CYAN
protected static final int	ERASE_LINE
protected static final int	ERASE_LINE_TO_BEGINING
protected static final int	ERASE_LINE_TO_END
protected static final int	ERASE_SCREEN
protected static final int	ERASE_SCREEN_TO_BEGINING
protected static final int	ERASE_SCREEN_TO_END
protected static final int	GREEN
protected static final int	MAGENTA
protected static final int	RED
protected static final int	WHITE
protected static final int	YELLOW

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
AnsiWriter(Writer out)

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	processAttributeRest()	process SGR 0 corresponding to Reset / Normal
protected void	processChangeIconName(String name)	process OSC 1;text BEL corresponding to Change Icon label
protected void	processChangeIconNameAndWindowTitle(String label)	process OSC 0;text BEL corresponding to Change Window and Icon label
protected void	processChangeWindowTitle(String title)	process OSC 2;text BEL corresponding to Change Window title
protected void	processCharsetSelect(int set, char seq)
protected void	processCursorDown(int count)	process CSI n B corresponding to CUD – Cursor Down
protected void	processCursorDownLine(int count)	process CSI n E corresponding to CNL – Cursor Next Line
protected void	processCursorLeft(int count)	process CSI n D corresponding to CUB – Cursor Back
protected void	processCursorRight(int count)	process CSI n C corresponding to CUF – Cursor Forward
protected void	processCursorTo(int row, int col)	process CSI n ; m H corresponding to CUP – Cursor Position or CSI n ; m f corresponding to HVP – Horizontal and Vertical Position
protected void	processCursorToColumn(int x)	process CSI n G corresponding to CHA – Cursor Horizontal Absolute
protected void	processCursorUp(int count)	process CSI n A corresponding to CUU – Cursor Up
protected void	processCursorUpLine(int count)	process CSI n F corresponding to CPL – Cursor Previous Line
protected void	processDefaultBackgroundColor()	process SGR 49 corresponding to Default background color
protected void	processDefaultTextColor()	process SGR 39 corresponding to Default text color (foreground)
protected void	processDeleteLine(int optionInt)	Process CSI s ANSI code, corresponding to DL – Delete Line
protected void	processEraseLine(int eraseOption)	Process CSI n K ANSI code, corresponding to ED – Erase in Line
protected void	processEraseScreen(int eraseOption)	Process CSI n J ANSI code, corresponding to ED – Erase in Display
protected void	processInsertLine(int optionInt)	Process CSI s ANSI code, corresponding to IL – Insert Line
protected void	processRestoreCursorPosition()	Process CSI u ANSI code, corresponding to RCP – Restore Cursor Position
protected void	processSaveCursorPosition()	Process CSI s ANSI code, corresponding to SCP – Save Cursor Position
protected void	processScrollDown(int optionInt)	Process CSI n T ANSI code, corresponding to SD – Scroll Down
protected void	processScrollUp(int optionInt)	Process CSI n U ANSI code, corresponding to SU – Scroll Up
protected void	processSetAttribute(int attribute)	process SGR other than 0 (reset), 30-39 (foreground), 40-49 (background), 90-97 (foreground high intensity) or 100-107 (background high intensity)
protected void	processSetBackgroundColor(int color)	process SGR 40-47 corresponding to Set background color.
protected void	processSetBackgroundColor(int color, boolean bright)	process SGR 40-47 or SGR 100-107 corresponding to Set background color either in normal mode or high intensity.
protected void	processSetBackgroundColorExt(int paletteIndex)	process SGR 48 corresponding to extended set background color with a palette of 255 colors.
protected void	processSetBackgroundColorExt(int r, int g, int b)	process SGR 48 corresponding to extended set background color with a 24 bits RGB definition of the color.
protected void	processSetForegroundColor(int color)	process SGR 30-37 corresponding to Set text color (foreground).
protected void	processSetForegroundColor(int color, boolean bright)	process SGR 30-37 or SGR 90-97 corresponding to Set text color (foreground) either in normal mode or high intensity.
protected void	processSetForegroundColorExt(int paletteIndex)	process SGR 38 corresponding to extended set text color (foreground) with a palette of 255 colors.
protected void	processSetForegroundColorExt(int r, int g, int b)	process SGR 38 corresponding to extended set text color (foreground) with a 24 bits RGB definition of the color.
protected void	processUnknownExtension(ArrayList<Object> options, int command)
protected void	processUnknownOperatingSystemCommand(int command, String param)	Process unknown OSC command.
void	write(char[] cbuf, int off, int len)
void	write(int data)
void	write(String str, int off, int len)

Methods inherited from class java.io.FilterWriter

flush

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write

Methods inherited from class java.lang.Object

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

Field Details

ERASE_SCREEN_TO_END

protected static final int ERASE_SCREEN_TO_END

See Also:

• Constant Field Values

ERASE_SCREEN_TO_BEGINING

protected static final int ERASE_SCREEN_TO_BEGINING

See Also:

• Constant Field Values

ERASE_SCREEN

protected static final int ERASE_SCREEN

See Also:

• Constant Field Values

ERASE_LINE_TO_END

protected static final int ERASE_LINE_TO_END

See Also:

• Constant Field Values

ERASE_LINE_TO_BEGINING

protected static final int ERASE_LINE_TO_BEGINING

See Also:

• Constant Field Values

ERASE_LINE

protected static final int ERASE_LINE

See Also:

• Constant Field Values

ATTRIBUTE_INTENSITY_BOLD

protected static final int ATTRIBUTE_INTENSITY_BOLD

See Also:

• Constant Field Values

ATTRIBUTE_INTENSITY_FAINT

protected static final int ATTRIBUTE_INTENSITY_FAINT

See Also:

• Constant Field Values

ATTRIBUTE_ITALIC

protected static final int ATTRIBUTE_ITALIC

See Also:

• Constant Field Values

ATTRIBUTE_UNDERLINE

protected static final int ATTRIBUTE_UNDERLINE

See Also:

• Constant Field Values

ATTRIBUTE_BLINK_SLOW

protected static final int ATTRIBUTE_BLINK_SLOW

See Also:

• Constant Field Values

ATTRIBUTE_BLINK_FAST

protected static final int ATTRIBUTE_BLINK_FAST

See Also:

• Constant Field Values

ATTRIBUTE_NEGATIVE_ON

protected static final int ATTRIBUTE_NEGATIVE_ON

See Also:

• Constant Field Values

ATTRIBUTE_CONCEAL_ON

protected static final int ATTRIBUTE_CONCEAL_ON

See Also:

• Constant Field Values

ATTRIBUTE_UNDERLINE_DOUBLE

protected static final int ATTRIBUTE_UNDERLINE_DOUBLE

See Also:

• Constant Field Values

ATTRIBUTE_INTENSITY_NORMAL

protected static final int ATTRIBUTE_INTENSITY_NORMAL

See Also:

• Constant Field Values

ATTRIBUTE_UNDERLINE_OFF

protected static final int ATTRIBUTE_UNDERLINE_OFF

See Also:

• Constant Field Values

ATTRIBUTE_BLINK_OFF

protected static final int ATTRIBUTE_BLINK_OFF

See Also:

• Constant Field Values

ATTRIBUTE_NEGATIVE_Off

@Deprecated
protected static final int ATTRIBUTE_NEGATIVE_Off

Deprecated.

See Also:

• Constant Field Values

ATTRIBUTE_NEGATIVE_OFF

protected static final int ATTRIBUTE_NEGATIVE_OFF

See Also:

• Constant Field Values

ATTRIBUTE_CONCEAL_OFF

protected static final int ATTRIBUTE_CONCEAL_OFF

See Also:

• Constant Field Values

BLACK

protected static final int BLACK

See Also:

• Constant Field Values

RED

protected static final int RED

See Also:

• Constant Field Values

GREEN

protected static final int GREEN

See Also:

• Constant Field Values

YELLOW

protected static final int YELLOW

See Also:

• Constant Field Values

BLUE

protected static final int BLUE

See Also:

• Constant Field Values

MAGENTA

protected static final int MAGENTA

See Also:

• Constant Field Values

CYAN

protected static final int CYAN

See Also:

• Constant Field Values

WHITE

protected static final int WHITE

See Also:

• Constant Field Values

Constructor Details

AnsiWriter

public AnsiWriter(Writer out)

Method Details

write

public void write(int data)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

processRestoreCursorPosition

protected void processRestoreCursorPosition()
                                     throws IOException

Process CSI u ANSI code, corresponding to RCP – Restore Cursor Position

Throws:

IOException - if an error occurs

processSaveCursorPosition

protected void processSaveCursorPosition()
                                  throws IOException

Process CSI s ANSI code, corresponding to SCP – Save Cursor Position

Throws:

IOException - if an error occurs

processInsertLine

protected void processInsertLine(int optionInt)
                          throws IOException

Process CSI s ANSI code, corresponding to IL – Insert Line

Parameters:

optionInt - the option

Throws:

IOException - if an error occurs

processDeleteLine

protected void processDeleteLine(int optionInt)
                          throws IOException

Process CSI s ANSI code, corresponding to DL – Delete Line

Parameters:

optionInt - the option

Throws:

IOException - if an error occurs

processScrollDown

protected void processScrollDown(int optionInt)
                          throws IOException

Process CSI n T ANSI code, corresponding to SD – Scroll Down

Parameters:

optionInt - the option

Throws:

IOException - if an error occurs

processScrollUp

protected void processScrollUp(int optionInt)
                        throws IOException

Process CSI n U ANSI code, corresponding to SU – Scroll Up

Parameters:

optionInt - the option

Throws:

IOException - if an error occurs

processEraseScreen

protected void processEraseScreen(int eraseOption)
                           throws IOException

Process CSI n J ANSI code, corresponding to ED – Erase in Display

Parameters:

eraseOption - the erase option

Throws:

IOException - if an error occurs

processEraseLine

protected void processEraseLine(int eraseOption)
                         throws IOException

Process CSI n K ANSI code, corresponding to ED – Erase in Line

Parameters:

eraseOption - the erase option

Throws:

IOException - if an error occurs

processSetAttribute

protected void processSetAttribute(int attribute)
                            throws IOException

process SGR other than 0 (reset), 30-39 (foreground), 40-49 (background), 90-97 (foreground high intensity) or 100-107 (background high intensity)

Parameters:

attribute - the attribute to set

Throws:

IOException - if an error occurs

See Also:

• processAttributeRest()
• processSetForegroundColor(int)
• processSetForegroundColor(int, boolean)
• processSetForegroundColorExt(int)
• processSetForegroundColorExt(int, int, int)
• processDefaultTextColor()
• processDefaultBackgroundColor()

processSetForegroundColor

protected void processSetForegroundColor(int color)
                                  throws IOException

process SGR 30-37 corresponding to Set text color (foreground).

Parameters:

color - the text color

Throws:

IOException - if an error occurs

processSetForegroundColor

protected void processSetForegroundColor(int color,
 boolean bright)
                                  throws IOException

process SGR 30-37 or SGR 90-97 corresponding to Set text color (foreground) either in normal mode or high intensity.

Parameters:

color - the text color

bright - is high intensity?

Throws:

IOException - if an error occurs

processSetForegroundColorExt

protected void processSetForegroundColorExt(int paletteIndex)
                                     throws IOException

process SGR 38 corresponding to extended set text color (foreground) with a palette of 255 colors.

Parameters:

paletteIndex - the text color in the palette

Throws:

IOException - if an error occurs

processSetForegroundColorExt

protected void processSetForegroundColorExt(int r,
 int g,
 int b)
                                     throws IOException

process SGR 38 corresponding to extended set text color (foreground) with a 24 bits RGB definition of the color.

Parameters:

r - red

g - green

b - blue

Throws:

IOException - if an error occurs

processSetBackgroundColor

protected void processSetBackgroundColor(int color)
                                  throws IOException

process SGR 40-47 corresponding to Set background color.

Parameters:

color - the background color

Throws:

IOException - if an error occurs

processSetBackgroundColor

protected void processSetBackgroundColor(int color,
 boolean bright)
                                  throws IOException

process SGR 40-47 or SGR 100-107 corresponding to Set background color either in normal mode or high intensity.

Parameters:

color - the background color

bright - is high intensity?

Throws:

IOException - if an error occurs

processSetBackgroundColorExt

protected void processSetBackgroundColorExt(int paletteIndex)
                                     throws IOException

process SGR 48 corresponding to extended set background color with a palette of 255 colors.

Parameters:

paletteIndex - the background color in the palette

Throws:

IOException - if an error occurs

processSetBackgroundColorExt

protected void processSetBackgroundColorExt(int r,
 int g,
 int b)
                                     throws IOException

process SGR 48 corresponding to extended set background color with a 24 bits RGB definition of the color.

Parameters:

r - red

g - green

b - blue

Throws:

IOException - if an error occurs

processDefaultTextColor

protected void processDefaultTextColor()
                                throws IOException

process SGR 39 corresponding to Default text color (foreground)

Throws:

IOException - if an error occurs

processDefaultBackgroundColor

protected void processDefaultBackgroundColor()
                                      throws IOException

process SGR 49 corresponding to Default background color

Throws:

IOException - if an error occurs

processAttributeRest

protected void processAttributeRest()
                             throws IOException

process SGR 0 corresponding to Reset / Normal

Throws:

IOException - if an error occurs

processCursorTo

protected void processCursorTo(int row,
 int col)
                        throws IOException

process CSI n ; m H corresponding to CUP – Cursor Position or CSI n ; m f corresponding to HVP – Horizontal and Vertical Position

Parameters:

row - the row

col - the column

Throws:

IOException - if an error occurs

processCursorToColumn

protected void processCursorToColumn(int x)
                              throws IOException

process CSI n G corresponding to CHA – Cursor Horizontal Absolute

Parameters:

x - the column

Throws:

IOException - if an error occurs

processCursorUpLine

protected void processCursorUpLine(int count)
                            throws IOException

process CSI n F corresponding to CPL – Cursor Previous Line

Parameters:

count - line count

Throws:

IOException - if an error occurs

processCursorDownLine

protected void processCursorDownLine(int count)
                              throws IOException

process CSI n E corresponding to CNL – Cursor Next Line

Parameters:

count - line count

Throws:

IOException - if an error occurs

processCursorLeft

protected void processCursorLeft(int count)
                          throws IOException

process CSI n D corresponding to CUB – Cursor Back

Parameters:

count - the count

Throws:

IOException - if an error occurs

processCursorRight

protected void processCursorRight(int count)
                           throws IOException

process CSI n C corresponding to CUF – Cursor Forward

Parameters:

count - the count

Throws:

IOException - if an error occurs

processCursorDown

protected void processCursorDown(int count)
                          throws IOException

process CSI n B corresponding to CUD – Cursor Down

Parameters:

count - the count

Throws:

IOException - if an error occurs

processCursorUp

protected void processCursorUp(int count)
                        throws IOException

process CSI n A corresponding to CUU – Cursor Up

Parameters:

count - the count

Throws:

IOException - if an error occurs

processUnknownExtension

protected void processUnknownExtension(ArrayList<Object> options,
 int command)

processChangeIconNameAndWindowTitle

protected void processChangeIconNameAndWindowTitle(String label)

process OSC 0;text BEL corresponding to Change Window and Icon label

Parameters:

label - the label

processChangeIconName

protected void processChangeIconName(String name)

process OSC 1;text BEL corresponding to Change Icon label

Parameters:

name - the icon name

processChangeWindowTitle

protected void processChangeWindowTitle(String title)

process OSC 2;text BEL corresponding to Change Window title

Parameters:

title - the title

processUnknownOperatingSystemCommand

protected void processUnknownOperatingSystemCommand(int command,
 String param)

Process unknown OSC command.

Parameters:

command - the command

param - the param

processCharsetSelect

protected void processCharsetSelect(int set,
 char seq)

write

public void write(char[] cbuf,
 int off,
 int len)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

public void write(String str,
 int off,
 int len)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterWriter

Throws:

IOException