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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. package/README.md +62 -38
  2. package/css/xterm.css +29 -22
  3. package/lib/xterm.js +1 -1
  4. package/lib/xterm.js.map +1 -1
  5. package/lib/xterm.mjs +8 -34
  6. package/lib/xterm.mjs.map +4 -4
  7. package/package.json +56 -48
  8. package/src/browser/AccessibilityManager.ts +18 -13
  9. package/src/browser/Clipboard.ts +8 -5
  10. package/src/browser/ColorContrastCache.ts +3 -3
  11. package/src/browser/CoreBrowserTerminal.ts +177 -346
  12. package/src/browser/Dom.ts +178 -0
  13. package/src/browser/Linkifier.ts +14 -14
  14. package/src/browser/OscLinkProvider.ts +86 -18
  15. package/src/browser/RenderDebouncer.ts +4 -4
  16. package/src/browser/TimeBasedDebouncer.ts +3 -3
  17. package/src/browser/Types.ts +16 -14
  18. package/src/browser/Viewport.ts +58 -23
  19. package/src/browser/decorations/BufferDecorationRenderer.ts +3 -3
  20. package/src/browser/decorations/ColorZoneStore.ts +1 -1
  21. package/src/browser/decorations/OverviewRulerRenderer.ts +36 -20
  22. package/src/browser/input/CompositionHelper.ts +47 -11
  23. package/src/browser/input/MoveToCell.ts +2 -2
  24. package/src/browser/public/Terminal.ts +33 -36
  25. package/src/browser/renderer/dom/DomRenderer.ts +251 -85
  26. package/src/browser/renderer/dom/DomRendererRowFactory.ts +34 -27
  27. package/src/browser/renderer/dom/WidthCache.ts +57 -55
  28. package/src/browser/renderer/shared/Constants.ts +7 -0
  29. package/src/browser/renderer/shared/RendererUtils.ts +1 -1
  30. package/src/browser/renderer/shared/SelectionRenderModel.ts +2 -2
  31. package/src/browser/renderer/shared/TextBlinkStateManager.ts +97 -0
  32. package/src/browser/renderer/shared/Types.ts +10 -4
  33. package/src/browser/scrollable/abstractScrollbar.ts +300 -0
  34. package/src/browser/scrollable/fastDomNode.ts +126 -0
  35. package/src/browser/scrollable/globalPointerMoveMonitor.ts +90 -0
  36. package/src/browser/scrollable/horizontalScrollbar.ts +85 -0
  37. package/src/browser/scrollable/mouseEvent.ts +292 -0
  38. package/src/browser/scrollable/scrollable.ts +486 -0
  39. package/src/browser/scrollable/scrollableElement.ts +581 -0
  40. package/src/browser/scrollable/scrollableElementOptions.ts +161 -0
  41. package/src/browser/scrollable/scrollbarArrow.ts +110 -0
  42. package/src/browser/scrollable/scrollbarState.ts +246 -0
  43. package/src/browser/scrollable/scrollbarVisibilityController.ts +113 -0
  44. package/src/browser/scrollable/touch.ts +485 -0
  45. package/src/browser/scrollable/verticalScrollbar.ts +143 -0
  46. package/src/browser/scrollable/widget.ts +23 -0
  47. package/src/browser/selection/SelectionModel.ts +1 -1
  48. package/src/browser/services/CharSizeService.ts +4 -4
  49. package/src/browser/services/CharacterJoinerService.ts +7 -7
  50. package/src/browser/services/CoreBrowserService.ts +7 -5
  51. package/src/browser/services/KeyboardService.ts +67 -0
  52. package/src/browser/services/LinkProviderService.ts +3 -3
  53. package/src/browser/services/MouseCoordsService.ts +47 -0
  54. package/src/browser/services/MouseService.ts +619 -23
  55. package/src/browser/services/RenderService.ts +33 -21
  56. package/src/browser/services/SelectionService.ts +72 -54
  57. package/src/browser/services/Services.ts +44 -21
  58. package/src/browser/services/ThemeService.ts +8 -8
  59. package/src/common/Async.ts +141 -0
  60. package/src/common/CircularList.ts +24 -3
  61. package/src/common/Color.ts +9 -1
  62. package/src/common/CoreTerminal.ts +61 -35
  63. package/src/common/Event.ts +118 -0
  64. package/src/common/InputHandler.ts +301 -102
  65. package/src/common/Lifecycle.ts +113 -0
  66. package/src/common/Platform.ts +13 -3
  67. package/src/common/SortedList.ts +8 -4
  68. package/src/common/StringBuilder.ts +67 -0
  69. package/src/common/TaskQueue.ts +16 -7
  70. package/src/common/Types.ts +67 -205
  71. package/src/common/Version.ts +9 -0
  72. package/src/common/WindowsMode.ts +2 -2
  73. package/src/common/buffer/AttributeData.ts +3 -2
  74. package/src/common/buffer/Buffer.ts +45 -30
  75. package/src/common/buffer/BufferLine.ts +145 -73
  76. package/src/common/buffer/BufferLineStringCache.ts +69 -0
  77. package/src/common/buffer/BufferReflow.ts +7 -4
  78. package/src/common/buffer/BufferSet.ts +13 -9
  79. package/src/common/buffer/CellData.ts +61 -4
  80. package/src/common/buffer/Marker.ts +3 -3
  81. package/src/common/buffer/Types.ts +153 -3
  82. package/src/common/data/Charsets.ts +4 -7
  83. package/src/common/data/EscapeSequences.ts +71 -70
  84. package/src/common/input/Keyboard.ts +16 -9
  85. package/src/common/input/KittyKeyboard.ts +526 -0
  86. package/src/common/input/TextDecoder.ts +1 -1
  87. package/src/common/input/UnicodeV6.ts +3 -2
  88. package/src/common/input/Win32InputMode.ts +297 -0
  89. package/src/common/input/WriteBuffer.ts +107 -38
  90. package/src/common/input/XParseColor.ts +2 -2
  91. package/src/common/parser/ApcParser.ts +196 -0
  92. package/src/common/parser/Constants.ts +14 -4
  93. package/src/common/parser/DcsParser.ts +15 -16
  94. package/src/common/parser/EscapeSequenceParser.ts +212 -70
  95. package/src/common/parser/OscParser.ts +14 -15
  96. package/src/common/parser/Params.ts +28 -9
  97. package/src/common/parser/Types.ts +38 -28
  98. package/src/common/public/BufferApiView.ts +3 -3
  99. package/src/common/public/BufferLineApiView.ts +4 -4
  100. package/src/common/public/BufferNamespaceApi.ts +5 -5
  101. package/src/common/public/ParserApi.ts +5 -2
  102. package/src/common/public/UnicodeApi.ts +1 -1
  103. package/src/common/services/BufferService.ts +17 -13
  104. package/src/common/services/CharsetService.ts +6 -2
  105. package/src/common/services/CoreService.ts +23 -10
  106. package/src/common/services/DecorationService.ts +260 -15
  107. package/src/common/services/InstantiationService.ts +2 -2
  108. package/src/common/services/LogService.ts +2 -32
  109. package/src/common/services/{CoreMouseService.ts → MouseStateService.ts} +22 -133
  110. package/src/common/services/OptionsService.ts +17 -7
  111. package/src/common/services/OscLinkService.ts +3 -2
  112. package/src/common/services/ServiceRegistry.ts +14 -8
  113. package/src/common/services/Services.ts +52 -48
  114. package/src/common/services/UnicodeService.ts +6 -11
  115. package/typings/xterm.d.ts +329 -34
  116. package/src/common/Clone.ts +0 -23
  117. package/src/common/TypedArrayUtils.ts +0 -17
  118. package/src/vs/base/browser/browser.ts +0 -141
  119. package/src/vs/base/browser/canIUse.ts +0 -49
  120. package/src/vs/base/browser/dom.ts +0 -2369
  121. package/src/vs/base/browser/fastDomNode.ts +0 -316
  122. package/src/vs/base/browser/globalPointerMoveMonitor.ts +0 -112
  123. package/src/vs/base/browser/iframe.ts +0 -135
  124. package/src/vs/base/browser/keyboardEvent.ts +0 -213
  125. package/src/vs/base/browser/mouseEvent.ts +0 -229
  126. package/src/vs/base/browser/touch.ts +0 -372
  127. package/src/vs/base/browser/ui/scrollbar/abstractScrollbar.ts +0 -303
  128. package/src/vs/base/browser/ui/scrollbar/horizontalScrollbar.ts +0 -114
  129. package/src/vs/base/browser/ui/scrollbar/scrollableElement.ts +0 -720
  130. package/src/vs/base/browser/ui/scrollbar/scrollableElementOptions.ts +0 -165
  131. package/src/vs/base/browser/ui/scrollbar/scrollbarArrow.ts +0 -114
  132. package/src/vs/base/browser/ui/scrollbar/scrollbarState.ts +0 -243
  133. package/src/vs/base/browser/ui/scrollbar/scrollbarVisibilityController.ts +0 -118
  134. package/src/vs/base/browser/ui/scrollbar/verticalScrollbar.ts +0 -116
  135. package/src/vs/base/browser/ui/widget.ts +0 -57
  136. package/src/vs/base/browser/window.ts +0 -14
  137. package/src/vs/base/common/arrays.ts +0 -887
  138. package/src/vs/base/common/arraysFind.ts +0 -202
  139. package/src/vs/base/common/assert.ts +0 -71
  140. package/src/vs/base/common/async.ts +0 -1992
  141. package/src/vs/base/common/cancellation.ts +0 -148
  142. package/src/vs/base/common/charCode.ts +0 -450
  143. package/src/vs/base/common/collections.ts +0 -140
  144. package/src/vs/base/common/decorators.ts +0 -130
  145. package/src/vs/base/common/equals.ts +0 -146
  146. package/src/vs/base/common/errors.ts +0 -303
  147. package/src/vs/base/common/event.ts +0 -1778
  148. package/src/vs/base/common/functional.ts +0 -32
  149. package/src/vs/base/common/hash.ts +0 -316
  150. package/src/vs/base/common/iterator.ts +0 -159
  151. package/src/vs/base/common/keyCodes.ts +0 -526
  152. package/src/vs/base/common/keybindings.ts +0 -284
  153. package/src/vs/base/common/lazy.ts +0 -47
  154. package/src/vs/base/common/lifecycle.ts +0 -801
  155. package/src/vs/base/common/linkedList.ts +0 -142
  156. package/src/vs/base/common/map.ts +0 -202
  157. package/src/vs/base/common/numbers.ts +0 -98
  158. package/src/vs/base/common/observable.ts +0 -76
  159. package/src/vs/base/common/observableInternal/api.ts +0 -31
  160. package/src/vs/base/common/observableInternal/autorun.ts +0 -281
  161. package/src/vs/base/common/observableInternal/base.ts +0 -489
  162. package/src/vs/base/common/observableInternal/debugName.ts +0 -145
  163. package/src/vs/base/common/observableInternal/derived.ts +0 -428
  164. package/src/vs/base/common/observableInternal/lazyObservableValue.ts +0 -146
  165. package/src/vs/base/common/observableInternal/logging.ts +0 -328
  166. package/src/vs/base/common/observableInternal/promise.ts +0 -209
  167. package/src/vs/base/common/observableInternal/utils.ts +0 -610
  168. package/src/vs/base/common/platform.ts +0 -281
  169. package/src/vs/base/common/scrollable.ts +0 -522
  170. package/src/vs/base/common/sequence.ts +0 -34
  171. package/src/vs/base/common/stopwatch.ts +0 -43
  172. package/src/vs/base/common/strings.ts +0 -557
  173. package/src/vs/base/common/symbols.ts +0 -9
  174. package/src/vs/base/common/uint.ts +0 -59
  175. package/src/vs/patches/nls.ts +0 -90
  176. package/src/vs/typings/base-common.d.ts +0 -20
  177. package/src/vs/typings/require.d.ts +0 -42
  178. package/src/vs/typings/vscode-globals-nls.d.ts +0 -36
  179. package/src/vs/typings/vscode-globals-product.d.ts +0 -33
@@ -3,31 +3,33 @@
3
3
  * @license MIT
4
4
  */
5
5
 
6
- import { CharData, IAttributeData, IBufferLine, ICellData, IExtendedAttrs } from 'common/Types';
7
- import { AttributeData } from 'common/buffer/AttributeData';
8
- import { CellData } from 'common/buffer/CellData';
9
- import { Attributes, BgFlags, CHAR_DATA_ATTR_INDEX, CHAR_DATA_CHAR_INDEX, CHAR_DATA_WIDTH_INDEX, Content, NULL_CELL_CHAR, NULL_CELL_CODE, NULL_CELL_WIDTH, WHITESPACE_CELL_CHAR } from 'common/buffer/Constants';
10
- import { stringFromCodePoint } from 'common/input/TextDecoder';
11
-
12
- /**
13
- * buffer memory layout:
14
- *
15
- * | uint32_t | uint32_t | uint32_t |
16
- * | `content` | `FG` | `BG` |
17
- * | wcwidth(2) comb(1) codepoint(21) | flags(8) R(8) G(8) B(8) | flags(8) R(8) G(8) B(8) |
18
- */
19
-
20
-
21
- /** typed array slots taken by one cell */
22
- const CELL_SIZE = 3;
6
+ import { CharData, IAttributeData, IBufferLine, ICellData, IExtendedAttrs } from './Types';
7
+ import { AttributeData } from './AttributeData';
8
+ import { CellData } from './CellData';
9
+ import { Attributes, BgFlags, CHAR_DATA_ATTR_INDEX, CHAR_DATA_CHAR_INDEX, CHAR_DATA_WIDTH_INDEX, Content, NULL_CELL_CHAR, NULL_CELL_CODE, NULL_CELL_WIDTH, WHITESPACE_CELL_CHAR } from './Constants';
10
+ import { stringFromCodePoint } from '../input/TextDecoder';
11
+ import { StringBuilder } from '../StringBuilder';
12
+
13
+ // Buffer memory layout:
14
+ //
15
+ // [0]: content `uint32_t` - wcwidth(2) comb(1) codepoint(21)
16
+ // [1]: fg `uint32_t` - flags(8) r(8) g(8) b(8)
17
+ // [2]: bg `uint32_t` - flags(8) r(8) g(8) b(8)
18
+
19
+ const enum Constants {
20
+ /** The number of 32 bit array indices taken by one cell. */
21
+ CELL_INDICIES = 3,
22
+ /** Factor when to cleanup underlying array buffer after shrinking. */
23
+ CLEANUP_THRESHOLD = 2
24
+ }
23
25
 
24
26
  /**
25
27
  * Cell member indices.
26
28
  *
27
29
  * Direct access:
28
- * `content = data[column * CELL_SIZE + Cell.CONTENT];`
29
- * `fg = data[column * CELL_SIZE + Cell.FG];`
30
- * `bg = data[column * CELL_SIZE + Cell.BG];`
30
+ * `content = data[column * Constants.CELL_INDICIES + Cell.CONTENT];`
31
+ * `fg = data[column * Constants.CELL_INDICIES + Cell.FG];`
32
+ * `bg = data[column * Constants.CELL_INDICIES + Cell.BG];`
31
33
  */
32
34
  const enum Cell {
33
35
  CONTENT = 0,
@@ -39,9 +41,20 @@ export const DEFAULT_ATTR_DATA = Object.freeze(new AttributeData());
39
41
 
40
42
  // Work variables to avoid garbage collection
41
43
  let $startIndex = 0;
44
+ const $workCell = new CellData();
45
+ const $translateToStringBuilder = new StringBuilder();
42
46
 
43
- /** Factor when to cleanup underlying array buffer after shrinking. */
44
- const CLEANUP_THRESHOLD = 2;
47
+ export interface IBufferLineStringCacheEntry {
48
+ value: string | undefined;
49
+ isTrimmed: boolean;
50
+ generation: number;
51
+ }
52
+
53
+ export interface IBufferLineStringCache {
54
+ generation: number;
55
+ allocateEntry(): IBufferLineStringCacheEntry;
56
+ touch?(): void;
57
+ }
45
58
 
46
59
  /**
47
60
  * Typed array based bufferline implementation.
@@ -62,11 +75,17 @@ export class BufferLine implements IBufferLine {
62
75
  protected _data: Uint32Array;
63
76
  protected _combined: {[index: number]: string} = {};
64
77
  protected _extendedAttrs: {[index: number]: IExtendedAttrs | undefined} = {};
78
+ protected _stringCacheEntryRef: WeakRef<IBufferLineStringCacheEntry> | undefined;
65
79
  public length: number;
66
80
 
67
- constructor(cols: number, fillCellData?: ICellData, public isWrapped: boolean = false) {
68
- this._data = new Uint32Array(cols * CELL_SIZE);
69
- const cell = fillCellData || CellData.fromCharData([0, NULL_CELL_CHAR, NULL_CELL_WIDTH, NULL_CELL_CODE]);
81
+ constructor(
82
+ protected readonly _stringCache: IBufferLineStringCache,
83
+ cols: number,
84
+ fillCellData?: ICellData,
85
+ public isWrapped: boolean = false
86
+ ) {
87
+ this._data = new Uint32Array(cols * Constants.CELL_INDICIES);
88
+ const cell = fillCellData ?? CellData.fromCharData([0, NULL_CELL_CHAR, NULL_CELL_WIDTH, NULL_CELL_CODE]);
70
89
  for (let i = 0; i < cols; ++i) {
71
90
  this.setCell(i, cell);
72
91
  }
@@ -78,10 +97,10 @@ export class BufferLine implements IBufferLine {
78
97
  * @deprecated
79
98
  */
80
99
  public get(index: number): CharData {
81
- const content = this._data[index * CELL_SIZE + Cell.CONTENT];
100
+ const content = this._data[index * Constants.CELL_INDICIES + Cell.CONTENT];
82
101
  const cp = content & Content.CODEPOINT_MASK;
83
102
  return [
84
- this._data[index * CELL_SIZE + Cell.FG],
103
+ this._data[index * Constants.CELL_INDICIES + Cell.FG],
85
104
  (content & Content.IS_COMBINED_MASK)
86
105
  ? this._combined[index]
87
106
  : (cp) ? stringFromCodePoint(cp) : '',
@@ -97,12 +116,13 @@ export class BufferLine implements IBufferLine {
97
116
  * @deprecated
98
117
  */
99
118
  public set(index: number, value: CharData): void {
100
- this._data[index * CELL_SIZE + Cell.FG] = value[CHAR_DATA_ATTR_INDEX];
119
+ this._invalidateStringCache();
120
+ this._data[index * Constants.CELL_INDICIES + Cell.FG] = value[CHAR_DATA_ATTR_INDEX];
101
121
  if (value[CHAR_DATA_CHAR_INDEX].length > 1) {
102
122
  this._combined[index] = value[1];
103
- this._data[index * CELL_SIZE + Cell.CONTENT] = index | Content.IS_COMBINED_MASK | (value[CHAR_DATA_WIDTH_INDEX] << Content.WIDTH_SHIFT);
123
+ this._data[index * Constants.CELL_INDICIES + Cell.CONTENT] = index | Content.IS_COMBINED_MASK | (value[CHAR_DATA_WIDTH_INDEX] << Content.WIDTH_SHIFT);
104
124
  } else {
105
- this._data[index * CELL_SIZE + Cell.CONTENT] = value[CHAR_DATA_CHAR_INDEX].charCodeAt(0) | (value[CHAR_DATA_WIDTH_INDEX] << Content.WIDTH_SHIFT);
125
+ this._data[index * Constants.CELL_INDICIES + Cell.CONTENT] = value[CHAR_DATA_CHAR_INDEX].charCodeAt(0) | (value[CHAR_DATA_WIDTH_INDEX] << Content.WIDTH_SHIFT);
106
126
  }
107
127
  }
108
128
 
@@ -111,22 +131,22 @@ export class BufferLine implements IBufferLine {
111
131
  * use these when only one value is needed, otherwise use `loadCell`
112
132
  */
113
133
  public getWidth(index: number): number {
114
- return this._data[index * CELL_SIZE + Cell.CONTENT] >> Content.WIDTH_SHIFT;
134
+ return this._data[index * Constants.CELL_INDICIES + Cell.CONTENT] >> Content.WIDTH_SHIFT;
115
135
  }
116
136
 
117
137
  /** Test whether content has width. */
118
138
  public hasWidth(index: number): number {
119
- return this._data[index * CELL_SIZE + Cell.CONTENT] & Content.WIDTH_MASK;
139
+ return this._data[index * Constants.CELL_INDICIES + Cell.CONTENT] & Content.WIDTH_MASK;
120
140
  }
121
141
 
122
142
  /** Get FG cell component. */
123
143
  public getFg(index: number): number {
124
- return this._data[index * CELL_SIZE + Cell.FG];
144
+ return this._data[index * Constants.CELL_INDICIES + Cell.FG];
125
145
  }
126
146
 
127
147
  /** Get BG cell component. */
128
148
  public getBg(index: number): number {
129
- return this._data[index * CELL_SIZE + Cell.BG];
149
+ return this._data[index * Constants.CELL_INDICIES + Cell.BG];
130
150
  }
131
151
 
132
152
  /**
@@ -135,7 +155,7 @@ export class BufferLine implements IBufferLine {
135
155
  * from real empty cells.
136
156
  */
137
157
  public hasContent(index: number): number {
138
- return this._data[index * CELL_SIZE + Cell.CONTENT] & Content.HAS_CONTENT_MASK;
158
+ return this._data[index * Constants.CELL_INDICIES + Cell.CONTENT] & Content.HAS_CONTENT_MASK;
139
159
  }
140
160
 
141
161
  /**
@@ -144,7 +164,7 @@ export class BufferLine implements IBufferLine {
144
164
  * a single UTF32 codepoint or the last codepoint of a combined string.
145
165
  */
146
166
  public getCodePoint(index: number): number {
147
- const content = this._data[index * CELL_SIZE + Cell.CONTENT];
167
+ const content = this._data[index * Constants.CELL_INDICIES + Cell.CONTENT];
148
168
  if (content & Content.IS_COMBINED_MASK) {
149
169
  return this._combined[index].charCodeAt(this._combined[index].length - 1);
150
170
  }
@@ -153,12 +173,12 @@ export class BufferLine implements IBufferLine {
153
173
 
154
174
  /** Test whether the cell contains a combined string. */
155
175
  public isCombined(index: number): number {
156
- return this._data[index * CELL_SIZE + Cell.CONTENT] & Content.IS_COMBINED_MASK;
176
+ return this._data[index * Constants.CELL_INDICIES + Cell.CONTENT] & Content.IS_COMBINED_MASK;
157
177
  }
158
178
 
159
179
  /** Returns the string content of the cell. */
160
180
  public getString(index: number): string {
161
- const content = this._data[index * CELL_SIZE + Cell.CONTENT];
181
+ const content = this._data[index * Constants.CELL_INDICIES + Cell.CONTENT];
162
182
  if (content & Content.IS_COMBINED_MASK) {
163
183
  return this._combined[index];
164
184
  }
@@ -171,7 +191,7 @@ export class BufferLine implements IBufferLine {
171
191
 
172
192
  /** Get state of protected flag. */
173
193
  public isProtected(index: number): number {
174
- return this._data[index * CELL_SIZE + Cell.BG] & BgFlags.PROTECTED;
194
+ return this._data[index * Constants.CELL_INDICIES + Cell.BG] & BgFlags.PROTECTED;
175
195
  }
176
196
 
177
197
  /**
@@ -179,7 +199,7 @@ export class BufferLine implements IBufferLine {
179
199
  * to GC as it significantly reduced the amount of new objects/references needed.
180
200
  */
181
201
  public loadCell(index: number, cell: ICellData): ICellData {
182
- $startIndex = index * CELL_SIZE;
202
+ $startIndex = index * Constants.CELL_INDICIES;
183
203
  cell.content = this._data[$startIndex + Cell.CONTENT];
184
204
  cell.fg = this._data[$startIndex + Cell.FG];
185
205
  cell.bg = this._data[$startIndex + Cell.BG];
@@ -196,15 +216,16 @@ export class BufferLine implements IBufferLine {
196
216
  * Set data at `index` to `cell`.
197
217
  */
198
218
  public setCell(index: number, cell: ICellData): void {
219
+ this._invalidateStringCache();
199
220
  if (cell.content & Content.IS_COMBINED_MASK) {
200
221
  this._combined[index] = cell.combinedData;
201
222
  }
202
223
  if (cell.bg & BgFlags.HAS_EXTENDED) {
203
224
  this._extendedAttrs[index] = cell.extended;
204
225
  }
205
- this._data[index * CELL_SIZE + Cell.CONTENT] = cell.content;
206
- this._data[index * CELL_SIZE + Cell.FG] = cell.fg;
207
- this._data[index * CELL_SIZE + Cell.BG] = cell.bg;
226
+ this._data[index * Constants.CELL_INDICIES + Cell.CONTENT] = cell.content;
227
+ this._data[index * Constants.CELL_INDICIES + Cell.FG] = cell.fg;
228
+ this._data[index * Constants.CELL_INDICIES + Cell.BG] = cell.bg;
208
229
  }
209
230
 
210
231
  /**
@@ -213,12 +234,13 @@ export class BufferLine implements IBufferLine {
213
234
  * it gets an optimized access method.
214
235
  */
215
236
  public setCellFromCodepoint(index: number, codePoint: number, width: number, attrs: IAttributeData): void {
237
+ this._invalidateStringCache();
216
238
  if (attrs.bg & BgFlags.HAS_EXTENDED) {
217
239
  this._extendedAttrs[index] = attrs.extended;
218
240
  }
219
- this._data[index * CELL_SIZE + Cell.CONTENT] = codePoint | (width << Content.WIDTH_SHIFT);
220
- this._data[index * CELL_SIZE + Cell.FG] = attrs.fg;
221
- this._data[index * CELL_SIZE + Cell.BG] = attrs.bg;
241
+ this._data[index * Constants.CELL_INDICIES + Cell.CONTENT] = codePoint | (width << Content.WIDTH_SHIFT);
242
+ this._data[index * Constants.CELL_INDICIES + Cell.FG] = attrs.fg;
243
+ this._data[index * Constants.CELL_INDICIES + Cell.BG] = attrs.bg;
222
244
  }
223
245
 
224
246
  /**
@@ -228,7 +250,8 @@ export class BufferLine implements IBufferLine {
228
250
  * by the previous `setDataFromCodePoint` call, we can omit it here.
229
251
  */
230
252
  public addCodepointToCell(index: number, codePoint: number, width: number): void {
231
- let content = this._data[index * CELL_SIZE + Cell.CONTENT];
253
+ this._invalidateStringCache();
254
+ let content = this._data[index * Constants.CELL_INDICIES + Cell.CONTENT];
232
255
  if (content & Content.IS_COMBINED_MASK) {
233
256
  // we already have a combined string, simply add
234
257
  this._combined[index] += stringFromCodePoint(codePoint);
@@ -250,10 +273,11 @@ export class BufferLine implements IBufferLine {
250
273
  content &= ~Content.WIDTH_MASK;
251
274
  content |= width << Content.WIDTH_SHIFT;
252
275
  }
253
- this._data[index * CELL_SIZE + Cell.CONTENT] = content;
276
+ this._data[index * Constants.CELL_INDICIES + Cell.CONTENT] = content;
254
277
  }
255
278
 
256
279
  public insertCells(pos: number, n: number, fillCellData: ICellData): void {
280
+ this._invalidateStringCache();
257
281
  pos %= this.length;
258
282
 
259
283
  // handle fullwidth at pos: reset cell one to the left if pos is second cell of a wide char
@@ -262,9 +286,8 @@ export class BufferLine implements IBufferLine {
262
286
  }
263
287
 
264
288
  if (n < this.length - pos) {
265
- const cell = new CellData();
266
289
  for (let i = this.length - pos - n - 1; i >= 0; --i) {
267
- this.setCell(pos + n + i, this.loadCell(pos + i, cell));
290
+ this.setCell(pos + n + i, this.loadCell(pos + i, $workCell));
268
291
  }
269
292
  for (let i = 0; i < n; ++i) {
270
293
  this.setCell(pos + i, fillCellData);
@@ -282,11 +305,11 @@ export class BufferLine implements IBufferLine {
282
305
  }
283
306
 
284
307
  public deleteCells(pos: number, n: number, fillCellData: ICellData): void {
308
+ this._invalidateStringCache();
285
309
  pos %= this.length;
286
310
  if (n < this.length - pos) {
287
- const cell = new CellData();
288
311
  for (let i = 0; i < this.length - pos - n; ++i) {
289
- this.setCell(pos + i, this.loadCell(pos + n + i, cell));
312
+ this.setCell(pos + i, this.loadCell(pos + n + i, $workCell));
290
313
  }
291
314
  for (let i = this.length - n; i < this.length; ++i) {
292
315
  this.setCell(i, fillCellData);
@@ -309,6 +332,7 @@ export class BufferLine implements IBufferLine {
309
332
  }
310
333
 
311
334
  public replaceCells(start: number, end: number, fillCellData: ICellData, respectProtect: boolean = false): void {
335
+ this._invalidateStringCache();
312
336
  // full branching on respectProtect==true, hopefully getting fast JIT for standard case
313
337
  if (respectProtect) {
314
338
  if (start && this.getWidth(start - 1) === 2 && !this.isProtected(start - 1)) {
@@ -345,13 +369,14 @@ export class BufferLine implements IBufferLine {
345
369
  * The underlying array buffer will not change if there is still enough space
346
370
  * to hold the new buffer line data.
347
371
  * Returns a boolean indicating, whether a `cleanupMemory` call would free
348
- * excess memory (true after shrinking > CLEANUP_THRESHOLD).
372
+ * excess memory (true after shrinking > Constants.CLEANUP_THRESHOLD).
349
373
  */
350
374
  public resize(cols: number, fillCellData: ICellData): boolean {
375
+ this._invalidateStringCache();
351
376
  if (cols === this.length) {
352
- return this._data.length * 4 * CLEANUP_THRESHOLD < this._data.buffer.byteLength;
377
+ return this._data.length * 4 * Constants.CLEANUP_THRESHOLD < this._data.buffer.byteLength;
353
378
  }
354
- const uint32Cells = cols * CELL_SIZE;
379
+ const uint32Cells = cols * Constants.CELL_INDICIES;
355
380
  if (cols > this.length) {
356
381
  if (this._data.buffer.byteLength >= uint32Cells * 4) {
357
382
  // optimization: avoid alloc and data copy if buffer has enough room
@@ -386,17 +411,17 @@ export class BufferLine implements IBufferLine {
386
411
  }
387
412
  }
388
413
  this.length = cols;
389
- return uint32Cells * 4 * CLEANUP_THRESHOLD < this._data.buffer.byteLength;
414
+ return uint32Cells * 4 * Constants.CLEANUP_THRESHOLD < this._data.buffer.byteLength;
390
415
  }
391
416
 
392
417
  /**
393
418
  * Cleanup underlying array buffer.
394
419
  * A cleanup will be triggered if the array buffer exceeds the actual used
395
- * memory by a factor of CLEANUP_THRESHOLD.
420
+ * memory by a factor of Constants.CLEANUP_THRESHOLD.
396
421
  * Returns 0 or 1 indicating whether a cleanup happened.
397
422
  */
398
423
  public cleanupMemory(): number {
399
- if (this._data.length * 4 * CLEANUP_THRESHOLD < this._data.buffer.byteLength) {
424
+ if (this._data.length * 4 * Constants.CLEANUP_THRESHOLD < this._data.buffer.byteLength) {
400
425
  const data = new Uint32Array(this._data.length);
401
426
  data.set(this._data);
402
427
  this._data = data;
@@ -407,6 +432,7 @@ export class BufferLine implements IBufferLine {
407
432
 
408
433
  /** fill a line with fillCharData */
409
434
  public fill(fillCellData: ICellData, respectProtect: boolean = false): void {
435
+ this._invalidateStringCache();
410
436
  // full branching on respectProtect==true, hopefully getting fast JIT for standard case
411
437
  if (respectProtect) {
412
438
  for (let i = 0; i < this.length; ++i) {
@@ -425,6 +451,7 @@ export class BufferLine implements IBufferLine {
425
451
 
426
452
  /** alter to a full copy of line */
427
453
  public copyFrom(line: BufferLine): void {
454
+ this._invalidateStringCache();
428
455
  if (this.length !== line.length) {
429
456
  this._data = new Uint32Array(line._data);
430
457
  } else {
@@ -445,7 +472,7 @@ export class BufferLine implements IBufferLine {
445
472
 
446
473
  /** create a new clone */
447
474
  public clone(): IBufferLine {
448
- const newLine = new BufferLine(0);
475
+ const newLine = new BufferLine(this._stringCache, 0, undefined, false);
449
476
  newLine._data = new Uint32Array(this._data);
450
477
  newLine.length = this.length;
451
478
  for (const el in this._combined) {
@@ -460,8 +487,8 @@ export class BufferLine implements IBufferLine {
460
487
 
461
488
  public getTrimmedLength(): number {
462
489
  for (let i = this.length - 1; i >= 0; --i) {
463
- if ((this._data[i * CELL_SIZE + Cell.CONTENT] & Content.HAS_CONTENT_MASK)) {
464
- return i + (this._data[i * CELL_SIZE + Cell.CONTENT] >> Content.WIDTH_SHIFT);
490
+ if ((this._data[i * Constants.CELL_INDICIES + Cell.CONTENT] & Content.HAS_CONTENT_MASK)) {
491
+ return i + (this._data[i * Constants.CELL_INDICIES + Cell.CONTENT] >> Content.WIDTH_SHIFT);
465
492
  }
466
493
  }
467
494
  return 0;
@@ -469,30 +496,31 @@ export class BufferLine implements IBufferLine {
469
496
 
470
497
  public getNoBgTrimmedLength(): number {
471
498
  for (let i = this.length - 1; i >= 0; --i) {
472
- if ((this._data[i * CELL_SIZE + Cell.CONTENT] & Content.HAS_CONTENT_MASK) || (this._data[i * CELL_SIZE + Cell.BG] & Attributes.CM_MASK)) {
473
- return i + (this._data[i * CELL_SIZE + Cell.CONTENT] >> Content.WIDTH_SHIFT);
499
+ if ((this._data[i * Constants.CELL_INDICIES + Cell.CONTENT] & Content.HAS_CONTENT_MASK) || (this._data[i * Constants.CELL_INDICIES + Cell.BG] & Attributes.CM_MASK)) {
500
+ return i + (this._data[i * Constants.CELL_INDICIES + Cell.CONTENT] >> Content.WIDTH_SHIFT);
474
501
  }
475
502
  }
476
503
  return 0;
477
504
  }
478
505
 
479
506
  public copyCellsFrom(src: BufferLine, srcCol: number, destCol: number, length: number, applyInReverse: boolean): void {
507
+ this._invalidateStringCache();
480
508
  const srcData = src._data;
481
509
  if (applyInReverse) {
482
510
  for (let cell = length - 1; cell >= 0; cell--) {
483
- for (let i = 0; i < CELL_SIZE; i++) {
484
- this._data[(destCol + cell) * CELL_SIZE + i] = srcData[(srcCol + cell) * CELL_SIZE + i];
511
+ for (let i = 0; i < Constants.CELL_INDICIES; i++) {
512
+ this._data[(destCol + cell) * Constants.CELL_INDICIES + i] = srcData[(srcCol + cell) * Constants.CELL_INDICIES + i];
485
513
  }
486
- if (srcData[(srcCol + cell) * CELL_SIZE + Cell.BG] & BgFlags.HAS_EXTENDED) {
514
+ if (srcData[(srcCol + cell) * Constants.CELL_INDICIES + Cell.BG] & BgFlags.HAS_EXTENDED) {
487
515
  this._extendedAttrs[destCol + cell] = src._extendedAttrs[srcCol + cell];
488
516
  }
489
517
  }
490
518
  } else {
491
519
  for (let cell = 0; cell < length; cell++) {
492
- for (let i = 0; i < CELL_SIZE; i++) {
493
- this._data[(destCol + cell) * CELL_SIZE + i] = srcData[(srcCol + cell) * CELL_SIZE + i];
520
+ for (let i = 0; i < Constants.CELL_INDICIES; i++) {
521
+ this._data[(destCol + cell) * Constants.CELL_INDICIES + i] = srcData[(srcCol + cell) * Constants.CELL_INDICIES + i];
494
522
  }
495
- if (srcData[(srcCol + cell) * CELL_SIZE + Cell.BG] & BgFlags.HAS_EXTENDED) {
523
+ if (srcData[(srcCol + cell) * Constants.CELL_INDICIES + Cell.BG] & BgFlags.HAS_EXTENDED) {
496
524
  this._extendedAttrs[destCol + cell] = src._extendedAttrs[srcCol + cell];
497
525
  }
498
526
  }
@@ -509,7 +537,8 @@ export class BufferLine implements IBufferLine {
509
537
  }
510
538
 
511
539
  /**
512
- * Translates the buffer line to a string.
540
+ * Translates the buffer line to a string. Caching only applies to canonical full-line translation
541
+ * requests (regardless of `trimRight` value).
513
542
  *
514
543
  * @param trimRight Whether to trim any empty cells on the right.
515
544
  * @param startCol The column to start the string (0-based inclusive).
@@ -522,6 +551,19 @@ export class BufferLine implements IBufferLine {
522
551
  * returned string, the corresponding entries in `outColumns` will have the same column number.
523
552
  */
524
553
  public translateToString(trimRight?: boolean, startCol?: number, endCol?: number, outColumns?: number[]): string {
554
+ const isCanonicalRequest = (startCol === undefined || startCol === 0) && endCol === undefined && outColumns === undefined;
555
+ if (isCanonicalRequest) {
556
+ this._stringCache.touch?.();
557
+ }
558
+ const stringCacheEntry = isCanonicalRequest ? this._getStringCacheEntry(false) : undefined;
559
+ if (isCanonicalRequest && stringCacheEntry?.value !== undefined) {
560
+ if (trimRight) {
561
+ return stringCacheEntry.isTrimmed ? stringCacheEntry.value : stringCacheEntry.value.trimEnd();
562
+ }
563
+ if (!stringCacheEntry.isTrimmed) {
564
+ return stringCacheEntry.value;
565
+ }
566
+ }
525
567
  startCol = startCol ?? 0;
526
568
  endCol = endCol ?? this.length;
527
569
  if (trimRight) {
@@ -530,12 +572,12 @@ export class BufferLine implements IBufferLine {
530
572
  if (outColumns) {
531
573
  outColumns.length = 0;
532
574
  }
533
- let result = '';
575
+ $translateToStringBuilder.reset();
534
576
  while (startCol < endCol) {
535
- const content = this._data[startCol * CELL_SIZE + Cell.CONTENT];
577
+ const content = this._data[startCol * Constants.CELL_INDICIES + Cell.CONTENT];
536
578
  const cp = content & Content.CODEPOINT_MASK;
537
579
  const chars = (content & Content.IS_COMBINED_MASK) ? this._combined[startCol] : (cp) ? stringFromCodePoint(cp) : WHITESPACE_CELL_CHAR;
538
- result += chars;
580
+ $translateToStringBuilder.append(chars);
539
581
  if (outColumns) {
540
582
  for (let i = 0; i < chars.length; ++i) {
541
583
  outColumns.push(startCol);
@@ -546,6 +588,36 @@ export class BufferLine implements IBufferLine {
546
588
  if (outColumns) {
547
589
  outColumns.push(startCol);
548
590
  }
591
+ const result = $translateToStringBuilder.toString();
592
+ $translateToStringBuilder.reset();
593
+ if (isCanonicalRequest) {
594
+ const cacheEntry = this._getStringCacheEntry(true)!;
595
+ cacheEntry.value = result;
596
+ cacheEntry.isTrimmed = !!trimRight;
597
+ }
549
598
  return result;
550
599
  }
600
+
601
+ protected _getStringCacheEntry(createIfNeeded: boolean): IBufferLineStringCacheEntry | undefined {
602
+ const cachedEntry = this._stringCacheEntryRef?.deref();
603
+ if (cachedEntry) {
604
+ if (cachedEntry.generation === this._stringCache.generation) {
605
+ return cachedEntry;
606
+ }
607
+ }
608
+ if (!createIfNeeded) {
609
+ return undefined;
610
+ }
611
+ const cacheEntry = this._stringCache.allocateEntry();
612
+ this._stringCacheEntryRef = new WeakRef(cacheEntry);
613
+ return cacheEntry;
614
+ }
615
+
616
+ private _invalidateStringCache(): void {
617
+ const cacheEntry = this._getStringCacheEntry(false);
618
+ if (cacheEntry) {
619
+ cacheEntry.value = undefined;
620
+ cacheEntry.isTrimmed = false;
621
+ }
622
+ }
551
623
  }
@@ -0,0 +1,69 @@
1
+ /**
2
+ * Copyright (c) 2026 The xterm.js authors. All rights reserved.
3
+ * @license MIT
4
+ */
5
+
6
+ import type { IBufferLineStringCache, IBufferLineStringCacheEntry } from './BufferLine';
7
+ import { disposableTimeout } from '../Async';
8
+ import { Disposable, MutableDisposable, toDisposable, type IDisposable } from '../Lifecycle';
9
+
10
+ const enum Constants {
11
+ CACHE_TTL_MS = 15000
12
+ }
13
+
14
+ export class BufferLineStringCache extends Disposable implements IBufferLineStringCache {
15
+ public generation: number = 0;
16
+ public readonly entries: Set<IBufferLineStringCacheEntry> = new Set();
17
+ private readonly _clearTimeout = this._register(new MutableDisposable<IDisposable>());
18
+ private _lastAccessTimestamp: number = 0;
19
+
20
+ constructor() {
21
+ super();
22
+ this._register(toDisposable(() => this.entries.clear()));
23
+ }
24
+
25
+ public touch(): void {
26
+ this._scheduleClear();
27
+ }
28
+
29
+ public allocateEntry(): IBufferLineStringCacheEntry {
30
+ const entry: IBufferLineStringCacheEntry = {
31
+ value: undefined,
32
+ isTrimmed: false,
33
+ generation: this.generation
34
+ };
35
+ this.entries.add(entry);
36
+ this._scheduleClear();
37
+ return entry;
38
+ }
39
+
40
+ public clear(): void {
41
+ this._clearTimeout.clear();
42
+ this._lastAccessTimestamp = 0;
43
+ this.generation++;
44
+ for (const entry of this.entries) {
45
+ entry.value = undefined;
46
+ entry.isTrimmed = false;
47
+ }
48
+ this.entries.clear();
49
+ }
50
+
51
+ private _scheduleClear(): void {
52
+ this._lastAccessTimestamp = Date.now();
53
+ if (this._clearTimeout.value) {
54
+ return;
55
+ }
56
+ this._scheduleClearTimeout(Constants.CACHE_TTL_MS);
57
+ }
58
+
59
+ private _scheduleClearTimeout(timeoutMs: number): void {
60
+ this._clearTimeout.value = disposableTimeout(() => {
61
+ const elapsed = Date.now() - this._lastAccessTimestamp;
62
+ if (elapsed >= Constants.CACHE_TTL_MS) {
63
+ this.clear();
64
+ return;
65
+ }
66
+ this._scheduleClearTimeout(Constants.CACHE_TTL_MS - elapsed);
67
+ }, timeoutMs);
68
+ }
69
+ }
@@ -3,9 +3,9 @@
3
3
  * @license MIT
4
4
  */
5
5
 
6
- import { BufferLine } from 'common/buffer/BufferLine';
7
- import { CircularList } from 'common/CircularList';
8
- import { IBufferLine, ICellData } from 'common/Types';
6
+ import { BufferLine } from './BufferLine';
7
+ import { CircularList } from '../CircularList';
8
+ import { IBufferLine, ICellData } from './Types';
9
9
 
10
10
  export interface INewLayoutResult {
11
11
  layout: number[];
@@ -178,7 +178,10 @@ export function reflowLargerApplyNewLayout(lines: CircularList<IBufferLine>, new
178
178
  */
179
179
  export function reflowSmallerGetNewLineLengths(wrappedLines: BufferLine[], oldCols: number, newCols: number): number[] {
180
180
  const newLineLengths: number[] = [];
181
- const cellsNeeded = wrappedLines.map((l, i) => getWrappedLineTrimmedLength(wrappedLines, i, oldCols)).reduce((p, c) => p + c);
181
+ let cellsNeeded = 0;
182
+ for (let i = 0; i < wrappedLines.length; i++) {
183
+ cellsNeeded += getWrappedLineTrimmedLength(wrappedLines, i, oldCols);
184
+ }
182
185
 
183
186
  // Use srcCol and srcLine to find the new wrapping point, use that to get the cellsAvailable and
184
187
  // linesNeeded
@@ -3,12 +3,11 @@
3
3
  * @license MIT
4
4
  */
5
5
 
6
- import { Disposable } from 'vs/base/common/lifecycle';
7
- import { IAttributeData } from 'common/Types';
8
- import { Buffer } from 'common/buffer/Buffer';
9
- import { IBuffer, IBufferSet } from 'common/buffer/Types';
10
- import { IBufferService, IOptionsService } from 'common/services/Services';
11
- import { Emitter } from 'vs/base/common/event';
6
+ import { Disposable, MutableDisposable } from '../Lifecycle';
7
+ import { Buffer } from './Buffer';
8
+ import { IAttributeData, IBuffer, IBufferSet } from './Types';
9
+ import { IBufferService, ILogService, IOptionsService } from '../services/Services';
10
+ import { Emitter } from '../Event';
12
11
 
13
12
  /**
14
13
  * The BufferSet represents the set of two buffers used by xterm terminals (normal and alt) and
@@ -18,6 +17,8 @@ export class BufferSet extends Disposable implements IBufferSet {
18
17
  private _normal!: Buffer;
19
18
  private _alt!: Buffer;
20
19
  private _activeBuffer!: Buffer;
20
+ private readonly _normalBuffer = this._register(new MutableDisposable<Buffer>());
21
+ private readonly _altBuffer = this._register(new MutableDisposable<Buffer>());
21
22
 
22
23
  private readonly _onBufferActivate = this._register(new Emitter<{ activeBuffer: IBuffer, inactiveBuffer: IBuffer }>());
23
24
  public readonly onBufferActivate = this._onBufferActivate.event;
@@ -27,7 +28,8 @@ export class BufferSet extends Disposable implements IBufferSet {
27
28
  */
28
29
  constructor(
29
30
  private readonly _optionsService: IOptionsService,
30
- private readonly _bufferService: IBufferService
31
+ private readonly _bufferService: IBufferService,
32
+ private readonly _logService: ILogService
31
33
  ) {
32
34
  super();
33
35
  this.reset();
@@ -36,12 +38,14 @@ export class BufferSet extends Disposable implements IBufferSet {
36
38
  }
37
39
 
38
40
  public reset(): void {
39
- this._normal = new Buffer(true, this._optionsService, this._bufferService);
41
+ this._normal = new Buffer(true, this._optionsService, this._bufferService, this._logService);
42
+ this._normalBuffer.value = this._normal;
40
43
  this._normal.fillViewportRows();
41
44
 
42
45
  // The alt buffer should never have scrollback.
43
46
  // See http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-The-Alternate-Screen-Buffer
44
- this._alt = new Buffer(false, this._optionsService, this._bufferService);
47
+ this._alt = new Buffer(false, this._optionsService, this._bufferService, this._logService);
48
+ this._altBuffer.value = this._alt;
45
49
  this._activeBuffer = this._normal;
46
50
  this._onBufferActivate.fire({
47
51
  activeBuffer: this._normal,