ketraterm-core/io.github.ketraterm.core.api/TerminalModeBits

TerminalModeBits

Public contract for the packed terminal mode bit layout.

The constants in this object define the bits inside snapshots returned by TerminalInputState.getInputModeBits. Core owns the values, while input and rendering code may read them through the helper methods without depending on core internals.

Properties

AMBIGUOUS_WIDE

const val AMBIGUOUS_WIDE: Long

Ambiguous-width Unicode policy flag.

APPLICATION_CURSOR_KEYS

const val APPLICATION_CURSOR_KEYS: Long

Application cursor keys mode flag (DECCKM).

APPLICATION_KEYPAD

const val APPLICATION_KEYPAD: Long

Application keypad mode flag (DECNKM).

AUTO_WRAP

const val AUTO_WRAP: Long

Auto-wrap mode flag (DECAWM).

BELL_IS_URGENT

const val BELL_IS_URGENT: Long

Bell is urgent mode flag (?1042).

BRACKETED_PASTE

const val BRACKETED_PASTE: Long

Bracketed paste reporting flag.

CURSOR_BLINKING

const val CURSOR_BLINKING: Long

Cursor blinking presentation flag.

CURSOR_VISIBLE

const val CURSOR_VISIBLE: Long

Cursor visibility presentation flag.

FOCUS_REPORTING

const val FOCUS_REPORTING: Long

Focus in/out reporting flag.

FORMAT_OTHER_KEYS_MASK

const val FORMAT_OTHER_KEYS_MASK: Long

Bit mask for the packed format-other-keys mode field.

FORMAT_OTHER_KEYS_SHIFT

const val FORMAT_OTHER_KEYS_SHIFT: Int = 27

Starting bit for the packed format-other-keys mode field.

FORMAT_OTHER_KEYS_WIDTH

const val FORMAT_OTHER_KEYS_WIDTH: Int = 2

Width in bits of the packed format-other-keys mode field.

INSERT_MODE

const val INSERT_MODE: Long

Insert/replace mode flag (IRM).

KITTY_KEYBOARD_FLAGS_MASK

const val KITTY_KEYBOARD_FLAGS_MASK: Long

Bit mask for the packed Kitty keyboard progressive-enhancement flags.

KITTY_KEYBOARD_FLAGS_SHIFT

const val KITTY_KEYBOARD_FLAGS_SHIFT: Int = 29

Starting bit for the packed Kitty keyboard progressive-enhancement flags.

KITTY_KEYBOARD_FLAGS_WIDTH

const val KITTY_KEYBOARD_FLAGS_WIDTH: Int = 5

Width in bits of the packed Kitty keyboard progressive-enhancement flags.

LEFT_RIGHT_MARGIN_MODE

const val LEFT_RIGHT_MARGIN_MODE: Long

Left/right margin mode flag (DECLRMM).

MODIFY_OTHER_KEYS_MASK

const val MODIFY_OTHER_KEYS_MASK: Long

Bit mask for the packed modify-other-keys mode field.

MODIFY_OTHER_KEYS_SHIFT

const val MODIFY_OTHER_KEYS_SHIFT: Int = 16

Starting bit for the packed modify-other-keys mode field.

MODIFY_OTHER_KEYS_WIDTH

const val MODIFY_OTHER_KEYS_WIDTH: Int = 3

Width in bits of the packed modify-other-keys mode field.

MOUSE_ENCODING_MASK

const val MOUSE_ENCODING_MASK: Long

Bit mask for the packed mouse encoding mode field.

MOUSE_ENCODING_SHIFT

const val MOUSE_ENCODING_SHIFT: Int = 24

Starting bit for the packed mouse encoding mode field.

MOUSE_ENCODING_WIDTH

const val MOUSE_ENCODING_WIDTH: Int = 3

Width in bits of the packed mouse encoding mode field.

MOUSE_TRACKING_MASK

const val MOUSE_TRACKING_MASK: Long

Bit mask for the packed mouse tracking mode field.

MOUSE_TRACKING_SHIFT

const val MOUSE_TRACKING_SHIFT: Int = 20

Starting bit for the packed mouse tracking mode field.

MOUSE_TRACKING_WIDTH

const val MOUSE_TRACKING_WIDTH: Int = 4

Width in bits of the packed mouse tracking mode field.

NEW_LINE_MODE

const val NEW_LINE_MODE: Long

New-line mode flag (LNM).

ORIGIN_MODE

const val ORIGIN_MODE: Long

Origin mode flag (DECOM).

POP_ON_BELL

const val POP_ON_BELL: Long

Pop on bell mode flag (?1043).

REVERSE_VIDEO

const val REVERSE_VIDEO: Long

Reverse-video presentation flag (DECSCNM).

SYNCHRONIZED_OUTPUT

const val SYNCHRONIZED_OUTPUT: Long

Synchronized output mode flag (?2026).

Functions

hasFlag

@JvmStatic

fun hasFlag(bits: Long, flag: Long): Boolean

Returns true when flag is set in bits.

packedValue

@JvmStatic

fun packedValue(bits: Long, mask: Long, shift: Int): Int

Extracts a packed integer field from bits.

withPackedValue

@JvmStatic

fun withPackedValue(bits: Long, mask: Long, shift: Int, value: Int): Long

Returns bits with one packed integer field replaced by value.