vterm.js 0.3.0 → 0.3.1

package/README.md

@@ -152,26 +152,29 @@ interface ScreenCell {
 
 ## vs vt100.js
 
-| Feature                                      | vt100.js | vterm.js |
-| -------------------------------------------- | -------- | -------- |
-| SGR basics (bold, italic, underline, colors) | Yes      | Yes      |
-| Underline styles (curly, dotted, dashed)     | Yes      | Yes      |
-| Underline color                              | No       | Yes      |
-| Blink, overline                              | No       | Yes      |
-| Cursor shapes (DECSCUSR)                     | No       | Yes      |
-| OSC 8 hyperlinks                             | No       | Yes      |
-| DA1/DA2/DA3 responses                        | No       | Yes      |
-| DSR/DECRPM responses                         | No       | Yes      |
-| Mouse tracking                               | No       | Yes      |
-| Focus tracking                               | No       | Yes      |
-| Synchronized output                          | No       | Yes      |
-| DEC Special Graphics                         | No       | Yes      |
-| REP (repeat character)                       | No       | Yes      |
-| DECSTR (soft reset)                          | No       | Yes      |
-| DCS sequences                                | No       | Yes      |
-| Package size                                 | Smaller  | Larger   |
-
-**Use vt100.js** when you want fast and simple — it covers ~90% of real-world terminal usage.
+| Feature                                   | vt100.js | vterm.js |
+| ----------------------------------------- | -------- | -------- |
+| Bold, underline (boolean), blink, inverse | Yes      | Yes      |
+| Colors (8/256/truecolor)                  | No       | Yes      |
+| Italic, faint, strikethrough, overline    | No       | Yes      |
+| Underline styles (curly, dotted, dashed)  | No       | Yes      |
+| Underline color                           | No       | Yes      |
+| Wide characters (CJK, emoji)              | No       | Yes      |
+| Cursor shapes (DECSCUSR)                  | No       | Yes      |
+| Insert/delete characters and lines        | No       | Yes      |
+| OSC 8 hyperlinks                          | No       | Yes      |
+| DA1/DA2/DA3 responses                     | DA1 only | Yes      |
+| DSR/DECRPM responses                      | No       | Yes      |
+| Mouse tracking                            | No       | Yes      |
+| Focus tracking                            | No       | Yes      |
+| Synchronized output                       | No       | Yes      |
+| DEC Special Graphics                      | Yes      | Yes      |
+| REP (repeat character)                    | No       | Yes      |
+| DECSTR (soft reset)                       | No       | Yes      |
+| DCS sequences                             | No       | Yes      |
+| Package size                              | Smaller  | Larger   |
+
+**Use vt100.js** for strict VT100 conformance — monochrome, no colors, no insert/delete. Fast and minimal.
 
 **Use vterm.js** when you need everything — 100% coverage of the [terminfo.dev](https://terminfo.dev) feature matrix.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vterm.js",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Modern terminal emulator — full VT/ECMA-48/xterm standards coverage. Pure TypeScript, zero dependencies.",
   "keywords": [
     "ansi",
@@ -17,7 +17,7 @@
   "homepage": "https://github.com/beorn/vterm/tree/main/packages/vterm",
   "bugs": "https://github.com/beorn/vterm/issues",
   "license": "MIT",
-  "author": "Beorn",
+  "author": "Bjørn Stabell",
   "repository": {
     "type": "git",
     "url": "https://github.com/beorn/vterm.git",

package/src/screen.ts

@@ -399,6 +399,20 @@ export function createScreen(options: ScreenOptions = {}): Screen {
   let scrollTop = 0
   let scrollBottom = rows - 1
 
+  // Left/right margin mode (DECLRMM, DECSET ?69)
+  let leftRightMarginMode = false
+  let leftMargin = 0
+  let rightMargin = cols - 1
+
+  // Color scheme reporting (mode 2031)
+  let colorSchemeReporting = false
+
+  // Text scale (OSC 66)
+  let textScale = 1
+
+  // Advanced clipboard (OSC 5522 — Kitty clipboard protocol)
+  let advancedClipboard = ""
+
   // Viewport scroll offset
   let viewportOffset = 0
 
@@ -506,28 +520,65 @@ export function createScreen(options: ScreenOptions = {}): Screen {
   // ── Scrolling ──
 
   function scrollUp(top: number, bottom: number): void {
-    // Move top row to scrollback (only if main screen & top of screen)
-    if (grid === mainGrid && top === 0) {
-      scrollback.push(grid[0]!)
-      if (scrollback.length > scrollbackLimit * 2) {
-        scrollback.splice(0, scrollback.length - scrollbackLimit)
+    if (leftRightMarginMode && (leftMargin > 0 || rightMargin < cols - 1)) {
+      // Scroll only within the left/right margin columns
+      const lm = leftMargin
+      const rm = rightMargin
+      for (let r = top; r < bottom; r++) {
+        const srcRow = grid[r + 1]!
+        const dstRow = grid[r]!
+        for (let c = lm; c <= rm && c < cols; c++) {
+          dstRow[c] = srcRow[c]!
+        }
       }
+      // Clear the bottom row within margins
+      const bottomRow = grid[bottom]!
+      for (let c = lm; c <= rm && c < cols; c++) {
+        bottomRow[c] = EMPTY_CELL
+      }
+    } else {
+      // Full-width scroll
+      // Move top row to scrollback (only if main screen & top of screen)
+      if (grid === mainGrid && top === 0) {
+        scrollback.push(grid[0]!)
+        if (scrollback.length > scrollbackLimit * 2) {
+          scrollback.splice(0, scrollback.length - scrollbackLimit)
+        }
+      }
+      for (let i = top; i < bottom; i++) {
+        grid[i] = grid[i + 1]!
+        softWrapped[i] = softWrapped[i + 1]!
+      }
+      grid[bottom] = makeRow(cols)
+      softWrapped[bottom] = false
     }
-    for (let i = top; i < bottom; i++) {
-      grid[i] = grid[i + 1]!
-      softWrapped[i] = softWrapped[i + 1]!
-    }
-    grid[bottom] = makeRow(cols)
-    softWrapped[bottom] = false
   }
 
   function scrollDown(top: number, bottom: number): void {
-    for (let i = bottom; i > top; i--) {
-      grid[i] = grid[i - 1]!
-      softWrapped[i] = softWrapped[i - 1]!
+    if (leftRightMarginMode && (leftMargin > 0 || rightMargin < cols - 1)) {
+      // Scroll only within the left/right margin columns
+      const lm = leftMargin
+      const rm = rightMargin
+      for (let r = bottom; r > top; r--) {
+        const srcRow = grid[r - 1]!
+        const dstRow = grid[r]!
+        for (let c = lm; c <= rm && c < cols; c++) {
+          dstRow[c] = srcRow[c]!
+        }
+      }
+      // Clear the top row within margins
+      const topRow = grid[top]!
+      for (let c = lm; c <= rm && c < cols; c++) {
+        topRow[c] = EMPTY_CELL
+      }
+    } else {
+      for (let i = bottom; i > top; i--) {
+        grid[i] = grid[i - 1]!
+        softWrapped[i] = softWrapped[i - 1]!
+      }
+      grid[top] = makeRow(cols)
+      softWrapped[top] = false
     }
-    grid[top] = makeRow(cols)
-    softWrapped[top] = false
   }
 
   // ── Character writing ──
@@ -670,30 +721,37 @@ export function createScreen(options: ScreenOptions = {}): Screen {
   }
 
   function writeCharCore(ch: string, wide: boolean): void {
+    // Guard: cannot write to a zero-dimension grid
+    if (cols <= 0 || rows <= 0) return
+
     const charWidth = wide ? 2 : 1
+    const wrapBoundary = leftRightMarginMode ? rightMargin + 1 : cols
+    const wrapReturn = leftRightMarginMode ? leftMargin : 0
 
-    // Handle autowrap at end of line
-    if (curX + charWidth > cols) {
+    // Handle autowrap at end of line (or right margin)
+    if (curX + charWidth > wrapBoundary) {
       if (autoWrap) {
         // Mark this row as soft-wrapped (auto-wrap caused the line break)
         softWrapped[curY] = true
-        curX = 0
+        curX = wrapReturn
         curY++
         if (curY > scrollBottom) {
           curY = scrollBottom
           scrollUp(scrollTop, scrollBottom)
         }
       } else {
-        curX = cols - charWidth
+        curX = wrapBoundary - charWidth
       }
     }
 
     // Insert mode: shift existing characters right before writing
     if (insertMode) {
       const row = grid[curY]!
+      const insertEnd = leftRightMarginMode ? rightMargin + 1 : cols
       for (let i = 0; i < charWidth; i++) {
+        // Shift cells right within margin, dropping the cell at the right edge
+        row.splice(insertEnd - 1, 1)
         row.splice(curX, 0, EMPTY_CELL)
-        row.pop()
       }
     }
 
@@ -919,9 +977,26 @@ export function createScreen(options: ScreenOptions = {}): Screen {
           if (code === 4) insertMode = false
         }
         break
-      case "s": // SCP - Save Cursor Position
-        savedCurX = curX
-        savedCurY = curY
+      case "s": // SCP - Save Cursor Position / DECSLRM when left/right margin mode active
+        if (leftRightMarginMode && intermediates === "") {
+          // DECSLRM - Set Left and Right Margins (1-based params)
+          const pl = parts[0] ?? 0
+          const pr = parts[1] ?? 0
+          leftMargin = pl > 0 ? pl - 1 : 0
+          rightMargin = pr > 0 ? pr - 1 : cols - 1
+          if (leftMargin >= rightMargin) {
+            leftMargin = 0
+            rightMargin = cols - 1
+          }
+          if (leftMargin >= cols) leftMargin = 0
+          if (rightMargin >= cols) rightMargin = cols - 1
+          // Move cursor to home (top-left of margin area if origin mode, else absolute home)
+          curX = originMode ? leftMargin : 0
+          curY = originMode ? scrollTop : 0
+        } else {
+          savedCurX = curX
+          savedCurY = curY
+        }
         break
       case "u": // RCP - Restore Cursor Position
         curX = savedCurX
@@ -1032,6 +1107,12 @@ export function createScreen(options: ScreenOptions = {}): Screen {
           case 2026:
             value = syncOutput ? 1 : 2
             break
+          case 69:
+            value = leftRightMarginMode ? 1 : 2
+            break
+          case 2031:
+            value = colorSchemeReporting ? 1 : 2
+            break
           case 5:
             value = reverseVideo ? 1 : 2
             break
@@ -1044,6 +1125,21 @@ export function createScreen(options: ScreenOptions = {}): Screen {
       return
     }
 
+    // Private DSR: CSI ? Ps n
+    if (finalByte === "n") {
+      if (onResponse) {
+        const ps = parts[0] ?? 0
+        if (ps === 6) {
+          // DECXCPR — Extended Cursor Position Report
+          onResponse(`\x1b[?${curY + 1};${curX + 1}n`)
+        } else if (ps === 997) {
+          // Color scheme report: 1 = dark, 2 = light
+          onResponse("\x1b[?997;1n")
+        }
+      }
+      return
+    }
+
     // DECSED / DECSEL — selective erase (CSI ? J / CSI ? K)
     // We treat selective erase same as normal erase (no DECSCA protection tracking)
     if (finalByte === "J") {
@@ -1092,29 +1188,14 @@ 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 9: // X10 mouse
         case 1000: // Mouse tracking (basic)
-          mouseTracking = set
-          mouseTrackingMode = set ? 1000 : 0
-          break
         case 1002: // Mouse tracking (button events)
-          mouseTracking = set
-          mouseTrackingMode = set ? 1002 : 0
-          break
         case 1003: // Mouse tracking (all events)
-          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
+          mouseTrackingMode = set ? code : 0
           break
         case 1004: // Focus tracking
           focusTracking = set
@@ -1142,12 +1223,23 @@ export function createScreen(options: ScreenOptions = {}): Screen {
             clampCursor()
           }
           break
+        case 69: // DECLRMM - Left/Right Margin Mode
+          leftRightMarginMode = set
+          if (!set) {
+            // Reset margins when mode is disabled
+            leftMargin = 0
+            rightMargin = cols - 1
+          }
+          break
         case 2004: // Bracketed paste
           bracketedPaste = set
           break
         case 2026: // Synchronized output
           syncOutput = set
           break
+        case 2031: // Color scheme reporting
+          colorSchemeReporting = set
+          break
       }
     }
   }
@@ -1181,15 +1273,17 @@ export function createScreen(options: ScreenOptions = {}): Screen {
   }
 
   function handleEraseLine(mode: number): void {
+    const eraseRight = leftRightMarginMode ? rightMargin : cols - 1
+    const eraseLeft = leftRightMarginMode ? leftMargin : 0
     switch (mode) {
-      case 0: // Erase from cursor to end of line
-        eraseCells(curY, curX, curY, cols - 1)
+      case 0: // Erase from cursor to end of line (or right margin)
+        eraseCells(curY, curX, curY, eraseRight)
         break
-      case 1: // Erase from start to cursor
-        eraseCells(curY, 0, curY, curX)
+      case 1: // Erase from start (or left margin) to cursor
+        eraseCells(curY, eraseLeft, curY, curX)
         break
-      case 2: // Erase entire line
-        eraseCells(curY, 0, curY, cols - 1)
+      case 2: // Erase entire line (within margins if active)
+        eraseCells(curY, eraseLeft, curY, eraseRight)
         break
     }
   }
@@ -1224,10 +1318,20 @@ export function createScreen(options: ScreenOptions = {}): Screen {
   function handleDeleteChars(count: number): void {
     const row = grid[curY]
     if (!row) return
-    for (let i = 0; i < count; i++) {
-      if (curX < cols) {
-        row.splice(curX, 1)
-        row.push(emptyCell())
+    if (leftRightMarginMode && (leftMargin > 0 || rightMargin < cols - 1)) {
+      // Delete within margin bounds: shift left, insert blanks at right margin
+      for (let i = 0; i < count; i++) {
+        if (curX <= rightMargin) {
+          row.splice(curX, 1)
+          row.splice(rightMargin, 0, emptyCell())
+        }
+      }
+    } else {
+      for (let i = 0; i < count; i++) {
+        if (curX < cols) {
+          row.splice(curX, 1)
+          row.push(emptyCell())
+        }
       }
     }
   }
@@ -1235,9 +1339,17 @@ export function createScreen(options: ScreenOptions = {}): Screen {
   function handleInsertChars(count: number): void {
     const row = grid[curY]
     if (!row) return
-    for (let i = 0; i < count; i++) {
-      row.splice(curX, 0, emptyCell())
-      row.pop()
+    if (leftRightMarginMode && (leftMargin > 0 || rightMargin < cols - 1)) {
+      // Insert within margin bounds: shift right, drop chars at right margin
+      for (let i = 0; i < count; i++) {
+        row.splice(rightMargin, 1)
+        row.splice(curX, 0, emptyCell())
+      }
+    } else {
+      for (let i = 0; i < count; i++) {
+        row.splice(curX, 0, emptyCell())
+        row.pop()
+      }
     }
   }
 
@@ -1622,6 +1734,42 @@ export function createScreen(options: ScreenOptions = {}): Screen {
         }
         break
       }
+      case 66: {
+        // OSC 66 — Text Sizing
+        if (value === "?" && onResponse) {
+          // Query: respond with current text scale
+          onResponse(`\x1b]66;s=${textScale}\x1b\\`)
+        } else {
+          // Parse key=value pairs (e.g., "s=2")
+          const kvPairs = value.split(";")
+          for (const pair of kvPairs) {
+            const [k, v] = pair.split("=")
+            if (k === "s" && v !== undefined) {
+              const n = parseInt(v, 10)
+              if (!isNaN(n) && n > 0) {
+                textScale = n
+              }
+            }
+          }
+        }
+        break
+      }
+      case 5522: {
+        // OSC 5522 — Advanced Clipboard (Kitty clipboard protocol)
+        if (value === "?" && onResponse) {
+          // Query: respond with stored clipboard data
+          const encoded = btoa(advancedClipboard)
+          onResponse(`\x1b]5522;${encoded}\x1b\\`)
+        } else {
+          // Store clipboard data (base64-encoded)
+          try {
+            advancedClipboard = atob(value)
+          } catch {
+            advancedClipboard = ""
+          }
+        }
+        break
+      }
       case 1337: {
         // iTerm2 proprietary sequences
         if (value === "ReportCellSize" && onResponse) {
@@ -1730,6 +1878,11 @@ export function createScreen(options: ScreenOptions = {}): Screen {
     scrollTop = 0
     scrollBottom = rows - 1
 
+    // Reset left/right margins
+    leftRightMarginMode = false
+    leftMargin = 0
+    rightMargin = cols - 1
+
     // Reset attributes
     attrs = resetAttrs()
 
@@ -1778,6 +1931,12 @@ export function createScreen(options: ScreenOptions = {}): Screen {
     sixelImages = []
     scrollTop = 0
     scrollBottom = rows - 1
+    leftRightMarginMode = false
+    leftMargin = 0
+    rightMargin = cols - 1
+    colorSchemeReporting = false
+    textScale = 1
+    advancedClipboard = ""
     viewportOffset = 0
     charsetG0 = false
     clipboard = ""
@@ -2209,6 +2368,8 @@ export function createScreen(options: ScreenOptions = {}): Screen {
     rows = newRows
     scrollTop = 0
     scrollBottom = rows - 1
+    leftMargin = 0
+    rightMargin = cols - 1
     clampCursor()
   }
 
@@ -2306,7 +2467,9 @@ export function createScreen(options: ScreenOptions = {}): Screen {
       case "pixelMouse":
         return mouseTrackingMode === 1016
       case "leftRightMargin":
-        return false // Not implemented yet
+        return leftRightMarginMode
+      case "colorSchemeReporting":
+        return colorSchemeReporting
       case "kittyKeyboard":
         return kittyKeyboardFlags > 0
       case "kittyGraphics":
@@ -2319,7 +2482,7 @@ export function createScreen(options: ScreenOptions = {}): Screen {
   }
 
   // Suppress unused variable warnings
-  void [mouseTrackingMode]
+  void [mouseTrackingMode, textScale, advancedClipboard]
 
   return {
     get cols() {