extHost.protocol.ts 68.2 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';
52
import { Timeline, TimelineChangeEvent, TimelineOptions, TimelineProviderDescriptor, InternalTimelineOptions } from 'vs/workbench/contrib/timeline/common/timeline';
53
import { revive } from 'vs/base/common/marshalling';
J
Johannes Rieken 已提交
54
import { CallHierarchyItem } from 'vs/workbench/contrib/callHierarchy/common/callHierarchy';
J
Johannes Rieken 已提交
55
import { Dto } 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, displayName: string): 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;
}

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

582 583
	$setHtml(handle: WebviewPanelHandle, value: string): void;
	$setOptions(handle: WebviewPanelHandle, options: modes.IWebviewOptions): void;
584

585
	$postMessage(handle: WebviewPanelHandle, value: any): Promise<boolean>;
586 587 588

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

590 591
	$registerTextEditorProvider(extension: WebviewExtensionDescription, viewType: string, options: modes.IWebviewPanelOptions): void;
	$registerCustomEditorProvider(extension: WebviewExtensionDescription, viewType: string, options: modes.IWebviewPanelOptions): void;
592
	$unregisterEditorProvider(viewType: string): void;
593

594
	$onDidChangeCustomDocumentState(resource: UriComponents, viewType: string, state: { dirty: boolean }): void;
M
Matt Bierner 已提交
595
}
596

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

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

611
	$deserializeWebviewPanel(newWebviewHandle: WebviewPanelHandle, viewType: string, title: string, state: any, position: EditorViewColumn, options: modes.IWebviewOptions & modes.IWebviewPanelOptions): Promise<void>;
612

613 614 615
	$resolveWebviewEditor(resource: UriComponents, newWebviewHandle: WebviewPanelHandle, viewType: string, title: string, position: EditorViewColumn, options: modes.IWebviewOptions & modes.IWebviewPanelOptions): Promise<void>;
	$createWebviewCustomEditorDocument(resource: UriComponents, viewType: string): Promise<{ editable: boolean }>;
	$disposeWebviewCustomEditorDocument(resource: UriComponents, viewType: string): Promise<void>;
616

617 618 619
	$undo(resource: UriComponents, viewType: string): void;
	$redo(resource: UriComponents, viewType: string): void;
	$revert(resource: UriComponents, viewType: string): void;
620 621
	$onSave(resource: UriComponents, viewType: string): Promise<void>;
	$onSaveAs(resource: UriComponents, viewType: string, targetResource: UriComponents): Promise<void>;
M
Matt Bierner 已提交
622

M
Matt Bierner 已提交
623
	$backup(resource: UriComponents, viewType: string, cancellation: CancellationToken): Promise<void>;
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
Johannes Rieken 已提交
1192
export type ICallHierarchyItemDto = Dto<CallHierarchyItem>;
1193

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

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

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

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

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

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

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

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

1284 1285 1286 1287 1288
export interface ITerminalDimensionsDto {
	columns: number;
	rows: number;
}

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

1311
export interface ExtHostSCMShape {
M
Matt Bierner 已提交
1312
	$provideOriginalResource(sourceControlHandle: number, uri: UriComponents, token: CancellationToken): Promise<UriComponents | null>;
A
Alex Dima 已提交
1313
	$onInputBoxValueChange(sourceControlHandle: number, value: string): void;
J
Johannes Rieken 已提交
1314 1315 1316
	$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 已提交
1317 1318
}

1319
export interface ExtHostTaskShape {
J
Johannes Rieken 已提交
1320
	$provideTasks(handle: number, validTypes: { [key: string]: boolean; }): Thenable<tasks.TaskSetDTO>;
1321
	$resolveTask(handle: number, taskDTO: tasks.TaskDTO): Thenable<tasks.TaskDTO | undefined>;
J
Johannes Rieken 已提交
1322 1323 1324 1325
	$onDidStartTask(execution: tasks.TaskExecutionDTO, terminalId: number): void;
	$onDidStartTaskProcess(value: tasks.TaskProcessStartedDTO): void;
	$onDidEndTaskProcess(value: tasks.TaskProcessEndedDTO): void;
	$OnDidEndTask(execution: tasks.TaskExecutionDTO): void;
1326 1327
	$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 已提交
1328
	$jsonTasksSupported(): Thenable<boolean>;
1329 1330
}

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

export interface IFunctionBreakpointDto extends IBreakpointDto {
	type: 'function';
1342
	functionName: string;
1343 1344
}

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

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

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

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

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

A
Andre Weinand 已提交
1388 1389
export type IDebugSessionDto = IDebugSessionFullDto | DebugSessionUUID;

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

1409

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

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

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

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

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

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

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

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

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

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

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

export interface MainThreadThemingShape extends IDisposable {
}
1461 1462

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

1470
export interface ExtHostTimelineShape {
1471
	$getTimeline(source: string, uri: UriComponents, options: TimelineOptions, token: CancellationToken, internalOptions?: InternalTimelineOptions): Promise<Timeline | undefined>;
1472 1473
}

1474 1475 1476
// --- proxy identifiers

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

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