org.fusesource.jansi.internal

Class Kernel32

java.lang.Object

org.fusesource.jansi.internal.Kernel32

public class Kernel32
extends java.lang.Object

Author:

Hiram Chirino

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Kernel32.CHAR_INFO see: https://msdn.microsoft.com/en-us/library/windows/desktop/ms682013(v=vs.85).aspx
static class	Kernel32.CONSOLE_SCREEN_BUFFER_INFO http://msdn.microsoft.com/en-us/library/ms682093%28VS.85%29.aspx
static class	Kernel32.COORD
static class	Kernel32.INPUT_RECORD see: http://msdn.microsoft.com/en-us/library/ms683499(v=VS.85).aspx
static class	Kernel32.KEY_EVENT_RECORD see: http://msdn.microsoft.com/en-us/library/ms684166(v=VS.85).aspx
static class	Kernel32.SMALL_RECT http://msdn.microsoft.com/en-us/library/ms686311%28VS.85%29.aspx

Field Summary

Fields

Modifier and Type	Field and Description
static short	BACKGROUND_BLUE
static short	BACKGROUND_GREEN
static short	BACKGROUND_INTENSITY
static short	BACKGROUND_RED
static short	COMMON_LVB_GRID_HORIZONTAL
static short	COMMON_LVB_GRID_LVERTICAL
static short	COMMON_LVB_GRID_RVERTICAL
static short	COMMON_LVB_LEADING_BYTE
static short	COMMON_LVB_REVERSE_VIDEO
static short	COMMON_LVB_TRAILING_BYTE
static short	COMMON_LVB_UNDERSCORE
static short	FOREGROUND_BLUE
static short	FOREGROUND_GREEN
static short	FOREGROUND_INTENSITY
static short	FOREGROUND_RED
static int	FORMAT_MESSAGE_FROM_SYSTEM
static int	INVALID_HANDLE_VALUE
static int	STD_ERROR_HANDLE
static int	STD_INPUT_HANDLE
static int	STD_OUTPUT_HANDLE

Constructor Summary

Constructors

Constructor and Description
Kernel32()

Method Summary

Modifier and Type	Method and Description
static int	_getch() see: http://msdn.microsoft.com/en-us/library/078sfkak(VS.80).aspx
static int	CloseHandle(long handle) see: http://msdn.microsoft.com/en-us/library/ms724211%28VS.85%29.aspx
static int	FillConsoleOutputAttribute(long consoleOutput, short attribute, int length, Kernel32.COORD writeCoord, int[] numberOfAttrsWritten) see: https://msdn.microsoft.com/en-us/library/ms682662%28VS.85%29.aspx
static int	FillConsoleOutputCharacterW(long consoleOutput, char character, int length, Kernel32.COORD writeCoord, int[] numberOfCharsWritten) see: http://msdn.microsoft.com/en-us/library/ms682663%28VS.85%29.aspx
static int	FlushConsoleInputBuffer(long handle) see: http://msdn.microsoft.com/en-us/library/ms683147(v=VS.85).aspx
static int	FormatMessageW(int flags, long source, int messageId, int languageId, byte[] buffer, int size, long[] args)
static void	free(long ptr)
static int	GetConsoleMode(long handle, int[] mode) see: http://msdn.microsoft.com/en-us/library/ms683167%28VS.85%29.aspx
static int	GetConsoleOutputCP() see: http://msdn.microsoft.com/en-us/library/ms683169(v=VS.85).aspx
static int	GetConsoleScreenBufferInfo(long consoleOutput, Kernel32.CONSOLE_SCREEN_BUFFER_INFO consoleScreenBufferInfo) See: http://msdn.microsoft.com/en-us/library/ms683171%28VS.85%29.aspx
static int	GetLastError() see: http://msdn.microsoft.com/en-us/library/ms679360(VS.85).aspx
static int	GetNumberOfConsoleInputEvents(long handle, int[] numberOfEvents) see: http://msdn.microsoft.com/en-us/library/ms683207(v=VS.85).aspx
static long	GetStdHandle(int stdHandle) see: http://msdn.microsoft.com/en-us/library/ms683231%28VS.85%29.aspx
static long	malloc(long size)
static Kernel32.INPUT_RECORD[]	readConsoleInputHelper(long handle, int count, boolean peek) Return console input events.
static Kernel32.INPUT_RECORD[]	readConsoleKeyInput(long handle, int count, boolean peek) Return console input key events (discard other events).
static int	ScrollConsoleScreenBuffer(long consoleOutput, Kernel32.SMALL_RECT scrollRectangle, Kernel32.SMALL_RECT clipRectangle, Kernel32.COORD destinationOrigin, Kernel32.CHAR_INFO fill) see: https://msdn.microsoft.com/en-us/library/windows/desktop/ms685107(v=vs.85).aspx
static int	SetConsoleCursorPosition(long consoleOutput, Kernel32.COORD cursorPosition) http://msdn.microsoft.com/en-us/library/ms686025%28VS.85%29.aspx
static int	SetConsoleMode(long handle, int mode) see: http://msdn.microsoft.com/en-us/library/ms686033%28VS.85%29.aspx
static int	SetConsoleOutputCP(int codePageID) see: http://msdn.microsoft.com/en-us/library/ms686036(v=VS.85).aspx
static int	SetConsoleTextAttribute(long consoleOutput, short attributes) see http://msdn.microsoft.com/en-us/library/ms686047%28VS.85%29.aspx
static int	SetConsoleTitle(java.lang.String title) see: http://msdn.microsoft.com/en-us/library/ms686050%28VS.85%29.aspx
static int	WriteConsoleW(long consoleOutput, char[] buffer, int numberOfCharsToWrite, int[] numberOfCharsWritten, long reserved) see: http://msdn.microsoft.com/en-us/library/ms687401(v=VS.85).aspx

Methods inherited from class java.lang.Object

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

Field Detail

FOREGROUND_BLUE

public static short FOREGROUND_BLUE

FOREGROUND_GREEN

public static short FOREGROUND_GREEN

FOREGROUND_RED

public static short FOREGROUND_RED

FOREGROUND_INTENSITY

public static short FOREGROUND_INTENSITY

BACKGROUND_BLUE

public static short BACKGROUND_BLUE

BACKGROUND_GREEN

public static short BACKGROUND_GREEN

BACKGROUND_RED

public static short BACKGROUND_RED

BACKGROUND_INTENSITY

public static short BACKGROUND_INTENSITY

COMMON_LVB_LEADING_BYTE

public static short COMMON_LVB_LEADING_BYTE

COMMON_LVB_TRAILING_BYTE

public static short COMMON_LVB_TRAILING_BYTE

COMMON_LVB_GRID_HORIZONTAL

public static short COMMON_LVB_GRID_HORIZONTAL

COMMON_LVB_GRID_LVERTICAL

public static short COMMON_LVB_GRID_LVERTICAL

COMMON_LVB_GRID_RVERTICAL

public static short COMMON_LVB_GRID_RVERTICAL

COMMON_LVB_REVERSE_VIDEO

public static short COMMON_LVB_REVERSE_VIDEO

COMMON_LVB_UNDERSCORE

public static short COMMON_LVB_UNDERSCORE

FORMAT_MESSAGE_FROM_SYSTEM

public static int FORMAT_MESSAGE_FROM_SYSTEM

STD_INPUT_HANDLE

public static int STD_INPUT_HANDLE

STD_OUTPUT_HANDLE

public static int STD_OUTPUT_HANDLE

STD_ERROR_HANDLE

public static int STD_ERROR_HANDLE

INVALID_HANDLE_VALUE

public static int INVALID_HANDLE_VALUE

Constructor Detail

Kernel32

public Kernel32()

Method Detail

malloc

public static final long malloc(long size)

free

public static final void free(long ptr)

SetConsoleTextAttribute

public static final int SetConsoleTextAttribute(long consoleOutput,
                                                short attributes)

see http://msdn.microsoft.com/en-us/library/ms686047%28VS.85%29.aspx

Parameters:

consoleOutput -

attributes -

Returns:

CloseHandle

public static final int CloseHandle(long handle)

see: http://msdn.microsoft.com/en-us/library/ms724211%28VS.85%29.aspx

Parameters:

handle -

Returns:

GetLastError

public static final int GetLastError()

see: http://msdn.microsoft.com/en-us/library/ms679360(VS.85).aspx

Returns:

FormatMessageW

public static final int FormatMessageW(int flags,
                                       long source,
                                       int messageId,
                                       int languageId,
                                       byte[] buffer,
                                       int size,
                                       long[] args)

Parameters:

flags -

source -

messageId -

languageId -

buffer -

size -

args -

Returns:

GetConsoleScreenBufferInfo

public static final int GetConsoleScreenBufferInfo(long consoleOutput,
                                                   Kernel32.CONSOLE_SCREEN_BUFFER_INFO consoleScreenBufferInfo)

See: http://msdn.microsoft.com/en-us/library/ms683171%28VS.85%29.aspx

Parameters:

consoleOutput -

consoleScreenBufferInfo -

Returns:

GetStdHandle

public static final long GetStdHandle(int stdHandle)

see: http://msdn.microsoft.com/en-us/library/ms683231%28VS.85%29.aspx

Parameters:

stdHandle -

Returns:

SetConsoleCursorPosition

public static final int SetConsoleCursorPosition(long consoleOutput,
                                                 Kernel32.COORD cursorPosition)

http://msdn.microsoft.com/en-us/library/ms686025%28VS.85%29.aspx

Parameters:

consoleOutput -

cursorPosition -

Returns:

FillConsoleOutputCharacterW

public static final int FillConsoleOutputCharacterW(long consoleOutput,
                                                    char character,
                                                    int length,
                                                    Kernel32.COORD writeCoord,
                                                    int[] numberOfCharsWritten)

see: http://msdn.microsoft.com/en-us/library/ms682663%28VS.85%29.aspx

Parameters:

consoleOutput -

character -

length -

writeCoord -

numberOfCharsWritten -

Returns:

FillConsoleOutputAttribute

public static final int FillConsoleOutputAttribute(long consoleOutput,
                                                   short attribute,
                                                   int length,
                                                   Kernel32.COORD writeCoord,
                                                   int[] numberOfAttrsWritten)

see: https://msdn.microsoft.com/en-us/library/ms682662%28VS.85%29.aspx

Parameters:

consoleOutput -

attribute -

length -

writeCoord -

numberOfAttrsWritten -

Returns:

WriteConsoleW

public static final int WriteConsoleW(long consoleOutput,
                                      char[] buffer,
                                      int numberOfCharsToWrite,
                                      int[] numberOfCharsWritten,
                                      long reserved)

see: http://msdn.microsoft.com/en-us/library/ms687401(v=VS.85).aspx

Parameters:

consoleOutput -

buffer -

numberOfCharsToWrite -

numberOfCharsWritten -

reserved - must be null

Returns:

GetConsoleMode

public static final int GetConsoleMode(long handle,
                                       int[] mode)

see: http://msdn.microsoft.com/en-us/library/ms683167%28VS.85%29.aspx

Parameters:

handle -

mode -

Returns:

SetConsoleMode

public static final int SetConsoleMode(long handle,
                                       int mode)

see: http://msdn.microsoft.com/en-us/library/ms686033%28VS.85%29.aspx

Parameters:

handle -

mode -

Returns:

_getch

public static final int _getch()

see: http://msdn.microsoft.com/en-us/library/078sfkak(VS.80).aspx

Returns:

SetConsoleTitle

public static final int SetConsoleTitle(java.lang.String title)

see: http://msdn.microsoft.com/en-us/library/ms686050%28VS.85%29.aspx

Parameters:

title -

Returns:

0 if title was set successfully

GetConsoleOutputCP

public static final int GetConsoleOutputCP()

see: http://msdn.microsoft.com/en-us/library/ms683169(v=VS.85).aspx

Returns:

the current output code page

SetConsoleOutputCP

public static final int SetConsoleOutputCP(int codePageID)

see: http://msdn.microsoft.com/en-us/library/ms686036(v=VS.85).aspx

Parameters:

codePageID -

Returns:

non 0 if code page was set

ScrollConsoleScreenBuffer

public static final int ScrollConsoleScreenBuffer(long consoleOutput,
                                                  Kernel32.SMALL_RECT scrollRectangle,
                                                  Kernel32.SMALL_RECT clipRectangle,
                                                  Kernel32.COORD destinationOrigin,
                                                  Kernel32.CHAR_INFO fill)

see: https://msdn.microsoft.com/en-us/library/windows/desktop/ms685107(v=vs.85).aspx

GetNumberOfConsoleInputEvents

public static final int GetNumberOfConsoleInputEvents(long handle,
                                                      int[] numberOfEvents)

see: http://msdn.microsoft.com/en-us/library/ms683207(v=VS.85).aspx

Parameters:

handle -

numberOfEvents - number of unread input records in the console's input buffer

Returns:

FlushConsoleInputBuffer

public static final int FlushConsoleInputBuffer(long handle)

see: http://msdn.microsoft.com/en-us/library/ms683147(v=VS.85).aspx

Parameters:

handle -

Returns:

readConsoleInputHelper

public static Kernel32.INPUT_RECORD[] readConsoleInputHelper(long handle,
                                                             int count,
                                                             boolean peek)
                                                      throws java.io.IOException

Return console input events.

Parameters:

handle -

count - requested number of events

Returns:

null on read errors

Throws:

java.io.IOException

readConsoleKeyInput

public static Kernel32.INPUT_RECORD[] readConsoleKeyInput(long handle,
                                                          int count,
                                                          boolean peek)
                                                   throws java.io.IOException

Return console input key events (discard other events).

Parameters:

count - requested number of events

Returns:

array possibly of size smaller then count

Throws:

java.io.IOException