extHost.protocol.ts 67.5 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';
S
Sandeep Somavarapu 已提交
53

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

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

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

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

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

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

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

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

114 115
// --- main thread

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

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

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

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

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

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

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

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

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

178
export interface MainThreadDialogSaveOptions {
179
	defaultUri?: UriComponents;
180
	saveLabel?: string;
181
	filters?: { [name: string]: string[]; };
182 183
}

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

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

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

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

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

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

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 已提交
236
	setEndOfLine?: EndOfLineSequence;
237 238
}

239
export interface ITextDocumentShowOptions {
240
	position?: EditorViewColumn;
241 242
	preserveFocus?: boolean;
	pinned?: boolean;
243
	selection?: IRange;
244 245
}

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

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

271 272 273 274
export interface MainThreadDownloadServiceShape extends IDisposable {
	$download(uri: UriComponents, to: UriComponents): Promise<void>;
}

275
export interface MainThreadErrorsShape extends IDisposable {
276
	$onUnexpectedError(err: any | SerializedError): void;
277 278
}

279
export interface MainThreadConsoleShape extends IDisposable {
280
	$logExtensionHostMessage(msg: IRemoteConsoleLog): void;
281 282
}

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

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

331
export type GlobPattern = string | { base: string; pattern: string; };
332

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

J
Johannes Rieken 已提交
341
export interface ISignatureHelpProviderMetadataDto {
342 343
	readonly triggerCharacters: readonly string[];
	readonly retriggerCharacters: readonly string[];
344 345
}

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

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

382
export interface MainThreadMessageOptions {
383
	extension?: IExtensionDescription;
384
	modal?: boolean;
385 386
}

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

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

401
export interface MainThreadProgressShape extends IDisposable {
402

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

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

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

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

J
Johannes Rieken 已提交
440
export interface TransferQuickPickItems extends quickInput.IQuickPickItem {
441 442
	handle: number;
}
C
Christof Marti 已提交
443

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

export type TransferQuickInput = TransferQuickPick | TransferInputBox;

export interface BaseTransferQuickInput {

454 455
	[key: string]: any;

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

C
Christof Marti 已提交
477
	items?: TransferQuickPickItems[];
478

479 480 481 482
	activeItems?: number[];

	selectedItems?: number[];

483 484 485 486 487 488 489
	canSelectMany?: boolean;

	ignoreFocusOut?: boolean;

	matchOnDescription?: boolean;

	matchOnDetail?: boolean;
490 491

	sortByLabel?: boolean;
492 493 494 495 496 497 498 499 500 501 502 503
}

export interface TransferInputBox extends BaseTransferQuickInput {

	type?: 'inputBox';

	value?: string;

	placeholder?: string;

	password?: boolean;

C
Christof Marti 已提交
504
	buttons?: TransferQuickInputButton[];
505 506 507 508 509 510

	prompt?: string;

	validationMessage?: string;
}

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

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

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

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

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

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

553 554 555 556 557 558
export interface ExtHostEditorInsetsShape {
	$onDidDispose(handle: number): void;
	$onDidReceiveMessage(handle: number, message: any): void;
}

export type WebviewPanelHandle = string;
559

M
Matt Bierner 已提交
560 561 562 563 564
export interface WebviewPanelShowOptions {
	readonly viewColumn?: EditorViewColumn;
	readonly preserveFocus?: boolean;
}

565 566 567 568 569
export interface WebviewExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
}

570
export enum WebviewEditorCapabilities {
M
Matt Bierner 已提交
571
	Editable,
572
	SupportsHotExit,
573 574
}

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
	$registerEditorProvider(extension: WebviewExtensionDescription, viewType: string, options: modes.IWebviewPanelOptions, capabilities: readonly WebviewEditorCapabilities[]): void;
591
	$unregisterEditorProvider(viewType: string): void;
592

593
	$onEdit(resource: UriComponents, viewType: string, editId: number): void;
M
Matt Bierner 已提交
594
}
595

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

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

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

613 614 615
	$undoEdits(resource: UriComponents, viewType: string, editIds: readonly number[]): void;
	$applyEdits(resource: UriComponents, viewType: string, editIds: readonly number[]): void;
	$disposeEdits(editIds: readonly number[]): void;
616

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

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

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

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

633 634 635 636
export interface ITextSearchComplete {
	limitHit?: boolean;
}

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

J
Johannes Rieken 已提交
646 647
export interface IFileChangeDto {
	resource: UriComponents;
J
Johannes Rieken 已提交
648
	type: files.FileChangeType;
J
Johannes Rieken 已提交
649 650
}

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

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

666 667 668 669 670
export interface MainThreadLabelServiceShape extends IDisposable {
	$registerResourceLabelFormatter(handle: number, formatter: ResourceLabelFormatter): void;
	$unregisterResourceLabelFormatter(handle: number): void;
}

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

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

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

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

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

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

721 722 723
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
724 725 726
	SCMRawResource[]
];

727 728 729 730 731
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

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

737 738 739 740
	$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 已提交
741

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

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

750 751
export type DebugSessionUUID = string;

752 753 754 755 756 757 758
export interface IDebugConfiguration {
	type: string;
	name: string;
	request: string;
	[key: string]: any;
}

759 760 761 762 763
export interface IStartDebuggingOptions {
	parentSessionID?: DebugSessionUUID;
	repl?: IDebugSessionReplMode;
}

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

783 784 785 786
export interface IOpenUriOptions {
	readonly allowTunneling?: boolean;
}

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

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

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

808 809
// -- extension host

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

815
export interface ExtHostConfigurationShape {
816
	$initializeConfiguration(data: IConfigurationInitData): void;
817
	$acceptConfigurationChanged(data: IConfigurationInitData, change: IConfigurationChange): void;
818 819
}

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

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

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

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

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

868
export interface ExtHostEditorsShape {
869
	$acceptEditorPropertiesChanged(id: string, props: IEditorPropertiesChangeData): void;
870
	$acceptEditorPositionData(data: ITextEditorPositionData): void;
871 872
}

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

881 882
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
883 884
}

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

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

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

915 916 917 918
export interface ExtHostLabelServiceShape {
	$registerResourceLabelFormatter(formatter: ResourceLabelFormatter): IDisposable;
}

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

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

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

export interface IResolveAuthorityOKResult {
	type: 'ok';
943
	value: ResolverResult;
A
Tweaks  
Alex Dima 已提交
944 945 946 947
}

export type IResolveAuthorityResult = IResolveAuthorityErrorResult | IResolveAuthorityOKResult;

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

955
	$deltaExtensions(toAdd: IExtensionDescription[], toRemove: ExtensionIdentifier[]): Promise<void>;
956 957

	$test_latency(n: number): Promise<number>;
958 959
	$test_up(b: VSBuffer): Promise<number>;
	$test_down(size: number): Promise<VSBuffer>;
960 961 962
}

export interface FileSystemEvents {
J
Johannes Rieken 已提交
963 964 965
	created: UriComponents[];
	changed: UriComponents[];
	deleted: UriComponents[];
966
}
967

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

J
Johannes Rieken 已提交
974
export interface ObjectIdentifier {
975
	$ident?: number;
J
Johannes Rieken 已提交
976 977 978
}

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

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

997 998 999 1000 1001 1002 1003 1004 1005
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;
	}
}

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

	// to merge into label
	label2 = 'o',
1024 1025
}

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

1046 1047 1048 1049 1050 1051
export const enum ISuggestResultDtoField {
	defaultRanges = 'a',
	completions = 'b',
	isIncomplete = 'c'
}

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

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

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

J
Johannes Rieken 已提交
1073
export interface ILocationDto {
1074 1075
	uri: UriComponents;
	range: IRange;
1076 1077
}

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

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

J
Johannes Rieken 已提交
1092 1093
export interface IWorkspaceSymbolsDto extends IdObject {
	symbols: IWorkspaceSymbolDto[];
1094 1095
}

1096
export interface IWorkspaceFileEditDto {
M
Matt Bierner 已提交
1097 1098
	oldUri?: UriComponents;
	newUri?: UriComponents;
1099 1100
	options?: modes.WorkspaceFileEditOptions
	metadata?: modes.WorkspaceEditMetadata;
1101 1102
}

1103
export interface IWorkspaceTextEditDto {
1104
	resource: UriComponents;
1105
	edit: modes.TextEdit;
1106
	modelVersionId?: number;
1107
	metadata?: modes.WorkspaceEditMetadata;
1108 1109
}

J
Johannes Rieken 已提交
1110
export interface IWorkspaceEditDto {
1111
	edits: Array<IWorkspaceFileEditDto | IWorkspaceTextEditDto>;
1112 1113

	// todo@joh reject should go into rename
1114 1115 1116
	rejectReason?: string;
}

J
Johannes Rieken 已提交
1117
export function reviveWorkspaceEditDto(data: IWorkspaceEditDto | undefined): modes.WorkspaceEdit {
1118 1119
	if (data && data.edits) {
		for (const edit of data.edits) {
1120 1121
			if (typeof (<IWorkspaceTextEditDto>edit).resource === 'object') {
				(<IWorkspaceTextEditDto>edit).resource = URI.revive((<IWorkspaceTextEditDto>edit).resource);
1122
			} else {
1123 1124
				(<IWorkspaceFileEditDto>edit).newUri = URI.revive((<IWorkspaceFileEditDto>edit).newUri);
				(<IWorkspaceFileEditDto>edit).oldUri = URI.revive((<IWorkspaceFileEditDto>edit).oldUri);
1125 1126 1127 1128 1129 1130
			}
		}
	}
	return <modes.WorkspaceEdit>data;
}

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

J
Johannes Rieken 已提交
1133
export interface ICodeActionDto {
1134
	title: string;
J
Johannes Rieken 已提交
1135
	edit?: IWorkspaceEditDto;
1136
	diagnostics?: IMarkerData[];
J
Johannes Rieken 已提交
1137
	command?: ICommandDto;
J
Johannes Rieken 已提交
1138
	kind?: string;
1139
	isPreferred?: boolean;
M
Matt Bierner 已提交
1140
	disabled?: string;
1141
}
1142

J
Johannes Rieken 已提交
1143
export interface ICodeActionListDto {
1144
	cacheId: number;
J
Johannes Rieken 已提交
1145
	actions: ReadonlyArray<ICodeActionDto>;
1146 1147
}

1148 1149 1150 1151 1152
export interface ICodeActionProviderMetadataDto {
	readonly providedKinds?: readonly string[];
	readonly documentation?: ReadonlyArray<{ readonly kind: string, readonly command: ICommandDto }>;
}

1153 1154 1155
export type CacheId = number;
export type ChainedCacheId = [CacheId, CacheId];

J
Johannes Rieken 已提交
1156
export interface ILinksListDto {
1157
	id?: CacheId;
J
Johannes Rieken 已提交
1158
	links: ILinkDto[];
1159 1160
}

J
Johannes Rieken 已提交
1161
export interface ILinkDto {
1162
	cacheId?: ChainedCacheId;
M
Martin Aeschlimann 已提交
1163 1164
	range: IRange;
	url?: string | UriComponents;
1165
	tooltip?: string;
M
Martin Aeschlimann 已提交
1166
}
1167

J
Johannes Rieken 已提交
1168
export interface ICodeLensListDto {
1169
	cacheId?: number;
J
Johannes Rieken 已提交
1170
	lenses: ICodeLensDto[];
1171 1172
}

J
Johannes Rieken 已提交
1173
export interface ICodeLensDto {
1174
	cacheId?: ChainedCacheId;
1175
	range: IRange;
J
Johannes Rieken 已提交
1176
	command?: ICommandDto;
1177
}
1178

J
jrieken 已提交
1179
export interface ICallHierarchyItemDto {
1180 1181
	_sessionId: string;
	_itemId: string;
1182 1183 1184 1185 1186 1187 1188 1189
	kind: modes.SymbolKind;
	name: string;
	detail?: string;
	uri: UriComponents;
	range: IRange;
	selectionRange: IRange;
}

1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
export interface IIncomingCallDto {
	from: ICallHierarchyItemDto;
	fromRanges: IRange[];
}

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

A
Alex Dima 已提交
1200 1201 1202 1203 1204 1205
export interface ILanguageWordDefinitionDto {
	languageId: string;
	regexSource: string;
	regexFlags: string
}

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

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

J
Johannes Rieken 已提交
1262
export interface IShellLaunchConfigDto {
1263 1264 1265
	name?: string;
	executable?: string;
	args?: string[] | string;
1266
	cwd?: string | UriComponents;
1267
	env?: { [key: string]: string | null; };
1268 1269
}

D
Daniel Imms 已提交
1270 1271 1272 1273 1274
export interface IShellDefinitionDto {
	label: string;
	path: string;
}

D
Daniel Imms 已提交
1275 1276 1277 1278 1279
export interface IShellAndArgsDto {
	shell: string;
	args: string[] | string | undefined;
}

1280 1281 1282 1283 1284
export interface ITerminalDimensionsDto {
	columns: number;
	rows: number;
}

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

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

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

1327 1328
export interface IBreakpointDto {
	type: string;
1329
	id?: string;
1330 1331 1332
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
1333 1334 1335 1336 1337
	logMessage?: string;
}

export interface IFunctionBreakpointDto extends IBreakpointDto {
	type: 'function';
1338
	functionName: string;
1339 1340
}

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

1349
export interface ISourceBreakpointDto extends IBreakpointDto {
1350
	type: 'source';
1351
	uri: UriComponents;
1352 1353
	line: number;
	character: number;
1354 1355
}

1356
export interface IBreakpointsDeltaDto {
I
isidor 已提交
1357
	added?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1358
	removed?: string[];
I
isidor 已提交
1359
	changed?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1360 1361
}

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

A
Andre Weinand 已提交
1376
export interface IDebugSessionFullDto {
1377 1378 1379
	id: DebugSessionUUID;
	type: string;
	name: string;
1380
	folderUri: UriComponents | undefined;
A
Andre Weinand 已提交
1381
	configuration: IConfig;
1382 1383
}

A
Andre Weinand 已提交
1384 1385
export type IDebugSessionDto = IDebugSessionFullDto | DebugSessionUUID;

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

1405

1406 1407 1408 1409 1410 1411
export interface DecorationRequest {
	readonly id: number;
	readonly handle: number;
	readonly uri: UriComponents;
}

1412
export type DecorationData = [number, boolean, string, string, ThemeColor];
1413
export type DecorationReply = { [id: number]: DecorationData; };
1414 1415

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

1419 1420
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
1421 1422
}

S
Sandeep Somavarapu 已提交
1423
export interface ExtHostLogServiceShape {
A
Alex Dima 已提交
1424
	$setLevel(level: LogLevel): void;
S
Sandeep Somavarapu 已提交
1425 1426
}

J
Johannes Rieken 已提交
1427 1428 1429 1430
export interface MainThreadLogShape {
	$log(file: UriComponents, level: LogLevel, args: any[]): void;
}

1431 1432 1433 1434
export interface ExtHostOutputServiceShape {
	$setVisibleChannel(channelId: string | null): void;
}

1435 1436 1437 1438
export interface ExtHostProgressShape {
	$acceptProgressCanceled(handle: number): void;
}

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

1447
export interface ExtHostStorageShape {
1448
	$acceptValue(shared: boolean, key: string, value: object | undefined): void;
1449 1450
}

M
Martin Aeschlimann 已提交
1451 1452 1453 1454 1455 1456
export interface ExtHostThemingShape {
	$onColorThemeChange(themeType: string): void;
}

export interface MainThreadThemingShape extends IDisposable {
}
1457 1458

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

1466
export interface ExtHostTimelineShape {
1467
	$getTimeline(source: string, uri: UriComponents, cursor: TimelineCursor, token: CancellationToken, options?: { cacheResults?: boolean }): Promise<Timeline | undefined>;
1468 1469
}

1470 1471 1472
// --- proxy identifiers

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

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