Skip to content

Commit fb19601

Browse files
jriekenjrieken
committed
debt/es6 - make LinkedMap a ES6 map
fyi @dbaeumer
1 parent bf77670 commit fb19601

File tree

4 files changed

+70
-63
lines changed

4 files changed

+70
-63
lines changed

‎src/vs/base/common/map.ts‎

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -580,7 +580,9 @@ export const enum Touch {
580580
AsNew = 2
581581
}
582582

583-
export class LinkedMap<K, V> {
583+
export class LinkedMap<K, V> implements Map<K, V>{
584+
585+
readonly [Symbol.toStringTag] = 'LinkedMap';
584586

585587
private _map: Map<K, Item<K, V>>;
586588
private _head: Item<K, V> | undefined;
@@ -632,7 +634,7 @@ export class LinkedMap<K, V> {
632634
return item.value;
633635
}
634636

635-
set(key: K, value: V, touch: Touch = Touch.None): void {
637+
set(key: K, value: V, touch: Touch = Touch.None): this {
636638
let item = this._map.get(key);
637639
if (item) {
638640
item.value = value;
@@ -658,6 +660,7 @@ export class LinkedMap<K, V> {
658660
this._map.set(key, item);
659661
this._size++;
660662
}
663+
return this;
661664
}
662665

663666
delete(key: K): boolean {
@@ -701,34 +704,13 @@ export class LinkedMap<K, V> {
701704
}
702705
}
703706

704-
values(): V[] {
705-
const result: V[] = [];
706-
let current = this._head;
707-
while (current) {
708-
result.push(current.value);
709-
current = current.next;
710-
}
711-
return result;
712-
}
713-
714-
keys(): K[] {
715-
const result: K[] = [];
716-
let current = this._head;
717-
while (current) {
718-
result.push(current.key);
719-
current = current.next;
720-
}
721-
return result;
722-
}
723-
724-
/* VS Code / Monaco editor runs on es5 which has no Symbol.iterator
725707
keys(): IterableIterator<K> {
726-
const current = this._head;
708+
let current = this._head;
727709
const iterator: IterableIterator<K> = {
728710
[Symbol.iterator]() {
729711
return iterator;
730712
},
731-
next():IteratorResult<K> {
713+
next(): IteratorResult<K> {
732714
if (current) {
733715
const result = { value: current.key, done: false };
734716
current = current.next;
@@ -742,12 +724,12 @@ export class LinkedMap<K, V> {
742724
}
743725

744726
values(): IterableIterator<V> {
745-
const current = this._head;
727+
let current = this._head;
746728
const iterator: IterableIterator<V> = {
747729
[Symbol.iterator]() {
748730
return iterator;
749731
},
750-
next():IteratorResult<V> {
732+
next(): IteratorResult<V> {
751733
if (current) {
752734
const result = { value: current.value, done: false };
753735
current = current.next;
@@ -759,7 +741,29 @@ export class LinkedMap<K, V> {
759741
};
760742
return iterator;
761743
}
762-
*/
744+
745+
entries(): IterableIterator<[K, V]> {
746+
let current = this._head;
747+
const iterator: IterableIterator<[K, V]> = {
748+
[Symbol.iterator]() {
749+
return iterator;
750+
},
751+
next(): IteratorResult<[K, V]> {
752+
if (current) {
753+
const result: IteratorResult<[K, V]> = { value: [current.key, current.value], done: false };
754+
current = current.next;
755+
return result;
756+
} else {
757+
return { value: undefined, done: true };
758+
}
759+
}
760+
};
761+
return iterator;
762+
}
763+
764+
[Symbol.iterator](): IterableIterator<[K, V]> {
765+
return this.entries();
766+
}
763767

764768
protected trimOld(newSize: number) {
765769
if (newSize >= this.size) {
@@ -961,9 +965,10 @@ export class LRUCache<K, V> extends LinkedMap<K, V> {
961965
return super.get(key, Touch.None);
962966
}
963967

964-
set(key: K, value: V): void {
968+
set(key: K, value: V): this {
965969
super.set(key, value, Touch.AsNew);
966970
this.checkTrim();
971+
return this;
967972
}
968973

969974
private checkTrim() {

‎src/vs/base/test/common/map.test.ts‎

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ suite('Map', () => {
1313
let map = new LinkedMap<string, string>();
1414
map.set('ak', 'av');
1515
map.set('bk', 'bv');
16-
assert.deepStrictEqual(map.keys(), ['ak', 'bk']);
17-
assert.deepStrictEqual(map.values(), ['av', 'bv']);
16+
assert.deepStrictEqual([...map.keys()], ['ak', 'bk']);
17+
assert.deepStrictEqual([...map.values()], ['av', 'bv']);
1818
assert.equal(map.first, 'av');
1919
assert.equal(map.last, 'bv');
2020
});
@@ -23,34 +23,34 @@ suite('Map', () => {
2323
let map = new LinkedMap<string, string>();
2424
map.set('ak', 'av');
2525
map.set('ak', 'av', Touch.AsOld);
26-
assert.deepStrictEqual(map.keys(), ['ak']);
27-
assert.deepStrictEqual(map.values(), ['av']);
26+
assert.deepStrictEqual([...map.keys()], ['ak']);
27+
assert.deepStrictEqual([...map.values()], ['av']);
2828
});
2929

3030
test('LinkedMap - Touch New one', () => {
3131
let map = new LinkedMap<string, string>();
3232
map.set('ak', 'av');
3333
map.set('ak', 'av', Touch.AsNew);
34-
assert.deepStrictEqual(map.keys(), ['ak']);
35-
assert.deepStrictEqual(map.values(), ['av']);
34+
assert.deepStrictEqual([...map.keys()], ['ak']);
35+
assert.deepStrictEqual([...map.values()], ['av']);
3636
});
3737

3838
test('LinkedMap - Touch Old two', () => {
3939
let map = new LinkedMap<string, string>();
4040
map.set('ak', 'av');
4141
map.set('bk', 'bv');
4242
map.set('bk', 'bv', Touch.AsOld);
43-
assert.deepStrictEqual(map.keys(), ['bk', 'ak']);
44-
assert.deepStrictEqual(map.values(), ['bv', 'av']);
43+
assert.deepStrictEqual([...map.keys()], ['bk', 'ak']);
44+
assert.deepStrictEqual([...map.values()], ['bv', 'av']);
4545
});
4646

4747
test('LinkedMap - Touch New two', () => {
4848
let map = new LinkedMap<string, string>();
4949
map.set('ak', 'av');
5050
map.set('bk', 'bv');
5151
map.set('ak', 'av', Touch.AsNew);
52-
assert.deepStrictEqual(map.keys(), ['bk', 'ak']);
53-
assert.deepStrictEqual(map.values(), ['bv', 'av']);
52+
assert.deepStrictEqual([...map.keys()], ['bk', 'ak']);
53+
assert.deepStrictEqual([...map.values()], ['bv', 'av']);
5454
});
5555

5656
test('LinkedMap - Touch Old from middle', () => {
@@ -59,8 +59,8 @@ suite('Map', () => {
5959
map.set('bk', 'bv');
6060
map.set('ck', 'cv');
6161
map.set('bk', 'bv', Touch.AsOld);
62-
assert.deepStrictEqual(map.keys(), ['bk', 'ak', 'ck']);
63-
assert.deepStrictEqual(map.values(), ['bv', 'av', 'cv']);
62+
assert.deepStrictEqual([...map.keys()], ['bk', 'ak', 'ck']);
63+
assert.deepStrictEqual([...map.values()], ['bv', 'av', 'cv']);
6464
});
6565

6666
test('LinkedMap - Touch New from middle', () => {
@@ -69,8 +69,8 @@ suite('Map', () => {
6969
map.set('bk', 'bv');
7070
map.set('ck', 'cv');
7171
map.set('bk', 'bv', Touch.AsNew);
72-
assert.deepStrictEqual(map.keys(), ['ak', 'ck', 'bk']);
73-
assert.deepStrictEqual(map.values(), ['av', 'cv', 'bv']);
72+
assert.deepStrictEqual([...map.keys()], ['ak', 'ck', 'bk']);
73+
assert.deepStrictEqual([...map.values()], ['av', 'cv', 'bv']);
7474
});
7575

7676
test('LinkedMap - basics', function () {
@@ -136,25 +136,27 @@ suite('Map', () => {
136136
assert.strictEqual(cache.size, 5);
137137
cache.set(6, 6);
138138
assert.strictEqual(cache.size, 5);
139-
assert.deepStrictEqual(cache.keys(), [2, 3, 4, 5, 6]);
139+
assert.deepStrictEqual([...cache.keys()], [2, 3, 4, 5, 6]);
140140
cache.set(7, 7);
141141
assert.strictEqual(cache.size, 5);
142-
assert.deepStrictEqual(cache.keys(), [3, 4, 5, 6, 7]);
142+
assert.deepStrictEqual([...cache.keys()], [3, 4, 5, 6, 7]);
143143
let values: number[] = [];
144144
[3, 4, 5, 6, 7].forEach(key => values.push(cache.get(key)!));
145145
assert.deepStrictEqual(values, [3, 4, 5, 6, 7]);
146+
147+
assert.deepEqual([...cache.entries()], [[3, 3], [4, 4], [5, 5], [6, 6], [7, 7]]);
146148
});
147149

148150
test('LinkedMap - LRU Cache get', () => {
149151
const cache = new LRUCache<number, number>(5);
150152

151153
[1, 2, 3, 4, 5].forEach(value => cache.set(value, value));
152154
assert.strictEqual(cache.size, 5);
153-
assert.deepStrictEqual(cache.keys(), [1, 2, 3, 4, 5]);
155+
assert.deepStrictEqual([...cache.keys()], [1, 2, 3, 4, 5]);
154156
cache.get(3);
155-
assert.deepStrictEqual(cache.keys(), [1, 2, 4, 5, 3]);
157+
assert.deepStrictEqual([...cache.keys()], [1, 2, 4, 5, 3]);
156158
cache.peek(4);
157-
assert.deepStrictEqual(cache.keys(), [1, 2, 4, 5, 3]);
159+
assert.deepStrictEqual([...cache.keys()], [1, 2, 4, 5, 3]);
158160
let values: number[] = [];
159161
[1, 2, 3, 4, 5].forEach(key => values.push(cache.get(key)!));
160162
assert.deepStrictEqual(values, [1, 2, 3, 4, 5]);
@@ -169,7 +171,7 @@ suite('Map', () => {
169171
assert.strictEqual(cache.size, 10);
170172
cache.limit = 5;
171173
assert.strictEqual(cache.size, 5);
172-
assert.deepStrictEqual(cache.keys(), [6, 7, 8, 9, 10]);
174+
assert.deepStrictEqual([...cache.keys()], [6, 7, 8, 9, 10]);
173175
cache.limit = 20;
174176
assert.strictEqual(cache.size, 5);
175177
for (let i = 11; i <= 20; i++) {
@@ -181,7 +183,7 @@ suite('Map', () => {
181183
values.push(cache.get(i)!);
182184
assert.strictEqual(cache.get(i), i);
183185
}
184-
assert.deepStrictEqual(cache.values(), values);
186+
assert.deepStrictEqual([...cache.values()], values);
185187
});
186188

187189
test('LinkedMap - LRU Cache limit with ratio', () => {
@@ -193,11 +195,11 @@ suite('Map', () => {
193195
assert.strictEqual(cache.size, 10);
194196
cache.set(11, 11);
195197
assert.strictEqual(cache.size, 5);
196-
assert.deepStrictEqual(cache.keys(), [7, 8, 9, 10, 11]);
198+
assert.deepStrictEqual([...cache.keys()], [7, 8, 9, 10, 11]);
197199
let values: number[] = [];
198-
cache.keys().forEach(key => values.push(cache.get(key)!));
200+
[...cache.keys()].forEach(key => values.push(cache.get(key)!));
199201
assert.deepStrictEqual(values, [7, 8, 9, 10, 11]);
200-
assert.deepStrictEqual(cache.values(), values);
202+
assert.deepStrictEqual([...cache.values()], values);
201203
});
202204

203205
test('LinkedMap - toJSON / fromJSON', () => {
@@ -237,7 +239,7 @@ suite('Map', () => {
237239
map.delete('1');
238240
assert.equal(map.get('1'), undefined);
239241
assert.equal(map.size, 0);
240-
assert.equal(map.keys().length, 0);
242+
assert.equal([...map.keys()].length, 0);
241243
});
242244

243245
test('LinkedMap - delete Head', function () {
@@ -251,8 +253,8 @@ suite('Map', () => {
251253
map.delete('1');
252254
assert.equal(map.get('2'), 2);
253255
assert.equal(map.size, 1);
254-
assert.equal(map.keys().length, 1);
255-
assert.equal(map.keys()[0], 2);
256+
assert.equal([...map.keys()].length, 1);
257+
assert.equal([...map.keys()][0], 2);
256258
});
257259

258260
test('LinkedMap - delete Tail', function () {
@@ -266,8 +268,8 @@ suite('Map', () => {
266268
map.delete('2');
267269
assert.equal(map.get('1'), 1);
268270
assert.equal(map.size, 1);
269-
assert.equal(map.keys().length, 1);
270-
assert.equal(map.keys()[0], 1);
271+
assert.equal([...map.keys()].length, 1);
272+
assert.equal([...map.keys()][0], 1);
271273
});
272274

273275

‎src/vs/workbench/browser/parts/editor/editorsObserver.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export class EditorsObserver extends Disposable {
4848
}
4949

5050
get editors(): IEditorIdentifier[] {
51-
return this.mostRecentEditorsMap.values();
51+
return [...this.mostRecentEditorsMap.values()];
5252
}
5353

5454
hasEditor(resource: URI): boolean {
@@ -283,7 +283,7 @@ export class EditorsObserver extends Disposable {
283283

284284
// Across all editor groups
285285
else {
286-
await this.doEnsureOpenedEditorsLimit(limit, this.mostRecentEditorsMap.values(), exclude);
286+
await this.doEnsureOpenedEditorsLimit(limit, [...this.mostRecentEditorsMap.values()], exclude);
287287
}
288288
}
289289

@@ -342,7 +342,7 @@ export class EditorsObserver extends Disposable {
342342
private serialize(): ISerializedEditorsList {
343343
const registry = Registry.as<IEditorInputFactoryRegistry>(Extensions.EditorInputFactories);
344344

345-
const entries = this.mostRecentEditorsMap.values();
345+
const entries = [...this.mostRecentEditorsMap.values()];
346346
const mapGroupToSerializableEditorsOfGroup = new Map<IEditorGroup, IEditorInput[]>();
347347

348348
return {

‎src/vs/workbench/contrib/tasks/browser/abstractTaskService.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -791,7 +791,7 @@ export abstract class AbstractTaskService extends Disposable implements ITaskSer
791791
if (quickOpenHistoryLimit === 0) {
792792
return;
793793
}
794-
let keys = this._recentlyUsedTasks.keys();
794+
let keys = [...this._recentlyUsedTasks.keys()];
795795
if (keys.length > quickOpenHistoryLimit) {
796796
keys = keys.slice(0, quickOpenHistoryLimit);
797797
}
@@ -2323,7 +2323,7 @@ export abstract class AbstractTaskService extends Disposable implements ITaskSer
23232323
taskMap[key] = task;
23242324
}
23252325
});
2326-
const reversed = recentlyUsedTasks.keys().reverse();
2326+
const reversed = [...recentlyUsedTasks.keys()].reverse();
23272327
for (const key in reversed) {
23282328
let task = taskMap[key];
23292329
if (task) {

0 commit comments

Comments
 (0)