File size: 7,076 Bytes
064bfd6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | /**
* ANSI Parser - Semantic Types
*
* These types represent the semantic meaning of ANSI escape sequences,
* not their string representation. Inspired by ghostty's action-based design.
*/
// =============================================================================
// Colors
// =============================================================================
/** Named colors from the 16-color palette */
export type NamedColor =
| 'black'
| 'red'
| 'green'
| 'yellow'
| 'blue'
| 'magenta'
| 'cyan'
| 'white'
| 'brightBlack'
| 'brightRed'
| 'brightGreen'
| 'brightYellow'
| 'brightBlue'
| 'brightMagenta'
| 'brightCyan'
| 'brightWhite'
/** Color specification - can be named, indexed (256), or RGB */
export type Color =
| { type: 'named'; name: NamedColor }
| { type: 'indexed'; index: number } // 0-255
| { type: 'rgb'; r: number; g: number; b: number }
| { type: 'default' }
// =============================================================================
// Text Styles
// =============================================================================
/** Underline style variants */
export type UnderlineStyle =
| 'none'
| 'single'
| 'double'
| 'curly'
| 'dotted'
| 'dashed'
/** Text style attributes - represents current styling state */
export type TextStyle = {
bold: boolean
dim: boolean
italic: boolean
underline: UnderlineStyle
blink: boolean
inverse: boolean
hidden: boolean
strikethrough: boolean
overline: boolean
fg: Color
bg: Color
underlineColor: Color
}
/** Create a default (reset) text style */
export function defaultStyle(): TextStyle {
return {
bold: false,
dim: false,
italic: false,
underline: 'none',
blink: false,
inverse: false,
hidden: false,
strikethrough: false,
overline: false,
fg: { type: 'default' },
bg: { type: 'default' },
underlineColor: { type: 'default' },
}
}
/** Check if two styles are equal */
export function stylesEqual(a: TextStyle, b: TextStyle): boolean {
return (
a.bold === b.bold &&
a.dim === b.dim &&
a.italic === b.italic &&
a.underline === b.underline &&
a.blink === b.blink &&
a.inverse === b.inverse &&
a.hidden === b.hidden &&
a.strikethrough === b.strikethrough &&
a.overline === b.overline &&
colorsEqual(a.fg, b.fg) &&
colorsEqual(a.bg, b.bg) &&
colorsEqual(a.underlineColor, b.underlineColor)
)
}
/** Check if two colors are equal */
export function colorsEqual(a: Color, b: Color): boolean {
if (a.type !== b.type) return false
switch (a.type) {
case 'named':
return a.name === (b as typeof a).name
case 'indexed':
return a.index === (b as typeof a).index
case 'rgb':
return (
a.r === (b as typeof a).r &&
a.g === (b as typeof a).g &&
a.b === (b as typeof a).b
)
case 'default':
return true
}
}
// =============================================================================
// Cursor Actions
// =============================================================================
export type CursorDirection = 'up' | 'down' | 'forward' | 'back'
export type CursorAction =
| { type: 'move'; direction: CursorDirection; count: number }
| { type: 'position'; row: number; col: number }
| { type: 'column'; col: number }
| { type: 'row'; row: number }
| { type: 'save' }
| { type: 'restore' }
| { type: 'show' }
| { type: 'hide' }
| {
type: 'style'
style: 'block' | 'underline' | 'bar'
blinking: boolean
}
| { type: 'nextLine'; count: number }
| { type: 'prevLine'; count: number }
// =============================================================================
// Erase Actions
// =============================================================================
export type EraseAction =
| { type: 'display'; region: 'toEnd' | 'toStart' | 'all' | 'scrollback' }
| { type: 'line'; region: 'toEnd' | 'toStart' | 'all' }
| { type: 'chars'; count: number }
// =============================================================================
// Scroll Actions
// =============================================================================
export type ScrollAction =
| { type: 'up'; count: number }
| { type: 'down'; count: number }
| { type: 'setRegion'; top: number; bottom: number }
// =============================================================================
// Mode Actions
// =============================================================================
export type ModeAction =
| { type: 'alternateScreen'; enabled: boolean }
| { type: 'bracketedPaste'; enabled: boolean }
| { type: 'mouseTracking'; mode: 'off' | 'normal' | 'button' | 'any' }
| { type: 'focusEvents'; enabled: boolean }
// =============================================================================
// Link Actions (OSC 8)
// =============================================================================
export type LinkAction =
| { type: 'start'; url: string; params?: Record<string, string> }
| { type: 'end' }
// =============================================================================
// Title Actions (OSC 0/1/2)
// =============================================================================
export type TitleAction =
| { type: 'windowTitle'; title: string }
| { type: 'iconName'; name: string }
| { type: 'both'; title: string }
// =============================================================================
// Tab Status Action (OSC 21337)
// =============================================================================
/**
* Per-tab chrome metadata. Tristate for each field:
* - property absent → not mentioned in sequence, no change
* - null → explicitly cleared (bare key or key= with empty value)
* - value → set to this
*/
export type TabStatusAction = {
indicator?: Color | null
status?: string | null
statusColor?: Color | null
}
// =============================================================================
// Parsed Segments - The output of the parser
// =============================================================================
/** A segment of styled text */
export type TextSegment = {
type: 'text'
text: string
style: TextStyle
}
/** A grapheme (visual character unit) with width info */
export type Grapheme = {
value: string
width: 1 | 2 // Display width in columns
}
/** All possible parsed actions */
export type Action =
| { type: 'text'; graphemes: Grapheme[]; style: TextStyle }
| { type: 'cursor'; action: CursorAction }
| { type: 'erase'; action: EraseAction }
| { type: 'scroll'; action: ScrollAction }
| { type: 'mode'; action: ModeAction }
| { type: 'link'; action: LinkAction }
| { type: 'title'; action: TitleAction }
| { type: 'tabStatus'; action: TabStatusAction }
| { type: 'sgr'; params: string } // Select Graphic Rendition (style change)
| { type: 'bell' }
| { type: 'reset' } // Full terminal reset (ESC c)
| { type: 'unknown'; sequence: string } // Unrecognized sequence
|