src/vs/base/common/history.ts
298 LOC · 284 covered · 14 uncovered · 82 ranges · 49 concepts · 32 introducers · 27 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
1
>
/*---------------------------------------------------------------------------------------------
history.ts ×31
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import { SetWithKey } from './collections.js';
7
>
import { Event } from './event.js';
8
>
import { IDisposable } from './lifecycle.js';
9
>
import { ArrayNavigator, INavigator } from './navigator.js';
10
>
11
>
export interface IHistory<T> {
12
>
delete(t: T): boolean;
13
>
add(t: T): this;
14
>
has(t: T): boolean;
15
>
clear(): void;
16
>
forEach(callbackfn: (value: T, value2: T, set: Set<T>) => void, thisArg?: unknown): void;
17
>
replace?(t: T[]): void;
18
>
readonly onDidChange?: Event<string[]>;
19
>
}
20
>
21
>
export class HistoryNavigator<T> implements INavigator<T> {
22
>
private _limit: number;
23
>
private _navigator!: ArrayNavigator<T>;
24
>
private _disposable: IDisposable | undefined;
25
>
26
>
constructor(
28
>
limit: number = 10,
29
>
) {
30
>
this._limit = limit;
31
>
this._onChange();
32
>
if (this._history.onDidChange) {
33
this._disposable = this._history.onDidChange(() => this._onChange());
34
}
37
>
public getHistory(): T[] {
38
return this._elements;
39
}
41
>
public add(t: T) {
43
>
this._history.add(t);
44
>
this._onChange();
45
>
}
47
>
public next(): T | null {
48
>
// This will navigate past the end of the last element, and in that case the input should be cleared
history.ts ×1
49
>
return this._navigator.next();
50
>
}
52
>
public previous(): T | null {
55
>
}
59
>
public current(): T | null {
61
>
}
63
>
public first(): T | null {
65
>
}
67
>
public last(): T | null {
69
>
}
71
>
public isFirst(): boolean {
73
>
}
75
>
public isLast(): boolean {
77
>
}
79
>
public isNowhere(): boolean {
81
>
}
83
>
public has(t: T): boolean {
84
return this._history.has(t);
85
}
87
>
public clear(): void {
89
>
this._onChange();
90
>
}
92
>
private _onChange() {
94
>
const elements = this._elements;
95
>
this._navigator = new ArrayNavigator(elements, 0, elements.length, elements.length);
96
>
}
98
>
private _reduceToLimit() {
100
>
if (data.length > this._limit) {
102
>
if (this._history.replace) {
103
this._history.replace(replaceValue);
105
>
this._history = new Set(replaceValue);
106
>
}
107
>
}
110
>
private _currentPosition(): number {
112
>
if (!currentElement) {
114
>
}
116
>
return this._elements.indexOf(currentElement);
119
>
private get _elements(): T[] {
121
>
this._history.forEach(e => elements.push(e));
122
>
return elements;
123
>
}
125
>
public dispose(): void {
126
if (this._disposable) {
127
this._disposable.dispose();
128
this._disposable = undefined;
129
}
130
}
132
>
133
>
interface HistoryNode<T> {
134
>
value: T;
135
>
previous: HistoryNode<T> | undefined;
136
>
next: HistoryNode<T> | undefined;
137
>
}
138
>
139
>
/**
140
>
* The right way to use HistoryNavigator2 is for the last item in the list to be the user's uncommitted current text. eg empty string, or whatever has been typed. Then
141
>
* the user can navigate away from the last item through the list, and back to it. When updating the last item, call replaceLast.
142
>
*/
143
>
export class HistoryNavigator2<T> {
144
>
145
>
private valueSet: Set<T>;
146
>
private head: HistoryNode<T>;
147
>
private tail: HistoryNode<T>;
148
>
private cursor: HistoryNode<T>;
149
>
private _size: number;
150
>
get size(): number { return this._size; }
151
>
152
>
constructor(history: readonly T[], private capacity: number = 10, private identityFn: (t: T) => unknown = t => t) {
155
>
}
157
>
this._size = 1;
158
>
this.head = this.tail = this.cursor = {
159
>
value: history[0],
160
>
previous: undefined,
161
>
next: undefined
162
>
};
163
>
164
>
this.valueSet = new SetWithKey<T>([history[0]], identityFn);
165
>
for (let i = 1; i < history.length; i++) {
166
>
this.add(history[i]);
167
>
}
170
>
add(value: T): void {
172
>
value,
173
>
previous: this.tail,
174
>
next: undefined
175
>
};
176
>
177
>
this.tail.next = node;
178
>
this.tail = node;
179
>
this.cursor = this.tail;
180
>
this._size++;
181
>
182
>
if (this.valueSet.has(value)) {
185
>
this.valueSet.add(value);
186
>
}
187
>
188
>
while (this._size > this.capacity) {
190
>
191
>
this.head = this.head.next!;
192
>
this.head.previous = undefined;
193
>
this._size--;
194
>
}
197
>
/**
198
>
* @returns old last value
199
>
*/
200
>
replaceLast(value: T): T {
202
return value;
203
}
205
>
const oldValue = this.tail.value;
206
>
this.valueSet.delete(oldValue);
207
>
this.tail.value = value;
208
>
209
>
if (this.valueSet.has(value)) {
213
>
}
215
>
return oldValue;
216
>
}
218
>
prepend(value: T): void {
220
>
return;
221
>
}
222
>
223
>
const node: HistoryNode<T> = {
224
>
value,
225
>
previous: undefined,
226
>
next: this.head
227
>
};
228
>
229
>
this.head.previous = node;
230
>
this.head = node;
231
>
this._size++;
232
>
233
>
this.valueSet.add(value);
234
>
}
236
>
isAtEnd(): boolean {
238
>
}
240
>
current(): T {
242
>
}
244
>
previous(): T {
246
>
this.cursor = this.cursor.previous;
247
>
}
248
>
249
>
return this.cursor.value;
250
>
}
252
>
next(): T {
254
>
this.cursor = this.cursor.next;
255
>
}
256
>
257
>
return this.cursor.value;
258
>
}
260
>
has(t: T): boolean {
262
>
}
264
>
resetCursor(): T {
266
>
return this.cursor.value;
267
>
}
269
>
*[Symbol.iterator](): Iterator<T> {
271
>
272
>
while (node) {
273
>
yield node.value;
274
>
node = node.next;
275
>
}
276
>
}
278
>
private _deleteFromList(value: T): void {
280
>
281
>
const valueKey = this.identityFn(value);
282
>
while (temp !== this.tail) {
283
>
if (this.identityFn(temp.value) === valueKey) {
284
>
if (temp === this.head) {
286
>
this.head.previous = undefined;
288
>
temp.previous!.next = temp.next;
289
>
temp.next!.previous = temp.previous;
290
>
}
291
>
292
>
this._size--;
293
>
}
294
>
295
>
temp = temp.next!;
296
>
}
297
>
}