Skip to content

Commit 029009e

Browse files
committed
Marking most private emitters as readonly
Emitters should generally not be reassigned as their corresponding event would also be lost. Marking these as readonly just to enforce this
1 parent e8b2096 commit 029009e

68 files changed

Lines changed: 179 additions & 179 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/vs/base/browser/ui/grid/gridview.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,12 +188,12 @@ class BranchNode implements ISplitView, IDisposable {
188188
return this.orientation === Orientation.HORIZONTAL ? this.maximumSize : this.maximumOrthogonalSize;
189189
}
190190

191-
private _onDidChange = new Emitter<number | undefined>();
191+
private readonly _onDidChange = new Emitter<number | undefined>();
192192
readonly onDidChange: Event<number | undefined> = this._onDidChange.event;
193193

194194
private childrenChangeDisposable: IDisposable = Disposable.None;
195195

196-
private _onDidSashReset = new Emitter<number[]>();
196+
private readonly _onDidSashReset = new Emitter<number[]>();
197197
readonly onDidSashReset: Event<number[]> = this._onDidSashReset.event;
198198
private splitviewSashResetDisposable: IDisposable = Disposable.None;
199199
private childrenSashResetDisposable: IDisposable = Disposable.None;
@@ -539,7 +539,7 @@ class LeafNode implements ISplitView, IDisposable {
539539
this._onDidSetLinkedNode.fire(undefined);
540540
}
541541

542-
private _onDidSetLinkedNode = new Emitter<number | undefined>();
542+
private readonly _onDidSetLinkedNode = new Emitter<number | undefined>();
543543
private _onDidViewChange: Event<number | undefined>;
544544
readonly onDidChange: Event<number | undefined>;
545545

src/vs/base/browser/ui/list/listView.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ export class ListView<T> implements ISpliceable<T>, IDisposable {
190190

191191
private readonly disposables: DisposableStore = new DisposableStore();
192192

193-
private _onDidChangeContentHeight = new Emitter<number>();
193+
private readonly _onDidChangeContentHeight = new Emitter<number>();
194194
readonly onDidChangeContentHeight: Event<number> = Event.latch(this._onDidChangeContentHeight.event);
195195
get contentHeight(): number { return this.rangeMap.size; }
196196

src/vs/base/browser/ui/list/listWidget.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ class Trait<T> implements ISpliceable<boolean>, IDisposable {
110110
private indexes: number[] = [];
111111
private sortedIndexes: number[] = [];
112112

113-
private _onChange = new Emitter<ITraitChangeEvent>();
113+
private readonly _onChange = new Emitter<ITraitChangeEvent>();
114114
readonly onChange: Event<ITraitChangeEvent> = this._onChange.event;
115115

116116
get trait(): string { return this._trait; }
@@ -176,7 +176,7 @@ class Trait<T> implements ISpliceable<boolean>, IDisposable {
176176
}
177177

178178
dispose() {
179-
this._onChange = dispose(this._onChange);
179+
dispose(this._onChange);
180180
}
181181
}
182182

@@ -1111,10 +1111,10 @@ export class List<T> implements ISpliceable<T>, IDisposable {
11111111
return Event.map(this.eventBufferer.wrapEvent(this.selection.onChange), e => this.toListEvent(e));
11121112
}
11131113

1114-
private _onDidOpen = new Emitter<IListEvent<T>>();
1114+
private readonly _onDidOpen = new Emitter<IListEvent<T>>();
11151115
readonly onDidOpen: Event<IListEvent<T>> = this._onDidOpen.event;
11161116

1117-
private _onDidPin = new Emitter<IListEvent<T>>();
1117+
private readonly _onDidPin = new Emitter<IListEvent<T>>();
11181118
readonly onDidPin: Event<IListEvent<T>> = this._onDidPin.event;
11191119

11201120
get domId(): string { return this.view.domId; }
@@ -1168,7 +1168,7 @@ export class List<T> implements ISpliceable<T>, IDisposable {
11681168
readonly onDidFocus: Event<void>;
11691169
readonly onDidBlur: Event<void>;
11701170

1171-
private _onDidDispose = new Emitter<void>();
1171+
private readonly _onDidDispose = new Emitter<void>();
11721172
readonly onDidDispose: Event<void> = this._onDidDispose.event;
11731173

11741174
constructor(

src/vs/base/browser/ui/tree/abstractTree.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ class TypeFilterController<T, TFilterData> implements IDisposable {
567567
private _empty: boolean = false;
568568
get empty(): boolean { return this._empty; }
569569

570-
private _onDidChangeEmptyState = new Emitter<boolean>();
570+
private readonly _onDidChangeEmptyState = new Emitter<boolean>();
571571
readonly onDidChangeEmptyState: Event<boolean> = Event.latch(this._onDidChangeEmptyState.event);
572572

573573
private positionClassName = 'ne';
@@ -581,7 +581,7 @@ class TypeFilterController<T, TFilterData> implements IDisposable {
581581
private automaticKeyboardNavigation = true;
582582
private triggered = false;
583583

584-
private _onDidChangePattern = new Emitter<string>();
584+
private readonly _onDidChangePattern = new Emitter<string>();
585585
readonly onDidChangePattern = this._onDidChangePattern.event;
586586

587587
private enabledDisposables: IDisposable[] = [];
@@ -934,7 +934,7 @@ class Trait<T> {
934934
private nodes: ITreeNode<T, any>[] = [];
935935
private elements: T[] | undefined;
936936

937-
private _onDidChange = new Emitter<ITreeEvent<T>>();
937+
private readonly _onDidChange = new Emitter<ITreeEvent<T>>();
938938
readonly onDidChange = this._onDidChange.event;
939939

940940
private _nodeSet: Set<ITreeNode<T, any>> | undefined;
@@ -1204,7 +1204,7 @@ export abstract class AbstractTree<T, TFilterData, TRef> implements IDisposable
12041204
get onDidChangeCollapseState(): Event<ICollapseStateChangeEvent<T, TFilterData>> { return this.model.onDidChangeCollapseState; }
12051205
get onDidChangeRenderNodeCount(): Event<ITreeNode<T, TFilterData>> { return this.model.onDidChangeRenderNodeCount; }
12061206

1207-
private _onWillRefilter = new Emitter<void>();
1207+
private readonly _onWillRefilter = new Emitter<void>();
12081208
readonly onWillRefilter: Event<void> = this._onWillRefilter.event;
12091209

12101210
get filterOnType(): boolean { return !!this._options.filterOnType; }
@@ -1213,7 +1213,7 @@ export abstract class AbstractTree<T, TFilterData, TRef> implements IDisposable
12131213
get openOnSingleClick(): boolean { return typeof this._options.openOnSingleClick === 'undefined' ? true : this._options.openOnSingleClick; }
12141214
get expandOnlyOnTwistieClick(): boolean | ((e: T) => boolean) { return typeof this._options.expandOnlyOnTwistieClick === 'undefined' ? false : this._options.expandOnlyOnTwistieClick; }
12151215

1216-
private _onDidUpdateOptions = new Emitter<IAbstractTreeOptions<T, TFilterData>>();
1216+
private readonly _onDidUpdateOptions = new Emitter<IAbstractTreeOptions<T, TFilterData>>();
12171217
readonly onDidUpdateOptions: Event<IAbstractTreeOptions<T, TFilterData>> = this._onDidUpdateOptions.event;
12181218

12191219
get onDidDispose(): Event<void> { return this.view.onDidDispose; }

src/vs/base/browser/ui/tree/indexTreeModel.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,17 +62,17 @@ export class IndexTreeModel<T extends Exclude<any, undefined>, TFilterData = voi
6262
private root: IIndexTreeNode<T, TFilterData>;
6363
private eventBufferer = new EventBufferer();
6464

65-
private _onDidChangeCollapseState = new Emitter<ICollapseStateChangeEvent<T, TFilterData>>();
65+
private readonly _onDidChangeCollapseState = new Emitter<ICollapseStateChangeEvent<T, TFilterData>>();
6666
readonly onDidChangeCollapseState: Event<ICollapseStateChangeEvent<T, TFilterData>> = this.eventBufferer.wrapEvent(this._onDidChangeCollapseState.event);
6767

68-
private _onDidChangeRenderNodeCount = new Emitter<ITreeNode<T, TFilterData>>();
68+
private readonly _onDidChangeRenderNodeCount = new Emitter<ITreeNode<T, TFilterData>>();
6969
readonly onDidChangeRenderNodeCount: Event<ITreeNode<T, TFilterData>> = this.eventBufferer.wrapEvent(this._onDidChangeRenderNodeCount.event);
7070

7171
private collapseByDefault: boolean;
7272
private filter?: ITreeFilter<T, TFilterData>;
7373
private autoExpandSingleChildren: boolean;
7474

75-
private _onDidSplice = new Emitter<ITreeModelSpliceEvent<T, TFilterData>>();
75+
private readonly _onDidSplice = new Emitter<ITreeModelSpliceEvent<T, TFilterData>>();
7676
readonly onDidSplice = this._onDidSplice.event;
7777

7878
constructor(

src/vs/base/common/event.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,7 @@ class LeakageMonitor {
451451
* Sample:
452452
class Document {
453453
454-
private _onDidChange = new Emitter<(value:string)=>any>();
454+
private readonly _onDidChange = new Emitter<(value:string)=>any>();
455455
456456
public onDidChange = this._onDidChange.event;
457457
@@ -808,7 +808,7 @@ export class Relay<T> implements IDisposable {
808808
private inputEvent: Event<T> = Event.None;
809809
private inputEventListener: IDisposable = Disposable.None;
810810

811-
private emitter = new Emitter<T>({
811+
private readonly emitter = new Emitter<T>({
812812
onFirstListenerDidAdd: () => {
813813
this.listening = true;
814814
this.inputEventListener = this.inputEvent(this.emitter.fire, this.emitter);

src/vs/base/common/sequence.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ export class Sequence<T> implements ISequence<T>, ISpliceable<T> {
2424

2525
readonly elements: T[] = [];
2626

27-
private _onDidSplice = new Emitter<ISplice<T>>();
27+
private readonly _onDidSplice = new Emitter<ISplice<T>>();
2828
readonly onDidSplice: Event<ISplice<T>> = this._onDidSplice.event;
2929

3030
splice(start: number, deleteCount: number, toInsert: T[] = []): void {
3131
this.elements.splice(start, deleteCount, ...toInsert);
3232
this._onDidSplice.fire({ start, deleteCount, toInsert });
3333
}
34-
}
34+
}

src/vs/base/parts/ipc/common/ipc.net.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -351,10 +351,10 @@ export class Protocol extends Disposable implements IMessagePassingProtocol {
351351
private _socketWriter: ProtocolWriter;
352352
private _socketReader: ProtocolReader;
353353

354-
private _onMessage = new Emitter<VSBuffer>();
354+
private readonly _onMessage = new Emitter<VSBuffer>();
355355
readonly onMessage: Event<VSBuffer> = this._onMessage.event;
356356

357-
private _onClose = new Emitter<void>();
357+
private readonly _onClose = new Emitter<void>();
358358
readonly onClose: Event<void> = this._onClose.event;
359359

360360
constructor(socket: ISocket) {

src/vs/base/parts/ipc/common/ipc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@ export class ChannelClient implements IChannelClient, IDisposable {
442442
private lastRequestId: number = 0;
443443
private protocolListener: IDisposable | null;
444444

445-
private _onDidInitialize = new Emitter<void>();
445+
private readonly _onDidInitialize = new Emitter<void>();
446446
readonly onDidInitialize = this._onDidInitialize.event;
447447

448448
constructor(private protocol: IMessagePassingProtocol) {
@@ -660,7 +660,7 @@ export class IPCServer<TContext = string> implements IChannelServer<TContext>, I
660660
private channels = new Map<string, IServerChannel<TContext>>();
661661
private _connections = new Set<Connection<TContext>>();
662662

663-
private _onDidChangeConnections = new Emitter<Connection<TContext>>();
663+
private readonly _onDidChangeConnections = new Emitter<Connection<TContext>>();
664664
readonly onDidChangeConnections: Event<Connection<TContext>> = this._onDidChangeConnections.event;
665665

666666
get connections(): Connection<TContext>[] {

src/vs/base/parts/ipc/node/ipc.cp.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ export class Client implements IChannelClient, IDisposable {
9292
private _client: IPCClient | null;
9393
private channels = new Map<string, IChannel>();
9494

95-
private _onDidProcessExit = new Emitter<{ code: number, signal: string }>();
95+
private readonly _onDidProcessExit = new Emitter<{ code: number, signal: string }>();
9696
readonly onDidProcessExit = this._onDidProcessExit.event;
9797

9898
constructor(private modulePath: string, private options: IIPCOptions) {

0 commit comments

Comments
 (0)