Package org.fusesource.jansi.io

Class AnsiOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.fusesource.jansi.io.AnsiOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class AnsiOutputStream
extends FilterOutputStream

A ANSI print stream extracts ANSI escape codes written to an output stream and calls corresponding AnsiProcessor.process* methods. This particular class is not synchronized for improved performances.

For more information about ANSI escape codes, see Wikipedia article

Since:

1.0

See Also:

• AnsiProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnsiOutputStream.IoRunnable
static interface	AnsiOutputStream.WidthSupplier
static class	AnsiOutputStream.ZeroWidthSupplier

Field Summary

Fields

Modifier and Type	Field	Description
private AnsiProcessor	ap
private static final int	BEL
private final byte[]	buffer
private final AnsiColors	colors
private final Charset	cs
private static final int	FIRST_ESC_CHAR
private final AnsiOutputStream.IoRunnable	installer
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
private static final int	MAX_ESCAPE_SEQUENCE_LENGTH
private AnsiMode	mode
private final ArrayList<Object>	options
private int	pos
private final AnsiProcessor	processor
static final byte[]	RESET_CODE
private boolean	resetAtUninstall
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
private int	state
private final AnsiType	type
private final AnsiOutputStream.IoRunnable	uninstaller
private final AnsiOutputStream.WidthSupplier	width

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
AnsiOutputStream(OutputStream os, AnsiOutputStream.WidthSupplier width, AnsiMode mode, AnsiProcessor processor, AnsiType type, AnsiColors colors, Charset cs, AnsiOutputStream.IoRunnable installer, AnsiOutputStream.IoRunnable uninstaller, boolean resetAtUninstall)

Method Summary

Modifier and Type	Method	Description
void	close()
AnsiColors	getColors()
AnsiMode	getMode()
int	getTerminalWidth()
AnsiType	getType()
void	install()
boolean	isResetAtUninstall()
private void	processCharsetSelect()
private void	processEscapeCommand(int data)
private void	processOperatingSystemCommand()
private void	reset(boolean skipBuffer)	Resets all state to continue with regular parsing
void	setMode(AnsiMode mode)
void	setResetAtUninstall(boolean resetAtUninstall)
void	uninstall()
void	write(int data)

Methods inherited from class java.io.FilterOutputStream

flush, write, write

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Field Details

RESET_CODE

public static final byte[] RESET_CODE

LOOKING_FOR_FIRST_ESC_CHAR

private static final int LOOKING_FOR_FIRST_ESC_CHAR

See Also:

• Constant Field Values

LOOKING_FOR_SECOND_ESC_CHAR

private static final int LOOKING_FOR_SECOND_ESC_CHAR

See Also:

• Constant Field Values

LOOKING_FOR_NEXT_ARG

private static final int LOOKING_FOR_NEXT_ARG

See Also:

• Constant Field Values

LOOKING_FOR_STR_ARG_END

private static final int LOOKING_FOR_STR_ARG_END

See Also:

• Constant Field Values

LOOKING_FOR_INT_ARG_END

private static final int LOOKING_FOR_INT_ARG_END

See Also:

• Constant Field Values

LOOKING_FOR_OSC_COMMAND

private static final int LOOKING_FOR_OSC_COMMAND

See Also:

• Constant Field Values

LOOKING_FOR_OSC_COMMAND_END

private static final int LOOKING_FOR_OSC_COMMAND_END

See Also:

• Constant Field Values

LOOKING_FOR_OSC_PARAM

private static final int LOOKING_FOR_OSC_PARAM

See Also:

• Constant Field Values

LOOKING_FOR_ST

private static final int LOOKING_FOR_ST

See Also:

• Constant Field Values

LOOKING_FOR_CHARSET

private static final int LOOKING_FOR_CHARSET

See Also:

• Constant Field Values

FIRST_ESC_CHAR

private static final int FIRST_ESC_CHAR

See Also:

• Constant Field Values

SECOND_ESC_CHAR

private static final int SECOND_ESC_CHAR

See Also:

• Constant Field Values

SECOND_OSC_CHAR

private static final int SECOND_OSC_CHAR

See Also:

• Constant Field Values

BEL

private static final int BEL

See Also:

• Constant Field Values

SECOND_ST_CHAR

private static final int SECOND_ST_CHAR

See Also:

• Constant Field Values

SECOND_CHARSET0_CHAR

private static final int SECOND_CHARSET0_CHAR

See Also:

• Constant Field Values

SECOND_CHARSET1_CHAR

private static final int SECOND_CHARSET1_CHAR

See Also:

• Constant Field Values

ap

private AnsiProcessor ap

MAX_ESCAPE_SEQUENCE_LENGTH

private static final int MAX_ESCAPE_SEQUENCE_LENGTH

See Also:

• Constant Field Values

buffer

private final byte[] buffer

pos

private int pos

startOfValue

private int startOfValue

options

private final ArrayList<Object> options

state

private int state

cs

private final Charset cs

width

private final AnsiOutputStream.WidthSupplier width

processor

private final AnsiProcessor processor

type

private final AnsiType type

colors

private final AnsiColors colors

installer

private final AnsiOutputStream.IoRunnable installer

uninstaller

private final AnsiOutputStream.IoRunnable uninstaller

mode

private AnsiMode mode

resetAtUninstall

private boolean resetAtUninstall

Constructor Details

AnsiOutputStream

public AnsiOutputStream(OutputStream os,
 AnsiOutputStream.WidthSupplier width,
 AnsiMode mode,
 AnsiProcessor processor,
 AnsiType type,
 AnsiColors colors,
 Charset cs,
 AnsiOutputStream.IoRunnable installer,
 AnsiOutputStream.IoRunnable uninstaller,
 boolean resetAtUninstall)

Method Details

getTerminalWidth

public int getTerminalWidth()

getType

public AnsiType getType()

getColors

public AnsiColors getColors()

getMode

public AnsiMode getMode()

setMode

public void setMode(AnsiMode mode)

isResetAtUninstall

public boolean isResetAtUninstall()

setResetAtUninstall

public void setResetAtUninstall(boolean resetAtUninstall)

write

public void write(int data)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

processCharsetSelect

private void processCharsetSelect()
                           throws IOException

Throws:

IOException

processOperatingSystemCommand

private void processOperatingSystemCommand()
                                    throws IOException

Throws:

IOException

processEscapeCommand

private void processEscapeCommand(int data)
                           throws IOException

Throws:

IOException

reset

private void reset(boolean skipBuffer)
            throws IOException

Resets all state to continue with regular parsing

Parameters:

skipBuffer - if current buffer should be skipped or written to out

Throws:

IOException

install

public void install()
             throws IOException

Throws:

IOException

uninstall

public void uninstall()
               throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException