extHost.protocol.ts 67.9 KB
Newer Older
1 2 3 4 5
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

6
import { VSBuffer } from 'vs/base/common/buffer';
A
Alex Dima 已提交
7
import { CancellationToken } from 'vs/base/common/cancellation';
8
import { IRemoteConsoleLog } from 'vs/base/common/console';
R
Rob Lourens 已提交
9
import { SerializedError } from 'vs/base/common/errors';
10 11
import { IRelativePattern } from 'vs/base/common/glob';
import { IMarkdownString } from 'vs/base/common/htmlContent';
R
Rob Lourens 已提交
12
import { IDisposable } from 'vs/base/common/lifecycle';
13
import Severity from 'vs/base/common/severity';
14
import { URI, UriComponents } from 'vs/base/common/uri';
15
import { RenderLineNumbersType, TextEditorCursorStyle } from 'vs/editor/common/config/editorOptions';
16 17
import { IPosition } from 'vs/editor/common/core/position';
import { IRange } from 'vs/editor/common/core/range';
18
import { ISelection, Selection } from 'vs/editor/common/core/selection';
R
Rob Lourens 已提交
19
import * as editorCommon from 'vs/editor/common/editorCommon';
20
import { EndOfLineSequence, ISingleEditOperation } from 'vs/editor/common/model';
R
Rob Lourens 已提交
21 22 23
import { IModelChangedEvent } from 'vs/editor/common/model/mirrorTextModel';
import * as modes from 'vs/editor/common/modes';
import { CharacterPair, CommentRule, EnterAction } from 'vs/editor/common/modes/languageConfiguration';
24
import { ICommandHandlerDescription } from 'vs/platform/commands/common/commands';
25
import { ConfigurationTarget, IConfigurationData, IConfigurationChange, IConfigurationOverrides } from 'vs/platform/configuration/common/configuration';
R
Rob Lourens 已提交
26
import { ConfigurationScope } from 'vs/platform/configuration/common/configurationRegistry';
27
import { ExtensionIdentifier, IExtensionDescription } from 'vs/platform/extensions/common/extensions';
J
Johannes Rieken 已提交
28
import * as files from 'vs/platform/files/common/files';
29
import { ResourceLabelFormatter } from 'vs/platform/label/common/label';
S
Sandeep Somavarapu 已提交
30
import { LogLevel } from 'vs/platform/log/common/log';
R
Rob Lourens 已提交
31
import { IMarkerData } from 'vs/platform/markers/common/markers';
32
import { IProgressOptions, IProgressStep } from 'vs/platform/progress/common/progress';
J
Johannes Rieken 已提交
33
import * as quickInput from 'vs/platform/quickinput/common/quickInput';
34
import { RemoteAuthorityResolverErrorCode, ResolverResult, TunnelDescription } from 'vs/platform/remote/common/remoteAuthorityResolver';
35
import * as statusbar from 'vs/workbench/services/statusbar/common/statusbar';
36
import { ClassifiedEvent, GDPRClassification, StrictPropertyCheck } from 'vs/platform/telemetry/common/gdprTypings';
R
Rob Lourens 已提交
37 38
import { ITelemetryInfo } from 'vs/platform/telemetry/common/telemetry';
import { ThemeColor } from 'vs/platform/theme/common/themeService';
39 40
import { EditorViewColumn } from 'vs/workbench/api/common/shared/editor';
import * as tasks from 'vs/workbench/api/common/shared/tasks';
41
import { IRevealOptions, ITreeItem } from 'vs/workbench/common/views';
42
import { IAdapterDescriptor, IConfig, IDebugSessionReplMode } from 'vs/workbench/contrib/debug/common/debug';
43
import { ITextQueryBuilderOptions } from 'vs/workbench/contrib/search/common/queryBuilder';
44
import { ITerminalDimensions, IShellLaunchConfig } from 'vs/workbench/contrib/terminal/common/terminal';
45
import { ExtensionActivationError } from 'vs/workbench/services/extensions/common/extensions';
46 47
import { createExtHostContextProxyIdentifier as createExtId, createMainContextProxyIdentifier as createMainId, IRPCProtocol } from 'vs/workbench/services/extensions/common/proxyIdentifier';
import * as search from 'vs/workbench/services/search/common/search';
48
import { SaveReason } from 'vs/workbench/common/editor';
49
import { ExtensionActivationReason } from 'vs/workbench/api/common/extHostExtensionActivator';
A
Alex Ross 已提交
50 51
import { TunnelDto } from 'vs/workbench/api/common/extHostTunnelService';
import { TunnelOptions } from 'vs/platform/remote/common/tunnel';
E
Eric Amodio 已提交
52
import { Timeline, TimelineChangeEvent, TimelineCursor, TimelineProviderDescriptor } from 'vs/workbench/contrib/timeline/common/timeline';
53
import { revive } from 'vs/base/common/marshalling';
J
Johannes Rieken 已提交
54 55
import { CallHierarchyItem } from 'vs/workbench/contrib/callHierarchy/common/callHierarchy';
import { Serialized } from 'vs/base/common/types';
S
Sandeep Somavarapu 已提交
56

57
export interface IEnvironment {
58
	isExtensionDevelopmentDebug: boolean;
59
	appName: string;
60
	appRoot?: URI;
61 62
	appLanguage: string;
	appUriScheme: string;
63
	appSettingsHome?: URI;
64
	extensionDevelopmentLocationURI?: URI[];
65
	extensionTestsLocationURI?: URI;
A
Alex Dima 已提交
66
	globalStorageHome: URI;
D
Daniel Imms 已提交
67
	userHome: URI;
M
Matt Bierner 已提交
68
	webviewResourceRoot: string;
69
	webviewCspSource: string;
70 71
}

72
export interface IStaticWorkspaceData {
73
	id: string;
74
	name: string;
A
Alex Dima 已提交
75
	configuration?: UriComponents | null;
76
	isUntitled?: boolean | null;
77 78
}

79
export interface IWorkspaceData extends IStaticWorkspaceData {
80
	folders: { uri: UriComponents, name: string, index: number; }[];
81 82
}

83
export interface IInitData {
84
	version: string;
85
	commit?: string;
86 87
	parentPid: number;
	environment: IEnvironment;
A
Alex Dima 已提交
88
	workspace?: IStaticWorkspaceData | null;
A
Alex Dima 已提交
89
	resolvedExtensions: ExtensionIdentifier[];
90
	hostExtensions: ExtensionIdentifier[];
91
	extensions: IExtensionDescription[];
92
	telemetryInfo: ITelemetryInfo;
S
Sandeep Somavarapu 已提交
93
	logLevel: LogLevel;
94
	logsLocation: URI;
95
	logFile: URI;
A
Alex Dima 已提交
96
	autoStart: boolean;
97
	remote: { isRemote: boolean; authority: string | undefined; };
98
	uiKind: UIKind;
99 100
}

S
Sandeep Somavarapu 已提交
101
export interface IConfigurationInitData extends IConfigurationData {
S
Sandeep Somavarapu 已提交
102
	configurationScopes: [string, ConfigurationScope | undefined][];
S
Sandeep Somavarapu 已提交
103 104
}

A
Alex Dima 已提交
105
export interface IExtHostContext extends IRPCProtocol {
A
Alex Dima 已提交
106
	remoteAuthority: string;
107 108
}

A
Alex Dima 已提交
109
export interface IMainContext extends IRPCProtocol {
110 111
}

112 113 114 115 116
export enum UIKind {
	Desktop = 1,
	Web = 2
}

117 118
// --- main thread

119 120 121 122 123
export interface MainThreadClipboardShape extends IDisposable {
	$readText(): Promise<string>;
	$writeText(value: string): Promise<void>;
}

124
export interface MainThreadCommandsShape extends IDisposable {
125 126
	$registerCommand(id: string): void;
	$unregisterCommand(id: string): void;
127
	$executeCommand<T>(id: string, args: any[], retry: boolean): Promise<T | undefined>;
J
Johannes Rieken 已提交
128
	$getCommands(): Promise<string[]>;
129 130
}

R
rebornix 已提交
131
export interface CommentProviderFeatures {
P
Peng Lyu 已提交
132
	reactionGroup?: modes.CommentReaction[];
P
Peng Lyu 已提交
133
	reactionHandler?: boolean;
R
rebornix 已提交
134 135
}

136 137 138 139 140
export type CommentThreadChanges = Partial<{
	range: IRange,
	label: string,
	contextValue: string,
	comments: modes.Comment[],
141
	collapseState: modes.CommentThreadCollapsibleState;
142 143
}>;

M
Matt Bierner 已提交
144
export interface MainThreadCommentsShape extends IDisposable {
P
Peng Lyu 已提交
145
	$registerCommentController(handle: number, id: string, label: string): void;
146
	$unregisterCommentController(handle: number): void;
P
Peng Lyu 已提交
147
	$updateCommentControllerFeatures(handle: number, features: CommentProviderFeatures): void;
148
	$createCommentThread(handle: number, commentThreadHandle: number, threadId: string, resource: UriComponents, range: IRange, extensionId: ExtensionIdentifier): modes.CommentThread | undefined;
149
	$updateCommentThread(handle: number, commentThreadHandle: number, threadId: string, resource: UriComponents, changes: CommentThreadChanges): void;
P
Peng Lyu 已提交
150
	$deleteCommentThread(handle: number, commentThreadHandle: number): void;
151
	$onDidCommentThreadsChange(handle: number, event: modes.CommentThreadChangedEvent): void;
M
Matt Bierner 已提交
152 153
}

154
export interface MainThreadAuthenticationShape extends IDisposable {
155
	$registerAuthenticationProvider(id: string, displayName: string): void;
156 157
	$unregisterAuthenticationProvider(id: string): void;
	$onDidChangeSessions(id: string): void;
158 159
	$getSessionsPrompt(providerId: string, providerName: string, extensionId: string, extensionName: string): Promise<boolean>;
	$loginPrompt(providerId: string, providerName: string, extensionId: string, extensionName: string): Promise<boolean>;
160 161
}

162
export interface MainThreadConfigurationShape extends IDisposable {
S
Sandeep Somavarapu 已提交
163 164
	$updateConfigurationOption(target: ConfigurationTarget | null, key: string, value: any, overrides: IConfigurationOverrides | undefined, scopeToLanguage: boolean | undefined): Promise<void>;
	$removeConfigurationOption(target: ConfigurationTarget | null, key: string, overrides: IConfigurationOverrides | undefined, scopeToLanguage: boolean | undefined): Promise<void>;
165 166
}

167
export interface MainThreadDiagnosticsShape extends IDisposable {
168
	$changeMany(owner: string, entries: [UriComponents, IMarkerData[] | undefined][]): void;
169
	$clear(owner: string): void;
170 171
}

172
export interface MainThreadDialogOpenOptions {
173
	defaultUri?: UriComponents;
174
	openLabel?: string;
175 176 177
	canSelectFiles?: boolean;
	canSelectFolders?: boolean;
	canSelectMany?: boolean;
178
	filters?: { [name: string]: string[]; };
179
	title?: string;
180 181
}

182
export interface MainThreadDialogSaveOptions {
183
	defaultUri?: UriComponents;
184
	saveLabel?: string;
185
	filters?: { [name: string]: string[]; };
186
	title?: string;
187 188
}

189
export interface MainThreadDiaglogsShape extends IDisposable {
190 191
	$showOpenDialog(options: MainThreadDialogOpenOptions): Promise<UriComponents[] | undefined>;
	$showSaveDialog(options: MainThreadDialogSaveOptions): Promise<UriComponents | undefined>;
192 193
}

194 195 196
export interface MainThreadDecorationsShape extends IDisposable {
	$registerDecorationProvider(handle: number, label: string): void;
	$unregisterDecorationProvider(handle: number): void;
197
	$onDidChange(handle: number, resources: UriComponents[] | null): void;
198 199
}

200
export interface MainThreadDocumentContentProvidersShape extends IDisposable {
201 202
	$registerTextContentProvider(handle: number, scheme: string): void;
	$unregisterTextContentProvider(handle: number): void;
203
	$onVirtualDocumentChange(uri: UriComponents, value: string): void;
204 205
}

206
export interface MainThreadDocumentsShape extends IDisposable {
J
Johannes Rieken 已提交
207 208 209
	$tryCreateDocument(options?: { language?: string; content?: string; }): Promise<UriComponents>;
	$tryOpenDocument(uri: UriComponents): Promise<void>;
	$trySaveDocument(uri: UriComponents): Promise<boolean>;
210 211
}

212 213
export interface ITextEditorConfigurationUpdate {
	tabSize?: number | 'auto';
A
Alex Dima 已提交
214
	indentSize?: number | 'tabSize';
215 216
	insertSpaces?: boolean | 'auto';
	cursorStyle?: TextEditorCursorStyle;
217
	lineNumbers?: RenderLineNumbersType;
218 219 220 221
}

export interface IResolvedTextEditorConfiguration {
	tabSize: number;
D
David Lechner 已提交
222
	indentSize: number;
223 224
	insertSpaces: boolean;
	cursorStyle: TextEditorCursorStyle;
225
	lineNumbers: RenderLineNumbersType;
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
}

export enum TextEditorRevealType {
	Default = 0,
	InCenter = 1,
	InCenterIfOutsideViewport = 2,
	AtTop = 3
}

export interface IUndoStopOptions {
	undoStopBefore: boolean;
	undoStopAfter: boolean;
}

export interface IApplyEditsOptions extends IUndoStopOptions {
J
Johannes Rieken 已提交
241
	setEndOfLine?: EndOfLineSequence;
242 243
}

244
export interface ITextDocumentShowOptions {
245
	position?: EditorViewColumn;
246 247
	preserveFocus?: boolean;
	pinned?: boolean;
248
	selection?: IRange;
249 250
}

251
export interface MainThreadTextEditorsShape extends IDisposable {
252
	$tryShowTextDocument(resource: UriComponents, options: ITextDocumentShowOptions): Promise<string | undefined>;
253 254
	$registerTextEditorDecorationType(key: string, options: editorCommon.IDecorationRenderOptions): void;
	$removeTextEditorDecorationType(key: string): void;
J
Johannes Rieken 已提交
255 256 257 258 259 260 261 262
	$tryShowEditor(id: string, position: EditorViewColumn): Promise<void>;
	$tryHideEditor(id: string): Promise<void>;
	$trySetOptions(id: string, options: ITextEditorConfigurationUpdate): Promise<void>;
	$trySetDecorations(id: string, key: string, ranges: editorCommon.IDecorationOptions[]): Promise<void>;
	$trySetDecorationsFast(id: string, key: string, ranges: number[]): Promise<void>;
	$tryRevealRange(id: string, range: IRange, revealType: TextEditorRevealType): Promise<void>;
	$trySetSelections(id: string, selections: ISelection[]): Promise<void>;
	$tryApplyEdits(id: string, modelVersionId: number, edits: ISingleEditOperation[], opts: IApplyEditsOptions): Promise<boolean>;
J
Johannes Rieken 已提交
263
	$tryApplyWorkspaceEdit(workspaceEditDto: IWorkspaceEditDto): Promise<boolean>;
M
Matt Bierner 已提交
264
	$tryInsertSnippet(id: string, template: string, selections: readonly IRange[], opts: IUndoStopOptions): Promise<boolean>;
J
Johannes Rieken 已提交
265
	$getDiffInformation(id: string): Promise<editorCommon.ILineChange[]>;
266 267
}

268
export interface MainThreadTreeViewsShape extends IDisposable {
269 270
	$registerTreeViewDataProvider(treeViewId: string, options: { showCollapseAll: boolean, canSelectMany: boolean; }): void;
	$refresh(treeViewId: string, itemsToRefresh?: { [treeItemHandle: string]: ITreeItem; }): Promise<void>;
J
Johannes Rieken 已提交
271
	$reveal(treeViewId: string, treeItem: ITreeItem, parentChain: ITreeItem[], options: IRevealOptions): Promise<void>;
272
	$setMessage(treeViewId: string, message: string): void;
273
	$setTitle(treeViewId: string, title: string): void;
274 275
}

276 277 278 279
export interface MainThreadDownloadServiceShape extends IDisposable {
	$download(uri: UriComponents, to: UriComponents): Promise<void>;
}

280
export interface MainThreadErrorsShape extends IDisposable {
281
	$onUnexpectedError(err: any | SerializedError): void;
282 283
}

284
export interface MainThreadConsoleShape extends IDisposable {
285
	$logExtensionHostMessage(msg: IRemoteConsoleLog): void;
286 287
}

A
Alex Dima 已提交
288 289 290 291 292
export interface MainThreadKeytarShape extends IDisposable {
	$getPassword(service: string, account: string): Promise<string | null>;
	$setPassword(service: string, account: string, password: string): Promise<void>;
	$deletePassword(service: string, account: string): Promise<boolean>;
	$findPassword(service: string): Promise<string | null>;
293
	$findCredentials(service: string): Promise<Array<{ account: string, password: string; }>>;
A
Alex Dima 已提交
294 295
}

J
Johannes Rieken 已提交
296
export interface IRegExpDto {
297 298 299
	pattern: string;
	flags?: string;
}
J
Johannes Rieken 已提交
300 301 302 303 304
export interface IIndentationRuleDto {
	decreaseIndentPattern: IRegExpDto;
	increaseIndentPattern: IRegExpDto;
	indentNextLinePattern?: IRegExpDto;
	unIndentedLinePattern?: IRegExpDto;
305
}
J
Johannes Rieken 已提交
306 307 308 309
export interface IOnEnterRuleDto {
	beforeText: IRegExpDto;
	afterText?: IRegExpDto;
	oneLineAboveText?: IRegExpDto;
310 311
	action: EnterAction;
}
J
Johannes Rieken 已提交
312
export interface ILanguageConfigurationDto {
313 314
	comments?: CommentRule;
	brackets?: CharacterPair[];
J
Johannes Rieken 已提交
315 316 317
	wordPattern?: IRegExpDto;
	indentationRules?: IIndentationRuleDto;
	onEnterRules?: IOnEnterRuleDto[];
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
	__electricCharacterSupport?: {
		brackets?: any;
		docComment?: {
			scope: string;
			open: string;
			lineStart: string;
			close?: string;
		};
	};
	__characterPairSupport?: {
		autoClosingPairs: {
			open: string;
			close: string;
			notIn?: string[];
		}[];
	};
}

336
export type GlobPattern = string | { base: string; pattern: string; };
337

J
Johannes Rieken 已提交
338
export interface IDocumentFilterDto {
A
Alex Dima 已提交
339 340 341
	$serialized: true;
	language?: string;
	scheme?: string;
342
	pattern?: string | IRelativePattern;
343
	exclusive?: boolean;
A
Alex Dima 已提交
344 345
}

J
Johannes Rieken 已提交
346
export interface ISignatureHelpProviderMetadataDto {
347 348
	readonly triggerCharacters: readonly string[];
	readonly retriggerCharacters: readonly string[];
349 350
}

351
export interface MainThreadLanguageFeaturesShape extends IDisposable {
352
	$unregister(handle: number): void;
J
Johannes Rieken 已提交
353 354
	$registerDocumentSymbolProvider(handle: number, selector: IDocumentFilterDto[], label: string): void;
	$registerCodeLensSupport(handle: number, selector: IDocumentFilterDto[], eventHandle: number | undefined): void;
355
	$emitCodeLensEvent(eventHandle: number, event?: any): void;
J
Johannes Rieken 已提交
356 357 358 359 360
	$registerDefinitionSupport(handle: number, selector: IDocumentFilterDto[]): void;
	$registerDeclarationSupport(handle: number, selector: IDocumentFilterDto[]): void;
	$registerImplementationSupport(handle: number, selector: IDocumentFilterDto[]): void;
	$registerTypeDefinitionSupport(handle: number, selector: IDocumentFilterDto[]): void;
	$registerHoverProvider(handle: number, selector: IDocumentFilterDto[]): void;
361
	$registerEvaluatableExpressionProvider(handle: number, selector: IDocumentFilterDto[]): void;
J
Johannes Rieken 已提交
362 363
	$registerDocumentHighlightProvider(handle: number, selector: IDocumentFilterDto[]): void;
	$registerReferenceSupport(handle: number, selector: IDocumentFilterDto[]): void;
364
	$registerQuickFixSupport(handle: number, selector: IDocumentFilterDto[], metadata: ICodeActionProviderMetadataDto): void;
J
Johannes Rieken 已提交
365 366 367
	$registerDocumentFormattingSupport(handle: number, selector: IDocumentFilterDto[], extensionId: ExtensionIdentifier, displayName: string): void;
	$registerRangeFormattingSupport(handle: number, selector: IDocumentFilterDto[], extensionId: ExtensionIdentifier, displayName: string): void;
	$registerOnTypeFormattingSupport(handle: number, selector: IDocumentFilterDto[], autoFormatTriggerCharacters: string[], extensionId: ExtensionIdentifier): void;
368
	$registerNavigateTypeSupport(handle: number): void;
J
Johannes Rieken 已提交
369
	$registerRenameSupport(handle: number, selector: IDocumentFilterDto[], supportsResolveInitialValues: boolean): void;
370 371
	$registerDocumentSemanticTokensProvider(handle: number, selector: IDocumentFilterDto[], legend: modes.SemanticTokensLegend): void;
	$registerDocumentRangeSemanticTokensProvider(handle: number, selector: IDocumentFilterDto[], legend: modes.SemanticTokensLegend): void;
J
Johannes Rieken 已提交
372 373 374 375 376 377 378 379
	$registerSuggestSupport(handle: number, selector: IDocumentFilterDto[], triggerCharacters: string[], supportsResolveDetails: boolean, extensionId: ExtensionIdentifier): void;
	$registerSignatureHelpProvider(handle: number, selector: IDocumentFilterDto[], metadata: ISignatureHelpProviderMetadataDto): void;
	$registerDocumentLinkProvider(handle: number, selector: IDocumentFilterDto[], supportsResolve: boolean): void;
	$registerDocumentColorProvider(handle: number, selector: IDocumentFilterDto[]): void;
	$registerFoldingRangeProvider(handle: number, selector: IDocumentFilterDto[]): void;
	$registerSelectionRangeProvider(handle: number, selector: IDocumentFilterDto[]): void;
	$registerCallHierarchyProvider(handle: number, selector: IDocumentFilterDto[]): void;
	$setLanguageConfiguration(handle: number, languageId: string, configuration: ILanguageConfigurationDto): void;
380 381
}

382
export interface MainThreadLanguagesShape extends IDisposable {
J
Johannes Rieken 已提交
383 384
	$getLanguages(): Promise<string[]>;
	$changeLanguage(resource: UriComponents, languageId: string): Promise<void>;
385 386
}

387
export interface MainThreadMessageOptions {
388
	extension?: IExtensionDescription;
389
	modal?: boolean;
390 391
}

392
export interface MainThreadMessageServiceShape extends IDisposable {
393
	$showMessage(severity: Severity, message: string, options: MainThreadMessageOptions, commands: { title: string; isCloseAffordance: boolean; handle: number; }[]): Promise<number | undefined>;
394 395
}

396
export interface MainThreadOutputServiceShape extends IDisposable {
J
Johannes Rieken 已提交
397
	$register(label: string, log: boolean, file?: UriComponents): Promise<string>;
398 399 400 401 402 403
	$append(channelId: string, value: string): Promise<void> | undefined;
	$update(channelId: string): Promise<void> | undefined;
	$clear(channelId: string, till: number): Promise<void> | undefined;
	$reveal(channelId: string, preserveFocus: boolean): Promise<void> | undefined;
	$close(channelId: string): Promise<void> | undefined;
	$dispose(channelId: string): Promise<void> | undefined;
404 405
}

406
export interface MainThreadProgressShape extends IDisposable {
407

B
Benjamin Pasero 已提交
408
	$startProgress(handle: number, options: IProgressOptions, extension?: IExtensionDescription): void;
409 410
	$progressReport(handle: number, message: IProgressStep): void;
	$progressEnd(handle: number): void;
411 412
}

D
Daniel Imms 已提交
413 414 415 416 417
export interface TerminalLaunchConfig {
	name?: string;
	shellPath?: string;
	shellArgs?: string[] | string;
	cwd?: string | UriComponents;
418
	env?: { [key: string]: string | null; };
D
Daniel Imms 已提交
419 420 421
	waitOnExit?: boolean;
	strictEnv?: boolean;
	hideFromUser?: boolean;
422
	isExtensionTerminal?: boolean;
D
Daniel Imms 已提交
423 424
}

425
export interface MainThreadTerminalServiceShape extends IDisposable {
426
	$createTerminal(config: TerminalLaunchConfig): Promise<{ id: number, name: string; }>;
427 428 429 430
	$dispose(terminalId: number): void;
	$hide(terminalId: number): void;
	$sendText(terminalId: number, text: string, addNewLine: boolean): void;
	$show(terminalId: number, preserveFocus: boolean): void;
431 432
	$startSendingDataEvents(): void;
	$stopSendingDataEvents(): void;
433

434
	// Process
435 436
	$sendProcessTitle(terminalId: number, title: string): void;
	$sendProcessData(terminalId: number, data: string): void;
D
Daniel Imms 已提交
437
	$sendProcessReady(terminalId: number, pid: number, cwd: string): void;
D
Daniel Imms 已提交
438
	$sendProcessExit(terminalId: number, exitCode: number | undefined): void;
439 440
	$sendProcessInitialCwd(terminalId: number, cwd: string): void;
	$sendProcessCwd(terminalId: number, initialCwd: string): void;
441
	$sendOverrideDimensions(terminalId: number, dimensions: ITerminalDimensions | undefined): void;
442
	$sendResolvedLaunchConfig(terminalId: number, shellLaunchConfig: IShellLaunchConfig): void;
D
Daniel Imms 已提交
443 444
}

J
Johannes Rieken 已提交
445
export interface TransferQuickPickItems extends quickInput.IQuickPickItem {
446 447
	handle: number;
}
C
Christof Marti 已提交
448

449
export interface TransferQuickInputButton {
450
	handle: number;
451 452
	iconPath: { dark: URI; light?: URI; } | { id: string; };
	tooltip?: string;
453
}
454 455 456 457 458

export type TransferQuickInput = TransferQuickPick | TransferInputBox;

export interface BaseTransferQuickInput {

459 460
	[key: string]: any;

461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
	id: number;

	type?: 'quickPick' | 'inputBox';

	enabled?: boolean;

	busy?: boolean;

	visible?: boolean;
}

export interface TransferQuickPick extends BaseTransferQuickInput {

	type?: 'quickPick';

	value?: string;

	placeholder?: string;

C
Christof Marti 已提交
480
	buttons?: TransferQuickInputButton[];
481

C
Christof Marti 已提交
482
	items?: TransferQuickPickItems[];
483

484 485 486 487
	activeItems?: number[];

	selectedItems?: number[];

488 489 490 491 492 493 494
	canSelectMany?: boolean;

	ignoreFocusOut?: boolean;

	matchOnDescription?: boolean;

	matchOnDetail?: boolean;
495 496

	sortByLabel?: boolean;
497 498 499 500 501 502 503 504 505 506 507 508
}

export interface TransferInputBox extends BaseTransferQuickInput {

	type?: 'inputBox';

	value?: string;

	placeholder?: string;

	password?: boolean;

C
Christof Marti 已提交
509
	buttons?: TransferQuickInputButton[];
510 511 512 513 514 515

	prompt?: string;

	validationMessage?: string;
}

516 517 518 519 520 521 522 523 524
export interface IInputBoxOptions {
	value?: string;
	valueSelection?: [number, number];
	prompt?: string;
	placeHolder?: string;
	password?: boolean;
	ignoreFocusOut?: boolean;
}

525
export interface MainThreadQuickOpenShape extends IDisposable {
J
Johannes Rieken 已提交
526
	$show(instance: number, options: quickInput.IPickOptions<TransferQuickPickItems>, token: CancellationToken): Promise<number | number[] | undefined>;
J
Johannes Rieken 已提交
527 528
	$setItems(instance: number, items: TransferQuickPickItems[]): Promise<void>;
	$setError(instance: number, error: Error): Promise<void>;
529
	$input(options: IInputBoxOptions | undefined, validateInput: boolean, token: CancellationToken): Promise<string>;
J
Johannes Rieken 已提交
530 531
	$createOrUpdate(params: TransferQuickInput): Promise<void>;
	$dispose(id: number): Promise<void>;
532 533
}

534
export interface MainThreadStatusBarShape extends IDisposable {
J
Johannes Rieken 已提交
535
	$setEntry(id: number, statusId: string, statusName: string, text: string, tooltip: string | undefined, command: string | undefined, color: string | ThemeColor | undefined, alignment: statusbar.StatusbarAlignment, priority: number | undefined): void;
536
	$dispose(id: number): void;
537 538
}

539
export interface MainThreadStorageShape extends IDisposable {
540
	$getValue<T>(shared: boolean, key: string): Promise<T | undefined>;
J
Johannes Rieken 已提交
541
	$setValue(shared: boolean, key: string, value: object): Promise<void>;
542 543
}

544
export interface MainThreadTelemetryShape extends IDisposable {
545
	$publicLog(eventName: string, data?: any): void;
546
	$publicLog2<E extends ClassifiedEvent<T> = never, T extends GDPRClassification<T> = never>(eventName: string, data?: StrictPropertyCheck<T, E>): void;
547 548
}

549
export interface MainThreadEditorInsetsShape extends IDisposable {
550
	$createEditorInset(handle: number, id: string, uri: UriComponents, line: number, height: number, options: modes.IWebviewOptions, extensionId: ExtensionIdentifier, extensionLocation: UriComponents): Promise<void>;
551 552 553 554 555 556
	$disposeEditorInset(handle: number): void;

	$setHtml(handle: number, value: string): void;
	$setOptions(handle: number, options: modes.IWebviewOptions): void;
	$postMessage(handle: number, value: any): Promise<boolean>;
}
M
Matt Bierner 已提交
557

558 559 560 561 562 563
export interface ExtHostEditorInsetsShape {
	$onDidDispose(handle: number): void;
	$onDidReceiveMessage(handle: number, message: any): void;
}

export type WebviewPanelHandle = string;
564

M
Matt Bierner 已提交
565 566 567 568 569
export interface WebviewPanelShowOptions {
	readonly viewColumn?: EditorViewColumn;
	readonly preserveFocus?: boolean;
}

570 571 572 573 574
export interface WebviewExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
}

575
export enum WebviewEditorCapabilities {
M
Matt Bierner 已提交
576
	Editable,
577
	SupportsHotExit,
578 579
}

M
Matt Bierner 已提交
580
export interface MainThreadWebviewsShape extends IDisposable {
581
	$createWebviewPanel(extension: WebviewExtensionDescription, handle: WebviewPanelHandle, viewType: string, title: string, showOptions: WebviewPanelShowOptions, options: modes.IWebviewPanelOptions & modes.IWebviewOptions): void;
582
	$disposeWebview(handle: WebviewPanelHandle): void;
M
Matt Bierner 已提交
583
	$reveal(handle: WebviewPanelHandle, showOptions: WebviewPanelShowOptions): void;
584
	$setTitle(handle: WebviewPanelHandle, value: string): void;
585
	$setIconPath(handle: WebviewPanelHandle, value: { light: UriComponents, dark: UriComponents; } | undefined): void;
586

587 588
	$setHtml(handle: WebviewPanelHandle, value: string): void;
	$setOptions(handle: WebviewPanelHandle, options: modes.IWebviewOptions): void;
589

590
	$postMessage(handle: WebviewPanelHandle, value: any): Promise<boolean>;
591 592 593

	$registerSerializer(viewType: string): void;
	$unregisterSerializer(viewType: string): void;
594

595
	$registerEditorProvider(extension: WebviewExtensionDescription, viewType: string, options: modes.IWebviewPanelOptions, capabilities: readonly WebviewEditorCapabilities[]): void;
596
	$unregisterEditorProvider(viewType: string): void;
597

598
	$onEdit(resource: UriComponents, viewType: string, editId: number): void;
M
Matt Bierner 已提交
599
}
600

601 602 603 604 605 606
export interface WebviewPanelViewStateData {
	[handle: string]: {
		readonly active: boolean;
		readonly visible: boolean;
		readonly position: EditorViewColumn;
	};
M
Matt Bierner 已提交
607 608
}

M
Matt Bierner 已提交
609
export interface ExtHostWebviewsShape {
610
	$onMessage(handle: WebviewPanelHandle, message: any): void;
611
	$onMissingCsp(handle: WebviewPanelHandle, extensionId: string): void;
612
	$onDidChangeWebviewPanelViewStates(newState: WebviewPanelViewStateData): void;
J
Johannes Rieken 已提交
613
	$onDidDisposeWebviewPanel(handle: WebviewPanelHandle): Promise<void>;
614

615
	$deserializeWebviewPanel(newWebviewHandle: WebviewPanelHandle, viewType: string, title: string, state: any, position: EditorViewColumn, options: modes.IWebviewOptions & modes.IWebviewPanelOptions): Promise<void>;
616
	$resolveWebviewEditor(resource: UriComponents, newWebviewHandle: WebviewPanelHandle, viewType: string, title: string, position: EditorViewColumn, options: modes.IWebviewOptions & modes.IWebviewPanelOptions): Promise<void>;
617

618 619 620
	$undoEdits(resource: UriComponents, viewType: string, editIds: readonly number[]): void;
	$applyEdits(resource: UriComponents, viewType: string, editIds: readonly number[]): void;
	$disposeEdits(editIds: readonly number[]): void;
621

622 623
	$onSave(resource: UriComponents, viewType: string): Promise<void>;
	$onSaveAs(resource: UriComponents, viewType: string, targetResource: UriComponents): Promise<void>;
M
Matt Bierner 已提交
624 625

	$backup(resource: UriComponents, viewType: string, cancellation: CancellationToken): Promise<boolean>;
M
Matt Bierner 已提交
626 627
}

J
Joao Moreno 已提交
628
export interface MainThreadUrlsShape extends IDisposable {
629
	$registerUriHandler(handle: number, extensionId: ExtensionIdentifier): Promise<void>;
J
Johannes Rieken 已提交
630
	$unregisterUriHandler(handle: number): Promise<void>;
631
	$createAppUri(uri: UriComponents): Promise<UriComponents>;
J
Joao Moreno 已提交
632 633 634
}

export interface ExtHostUrlsShape {
J
Johannes Rieken 已提交
635
	$handleExternalUri(handle: number, uri: UriComponents): Promise<void>;
M
Matt Bierner 已提交
636 637
}

638 639 640 641
export interface ITextSearchComplete {
	limitHit?: boolean;
}

642
export interface MainThreadWorkspaceShape extends IDisposable {
643
	$startFileSearch(includePattern: string | null, includeFolder: UriComponents | null, excludePatternOrDisregardExcludes: string | false | null, maxResults: number | null, token: CancellationToken): Promise<UriComponents[] | null>;
644
	$startTextSearch(query: search.IPatternInfo, folder: UriComponents | null, options: ITextQueryBuilderOptions, requestId: number, token: CancellationToken): Promise<ITextSearchComplete | null>;
645
	$checkExists(folders: UriComponents[], includes: string[], token: CancellationToken): Promise<boolean>;
J
Johannes Rieken 已提交
646
	$saveAll(includeUntitled?: boolean): Promise<boolean>;
647
	$updateWorkspaceFolders(extensionName: string, index: number, deleteCount: number, workspaceFoldersToAdd: { uri: UriComponents, name?: string; }[]): Promise<void>;
648
	$resolveProxy(url: string): Promise<string | undefined>;
649
}
650

J
Johannes Rieken 已提交
651 652
export interface IFileChangeDto {
	resource: UriComponents;
J
Johannes Rieken 已提交
653
	type: files.FileChangeType;
J
Johannes Rieken 已提交
654 655
}

656
export interface MainThreadFileSystemShape extends IDisposable {
J
Johannes Rieken 已提交
657
	$registerFileSystemProvider(handle: number, scheme: string, capabilities: files.FileSystemProviderCapabilities): void;
658
	$unregisterProvider(handle: number): void;
J
Johannes Rieken 已提交
659
	$onFileSystemChange(handle: number, resource: IFileChangeDto[]): void;
660 661 662 663

	$stat(uri: UriComponents): Promise<files.IStat>;
	$readdir(resource: UriComponents): Promise<[string, files.FileType][]>;
	$readFile(resource: UriComponents): Promise<VSBuffer>;
664
	$writeFile(resource: UriComponents, content: VSBuffer): Promise<void>;
665 666 667 668
	$rename(resource: UriComponents, target: UriComponents, opts: files.FileOverwriteOptions): Promise<void>;
	$copy(resource: UriComponents, target: UriComponents, opts: files.FileOverwriteOptions): Promise<void>;
	$mkdir(resource: UriComponents): Promise<void>;
	$delete(resource: UriComponents, opts: files.FileDeleteOptions): Promise<void>;
669
}
J
Johannes Rieken 已提交
670

671 672 673 674 675
export interface MainThreadLabelServiceShape extends IDisposable {
	$registerResourceLabelFormatter(handle: number, formatter: ResourceLabelFormatter): void;
	$unregisterResourceLabelFormatter(handle: number): void;
}

676
export interface MainThreadSearchShape extends IDisposable {
677 678
	$registerFileSearchProvider(handle: number, scheme: string): void;
	$registerTextSearchProvider(handle: number, scheme: string): void;
679
	$unregisterProvider(handle: number): void;
680
	$handleFileMatch(handle: number, session: number, data: UriComponents[]): void;
J
Johannes Rieken 已提交
681
	$handleTextMatch(handle: number, session: number, data: search.IRawFileMatch2[]): void;
682
	$handleTelemetry(eventName: string, data: any): void;
683 684
}

685
export interface MainThreadTaskShape extends IDisposable {
J
Johannes Rieken 已提交
686
	$createTaskId(task: tasks.TaskDTO): Promise<string>;
687
	$registerTaskProvider(handle: number, type: string): Promise<void>;
J
Johannes Rieken 已提交
688
	$unregisterTaskProvider(handle: number): Promise<void>;
J
Johannes Rieken 已提交
689 690
	$fetchTasks(filter?: tasks.TaskFilterDTO): Promise<tasks.TaskDTO[]>;
	$executeTask(task: tasks.TaskHandleDTO | tasks.TaskDTO): Promise<tasks.TaskExecutionDTO>;
J
Johannes Rieken 已提交
691
	$terminateTask(id: string): Promise<void>;
J
Johannes Rieken 已提交
692
	$registerTaskSystem(scheme: string, info: tasks.TaskSystemInfoDTO): void;
G
Gabriel DeBacker 已提交
693
	$customExecutionComplete(id: string, result?: number): Promise<void>;
694 695
}

696
export interface MainThreadExtensionServiceShape extends IDisposable {
697
	$activateExtension(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<void>;
698
	$onWillActivateExtension(extensionId: ExtensionIdentifier): void;
699
	$onDidActivateExtension(extensionId: ExtensionIdentifier, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number, activationReason: ExtensionActivationReason): void;
700
	$onExtensionActivationError(extensionId: ExtensionIdentifier, error: ExtensionActivationError): Promise<void>;
701
	$onExtensionRuntimeError(extensionId: ExtensionIdentifier, error: SerializedError): void;
A
Alex Dima 已提交
702
	$onExtensionHostExit(code: number): void;
703 704
}

J
Joao Moreno 已提交
705
export interface SCMProviderFeatures {
J
Joao Moreno 已提交
706 707
	hasQuickDiffProvider?: boolean;
	count?: number;
708 709
	commitTemplate?: string;
	acceptInputCommand?: modes.Command;
J
Johannes Rieken 已提交
710
	statusBarCommands?: ICommandDto[];
J
Joao Moreno 已提交
711 712 713 714
}

export interface SCMGroupFeatures {
	hideWhenEmpty?: boolean;
J
Joao Moreno 已提交
715 716
}

J
Joao Moreno 已提交
717
export type SCMRawResource = [
718
	number /*handle*/,
719
	UriComponents /*resourceUri*/,
720
	UriComponents[] /*icons: light, dark*/,
721
	string /*tooltip*/,
722
	boolean /*strike through*/,
723
	boolean /*faded*/
J
Joao Moreno 已提交
724
];
725

726 727 728
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
729 730 731
	SCMRawResource[]
];

732 733 734 735 736
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

737
export interface MainThreadSCMShape extends IDisposable {
738
	$registerSourceControl(handle: number, id: string, label: string, rootUri: UriComponents | undefined): void;
739 740
	$updateSourceControl(handle: number, features: SCMProviderFeatures): void;
	$unregisterSourceControl(handle: number): void;
J
Joao Moreno 已提交
741

742 743 744 745
	$registerGroup(sourceControlHandle: number, handle: number, id: string, label: string): void;
	$updateGroup(sourceControlHandle: number, handle: number, features: SCMGroupFeatures): void;
	$updateGroupLabel(sourceControlHandle: number, handle: number, label: string): void;
	$unregisterGroup(sourceControlHandle: number, handle: number): void;
J
Joao Moreno 已提交
746

747
	$spliceResourceStates(sourceControlHandle: number, splices: SCMRawResourceSplices[]): void;
J
Joao 已提交
748

J
Joao Moreno 已提交
749
	$setInputBoxValue(sourceControlHandle: number, value: string): void;
750
	$setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
751
	$setInputBoxVisibility(sourceControlHandle: number, visible: boolean): void;
752
	$setValidationProviderIsEnabled(sourceControlHandle: number, enabled: boolean): void;
J
Joao Moreno 已提交
753 754
}

755 756
export type DebugSessionUUID = string;

757 758 759 760 761 762 763
export interface IDebugConfiguration {
	type: string;
	name: string;
	request: string;
	[key: string]: any;
}

764 765 766 767 768
export interface IStartDebuggingOptions {
	parentSessionID?: DebugSessionUUID;
	repl?: IDebugSessionReplMode;
}

769
export interface MainThreadDebugServiceShape extends IDisposable {
A
Alex Dima 已提交
770
	$registerDebugTypes(debugTypes: string[]): void;
771
	$sessionCached(sessionID: string): void;
A
Alex Dima 已提交
772
	$acceptDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
773 774
	$acceptDAError(handle: number, name: string, message: string, stack: string | undefined): void;
	$acceptDAExit(handle: number, code: number | undefined, signal: string | undefined): void;
775
	$registerDebugConfigurationProvider(type: string, hasProvideMethod: boolean, hasResolveMethod: boolean, hasResolve2Method: boolean, hasProvideDaMethod: boolean, handle: number): Promise<void>;
J
Johannes Rieken 已提交
776
	$registerDebugAdapterDescriptorFactory(type: string, handle: number): Promise<void>;
777
	$unregisterDebugConfigurationProvider(handle: number): void;
A
Andre Weinand 已提交
778
	$unregisterDebugAdapterDescriptorFactory(handle: number): void;
I
isidor 已提交
779
	$startDebugging(folder: UriComponents | undefined, nameOrConfig: string | IDebugConfiguration, options: IStartDebuggingOptions): Promise<boolean>;
780
	$setDebugSessionName(id: DebugSessionUUID, name: string): void;
J
Johannes Rieken 已提交
781
	$customDebugAdapterRequest(id: DebugSessionUUID, command: string, args: any): Promise<any>;
782 783
	$appendDebugConsole(value: string): void;
	$startBreakpointEvents(): void;
I
isidor 已提交
784 785
	$registerBreakpoints(breakpoints: Array<ISourceMultiBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>): Promise<void>;
	$unregisterBreakpoints(breakpointIds: string[], functionBreakpointIds: string[], dataBreakpointIds: string[]): Promise<void>;
786 787
}

788 789 790 791
export interface IOpenUriOptions {
	readonly allowTunneling?: boolean;
}

792
export interface MainThreadWindowShape extends IDisposable {
J
Johannes Rieken 已提交
793
	$getWindowVisibility(): Promise<boolean>;
794
	$openUri(uri: UriComponents, uriString: string | undefined, options: IOpenUriOptions): Promise<boolean>;
795
	$asExternalUri(uri: UriComponents, options: IOpenUriOptions): Promise<UriComponents>;
796 797
}

A
Alex Ross 已提交
798 799
export interface MainThreadTunnelServiceShape extends IDisposable {
	$openTunnel(tunnelOptions: TunnelOptions): Promise<TunnelDto | undefined>;
800
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
801
	$getTunnels(): Promise<TunnelDescription[]>;
A
Alex Ross 已提交
802
	$registerCandidateFinder(): Promise<void>;
803
	$setTunnelProvider(): Promise<void>;
804
	$setCandidateFilter(): Promise<void>;
A
Alex Ross 已提交
805 806
}

807
export interface MainThreadTimelineShape extends IDisposable {
808 809
	$registerTimelineProvider(provider: TimelineProviderDescriptor): void;
	$unregisterTimelineProvider(source: string): void;
810
	$emitTimelineChangeEvent(e: TimelineChangeEvent): void;
811 812
}

813 814
// -- extension host

815
export interface ExtHostCommandsShape {
J
Johannes Rieken 已提交
816
	$executeContributedCommand<T>(id: string, ...args: any[]): Promise<T>;
817
	$getContributedCommandHandlerDescriptions(): Promise<{ [id: string]: string | ICommandHandlerDescription; }>;
818 819
}

820
export interface ExtHostConfigurationShape {
821
	$initializeConfiguration(data: IConfigurationInitData): void;
822
	$acceptConfigurationChanged(data: IConfigurationInitData, change: IConfigurationChange): void;
823 824
}

825
export interface ExtHostDiagnosticsShape {
J
Johannes Rieken 已提交
826
	$acceptMarkersChange(data: [UriComponents, IMarkerData[]][]): void;
827 828
}

829
export interface ExtHostDocumentContentProvidersShape {
M
Matt Bierner 已提交
830
	$provideTextDocumentContent(handle: number, uri: UriComponents): Promise<string | null | undefined>;
831 832
}

833
export interface IModelAddedData {
834
	uri: UriComponents;
835
	versionId: number;
836 837
	lines: string[];
	EOL: string;
838 839 840
	modeId: string;
	isDirty: boolean;
}
841
export interface ExtHostDocumentsShape {
842 843 844 845
	$acceptModelModeChanged(strURL: UriComponents, oldModeId: string, newModeId: string): void;
	$acceptModelSaved(strURL: UriComponents): void;
	$acceptDirtyStateChanged(strURL: UriComponents, isDirty: boolean): void;
	$acceptModelChanged(strURL: UriComponents, e: IModelChangedEvent, isDirty: boolean): void;
846 847
}

848
export interface ExtHostDocumentSaveParticipantShape {
J
Johannes Rieken 已提交
849
	$participateInSave(resource: UriComponents, reason: SaveReason): Promise<boolean[]>;
850 851
}

852 853
export interface ITextEditorAddData {
	id: string;
854
	documentUri: UriComponents;
855
	options: IResolvedTextEditorConfiguration;
A
Alex Dima 已提交
856
	selections: ISelection[];
857
	visibleRanges: IRange[];
A
Alex Dima 已提交
858
	editorPosition: EditorViewColumn | undefined;
859 860
}
export interface ITextEditorPositionData {
861
	[id: string]: EditorViewColumn;
862
}
863 864 865
export interface IEditorPropertiesChangeData {
	options: IResolvedTextEditorConfiguration | null;
	selections: ISelectionChangeEvent | null;
866
	visibleRanges: IRange[] | null;
867 868 869 870 871 872
}
export interface ISelectionChangeEvent {
	selections: Selection[];
	source?: string;
}

873
export interface ExtHostEditorsShape {
874
	$acceptEditorPropertiesChanged(id: string, props: IEditorPropertiesChangeData): void;
875
	$acceptEditorPositionData(data: ITextEditorPositionData): void;
876 877
}

J
Johannes Rieken 已提交
878
export interface IDocumentsAndEditorsDelta {
879
	removedDocuments?: UriComponents[];
J
Johannes Rieken 已提交
880 881 882
	addedDocuments?: IModelAddedData[];
	removedEditors?: string[];
	addedEditors?: ITextEditorAddData[];
A
Alex Dima 已提交
883
	newActiveEditor?: string | null;
J
Johannes Rieken 已提交
884 885
}

886 887
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
888 889
}

890
export interface ExtHostTreeViewsShape {
J
Johannes Rieken 已提交
891
	$getChildren(treeViewId: string, treeItemHandle?: string): Promise<ITreeItem[]>;
892
	$setExpanded(treeViewId: string, treeItemHandle: string, expanded: boolean): void;
893
	$setSelection(treeViewId: string, treeItemHandles: string[]): void;
894
	$setVisible(treeViewId: string, visible: boolean): void;
S
Sandeep Somavarapu 已提交
895 896
}

897
export interface ExtHostWorkspaceShape {
898
	$initializeWorkspace(workspace: IWorkspaceData | null): void;
899
	$acceptWorkspaceData(workspace: IWorkspaceData | null): void;
J
Johannes Rieken 已提交
900
	$handleTextSearchResult(result: search.IRawFileMatch2, requestId: number): void;
901
}
902

903
export interface ExtHostFileSystemShape {
J
Johannes Rieken 已提交
904 905
	$stat(handle: number, resource: UriComponents): Promise<files.IStat>;
	$readdir(handle: number, resource: UriComponents): Promise<[string, files.FileType][]>;
906 907
	$readFile(handle: number, resource: UriComponents): Promise<VSBuffer>;
	$writeFile(handle: number, resource: UriComponents, content: VSBuffer, opts: files.FileWriteOptions): Promise<void>;
J
Johannes Rieken 已提交
908 909
	$rename(handle: number, resource: UriComponents, target: UriComponents, opts: files.FileOverwriteOptions): Promise<void>;
	$copy(handle: number, resource: UriComponents, target: UriComponents, opts: files.FileOverwriteOptions): Promise<void>;
J
Johannes Rieken 已提交
910
	$mkdir(handle: number, resource: UriComponents): Promise<void>;
J
Johannes Rieken 已提交
911 912
	$delete(handle: number, resource: UriComponents, opts: files.FileDeleteOptions): Promise<void>;
	$watch(handle: number, session: number, resource: UriComponents, opts: files.IWatchOptions): void;
913
	$unwatch(handle: number, session: number): void;
J
Johannes Rieken 已提交
914
	$open(handle: number, resource: UriComponents, opts: files.FileOpenOptions): Promise<number>;
J
Johannes Rieken 已提交
915
	$close(handle: number, fd: number): Promise<void>;
916 917
	$read(handle: number, fd: number, pos: number, length: number): Promise<VSBuffer>;
	$write(handle: number, fd: number, pos: number, data: VSBuffer): Promise<number>;
918
}
919

920 921 922 923
export interface ExtHostLabelServiceShape {
	$registerResourceLabelFormatter(formatter: ResourceLabelFormatter): IDisposable;
}

924
export interface ExtHostAuthenticationShape {
925
	$getSessions(id: string): Promise<ReadonlyArray<modes.AuthenticationSession>>;
926
	$getSessionAccessToken(id: string, sessionId: string): Promise<string>;
927
	$login(id: string, scopes: string[]): Promise<modes.AuthenticationSession>;
928
	$logout(id: string, sessionId: string): Promise<void>;
929 930
}

931
export interface ExtHostSearchShape {
J
Johannes Rieken 已提交
932 933
	$provideFileSearchResults(handle: number, session: number, query: search.IRawQuery, token: CancellationToken): Promise<search.ISearchCompleteStats>;
	$provideTextSearchResults(handle: number, session: number, query: search.IRawTextQuery, token: CancellationToken): Promise<search.ISearchCompleteStats>;
J
Johannes Rieken 已提交
934
	$clearCache(cacheKey: string): Promise<void>;
935 936
}

A
Tweaks  
Alex Dima 已提交
937 938 939 940 941 942 943 944 945 946 947
export interface IResolveAuthorityErrorResult {
	type: 'error';
	error: {
		message: string | undefined;
		code: RemoteAuthorityResolverErrorCode;
		detail: any;
	};
}

export interface IResolveAuthorityOKResult {
	type: 'ok';
948
	value: ResolverResult;
A
Tweaks  
Alex Dima 已提交
949 950 951 952
}

export type IResolveAuthorityResult = IResolveAuthorityErrorResult | IResolveAuthorityOKResult;

953
export interface ExtHostExtensionServiceShape {
A
Tweaks  
Alex Dima 已提交
954
	$resolveAuthority(remoteAuthority: string, resolveAttempt: number): Promise<IResolveAuthorityResult>;
955
	$startExtensionHost(enabledExtensionIds: ExtensionIdentifier[]): Promise<void>;
J
Johannes Rieken 已提交
956
	$activateByEvent(activationEvent: string): Promise<void>;
957
	$activate(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<boolean>;
958
	$setRemoteEnvironment(env: { [key: string]: string | null; }): Promise<void>;
959

960
	$deltaExtensions(toAdd: IExtensionDescription[], toRemove: ExtensionIdentifier[]): Promise<void>;
961 962

	$test_latency(n: number): Promise<number>;
963 964
	$test_up(b: VSBuffer): Promise<number>;
	$test_down(size: number): Promise<VSBuffer>;
965 966 967
}

export interface FileSystemEvents {
J
Johannes Rieken 已提交
968 969 970
	created: UriComponents[];
	changed: UriComponents[];
	deleted: UriComponents[];
971
}
972

973
export interface ExtHostFileSystemEventServiceShape {
974
	$onFileEvent(events: FileSystemEvents): void;
975
	$onWillRunFileOperation(operation: files.FileOperation, target: UriComponents, source: UriComponents | undefined, timeout: number, token: CancellationToken): Promise<any>;
976
	$onDidRunFileOperation(operation: files.FileOperation, target: UriComponents, source: UriComponents | undefined): void;
977 978
}

J
Johannes Rieken 已提交
979
export interface ObjectIdentifier {
980
	$ident?: number;
J
Johannes Rieken 已提交
981 982 983
}

export namespace ObjectIdentifier {
984
	export const name = '$ident';
J
Johannes Rieken 已提交
985
	export function mixin<T>(obj: T, id: number): T & ObjectIdentifier {
986
		Object.defineProperty(obj, name, { value: id, enumerable: true });
J
Johannes Rieken 已提交
987 988
		return <T & ObjectIdentifier>obj;
	}
989 990
	export function of(obj: any): number {
		return obj[name];
J
Johannes Rieken 已提交
991 992 993
	}
}

994 995
export interface ExtHostHeapServiceShape {
	$onGarbageCollection(ids: number[]): void;
996
}
997
export interface IRawColorInfo {
J
Joao Moreno 已提交
998
	color: [number, number, number, number];
999 1000 1001
	range: IRange;
}

1002 1003 1004 1005 1006 1007 1008 1009 1010
export class IdObject {
	_id?: number;
	private static _n = 0;
	static mixin<T extends object>(object: T): T & IdObject {
		(<any>object)._id = IdObject._n++;
		return <any>object;
	}
}

1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
export const enum ISuggestDataDtoField {
	label = 'a',
	kind = 'b',
	detail = 'c',
	documentation = 'd',
	sortText = 'e',
	filterText = 'f',
	preselect = 'g',
	insertText = 'h',
	insertTextRules = 'i',
	range = 'j',
	commitCharacters = 'k',
	additionalTextEdits = 'l',
	command = 'm',
	kindModifier = 'n',
P
label2  
Pine Wu 已提交
1026 1027 1028

	// to merge into label
	label2 = 'o',
1029 1030
}

J
Johannes Rieken 已提交
1031
export interface ISuggestDataDto {
P
label2  
Pine Wu 已提交
1032 1033
	[ISuggestDataDtoField.label]: string;
	[ISuggestDataDtoField.label2]?: string | modes.CompletionItemLabel;
1034 1035 1036 1037 1038
	[ISuggestDataDtoField.kind]: modes.CompletionItemKind;
	[ISuggestDataDtoField.detail]?: string;
	[ISuggestDataDtoField.documentation]?: string | IMarkdownString;
	[ISuggestDataDtoField.sortText]?: string;
	[ISuggestDataDtoField.filterText]?: string;
1039
	[ISuggestDataDtoField.preselect]?: true;
1040 1041
	[ISuggestDataDtoField.insertText]?: string;
	[ISuggestDataDtoField.insertTextRules]?: modes.CompletionItemInsertTextRule;
1042
	[ISuggestDataDtoField.range]?: IRange | { insert: IRange, replace: IRange; };
1043 1044 1045 1046
	[ISuggestDataDtoField.commitCharacters]?: string[];
	[ISuggestDataDtoField.additionalTextEdits]?: ISingleEditOperation[];
	[ISuggestDataDtoField.command]?: modes.Command;
	[ISuggestDataDtoField.kindModifier]?: modes.CompletionItemTag[];
J
Johannes Rieken 已提交
1047
	// not-standard
1048
	x?: ChainedCacheId;
J
Johannes Rieken 已提交
1049 1050
}

1051 1052 1053 1054 1055 1056
export const enum ISuggestResultDtoField {
	defaultRanges = 'a',
	completions = 'b',
	isIncomplete = 'c'
}

J
Johannes Rieken 已提交
1057
export interface ISuggestResultDto {
1058 1059 1060
	[ISuggestResultDtoField.defaultRanges]: { insert: IRange, replace: IRange; };
	[ISuggestResultDtoField.completions]: ISuggestDataDto[];
	[ISuggestResultDtoField.isIncomplete]: undefined | true;
1061
	x?: number;
1062 1063
}

J
Johannes Rieken 已提交
1064
export interface ISignatureHelpDto {
1065 1066 1067 1068 1069 1070
	id: CacheId;
	signatures: modes.SignatureInformation[];
	activeSignature: number;
	activeParameter: number;
}

J
Johannes Rieken 已提交
1071
export interface ISignatureHelpContextDto {
1072 1073 1074
	readonly triggerKind: modes.SignatureHelpTriggerKind;
	readonly triggerCharacter?: string;
	readonly isRetrigger: boolean;
J
Johannes Rieken 已提交
1075
	readonly activeSignatureHelp?: ISignatureHelpDto;
1076 1077
}

J
Johannes Rieken 已提交
1078
export interface ILocationDto {
1079 1080
	uri: UriComponents;
	range: IRange;
1081 1082
}

J
Johannes Rieken 已提交
1083
export interface IDefinitionLinkDto {
J
Johannes Rieken 已提交
1084
	originSelectionRange?: IRange;
M
Matt Bierner 已提交
1085 1086
	uri: UriComponents;
	range: IRange;
J
Johannes Rieken 已提交
1087
	targetSelectionRange?: IRange;
M
Matt Bierner 已提交
1088 1089
}

J
Johannes Rieken 已提交
1090
export interface IWorkspaceSymbolDto extends IdObject {
1091 1092 1093
	name: string;
	containerName?: string;
	kind: modes.SymbolKind;
J
Johannes Rieken 已提交
1094
	location: ILocationDto;
1095 1096
}

J
Johannes Rieken 已提交
1097 1098
export interface IWorkspaceSymbolsDto extends IdObject {
	symbols: IWorkspaceSymbolDto[];
1099 1100
}

1101 1102 1103 1104 1105 1106 1107
export interface IWorkspaceEditEntryMetadataDto {
	needsConfirmation: boolean;
	label: string;
	description?: string;
	iconPath?: { id: string } | UriComponents | { light: UriComponents, dark: UriComponents };
}

1108
export interface IWorkspaceFileEditDto {
M
Matt Bierner 已提交
1109 1110
	oldUri?: UriComponents;
	newUri?: UriComponents;
1111
	options?: modes.WorkspaceFileEditOptions
1112
	metadata?: IWorkspaceEditEntryMetadataDto;
1113 1114
}

1115
export interface IWorkspaceTextEditDto {
1116
	resource: UriComponents;
1117
	edit: modes.TextEdit;
1118
	modelVersionId?: number;
1119
	metadata?: IWorkspaceEditEntryMetadataDto;
1120 1121
}

J
Johannes Rieken 已提交
1122
export interface IWorkspaceEditDto {
1123
	edits: Array<IWorkspaceFileEditDto | IWorkspaceTextEditDto>;
1124 1125

	// todo@joh reject should go into rename
1126 1127 1128
	rejectReason?: string;
}

J
Johannes Rieken 已提交
1129
export function reviveWorkspaceEditDto(data: IWorkspaceEditDto | undefined): modes.WorkspaceEdit {
1130 1131
	if (data && data.edits) {
		for (const edit of data.edits) {
1132 1133
			if (typeof (<IWorkspaceTextEditDto>edit).resource === 'object') {
				(<IWorkspaceTextEditDto>edit).resource = URI.revive((<IWorkspaceTextEditDto>edit).resource);
1134
			} else {
1135 1136
				(<IWorkspaceFileEditDto>edit).newUri = URI.revive((<IWorkspaceFileEditDto>edit).newUri);
				(<IWorkspaceFileEditDto>edit).oldUri = URI.revive((<IWorkspaceFileEditDto>edit).oldUri);
1137
			}
1138 1139 1140
			if (edit.metadata && edit.metadata.iconPath) {
				edit.metadata = revive(edit.metadata);
			}
1141 1142 1143 1144 1145
		}
	}
	return <modes.WorkspaceEdit>data;
}

J
Johannes Rieken 已提交
1146
export type ICommandDto = ObjectIdentifier & modes.Command;
1147

J
Johannes Rieken 已提交
1148
export interface ICodeActionDto {
1149
	title: string;
J
Johannes Rieken 已提交
1150
	edit?: IWorkspaceEditDto;
1151
	diagnostics?: IMarkerData[];
J
Johannes Rieken 已提交
1152
	command?: ICommandDto;
J
Johannes Rieken 已提交
1153
	kind?: string;
1154
	isPreferred?: boolean;
M
Matt Bierner 已提交
1155
	disabled?: string;
1156
}
1157

J
Johannes Rieken 已提交
1158
export interface ICodeActionListDto {
1159
	cacheId: number;
J
Johannes Rieken 已提交
1160
	actions: ReadonlyArray<ICodeActionDto>;
1161 1162
}

1163 1164 1165 1166 1167
export interface ICodeActionProviderMetadataDto {
	readonly providedKinds?: readonly string[];
	readonly documentation?: ReadonlyArray<{ readonly kind: string, readonly command: ICommandDto }>;
}

1168 1169 1170
export type CacheId = number;
export type ChainedCacheId = [CacheId, CacheId];

J
Johannes Rieken 已提交
1171
export interface ILinksListDto {
1172
	id?: CacheId;
J
Johannes Rieken 已提交
1173
	links: ILinkDto[];
1174 1175
}

J
Johannes Rieken 已提交
1176
export interface ILinkDto {
1177
	cacheId?: ChainedCacheId;
M
Martin Aeschlimann 已提交
1178 1179
	range: IRange;
	url?: string | UriComponents;
1180
	tooltip?: string;
M
Martin Aeschlimann 已提交
1181
}
1182

J
Johannes Rieken 已提交
1183
export interface ICodeLensListDto {
1184
	cacheId?: number;
J
Johannes Rieken 已提交
1185
	lenses: ICodeLensDto[];
1186 1187
}

J
Johannes Rieken 已提交
1188
export interface ICodeLensDto {
1189
	cacheId?: ChainedCacheId;
1190
	range: IRange;
J
Johannes Rieken 已提交
1191
	command?: ICommandDto;
1192
}
1193

J
Johannes Rieken 已提交
1194
export type ICallHierarchyItemDto = Serialized<CallHierarchyItem>;
1195

1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
export interface IIncomingCallDto {
	from: ICallHierarchyItemDto;
	fromRanges: IRange[];
}

export interface IOutgoingCallDto {
	fromRanges: IRange[];
	to: ICallHierarchyItemDto;
}

A
Alex Dima 已提交
1206 1207 1208 1209 1210 1211
export interface ILanguageWordDefinitionDto {
	languageId: string;
	regexSource: string;
	regexFlags: string
}

1212
export interface ExtHostLanguageFeaturesShape {
1213
	$provideDocumentSymbols(handle: number, resource: UriComponents, token: CancellationToken): Promise<modes.DocumentSymbol[] | undefined>;
J
Johannes Rieken 已提交
1214 1215
	$provideCodeLenses(handle: number, resource: UriComponents, token: CancellationToken): Promise<ICodeLensListDto | undefined>;
	$resolveCodeLens(handle: number, symbol: ICodeLensDto, token: CancellationToken): Promise<ICodeLensDto | undefined>;
1216
	$releaseCodeLenses(handle: number, id: number): void;
J
Johannes Rieken 已提交
1217 1218 1219 1220
	$provideDefinition(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<IDefinitionLinkDto[]>;
	$provideDeclaration(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<IDefinitionLinkDto[]>;
	$provideImplementation(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<IDefinitionLinkDto[]>;
	$provideTypeDefinition(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<IDefinitionLinkDto[]>;
1221
	$provideHover(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.Hover | undefined>;
1222
	$provideEvaluatableExpression(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.EvaluatableExpression | undefined>;
1223
	$provideDocumentHighlights(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.DocumentHighlight[] | undefined>;
J
Johannes Rieken 已提交
1224 1225
	$provideReferences(handle: number, resource: UriComponents, position: IPosition, context: modes.ReferenceContext, token: CancellationToken): Promise<ILocationDto[] | undefined>;
	$provideCodeActions(handle: number, resource: UriComponents, rangeOrSelection: IRange | ISelection, context: modes.CodeActionContext, token: CancellationToken): Promise<ICodeActionListDto | undefined>;
1226
	$releaseCodeActions(handle: number, cacheId: number): void;
1227 1228 1229
	$provideDocumentFormattingEdits(handle: number, resource: UriComponents, options: modes.FormattingOptions, token: CancellationToken): Promise<ISingleEditOperation[] | undefined>;
	$provideDocumentRangeFormattingEdits(handle: number, resource: UriComponents, range: IRange, options: modes.FormattingOptions, token: CancellationToken): Promise<ISingleEditOperation[] | undefined>;
	$provideOnTypeFormattingEdits(handle: number, resource: UriComponents, position: IPosition, ch: string, options: modes.FormattingOptions, token: CancellationToken): Promise<ISingleEditOperation[] | undefined>;
J
Johannes Rieken 已提交
1230 1231
	$provideWorkspaceSymbols(handle: number, search: string, token: CancellationToken): Promise<IWorkspaceSymbolsDto>;
	$resolveWorkspaceSymbol(handle: number, symbol: IWorkspaceSymbolDto, token: CancellationToken): Promise<IWorkspaceSymbolDto | undefined>;
1232
	$releaseWorkspaceSymbols(handle: number, id: number): void;
J
Johannes Rieken 已提交
1233
	$provideRenameEdits(handle: number, resource: UriComponents, position: IPosition, newName: string, token: CancellationToken): Promise<IWorkspaceEditDto | undefined>;
1234
	$resolveRenameLocation(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.RenameLocation | undefined>;
1235 1236 1237
	$provideDocumentSemanticTokens(handle: number, resource: UriComponents, previousResultId: number, token: CancellationToken): Promise<VSBuffer | null>;
	$releaseDocumentSemanticTokens(handle: number, semanticColoringResultId: number): void;
	$provideDocumentRangeSemanticTokens(handle: number, resource: UriComponents, range: IRange, token: CancellationToken): Promise<VSBuffer | null>;
J
Johannes Rieken 已提交
1238 1239
	$provideCompletionItems(handle: number, resource: UriComponents, position: IPosition, context: modes.CompletionContext, token: CancellationToken): Promise<ISuggestResultDto | undefined>;
	$resolveCompletionItem(handle: number, resource: UriComponents, position: IPosition, id: ChainedCacheId, token: CancellationToken): Promise<ISuggestDataDto | undefined>;
1240
	$releaseCompletionItems(handle: number, id: number): void;
J
Johannes Rieken 已提交
1241
	$provideSignatureHelp(handle: number, resource: UriComponents, position: IPosition, context: modes.SignatureHelpContext, token: CancellationToken): Promise<ISignatureHelpDto | undefined>;
1242
	$releaseSignatureHelp(handle: number, id: number): void;
J
Johannes Rieken 已提交
1243 1244
	$provideDocumentLinks(handle: number, resource: UriComponents, token: CancellationToken): Promise<ILinksListDto | undefined>;
	$resolveDocumentLink(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<ILinkDto | undefined>;
1245
	$releaseDocumentLinks(handle: number, id: number): void;
J
Johannes Rieken 已提交
1246
	$provideDocumentColors(handle: number, resource: UriComponents, token: CancellationToken): Promise<IRawColorInfo[]>;
M
Matt Bierner 已提交
1247 1248
	$provideColorPresentations(handle: number, resource: UriComponents, colorInfo: IRawColorInfo, token: CancellationToken): Promise<modes.IColorPresentation[] | undefined>;
	$provideFoldingRanges(handle: number, resource: UriComponents, context: modes.FoldingContext, token: CancellationToken): Promise<modes.FoldingRange[] | undefined>;
1249
	$provideSelectionRanges(handle: number, resource: UriComponents, positions: IPosition[], token: CancellationToken): Promise<modes.SelectionRange[][]>;
1250
	$prepareCallHierarchy(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<ICallHierarchyItemDto[] | undefined>;
1251 1252
	$provideCallHierarchyIncomingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IIncomingCallDto[] | undefined>;
	$provideCallHierarchyOutgoingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IOutgoingCallDto[] | undefined>;
1253
	$releaseCallHierarchy(handle: number, sessionId: string): void;
A
Alex Dima 已提交
1254
	$setWordDefinitions(wordDefinitions: ILanguageWordDefinitionDto[]): void;
1255 1256
}

1257 1258
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
M
Matt Bierner 已提交
1259
	$validateInput(input: string): Promise<string | null | undefined>;
1260 1261 1262
	$onDidChangeActive(sessionId: number, handles: number[]): void;
	$onDidChangeSelection(sessionId: number, handles: number[]): void;
	$onDidAccept(sessionId: number): void;
1263
	$onDidChangeValue(sessionId: number, value: string): void;
C
Christof Marti 已提交
1264
	$onDidTriggerButton(sessionId: number, handle: number): void;
1265
	$onDidHide(sessionId: number): void;
1266 1267
}

J
Johannes Rieken 已提交
1268
export interface IShellLaunchConfigDto {
1269 1270 1271
	name?: string;
	executable?: string;
	args?: string[] | string;
1272
	cwd?: string | UriComponents;
1273
	env?: { [key: string]: string | null; };
1274 1275
}

D
Daniel Imms 已提交
1276 1277 1278 1279 1280
export interface IShellDefinitionDto {
	label: string;
	path: string;
}

D
Daniel Imms 已提交
1281 1282 1283 1284 1285
export interface IShellAndArgsDto {
	shell: string;
	args: string[] | string | undefined;
}

1286 1287 1288 1289 1290
export interface ITerminalDimensionsDto {
	columns: number;
	rows: number;
}

1291
export interface ExtHostTerminalServiceShape {
D
Daniel Imms 已提交
1292
	$acceptTerminalClosed(id: number, exitCode: number | undefined): void;
1293
	$acceptTerminalOpened(id: number, name: string, shellLaunchConfig: IShellLaunchConfigDto): void;
1294
	$acceptActiveTerminalChanged(id: number | null): void;
1295
	$acceptTerminalProcessId(id: number, processId: number): void;
A
Alex Dima 已提交
1296
	$acceptTerminalProcessData(id: number, data: string): void;
1297
	$acceptTerminalTitleChange(id: number, name: string): void;
1298
	$acceptTerminalDimensions(id: number, cols: number, rows: number): void;
1299
	$acceptTerminalMaximumDimensions(id: number, cols: number, rows: number): void;
1300
	$spawnExtHostProcess(id: number, shellLaunchConfig: IShellLaunchConfigDto, activeWorkspaceRootUri: UriComponents | undefined, cols: number, rows: number, isWorkspaceShellAllowed: boolean): void;
1301
	$startExtensionTerminal(id: number, initialDimensions: ITerminalDimensionsDto | undefined): void;
D
Daniel Imms 已提交
1302 1303
	$acceptProcessInput(id: number, data: string): void;
	$acceptProcessResize(id: number, cols: number, rows: number): void;
1304
	$acceptProcessShutdown(id: number, immediate: boolean): void;
1305 1306
	$acceptProcessRequestInitialCwd(id: number): void;
	$acceptProcessRequestCwd(id: number): void;
1307
	$acceptProcessRequestLatency(id: number): number;
1308
	$acceptWorkspacePermissionsChanged(isAllowed: boolean): void;
1309
	$getAvailableShells(): Promise<IShellDefinitionDto[]>;
1310
	$getDefaultShellAndArgs(useAutomationShell: boolean): Promise<IShellAndArgsDto>;
1311 1312
}

1313
export interface ExtHostSCMShape {
M
Matt Bierner 已提交
1314
	$provideOriginalResource(sourceControlHandle: number, uri: UriComponents, token: CancellationToken): Promise<UriComponents | null>;
A
Alex Dima 已提交
1315
	$onInputBoxValueChange(sourceControlHandle: number, value: string): void;
J
Johannes Rieken 已提交
1316 1317 1318
	$executeResourceCommand(sourceControlHandle: number, groupHandle: number, handle: number): Promise<void>;
	$validateInput(sourceControlHandle: number, value: string, cursorPosition: number): Promise<[string, number] | undefined>;
	$setSelectedSourceControls(selectedSourceControlHandles: number[]): Promise<void>;
J
Joao Moreno 已提交
1319 1320
}

1321
export interface ExtHostTaskShape {
J
Johannes Rieken 已提交
1322
	$provideTasks(handle: number, validTypes: { [key: string]: boolean; }): Thenable<tasks.TaskSetDTO>;
1323
	$resolveTask(handle: number, taskDTO: tasks.TaskDTO): Thenable<tasks.TaskDTO | undefined>;
J
Johannes Rieken 已提交
1324 1325 1326 1327
	$onDidStartTask(execution: tasks.TaskExecutionDTO, terminalId: number): void;
	$onDidStartTaskProcess(value: tasks.TaskProcessStartedDTO): void;
	$onDidEndTaskProcess(value: tasks.TaskProcessEndedDTO): void;
	$OnDidEndTask(execution: tasks.TaskExecutionDTO): void;
1328 1329
	$resolveVariables(workspaceFolder: UriComponents, toResolve: { process?: { name: string; cwd?: string; }, variables: string[]; }): Promise<{ process?: string; variables: { [key: string]: string; }; }>;
	$getDefaultShellAndArgs(): Thenable<{ shell: string, args: string[] | string | undefined; }>;
A
Alex Ross 已提交
1330
	$jsonTasksSupported(): Thenable<boolean>;
1331 1332
}

1333 1334
export interface IBreakpointDto {
	type: string;
1335
	id?: string;
1336 1337 1338
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
1339 1340 1341 1342 1343
	logMessage?: string;
}

export interface IFunctionBreakpointDto extends IBreakpointDto {
	type: 'function';
1344
	functionName: string;
1345 1346
}

I
isidor 已提交
1347 1348 1349 1350 1351
export interface IDataBreakpointDto extends IBreakpointDto {
	type: 'data';
	dataId: string;
	canPersist: boolean;
	label: string;
1352
	accessTypes?: DebugProtocol.DataBreakpointAccessType[];
I
isidor 已提交
1353 1354
}

1355
export interface ISourceBreakpointDto extends IBreakpointDto {
1356
	type: 'source';
1357
	uri: UriComponents;
1358 1359
	line: number;
	character: number;
1360 1361
}

1362
export interface IBreakpointsDeltaDto {
I
isidor 已提交
1363
	added?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1364
	removed?: string[];
I
isidor 已提交
1365
	changed?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1366 1367
}

1368 1369 1370 1371
export interface ISourceMultiBreakpointDto {
	type: 'sourceMulti';
	uri: UriComponents;
	lines: {
1372
		id: string;
1373 1374 1375
		enabled: boolean;
		condition?: string;
		hitCondition?: string;
1376
		logMessage?: string;
1377 1378 1379
		line: number;
		character: number;
	}[];
1380 1381
}

A
Andre Weinand 已提交
1382
export interface IDebugSessionFullDto {
1383 1384 1385
	id: DebugSessionUUID;
	type: string;
	name: string;
1386
	folderUri: UriComponents | undefined;
A
Andre Weinand 已提交
1387
	configuration: IConfig;
1388 1389
}

A
Andre Weinand 已提交
1390 1391
export type IDebugSessionDto = IDebugSessionFullDto | DebugSessionUUID;

1392
export interface ExtHostDebugServiceShape {
J
Johannes Rieken 已提交
1393
	$substituteVariables(folder: UriComponents | undefined, config: IConfig): Promise<IConfig>;
1394
	$runInTerminal(args: DebugProtocol.RunInTerminalRequestArguments): Promise<number | undefined>;
J
Johannes Rieken 已提交
1395 1396
	$startDASession(handle: number, session: IDebugSessionDto): Promise<void>;
	$stopDASession(handle: number): Promise<void>;
1397
	$sendDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
1398
	$resolveDebugConfiguration(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1399
	$resolveDebugConfigurationWithSubstitutedVariables(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1400
	$provideDebugConfigurations(handle: number, folder: UriComponents | undefined, token: CancellationToken): Promise<IConfig[]>;
J
Johannes Rieken 已提交
1401 1402
	$legacyDebugAdapterExecutable(handle: number, folderUri: UriComponents | undefined): Promise<IAdapterDescriptor>; // TODO@AW legacy
	$provideDebugAdapter(handle: number, session: IDebugSessionDto): Promise<IAdapterDescriptor>;
1403 1404
	$acceptDebugSessionStarted(session: IDebugSessionDto): void;
	$acceptDebugSessionTerminated(session: IDebugSessionDto): void;
1405
	$acceptDebugSessionActiveChanged(session: IDebugSessionDto | undefined): void;
1406 1407
	$acceptDebugSessionCustomEvent(session: IDebugSessionDto, event: any): void;
	$acceptBreakpointsDelta(delta: IBreakpointsDeltaDto): void;
1408
	$acceptDebugSessionNameChanged(session: IDebugSessionDto, name: string): void;
1409 1410
}

1411

1412 1413 1414 1415 1416 1417
export interface DecorationRequest {
	readonly id: number;
	readonly handle: number;
	readonly uri: UriComponents;
}

1418
export type DecorationData = [number, boolean, string, string, ThemeColor];
1419
export type DecorationReply = { [id: number]: DecorationData; };
1420 1421

export interface ExtHostDecorationsShape {
J
Johannes Rieken 已提交
1422
	$provideDecorations(requests: DecorationRequest[], token: CancellationToken): Promise<DecorationReply>;
1423 1424
}

1425 1426
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
1427 1428
}

S
Sandeep Somavarapu 已提交
1429
export interface ExtHostLogServiceShape {
A
Alex Dima 已提交
1430
	$setLevel(level: LogLevel): void;
S
Sandeep Somavarapu 已提交
1431 1432
}

J
Johannes Rieken 已提交
1433 1434 1435 1436
export interface MainThreadLogShape {
	$log(file: UriComponents, level: LogLevel, args: any[]): void;
}

1437 1438 1439 1440
export interface ExtHostOutputServiceShape {
	$setVisibleChannel(channelId: string | null): void;
}

1441 1442 1443 1444
export interface ExtHostProgressShape {
	$acceptProgressCanceled(handle: number): void;
}

M
Matt Bierner 已提交
1445
export interface ExtHostCommentsShape {
P
Peng Lyu 已提交
1446
	$createCommentThreadTemplate(commentControllerHandle: number, uriComponents: UriComponents, range: IRange): void;
1447
	$updateCommentThreadTemplate(commentControllerHandle: number, threadHandle: number, range: IRange): Promise<void>;
1448
	$deleteCommentThread(commentControllerHandle: number, commentThreadHandle: number): void;
P
Peng Lyu 已提交
1449
	$provideCommentingRanges(commentControllerHandle: number, uriComponents: UriComponents, token: CancellationToken): Promise<IRange[] | undefined>;
P
Peng Lyu 已提交
1450
	$toggleReaction(commentControllerHandle: number, threadHandle: number, uri: UriComponents, comment: modes.Comment, reaction: modes.CommentReaction): Promise<void>;
M
Matt Bierner 已提交
1451 1452
}

1453
export interface ExtHostStorageShape {
1454
	$acceptValue(shared: boolean, key: string, value: object | undefined): void;
1455 1456
}

M
Martin Aeschlimann 已提交
1457 1458 1459 1460 1461 1462
export interface ExtHostThemingShape {
	$onColorThemeChange(themeType: string): void;
}

export interface MainThreadThemingShape extends IDisposable {
}
1463 1464

export interface ExtHostTunnelServiceShape {
1465
	$findCandidatePorts(): Promise<{ host: string, port: number, detail: string }[]>;
1466
	$filterCandidates(candidates: { host: string, port: number, detail: string }[]): Promise<boolean[]>;
1467 1468
	$forwardPort(tunnelOptions: TunnelOptions): Promise<TunnelDto> | undefined;
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
A
Alex Ross 已提交
1469
	$onDidTunnelsChange(): Promise<void>;
1470 1471
}

1472
export interface ExtHostTimelineShape {
1473
	$getTimeline(source: string, uri: UriComponents, cursor: TimelineCursor, token: CancellationToken, options?: { cacheResults?: boolean }): Promise<Timeline | undefined>;
1474 1475
}

1476 1477 1478
// --- proxy identifiers

export const MainContext = {
1479
	MainThreadAuthentication: createMainId<MainThreadAuthenticationShape>('MainThreadAuthentication'),
1480 1481
	MainThreadClipboard: createMainId<MainThreadClipboardShape>('MainThreadClipboard'),
	MainThreadCommands: createMainId<MainThreadCommandsShape>('MainThreadCommands'),
M
Matt Bierner 已提交
1482
	MainThreadComments: createMainId<MainThreadCommentsShape>('MainThreadComments'),
1483
	MainThreadConfiguration: createMainId<MainThreadConfigurationShape>('MainThreadConfiguration'),
1484
	MainThreadConsole: createMainId<MainThreadConsoleShape>('MainThreadConsole'),
1485
	MainThreadDebugService: createMainId<MainThreadDebugServiceShape>('MainThreadDebugService'),
1486 1487 1488 1489
	MainThreadDecorations: createMainId<MainThreadDecorationsShape>('MainThreadDecorations'),
	MainThreadDiagnostics: createMainId<MainThreadDiagnosticsShape>('MainThreadDiagnostics'),
	MainThreadDialogs: createMainId<MainThreadDiaglogsShape>('MainThreadDiaglogs'),
	MainThreadDocuments: createMainId<MainThreadDocumentsShape>('MainThreadDocuments'),
1490
	MainThreadDocumentContentProviders: createMainId<MainThreadDocumentContentProvidersShape>('MainThreadDocumentContentProviders'),
1491
	MainThreadTextEditors: createMainId<MainThreadTextEditorsShape>('MainThreadTextEditors'),
1492
	MainThreadEditorInsets: createMainId<MainThreadEditorInsetsShape>('MainThreadEditorInsets'),
1493 1494
	MainThreadErrors: createMainId<MainThreadErrorsShape>('MainThreadErrors'),
	MainThreadTreeViews: createMainId<MainThreadTreeViewsShape>('MainThreadTreeViews'),
1495
	MainThreadDownloadService: createMainId<MainThreadDownloadServiceShape>('MainThreadDownloadService'),
A
Alex Dima 已提交
1496
	MainThreadKeytar: createMainId<MainThreadKeytarShape>('MainThreadKeytar'),
1497
	MainThreadLanguageFeatures: createMainId<MainThreadLanguageFeaturesShape>('MainThreadLanguageFeatures'),
1498
	MainThreadLanguages: createMainId<MainThreadLanguagesShape>('MainThreadLanguages'),
J
Johannes Rieken 已提交
1499
	MainThreadLog: createMainId<MainThreadLogShape>('MainThread'),
1500
	MainThreadMessageService: createMainId<MainThreadMessageServiceShape>('MainThreadMessageService'),
1501 1502
	MainThreadOutputService: createMainId<MainThreadOutputServiceShape>('MainThreadOutputService'),
	MainThreadProgress: createMainId<MainThreadProgressShape>('MainThreadProgress'),
1503
	MainThreadQuickOpen: createMainId<MainThreadQuickOpenShape>('MainThreadQuickOpen'),
1504
	MainThreadStatusBar: createMainId<MainThreadStatusBarShape>('MainThreadStatusBar'),
1505
	MainThreadStorage: createMainId<MainThreadStorageShape>('MainThreadStorage'),
1506
	MainThreadTelemetry: createMainId<MainThreadTelemetryShape>('MainThreadTelemetry'),
1507
	MainThreadTerminalService: createMainId<MainThreadTerminalServiceShape>('MainThreadTerminalService'),
M
Matt Bierner 已提交
1508
	MainThreadWebviews: createMainId<MainThreadWebviewsShape>('MainThreadWebviews'),
J
Joao Moreno 已提交
1509
	MainThreadUrls: createMainId<MainThreadUrlsShape>('MainThreadUrls'),
1510
	MainThreadWorkspace: createMainId<MainThreadWorkspaceShape>('MainThreadWorkspace'),
1511
	MainThreadFileSystem: createMainId<MainThreadFileSystemShape>('MainThreadFileSystem'),
1512
	MainThreadExtensionService: createMainId<MainThreadExtensionServiceShape>('MainThreadExtensionService'),
J
Joao Moreno 已提交
1513
	MainThreadSCM: createMainId<MainThreadSCMShape>('MainThreadSCM'),
1514
	MainThreadSearch: createMainId<MainThreadSearchShape>('MainThreadSearch'),
1515
	MainThreadTask: createMainId<MainThreadTaskShape>('MainThreadTask'),
1516
	MainThreadWindow: createMainId<MainThreadWindowShape>('MainThreadWindow'),
M
Martin Aeschlimann 已提交
1517
	MainThreadLabelService: createMainId<MainThreadLabelServiceShape>('MainThreadLabelService'),
1518
	MainThreadTheming: createMainId<MainThreadThemingShape>('MainThreadTheming'),
1519 1520
	MainThreadTunnelService: createMainId<MainThreadTunnelServiceShape>('MainThreadTunnelService'),
	MainThreadTimeline: createMainId<MainThreadTimelineShape>('MainThreadTimeline')
1521 1522 1523
};

export const ExtHostContext = {
1524
	ExtHostCommands: createExtId<ExtHostCommandsShape>('ExtHostCommands'),
1525
	ExtHostConfiguration: createExtId<ExtHostConfigurationShape>('ExtHostConfiguration'),
1526
	ExtHostDiagnostics: createExtId<ExtHostDiagnosticsShape>('ExtHostDiagnostics'),
1527
	ExtHostDebugService: createExtId<ExtHostDebugServiceShape>('ExtHostDebugService'),
J
Johannes Rieken 已提交
1528
	ExtHostDecorations: createExtId<ExtHostDecorationsShape>('ExtHostDecorations'),
1529
	ExtHostDocumentsAndEditors: createExtId<ExtHostDocumentsAndEditorsShape>('ExtHostDocumentsAndEditors'),
1530
	ExtHostDocuments: createExtId<ExtHostDocumentsShape>('ExtHostDocuments'),
J
Johannes Rieken 已提交
1531
	ExtHostDocumentContentProviders: createExtId<ExtHostDocumentContentProvidersShape>('ExtHostDocumentContentProviders'),
J
Johannes Rieken 已提交
1532
	ExtHostDocumentSaveParticipant: createExtId<ExtHostDocumentSaveParticipantShape>('ExtHostDocumentSaveParticipant'),
J
Johannes Rieken 已提交
1533
	ExtHostEditors: createExtId<ExtHostEditorsShape>('ExtHostEditors'),
1534
	ExtHostTreeViews: createExtId<ExtHostTreeViewsShape>('ExtHostTreeViews'),
J
Johannes Rieken 已提交
1535
	ExtHostFileSystem: createExtId<ExtHostFileSystemShape>('ExtHostFileSystem'),
J
Johannes Rieken 已提交
1536
	ExtHostFileSystemEventService: createExtId<ExtHostFileSystemEventServiceShape>('ExtHostFileSystemEventService'),
1537
	ExtHostLanguageFeatures: createExtId<ExtHostLanguageFeaturesShape>('ExtHostLanguageFeatures'),
1538 1539
	ExtHostQuickOpen: createExtId<ExtHostQuickOpenShape>('ExtHostQuickOpen'),
	ExtHostExtensionService: createExtId<ExtHostExtensionServiceShape>('ExtHostExtensionService'),
1540
	ExtHostLogService: createExtId<ExtHostLogServiceShape>('ExtHostLogService'),
1541
	ExtHostTerminalService: createExtId<ExtHostTerminalServiceShape>('ExtHostTerminalService'),
J
Joao Moreno 已提交
1542
	ExtHostSCM: createExtId<ExtHostSCMShape>('ExtHostSCM'),
1543
	ExtHostSearch: createExtId<ExtHostSearchShape>('ExtHostSearch'),
1544
	ExtHostTask: createExtId<ExtHostTaskShape>('ExtHostTask'),
1545
	ExtHostWorkspace: createExtId<ExtHostWorkspaceShape>('ExtHostWorkspace'),
1546
	ExtHostWindow: createExtId<ExtHostWindowShape>('ExtHostWindow'),
1547
	ExtHostWebviews: createExtId<ExtHostWebviewsShape>('ExtHostWebviews'),
1548
	ExtHostEditorInsets: createExtId<ExtHostEditorInsetsShape>('ExtHostEditorInsets'),
M
Matt Bierner 已提交
1549
	ExtHostProgress: createMainId<ExtHostProgressShape>('ExtHostProgress'),
1550
	ExtHostComments: createMainId<ExtHostCommentsShape>('ExtHostComments'),
1551
	ExtHostStorage: createMainId<ExtHostStorageShape>('ExtHostStorage'),
1552 1553
	ExtHostUrls: createExtId<ExtHostUrlsShape>('ExtHostUrls'),
	ExtHostOutputService: createMainId<ExtHostOutputServiceShape>('ExtHostOutputService'),
M
Martin Aeschlimann 已提交
1554
	ExtHostLabelService: createMainId<ExtHostLabelServiceShape>('ExtHostLabelService'),
1555
	ExtHostTheming: createMainId<ExtHostThemingShape>('ExtHostTheming'),
1556
	ExtHostTunnelService: createMainId<ExtHostTunnelServiceShape>('ExtHostTunnelService'),
1557 1558
	ExtHostAuthentication: createMainId<ExtHostAuthenticationShape>('ExtHostAuthentication'),
	ExtHostTimeline: createMainId<ExtHostTimelineShape>('ExtHostTimeline')
1559
};