extHost.protocol.ts 69.4 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 { TimelineItem, TimelineProviderDescriptor, TimelineChangeEvent, TimelineItemWithSource } from 'vs/workbench/contrib/timeline/common/timeline';
53
import { INotebookMimeTypeSelector, IOutput } from 'vs/workbench/contrib/notebook/common/notebookCommon';
S
Sandeep Somavarapu 已提交
54

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

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

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

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

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

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

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

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

115 116
// --- main thread

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

347
export interface MainThreadLanguageFeaturesShape extends IDisposable {
348
	$unregister(handle: number): void;
J
Johannes Rieken 已提交
349 350
	$registerDocumentSymbolProvider(handle: number, selector: IDocumentFilterDto[], label: string): void;
	$registerCodeLensSupport(handle: number, selector: IDocumentFilterDto[], eventHandle: number | undefined): void;
351
	$emitCodeLensEvent(eventHandle: number, event?: any): void;
J
Johannes Rieken 已提交
352 353 354 355 356 357 358
	$registerDefinitionSupport(handle: number, selector: IDocumentFilterDto[]): void;
	$registerDeclarationSupport(handle: number, selector: IDocumentFilterDto[]): void;
	$registerImplementationSupport(handle: number, selector: IDocumentFilterDto[]): void;
	$registerTypeDefinitionSupport(handle: number, selector: IDocumentFilterDto[]): void;
	$registerHoverProvider(handle: number, selector: IDocumentFilterDto[]): void;
	$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;
}

R
rebornix 已提交
570 571 572 573 574
export interface NotebookExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
// export interface INotebookDto {
// 	handle: number;
// 	// metadata: IMetadata;
// 	readonly uri: UriComponents;
// 	languages: string[];
// 	cells: ICellDto[];
// 	renderers: Set<number>;
// }

export interface ICellDto {
	handle: number;
	source: string[];
	language: string;
	cell_type: 'markdown' | 'code';
	outputs: IOutput[];
	isDirty: boolean;
}

R
rebornix 已提交
646
export interface MainThreadNotebookShape extends IDisposable {
R
rebornix 已提交
647 648
	$registerNotebookProvider(extension: NotebookExtensionDescription, viewType: string): Promise<void>;
	$unregisterNotebookProvider(viewType: string): Promise<void>;
649
	$registerNotebookRenderer(extension: NotebookExtensionDescription, selectors: INotebookMimeTypeSelector, handle: number, preloads: UriComponents[]): Promise<void>;
R
rebornix 已提交
650
	$unregisterNotebookRenderer(handle: number): Promise<void>;
R
rebornix 已提交
651
	$createNotebookDocument(handle: number, viewType: string, resource: UriComponents): Promise<void>;
652
	$updateNotebookCells(viewType: string, resource: UriComponents, cells: ICellDto[], renderers: number[]): Promise<void>;
R
rebornix 已提交
653
	$updateNotebookLanguages(viewType: string, resource: UriComponents, languages: string[]): Promise<void>;
R
rebornix 已提交
654 655
}

J
Joao Moreno 已提交
656
export interface MainThreadUrlsShape extends IDisposable {
657
	$registerUriHandler(handle: number, extensionId: ExtensionIdentifier): Promise<void>;
J
Johannes Rieken 已提交
658
	$unregisterUriHandler(handle: number): Promise<void>;
659
	$createAppUri(uri: UriComponents): Promise<UriComponents>;
J
Joao Moreno 已提交
660 661 662
}

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

666 667 668 669
export interface ITextSearchComplete {
	limitHit?: boolean;
}

670
export interface MainThreadWorkspaceShape extends IDisposable {
671
	$startFileSearch(includePattern: string | null, includeFolder: UriComponents | null, excludePatternOrDisregardExcludes: string | false | null, maxResults: number | null, token: CancellationToken): Promise<UriComponents[] | null>;
672
	$startTextSearch(query: search.IPatternInfo, folder: UriComponents | null, options: ITextQueryBuilderOptions, requestId: number, token: CancellationToken): Promise<ITextSearchComplete | null>;
673
	$checkExists(folders: UriComponents[], includes: string[], token: CancellationToken): Promise<boolean>;
J
Johannes Rieken 已提交
674
	$saveAll(includeUntitled?: boolean): Promise<boolean>;
675
	$updateWorkspaceFolders(extensionName: string, index: number, deleteCount: number, workspaceFoldersToAdd: { uri: UriComponents, name?: string; }[]): Promise<void>;
676
	$resolveProxy(url: string): Promise<string | undefined>;
677
}
678

J
Johannes Rieken 已提交
679 680
export interface IFileChangeDto {
	resource: UriComponents;
J
Johannes Rieken 已提交
681
	type: files.FileChangeType;
J
Johannes Rieken 已提交
682 683
}

684
export interface MainThreadFileSystemShape extends IDisposable {
J
Johannes Rieken 已提交
685
	$registerFileSystemProvider(handle: number, scheme: string, capabilities: files.FileSystemProviderCapabilities): void;
686
	$unregisterProvider(handle: number): void;
J
Johannes Rieken 已提交
687
	$onFileSystemChange(handle: number, resource: IFileChangeDto[]): void;
688 689 690 691

	$stat(uri: UriComponents): Promise<files.IStat>;
	$readdir(resource: UriComponents): Promise<[string, files.FileType][]>;
	$readFile(resource: UriComponents): Promise<VSBuffer>;
692
	$writeFile(resource: UriComponents, content: VSBuffer): Promise<void>;
693 694 695 696
	$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>;
697
}
J
Johannes Rieken 已提交
698

699 700 701 702 703
export interface MainThreadLabelServiceShape extends IDisposable {
	$registerResourceLabelFormatter(handle: number, formatter: ResourceLabelFormatter): void;
	$unregisterResourceLabelFormatter(handle: number): void;
}

704
export interface MainThreadSearchShape extends IDisposable {
705 706
	$registerFileSearchProvider(handle: number, scheme: string): void;
	$registerTextSearchProvider(handle: number, scheme: string): void;
707
	$unregisterProvider(handle: number): void;
708
	$handleFileMatch(handle: number, session: number, data: UriComponents[]): void;
J
Johannes Rieken 已提交
709
	$handleTextMatch(handle: number, session: number, data: search.IRawFileMatch2[]): void;
710
	$handleTelemetry(eventName: string, data: any): void;
711 712
}

713
export interface MainThreadTaskShape extends IDisposable {
J
Johannes Rieken 已提交
714
	$createTaskId(task: tasks.TaskDTO): Promise<string>;
715
	$registerTaskProvider(handle: number, type: string): Promise<void>;
J
Johannes Rieken 已提交
716
	$unregisterTaskProvider(handle: number): Promise<void>;
J
Johannes Rieken 已提交
717 718
	$fetchTasks(filter?: tasks.TaskFilterDTO): Promise<tasks.TaskDTO[]>;
	$executeTask(task: tasks.TaskHandleDTO | tasks.TaskDTO): Promise<tasks.TaskExecutionDTO>;
J
Johannes Rieken 已提交
719
	$terminateTask(id: string): Promise<void>;
J
Johannes Rieken 已提交
720
	$registerTaskSystem(scheme: string, info: tasks.TaskSystemInfoDTO): void;
G
Gabriel DeBacker 已提交
721
	$customExecutionComplete(id: string, result?: number): Promise<void>;
722 723
}

724
export interface MainThreadExtensionServiceShape extends IDisposable {
725
	$activateExtension(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<void>;
726
	$onWillActivateExtension(extensionId: ExtensionIdentifier): void;
727
	$onDidActivateExtension(extensionId: ExtensionIdentifier, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number, activationReason: ExtensionActivationReason): void;
728
	$onExtensionActivationError(extensionId: ExtensionIdentifier, error: ExtensionActivationError): Promise<void>;
729
	$onExtensionRuntimeError(extensionId: ExtensionIdentifier, error: SerializedError): void;
A
Alex Dima 已提交
730
	$onExtensionHostExit(code: number): void;
731 732
}

J
Joao Moreno 已提交
733
export interface SCMProviderFeatures {
J
Joao Moreno 已提交
734 735
	hasQuickDiffProvider?: boolean;
	count?: number;
736 737
	commitTemplate?: string;
	acceptInputCommand?: modes.Command;
J
Johannes Rieken 已提交
738
	statusBarCommands?: ICommandDto[];
J
Joao Moreno 已提交
739 740 741 742
}

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

J
Joao Moreno 已提交
745
export type SCMRawResource = [
746
	number /*handle*/,
747
	UriComponents /*resourceUri*/,
748
	UriComponents[] /*icons: light, dark*/,
749
	string /*tooltip*/,
750
	boolean /*strike through*/,
751
	boolean /*faded*/
J
Joao Moreno 已提交
752
];
753

754 755 756
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
757 758 759
	SCMRawResource[]
];

760 761 762 763 764
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

765
export interface MainThreadSCMShape extends IDisposable {
766
	$registerSourceControl(handle: number, id: string, label: string, rootUri: UriComponents | undefined): void;
767 768
	$updateSourceControl(handle: number, features: SCMProviderFeatures): void;
	$unregisterSourceControl(handle: number): void;
J
Joao Moreno 已提交
769

770 771 772 773
	$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 已提交
774

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

J
Joao Moreno 已提交
777
	$setInputBoxValue(sourceControlHandle: number, value: string): void;
778
	$setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
779
	$setInputBoxVisibility(sourceControlHandle: number, visible: boolean): void;
780
	$setValidationProviderIsEnabled(sourceControlHandle: number, enabled: boolean): void;
J
Joao Moreno 已提交
781 782
}

783 784
export type DebugSessionUUID = string;

785 786 787 788 789 790 791
export interface IDebugConfiguration {
	type: string;
	name: string;
	request: string;
	[key: string]: any;
}

792 793 794 795 796
export interface IStartDebuggingOptions {
	parentSessionID?: DebugSessionUUID;
	repl?: IDebugSessionReplMode;
}

797
export interface MainThreadDebugServiceShape extends IDisposable {
A
Alex Dima 已提交
798
	$registerDebugTypes(debugTypes: string[]): void;
799
	$sessionCached(sessionID: string): void;
A
Alex Dima 已提交
800
	$acceptDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
801 802
	$acceptDAError(handle: number, name: string, message: string, stack: string | undefined): void;
	$acceptDAExit(handle: number, code: number | undefined, signal: string | undefined): void;
803
	$registerDebugConfigurationProvider(type: string, hasProvideMethod: boolean, hasResolveMethod: boolean, hasResolve2Method: boolean, hasProvideDaMethod: boolean, handle: number): Promise<void>;
J
Johannes Rieken 已提交
804
	$registerDebugAdapterDescriptorFactory(type: string, handle: number): Promise<void>;
805
	$unregisterDebugConfigurationProvider(handle: number): void;
A
Andre Weinand 已提交
806
	$unregisterDebugAdapterDescriptorFactory(handle: number): void;
I
isidor 已提交
807
	$startDebugging(folder: UriComponents | undefined, nameOrConfig: string | IDebugConfiguration, options: IStartDebuggingOptions): Promise<boolean>;
808
	$setDebugSessionName(id: DebugSessionUUID, name: string): void;
J
Johannes Rieken 已提交
809
	$customDebugAdapterRequest(id: DebugSessionUUID, command: string, args: any): Promise<any>;
810 811
	$appendDebugConsole(value: string): void;
	$startBreakpointEvents(): void;
I
isidor 已提交
812 813
	$registerBreakpoints(breakpoints: Array<ISourceMultiBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>): Promise<void>;
	$unregisterBreakpoints(breakpointIds: string[], functionBreakpointIds: string[], dataBreakpointIds: string[]): Promise<void>;
814 815
}

816 817 818 819
export interface IOpenUriOptions {
	readonly allowTunneling?: boolean;
}

820
export interface MainThreadWindowShape extends IDisposable {
J
Johannes Rieken 已提交
821
	$getWindowVisibility(): Promise<boolean>;
822
	$openUri(uri: UriComponents, uriString: string | undefined, options: IOpenUriOptions): Promise<boolean>;
823
	$asExternalUri(uri: UriComponents, options: IOpenUriOptions): Promise<UriComponents>;
824 825
}

A
Alex Ross 已提交
826 827
export interface MainThreadTunnelServiceShape extends IDisposable {
	$openTunnel(tunnelOptions: TunnelOptions): Promise<TunnelDto | undefined>;
828
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
829
	$getTunnels(): Promise<TunnelDescription[]>;
A
Alex Ross 已提交
830
	$registerCandidateFinder(): Promise<void>;
831
	$setTunnelProvider(): Promise<void>;
832
	$setCandidateFilter(): Promise<void>;
A
Alex Ross 已提交
833 834
}

835
export interface MainThreadTimelineShape extends IDisposable {
836 837
	$registerTimelineProvider(provider: TimelineProviderDescriptor): void;
	$unregisterTimelineProvider(source: string): void;
838
	$emitTimelineChangeEvent(e: TimelineChangeEvent): void;
839

E
Eric Amodio 已提交
840
	$getTimeline(uri: UriComponents, token: CancellationToken): Promise<TimelineItem[]>;
841 842
}

843 844
// -- extension host

845
export interface ExtHostCommandsShape {
J
Johannes Rieken 已提交
846
	$executeContributedCommand<T>(id: string, ...args: any[]): Promise<T>;
847
	$getContributedCommandHandlerDescriptions(): Promise<{ [id: string]: string | ICommandHandlerDescription; }>;
848 849
}

850
export interface ExtHostConfigurationShape {
851
	$initializeConfiguration(data: IConfigurationInitData): void;
852
	$acceptConfigurationChanged(data: IConfigurationInitData, change: IConfigurationChange): void;
853 854
}

855
export interface ExtHostDiagnosticsShape {
J
Johannes Rieken 已提交
856
	$acceptMarkersChange(data: [UriComponents, IMarkerData[]][]): void;
857 858
}

859
export interface ExtHostDocumentContentProvidersShape {
M
Matt Bierner 已提交
860
	$provideTextDocumentContent(handle: number, uri: UriComponents): Promise<string | null | undefined>;
861 862
}

863
export interface IModelAddedData {
864
	uri: UriComponents;
865
	versionId: number;
866 867
	lines: string[];
	EOL: string;
868 869 870
	modeId: string;
	isDirty: boolean;
}
871
export interface ExtHostDocumentsShape {
872 873 874 875
	$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;
876 877
}

878
export interface ExtHostDocumentSaveParticipantShape {
J
Johannes Rieken 已提交
879
	$participateInSave(resource: UriComponents, reason: SaveReason): Promise<boolean[]>;
880 881
}

882 883
export interface ITextEditorAddData {
	id: string;
884
	documentUri: UriComponents;
885
	options: IResolvedTextEditorConfiguration;
A
Alex Dima 已提交
886
	selections: ISelection[];
887
	visibleRanges: IRange[];
A
Alex Dima 已提交
888
	editorPosition: EditorViewColumn | undefined;
889 890
}
export interface ITextEditorPositionData {
891
	[id: string]: EditorViewColumn;
892
}
893 894 895
export interface IEditorPropertiesChangeData {
	options: IResolvedTextEditorConfiguration | null;
	selections: ISelectionChangeEvent | null;
896
	visibleRanges: IRange[] | null;
897 898 899 900 901 902
}
export interface ISelectionChangeEvent {
	selections: Selection[];
	source?: string;
}

903
export interface ExtHostEditorsShape {
904
	$acceptEditorPropertiesChanged(id: string, props: IEditorPropertiesChangeData): void;
905
	$acceptEditorPositionData(data: ITextEditorPositionData): void;
906 907
}

J
Johannes Rieken 已提交
908
export interface IDocumentsAndEditorsDelta {
909
	removedDocuments?: UriComponents[];
J
Johannes Rieken 已提交
910 911 912
	addedDocuments?: IModelAddedData[];
	removedEditors?: string[];
	addedEditors?: ITextEditorAddData[];
A
Alex Dima 已提交
913
	newActiveEditor?: string | null;
J
Johannes Rieken 已提交
914 915
}

916 917
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
918 919
}

920
export interface ExtHostTreeViewsShape {
J
Johannes Rieken 已提交
921
	$getChildren(treeViewId: string, treeItemHandle?: string): Promise<ITreeItem[]>;
922
	$setExpanded(treeViewId: string, treeItemHandle: string, expanded: boolean): void;
923
	$setSelection(treeViewId: string, treeItemHandles: string[]): void;
924
	$setVisible(treeViewId: string, visible: boolean): void;
S
Sandeep Somavarapu 已提交
925 926
}

927
export interface ExtHostWorkspaceShape {
928
	$initializeWorkspace(workspace: IWorkspaceData | null): void;
929
	$acceptWorkspaceData(workspace: IWorkspaceData | null): void;
J
Johannes Rieken 已提交
930
	$handleTextSearchResult(result: search.IRawFileMatch2, requestId: number): void;
931
}
932

933
export interface ExtHostFileSystemShape {
J
Johannes Rieken 已提交
934 935
	$stat(handle: number, resource: UriComponents): Promise<files.IStat>;
	$readdir(handle: number, resource: UriComponents): Promise<[string, files.FileType][]>;
936 937
	$readFile(handle: number, resource: UriComponents): Promise<VSBuffer>;
	$writeFile(handle: number, resource: UriComponents, content: VSBuffer, opts: files.FileWriteOptions): Promise<void>;
J
Johannes Rieken 已提交
938 939
	$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 已提交
940
	$mkdir(handle: number, resource: UriComponents): Promise<void>;
J
Johannes Rieken 已提交
941 942
	$delete(handle: number, resource: UriComponents, opts: files.FileDeleteOptions): Promise<void>;
	$watch(handle: number, session: number, resource: UriComponents, opts: files.IWatchOptions): void;
943
	$unwatch(handle: number, session: number): void;
J
Johannes Rieken 已提交
944
	$open(handle: number, resource: UriComponents, opts: files.FileOpenOptions): Promise<number>;
J
Johannes Rieken 已提交
945
	$close(handle: number, fd: number): Promise<void>;
946 947
	$read(handle: number, fd: number, pos: number, length: number): Promise<VSBuffer>;
	$write(handle: number, fd: number, pos: number, data: VSBuffer): Promise<number>;
948
}
949

950 951 952 953
export interface ExtHostLabelServiceShape {
	$registerResourceLabelFormatter(formatter: ResourceLabelFormatter): IDisposable;
}

954
export interface ExtHostAuthenticationShape {
955
	$getSessions(id: string): Promise<ReadonlyArray<modes.AuthenticationSession>>;
956
	$getSessionAccessToken(id: string, sessionId: string): Promise<string>;
957
	$login(id: string, scopes: string[]): Promise<modes.AuthenticationSession>;
958
	$logout(id: string, sessionId: string): Promise<void>;
959 960
}

961
export interface ExtHostSearchShape {
J
Johannes Rieken 已提交
962 963
	$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 已提交
964
	$clearCache(cacheKey: string): Promise<void>;
965 966
}

A
Tweaks  
Alex Dima 已提交
967 968 969 970 971 972 973 974 975 976 977
export interface IResolveAuthorityErrorResult {
	type: 'error';
	error: {
		message: string | undefined;
		code: RemoteAuthorityResolverErrorCode;
		detail: any;
	};
}

export interface IResolveAuthorityOKResult {
	type: 'ok';
978
	value: ResolverResult;
A
Tweaks  
Alex Dima 已提交
979 980 981 982
}

export type IResolveAuthorityResult = IResolveAuthorityErrorResult | IResolveAuthorityOKResult;

983
export interface ExtHostExtensionServiceShape {
A
Tweaks  
Alex Dima 已提交
984
	$resolveAuthority(remoteAuthority: string, resolveAttempt: number): Promise<IResolveAuthorityResult>;
985
	$startExtensionHost(enabledExtensionIds: ExtensionIdentifier[]): Promise<void>;
J
Johannes Rieken 已提交
986
	$activateByEvent(activationEvent: string): Promise<void>;
987
	$activate(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<boolean>;
988
	$setRemoteEnvironment(env: { [key: string]: string | null; }): Promise<void>;
989

990
	$deltaExtensions(toAdd: IExtensionDescription[], toRemove: ExtensionIdentifier[]): Promise<void>;
991 992

	$test_latency(n: number): Promise<number>;
993 994
	$test_up(b: VSBuffer): Promise<number>;
	$test_down(size: number): Promise<VSBuffer>;
995 996 997
}

export interface FileSystemEvents {
J
Johannes Rieken 已提交
998 999 1000
	created: UriComponents[];
	changed: UriComponents[];
	deleted: UriComponents[];
1001
}
1002

1003
export interface ExtHostFileSystemEventServiceShape {
1004
	$onFileEvent(events: FileSystemEvents): void;
1005
	$onWillRunFileOperation(operation: files.FileOperation, target: UriComponents, source: UriComponents | undefined, timeout: number, token: CancellationToken): Promise<any>;
1006
	$onDidRunFileOperation(operation: files.FileOperation, target: UriComponents, source: UriComponents | undefined): void;
1007 1008
}

J
Johannes Rieken 已提交
1009
export interface ObjectIdentifier {
1010
	$ident?: number;
J
Johannes Rieken 已提交
1011 1012 1013
}

export namespace ObjectIdentifier {
1014
	export const name = '$ident';
J
Johannes Rieken 已提交
1015
	export function mixin<T>(obj: T, id: number): T & ObjectIdentifier {
1016
		Object.defineProperty(obj, name, { value: id, enumerable: true });
J
Johannes Rieken 已提交
1017 1018
		return <T & ObjectIdentifier>obj;
	}
1019 1020
	export function of(obj: any): number {
		return obj[name];
J
Johannes Rieken 已提交
1021 1022 1023
	}
}

1024 1025
export interface ExtHostHeapServiceShape {
	$onGarbageCollection(ids: number[]): void;
1026
}
1027
export interface IRawColorInfo {
J
Joao Moreno 已提交
1028
	color: [number, number, number, number];
1029 1030 1031
	range: IRange;
}

1032 1033 1034 1035 1036 1037 1038 1039 1040
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;
	}
}

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
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 已提交
1056 1057 1058

	// to merge into label
	label2 = 'o',
1059 1060
}

J
Johannes Rieken 已提交
1061
export interface ISuggestDataDto {
1062
	[ISuggestDataDtoField.label]: string;
P
label2  
Pine Wu 已提交
1063
	[ISuggestDataDtoField.label2]?: string | modes.CompletionItemLabel;
1064 1065 1066 1067 1068
	[ISuggestDataDtoField.kind]: modes.CompletionItemKind;
	[ISuggestDataDtoField.detail]?: string;
	[ISuggestDataDtoField.documentation]?: string | IMarkdownString;
	[ISuggestDataDtoField.sortText]?: string;
	[ISuggestDataDtoField.filterText]?: string;
1069
	[ISuggestDataDtoField.preselect]?: true;
1070 1071
	[ISuggestDataDtoField.insertText]?: string;
	[ISuggestDataDtoField.insertTextRules]?: modes.CompletionItemInsertTextRule;
1072
	[ISuggestDataDtoField.range]?: IRange | { insert: IRange, replace: IRange; };
1073 1074 1075 1076
	[ISuggestDataDtoField.commitCharacters]?: string[];
	[ISuggestDataDtoField.additionalTextEdits]?: ISingleEditOperation[];
	[ISuggestDataDtoField.command]?: modes.Command;
	[ISuggestDataDtoField.kindModifier]?: modes.CompletionItemTag[];
J
Johannes Rieken 已提交
1077
	// not-standard
1078
	x?: ChainedCacheId;
J
Johannes Rieken 已提交
1079 1080
}

1081 1082 1083 1084 1085 1086
export const enum ISuggestResultDtoField {
	defaultRanges = 'a',
	completions = 'b',
	isIncomplete = 'c'
}

J
Johannes Rieken 已提交
1087
export interface ISuggestResultDto {
1088 1089 1090
	[ISuggestResultDtoField.defaultRanges]: { insert: IRange, replace: IRange; };
	[ISuggestResultDtoField.completions]: ISuggestDataDto[];
	[ISuggestResultDtoField.isIncomplete]: undefined | true;
1091
	x?: number;
1092 1093
}

J
Johannes Rieken 已提交
1094
export interface ISignatureHelpDto {
1095 1096 1097 1098 1099 1100
	id: CacheId;
	signatures: modes.SignatureInformation[];
	activeSignature: number;
	activeParameter: number;
}

J
Johannes Rieken 已提交
1101
export interface ISignatureHelpContextDto {
1102 1103 1104
	readonly triggerKind: modes.SignatureHelpTriggerKind;
	readonly triggerCharacter?: string;
	readonly isRetrigger: boolean;
J
Johannes Rieken 已提交
1105
	readonly activeSignatureHelp?: ISignatureHelpDto;
1106 1107
}

J
Johannes Rieken 已提交
1108
export interface ILocationDto {
1109 1110
	uri: UriComponents;
	range: IRange;
1111 1112
}

J
Johannes Rieken 已提交
1113
export interface IDefinitionLinkDto {
J
Johannes Rieken 已提交
1114
	originSelectionRange?: IRange;
M
Matt Bierner 已提交
1115 1116
	uri: UriComponents;
	range: IRange;
J
Johannes Rieken 已提交
1117
	targetSelectionRange?: IRange;
M
Matt Bierner 已提交
1118 1119
}

J
Johannes Rieken 已提交
1120
export interface IWorkspaceSymbolDto extends IdObject {
1121 1122 1123
	name: string;
	containerName?: string;
	kind: modes.SymbolKind;
J
Johannes Rieken 已提交
1124
	location: ILocationDto;
1125 1126
}

J
Johannes Rieken 已提交
1127 1128
export interface IWorkspaceSymbolsDto extends IdObject {
	symbols: IWorkspaceSymbolDto[];
1129 1130
}

1131
export interface IWorkspaceFileEditDto {
M
Matt Bierner 已提交
1132 1133
	oldUri?: UriComponents;
	newUri?: UriComponents;
1134 1135
	options?: modes.WorkspaceFileEditOptions
	metadata?: modes.WorkspaceEditMetadata;
1136 1137
}

1138
export interface IWorkspaceTextEditDto {
1139
	resource: UriComponents;
1140
	edit: modes.TextEdit;
1141
	modelVersionId?: number;
1142
	metadata?: modes.WorkspaceEditMetadata;
1143 1144
}

J
Johannes Rieken 已提交
1145
export interface IWorkspaceEditDto {
1146
	edits: Array<IWorkspaceFileEditDto | IWorkspaceTextEditDto>;
1147 1148

	// todo@joh reject should go into rename
1149 1150 1151
	rejectReason?: string;
}

J
Johannes Rieken 已提交
1152
export function reviveWorkspaceEditDto(data: IWorkspaceEditDto | undefined): modes.WorkspaceEdit {
1153 1154
	if (data && data.edits) {
		for (const edit of data.edits) {
1155 1156
			if (typeof (<IWorkspaceTextEditDto>edit).resource === 'object') {
				(<IWorkspaceTextEditDto>edit).resource = URI.revive((<IWorkspaceTextEditDto>edit).resource);
1157
			} else {
1158 1159
				(<IWorkspaceFileEditDto>edit).newUri = URI.revive((<IWorkspaceFileEditDto>edit).newUri);
				(<IWorkspaceFileEditDto>edit).oldUri = URI.revive((<IWorkspaceFileEditDto>edit).oldUri);
1160 1161 1162 1163 1164 1165
			}
		}
	}
	return <modes.WorkspaceEdit>data;
}

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

J
Johannes Rieken 已提交
1168
export interface ICodeActionDto {
1169
	title: string;
J
Johannes Rieken 已提交
1170
	edit?: IWorkspaceEditDto;
1171
	diagnostics?: IMarkerData[];
J
Johannes Rieken 已提交
1172
	command?: ICommandDto;
J
Johannes Rieken 已提交
1173
	kind?: string;
1174
	isPreferred?: boolean;
M
Matt Bierner 已提交
1175
	disabled?: string;
1176
}
1177

J
Johannes Rieken 已提交
1178
export interface ICodeActionListDto {
1179
	cacheId: number;
J
Johannes Rieken 已提交
1180
	actions: ReadonlyArray<ICodeActionDto>;
1181 1182
}

1183 1184 1185 1186 1187
export interface ICodeActionProviderMetadataDto {
	readonly providedKinds?: readonly string[];
	readonly documentation?: ReadonlyArray<{ readonly kind: string, readonly command: ICommandDto }>;
}

1188 1189 1190
export type CacheId = number;
export type ChainedCacheId = [CacheId, CacheId];

J
Johannes Rieken 已提交
1191
export interface ILinksListDto {
1192
	id?: CacheId;
J
Johannes Rieken 已提交
1193
	links: ILinkDto[];
1194 1195
}

J
Johannes Rieken 已提交
1196
export interface ILinkDto {
1197
	cacheId?: ChainedCacheId;
M
Martin Aeschlimann 已提交
1198 1199
	range: IRange;
	url?: string | UriComponents;
1200
	tooltip?: string;
M
Martin Aeschlimann 已提交
1201
}
1202

J
Johannes Rieken 已提交
1203
export interface ICodeLensListDto {
1204
	cacheId?: number;
J
Johannes Rieken 已提交
1205
	lenses: ICodeLensDto[];
1206 1207
}

J
Johannes Rieken 已提交
1208
export interface ICodeLensDto {
1209
	cacheId?: ChainedCacheId;
1210
	range: IRange;
J
Johannes Rieken 已提交
1211
	command?: ICommandDto;
1212
}
1213

J
jrieken 已提交
1214
export interface ICallHierarchyItemDto {
1215 1216
	_sessionId: string;
	_itemId: string;
1217 1218 1219 1220 1221 1222 1223 1224
	kind: modes.SymbolKind;
	name: string;
	detail?: string;
	uri: UriComponents;
	range: IRange;
	selectionRange: IRange;
}

1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
export interface IIncomingCallDto {
	from: ICallHierarchyItemDto;
	fromRanges: IRange[];
}

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

1235
export interface ExtHostLanguageFeaturesShape {
1236
	$provideDocumentSymbols(handle: number, resource: UriComponents, token: CancellationToken): Promise<modes.DocumentSymbol[] | undefined>;
J
Johannes Rieken 已提交
1237 1238
	$provideCodeLenses(handle: number, resource: UriComponents, token: CancellationToken): Promise<ICodeLensListDto | undefined>;
	$resolveCodeLens(handle: number, symbol: ICodeLensDto, token: CancellationToken): Promise<ICodeLensDto | undefined>;
1239
	$releaseCodeLenses(handle: number, id: number): void;
J
Johannes Rieken 已提交
1240 1241 1242 1243
	$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[]>;
1244 1245
	$provideHover(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.Hover | undefined>;
	$provideDocumentHighlights(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.DocumentHighlight[] | undefined>;
J
Johannes Rieken 已提交
1246 1247
	$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>;
1248
	$releaseCodeActions(handle: number, cacheId: number): void;
1249 1250 1251
	$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 已提交
1252 1253
	$provideWorkspaceSymbols(handle: number, search: string, token: CancellationToken): Promise<IWorkspaceSymbolsDto>;
	$resolveWorkspaceSymbol(handle: number, symbol: IWorkspaceSymbolDto, token: CancellationToken): Promise<IWorkspaceSymbolDto | undefined>;
1254
	$releaseWorkspaceSymbols(handle: number, id: number): void;
J
Johannes Rieken 已提交
1255
	$provideRenameEdits(handle: number, resource: UriComponents, position: IPosition, newName: string, token: CancellationToken): Promise<IWorkspaceEditDto | undefined>;
1256
	$resolveRenameLocation(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.RenameLocation | undefined>;
1257 1258 1259
	$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 已提交
1260 1261
	$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>;
1262
	$releaseCompletionItems(handle: number, id: number): void;
J
Johannes Rieken 已提交
1263
	$provideSignatureHelp(handle: number, resource: UriComponents, position: IPosition, context: modes.SignatureHelpContext, token: CancellationToken): Promise<ISignatureHelpDto | undefined>;
1264
	$releaseSignatureHelp(handle: number, id: number): void;
J
Johannes Rieken 已提交
1265 1266
	$provideDocumentLinks(handle: number, resource: UriComponents, token: CancellationToken): Promise<ILinksListDto | undefined>;
	$resolveDocumentLink(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<ILinkDto | undefined>;
1267
	$releaseDocumentLinks(handle: number, id: number): void;
J
Johannes Rieken 已提交
1268
	$provideDocumentColors(handle: number, resource: UriComponents, token: CancellationToken): Promise<IRawColorInfo[]>;
M
Matt Bierner 已提交
1269 1270
	$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>;
1271
	$provideSelectionRanges(handle: number, resource: UriComponents, positions: IPosition[], token: CancellationToken): Promise<modes.SelectionRange[][]>;
1272
	$prepareCallHierarchy(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<ICallHierarchyItemDto[] | undefined>;
1273 1274
	$provideCallHierarchyIncomingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IIncomingCallDto[] | undefined>;
	$provideCallHierarchyOutgoingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IOutgoingCallDto[] | undefined>;
1275
	$releaseCallHierarchy(handle: number, sessionId: string): void;
1276 1277
}

1278 1279
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
M
Matt Bierner 已提交
1280
	$validateInput(input: string): Promise<string | null | undefined>;
1281 1282 1283
	$onDidChangeActive(sessionId: number, handles: number[]): void;
	$onDidChangeSelection(sessionId: number, handles: number[]): void;
	$onDidAccept(sessionId: number): void;
1284
	$onDidChangeValue(sessionId: number, value: string): void;
C
Christof Marti 已提交
1285
	$onDidTriggerButton(sessionId: number, handle: number): void;
1286
	$onDidHide(sessionId: number): void;
1287 1288
}

J
Johannes Rieken 已提交
1289
export interface IShellLaunchConfigDto {
1290 1291 1292
	name?: string;
	executable?: string;
	args?: string[] | string;
1293
	cwd?: string | UriComponents;
1294
	env?: { [key: string]: string | null; };
1295 1296
}

D
Daniel Imms 已提交
1297 1298 1299 1300 1301
export interface IShellDefinitionDto {
	label: string;
	path: string;
}

D
Daniel Imms 已提交
1302 1303 1304 1305 1306
export interface IShellAndArgsDto {
	shell: string;
	args: string[] | string | undefined;
}

1307 1308 1309 1310 1311
export interface ITerminalDimensionsDto {
	columns: number;
	rows: number;
}

1312
export interface ExtHostTerminalServiceShape {
D
Daniel Imms 已提交
1313
	$acceptTerminalClosed(id: number, exitCode: number | undefined): void;
1314
	$acceptTerminalOpened(id: number, name: string, shellLaunchConfig: IShellLaunchConfigDto): void;
1315
	$acceptActiveTerminalChanged(id: number | null): void;
1316
	$acceptTerminalProcessId(id: number, processId: number): void;
A
Alex Dima 已提交
1317
	$acceptTerminalProcessData(id: number, data: string): void;
1318
	$acceptTerminalTitleChange(id: number, name: string): void;
1319
	$acceptTerminalDimensions(id: number, cols: number, rows: number): void;
1320
	$acceptTerminalMaximumDimensions(id: number, cols: number, rows: number): void;
1321
	$spawnExtHostProcess(id: number, shellLaunchConfig: IShellLaunchConfigDto, activeWorkspaceRootUri: UriComponents | undefined, cols: number, rows: number, isWorkspaceShellAllowed: boolean): void;
1322
	$startExtensionTerminal(id: number, initialDimensions: ITerminalDimensionsDto | undefined): void;
D
Daniel Imms 已提交
1323 1324
	$acceptProcessInput(id: number, data: string): void;
	$acceptProcessResize(id: number, cols: number, rows: number): void;
1325
	$acceptProcessShutdown(id: number, immediate: boolean): void;
1326 1327
	$acceptProcessRequestInitialCwd(id: number): void;
	$acceptProcessRequestCwd(id: number): void;
1328
	$acceptProcessRequestLatency(id: number): number;
1329
	$acceptWorkspacePermissionsChanged(isAllowed: boolean): void;
1330
	$getAvailableShells(): Promise<IShellDefinitionDto[]>;
1331
	$getDefaultShellAndArgs(useAutomationShell: boolean): Promise<IShellAndArgsDto>;
1332 1333
}

1334
export interface ExtHostSCMShape {
M
Matt Bierner 已提交
1335
	$provideOriginalResource(sourceControlHandle: number, uri: UriComponents, token: CancellationToken): Promise<UriComponents | null>;
A
Alex Dima 已提交
1336
	$onInputBoxValueChange(sourceControlHandle: number, value: string): void;
J
Johannes Rieken 已提交
1337 1338 1339
	$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 已提交
1340 1341
}

1342
export interface ExtHostTaskShape {
J
Johannes Rieken 已提交
1343
	$provideTasks(handle: number, validTypes: { [key: string]: boolean; }): Thenable<tasks.TaskSetDTO>;
1344
	$resolveTask(handle: number, taskDTO: tasks.TaskDTO): Thenable<tasks.TaskDTO | undefined>;
J
Johannes Rieken 已提交
1345 1346 1347 1348
	$onDidStartTask(execution: tasks.TaskExecutionDTO, terminalId: number): void;
	$onDidStartTaskProcess(value: tasks.TaskProcessStartedDTO): void;
	$onDidEndTaskProcess(value: tasks.TaskProcessEndedDTO): void;
	$OnDidEndTask(execution: tasks.TaskExecutionDTO): void;
1349 1350
	$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 已提交
1351
	$jsonTasksSupported(): Thenable<boolean>;
1352 1353
}

1354 1355
export interface IBreakpointDto {
	type: string;
1356
	id?: string;
1357 1358 1359
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
1360 1361 1362 1363 1364
	logMessage?: string;
}

export interface IFunctionBreakpointDto extends IBreakpointDto {
	type: 'function';
1365
	functionName: string;
1366 1367
}

I
isidor 已提交
1368 1369 1370 1371 1372
export interface IDataBreakpointDto extends IBreakpointDto {
	type: 'data';
	dataId: string;
	canPersist: boolean;
	label: string;
1373
	accessTypes?: DebugProtocol.DataBreakpointAccessType[];
I
isidor 已提交
1374 1375
}

1376
export interface ISourceBreakpointDto extends IBreakpointDto {
1377
	type: 'source';
1378
	uri: UriComponents;
1379 1380
	line: number;
	character: number;
1381 1382
}

1383
export interface IBreakpointsDeltaDto {
I
isidor 已提交
1384
	added?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1385
	removed?: string[];
I
isidor 已提交
1386
	changed?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1387 1388
}

1389 1390 1391 1392
export interface ISourceMultiBreakpointDto {
	type: 'sourceMulti';
	uri: UriComponents;
	lines: {
1393
		id: string;
1394 1395 1396
		enabled: boolean;
		condition?: string;
		hitCondition?: string;
1397
		logMessage?: string;
1398 1399 1400
		line: number;
		character: number;
	}[];
1401 1402
}

A
Andre Weinand 已提交
1403
export interface IDebugSessionFullDto {
1404 1405 1406
	id: DebugSessionUUID;
	type: string;
	name: string;
1407
	folderUri: UriComponents | undefined;
A
Andre Weinand 已提交
1408
	configuration: IConfig;
1409 1410
}

A
Andre Weinand 已提交
1411 1412
export type IDebugSessionDto = IDebugSessionFullDto | DebugSessionUUID;

1413
export interface ExtHostDebugServiceShape {
J
Johannes Rieken 已提交
1414
	$substituteVariables(folder: UriComponents | undefined, config: IConfig): Promise<IConfig>;
1415
	$runInTerminal(args: DebugProtocol.RunInTerminalRequestArguments): Promise<number | undefined>;
J
Johannes Rieken 已提交
1416 1417
	$startDASession(handle: number, session: IDebugSessionDto): Promise<void>;
	$stopDASession(handle: number): Promise<void>;
1418
	$sendDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
1419
	$resolveDebugConfiguration(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1420
	$resolveDebugConfigurationWithSubstitutedVariables(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1421
	$provideDebugConfigurations(handle: number, folder: UriComponents | undefined, token: CancellationToken): Promise<IConfig[]>;
J
Johannes Rieken 已提交
1422 1423
	$legacyDebugAdapterExecutable(handle: number, folderUri: UriComponents | undefined): Promise<IAdapterDescriptor>; // TODO@AW legacy
	$provideDebugAdapter(handle: number, session: IDebugSessionDto): Promise<IAdapterDescriptor>;
1424 1425
	$acceptDebugSessionStarted(session: IDebugSessionDto): void;
	$acceptDebugSessionTerminated(session: IDebugSessionDto): void;
1426
	$acceptDebugSessionActiveChanged(session: IDebugSessionDto | undefined): void;
1427 1428
	$acceptDebugSessionCustomEvent(session: IDebugSessionDto, event: any): void;
	$acceptBreakpointsDelta(delta: IBreakpointsDeltaDto): void;
1429
	$acceptDebugSessionNameChanged(session: IDebugSessionDto, name: string): void;
1430 1431
}

1432

1433 1434 1435 1436 1437 1438
export interface DecorationRequest {
	readonly id: number;
	readonly handle: number;
	readonly uri: UriComponents;
}

1439
export type DecorationData = [number, boolean, string, string, ThemeColor];
1440
export type DecorationReply = { [id: number]: DecorationData; };
1441 1442

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

1446 1447
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
1448 1449
}

S
Sandeep Somavarapu 已提交
1450
export interface ExtHostLogServiceShape {
A
Alex Dima 已提交
1451
	$setLevel(level: LogLevel): void;
S
Sandeep Somavarapu 已提交
1452 1453
}

J
Johannes Rieken 已提交
1454 1455 1456 1457
export interface MainThreadLogShape {
	$log(file: UriComponents, level: LogLevel, args: any[]): void;
}

1458 1459 1460 1461
export interface ExtHostOutputServiceShape {
	$setVisibleChannel(channelId: string | null): void;
}

1462 1463 1464 1465
export interface ExtHostProgressShape {
	$acceptProgressCanceled(handle: number): void;
}

M
Matt Bierner 已提交
1466
export interface ExtHostCommentsShape {
P
Peng Lyu 已提交
1467
	$createCommentThreadTemplate(commentControllerHandle: number, uriComponents: UriComponents, range: IRange): void;
1468
	$updateCommentThreadTemplate(commentControllerHandle: number, threadHandle: number, range: IRange): Promise<void>;
1469
	$deleteCommentThread(commentControllerHandle: number, commentThreadHandle: number): void;
P
Peng Lyu 已提交
1470
	$provideCommentingRanges(commentControllerHandle: number, uriComponents: UriComponents, token: CancellationToken): Promise<IRange[] | undefined>;
P
Peng Lyu 已提交
1471
	$toggleReaction(commentControllerHandle: number, threadHandle: number, uri: UriComponents, comment: modes.Comment, reaction: modes.CommentReaction): Promise<void>;
M
Matt Bierner 已提交
1472 1473
}

R
rebornix 已提交
1474
export interface ExtHostNotebookShape {
1475
	$resolveNotebook(viewType: string, uri: UriComponents): Promise<number | undefined>;
R
rebornix 已提交
1476 1477 1478
	$executeNotebook(viewType: string, uri: UriComponents, cellHandle: number | undefined): Promise<void>;
	// $latexRenderer(viewType: string, value: string): Promise<IMarkdownString | undefined>;
	$createEmptyCell(viewType: string, uri: UriComponents, index: number, language: string, type: 'markdown' | 'code'): Promise<ICellDto | undefined>;
1479 1480 1481 1482
	$deleteCell(viewType: string, uri: UriComponents, index: number): Promise<boolean>;
	$saveNotebook(viewType: string, uri: UriComponents): Promise<boolean>;
	$updateActiveEditor(viewType: string, uri: UriComponents): Promise<void>;
	$destoryNotebookDocument(viewType: string, uri: UriComponents): Promise<boolean>;
R
rebornix 已提交
1483 1484
}

1485
export interface ExtHostStorageShape {
1486
	$acceptValue(shared: boolean, key: string, value: object | undefined): void;
1487 1488
}

M
Martin Aeschlimann 已提交
1489 1490 1491 1492 1493 1494
export interface ExtHostThemingShape {
	$onColorThemeChange(themeType: string): void;
}

export interface MainThreadThemingShape extends IDisposable {
}
1495 1496

export interface ExtHostTunnelServiceShape {
1497
	$findCandidatePorts(): Promise<{ host: string, port: number, detail: string }[]>;
1498
	$filterCandidates(candidates: { host: string, port: number, detail: string }[]): Promise<boolean[]>;
1499 1500
	$forwardPort(tunnelOptions: TunnelOptions): Promise<TunnelDto> | undefined;
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
A
Alex Ross 已提交
1501
	$onDidTunnelsChange(): Promise<void>;
1502 1503
}

1504
export interface ExtHostTimelineShape {
1505
	$getTimeline(source: string, uri: UriComponents, token: CancellationToken): Promise<TimelineItemWithSource[]>;
1506 1507
}

1508 1509 1510
// --- proxy identifiers

export const MainContext = {
1511
	MainThreadAuthentication: createMainId<MainThreadAuthenticationShape>('MainThreadAuthentication'),
1512 1513
	MainThreadClipboard: createMainId<MainThreadClipboardShape>('MainThreadClipboard'),
	MainThreadCommands: createMainId<MainThreadCommandsShape>('MainThreadCommands'),
M
Matt Bierner 已提交
1514
	MainThreadComments: createMainId<MainThreadCommentsShape>('MainThreadComments'),
1515
	MainThreadConfiguration: createMainId<MainThreadConfigurationShape>('MainThreadConfiguration'),
1516
	MainThreadConsole: createMainId<MainThreadConsoleShape>('MainThreadConsole'),
1517
	MainThreadDebugService: createMainId<MainThreadDebugServiceShape>('MainThreadDebugService'),
1518 1519 1520 1521
	MainThreadDecorations: createMainId<MainThreadDecorationsShape>('MainThreadDecorations'),
	MainThreadDiagnostics: createMainId<MainThreadDiagnosticsShape>('MainThreadDiagnostics'),
	MainThreadDialogs: createMainId<MainThreadDiaglogsShape>('MainThreadDiaglogs'),
	MainThreadDocuments: createMainId<MainThreadDocumentsShape>('MainThreadDocuments'),
1522
	MainThreadDocumentContentProviders: createMainId<MainThreadDocumentContentProvidersShape>('MainThreadDocumentContentProviders'),
1523
	MainThreadTextEditors: createMainId<MainThreadTextEditorsShape>('MainThreadTextEditors'),
1524
	MainThreadEditorInsets: createMainId<MainThreadEditorInsetsShape>('MainThreadEditorInsets'),
1525 1526
	MainThreadErrors: createMainId<MainThreadErrorsShape>('MainThreadErrors'),
	MainThreadTreeViews: createMainId<MainThreadTreeViewsShape>('MainThreadTreeViews'),
1527
	MainThreadDownloadService: createMainId<MainThreadDownloadServiceShape>('MainThreadDownloadService'),
A
Alex Dima 已提交
1528
	MainThreadKeytar: createMainId<MainThreadKeytarShape>('MainThreadKeytar'),
1529
	MainThreadLanguageFeatures: createMainId<MainThreadLanguageFeaturesShape>('MainThreadLanguageFeatures'),
1530
	MainThreadLanguages: createMainId<MainThreadLanguagesShape>('MainThreadLanguages'),
J
Johannes Rieken 已提交
1531
	MainThreadLog: createMainId<MainThreadLogShape>('MainThread'),
1532
	MainThreadMessageService: createMainId<MainThreadMessageServiceShape>('MainThreadMessageService'),
1533 1534
	MainThreadOutputService: createMainId<MainThreadOutputServiceShape>('MainThreadOutputService'),
	MainThreadProgress: createMainId<MainThreadProgressShape>('MainThreadProgress'),
1535
	MainThreadQuickOpen: createMainId<MainThreadQuickOpenShape>('MainThreadQuickOpen'),
1536
	MainThreadStatusBar: createMainId<MainThreadStatusBarShape>('MainThreadStatusBar'),
1537
	MainThreadStorage: createMainId<MainThreadStorageShape>('MainThreadStorage'),
1538
	MainThreadTelemetry: createMainId<MainThreadTelemetryShape>('MainThreadTelemetry'),
1539
	MainThreadTerminalService: createMainId<MainThreadTerminalServiceShape>('MainThreadTerminalService'),
M
Matt Bierner 已提交
1540
	MainThreadWebviews: createMainId<MainThreadWebviewsShape>('MainThreadWebviews'),
J
Joao Moreno 已提交
1541
	MainThreadUrls: createMainId<MainThreadUrlsShape>('MainThreadUrls'),
1542
	MainThreadWorkspace: createMainId<MainThreadWorkspaceShape>('MainThreadWorkspace'),
1543
	MainThreadFileSystem: createMainId<MainThreadFileSystemShape>('MainThreadFileSystem'),
1544
	MainThreadExtensionService: createMainId<MainThreadExtensionServiceShape>('MainThreadExtensionService'),
J
Joao Moreno 已提交
1545
	MainThreadSCM: createMainId<MainThreadSCMShape>('MainThreadSCM'),
1546
	MainThreadSearch: createMainId<MainThreadSearchShape>('MainThreadSearch'),
1547
	MainThreadTask: createMainId<MainThreadTaskShape>('MainThreadTask'),
1548
	MainThreadWindow: createMainId<MainThreadWindowShape>('MainThreadWindow'),
R
rebornix 已提交
1549
	MainThreadLabelService: createMainId<MainThreadLabelServiceShape>('MainThreadLabelService'),
1550
	MainThreadNotebook: createMainId<MainThreadNotebookShape>('MainThreadNotebook'),
1551
	MainThreadTheming: createMainId<MainThreadThemingShape>('MainThreadTheming'),
1552 1553
	MainThreadTunnelService: createMainId<MainThreadTunnelServiceShape>('MainThreadTunnelService'),
	MainThreadTimeline: createMainId<MainThreadTimelineShape>('MainThreadTimeline')
1554 1555 1556
};

export const ExtHostContext = {
1557
	ExtHostCommands: createExtId<ExtHostCommandsShape>('ExtHostCommands'),
1558
	ExtHostConfiguration: createExtId<ExtHostConfigurationShape>('ExtHostConfiguration'),
1559
	ExtHostDiagnostics: createExtId<ExtHostDiagnosticsShape>('ExtHostDiagnostics'),
1560
	ExtHostDebugService: createExtId<ExtHostDebugServiceShape>('ExtHostDebugService'),
J
Johannes Rieken 已提交
1561
	ExtHostDecorations: createExtId<ExtHostDecorationsShape>('ExtHostDecorations'),
1562
	ExtHostDocumentsAndEditors: createExtId<ExtHostDocumentsAndEditorsShape>('ExtHostDocumentsAndEditors'),
1563
	ExtHostDocuments: createExtId<ExtHostDocumentsShape>('ExtHostDocuments'),
J
Johannes Rieken 已提交
1564
	ExtHostDocumentContentProviders: createExtId<ExtHostDocumentContentProvidersShape>('ExtHostDocumentContentProviders'),
J
Johannes Rieken 已提交
1565
	ExtHostDocumentSaveParticipant: createExtId<ExtHostDocumentSaveParticipantShape>('ExtHostDocumentSaveParticipant'),
J
Johannes Rieken 已提交
1566
	ExtHostEditors: createExtId<ExtHostEditorsShape>('ExtHostEditors'),
1567
	ExtHostTreeViews: createExtId<ExtHostTreeViewsShape>('ExtHostTreeViews'),
J
Johannes Rieken 已提交
1568
	ExtHostFileSystem: createExtId<ExtHostFileSystemShape>('ExtHostFileSystem'),
J
Johannes Rieken 已提交
1569
	ExtHostFileSystemEventService: createExtId<ExtHostFileSystemEventServiceShape>('ExtHostFileSystemEventService'),
1570
	ExtHostLanguageFeatures: createExtId<ExtHostLanguageFeaturesShape>('ExtHostLanguageFeatures'),
1571 1572
	ExtHostQuickOpen: createExtId<ExtHostQuickOpenShape>('ExtHostQuickOpen'),
	ExtHostExtensionService: createExtId<ExtHostExtensionServiceShape>('ExtHostExtensionService'),
1573
	ExtHostLogService: createExtId<ExtHostLogServiceShape>('ExtHostLogService'),
1574
	ExtHostTerminalService: createExtId<ExtHostTerminalServiceShape>('ExtHostTerminalService'),
J
Joao Moreno 已提交
1575
	ExtHostSCM: createExtId<ExtHostSCMShape>('ExtHostSCM'),
1576
	ExtHostSearch: createExtId<ExtHostSearchShape>('ExtHostSearch'),
1577
	ExtHostTask: createExtId<ExtHostTaskShape>('ExtHostTask'),
1578
	ExtHostWorkspace: createExtId<ExtHostWorkspaceShape>('ExtHostWorkspace'),
1579
	ExtHostWindow: createExtId<ExtHostWindowShape>('ExtHostWindow'),
1580
	ExtHostWebviews: createExtId<ExtHostWebviewsShape>('ExtHostWebviews'),
1581
	ExtHostEditorInsets: createExtId<ExtHostEditorInsetsShape>('ExtHostEditorInsets'),
M
Matt Bierner 已提交
1582
	ExtHostProgress: createMainId<ExtHostProgressShape>('ExtHostProgress'),
1583
	ExtHostComments: createMainId<ExtHostCommentsShape>('ExtHostComments'),
1584
	ExtHostStorage: createMainId<ExtHostStorageShape>('ExtHostStorage'),
1585 1586
	ExtHostUrls: createExtId<ExtHostUrlsShape>('ExtHostUrls'),
	ExtHostOutputService: createMainId<ExtHostOutputServiceShape>('ExtHostOutputService'),
R
rebornix 已提交
1587
	ExtHosLabelService: createMainId<ExtHostLabelServiceShape>('ExtHostLabelService'),
1588
	ExtHostNotebook: createMainId<ExtHostNotebookShape>('ExtHostNotebook'),
1589
	ExtHostTheming: createMainId<ExtHostThemingShape>('ExtHostTheming'),
1590
	ExtHostTunnelService: createMainId<ExtHostTunnelServiceShape>('ExtHostTunnelService'),
1591 1592
	ExtHostAuthentication: createMainId<ExtHostAuthenticationShape>('ExtHostAuthentication'),
	ExtHostTimeline: createMainId<ExtHostTimelineShape>('ExtHostTimeline')
1593
};