OpenJDK 27 · jdk.internal.org.jline.utils.AnsiWriter

Field Summary

Modifier and Type	Field and 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
private static final int	BEL
protected static final int	BLACK
protected static final int	BLUE
private final char[]	buffer
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
private static final int	FIRST_ESC_CHAR
protected static final int	GREEN
private static final int	LOOKING_FOR_CHARSET
private static final int	LOOKING_FOR_FIRST_ESC_CHAR
private static final int	LOOKING_FOR_INT_ARG_END
private static final int	LOOKING_FOR_NEXT_ARG
private static final int	LOOKING_FOR_OSC_COMMAND
private static final int	LOOKING_FOR_OSC_COMMAND_END
private static final int	LOOKING_FOR_OSC_PARAM
private static final int	LOOKING_FOR_SECOND_ESC_CHAR
private static final int	LOOKING_FOR_ST
private static final int	LOOKING_FOR_STR_ARG_END
protected static final int	MAGENTA
private static final int	MAX_ESCAPE_SEQUENCE_LENGTH
private final ArrayList<Object>	options
private int	pos
protected static final int	RED
private static final char[]	RESET_CODE
private static final int	SECOND_CHARSET0_CHAR
private static final int	SECOND_CHARSET1_CHAR
private static final int	SECOND_ESC_CHAR
private static final int	SECOND_OSC_CHAR
private static final int	SECOND_ST_CHAR
private int	startOfValue
pack-priv int	state
protected static final int	WHITE
protected static final int	YELLOW

Inherited from java.io.FilterWriter:: out

Constructor Summary

Access	Constructor and Description
public	AnsiWriter(Writer out)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.FilterWriter.close. Implements java.io.Closeable.close. Closes the stream, flushing it first.
private int	getNextOptionInt(Iterator<Object> the underlying iterator optionsIterator) Helper for processEscapeCommand() to iterate over integer options
private int	optionInt(ArrayList<Object> options, int index)
private int	optionInt(ArrayList<Object> options, int index, int defaultValue)
protected void	processAttributeRest() process `SGR 0` corresponding to `Reset / Normal`
protected void	processChangeIconName(String the icon name name) process `OSC 1;text BEL` corresponding to `Change Icon label`
protected void	processChangeIconNameAndWindowTitle(String the label label) process `OSC 0;text BEL` corresponding to `Change Window and Icon label`
protected void	processChangeWindowTitle(String the title title) process `OSC 2;text BEL` corresponding to `Change Window title`
private boolean	Returns: true if the charcter set select command was processed. processCharsetSelect(ArrayList<Object> options) Process character set sequence.
protected void	processCharsetSelect(int set, char seq)
protected void	processCursorDown(int the count count) process `CSI n B` corresponding to `CUD – Cursor Down`
protected void	processCursorDownLine(int line count count) process `CSI n E` corresponding to `CNL – Cursor Next Line`
protected void	processCursorLeft(int the count count) process `CSI n D` corresponding to `CUB – Cursor Back`
protected void	processCursorRight(int the count count) process `CSI n C` corresponding to `CUF – Cursor Forward`
protected void	processCursorTo(int the row row, int the column 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 the column x) process `CSI n G` corresponding to `CHA – Cursor Horizontal Absolute`
protected void	processCursorUp(int the count count) process `CSI n A` corresponding to `CUU – Cursor Up`
protected void	processCursorUpLine(int line count 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 the option optionInt) Process `CSI s` ANSI code, corresponding to `DL – Delete Line`
protected void	processEraseLine(int the erase option eraseOption) Process `CSI n K` ANSI code, corresponding to `ED – Erase in Line`
protected void	processEraseScreen(int the erase option eraseOption) Process `CSI n J` ANSI code, corresponding to `ED – Erase in Display`
private boolean	Returns: true if the escape command was processed. processEscapeCommand(ArrayList<Object> the list of options options, int the command command) Process escape command
protected void	processInsertLine(int the option optionInt) Process `CSI s` ANSI code, corresponding to `IL – Insert Line`
private boolean	Returns: true if the operating system command was processed. processOperatingSystemCommand(ArrayList<Object> the options list options) Process operating system command.
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 the option optionInt) Process `CSI n T` ANSI code, corresponding to `SD – Scroll Down`
protected void	processScrollUp(int the option optionInt) Process `CSI n U` ANSI code, corresponding to `SU – Scroll Up`
protected void	processSetAttribute(int the attribute to set 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 the background color color) process `SGR 40-47` corresponding to `Set background color`.
protected void	processSetBackgroundColor(int the background color color, boolean is high intensity? 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 the background color in the palette paletteIndex) process `SGR 48` corresponding to `extended set background color` with a palette of 255 colors.
protected void	processSetBackgroundColorExt(int red r, int green g, int blue b) process `SGR 48` corresponding to `extended set background color` with a 24 bits RGB definition of the color.
protected void	processSetForegroundColor(int the text color color) process `SGR 30-37` corresponding to `Set text color (foreground)`.
protected void	processSetForegroundColor(int the text color color, boolean is high intensity? 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 the text color in the palette paletteIndex) process `SGR 38` corresponding to `extended set text color (foreground)` with a palette of 255 colors.
protected void	processSetForegroundColorExt(int red r, int green g, int blue 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 the command command, String the param param) Process unknown `OSC` command.
private void	reset(boolean if current buffer should be skipped or written to out skipBuffer) Resets all state to continue with regular parsing
public synchronized void	write(int data) Overrides java.io.FilterWriter.write. Writes a single character.
public void	write(char[] cbuf, int off, int len) Overrides java.io.FilterWriter.write. Writes a portion of an array of characters.
public void	write(String str, int off, int len) Overrides java.io.FilterWriter.write. Writes a portion of a string.

Inherited from java.io.FilterWriter:: flush

Field Detail

ATTRIBUTE_BLINK_FAST	back to summary
protected static final int ATTRIBUTE_BLINK_FAST

ATTRIBUTE_BLINK_OFF	back to summary
protected static final int ATTRIBUTE_BLINK_OFF

ATTRIBUTE_BLINK_SLOW	back to summary
protected static final int ATTRIBUTE_BLINK_SLOW

ATTRIBUTE_CONCEAL_OFF	back to summary
protected static final int ATTRIBUTE_CONCEAL_OFF

ATTRIBUTE_CONCEAL_ON	back to summary
protected static final int ATTRIBUTE_CONCEAL_ON

ATTRIBUTE_INTENSITY_BOLD	back to summary
protected static final int ATTRIBUTE_INTENSITY_BOLD

ATTRIBUTE_INTENSITY_FAINT	back to summary
protected static final int ATTRIBUTE_INTENSITY_FAINT

ATTRIBUTE_INTENSITY_NORMAL	back to summary
protected static final int ATTRIBUTE_INTENSITY_NORMAL

ATTRIBUTE_ITALIC	back to summary
protected static final int ATTRIBUTE_ITALIC

ATTRIBUTE_NEGATIVE_Off	back to summary
protected static final int ATTRIBUTE_NEGATIVE_Off Deprecated Annotations @Deprecated

ATTRIBUTE_NEGATIVE_OFF	back to summary
protected static final int ATTRIBUTE_NEGATIVE_OFF

ATTRIBUTE_NEGATIVE_ON	back to summary
protected static final int ATTRIBUTE_NEGATIVE_ON

ATTRIBUTE_UNDERLINE	back to summary
protected static final int ATTRIBUTE_UNDERLINE

ATTRIBUTE_UNDERLINE_DOUBLE	back to summary
protected static final int ATTRIBUTE_UNDERLINE_DOUBLE

ATTRIBUTE_UNDERLINE_OFF	back to summary
protected static final int ATTRIBUTE_UNDERLINE_OFF

BEL	back to summary
private static final int BEL

BLACK	back to summary
protected static final int BLACK

BLUE	back to summary
protected static final int BLUE

buffer	back to summary
private final char[] buffer

CYAN	back to summary
protected static final int CYAN

ERASE_LINE	back to summary
protected static final int ERASE_LINE

ERASE_LINE_TO_BEGINING	back to summary
protected static final int ERASE_LINE_TO_BEGINING

ERASE_LINE_TO_END	back to summary
protected static final int ERASE_LINE_TO_END

ERASE_SCREEN	back to summary
protected static final int ERASE_SCREEN

ERASE_SCREEN_TO_BEGINING	back to summary
protected static final int ERASE_SCREEN_TO_BEGINING

ERASE_SCREEN_TO_END	back to summary
protected static final int ERASE_SCREEN_TO_END

FIRST_ESC_CHAR	back to summary
private static final int FIRST_ESC_CHAR

GREEN	back to summary
protected static final int GREEN

LOOKING_FOR_CHARSET	back to summary
private static final int LOOKING_FOR_CHARSET

LOOKING_FOR_FIRST_ESC_CHAR	back to summary
private static final int LOOKING_FOR_FIRST_ESC_CHAR

LOOKING_FOR_INT_ARG_END	back to summary
private static final int LOOKING_FOR_INT_ARG_END

LOOKING_FOR_NEXT_ARG	back to summary
private static final int LOOKING_FOR_NEXT_ARG

LOOKING_FOR_OSC_COMMAND	back to summary
private static final int LOOKING_FOR_OSC_COMMAND

LOOKING_FOR_OSC_COMMAND_END	back to summary
private static final int LOOKING_FOR_OSC_COMMAND_END

LOOKING_FOR_OSC_PARAM	back to summary
private static final int LOOKING_FOR_OSC_PARAM

LOOKING_FOR_SECOND_ESC_CHAR	back to summary
private static final int LOOKING_FOR_SECOND_ESC_CHAR

LOOKING_FOR_ST	back to summary
private static final int LOOKING_FOR_ST

LOOKING_FOR_STR_ARG_END	back to summary
private static final int LOOKING_FOR_STR_ARG_END

MAGENTA	back to summary
protected static final int MAGENTA

MAX_ESCAPE_SEQUENCE_LENGTH	back to summary
private static final int MAX_ESCAPE_SEQUENCE_LENGTH

options	back to summary
private final ArrayList<Object> options

pos	back to summary
private int pos

RED	back to summary
protected static final int RED

RESET_CODE	back to summary
private static final char[] RESET_CODE

SECOND_CHARSET0_CHAR	back to summary
private static final int SECOND_CHARSET0_CHAR

SECOND_CHARSET1_CHAR	back to summary
private static final int SECOND_CHARSET1_CHAR

SECOND_ESC_CHAR	back to summary
private static final int SECOND_ESC_CHAR

SECOND_OSC_CHAR	back to summary
private static final int SECOND_OSC_CHAR

SECOND_ST_CHAR	back to summary
private static final int SECOND_ST_CHAR

startOfValue	back to summary
private int startOfValue

state	back to summary
pack-priv int state

WHITE	back to summary
protected static final int WHITE

YELLOW	back to summary
protected static final int YELLOW

Constructor Detail

AnsiWriter	back to summary
public AnsiWriter(Writer out)

Method Detail

back to summary

public void close() throws IOException

Overrides java.io.FilterWriter.close.

Implements java.io.Closeable.close.

Doc from java.io.Writer.close.

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

getNextOptionInt

back to summary

private int getNextOptionInt(Iterator<Object> optionsIterator) throws IOException

Helper for processEscapeCommand() to iterate over integer options

Parameters

optionsIterator:Iterator<Object>: the underlying iterator

Exceptions

IOException:: if no more non-null values left

optionInt	back to summary
private int optionInt(ArrayList<Object> options, int index)

optionInt	back to summary
private int optionInt(ArrayList<Object> options, int index, int defaultValue)

processAttributeRest back to summary

protected void processAttributeRest() throws IOException

process SGR 0 corresponding to Reset / Normal

Exceptions

IOException:: if an error occurs

processChangeIconName back to summary

protected void processChangeIconName(String name)

process OSC 1;text BEL corresponding to Change Icon label

Parameters

name:String: the icon name

processChangeIconNameAndWindowTitle back to summary

protected void processChangeIconNameAndWindowTitle(String label)

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

Parameters

label:String: the label

processChangeWindowTitle back to summary

protected void processChangeWindowTitle(String title)

process OSC 2;text BEL corresponding to Change Window title

Parameters

title:String: the title

processCharsetSelect

back to summary

private boolean processCharsetSelect(ArrayList<Object> options) throws IOException

Process character set sequence.

Returns:boolean: true if the charcter set select command was processed.

processCharsetSelect	back to summary
protected void processCharsetSelect(int set, char seq)

processCursorDown back to summary

protected void processCursorDown(int count) throws IOException

process CSI n B corresponding to CUD – Cursor Down

Parameters

count:int: the count

Exceptions

IOException:: if an error occurs

processCursorDownLine back to summary

protected void processCursorDownLine(int count) throws IOException

process CSI n E corresponding to CNL – Cursor Next Line

Parameters

count:int: line count

Exceptions

IOException:: if an error occurs

processCursorLeft back to summary

protected void processCursorLeft(int count) throws IOException

process CSI n D corresponding to CUB – Cursor Back

Parameters

count:int: the count

Exceptions

IOException:: if an error occurs

processCursorRight back to summary

protected void processCursorRight(int count) throws IOException

process CSI n C corresponding to CUF – Cursor Forward

Parameters

count:int: the count

Exceptions

IOException:: if an error occurs

processCursorTo back to summary

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:int: the row
col:int: the column

Exceptions

IOException:: if an error occurs

processCursorToColumn back to summary

protected void processCursorToColumn(int x) throws IOException

process CSI n G corresponding to CHA – Cursor Horizontal Absolute

Parameters

x:int: the column

Exceptions

IOException:: if an error occurs

processCursorUp back to summary

protected void processCursorUp(int count) throws IOException

process CSI n A corresponding to CUU – Cursor Up

Parameters

count:int: the count

Exceptions

IOException:: if an error occurs

processCursorUpLine back to summary

protected void processCursorUpLine(int count) throws IOException

process CSI n F corresponding to CPL – Cursor Previous Line

Parameters

count:int: line count

Exceptions

IOException:: if an error occurs

processDefaultBackgroundColor back to summary

protected void processDefaultBackgroundColor() throws IOException

process SGR 49 corresponding to Default background color

Exceptions

IOException:: if an error occurs

processDefaultTextColor back to summary

protected void processDefaultTextColor() throws IOException

process SGR 39 corresponding to Default text color (foreground)

Exceptions

IOException:: if an error occurs

processDeleteLine back to summary

protected void processDeleteLine(int optionInt) throws IOException

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

Parameters

optionInt:int: the option

Exceptions

IOException:: if an error occurs

processEraseLine back to summary

protected void processEraseLine(int eraseOption) throws IOException

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

Parameters

eraseOption:int: the erase option

Exceptions

IOException:: if an error occurs

processEraseScreen back to summary

protected void processEraseScreen(int eraseOption) throws IOException

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

Parameters

eraseOption:int: the erase option

Exceptions

IOException:: if an error occurs

processEscapeCommand

back to summary

private boolean processEscapeCommand(ArrayList<Object> options, int command) throws IOException

Process escape command

Parameters

options:ArrayList<Object>: the list of options
command:int: the command

Returns:boolean

true if the escape command was processed.

Exceptions

IOException:: if an error occurs

processInsertLine back to summary

protected void processInsertLine(int optionInt) throws IOException

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

Parameters

optionInt:int: the option

Exceptions

IOException:: if an error occurs

processOperatingSystemCommand

back to summary

private boolean processOperatingSystemCommand(ArrayList<Object> options) throws IOException

Process operating system command.

Parameters

options:ArrayList<Object>: the options list

Returns:boolean

true if the operating system command was processed.

processRestoreCursorPosition back to summary

protected void processRestoreCursorPosition() throws IOException

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

Exceptions

IOException:: if an error occurs

processSaveCursorPosition back to summary

protected void processSaveCursorPosition() throws IOException

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

Exceptions

IOException:: if an error occurs

processScrollDown back to summary

protected void processScrollDown(int optionInt) throws IOException

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

Parameters

optionInt:int: the option

Exceptions

IOException:: if an error occurs

processScrollUp back to summary

protected void processScrollUp(int optionInt) throws IOException

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

Parameters

optionInt:int: the option

Exceptions

IOException:: if an error occurs

processSetAttribute back to summary

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:int: the attribute to set

Exceptions

IOException:: if an error occurs

processSetBackgroundColor back to summary

protected void processSetBackgroundColor(int color) throws IOException

process SGR 40-47 corresponding to Set background color.

Parameters

color:int: the background color

Exceptions

IOException:: if an error occurs

processSetBackgroundColor back to summary

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:int: the background color
bright:boolean: is high intensity?

Exceptions

IOException:: if an error occurs

processSetBackgroundColorExt back to summary

protected void processSetBackgroundColorExt(int paletteIndex) throws IOException

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

Parameters

paletteIndex:int: the background color in the palette

Exceptions

IOException:: if an error occurs

processSetBackgroundColorExt back to summary

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:int: red
g:int: green
b:int: blue

Exceptions

IOException:: if an error occurs

processSetForegroundColor back to summary

protected void processSetForegroundColor(int color) throws IOException

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

Parameters

color:int: the text color

Exceptions

IOException:: if an error occurs

processSetForegroundColor back to summary

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:int: the text color
bright:boolean: is high intensity?

Exceptions

IOException:: if an error occurs

processSetForegroundColorExt back to summary

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:int: the text color in the palette

Exceptions

IOException:: if an error occurs

processSetForegroundColorExt back to summary

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:int: red
g:int: green
b:int: blue

Exceptions

IOException:: if an error occurs

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

processUnknownOperatingSystemCommand back to summary

protected void processUnknownOperatingSystemCommand(int command, String param)

Process unknown OSC command.

Parameters

command:int: the command
param:String: the param

reset

back to summary

private void reset(boolean skipBuffer) throws IOException

Resets all state to continue with regular parsing

Parameters

skipBuffer:boolean: if current buffer should be skipped or written to out

Exceptions

IOException:: if an error occurs

write

back to summary

public synchronized void write(int data) throws IOException

Overrides java.io.FilterWriter.write.

Doc from java.io.FilterWriter.write.

Writes a single character.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write

back to summary

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

Overrides java.io.FilterWriter.write.

Doc from java.io.FilterWriter.write.

Writes a portion of an array of characters.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write

back to summary

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

Overrides java.io.FilterWriter.write.

Doc from java.io.FilterWriter.write.

Writes a portion of a string.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

public Class AnsiWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail