java.lang.Object

org.fusesource.jansi.io.AnsiProcessor

org.fusesource.jansi.io.WindowsAnsiProcessor

public final class WindowsAnsiProcessor extends AnsiProcessor

A Windows ANSI escape processor, that uses JNA to access native platform API's to change the console attributes (see Jansi native Kernel32).

The native library used is named jansi and is loaded using HawtJNI Runtime Library

Since:: 1.19

Field Summary

Fields

Modifier and Type

Field

Description

private static final short[]

ANSI_BACKGROUND_COLOR_MAP

private static final short[]

ANSI_FOREGROUND_COLOR_MAP

private static final short

BACKGROUND_BLACK

private static final short

BACKGROUND_CYAN

private static final short

BACKGROUND_MAGENTA

private static final short

BACKGROUND_WHITE

private static final short

BACKGROUND_YELLOW

private final long

console

private static final short

FOREGROUND_BLACK

private static final short

FOREGROUND_CYAN

private static final short

FOREGROUND_MAGENTA

private static final short

FOREGROUND_WHITE

private static final short

FOREGROUND_YELLOW

private final Kernel32.CONSOLE_SCREEN_BUFFER_INFO

info

private boolean

negative

private final short

originalColors

private short

savedX

private short

savedY

Fields inherited from class org.fusesource.jansi.io.AnsiProcessor
ATTRIBUTE_BLINK_FAST, ATTRIBUTE_BLINK_OFF, ATTRIBUTE_BLINK_SLOW, ATTRIBUTE_CONCEAL_OFF, ATTRIBUTE_CONCEAL_ON, ATTRIBUTE_INTENSITY_BOLD, ATTRIBUTE_INTENSITY_FAINT, ATTRIBUTE_INTENSITY_NORMAL, ATTRIBUTE_ITALIC, ATTRIBUTE_NEGATIVE_OFF, ATTRIBUTE_NEGATIVE_ON, ATTRIBUTE_UNDERLINE, ATTRIBUTE_UNDERLINE_DOUBLE, ATTRIBUTE_UNDERLINE_OFF, BLACK, BLUE, CYAN, ERASE_LINE, ERASE_LINE_TO_BEGINING, ERASE_LINE_TO_END, ERASE_SCREEN, ERASE_SCREEN_TO_BEGINING, ERASE_SCREEN_TO_END, GREEN, MAGENTA, os, RED, WHITE, YELLOW
Constructor Summary

Constructors

Constructor

Description

WindowsAnsiProcessor(OutputStream ps)

WindowsAnsiProcessor(OutputStream ps, boolean stdout)

WindowsAnsiProcessor(OutputStream ps, long console)
Method Summary

Modifier and Type

Method

Description

private void

applyAttribute()

private void

applyCursorPosition()

private void

getConsoleInfo()

private short

invertAttributeColors(short attributes)

protected void

processAttributeReset()

process SGR 0 corresponding to Reset / Normal

protected void

processChangeWindowTitle(String label)

process OSC 2;text BEL corresponding to Change Window title

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 M 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 L 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

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, 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, 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.

Methods inherited from class org.fusesource.jansi.io.AnsiProcessor
getNextOptionInt, processChangeIconName, processChangeIconNameAndWindowTitle, processCharsetSelect, processCharsetSelect, processEscapeCommand, processOperatingSystemCommand, processScrollDown, processScrollUp, processSetBackgroundColor, processSetForegroundColor, processUnknownExtension, processUnknownOperatingSystemCommand

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- console
  
  private final long console
- FOREGROUND_BLACK
  
  private static final short FOREGROUND_BLACK
  See Also:
  
  Constant Field Values
- FOREGROUND_YELLOW
  
  private static final short FOREGROUND_YELLOW
- FOREGROUND_MAGENTA
  
  private static final short FOREGROUND_MAGENTA
- FOREGROUND_CYAN
  
  private static final short FOREGROUND_CYAN
- FOREGROUND_WHITE
  
  private static final short FOREGROUND_WHITE
- BACKGROUND_BLACK
  
  private static final short BACKGROUND_BLACK
  See Also:
  
  Constant Field Values
- BACKGROUND_YELLOW
  
  private static final short BACKGROUND_YELLOW
- BACKGROUND_MAGENTA
  
  private static final short BACKGROUND_MAGENTA
- BACKGROUND_CYAN
  
  private static final short BACKGROUND_CYAN
- BACKGROUND_WHITE
  
  private static final short BACKGROUND_WHITE
- ANSI_FOREGROUND_COLOR_MAP
  
  private static final short[] ANSI_FOREGROUND_COLOR_MAP
- ANSI_BACKGROUND_COLOR_MAP
  
  private static final short[] ANSI_BACKGROUND_COLOR_MAP
- info
  
  private final Kernel32.CONSOLE_SCREEN_BUFFER_INFO info
- originalColors
  
  private final short originalColors
- negative
  
  private boolean negative
- savedX
  
  private short savedX
- savedY
  
  private short savedY
Constructor Details
- WindowsAnsiProcessor
  
  public WindowsAnsiProcessor(OutputStream ps, long console) throws IOException
  
  Throws:
  
  IOException
- WindowsAnsiProcessor
  
  public WindowsAnsiProcessor(OutputStream ps, boolean stdout) throws IOException
  
  Throws:
  
  IOException
- WindowsAnsiProcessor
  
  public WindowsAnsiProcessor(OutputStream ps) throws IOException
  
  Throws:
  
  IOException
Method Details
- getConsoleInfo
  
  private void getConsoleInfo() throws IOException
  
  Throws:
  
  IOException
- applyAttribute
  
  private void applyAttribute() throws IOException
  
  Throws:
  
  IOException
- invertAttributeColors
  
  private short invertAttributeColors(short attributes)
- applyCursorPosition
  
  private void applyCursorPosition() throws IOException
  
  Throws:
  
  IOException
- processEraseScreen
  
  protected void processEraseScreen(int eraseOption) throws IOException
  
  Description copied from class: AnsiProcessor
  
  Process CSI n J ANSI code, corresponding to ED – Erase in Display
  
  Overrides:
  
  processEraseScreen in class AnsiProcessor
  
  Parameters:
  
  eraseOption - eraseOption
  
  Throws:
  
  IOException - IOException
- processEraseLine
  
  protected void processEraseLine(int eraseOption) throws IOException
  
  Description copied from class: AnsiProcessor
  
  Process CSI n K ANSI code, corresponding to ED – Erase in Line
  
  Overrides:
  
  processEraseLine in class AnsiProcessor
  
  Parameters:
  
  eraseOption - eraseOption
  
  Throws:
  
  IOException - IOException
- processCursorLeft
  
  protected void processCursorLeft(int count) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process CSI n D corresponding to CUB – Cursor Back
  
  Overrides:
  
  processCursorLeft in class AnsiProcessor
  
  Parameters:
  
  count - count
  
  Throws:
  
  IOException - IOException
- processCursorRight
  
  protected void processCursorRight(int count) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process CSI n C corresponding to CUF – Cursor Forward
  
  Overrides:
  
  processCursorRight in class AnsiProcessor
  
  Parameters:
  
  count - count
  
  Throws:
  
  IOException - IOException
- processCursorDown
  
  protected void processCursorDown(int count) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process CSI n B corresponding to CUD – Cursor Down
  
  Overrides:
  
  processCursorDown in class AnsiProcessor
  
  Parameters:
  
  count - count
  
  Throws:
  
  IOException - IOException
- processCursorUp
  
  protected void processCursorUp(int count) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process CSI n A corresponding to CUU – Cursor Up
  
  Overrides:
  
  processCursorUp in class AnsiProcessor
  
  Parameters:
  
  count - count
  
  Throws:
  
  IOException - IOException
- processCursorTo
  
  protected void processCursorTo(int row, int col) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process CSI n ; m H corresponding to CUP – Cursor Position or CSI n ; m f corresponding to HVP – Horizontal and Vertical Position
  
  Overrides:
  
  processCursorTo in class AnsiProcessor
  
  Parameters:
  
  row - row
  
  col - col
  
  Throws:
  
  IOException - IOException
- processCursorToColumn
  
  protected void processCursorToColumn(int x) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process CSI n G corresponding to CHA – Cursor Horizontal Absolute
  
  Overrides:
  
  processCursorToColumn in class AnsiProcessor
  
  Parameters:
  
  x - the column
  
  Throws:
  
  IOException - IOException
- processCursorUpLine
  
  protected void processCursorUpLine(int count) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process CSI n F corresponding to CPL – Cursor Previous Line
  
  Overrides:
  
  processCursorUpLine in class AnsiProcessor
  
  Parameters:
  
  count - line count
  
  Throws:
  
  IOException - IOException
- processCursorDownLine
  
  protected void processCursorDownLine(int count) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process CSI n E corresponding to CNL – Cursor Next Line
  
  Overrides:
  
  processCursorDownLine in class AnsiProcessor
  
  Parameters:
  
  count - line count
  
  Throws:
  
  IOException - IOException
- processSetForegroundColor
  
  protected void processSetForegroundColor(int color, boolean bright) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process SGR 30-37 or SGR 90-97 corresponding to Set text color (foreground) either in normal mode or high intensity.
  
  Overrides:
  
  processSetForegroundColor in class AnsiProcessor
  
  Parameters:
  
  color - the text color
  
  bright - is high intensity?
  
  Throws:
  
  IOException - IOException
- processSetForegroundColorExt
  
  protected void processSetForegroundColorExt(int paletteIndex) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process SGR 38 corresponding to extended set text color (foreground) with a palette of 255 colors.
  
  Overrides:
  
  processSetForegroundColorExt in class AnsiProcessor
  
  Parameters:
  
  paletteIndex - the text color in the palette
  
  Throws:
  
  IOException - IOException
- processSetForegroundColorExt
  
  protected void processSetForegroundColorExt(int r, int g, int b) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process SGR 38 corresponding to extended set text color (foreground) with a 24 bits RGB definition of the color.
  
  Overrides:
  
  processSetForegroundColorExt in class AnsiProcessor
  
  Parameters:
  
  r - red
  
  g - green
  
  b - blue
  
  Throws:
  
  IOException - IOException
- processSetBackgroundColor
  
  protected void processSetBackgroundColor(int color, boolean bright) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process SGR 40-47 or SGR 100-107 corresponding to Set background color either in normal mode or high intensity.
  
  Overrides:
  
  processSetBackgroundColor in class AnsiProcessor
  
  Parameters:
  
  color - the background color
  
  bright - is high intensity?
  
  Throws:
  
  IOException - IOException
- processSetBackgroundColorExt
  
  protected void processSetBackgroundColorExt(int paletteIndex) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process SGR 48 corresponding to extended set background color with a palette of 255 colors.
  
  Overrides:
  
  processSetBackgroundColorExt in class AnsiProcessor
  
  Parameters:
  
  paletteIndex - the background color in the palette
  
  Throws:
  
  IOException - IOException
- processSetBackgroundColorExt
  
  protected void processSetBackgroundColorExt(int r, int g, int b) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process SGR 48 corresponding to extended set background color with a 24 bits RGB definition of the color.
  
  Overrides:
  
  processSetBackgroundColorExt in class AnsiProcessor
  
  Parameters:
  
  r - red
  
  g - green
  
  b - blue
  
  Throws:
  
  IOException - IOException
- processDefaultTextColor
  
  protected void processDefaultTextColor() throws IOException
  
  Description copied from class: AnsiProcessor
  
  process SGR 39 corresponding to Default text color (foreground)
  
  Overrides:
  
  processDefaultTextColor in class AnsiProcessor
  
  Throws:
  
  IOException - IOException
- processDefaultBackgroundColor
  
  protected void processDefaultBackgroundColor() throws IOException
  
  Description copied from class: AnsiProcessor
  
  process SGR 49 corresponding to Default background color
  
  Overrides:
  
  processDefaultBackgroundColor in class AnsiProcessor
  
  Throws:
  
  IOException - IOException
- processAttributeReset
  
  protected void processAttributeReset() throws IOException
  
  Description copied from class: AnsiProcessor
  
  process SGR 0 corresponding to Reset / Normal
  
  Overrides:
  
  processAttributeReset in class AnsiProcessor
  
  Throws:
  
  IOException - IOException
- processSetAttribute
  
  protected void processSetAttribute(int attribute) throws IOException
  
  Description copied from class: AnsiProcessor
  
  process SGR other than 0 (reset), 30-39 (foreground), 40-49 (background), 90-97 (foreground high intensity) or 100-107 (background high intensity)
  Overrides:
  
  processSetAttribute in class AnsiProcessor
  
  Parameters:
  
  attribute - attribute
  
  Throws:
  
  IOException - IOException
  
  See Also:
  
  AnsiProcessor.processAttributeReset()
  
  AnsiProcessor.processSetForegroundColor(int)
  
  AnsiProcessor.processSetForegroundColor(int, boolean)
  
  AnsiProcessor.processSetForegroundColorExt(int)
  
  AnsiProcessor.processSetForegroundColorExt(int, int, int)
  
  AnsiProcessor.processDefaultTextColor()
  
  AnsiProcessor.processDefaultBackgroundColor()
- processSaveCursorPosition
  
  protected void processSaveCursorPosition() throws IOException
  
  Description copied from class: AnsiProcessor
  
  Process CSI s ANSI code, corresponding to SCP – Save Cursor Position
  
  Overrides:
  
  processSaveCursorPosition in class AnsiProcessor
  
  Throws:
  
  IOException - IOException
- processRestoreCursorPosition
  
  protected void processRestoreCursorPosition() throws IOException
  
  Description copied from class: AnsiProcessor
  
  Process CSI u ANSI code, corresponding to RCP – Restore Cursor Position
  
  Overrides:
  
  processRestoreCursorPosition in class AnsiProcessor
  
  Throws:
  
  IOException - IOException
- processInsertLine
  
  protected void processInsertLine(int optionInt) throws IOException
  
  Description copied from class: AnsiProcessor
  
  Process CSI L ANSI code, corresponding to IL – Insert Line
  
  Overrides:
  
  processInsertLine in class AnsiProcessor
  
  Parameters:
  
  optionInt - option
  
  Throws:
  
  IOException - IOException
- processDeleteLine
  
  protected void processDeleteLine(int optionInt) throws IOException
  
  Description copied from class: AnsiProcessor
  
  Process CSI M ANSI code, corresponding to DL – Delete Line
  
  Overrides:
  
  processDeleteLine in class AnsiProcessor
  
  Parameters:
  
  optionInt - option
  
  Throws:
  
  IOException - IOException
- processChangeWindowTitle
  
  protected void processChangeWindowTitle(String label)
  
  Description copied from class: AnsiProcessor
  
  process OSC 2;text BEL corresponding to Change Window title
  
  Overrides:
  
  processChangeWindowTitle in class AnsiProcessor
  
  Parameters:
  
  label - window title text

Class WindowsAnsiProcessor

Field Summary

Fields inherited from class org.fusesource.jansi.io.AnsiProcessor

Constructor Summary

Method Summary

Methods inherited from class org.fusesource.jansi.io.AnsiProcessor

Methods inherited from class java.lang.Object

Field Details

console

FOREGROUND_BLACK

FOREGROUND_YELLOW

FOREGROUND_MAGENTA

FOREGROUND_CYAN

FOREGROUND_WHITE

BACKGROUND_BLACK

BACKGROUND_YELLOW

BACKGROUND_MAGENTA

BACKGROUND_CYAN

BACKGROUND_WHITE

ANSI_FOREGROUND_COLOR_MAP

ANSI_BACKGROUND_COLOR_MAP

info

originalColors

negative

savedX

savedY

Constructor Details

WindowsAnsiProcessor

WindowsAnsiProcessor

WindowsAnsiProcessor

Method Details

getConsoleInfo

applyAttribute

invertAttributeColors

applyCursorPosition

processEraseScreen

processEraseLine

processCursorLeft

processCursorRight

processCursorDown

processCursorUp

processCursorTo

processCursorToColumn

processCursorUpLine

processCursorDownLine

processSetForegroundColor

processSetForegroundColorExt

processSetForegroundColorExt

processSetBackgroundColor

processSetBackgroundColorExt

processSetBackgroundColorExt

processDefaultTextColor

processDefaultBackgroundColor

processAttributeReset

processSetAttribute

processSaveCursorPosition

processRestoreCursorPosition

processInsertLine

processDeleteLine

processChangeWindowTitle