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';
S
Sandeep Somavarapu 已提交
54

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

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

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

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

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

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

A
Alex Dima 已提交
107
export interface IMainContext extends IRPCProtocol {
108 109
}

110 111 112 113 114
export enum UIKind {
	Desktop = 1,
	Web = 2
}

115 116
// --- main thread

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

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

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

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

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

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

160
export interface MainThreadConfigurationShape extends IDisposable {
S
Sandeep Somavarapu 已提交
161 162
	$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>;
163 164
}

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

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

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

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

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

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

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

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

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

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 已提交
239
	setEndOfLine?: EndOfLineSequence;
240 241
}

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

249
export interface MainThreadTextEditorsShape extends IDisposable {
250
	$tryShowTextDocument(resource: UriComponents, options: ITextDocumentShowOptions): Promise<string | undefined>;
251 252
	$registerTextEditorDecorationType(key: string, options: editorCommon.IDecorationRenderOptions): void;
	$removeTextEditorDecorationType(key: string): void;
J
Johannes Rieken 已提交
253 254 255 256 257 258 259 260
	$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 已提交
261
	$tryApplyWorkspaceEdit(workspaceEditDto: IWorkspaceEditDto): Promise<boolean>;
M
Matt Bierner 已提交
262
	$tryInsertSnippet(id: string, template: string, selections: readonly IRange[], opts: IUndoStopOptions): Promise<boolean>;
J
Johannes Rieken 已提交
263
	$getDiffInformation(id: string): Promise<editorCommon.ILineChange[]>;
264 265
}

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

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

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

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

A
Alex Dima 已提交
286 287 288 289 290
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>;
291
	$findCredentials(service: string): Promise<Array<{ account: string, password: string; }>>;
A
Alex Dima 已提交
292 293
}

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

334
export type GlobPattern = string | { base: string; pattern: string; };
335

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

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

349
export interface MainThreadLanguageFeaturesShape extends IDisposable {
350
	$unregister(handle: number): void;
J
Johannes Rieken 已提交
351 352
	$registerDocumentSymbolProvider(handle: number, selector: IDocumentFilterDto[], label: string): void;
	$registerCodeLensSupport(handle: number, selector: IDocumentFilterDto[], eventHandle: number | undefined): void;
353
	$emitCodeLensEvent(eventHandle: number, event?: any): void;
J
Johannes Rieken 已提交
354 355 356 357 358
	$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;
359
	$registerEvaluatableExpressionProvider(handle: number, selector: IDocumentFilterDto[]): void;
J
Johannes Rieken 已提交
360 361
	$registerDocumentHighlightProvider(handle: number, selector: IDocumentFilterDto[]): void;
	$registerReferenceSupport(handle: number, selector: IDocumentFilterDto[]): void;
362
	$registerQuickFixSupport(handle: number, selector: IDocumentFilterDto[], metadata: ICodeActionProviderMetadataDto): void;
J
Johannes Rieken 已提交
363 364 365
	$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;
366
	$registerNavigateTypeSupport(handle: number): void;
J
Johannes Rieken 已提交
367
	$registerRenameSupport(handle: number, selector: IDocumentFilterDto[], supportsResolveInitialValues: boolean): void;
368 369
	$registerDocumentSemanticTokensProvider(handle: number, selector: IDocumentFilterDto[], legend: modes.SemanticTokensLegend): void;
	$registerDocumentRangeSemanticTokensProvider(handle: number, selector: IDocumentFilterDto[], legend: modes.SemanticTokensLegend): void;
J
Johannes Rieken 已提交
370 371 372 373 374 375 376 377
	$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;
378 379
}

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

385
export interface MainThreadMessageOptions {
386
	extension?: IExtensionDescription;
387
	modal?: boolean;
388 389
}

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

394
export interface MainThreadOutputServiceShape extends IDisposable {
J
Johannes Rieken 已提交
395
	$register(label: string, log: boolean, file?: UriComponents): Promise<string>;
396 397 398 399 400 401
	$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;
402 403
}

404
export interface MainThreadProgressShape extends IDisposable {
405

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

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

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

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

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

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

export type TransferQuickInput = TransferQuickPick | TransferInputBox;

export interface BaseTransferQuickInput {

457 458
	[key: string]: any;

459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
	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 已提交
478
	buttons?: TransferQuickInputButton[];
479

C
Christof Marti 已提交
480
	items?: TransferQuickPickItems[];
481

482 483 484 485
	activeItems?: number[];

	selectedItems?: number[];

486 487 488 489 490 491 492
	canSelectMany?: boolean;

	ignoreFocusOut?: boolean;

	matchOnDescription?: boolean;

	matchOnDetail?: boolean;
493 494

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

export interface TransferInputBox extends BaseTransferQuickInput {

	type?: 'inputBox';

	value?: string;

	placeholder?: string;

	password?: boolean;

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

	prompt?: string;

	validationMessage?: string;
}

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

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

532
export interface MainThreadStatusBarShape extends IDisposable {
J
Johannes Rieken 已提交
533
	$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;
534
	$dispose(id: number): void;
535 536
}

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

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

547
export interface MainThreadEditorInsetsShape extends IDisposable {
548
	$createEditorInset(handle: number, id: string, uri: UriComponents, line: number, height: number, options: modes.IWebviewOptions, extensionId: ExtensionIdentifier, extensionLocation: UriComponents): Promise<void>;
549 550 551 552 553 554
	$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 已提交
555

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

export type WebviewPanelHandle = string;
562

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

568 569 570 571 572
export interface WebviewExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

636 637 638 639
export interface ITextSearchComplete {
	limitHit?: boolean;
}

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

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

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

	$stat(uri: UriComponents): Promise<files.IStat>;
	$readdir(resource: UriComponents): Promise<[string, files.FileType][]>;
	$readFile(resource: UriComponents): Promise<VSBuffer>;
662
	$writeFile(resource: UriComponents, content: VSBuffer): Promise<void>;
663 664 665 666
	$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>;
667
}
J
Johannes Rieken 已提交
668

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

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

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

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

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

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

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

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

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

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

740 741 742 743
	$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 已提交
744

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

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

753 754
export type DebugSessionUUID = string;

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

762 763 764 765 766
export interface IStartDebuggingOptions {
	parentSessionID?: DebugSessionUUID;
	repl?: IDebugSessionReplMode;
}

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

786 787 788 789
export interface IOpenUriOptions {
	readonly allowTunneling?: boolean;
}

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

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

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

811 812
// -- extension host

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

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

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

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

831
export interface IModelAddedData {
832
	uri: UriComponents;
833
	versionId: number;
834 835
	lines: string[];
	EOL: string;
836 837 838
	modeId: string;
	isDirty: boolean;
}
839
export interface ExtHostDocumentsShape {
840 841 842 843
	$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;
844 845
}

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

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

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

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

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

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

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

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

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

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

929
export interface ExtHostSearchShape {
J
Johannes Rieken 已提交
930 931
	$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 已提交
932
	$clearCache(cacheKey: string): Promise<void>;
933 934
}

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

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

export type IResolveAuthorityResult = IResolveAuthorityErrorResult | IResolveAuthorityOKResult;

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

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

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

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

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

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

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

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

1000 1001 1002 1003 1004 1005 1006 1007 1008
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;
	}
}

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
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 已提交
1024 1025 1026

	// to merge into label
	label2 = 'o',
1027 1028
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1166 1167 1168
export type CacheId = number;
export type ChainedCacheId = [CacheId, CacheId];

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

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

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

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

J
jrieken 已提交
1192
export interface ICallHierarchyItemDto {
1193 1194
	_sessionId: string;
	_itemId: string;
1195 1196 1197 1198 1199 1200 1201 1202
	kind: modes.SymbolKind;
	name: string;
	detail?: string;
	uri: UriComponents;
	range: IRange;
	selectionRange: IRange;
}

1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
export interface IIncomingCallDto {
	from: ICallHierarchyItemDto;
	fromRanges: IRange[];
}

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

A
Alex Dima 已提交
1213 1214 1215 1216 1217 1218
export interface ILanguageWordDefinitionDto {
	languageId: string;
	regexSource: string;
	regexFlags: string
}

1219
export interface ExtHostLanguageFeaturesShape {
1220
	$provideDocumentSymbols(handle: number, resource: UriComponents, token: CancellationToken): Promise<modes.DocumentSymbol[] | undefined>;
J
Johannes Rieken 已提交
1221 1222
	$provideCodeLenses(handle: number, resource: UriComponents, token: CancellationToken): Promise<ICodeLensListDto | undefined>;
	$resolveCodeLens(handle: number, symbol: ICodeLensDto, token: CancellationToken): Promise<ICodeLensDto | undefined>;
1223
	$releaseCodeLenses(handle: number, id: number): void;
J
Johannes Rieken 已提交
1224 1225 1226 1227
	$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[]>;
1228
	$provideHover(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.Hover | undefined>;
1229
	$provideEvaluatableExpression(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.EvaluatableExpression | undefined>;
1230
	$provideDocumentHighlights(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.DocumentHighlight[] | undefined>;
J
Johannes Rieken 已提交
1231 1232
	$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>;
1233
	$releaseCodeActions(handle: number, cacheId: number): void;
1234 1235 1236
	$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 已提交
1237 1238
	$provideWorkspaceSymbols(handle: number, search: string, token: CancellationToken): Promise<IWorkspaceSymbolsDto>;
	$resolveWorkspaceSymbol(handle: number, symbol: IWorkspaceSymbolDto, token: CancellationToken): Promise<IWorkspaceSymbolDto | undefined>;
1239
	$releaseWorkspaceSymbols(handle: number, id: number): void;
J
Johannes Rieken 已提交
1240
	$provideRenameEdits(handle: number, resource: UriComponents, position: IPosition, newName: string, token: CancellationToken): Promise<IWorkspaceEditDto | undefined>;
1241
	$resolveRenameLocation(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.RenameLocation | undefined>;
1242 1243 1244
	$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 已提交
1245 1246
	$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>;
1247
	$releaseCompletionItems(handle: number, id: number): void;
J
Johannes Rieken 已提交
1248
	$provideSignatureHelp(handle: number, resource: UriComponents, position: IPosition, context: modes.SignatureHelpContext, token: CancellationToken): Promise<ISignatureHelpDto | undefined>;
1249
	$releaseSignatureHelp(handle: number, id: number): void;
J
Johannes Rieken 已提交
1250 1251
	$provideDocumentLinks(handle: number, resource: UriComponents, token: CancellationToken): Promise<ILinksListDto | undefined>;
	$resolveDocumentLink(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<ILinkDto | undefined>;
1252
	$releaseDocumentLinks(handle: number, id: number): void;
J
Johannes Rieken 已提交
1253
	$provideDocumentColors(handle: number, resource: UriComponents, token: CancellationToken): Promise<IRawColorInfo[]>;
M
Matt Bierner 已提交
1254 1255
	$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>;
1256
	$provideSelectionRanges(handle: number, resource: UriComponents, positions: IPosition[], token: CancellationToken): Promise<modes.SelectionRange[][]>;
1257
	$prepareCallHierarchy(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<ICallHierarchyItemDto[] | undefined>;
1258 1259
	$provideCallHierarchyIncomingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IIncomingCallDto[] | undefined>;
	$provideCallHierarchyOutgoingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IOutgoingCallDto[] | undefined>;
1260
	$releaseCallHierarchy(handle: number, sessionId: string): void;
A
Alex Dima 已提交
1261
	$setWordDefinitions(wordDefinitions: ILanguageWordDefinitionDto[]): void;
1262 1263
}

1264 1265
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
M
Matt Bierner 已提交
1266
	$validateInput(input: string): Promise<string | null | undefined>;
1267 1268 1269
	$onDidChangeActive(sessionId: number, handles: number[]): void;
	$onDidChangeSelection(sessionId: number, handles: number[]): void;
	$onDidAccept(sessionId: number): void;
1270
	$onDidChangeValue(sessionId: number, value: string): void;
C
Christof Marti 已提交
1271
	$onDidTriggerButton(sessionId: number, handle: number): void;
1272
	$onDidHide(sessionId: number): void;
1273 1274
}

J
Johannes Rieken 已提交
1275
export interface IShellLaunchConfigDto {
1276 1277 1278
	name?: string;
	executable?: string;
	args?: string[] | string;
1279
	cwd?: string | UriComponents;
1280
	env?: { [key: string]: string | null; };
1281 1282
}

D
Daniel Imms 已提交
1283 1284 1285 1286 1287
export interface IShellDefinitionDto {
	label: string;
	path: string;
}

D
Daniel Imms 已提交
1288 1289 1290 1291 1292
export interface IShellAndArgsDto {
	shell: string;
	args: string[] | string | undefined;
}

1293 1294 1295 1296 1297
export interface ITerminalDimensionsDto {
	columns: number;
	rows: number;
}

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

1320
export interface ExtHostSCMShape {
M
Matt Bierner 已提交
1321
	$provideOriginalResource(sourceControlHandle: number, uri: UriComponents, token: CancellationToken): Promise<UriComponents | null>;
A
Alex Dima 已提交
1322
	$onInputBoxValueChange(sourceControlHandle: number, value: string): void;
J
Johannes Rieken 已提交
1323 1324 1325
	$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 已提交
1326 1327
}

1328
export interface ExtHostTaskShape {
J
Johannes Rieken 已提交
1329
	$provideTasks(handle: number, validTypes: { [key: string]: boolean; }): Thenable<tasks.TaskSetDTO>;
1330
	$resolveTask(handle: number, taskDTO: tasks.TaskDTO): Thenable<tasks.TaskDTO | undefined>;
J
Johannes Rieken 已提交
1331 1332 1333 1334
	$onDidStartTask(execution: tasks.TaskExecutionDTO, terminalId: number): void;
	$onDidStartTaskProcess(value: tasks.TaskProcessStartedDTO): void;
	$onDidEndTaskProcess(value: tasks.TaskProcessEndedDTO): void;
	$OnDidEndTask(execution: tasks.TaskExecutionDTO): void;
1335 1336
	$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 已提交
1337
	$jsonTasksSupported(): Thenable<boolean>;
1338 1339
}

1340 1341
export interface IBreakpointDto {
	type: string;
1342
	id?: string;
1343 1344 1345
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
1346 1347 1348 1349 1350
	logMessage?: string;
}

export interface IFunctionBreakpointDto extends IBreakpointDto {
	type: 'function';
1351
	functionName: string;
1352 1353
}

I
isidor 已提交
1354 1355 1356 1357 1358
export interface IDataBreakpointDto extends IBreakpointDto {
	type: 'data';
	dataId: string;
	canPersist: boolean;
	label: string;
1359
	accessTypes?: DebugProtocol.DataBreakpointAccessType[];
I
isidor 已提交
1360 1361
}

1362
export interface ISourceBreakpointDto extends IBreakpointDto {
1363
	type: 'source';
1364
	uri: UriComponents;
1365 1366
	line: number;
	character: number;
1367 1368
}

1369
export interface IBreakpointsDeltaDto {
I
isidor 已提交
1370
	added?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1371
	removed?: string[];
I
isidor 已提交
1372
	changed?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1373 1374
}

1375 1376 1377 1378
export interface ISourceMultiBreakpointDto {
	type: 'sourceMulti';
	uri: UriComponents;
	lines: {
1379
		id: string;
1380 1381 1382
		enabled: boolean;
		condition?: string;
		hitCondition?: string;
1383
		logMessage?: string;
1384 1385 1386
		line: number;
		character: number;
	}[];
1387 1388
}

A
Andre Weinand 已提交
1389
export interface IDebugSessionFullDto {
1390 1391 1392
	id: DebugSessionUUID;
	type: string;
	name: string;
1393
	folderUri: UriComponents | undefined;
A
Andre Weinand 已提交
1394
	configuration: IConfig;
1395 1396
}

A
Andre Weinand 已提交
1397 1398
export type IDebugSessionDto = IDebugSessionFullDto | DebugSessionUUID;

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

1418

1419 1420 1421 1422 1423 1424
export interface DecorationRequest {
	readonly id: number;
	readonly handle: number;
	readonly uri: UriComponents;
}

1425
export type DecorationData = [number, boolean, string, string, ThemeColor];
1426
export type DecorationReply = { [id: number]: DecorationData; };
1427 1428

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

1432 1433
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
1434 1435
}

S
Sandeep Somavarapu 已提交
1436
export interface ExtHostLogServiceShape {
A
Alex Dima 已提交
1437
	$setLevel(level: LogLevel): void;
S
Sandeep Somavarapu 已提交
1438 1439
}

J
Johannes Rieken 已提交
1440 1441 1442 1443
export interface MainThreadLogShape {
	$log(file: UriComponents, level: LogLevel, args: any[]): void;
}

1444 1445 1446 1447
export interface ExtHostOutputServiceShape {
	$setVisibleChannel(channelId: string | null): void;
}

1448 1449 1450 1451
export interface ExtHostProgressShape {
	$acceptProgressCanceled(handle: number): void;
}

M
Matt Bierner 已提交
1452
export interface ExtHostCommentsShape {
P
Peng Lyu 已提交
1453
	$createCommentThreadTemplate(commentControllerHandle: number, uriComponents: UriComponents, range: IRange): void;
1454
	$updateCommentThreadTemplate(commentControllerHandle: number, threadHandle: number, range: IRange): Promise<void>;
1455
	$deleteCommentThread(commentControllerHandle: number, commentThreadHandle: number): void;
P
Peng Lyu 已提交
1456
	$provideCommentingRanges(commentControllerHandle: number, uriComponents: UriComponents, token: CancellationToken): Promise<IRange[] | undefined>;
P
Peng Lyu 已提交
1457
	$toggleReaction(commentControllerHandle: number, threadHandle: number, uri: UriComponents, comment: modes.Comment, reaction: modes.CommentReaction): Promise<void>;
M
Matt Bierner 已提交
1458 1459
}

1460
export interface ExtHostStorageShape {
1461
	$acceptValue(shared: boolean, key: string, value: object | undefined): void;
1462 1463
}

M
Martin Aeschlimann 已提交
1464 1465 1466 1467 1468 1469
export interface ExtHostThemingShape {
	$onColorThemeChange(themeType: string): void;
}

export interface MainThreadThemingShape extends IDisposable {
}
1470 1471

export interface ExtHostTunnelServiceShape {
1472
	$findCandidatePorts(): Promise<{ host: string, port: number, detail: string }[]>;
1473
	$filterCandidates(candidates: { host: string, port: number, detail: string }[]): Promise<boolean[]>;
1474 1475
	$forwardPort(tunnelOptions: TunnelOptions): Promise<TunnelDto> | undefined;
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
A
Alex Ross 已提交
1476
	$onDidTunnelsChange(): Promise<void>;
1477 1478
}

1479
export interface ExtHostTimelineShape {
1480
	$getTimeline(source: string, uri: UriComponents, cursor: TimelineCursor, token: CancellationToken, options?: { cacheResults?: boolean }): Promise<Timeline | undefined>;
1481 1482
}

1483 1484 1485
// --- proxy identifiers

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

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