vterm.js 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vterm.js",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Modern terminal emulator — full VT/ECMA-48/xterm standards coverage. Pure TypeScript, zero dependencies.",
   "keywords": [
     "ansi",

package/src/screen.ts

@@ -20,7 +20,7 @@
  * - Scrollback buffer with configurable limit
  * - Wide character support (CJK, emoji ZWJ, regional indicators, VS-16)
  * - OSC sequences (title, hyperlinks, clipboard, colors)
- * - DCS sequences (consumed and ignored, XTVERSION response)
+ * - DCS sequences (XTVERSION, DECRQSS, XTGETTCAP, Sixel)
  * - APC sequences (Kitty graphics protocol — parsed, query responses)
  * - DA1/DA2/DA3 device attribute responses
  * - DSR (device status report) responses
@@ -101,6 +101,9 @@ export interface Screen {
 
   getTitle(): string
   getMode(mode: string): boolean
+  getClipboard(): string
+  getCwd(): string
+  getNotifications(): string[]
 
   getScrollbackLength(): number
   getViewportOffset(): number
@@ -376,10 +379,20 @@ export function createScreen(options: ScreenOptions = {}): Screen {
   let syncOutput = false
 
   // Kitty keyboard protocol
+  // Headless design: we implement the full push/pop/query state machine so that
+  // applications can negotiate keyboard encoding modes. The flags are stored and
+  // queryable (CSI ? u responds correctly), and a host can read them to decide
+  // how to encode keypresses. The actual key encoding lives in the host layer
+  // (e.g. termless's encodeKeyToAnsi), not here — separation of concerns.
   let kittyKeyboardFlags = 0
   let kittyKeyboardStack: number[] = []
 
   // Kitty graphics protocol
+  // Headless design: we parse the APC G protocol and respond to queries so that
+  // applications relying on the query→response handshake work correctly. We don't
+  // store image data because there's no pixel framebuffer — unlike sixel where we
+  // preserve the raw data for consumers, kitty graphics payloads are chunked and
+  // stateful, making storage without rendering impractical.
   let hasKittyGraphics = false
 
   // Scroll region (inclusive, 0-based)
@@ -395,10 +408,20 @@ export function createScreen(options: ScreenOptions = {}): Screen {
   // Clipboard (OSC 52)
   let clipboard = ""
 
-  // Semantic prompt zones (OSC 133)
+  // Current working directory (OSC 7)
+  let cwd = ""
+
+  // Notifications (OSC 9)
+  let notifications: string[] = []
+
+  // Semantic prompt zones (OSC 133 / OSC 633)
   let semanticZones: SemanticZone[] = []
 
   // Sixel graphics (DCS q)
+  // Headless design: we parse sixel data and store it for consumers (e.g. a GUI
+  // renderer could use getSixelImages() to display them). We don't decode pixels
+  // because there's no framebuffer to render into — but preserving the data means
+  // a host application gets full fidelity without re-parsing the stream.
   let hasSixel = false
   let sixelImages: SixelImage[] = []
 
@@ -792,9 +815,20 @@ export function createScreen(options: ScreenOptions = {}): Screen {
         break
       case "H": // CUP - Cursor Position
       case "f": // HVP - same as CUP
-        curY = (parts[0] ?? 1) - 1
-        curX = (parts[1] ?? 1) - 1
-        clampCursor()
+        if (originMode) {
+          // DECOM: positions are relative to scroll region
+          curY = scrollTop + (parts[0] ?? 1) - 1
+          curX = (parts[1] ?? 1) - 1
+          // Clamp to scroll region bounds
+          if (curY < scrollTop) curY = scrollTop
+          if (curY > scrollBottom) curY = scrollBottom
+          if (curX < 0) curX = 0
+          if (curX >= cols) curX = cols - 1
+        } else {
+          curY = (parts[0] ?? 1) - 1
+          curX = (parts[1] ?? 1) - 1
+          clampCursor()
+        }
         break
       case "J": // ED - Erase in Display
         handleEraseDisplay(parts[0] ?? 0)
@@ -868,6 +902,9 @@ export function createScreen(options: ScreenOptions = {}): Screen {
       case "c": // DA1 - Primary Device Attributes
         if (onResponse) {
           if (params === "" || params === "0") {
+            // VT200 (62) + sixel (4). We include sixel because we parse and
+            // preserve sixel data via getSixelImages() — applications checking
+            // DA1 for sixel support before sending image data will work correctly.
             onResponse("\x1b[?62;4c")
           }
         }
@@ -929,6 +966,18 @@ export function createScreen(options: ScreenOptions = {}): Screen {
     }
   }
 
+  function handleCSIEq(params: string, _intermediates: string, finalByte: string): void {
+    // CSI = sequences
+    if (finalByte === "c") {
+      // DA3 - Tertiary Device Attributes
+      if (onResponse) {
+        if (params === "" || params === "0") {
+          onResponse("\x1bP!|00000000\x1b\\")
+        }
+      }
+    }
+  }
+
   function handleCSIPrivate(params: string, intermediates: string, finalByte: string): void {
     const parts = params.split(";").map((s) => (s === "" ? 0 : parseInt(s, 10)))
 
@@ -995,6 +1044,17 @@ export function createScreen(options: ScreenOptions = {}): Screen {
       return
     }
 
+    // DECSED / DECSEL — selective erase (CSI ? J / CSI ? K)
+    // We treat selective erase same as normal erase (no DECSCA protection tracking)
+    if (finalByte === "J") {
+      handleEraseDisplay(parts[0] ?? 0)
+      return
+    }
+    if (finalByte === "K") {
+      handleEraseLine(parts[0] ?? 0)
+      return
+    }
+
     const set = finalByte === "h"
 
     for (const code of parts) {
@@ -1032,6 +1092,10 @@ export function createScreen(options: ScreenOptions = {}): Screen {
         case 66: // DECNKM - Application Keypad
           applicationKeypad = set
           break
+        case 9: // X10 mouse tracking
+          mouseTracking = set
+          mouseTrackingMode = set ? 9 : 0
+          break
         case 1000: // Mouse tracking (basic)
           mouseTracking = set
           mouseTrackingMode = set ? 1000 : 0
@@ -1044,6 +1108,14 @@ export function createScreen(options: ScreenOptions = {}): Screen {
           mouseTracking = set
           mouseTrackingMode = set ? 1003 : 0
           break
+        case 1015: // urxvt mouse encoding
+          mouseTracking = set
+          mouseTrackingMode = set ? 1015 : 0
+          break
+        case 1016: // SGR pixel mouse
+          mouseTracking = set
+          mouseTrackingMode = set ? 1016 : 0
+          break
         case 1004: // Focus tracking
           focusTracking = set
           break
@@ -1126,7 +1198,12 @@ export function createScreen(options: ScreenOptions = {}): Screen {
     const r = grid[row]
     if (!r) return
     for (let col = startCol; col <= endCol && col < cols; col++) {
-      r[col] = emptyCell()
+      const cell = emptyCell()
+      // Fill erased cells with the current background color
+      if (attrs.bg) {
+        cell.bg = { ...attrs.bg }
+      }
+      r[col] = cell
     }
   }
 
@@ -1473,6 +1550,9 @@ export function createScreen(options: ScreenOptions = {}): Screen {
       }
       case 1: // Set icon name (ignore)
         break
+      case 7: // Current working directory: OSC 7 ; file://host/path ST
+        cwd = value
+        break
       case 8: {
         // Hyperlink: OSC 8 ; params ; url ST
         // Format: 8;params;url  or  8;;url  or 8;;  (close)
@@ -1520,6 +1600,40 @@ export function createScreen(options: ScreenOptions = {}): Screen {
         }
         break
       }
+      case 9: // Notifications: OSC 9 ; message ST (iTerm2/ConEmu convention)
+        notifications.push(value)
+        break
+      case 633: {
+        // VS Code shell integration (OSC 633 is a superset of OSC 133)
+        // Maps to the same semantic zone model as FinalTerm markers.
+        const marker = value.charAt(0)
+        switch (marker) {
+          case "A":
+            semanticZones.push({ type: "prompt", startRow: curY, startCol: curX })
+            break
+          case "B":
+            semanticZones.push({ type: "command", startRow: curY, startCol: curX })
+            break
+          case "C":
+            semanticZones.push({ type: "output", startRow: curY, startCol: curX })
+            break
+          case "D":
+            break
+        }
+        break
+      }
+      case 1337: {
+        // iTerm2 proprietary sequences
+        if (value === "ReportCellSize" && onResponse) {
+          // Report default 8x16 pixel cell size (standard monospace ratio)
+          onResponse("\x1b]1337;ReportCellSize=16;8\x1b\\")
+        } else if (value === "RequestCapabilities" && onResponse) {
+          // Report empty capabilities (protocol supported, no iTerm2-specific features)
+          onResponse("\x1b]1337;Capabilities=\x1b\\")
+        }
+        // Inline images (File=...) are silently consumed — no pixel framebuffer
+        break
+      }
     }
   }
 
@@ -1538,6 +1652,35 @@ export function createScreen(options: ScreenOptions = {}): Screen {
       return
     }
 
+    // DECRQSS: DCS $ q Pt ST → response DCS Ps $ r Pt ST
+    if (data.startsWith("$q") && onResponse) {
+      const pt = data.substring(2)
+      if (pt === '"p') {
+        // DECSCL - Conformance level: VT200 mode, 8-bit controls
+        onResponse('\x1bP1$r62;1"p\x1b\\')
+      } else {
+        // Not recognized
+        onResponse("\x1bP0$r\x1b\\")
+      }
+      return
+    }
+
+    // XTGETTCAP: DCS + q hex ST → response DCS 1 + r hex = hexvalue ST
+    if (data.startsWith("+q") && onResponse) {
+      const hexName = data.substring(2)
+      if (hexName === "544e") {
+        // "TN" = terminal name → "vterm"
+        const hexValue = Array.from(new TextEncoder().encode("vterm"))
+          .map((b) => b.toString(16).padStart(2, "0"))
+          .join("")
+        onResponse(`\x1bP1+r544e=${hexValue}\x1b\\`)
+      } else {
+        // Unknown capability
+        onResponse("\x1bP0+r\x1b\\")
+      }
+      return
+    }
+
     // Other DCS sequences are consumed and ignored
   }
 
@@ -1638,6 +1781,8 @@ export function createScreen(options: ScreenOptions = {}): Screen {
     viewportOffset = 0
     charsetG0 = false
     clipboard = ""
+    cwd = ""
+    notifications = []
     lastChar = ""
     pendingRegionalIndicator = null
     afterZWJ = false
@@ -1777,6 +1922,14 @@ export function createScreen(options: ScreenOptions = {}): Screen {
           } else if (ch === ")") {
             // Designate G1 character set (ignored, just consume next byte)
             parserState = "escape_charset"
+          } else if (ch === "=") {
+            // DECKPAM - Application Keypad Mode
+            applicationKeypad = true
+            parserState = "ground"
+          } else if (ch === ">") {
+            // DECKPNM - Normal Keypad Mode
+            applicationKeypad = false
+            parserState = "ground"
           } else if (ch === "_") {
             // APC - Application Program Command
             parserState = "apc"
@@ -1826,6 +1979,8 @@ export function createScreen(options: ScreenOptions = {}): Screen {
               handleCSIGt(paramPart.substring(1), intermediatePart, ch)
             } else if (paramPart.startsWith("<")) {
               handleCSILt(paramPart.substring(1), intermediatePart, ch)
+            } else if (paramPart.startsWith("=")) {
+              handleCSIEq(paramPart.substring(1), intermediatePart, ch)
             } else {
               handleCSI(paramPart, intermediatePart, ch)
             }
@@ -2148,6 +2303,10 @@ export function createScreen(options: ScreenOptions = {}): Screen {
         return syncOutput
       case "sgrMouse":
         return sgrMouse
+      case "pixelMouse":
+        return mouseTrackingMode === 1016
+      case "leftRightMargin":
+        return false // Not implemented yet
       case "kittyKeyboard":
         return kittyKeyboardFlags > 0
       case "kittyGraphics":
@@ -2182,6 +2341,9 @@ export function createScreen(options: ScreenOptions = {}): Screen {
     getCursorBlinking: () => cursorBlinking,
     getTitle: () => title,
     getMode,
+    getClipboard: () => clipboard,
+    getCwd: () => cwd,
+    getNotifications: () => [...notifications],
     getScrollbackLength: () => scrollback.length,
     getViewportOffset: () => viewportOffset,
     scrollViewport: (delta: number) => {