Merge pull request #2507 from jerch/remove_obsolete_mouseencodings

remove URXVT and UTF8 mouse encoding from codebase
xtermjs · Oct 25, 2019 · 1c72a66 · 1c72a66
2 parents 7487d61 + 6f8919a
commit 1c72a66
Show file tree

Hide file tree

Showing 4 changed files with 138 additions and 1,359 deletions.
diff --git a/src/InputHandler.ts b/src/InputHandler.ts
@@ -1434,16 +1434,14 @@ export class InputHandler extends Disposable implements IInputHandler {
  // focusout: ^[[O
  this._terminal.sendFocus = true;
  break;
- case 1005: // utf8 ext mode mouse
- // for wide terminals
- // simply encodes large values as utf8 characters
- this._coreMouseService.activeEncoding = 'UTF8';
+ case 1005: // utf8 ext mode mouse - removed in #2507
+ this._logService.debug('DECSET 1005 not supported (see #2507)');
  break;
  case 1006: // sgr ext mode mouse
  this._coreMouseService.activeEncoding = 'SGR';
  break;
- case 1015: // urxvt ext mode mouse
- this._coreMouseService.activeEncoding = 'URXVT';
+ case 1015: // urxvt ext mode mouse - removed in #2507
+ this._logService.debug('DECSET 1015 not supported (see #2507)');
  break;
  case 25: // show cursor
  this._terminal.cursorHidden = false;
@@ -1607,14 +1605,14 @@ export class InputHandler extends Disposable implements IInputHandler {
  case 1004: // send focusin/focusout events
  this._terminal.sendFocus = false;
  break;
- case 1005: // utf8 ext mode mouse
- this._coreMouseService.activeEncoding = 'DEFAULT';
+ case 1005: // utf8 ext mode mouse - removed in #2507
+ this._logService.debug('DECRST 1005 not supported (see #2507)');
  break;
  case 1006: // sgr ext mode mouse
  this._coreMouseService.activeEncoding = 'DEFAULT';
  break;
- case 1015: // urxvt ext mode mouse
- this._coreMouseService.activeEncoding = 'DEFAULT';
+ case 1015: // urxvt ext mode mouse - removed in #2507
+ this._logService.debug('DECRST 1015 not supported (see #2507)');
  break;
  case 25: // hide cursor
  this._terminal.cursorHidden = true;

diff --git a/src/common/services/CoreMouseService.test.ts b/src/common/services/CoreMouseService.test.ts
@@ -32,9 +32,9 @@ describe('CoreMouseService', () => {
  const cms = new CoreMouseService(bufferService, coreService);
  assert.deepEqual(Object.keys((cms as any)._protocols), ['NONE', 'X10', 'VT200', 'DRAG', 'ANY']);
  });
- it('default encodings - DEFAULT, UTF8, SGR, URXVT', () => {
+ it('default encodings - DEFAULT, SGR', () => {
  const cms = new CoreMouseService(bufferService, coreService);
- assert.deepEqual(Object.keys((cms as any)._encodings), ['DEFAULT', 'UTF8', 'SGR', 'URXVT']);
+ assert.deepEqual(Object.keys((cms as any)._encodings), ['DEFAULT', 'SGR']);
  });
  it('protocol/encoding setter, reset', () => {
  const cms = new CoreMouseService(bufferService, coreService);
@@ -151,14 +151,6 @@ describe('CoreMouseService', () => {
  }
  }
  });
- it('UTF8 encoding', () => {
- cms.activeProtocol = 'ANY';
- cms.activeEncoding = 'UTF8';
- for (let i = 0; i < bufferService.cols; ++i) {
- assert.equal(cms.triggerMouseEvent({ col: i, row: 0, button: CoreMouseButton.LEFT, action: CoreMouseAction.DOWN }), true);
- assert.deepEqual(toBytes(reports.pop()), [0x1b, 0x5b, 0x4d, 0x20, i + 33, 0x21]);
- }
- });
  it('SGR encoding', () => {
  cms.activeProtocol = 'ANY';
  cms.activeEncoding = 'SGR';
@@ -167,14 +159,6 @@ describe('CoreMouseService', () => {
  assert.deepEqual(reports.pop(), `\x1b[<0;${i + 1};1M`);
  }
  });
- it('URXVT', () => {
- cms.activeProtocol = 'ANY';
- cms.activeEncoding = 'URXVT';
- for (let i = 0; i < bufferService.cols; ++i) {
- assert.equal(cms.triggerMouseEvent({ col: i, row: 0, button: CoreMouseButton.LEFT, action: CoreMouseAction.DOWN }), true);
- assert.deepEqual(reports.pop(), `\x1b[32;${i + 1};1M`);
- }
- });
  });
  it('eventCodes with modifiers (DEFAULT encoding)', () => {
  // TODO: implement AUX button tests

diff --git a/src/common/services/CoreMouseService.ts b/src/common/services/CoreMouseService.ts
@@ -132,17 +132,6 @@ const DEFAULT_ENCODINGS: {[key: string]: CoreMouseEncoding} = {
  // FIXED: params = params.map(v => (v > 255) ? 0 : value);
  return `\x1b[M${S(params[0])}${S(params[1])}${S(params[2])}`;
  },
- /**
- * UTF8 - CSI M Pb Px Py
- * Same as DEFAULT, but with optional 2-byte UTF8
- * encoding for values > 223 (can encode up to 2015).
- */
- UTF8: (e: ICoreMouseEvent) => {
- let params = [eventCode(e, false) + 32, e.col + 32, e.row + 32];
- // limit to 2-byte UTF8
- params = params.map(v => (v > 2047) ? 0 : v);
- return `\x1b[M${S(params[0])}${S(params[1])}${S(params[2])}`;
- },
  /**
  * SGR - CSI < Pb ; Px ; Py M|m
  * No encoding limitation.
@@ -151,14 +140,6 @@ const DEFAULT_ENCODINGS: {[key: string]: CoreMouseEncoding} = {
  SGR: (e: ICoreMouseEvent) => {
  const final = (e.action === CoreMouseAction.UP && e.button !== CoreMouseButton.WHEEL) ? 'm' : 'M';
  return `\x1b[<${eventCode(e, true)};${e.col};${e.row}${final}`;
- },
- /**
- * URXVT - CSI Pb ; Px ; Py M
- * Same button encoding as default, decimal encoding for coords.
- * Ambiguity with other sequences, should not be used.
- */
- URXVT: (e: ICoreMouseEvent) => {
- return `\x1b[${eventCode(e, false) + 32};${e.col};${e.row}M`;
  }
 };
 
@@ -167,7 +148,7 @@ const DEFAULT_ENCODINGS: {[key: string]: CoreMouseEncoding} = {
  *
  * Provides mouse tracking reports with different protocols and encodings.
  * - protocols: NONE (default), X10, VT200, DRAG, ANY
- * - encodings: DEFAULT, SGR, UTF8, URXVT
+ * - encodings: DEFAULT, SGR (UTF8, URXVT removed in #2507)
  *
  * Custom protocols/encodings can be added by `addProtocol` / `addEncoding`.
  * To activate a protocol/encoding, set `activeProtocol` / `activeEncoding`.