forked from microsoft/vscode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathprogress.ts
More file actions
227 lines (186 loc) · 6.5 KB
/
progress.ts
File metadata and controls
227 lines (186 loc) · 6.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { IAction } from 'vs/base/common/actions';
import { DeferredPromise } from 'vs/base/common/async';
import { CancellationToken, CancellationTokenSource } from 'vs/base/common/cancellation';
import { Disposable, DisposableStore, toDisposable } from 'vs/base/common/lifecycle';
import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
export const IProgressService = createDecorator<IProgressService>('progressService');
/**
* A progress service that can be used to report progress to various locations of the UI.
*/
export interface IProgressService {
readonly _serviceBrand: undefined;
withProgress<R>(
options: IProgressOptions | IProgressDialogOptions | IProgressNotificationOptions | IProgressWindowOptions | IProgressCompositeOptions,
task: (progress: IProgress<IProgressStep>) => Promise<R>,
onDidCancel?: (choice?: number) => void
): Promise<R>;
}
export interface IProgressIndicator {
/**
* Show progress customized with the provided flags.
*/
show(infinite: true, delay?: number): IProgressRunner;
show(total: number, delay?: number): IProgressRunner;
/**
* Indicate progress for the duration of the provided promise. Progress will stop in
* any case of promise completion, error or cancellation.
*/
showWhile(promise: Promise<unknown>, delay?: number): Promise<void>;
}
export const enum ProgressLocation {
Explorer = 1,
Scm = 3,
Extensions = 5,
Window = 10,
Notification = 15,
Dialog = 20
}
export interface IProgressOptions {
readonly location: ProgressLocation | string;
readonly title?: string;
readonly source?: string | { label: string; id: string };
readonly total?: number;
readonly cancellable?: boolean;
readonly buttons?: string[];
}
export interface IProgressNotificationOptions extends IProgressOptions {
readonly location: ProgressLocation.Notification;
readonly primaryActions?: readonly IAction[];
readonly secondaryActions?: readonly IAction[];
readonly delay?: number;
readonly silent?: boolean;
readonly type?: 'syncing' | 'loading';
}
export interface IProgressDialogOptions extends IProgressOptions {
readonly delay?: number;
readonly detail?: string;
readonly sticky?: boolean;
}
export interface IProgressWindowOptions extends IProgressOptions {
readonly location: ProgressLocation.Window;
readonly command?: string;
readonly type?: 'syncing' | 'loading';
}
export interface IProgressCompositeOptions extends IProgressOptions {
readonly location: ProgressLocation.Explorer | ProgressLocation.Extensions | ProgressLocation.Scm | string;
readonly delay?: number;
}
export interface IProgressStep {
message?: string;
increment?: number;
total?: number;
}
export interface IProgressRunner {
total(value: number): void;
worked(value: number): void;
done(): void;
}
export const emptyProgressRunner = Object.freeze<IProgressRunner>({
total() { },
worked() { },
done() { }
});
export interface IProgress<T> {
report(item: T): void;
}
export class Progress<T> implements IProgress<T> {
static readonly None = Object.freeze<IProgress<unknown>>({ report() { } });
private _value?: T;
get value(): T | undefined { return this._value; }
constructor(private callback: (data: T) => void) { }
report(item: T) {
this._value = item;
this.callback(this._value);
}
}
/**
* A helper to show progress during a long running operation. If the operation
* is started multiple times, only the last invocation will drive the progress.
*/
export interface IOperation {
id: number;
isCurrent: () => boolean;
token: CancellationToken;
stop(): void;
}
/**
* RAII-style progress instance that allows imperative reporting and hides
* once `dispose()` is called.
*/
export class UnmanagedProgress extends Disposable {
private readonly deferred = new DeferredPromise<void>();
private reporter?: IProgress<IProgressStep>;
private lastStep?: IProgressStep;
constructor(
options: IProgressOptions | IProgressDialogOptions | IProgressNotificationOptions | IProgressWindowOptions | IProgressCompositeOptions,
@IProgressService progressService: IProgressService,
) {
super();
progressService.withProgress(options, reporter => {
this.reporter = reporter;
if (this.lastStep) {
reporter.report(this.lastStep);
}
return this.deferred.p;
});
this._register(toDisposable(() => this.deferred.complete()));
}
report(step: IProgressStep) {
if (this.reporter) {
this.reporter.report(step);
} else {
this.lastStep = step;
}
}
}
export class LongRunningOperation extends Disposable {
private currentOperationId = 0;
private readonly currentOperationDisposables = this._register(new DisposableStore());
private currentProgressRunner: IProgressRunner | undefined;
private currentProgressTimeout: any;
constructor(
private progressIndicator: IProgressIndicator
) {
super();
}
start(progressDelay: number): IOperation {
// Stop any previous operation
this.stop();
// Start new
const newOperationId = ++this.currentOperationId;
const newOperationToken = new CancellationTokenSource();
this.currentProgressTimeout = setTimeout(() => {
if (newOperationId === this.currentOperationId) {
this.currentProgressRunner = this.progressIndicator.show(true);
}
}, progressDelay);
this.currentOperationDisposables.add(toDisposable(() => clearTimeout(this.currentProgressTimeout)));
this.currentOperationDisposables.add(toDisposable(() => newOperationToken.cancel()));
this.currentOperationDisposables.add(toDisposable(() => this.currentProgressRunner ? this.currentProgressRunner.done() : undefined));
return {
id: newOperationId,
token: newOperationToken.token,
stop: () => this.doStop(newOperationId),
isCurrent: () => this.currentOperationId === newOperationId
};
}
stop(): void {
this.doStop(this.currentOperationId);
}
private doStop(operationId: number): void {
if (this.currentOperationId === operationId) {
this.currentOperationDisposables.clear();
}
}
}
export const IEditorProgressService = createDecorator<IEditorProgressService>('editorProgressService');
/**
* A progress service that will report progress local to the editor triggered from.
*/
export interface IEditorProgressService extends IProgressIndicator {
readonly _serviceBrand: undefined;
}