@xterm/xterm 6.1.0-beta.26 → 6.1.0-beta.261

package/src/common/buffer/CellData.ts

@@ -3,10 +3,11 @@
  * @license MIT
  */
 
-import { CharData, ICellData, IExtendedAttrs } from 'common/Types';
-import { stringFromCodePoint } from 'common/input/TextDecoder';
-import { CHAR_DATA_CHAR_INDEX, CHAR_DATA_WIDTH_INDEX, CHAR_DATA_ATTR_INDEX, Content } from 'common/buffer/Constants';
-import { AttributeData, ExtendedAttrs } from 'common/buffer/AttributeData';
+import { CharData, ICellData, IExtendedAttrs } from './Types';
+import { stringFromCodePoint } from '../input/TextDecoder';
+import { CHAR_DATA_CHAR_INDEX, CHAR_DATA_WIDTH_INDEX, CHAR_DATA_ATTR_INDEX, Content } from './Constants';
+import { AttributeData, ExtendedAttrs } from './AttributeData';
+import type { IBufferCell as IBufferCellApi } from '@xterm/xterm';
 
 /**
  * CellData - represents a single Cell in the terminal buffer.
@@ -91,4 +92,60 @@ export class CellData extends AttributeData implements ICellData {
   public getAsCharData(): CharData {
     return [this.fg, this.getChars(), this.getWidth(), this.getCode()];
   }
+
+  public attributesEquals(other: IBufferCellApi): boolean {
+    if (this.getFgColorMode() !== other.getFgColorMode() || this.getFgColor() !== other.getFgColor()) {
+      return false;
+    }
+    if (this.getBgColorMode() !== other.getBgColorMode() || this.getBgColor() !== other.getBgColor()) {
+      return false;
+    }
+    if (this.isInverse() !== other.isInverse()) {
+      return false;
+    }
+    if (this.isBold() !== other.isBold()) {
+      return false;
+    }
+    if (this.isUnderline() !== other.isUnderline()) {
+      return false;
+    }
+    if (this.isUnderline()) {
+      if (this.getUnderlineStyle() !== other.getUnderlineStyle()) {
+        return false;
+      }
+      const thisDefault = this.isUnderlineColorDefault();
+      const otherDefault = other.isUnderlineColorDefault();
+      if (!(thisDefault && otherDefault)) {
+        if (thisDefault !== otherDefault) {
+          return false;
+        }
+        if (this.getUnderlineColor() !== other.getUnderlineColor()) {
+          return false;
+        }
+        if (this.getUnderlineColorMode() !== other.getUnderlineColorMode()) {
+          return false;
+        }
+      }
+    }
+    if (this.isOverline() !== other.isOverline()) {
+      return false;
+    }
+    if (this.isBlink() !== other.isBlink()) {
+      return false;
+    }
+    if (this.isInvisible() !== other.isInvisible()) {
+      return false;
+    }
+    if (this.isItalic() !== other.isItalic()) {
+      return false;
+    }
+    if (this.isDim() !== other.isDim()) {
+      return false;
+    }
+    if (this.isStrikethrough() !== other.isStrikethrough()) {
+      return false;
+    }
+    return true;
+  }
+
 }

package/src/common/buffer/Marker.ts

@@ -3,9 +3,9 @@
  * @license MIT
  */
 
-import { IDisposable, IMarker } from 'common/Types';
-import { Emitter } from 'vs/base/common/event';
-import { dispose } from 'vs/base/common/lifecycle';
+import { dispose, IDisposable } from '../Lifecycle';
+import { IMarker } from './Types';
+import { Emitter } from '../Event';
 
 export class Marker implements IMarker {
   private static _nextId = 1;

package/src/common/buffer/Types.ts

@@ -3,12 +3,158 @@
  * @license MIT
  */
 
-import { IAttributeData, ICircularList, IBufferLine, ICellData, IMarker, ICharset, IDisposable } from 'common/Types';
-import type { Event } from 'vs/base/common/event';
+import type { IEvent } from '../Event';
+import type { ICircularList } from '../CircularList';
+import type { ICharset } from '../Types';
+import type { IDisposable } from '../Lifecycle';
+import type { UnderlineStyle } from './Constants';
 
 // BufferIndex denotes a position in the buffer: [rowIndex, colIndex]
 export type BufferIndex = [number, number];
 
+export type CharData = [attr: number, char: string, width: number, code: number];
+
+export interface IExtendedAttrs {
+  ext: number;
+  underlineStyle: UnderlineStyle;
+  underlineColor: number;
+  underlineVariantOffset: number;
+  urlId: number;
+  clone(): IExtendedAttrs;
+  isEmpty(): boolean;
+}
+
+/**
+ * An object that represents all attributes of a cell.
+ */
+export interface IAttributeData {
+  /**
+   * "fg" is a 32-bit unsigned integer that stores the foreground color of the cell in the 24 least
+   * significant bits and additional flags in the remaining 8 bits.
+   */
+  fg: number;
+  /**
+   * "bg" is a 32-bit unsigned integer that stores the background color of the cell in the 24 least
+   * significant bits and additional flags in the remaining 8 bits.
+   */
+  bg: number;
+  /**
+   * "extended", aka "ext", stores extended attributes beyond those available in fg and bg. This
+   * data is optional on a cell and encodes less common data.
+   */
+  extended: IExtendedAttrs;
+
+  clone(): IAttributeData;
+
+  // flags
+  isInverse(): number;
+  isBold(): number;
+  isUnderline(): number;
+  isBlink(): number;
+  isInvisible(): number;
+  isItalic(): number;
+  isDim(): number;
+  isStrikethrough(): number;
+  isProtected(): number;
+  isOverline(): number;
+
+  /**
+   * The color mode of the foreground color which determines how to decode {@link getFgColor},
+   * possible values include {@link Attributes.CM_DEFAULT}, {@link Attributes.CM_P16},
+   * {@link Attributes.CM_P256} and {@link Attributes.CM_RGB}.
+   */
+  getFgColorMode(): number;
+  /**
+   * The color mode of the background color which determines how to decode {@link getBgColor},
+   * possible values include {@link Attributes.CM_DEFAULT}, {@link Attributes.CM_P16},
+   * {@link Attributes.CM_P256} and {@link Attributes.CM_RGB}.
+   */
+  getBgColorMode(): number;
+  isFgRGB(): boolean;
+  isBgRGB(): boolean;
+  isFgPalette(): boolean;
+  isBgPalette(): boolean;
+  isFgDefault(): boolean;
+  isBgDefault(): boolean;
+  isAttributeDefault(): boolean;
+
+  /**
+   * Gets an integer representation of the foreground color, how to decode the color depends on the
+   * color mode {@link getFgColorMode}.
+   */
+  getFgColor(): number;
+  /**
+   * Gets an integer representation of the background color, how to decode the color depends on the
+   * color mode {@link getBgColorMode}.
+   */
+  getBgColor(): number;
+
+  // extended attrs
+  hasExtendedAttrs(): number;
+  updateExtended(): void;
+  getUnderlineColor(): number;
+  getUnderlineColorMode(): number;
+  isUnderlineColorRGB(): boolean;
+  isUnderlineColorPalette(): boolean;
+  isUnderlineColorDefault(): boolean;
+  getUnderlineStyle(): number;
+  getUnderlineVariantOffset(): number;
+}
+
+/** Cell data */
+export interface ICellData extends IAttributeData {
+  content: number;
+  combinedData: string;
+  isCombined(): number;
+  getWidth(): number;
+  getChars(): string;
+  getCode(): number;
+  setFromCharData(value: CharData): void;
+  getAsCharData(): CharData;
+}
+
+/**
+ * Interface for a line in the terminal buffer.
+ */
+export interface IBufferLine {
+  length: number;
+  isWrapped: boolean;
+  get(index: number): CharData;
+  set(index: number, value: CharData): void;
+  loadCell(index: number, cell: ICellData): ICellData;
+  setCell(index: number, cell: ICellData): void;
+  setCellFromCodepoint(index: number, codePoint: number, width: number, attrs: IAttributeData): void;
+  addCodepointToCell(index: number, codePoint: number, width: number): void;
+  insertCells(pos: number, n: number, ch: ICellData): void;
+  deleteCells(pos: number, n: number, fill: ICellData): void;
+  replaceCells(start: number, end: number, fill: ICellData, respectProtect?: boolean): void;
+  resize(cols: number, fill: ICellData): boolean;
+  cleanupMemory(): number;
+  fill(fillCellData: ICellData, respectProtect?: boolean): void;
+  copyFrom(line: IBufferLine): void;
+  clone(): IBufferLine;
+  getTrimmedLength(): number;
+  getNoBgTrimmedLength(): number;
+  translateToString(trimRight?: boolean, startCol?: number, endCol?: number, outColumns?: number[]): string;
+
+  /* direct access to cell attrs */
+  getWidth(index: number): number;
+  hasWidth(index: number): number;
+  getFg(index: number): number;
+  getBg(index: number): number;
+  hasContent(index: number): number;
+  getCodePoint(index: number): number;
+  isCombined(index: number): number;
+  getString(index: number): string;
+}
+
+export interface IMarker extends IDisposable {
+  readonly id: number;
+  readonly isDisposed: boolean;
+  readonly line: number;
+  onDispose: IEvent<void>;
+}
+
 export interface IBuffer {
   readonly lines: ICircularList<IBufferLine>;
   ydisp: number;
@@ -22,6 +168,10 @@ export interface IBuffer {
   savedY: number;
   savedX: number;
   savedCharset: ICharset | undefined;
+  savedCharsets: (ICharset | undefined)[];
+  savedGlevel: number;
+  savedOriginMode: boolean;
+  savedWraparoundMode: boolean;
   savedCurAttrData: IAttributeData;
   isCursorInViewport: boolean;
   markers: IMarker[];
@@ -42,7 +192,7 @@ export interface IBufferSet extends IDisposable {
   normal: IBuffer;
   active: IBuffer;
 
-  onBufferActivate: Event<{ activeBuffer: IBuffer, inactiveBuffer: IBuffer }>;
+  onBufferActivate: IEvent<{ activeBuffer: IBuffer, inactiveBuffer: IBuffer }>;
 
   activateNormalBuffer(): void;
   activateAltBuffer(fillAttr?: IAttributeData): void;

package/src/common/data/Charsets.ts

@@ -3,7 +3,7 @@
  * @license MIT
  */
 
-import { ICharset } from 'common/Types';
+import { ICharset } from '../Types';
 
 /**
  * The character sets supported by the terminal. These enable several languages
@@ -98,8 +98,7 @@ CHARSETS['4'] = {
  * ESC (C or ESC (5
  * Reference: http://vt100.net/docs/vt220-rm/table2-7.html
  */
-CHARSETS['C'] =
-CHARSETS['5'] = {
+CHARSETS['C'] = CHARSETS['5'] = {
   '[': 'Ä',
   '\\': 'Ö',
   ']': 'Å',
@@ -185,8 +184,7 @@ CHARSETS['Y'] = {
  * ESC (E or ESC (6
  * Reference: http://vt100.net/docs/vt220-rm/table2-12.html
  */
-CHARSETS['E'] =
-CHARSETS['6'] = {
+CHARSETS['E'] = CHARSETS['6'] = {
   '@': 'Ä',
   '[': 'Æ',
   '\\': 'Ø',
@@ -220,8 +218,7 @@ CHARSETS['Z'] = {
  * ESC (H or ESC (7
  * Reference: http://vt100.net/docs/vt220-rm/table2-14.html
  */
-CHARSETS['H'] =
-CHARSETS['7'] = {
+CHARSETS['H'] = CHARSETS['7'] = {
   '@': 'É',
   '[': 'Ä',
   '\\': 'Ö',

package/src/common/data/EscapeSequences.ts

@@ -7,147 +7,148 @@
  * C0 control codes
  * See = https://en.wikipedia.org/wiki/C0_and_C1_control_codes
  */
-export namespace C0 {
+export const enum C0 {
   /** Null (Caret = ^@, C = \0) */
-  export const NUL = '\x00';
+  NUL = '\x00',
   /** Start of Heading (Caret = ^A) */
-  export const SOH = '\x01';
+  SOH = '\x01',
   /** Start of Text (Caret = ^B) */
-  export const STX = '\x02';
+  STX = '\x02',
   /** End of Text (Caret = ^C) */
-  export const ETX = '\x03';
+  ETX = '\x03',
   /** End of Transmission (Caret = ^D) */
-  export const EOT = '\x04';
+  EOT = '\x04',
   /** Enquiry (Caret = ^E) */
-  export const ENQ = '\x05';
+  ENQ = '\x05',
   /** Acknowledge (Caret = ^F) */
-  export const ACK = '\x06';
+  ACK = '\x06',
   /** Bell (Caret = ^G, C = \a) */
-  export const BEL = '\x07';
+  BEL = '\x07',
   /** Backspace (Caret = ^H, C = \b) */
-  export const BS  = '\x08';
+  BS = '\x08',
   /** Character Tabulation, Horizontal Tabulation (Caret = ^I, C = \t) */
-  export const HT  = '\x09';
+  HT = '\x09',
   /** Line Feed (Caret = ^J, C = \n) */
-  export const LF  = '\x0a';
+  LF = '\x0a',
   /** Line Tabulation, Vertical Tabulation (Caret = ^K, C = \v) */
-  export const VT  = '\x0b';
+  VT = '\x0b',
   /** Form Feed (Caret = ^L, C = \f) */
-  export const FF  = '\x0c';
+  FF = '\x0c',
   /** Carriage Return (Caret = ^M, C = \r) */
-  export const CR  = '\x0d';
+  CR = '\x0d',
   /** Shift Out (Caret = ^N) */
-  export const SO  = '\x0e';
+  SO = '\x0e',
   /** Shift In (Caret = ^O) */
-  export const SI  = '\x0f';
+  SI = '\x0f',
   /** Data Link Escape (Caret = ^P) */
-  export const DLE = '\x10';
+  DLE = '\x10',
   /** Device Control One (XON) (Caret = ^Q) */
-  export const DC1 = '\x11';
+  DC1 = '\x11',
   /** Device Control Two (Caret = ^R) */
-  export const DC2 = '\x12';
+  DC2 = '\x12',
   /** Device Control Three (XOFF) (Caret = ^S) */
-  export const DC3 = '\x13';
+  DC3 = '\x13',
   /** Device Control Four (Caret = ^T) */
-  export const DC4 = '\x14';
+  DC4 = '\x14',
   /** Negative Acknowledge (Caret = ^U) */
-  export const NAK = '\x15';
+  NAK = '\x15',
   /** Synchronous Idle (Caret = ^V) */
-  export const SYN = '\x16';
+  SYN = '\x16',
   /** End of Transmission Block (Caret = ^W) */
-  export const ETB = '\x17';
+  ETB = '\x17',
   /** Cancel (Caret = ^X) */
-  export const CAN = '\x18';
+  CAN = '\x18',
   /** End of Medium (Caret = ^Y) */
-  export const EM  = '\x19';
+  EM = '\x19',
   /** Substitute (Caret = ^Z) */
-  export const SUB = '\x1a';
+  SUB = '\x1a',
   /** Escape (Caret = ^[, C = \e) */
-  export const ESC = '\x1b';
+  ESC = '\x1b',
   /** File Separator (Caret = ^\) */
-  export const FS  = '\x1c';
+  FS = '\x1c',
   /** Group Separator (Caret = ^]) */
-  export const GS  = '\x1d';
+  GS = '\x1d',
   /** Record Separator (Caret = ^^) */
-  export const RS  = '\x1e';
+  RS = '\x1e',
   /** Unit Separator (Caret = ^_) */
-  export const US  = '\x1f';
+  US = '\x1f',
   /** Space */
-  export const SP  = '\x20';
+  SP = '\x20',
   /** Delete (Caret = ^?) */
-  export const DEL = '\x7f';
+  DEL = '\x7f'
 }
 
 /**
  * C1 control codes
  * See = https://en.wikipedia.org/wiki/C0_and_C1_control_codes
  */
-export namespace C1 {
+export const enum C1 {
   /** padding character */
-  export const PAD = '\x80';
+  PAD = '\x80',
   /** High Octet Preset */
-  export const HOP = '\x81';
+  HOP = '\x81',
   /** Break Permitted Here */
-  export const BPH = '\x82';
+  BPH = '\x82',
   /** No Break Here */
-  export const NBH = '\x83';
+  NBH = '\x83',
   /** Index */
-  export const IND = '\x84';
+  IND = '\x84',
   /** Next Line */
-  export const NEL = '\x85';
+  NEL = '\x85',
   /** Start of Selected Area */
-  export const SSA = '\x86';
+  SSA = '\x86',
   /** End of Selected Area */
-  export const ESA = '\x87';
+  ESA = '\x87',
   /** Horizontal Tabulation Set */
-  export const HTS = '\x88';
+  HTS = '\x88',
   /** Horizontal Tabulation With Justification */
-  export const HTJ = '\x89';
+  HTJ = '\x89',
   /** Vertical Tabulation Set */
-  export const VTS = '\x8a';
+  VTS = '\x8a',
   /** Partial Line Down */
-  export const PLD = '\x8b';
+  PLD = '\x8b',
   /** Partial Line Up */
-  export const PLU = '\x8c';
+  PLU = '\x8c',
   /** Reverse Index */
-  export const RI = '\x8d';
+  RI = '\x8d',
   /** Single-Shift 2 */
-  export const SS2 = '\x8e';
+  SS2 = '\x8e',
   /** Single-Shift 3 */
-  export const SS3 = '\x8f';
+  SS3 = '\x8f',
   /** Device Control String */
-  export const DCS = '\x90';
+  DCS = '\x90',
   /** Private Use 1 */
-  export const PU1 = '\x91';
+  PU1 = '\x91',
   /** Private Use 2 */
-  export const PU2 = '\x92';
+  PU2 = '\x92',
   /** Set Transmit State */
-  export const STS = '\x93';
+  STS = '\x93',
   /** Destructive backspace, intended to eliminate ambiguity about meaning of BS. */
-  export const CCH = '\x94';
+  CCH = '\x94',
   /** Message Waiting */
-  export const MW = '\x95';
+  MW = '\x95',
   /** Start of Protected Area */
-  export const SPA = '\x96';
+  SPA = '\x96',
   /** End of Protected Area */
-  export const EPA = '\x97';
+  EPA = '\x97',
   /** Start of String */
-  export const SOS = '\x98';
+  SOS = '\x98',
   /** Single Graphic Character Introducer */
-  export const SGCI = '\x99';
+  SGCI = '\x99',
   /** Single Character Introducer */
-  export const SCI = '\x9a';
+  SCI = '\x9a',
   /** Control Sequence Introducer */
-  export const CSI = '\x9b';
+  CSI = '\x9b',
   /** String Terminator */
-  export const ST = '\x9c';
+  ST = '\x9c',
   /** Operating System Command */
-  export const OSC = '\x9d';
+  OSC = '\x9d',
   /** Privacy Message */
-  export const PM = '\x9e';
+  PM = '\x9e',
   /** Application Program Command */
-  export const APC = '\x9f';
+  APC = '\x9f'
 }
-export namespace C1_ESCAPED {
-  export const ST = `${C0.ESC}\\`;
+
+export const enum C1ESCAPED {
+  ST = '\x1b\\'
 }

package/src/common/input/Keyboard.ts

@@ -4,8 +4,8 @@
  * @license MIT
  */
 
-import { IKeyboardEvent, IKeyboardResult, KeyboardResultType } from 'common/Types';
-import { C0 } from 'common/data/EscapeSequences';
+import { IKeyboardEvent, IKeyboardResult, KeyboardResultType } from '../Types';
+import { C0 } from '../data/EscapeSequences';
 
 // reg + shift key mappings for digits and special chars
 const KEYCODE_KEY_MAPPINGS: { [key: number]: [string, string]} = {
@@ -99,7 +99,13 @@ export function evaluateKeyboardEvent(
       break;
     case 13:
       // return/enter
-      result.key = ev.altKey ? C0.ESC + C0.CR : C0.CR;
+      if (ev.key === 'c' && ev.ctrlKey) {
+        // HACK: Safari on iPad, iOS, AppleVisionPro sends key 13 when typing ctrl-c on hardware
+        // keyboard
+        result.key = C0.ETX;
+      } else {
+        result.key = ev.altKey ? C0.ESC + C0.CR : C0.CR;
+      }
       result.cancel = true;
       break;
     case 27:
@@ -315,6 +321,8 @@ export function evaluateKeyboardEvent(
           result.key = String.fromCharCode(ev.keyCode - 51 + 27);
         } else if (ev.keyCode === 56) {
           result.key = C0.DEL;
+        } else if (ev.key === '/') {
+          result.key = C0.US; // https://github.com/xtermjs/xterm.js/issues/5457
         } else if (ev.keyCode === 219) {
           result.key = C0.ESC;
         } else if (ev.keyCode === 220) {
@@ -358,12 +366,11 @@ export function evaluateKeyboardEvent(
         // Include only keys that that result in a _single_ character; don't include num lock,
         // volume up, etc.
         result.key = ev.key;
-      } else if (ev.key && ev.ctrlKey) {
-        if (ev.key === '_') { // ^_
-          result.key = C0.US;
-        }
-        if (ev.key === '@') { // ^ + shift + 2 = ^ + @
-          result.key = C0.NUL;
+      } else if (ev.key && ev.ctrlKey && ev.shiftKey) {
+        switch (ev.code) {
+          case 'Minus':  result.key = C0.US;  break; // ^_ (Ctrl+Shift+-_
+          case 'Digit2': result.key = C0.NUL; break; // ^@ (Ctrl+Shift+2)
+          case 'Digit6': result.key = C0.RS;  break; // ^^ (Ctrl+Shift+6)
         }
       }
       break;