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

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

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

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

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

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

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

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

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

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

118 119
// --- main thread

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 已提交
242
	setEndOfLine?: EndOfLineSequence;
243 244
}

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

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

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

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

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

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

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

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

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

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

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

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

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

389
export interface MainThreadMessageOptions {
390
	extension?: IExtensionDescription;
391
	modal?: boolean;
392 393
}

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

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

408
export interface MainThreadProgressShape extends IDisposable {
409

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

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

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

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

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

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

export type TransferQuickInput = TransferQuickPick | TransferInputBox;

export interface BaseTransferQuickInput {

461 462
	[key: string]: any;

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

C
Christof Marti 已提交
484
	items?: TransferQuickPickItems[];
485

486 487 488 489
	activeItems?: number[];

	selectedItems?: number[];

490 491 492 493 494 495 496
	canSelectMany?: boolean;

	ignoreFocusOut?: boolean;

	matchOnDescription?: boolean;

	matchOnDetail?: boolean;
497 498

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

export interface TransferInputBox extends BaseTransferQuickInput {

	type?: 'inputBox';

	value?: string;

	placeholder?: string;

	password?: boolean;

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

	prompt?: string;

	validationMessage?: string;
}

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

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

536
export interface MainThreadStatusBarShape extends IDisposable {
J
Johannes Rieken 已提交
537
	$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;
538
	$dispose(id: number): void;
539 540
}

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

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

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

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

export type WebviewPanelHandle = string;
566

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

572 573 574 575 576
export interface WebviewExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
}

R
rebornix 已提交
577 578 579 580 581
export interface NotebookExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
}

582
export enum WebviewEditorCapabilities {
M
Matt Bierner 已提交
583
	Editable,
584
	SupportsHotExit,
585 586
}

M
Matt Bierner 已提交
587
export interface MainThreadWebviewsShape extends IDisposable {
588
	$createWebviewPanel(extension: WebviewExtensionDescription, handle: WebviewPanelHandle, viewType: string, title: string, showOptions: WebviewPanelShowOptions, options: modes.IWebviewPanelOptions & modes.IWebviewOptions): void;
589
	$disposeWebview(handle: WebviewPanelHandle): void;
M
Matt Bierner 已提交
590
	$reveal(handle: WebviewPanelHandle, showOptions: WebviewPanelShowOptions): void;
591
	$setTitle(handle: WebviewPanelHandle, value: string): void;
592
	$setIconPath(handle: WebviewPanelHandle, value: { light: UriComponents, dark: UriComponents; } | undefined): void;
593

594 595
	$setHtml(handle: WebviewPanelHandle, value: string): void;
	$setOptions(handle: WebviewPanelHandle, options: modes.IWebviewOptions): void;
596

597
	$postMessage(handle: WebviewPanelHandle, value: any): Promise<boolean>;
598 599 600

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

602 603
	$registerTextEditorProvider(extension: WebviewExtensionDescription, viewType: string, options: modes.IWebviewPanelOptions): void;
	$registerCustomEditorProvider(extension: WebviewExtensionDescription, viewType: string, options: modes.IWebviewPanelOptions): void;
604
	$unregisterEditorProvider(viewType: string): void;
605

606
	$onDidChangeCustomDocumentState(resource: UriComponents, viewType: string, state: { dirty: boolean }): void;
M
Matt Bierner 已提交
607
}
608

609 610 611 612 613 614
export interface WebviewPanelViewStateData {
	[handle: string]: {
		readonly active: boolean;
		readonly visible: boolean;
		readonly position: EditorViewColumn;
	};
M
Matt Bierner 已提交
615 616
}

M
Matt Bierner 已提交
617
export interface ExtHostWebviewsShape {
618
	$onMessage(handle: WebviewPanelHandle, message: any): void;
619
	$onMissingCsp(handle: WebviewPanelHandle, extensionId: string): void;
620
	$onDidChangeWebviewPanelViewStates(newState: WebviewPanelViewStateData): void;
J
Johannes Rieken 已提交
621
	$onDidDisposeWebviewPanel(handle: WebviewPanelHandle): Promise<void>;
622

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

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

629 630 631
	$undo(resource: UriComponents, viewType: string): void;
	$redo(resource: UriComponents, viewType: string): void;
	$revert(resource: UriComponents, viewType: string): void;
632 633
	$onSave(resource: UriComponents, viewType: string): Promise<void>;
	$onSaveAs(resource: UriComponents, viewType: string, targetResource: UriComponents): Promise<void>;
M
Matt Bierner 已提交
634

M
Matt Bierner 已提交
635
	$backup(resource: UriComponents, viewType: string, cancellation: CancellationToken): Promise<void>;
M
Matt Bierner 已提交
636 637
}

638 639 640 641 642 643 644 645
export interface ICellDto {
	handle: number;
	source: string[];
	language: string;
	cell_type: 'markdown' | 'code';
	outputs: IOutput[];
}

646 647 648 649 650 651 652 653 654 655 656 657
export type NotebookCellsSplice = [
	number /* start */,
	number /* delete count */,
	ICellDto[]
];

export type NotebookCellOutputsSplice = [
	number /* start */,
	number /* delete count */,
	IOutput[]
];

R
rebornix 已提交
658
export interface MainThreadNotebookShape extends IDisposable {
R
rebornix 已提交
659 660
	$registerNotebookProvider(extension: NotebookExtensionDescription, viewType: string): Promise<void>;
	$unregisterNotebookProvider(viewType: string): Promise<void>;
R
rebornix 已提交
661
	$registerNotebookRenderer(extension: NotebookExtensionDescription, type: string, selectors: INotebookMimeTypeSelector, handle: number, preloads: UriComponents[]): Promise<void>;
R
rebornix 已提交
662
	$unregisterNotebookRenderer(handle: number): Promise<void>;
R
rebornix 已提交
663 664
	$createNotebookDocument(handle: number, viewType: string, resource: UriComponents): Promise<void>;
	$updateNotebookLanguages(viewType: string, resource: UriComponents, languages: string[]): Promise<void>;
665 666
	$spliceNotebookCells(viewType: string, resource: UriComponents, splices: NotebookCellsSplice[], renderers: number[]): Promise<void>;
	$spliceNotebookCellOutputs(viewType: string, resource: UriComponents, cellHandle: number, splices: NotebookCellOutputsSplice[], renderers: number[]): Promise<void>;
R
rebornix 已提交
667 668
}

J
Joao Moreno 已提交
669
export interface MainThreadUrlsShape extends IDisposable {
670
	$registerUriHandler(handle: number, extensionId: ExtensionIdentifier): Promise<void>;
J
Johannes Rieken 已提交
671
	$unregisterUriHandler(handle: number): Promise<void>;
672
	$createAppUri(uri: UriComponents): Promise<UriComponents>;
J
Joao Moreno 已提交
673 674 675
}

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

679 680 681 682
export interface ITextSearchComplete {
	limitHit?: boolean;
}

683
export interface MainThreadWorkspaceShape extends IDisposable {
684
	$startFileSearch(includePattern: string | null, includeFolder: UriComponents | null, excludePatternOrDisregardExcludes: string | false | null, maxResults: number | null, token: CancellationToken): Promise<UriComponents[] | null>;
685
	$startTextSearch(query: search.IPatternInfo, folder: UriComponents | null, options: ITextQueryBuilderOptions, requestId: number, token: CancellationToken): Promise<ITextSearchComplete | null>;
686
	$checkExists(folders: UriComponents[], includes: string[], token: CancellationToken): Promise<boolean>;
J
Johannes Rieken 已提交
687
	$saveAll(includeUntitled?: boolean): Promise<boolean>;
688
	$updateWorkspaceFolders(extensionName: string, index: number, deleteCount: number, workspaceFoldersToAdd: { uri: UriComponents, name?: string; }[]): Promise<void>;
689
	$resolveProxy(url: string): Promise<string | undefined>;
690
}
691

J
Johannes Rieken 已提交
692 693
export interface IFileChangeDto {
	resource: UriComponents;
J
Johannes Rieken 已提交
694
	type: files.FileChangeType;
J
Johannes Rieken 已提交
695 696
}

697
export interface MainThreadFileSystemShape extends IDisposable {
J
Johannes Rieken 已提交
698
	$registerFileSystemProvider(handle: number, scheme: string, capabilities: files.FileSystemProviderCapabilities): void;
699
	$unregisterProvider(handle: number): void;
J
Johannes Rieken 已提交
700
	$onFileSystemChange(handle: number, resource: IFileChangeDto[]): void;
701 702 703 704

	$stat(uri: UriComponents): Promise<files.IStat>;
	$readdir(resource: UriComponents): Promise<[string, files.FileType][]>;
	$readFile(resource: UriComponents): Promise<VSBuffer>;
705
	$writeFile(resource: UriComponents, content: VSBuffer): Promise<void>;
706 707 708 709
	$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>;
710
}
J
Johannes Rieken 已提交
711

712 713 714 715 716
export interface MainThreadLabelServiceShape extends IDisposable {
	$registerResourceLabelFormatter(handle: number, formatter: ResourceLabelFormatter): void;
	$unregisterResourceLabelFormatter(handle: number): void;
}

717
export interface MainThreadSearchShape extends IDisposable {
718 719
	$registerFileSearchProvider(handle: number, scheme: string): void;
	$registerTextSearchProvider(handle: number, scheme: string): void;
720
	$unregisterProvider(handle: number): void;
721
	$handleFileMatch(handle: number, session: number, data: UriComponents[]): void;
J
Johannes Rieken 已提交
722
	$handleTextMatch(handle: number, session: number, data: search.IRawFileMatch2[]): void;
723
	$handleTelemetry(eventName: string, data: any): void;
724 725
}

726
export interface MainThreadTaskShape extends IDisposable {
J
Johannes Rieken 已提交
727
	$createTaskId(task: tasks.TaskDTO): Promise<string>;
728
	$registerTaskProvider(handle: number, type: string): Promise<void>;
J
Johannes Rieken 已提交
729
	$unregisterTaskProvider(handle: number): Promise<void>;
J
Johannes Rieken 已提交
730 731
	$fetchTasks(filter?: tasks.TaskFilterDTO): Promise<tasks.TaskDTO[]>;
	$executeTask(task: tasks.TaskHandleDTO | tasks.TaskDTO): Promise<tasks.TaskExecutionDTO>;
J
Johannes Rieken 已提交
732
	$terminateTask(id: string): Promise<void>;
J
Johannes Rieken 已提交
733
	$registerTaskSystem(scheme: string, info: tasks.TaskSystemInfoDTO): void;
G
Gabriel DeBacker 已提交
734
	$customExecutionComplete(id: string, result?: number): Promise<void>;
735 736
}

737
export interface MainThreadExtensionServiceShape extends IDisposable {
738
	$activateExtension(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<void>;
739
	$onWillActivateExtension(extensionId: ExtensionIdentifier): void;
740
	$onDidActivateExtension(extensionId: ExtensionIdentifier, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number, activationReason: ExtensionActivationReason): void;
741
	$onExtensionActivationError(extensionId: ExtensionIdentifier, error: ExtensionActivationError): Promise<void>;
742
	$onExtensionRuntimeError(extensionId: ExtensionIdentifier, error: SerializedError): void;
A
Alex Dima 已提交
743
	$onExtensionHostExit(code: number): void;
744 745
}

J
Joao Moreno 已提交
746
export interface SCMProviderFeatures {
J
Joao Moreno 已提交
747 748
	hasQuickDiffProvider?: boolean;
	count?: number;
749 750
	commitTemplate?: string;
	acceptInputCommand?: modes.Command;
J
Johannes Rieken 已提交
751
	statusBarCommands?: ICommandDto[];
J
Joao Moreno 已提交
752 753 754 755
}

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

J
Joao Moreno 已提交
758
export type SCMRawResource = [
759
	number /*handle*/,
760
	UriComponents /*resourceUri*/,
761
	UriComponents[] /*icons: light, dark*/,
762
	string /*tooltip*/,
763
	boolean /*strike through*/,
764
	boolean /*faded*/
J
Joao Moreno 已提交
765
];
766

767 768 769
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
770 771 772
	SCMRawResource[]
];

773 774 775 776 777
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

778
export interface MainThreadSCMShape extends IDisposable {
779
	$registerSourceControl(handle: number, id: string, label: string, rootUri: UriComponents | undefined): void;
780 781
	$updateSourceControl(handle: number, features: SCMProviderFeatures): void;
	$unregisterSourceControl(handle: number): void;
J
Joao Moreno 已提交
782

783 784 785 786
	$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 已提交
787

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

J
Joao Moreno 已提交
790
	$setInputBoxValue(sourceControlHandle: number, value: string): void;
791
	$setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
792
	$setInputBoxVisibility(sourceControlHandle: number, visible: boolean): void;
793
	$setValidationProviderIsEnabled(sourceControlHandle: number, enabled: boolean): void;
J
Joao Moreno 已提交
794 795
}

796 797
export type DebugSessionUUID = string;

798 799 800 801 802 803 804
export interface IDebugConfiguration {
	type: string;
	name: string;
	request: string;
	[key: string]: any;
}

805 806 807 808 809
export interface IStartDebuggingOptions {
	parentSessionID?: DebugSessionUUID;
	repl?: IDebugSessionReplMode;
}

810
export interface MainThreadDebugServiceShape extends IDisposable {
A
Alex Dima 已提交
811
	$registerDebugTypes(debugTypes: string[]): void;
812
	$sessionCached(sessionID: string): void;
A
Alex Dima 已提交
813
	$acceptDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
814 815
	$acceptDAError(handle: number, name: string, message: string, stack: string | undefined): void;
	$acceptDAExit(handle: number, code: number | undefined, signal: string | undefined): void;
816
	$registerDebugConfigurationProvider(type: string, hasProvideMethod: boolean, hasResolveMethod: boolean, hasResolve2Method: boolean, hasProvideDaMethod: boolean, handle: number): Promise<void>;
J
Johannes Rieken 已提交
817
	$registerDebugAdapterDescriptorFactory(type: string, handle: number): Promise<void>;
818
	$unregisterDebugConfigurationProvider(handle: number): void;
A
Andre Weinand 已提交
819
	$unregisterDebugAdapterDescriptorFactory(handle: number): void;
I
isidor 已提交
820
	$startDebugging(folder: UriComponents | undefined, nameOrConfig: string | IDebugConfiguration, options: IStartDebuggingOptions): Promise<boolean>;
821
	$setDebugSessionName(id: DebugSessionUUID, name: string): void;
J
Johannes Rieken 已提交
822
	$customDebugAdapterRequest(id: DebugSessionUUID, command: string, args: any): Promise<any>;
823 824
	$appendDebugConsole(value: string): void;
	$startBreakpointEvents(): void;
I
isidor 已提交
825 826
	$registerBreakpoints(breakpoints: Array<ISourceMultiBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>): Promise<void>;
	$unregisterBreakpoints(breakpointIds: string[], functionBreakpointIds: string[], dataBreakpointIds: string[]): Promise<void>;
827 828
}

829 830 831 832
export interface IOpenUriOptions {
	readonly allowTunneling?: boolean;
}

833
export interface MainThreadWindowShape extends IDisposable {
J
Johannes Rieken 已提交
834
	$getWindowVisibility(): Promise<boolean>;
835
	$openUri(uri: UriComponents, uriString: string | undefined, options: IOpenUriOptions): Promise<boolean>;
836
	$asExternalUri(uri: UriComponents, options: IOpenUriOptions): Promise<UriComponents>;
837 838
}

A
Alex Ross 已提交
839 840
export interface MainThreadTunnelServiceShape extends IDisposable {
	$openTunnel(tunnelOptions: TunnelOptions): Promise<TunnelDto | undefined>;
841
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
842
	$getTunnels(): Promise<TunnelDescription[]>;
A
Alex Ross 已提交
843
	$registerCandidateFinder(): Promise<void>;
844
	$setTunnelProvider(): Promise<void>;
845
	$setCandidateFilter(): Promise<void>;
A
Alex Ross 已提交
846 847
}

848
export interface MainThreadTimelineShape extends IDisposable {
849 850
	$registerTimelineProvider(provider: TimelineProviderDescriptor): void;
	$unregisterTimelineProvider(source: string): void;
851
	$emitTimelineChangeEvent(e: TimelineChangeEvent): void;
852 853
}

854 855
// -- extension host

856
export interface ExtHostCommandsShape {
J
Johannes Rieken 已提交
857
	$executeContributedCommand<T>(id: string, ...args: any[]): Promise<T>;
858
	$getContributedCommandHandlerDescriptions(): Promise<{ [id: string]: string | ICommandHandlerDescription; }>;
859 860
}

861
export interface ExtHostConfigurationShape {
862
	$initializeConfiguration(data: IConfigurationInitData): void;
863
	$acceptConfigurationChanged(data: IConfigurationInitData, change: IConfigurationChange): void;
864 865
}

866
export interface ExtHostDiagnosticsShape {
J
Johannes Rieken 已提交
867
	$acceptMarkersChange(data: [UriComponents, IMarkerData[]][]): void;
868 869
}

870
export interface ExtHostDocumentContentProvidersShape {
M
Matt Bierner 已提交
871
	$provideTextDocumentContent(handle: number, uri: UriComponents): Promise<string | null | undefined>;
872 873
}

874
export interface IModelAddedData {
875
	uri: UriComponents;
876
	versionId: number;
877 878
	lines: string[];
	EOL: string;
879 880 881
	modeId: string;
	isDirty: boolean;
}
882
export interface ExtHostDocumentsShape {
883 884 885 886
	$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;
887 888
}

889
export interface ExtHostDocumentSaveParticipantShape {
J
Johannes Rieken 已提交
890
	$participateInSave(resource: UriComponents, reason: SaveReason): Promise<boolean[]>;
891 892
}

893 894
export interface ITextEditorAddData {
	id: string;
895
	documentUri: UriComponents;
896
	options: IResolvedTextEditorConfiguration;
A
Alex Dima 已提交
897
	selections: ISelection[];
898
	visibleRanges: IRange[];
A
Alex Dima 已提交
899
	editorPosition: EditorViewColumn | undefined;
900 901
}
export interface ITextEditorPositionData {
902
	[id: string]: EditorViewColumn;
903
}
904 905 906
export interface IEditorPropertiesChangeData {
	options: IResolvedTextEditorConfiguration | null;
	selections: ISelectionChangeEvent | null;
907
	visibleRanges: IRange[] | null;
908 909 910 911 912 913
}
export interface ISelectionChangeEvent {
	selections: Selection[];
	source?: string;
}

914
export interface ExtHostEditorsShape {
915
	$acceptEditorPropertiesChanged(id: string, props: IEditorPropertiesChangeData): void;
916
	$acceptEditorPositionData(data: ITextEditorPositionData): void;
917 918
}

J
Johannes Rieken 已提交
919
export interface IDocumentsAndEditorsDelta {
920
	removedDocuments?: UriComponents[];
J
Johannes Rieken 已提交
921 922 923
	addedDocuments?: IModelAddedData[];
	removedEditors?: string[];
	addedEditors?: ITextEditorAddData[];
A
Alex Dima 已提交
924
	newActiveEditor?: string | null;
J
Johannes Rieken 已提交
925 926
}

927 928
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
929 930
}

931
export interface ExtHostTreeViewsShape {
J
Johannes Rieken 已提交
932
	$getChildren(treeViewId: string, treeItemHandle?: string): Promise<ITreeItem[]>;
933
	$setExpanded(treeViewId: string, treeItemHandle: string, expanded: boolean): void;
934
	$setSelection(treeViewId: string, treeItemHandles: string[]): void;
935
	$setVisible(treeViewId: string, visible: boolean): void;
S
Sandeep Somavarapu 已提交
936 937
}

938
export interface ExtHostWorkspaceShape {
939
	$initializeWorkspace(workspace: IWorkspaceData | null): void;
940
	$acceptWorkspaceData(workspace: IWorkspaceData | null): void;
J
Johannes Rieken 已提交
941
	$handleTextSearchResult(result: search.IRawFileMatch2, requestId: number): void;
942
}
943

944
export interface ExtHostFileSystemShape {
J
Johannes Rieken 已提交
945 946
	$stat(handle: number, resource: UriComponents): Promise<files.IStat>;
	$readdir(handle: number, resource: UriComponents): Promise<[string, files.FileType][]>;
947 948
	$readFile(handle: number, resource: UriComponents): Promise<VSBuffer>;
	$writeFile(handle: number, resource: UriComponents, content: VSBuffer, opts: files.FileWriteOptions): Promise<void>;
J
Johannes Rieken 已提交
949 950
	$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 已提交
951
	$mkdir(handle: number, resource: UriComponents): Promise<void>;
J
Johannes Rieken 已提交
952 953
	$delete(handle: number, resource: UriComponents, opts: files.FileDeleteOptions): Promise<void>;
	$watch(handle: number, session: number, resource: UriComponents, opts: files.IWatchOptions): void;
954
	$unwatch(handle: number, session: number): void;
J
Johannes Rieken 已提交
955
	$open(handle: number, resource: UriComponents, opts: files.FileOpenOptions): Promise<number>;
J
Johannes Rieken 已提交
956
	$close(handle: number, fd: number): Promise<void>;
957 958
	$read(handle: number, fd: number, pos: number, length: number): Promise<VSBuffer>;
	$write(handle: number, fd: number, pos: number, data: VSBuffer): Promise<number>;
959
}
960

961 962 963 964
export interface ExtHostLabelServiceShape {
	$registerResourceLabelFormatter(formatter: ResourceLabelFormatter): IDisposable;
}

965
export interface ExtHostAuthenticationShape {
966
	$getSessions(id: string): Promise<ReadonlyArray<modes.AuthenticationSession>>;
967
	$getSessionAccessToken(id: string, sessionId: string): Promise<string>;
968
	$login(id: string, scopes: string[]): Promise<modes.AuthenticationSession>;
969
	$logout(id: string, sessionId: string): Promise<void>;
970 971
}

972
export interface ExtHostSearchShape {
J
Johannes Rieken 已提交
973 974
	$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 已提交
975
	$clearCache(cacheKey: string): Promise<void>;
976 977
}

A
Tweaks  
Alex Dima 已提交
978 979 980 981 982 983 984 985 986 987 988
export interface IResolveAuthorityErrorResult {
	type: 'error';
	error: {
		message: string | undefined;
		code: RemoteAuthorityResolverErrorCode;
		detail: any;
	};
}

export interface IResolveAuthorityOKResult {
	type: 'ok';
989
	value: ResolverResult;
A
Tweaks  
Alex Dima 已提交
990 991 992 993
}

export type IResolveAuthorityResult = IResolveAuthorityErrorResult | IResolveAuthorityOKResult;

994
export interface ExtHostExtensionServiceShape {
A
Tweaks  
Alex Dima 已提交
995
	$resolveAuthority(remoteAuthority: string, resolveAttempt: number): Promise<IResolveAuthorityResult>;
996
	$startExtensionHost(enabledExtensionIds: ExtensionIdentifier[]): Promise<void>;
J
Johannes Rieken 已提交
997
	$activateByEvent(activationEvent: string): Promise<void>;
998
	$activate(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<boolean>;
999
	$setRemoteEnvironment(env: { [key: string]: string | null; }): Promise<void>;
1000

1001
	$deltaExtensions(toAdd: IExtensionDescription[], toRemove: ExtensionIdentifier[]): Promise<void>;
1002 1003

	$test_latency(n: number): Promise<number>;
1004 1005
	$test_up(b: VSBuffer): Promise<number>;
	$test_down(size: number): Promise<VSBuffer>;
1006 1007 1008
}

export interface FileSystemEvents {
J
Johannes Rieken 已提交
1009 1010 1011
	created: UriComponents[];
	changed: UriComponents[];
	deleted: UriComponents[];
1012
}
1013

1014
export interface ExtHostFileSystemEventServiceShape {
1015
	$onFileEvent(events: FileSystemEvents): void;
1016
	$onWillRunFileOperation(operation: files.FileOperation, target: UriComponents, source: UriComponents | undefined, timeout: number, token: CancellationToken): Promise<any>;
1017
	$onDidRunFileOperation(operation: files.FileOperation, target: UriComponents, source: UriComponents | undefined): void;
1018 1019
}

J
Johannes Rieken 已提交
1020
export interface ObjectIdentifier {
1021
	$ident?: number;
J
Johannes Rieken 已提交
1022 1023 1024
}

export namespace ObjectIdentifier {
1025
	export const name = '$ident';
J
Johannes Rieken 已提交
1026
	export function mixin<T>(obj: T, id: number): T & ObjectIdentifier {
1027
		Object.defineProperty(obj, name, { value: id, enumerable: true });
J
Johannes Rieken 已提交
1028 1029
		return <T & ObjectIdentifier>obj;
	}
1030 1031
	export function of(obj: any): number {
		return obj[name];
J
Johannes Rieken 已提交
1032 1033 1034
	}
}

1035 1036
export interface ExtHostHeapServiceShape {
	$onGarbageCollection(ids: number[]): void;
1037
}
1038
export interface IRawColorInfo {
J
Joao Moreno 已提交
1039
	color: [number, number, number, number];
1040 1041 1042
	range: IRange;
}

1043 1044 1045 1046 1047 1048 1049 1050 1051
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;
	}
}

1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
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 已提交
1067 1068 1069

	// to merge into label
	label2 = 'o',
1070 1071
}

J
Johannes Rieken 已提交
1072
export interface ISuggestDataDto {
1073
	[ISuggestDataDtoField.label]: string;
P
label2  
Pine Wu 已提交
1074
	[ISuggestDataDtoField.label2]?: string | modes.CompletionItemLabel;
1075 1076 1077 1078 1079
	[ISuggestDataDtoField.kind]: modes.CompletionItemKind;
	[ISuggestDataDtoField.detail]?: string;
	[ISuggestDataDtoField.documentation]?: string | IMarkdownString;
	[ISuggestDataDtoField.sortText]?: string;
	[ISuggestDataDtoField.filterText]?: string;
1080
	[ISuggestDataDtoField.preselect]?: true;
1081 1082
	[ISuggestDataDtoField.insertText]?: string;
	[ISuggestDataDtoField.insertTextRules]?: modes.CompletionItemInsertTextRule;
1083
	[ISuggestDataDtoField.range]?: IRange | { insert: IRange, replace: IRange; };
1084 1085 1086 1087
	[ISuggestDataDtoField.commitCharacters]?: string[];
	[ISuggestDataDtoField.additionalTextEdits]?: ISingleEditOperation[];
	[ISuggestDataDtoField.command]?: modes.Command;
	[ISuggestDataDtoField.kindModifier]?: modes.CompletionItemTag[];
J
Johannes Rieken 已提交
1088
	// not-standard
1089
	x?: ChainedCacheId;
J
Johannes Rieken 已提交
1090 1091
}

1092 1093 1094 1095 1096 1097
export const enum ISuggestResultDtoField {
	defaultRanges = 'a',
	completions = 'b',
	isIncomplete = 'c'
}

J
Johannes Rieken 已提交
1098
export interface ISuggestResultDto {
1099 1100 1101
	[ISuggestResultDtoField.defaultRanges]: { insert: IRange, replace: IRange; };
	[ISuggestResultDtoField.completions]: ISuggestDataDto[];
	[ISuggestResultDtoField.isIncomplete]: undefined | true;
1102
	x?: number;
1103 1104
}

J
Johannes Rieken 已提交
1105
export interface ISignatureHelpDto {
1106 1107 1108 1109 1110 1111
	id: CacheId;
	signatures: modes.SignatureInformation[];
	activeSignature: number;
	activeParameter: number;
}

J
Johannes Rieken 已提交
1112
export interface ISignatureHelpContextDto {
1113 1114 1115
	readonly triggerKind: modes.SignatureHelpTriggerKind;
	readonly triggerCharacter?: string;
	readonly isRetrigger: boolean;
J
Johannes Rieken 已提交
1116
	readonly activeSignatureHelp?: ISignatureHelpDto;
1117 1118
}

J
Johannes Rieken 已提交
1119
export interface ILocationDto {
1120 1121
	uri: UriComponents;
	range: IRange;
1122 1123
}

J
Johannes Rieken 已提交
1124
export interface IDefinitionLinkDto {
J
Johannes Rieken 已提交
1125
	originSelectionRange?: IRange;
M
Matt Bierner 已提交
1126 1127
	uri: UriComponents;
	range: IRange;
J
Johannes Rieken 已提交
1128
	targetSelectionRange?: IRange;
M
Matt Bierner 已提交
1129 1130
}

J
Johannes Rieken 已提交
1131
export interface IWorkspaceSymbolDto extends IdObject {
1132 1133 1134
	name: string;
	containerName?: string;
	kind: modes.SymbolKind;
J
Johannes Rieken 已提交
1135
	location: ILocationDto;
1136 1137
}

J
Johannes Rieken 已提交
1138 1139
export interface IWorkspaceSymbolsDto extends IdObject {
	symbols: IWorkspaceSymbolDto[];
1140 1141
}

1142 1143 1144 1145 1146 1147 1148
export interface IWorkspaceEditEntryMetadataDto {
	needsConfirmation: boolean;
	label: string;
	description?: string;
	iconPath?: { id: string } | UriComponents | { light: UriComponents, dark: UriComponents };
}

1149
export interface IWorkspaceFileEditDto {
M
Matt Bierner 已提交
1150 1151
	oldUri?: UriComponents;
	newUri?: UriComponents;
1152
	options?: modes.WorkspaceFileEditOptions
1153
	metadata?: IWorkspaceEditEntryMetadataDto;
1154 1155
}

1156
export interface IWorkspaceTextEditDto {
1157
	resource: UriComponents;
1158
	edit: modes.TextEdit;
1159
	modelVersionId?: number;
1160
	metadata?: IWorkspaceEditEntryMetadataDto;
1161 1162
}

J
Johannes Rieken 已提交
1163
export interface IWorkspaceEditDto {
1164
	edits: Array<IWorkspaceFileEditDto | IWorkspaceTextEditDto>;
1165 1166

	// todo@joh reject should go into rename
1167 1168 1169
	rejectReason?: string;
}

J
Johannes Rieken 已提交
1170
export function reviveWorkspaceEditDto(data: IWorkspaceEditDto | undefined): modes.WorkspaceEdit {
1171 1172
	if (data && data.edits) {
		for (const edit of data.edits) {
1173 1174
			if (typeof (<IWorkspaceTextEditDto>edit).resource === 'object') {
				(<IWorkspaceTextEditDto>edit).resource = URI.revive((<IWorkspaceTextEditDto>edit).resource);
1175
			} else {
1176 1177
				(<IWorkspaceFileEditDto>edit).newUri = URI.revive((<IWorkspaceFileEditDto>edit).newUri);
				(<IWorkspaceFileEditDto>edit).oldUri = URI.revive((<IWorkspaceFileEditDto>edit).oldUri);
1178
			}
1179 1180 1181
			if (edit.metadata && edit.metadata.iconPath) {
				edit.metadata = revive(edit.metadata);
			}
1182 1183 1184 1185 1186
		}
	}
	return <modes.WorkspaceEdit>data;
}

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

J
Johannes Rieken 已提交
1189
export interface ICodeActionDto {
1190
	title: string;
J
Johannes Rieken 已提交
1191
	edit?: IWorkspaceEditDto;
1192
	diagnostics?: IMarkerData[];
J
Johannes Rieken 已提交
1193
	command?: ICommandDto;
J
Johannes Rieken 已提交
1194
	kind?: string;
1195
	isPreferred?: boolean;
M
Matt Bierner 已提交
1196
	disabled?: string;
1197
}
1198

J
Johannes Rieken 已提交
1199
export interface ICodeActionListDto {
1200
	cacheId: number;
J
Johannes Rieken 已提交
1201
	actions: ReadonlyArray<ICodeActionDto>;
1202 1203
}

1204 1205 1206 1207 1208
export interface ICodeActionProviderMetadataDto {
	readonly providedKinds?: readonly string[];
	readonly documentation?: ReadonlyArray<{ readonly kind: string, readonly command: ICommandDto }>;
}

1209 1210 1211
export type CacheId = number;
export type ChainedCacheId = [CacheId, CacheId];

J
Johannes Rieken 已提交
1212
export interface ILinksListDto {
1213
	id?: CacheId;
J
Johannes Rieken 已提交
1214
	links: ILinkDto[];
1215 1216
}

J
Johannes Rieken 已提交
1217
export interface ILinkDto {
1218
	cacheId?: ChainedCacheId;
M
Martin Aeschlimann 已提交
1219 1220
	range: IRange;
	url?: string | UriComponents;
1221
	tooltip?: string;
M
Martin Aeschlimann 已提交
1222
}
1223

J
Johannes Rieken 已提交
1224
export interface ICodeLensListDto {
1225
	cacheId?: number;
J
Johannes Rieken 已提交
1226
	lenses: ICodeLensDto[];
1227 1228
}

J
Johannes Rieken 已提交
1229
export interface ICodeLensDto {
1230
	cacheId?: ChainedCacheId;
1231
	range: IRange;
J
Johannes Rieken 已提交
1232
	command?: ICommandDto;
1233
}
1234

J
Johannes Rieken 已提交
1235
export type ICallHierarchyItemDto = Dto<CallHierarchyItem>;
1236

1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
export interface IIncomingCallDto {
	from: ICallHierarchyItemDto;
	fromRanges: IRange[];
}

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

A
Alex Dima 已提交
1247 1248 1249 1250 1251 1252
export interface ILanguageWordDefinitionDto {
	languageId: string;
	regexSource: string;
	regexFlags: string
}

1253
export interface ExtHostLanguageFeaturesShape {
1254
	$provideDocumentSymbols(handle: number, resource: UriComponents, token: CancellationToken): Promise<modes.DocumentSymbol[] | undefined>;
J
Johannes Rieken 已提交
1255 1256
	$provideCodeLenses(handle: number, resource: UriComponents, token: CancellationToken): Promise<ICodeLensListDto | undefined>;
	$resolveCodeLens(handle: number, symbol: ICodeLensDto, token: CancellationToken): Promise<ICodeLensDto | undefined>;
1257
	$releaseCodeLenses(handle: number, id: number): void;
J
Johannes Rieken 已提交
1258 1259 1260 1261
	$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[]>;
1262
	$provideHover(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.Hover | undefined>;
1263
	$provideEvaluatableExpression(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.EvaluatableExpression | undefined>;
1264
	$provideDocumentHighlights(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.DocumentHighlight[] | undefined>;
J
Johannes Rieken 已提交
1265 1266
	$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>;
1267
	$releaseCodeActions(handle: number, cacheId: number): void;
1268 1269 1270
	$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 已提交
1271 1272
	$provideWorkspaceSymbols(handle: number, search: string, token: CancellationToken): Promise<IWorkspaceSymbolsDto>;
	$resolveWorkspaceSymbol(handle: number, symbol: IWorkspaceSymbolDto, token: CancellationToken): Promise<IWorkspaceSymbolDto | undefined>;
1273
	$releaseWorkspaceSymbols(handle: number, id: number): void;
J
Johannes Rieken 已提交
1274
	$provideRenameEdits(handle: number, resource: UriComponents, position: IPosition, newName: string, token: CancellationToken): Promise<IWorkspaceEditDto | undefined>;
1275
	$resolveRenameLocation(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.RenameLocation | undefined>;
1276 1277 1278
	$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 已提交
1279 1280
	$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>;
1281
	$releaseCompletionItems(handle: number, id: number): void;
J
Johannes Rieken 已提交
1282
	$provideSignatureHelp(handle: number, resource: UriComponents, position: IPosition, context: modes.SignatureHelpContext, token: CancellationToken): Promise<ISignatureHelpDto | undefined>;
1283
	$releaseSignatureHelp(handle: number, id: number): void;
J
Johannes Rieken 已提交
1284 1285
	$provideDocumentLinks(handle: number, resource: UriComponents, token: CancellationToken): Promise<ILinksListDto | undefined>;
	$resolveDocumentLink(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<ILinkDto | undefined>;
1286
	$releaseDocumentLinks(handle: number, id: number): void;
J
Johannes Rieken 已提交
1287
	$provideDocumentColors(handle: number, resource: UriComponents, token: CancellationToken): Promise<IRawColorInfo[]>;
M
Matt Bierner 已提交
1288 1289
	$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>;
1290
	$provideSelectionRanges(handle: number, resource: UriComponents, positions: IPosition[], token: CancellationToken): Promise<modes.SelectionRange[][]>;
1291
	$prepareCallHierarchy(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<ICallHierarchyItemDto[] | undefined>;
1292 1293
	$provideCallHierarchyIncomingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IIncomingCallDto[] | undefined>;
	$provideCallHierarchyOutgoingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IOutgoingCallDto[] | undefined>;
1294
	$releaseCallHierarchy(handle: number, sessionId: string): void;
A
Alex Dima 已提交
1295
	$setWordDefinitions(wordDefinitions: ILanguageWordDefinitionDto[]): void;
1296 1297
}

1298 1299
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
M
Matt Bierner 已提交
1300
	$validateInput(input: string): Promise<string | null | undefined>;
1301 1302 1303
	$onDidChangeActive(sessionId: number, handles: number[]): void;
	$onDidChangeSelection(sessionId: number, handles: number[]): void;
	$onDidAccept(sessionId: number): void;
1304
	$onDidChangeValue(sessionId: number, value: string): void;
C
Christof Marti 已提交
1305
	$onDidTriggerButton(sessionId: number, handle: number): void;
1306
	$onDidHide(sessionId: number): void;
1307 1308
}

J
Johannes Rieken 已提交
1309
export interface IShellLaunchConfigDto {
1310 1311 1312
	name?: string;
	executable?: string;
	args?: string[] | string;
1313
	cwd?: string | UriComponents;
1314
	env?: { [key: string]: string | null; };
1315 1316
}

D
Daniel Imms 已提交
1317 1318 1319 1320 1321
export interface IShellDefinitionDto {
	label: string;
	path: string;
}

D
Daniel Imms 已提交
1322 1323 1324 1325 1326
export interface IShellAndArgsDto {
	shell: string;
	args: string[] | string | undefined;
}

1327 1328 1329 1330 1331
export interface ITerminalDimensionsDto {
	columns: number;
	rows: number;
}

1332
export interface ExtHostTerminalServiceShape {
D
Daniel Imms 已提交
1333
	$acceptTerminalClosed(id: number, exitCode: number | undefined): void;
1334
	$acceptTerminalOpened(id: number, name: string, shellLaunchConfig: IShellLaunchConfigDto): void;
1335
	$acceptActiveTerminalChanged(id: number | null): void;
1336
	$acceptTerminalProcessId(id: number, processId: number): void;
A
Alex Dima 已提交
1337
	$acceptTerminalProcessData(id: number, data: string): void;
1338
	$acceptTerminalTitleChange(id: number, name: string): void;
1339
	$acceptTerminalDimensions(id: number, cols: number, rows: number): void;
1340
	$acceptTerminalMaximumDimensions(id: number, cols: number, rows: number): void;
1341
	$spawnExtHostProcess(id: number, shellLaunchConfig: IShellLaunchConfigDto, activeWorkspaceRootUri: UriComponents | undefined, cols: number, rows: number, isWorkspaceShellAllowed: boolean): void;
1342
	$startExtensionTerminal(id: number, initialDimensions: ITerminalDimensionsDto | undefined): void;
D
Daniel Imms 已提交
1343 1344
	$acceptProcessInput(id: number, data: string): void;
	$acceptProcessResize(id: number, cols: number, rows: number): void;
1345
	$acceptProcessShutdown(id: number, immediate: boolean): void;
1346 1347
	$acceptProcessRequestInitialCwd(id: number): void;
	$acceptProcessRequestCwd(id: number): void;
1348
	$acceptProcessRequestLatency(id: number): number;
1349
	$acceptWorkspacePermissionsChanged(isAllowed: boolean): void;
1350
	$getAvailableShells(): Promise<IShellDefinitionDto[]>;
1351
	$getDefaultShellAndArgs(useAutomationShell: boolean): Promise<IShellAndArgsDto>;
1352 1353
}

1354
export interface ExtHostSCMShape {
M
Matt Bierner 已提交
1355
	$provideOriginalResource(sourceControlHandle: number, uri: UriComponents, token: CancellationToken): Promise<UriComponents | null>;
A
Alex Dima 已提交
1356
	$onInputBoxValueChange(sourceControlHandle: number, value: string): void;
J
Johannes Rieken 已提交
1357 1358 1359
	$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 已提交
1360 1361
}

1362
export interface ExtHostTaskShape {
J
Johannes Rieken 已提交
1363
	$provideTasks(handle: number, validTypes: { [key: string]: boolean; }): Thenable<tasks.TaskSetDTO>;
1364
	$resolveTask(handle: number, taskDTO: tasks.TaskDTO): Thenable<tasks.TaskDTO | undefined>;
J
Johannes Rieken 已提交
1365 1366 1367 1368
	$onDidStartTask(execution: tasks.TaskExecutionDTO, terminalId: number): void;
	$onDidStartTaskProcess(value: tasks.TaskProcessStartedDTO): void;
	$onDidEndTaskProcess(value: tasks.TaskProcessEndedDTO): void;
	$OnDidEndTask(execution: tasks.TaskExecutionDTO): void;
1369 1370
	$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 已提交
1371
	$jsonTasksSupported(): Thenable<boolean>;
1372 1373
}

1374 1375
export interface IBreakpointDto {
	type: string;
1376
	id?: string;
1377 1378 1379
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
1380 1381 1382 1383 1384
	logMessage?: string;
}

export interface IFunctionBreakpointDto extends IBreakpointDto {
	type: 'function';
1385
	functionName: string;
1386 1387
}

I
isidor 已提交
1388 1389 1390 1391 1392
export interface IDataBreakpointDto extends IBreakpointDto {
	type: 'data';
	dataId: string;
	canPersist: boolean;
	label: string;
1393
	accessTypes?: DebugProtocol.DataBreakpointAccessType[];
I
isidor 已提交
1394 1395
}

1396
export interface ISourceBreakpointDto extends IBreakpointDto {
1397
	type: 'source';
1398
	uri: UriComponents;
1399 1400
	line: number;
	character: number;
1401 1402
}

1403
export interface IBreakpointsDeltaDto {
I
isidor 已提交
1404
	added?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1405
	removed?: string[];
I
isidor 已提交
1406
	changed?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1407 1408
}

1409 1410 1411 1412
export interface ISourceMultiBreakpointDto {
	type: 'sourceMulti';
	uri: UriComponents;
	lines: {
1413
		id: string;
1414 1415 1416
		enabled: boolean;
		condition?: string;
		hitCondition?: string;
1417
		logMessage?: string;
1418 1419 1420
		line: number;
		character: number;
	}[];
1421 1422
}

A
Andre Weinand 已提交
1423
export interface IDebugSessionFullDto {
1424 1425 1426
	id: DebugSessionUUID;
	type: string;
	name: string;
1427
	folderUri: UriComponents | undefined;
A
Andre Weinand 已提交
1428
	configuration: IConfig;
1429 1430
}

A
Andre Weinand 已提交
1431 1432
export type IDebugSessionDto = IDebugSessionFullDto | DebugSessionUUID;

1433
export interface ExtHostDebugServiceShape {
J
Johannes Rieken 已提交
1434
	$substituteVariables(folder: UriComponents | undefined, config: IConfig): Promise<IConfig>;
1435
	$runInTerminal(args: DebugProtocol.RunInTerminalRequestArguments): Promise<number | undefined>;
J
Johannes Rieken 已提交
1436 1437
	$startDASession(handle: number, session: IDebugSessionDto): Promise<void>;
	$stopDASession(handle: number): Promise<void>;
1438
	$sendDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
1439
	$resolveDebugConfiguration(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1440
	$resolveDebugConfigurationWithSubstitutedVariables(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1441
	$provideDebugConfigurations(handle: number, folder: UriComponents | undefined, token: CancellationToken): Promise<IConfig[]>;
J
Johannes Rieken 已提交
1442 1443
	$legacyDebugAdapterExecutable(handle: number, folderUri: UriComponents | undefined): Promise<IAdapterDescriptor>; // TODO@AW legacy
	$provideDebugAdapter(handle: number, session: IDebugSessionDto): Promise<IAdapterDescriptor>;
1444 1445
	$acceptDebugSessionStarted(session: IDebugSessionDto): void;
	$acceptDebugSessionTerminated(session: IDebugSessionDto): void;
1446
	$acceptDebugSessionActiveChanged(session: IDebugSessionDto | undefined): void;
1447 1448
	$acceptDebugSessionCustomEvent(session: IDebugSessionDto, event: any): void;
	$acceptBreakpointsDelta(delta: IBreakpointsDeltaDto): void;
1449
	$acceptDebugSessionNameChanged(session: IDebugSessionDto, name: string): void;
1450 1451
}

1452

1453 1454 1455 1456 1457 1458
export interface DecorationRequest {
	readonly id: number;
	readonly handle: number;
	readonly uri: UriComponents;
}

1459
export type DecorationData = [number, boolean, string, string, ThemeColor];
1460
export type DecorationReply = { [id: number]: DecorationData; };
1461 1462

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

1466 1467
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
1468 1469
}

S
Sandeep Somavarapu 已提交
1470
export interface ExtHostLogServiceShape {
A
Alex Dima 已提交
1471
	$setLevel(level: LogLevel): void;
S
Sandeep Somavarapu 已提交
1472 1473
}

J
Johannes Rieken 已提交
1474 1475 1476 1477
export interface MainThreadLogShape {
	$log(file: UriComponents, level: LogLevel, args: any[]): void;
}

1478 1479 1480 1481
export interface ExtHostOutputServiceShape {
	$setVisibleChannel(channelId: string | null): void;
}

1482 1483 1484 1485
export interface ExtHostProgressShape {
	$acceptProgressCanceled(handle: number): void;
}

M
Matt Bierner 已提交
1486
export interface ExtHostCommentsShape {
P
Peng Lyu 已提交
1487
	$createCommentThreadTemplate(commentControllerHandle: number, uriComponents: UriComponents, range: IRange): void;
1488
	$updateCommentThreadTemplate(commentControllerHandle: number, threadHandle: number, range: IRange): Promise<void>;
1489
	$deleteCommentThread(commentControllerHandle: number, commentThreadHandle: number): void;
P
Peng Lyu 已提交
1490
	$provideCommentingRanges(commentControllerHandle: number, uriComponents: UriComponents, token: CancellationToken): Promise<IRange[] | undefined>;
P
Peng Lyu 已提交
1491
	$toggleReaction(commentControllerHandle: number, threadHandle: number, uri: UriComponents, comment: modes.Comment, reaction: modes.CommentReaction): Promise<void>;
M
Matt Bierner 已提交
1492 1493
}

R
rebornix 已提交
1494
export interface ExtHostNotebookShape {
1495
	$resolveNotebook(viewType: string, uri: UriComponents): Promise<number | undefined>;
R
rebornix 已提交
1496 1497
	$executeNotebook(viewType: string, uri: UriComponents, cellHandle: number | undefined): Promise<void>;
	$createEmptyCell(viewType: string, uri: UriComponents, index: number, language: string, type: 'markdown' | 'code'): Promise<ICellDto | undefined>;
1498 1499 1500 1501
	$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 已提交
1502
	$acceptDisplayOrder(displayOrder: INotebookDisplayOrder): void;
R
rebornix 已提交
1503 1504
}

1505
export interface ExtHostStorageShape {
1506
	$acceptValue(shared: boolean, key: string, value: object | undefined): void;
1507 1508
}

M
Martin Aeschlimann 已提交
1509 1510 1511 1512 1513 1514
export interface ExtHostThemingShape {
	$onColorThemeChange(themeType: string): void;
}

export interface MainThreadThemingShape extends IDisposable {
}
1515 1516

export interface ExtHostTunnelServiceShape {
1517
	$findCandidatePorts(): Promise<{ host: string, port: number, detail: string }[]>;
1518
	$filterCandidates(candidates: { host: string, port: number, detail: string }[]): Promise<boolean[]>;
1519 1520
	$forwardPort(tunnelOptions: TunnelOptions): Promise<TunnelDto> | undefined;
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
A
Alex Ross 已提交
1521
	$onDidTunnelsChange(): Promise<void>;
1522 1523
}

1524
export interface ExtHostTimelineShape {
1525
	$getTimeline(source: string, uri: UriComponents, options: TimelineOptions, token: CancellationToken, internalOptions?: InternalTimelineOptions): Promise<Timeline | undefined>;
1526 1527
}

1528 1529 1530
// --- proxy identifiers

export const MainContext = {
1531
	MainThreadAuthentication: createMainId<MainThreadAuthenticationShape>('MainThreadAuthentication'),
1532 1533
	MainThreadClipboard: createMainId<MainThreadClipboardShape>('MainThreadClipboard'),
	MainThreadCommands: createMainId<MainThreadCommandsShape>('MainThreadCommands'),
M
Matt Bierner 已提交
1534
	MainThreadComments: createMainId<MainThreadCommentsShape>('MainThreadComments'),
1535
	MainThreadConfiguration: createMainId<MainThreadConfigurationShape>('MainThreadConfiguration'),
1536
	MainThreadConsole: createMainId<MainThreadConsoleShape>('MainThreadConsole'),
1537
	MainThreadDebugService: createMainId<MainThreadDebugServiceShape>('MainThreadDebugService'),
1538 1539 1540 1541
	MainThreadDecorations: createMainId<MainThreadDecorationsShape>('MainThreadDecorations'),
	MainThreadDiagnostics: createMainId<MainThreadDiagnosticsShape>('MainThreadDiagnostics'),
	MainThreadDialogs: createMainId<MainThreadDiaglogsShape>('MainThreadDiaglogs'),
	MainThreadDocuments: createMainId<MainThreadDocumentsShape>('MainThreadDocuments'),
1542
	MainThreadDocumentContentProviders: createMainId<MainThreadDocumentContentProvidersShape>('MainThreadDocumentContentProviders'),
1543
	MainThreadTextEditors: createMainId<MainThreadTextEditorsShape>('MainThreadTextEditors'),
1544
	MainThreadEditorInsets: createMainId<MainThreadEditorInsetsShape>('MainThreadEditorInsets'),
1545 1546
	MainThreadErrors: createMainId<MainThreadErrorsShape>('MainThreadErrors'),
	MainThreadTreeViews: createMainId<MainThreadTreeViewsShape>('MainThreadTreeViews'),
1547
	MainThreadDownloadService: createMainId<MainThreadDownloadServiceShape>('MainThreadDownloadService'),
A
Alex Dima 已提交
1548
	MainThreadKeytar: createMainId<MainThreadKeytarShape>('MainThreadKeytar'),
1549
	MainThreadLanguageFeatures: createMainId<MainThreadLanguageFeaturesShape>('MainThreadLanguageFeatures'),
1550
	MainThreadLanguages: createMainId<MainThreadLanguagesShape>('MainThreadLanguages'),
J
Johannes Rieken 已提交
1551
	MainThreadLog: createMainId<MainThreadLogShape>('MainThread'),
1552
	MainThreadMessageService: createMainId<MainThreadMessageServiceShape>('MainThreadMessageService'),
1553 1554
	MainThreadOutputService: createMainId<MainThreadOutputServiceShape>('MainThreadOutputService'),
	MainThreadProgress: createMainId<MainThreadProgressShape>('MainThreadProgress'),
1555
	MainThreadQuickOpen: createMainId<MainThreadQuickOpenShape>('MainThreadQuickOpen'),
1556
	MainThreadStatusBar: createMainId<MainThreadStatusBarShape>('MainThreadStatusBar'),
1557
	MainThreadStorage: createMainId<MainThreadStorageShape>('MainThreadStorage'),
1558
	MainThreadTelemetry: createMainId<MainThreadTelemetryShape>('MainThreadTelemetry'),
1559
	MainThreadTerminalService: createMainId<MainThreadTerminalServiceShape>('MainThreadTerminalService'),
M
Matt Bierner 已提交
1560
	MainThreadWebviews: createMainId<MainThreadWebviewsShape>('MainThreadWebviews'),
J
Joao Moreno 已提交
1561
	MainThreadUrls: createMainId<MainThreadUrlsShape>('MainThreadUrls'),
1562
	MainThreadWorkspace: createMainId<MainThreadWorkspaceShape>('MainThreadWorkspace'),
1563
	MainThreadFileSystem: createMainId<MainThreadFileSystemShape>('MainThreadFileSystem'),
1564
	MainThreadExtensionService: createMainId<MainThreadExtensionServiceShape>('MainThreadExtensionService'),
J
Joao Moreno 已提交
1565
	MainThreadSCM: createMainId<MainThreadSCMShape>('MainThreadSCM'),
1566
	MainThreadSearch: createMainId<MainThreadSearchShape>('MainThreadSearch'),
1567
	MainThreadTask: createMainId<MainThreadTaskShape>('MainThreadTask'),
1568
	MainThreadWindow: createMainId<MainThreadWindowShape>('MainThreadWindow'),
R
rebornix 已提交
1569
	MainThreadLabelService: createMainId<MainThreadLabelServiceShape>('MainThreadLabelService'),
1570
	MainThreadNotebook: createMainId<MainThreadNotebookShape>('MainThreadNotebook'),
1571
	MainThreadTheming: createMainId<MainThreadThemingShape>('MainThreadTheming'),
1572 1573
	MainThreadTunnelService: createMainId<MainThreadTunnelServiceShape>('MainThreadTunnelService'),
	MainThreadTimeline: createMainId<MainThreadTimelineShape>('MainThreadTimeline')
1574 1575 1576
};

export const ExtHostContext = {
1577
	ExtHostCommands: createExtId<ExtHostCommandsShape>('ExtHostCommands'),
1578
	ExtHostConfiguration: createExtId<ExtHostConfigurationShape>('ExtHostConfiguration'),
1579
	ExtHostDiagnostics: createExtId<ExtHostDiagnosticsShape>('ExtHostDiagnostics'),
1580
	ExtHostDebugService: createExtId<ExtHostDebugServiceShape>('ExtHostDebugService'),
J
Johannes Rieken 已提交
1581
	ExtHostDecorations: createExtId<ExtHostDecorationsShape>('ExtHostDecorations'),
1582
	ExtHostDocumentsAndEditors: createExtId<ExtHostDocumentsAndEditorsShape>('ExtHostDocumentsAndEditors'),
1583
	ExtHostDocuments: createExtId<ExtHostDocumentsShape>('ExtHostDocuments'),
J
Johannes Rieken 已提交
1584
	ExtHostDocumentContentProviders: createExtId<ExtHostDocumentContentProvidersShape>('ExtHostDocumentContentProviders'),
J
Johannes Rieken 已提交
1585
	ExtHostDocumentSaveParticipant: createExtId<ExtHostDocumentSaveParticipantShape>('ExtHostDocumentSaveParticipant'),
J
Johannes Rieken 已提交
1586
	ExtHostEditors: createExtId<ExtHostEditorsShape>('ExtHostEditors'),
1587
	ExtHostTreeViews: createExtId<ExtHostTreeViewsShape>('ExtHostTreeViews'),
J
Johannes Rieken 已提交
1588
	ExtHostFileSystem: createExtId<ExtHostFileSystemShape>('ExtHostFileSystem'),
J
Johannes Rieken 已提交
1589
	ExtHostFileSystemEventService: createExtId<ExtHostFileSystemEventServiceShape>('ExtHostFileSystemEventService'),
1590
	ExtHostLanguageFeatures: createExtId<ExtHostLanguageFeaturesShape>('ExtHostLanguageFeatures'),
1591 1592
	ExtHostQuickOpen: createExtId<ExtHostQuickOpenShape>('ExtHostQuickOpen'),
	ExtHostExtensionService: createExtId<ExtHostExtensionServiceShape>('ExtHostExtensionService'),
1593
	ExtHostLogService: createExtId<ExtHostLogServiceShape>('ExtHostLogService'),
1594
	ExtHostTerminalService: createExtId<ExtHostTerminalServiceShape>('ExtHostTerminalService'),
J
Joao Moreno 已提交
1595
	ExtHostSCM: createExtId<ExtHostSCMShape>('ExtHostSCM'),
1596
	ExtHostSearch: createExtId<ExtHostSearchShape>('ExtHostSearch'),
1597
	ExtHostTask: createExtId<ExtHostTaskShape>('ExtHostTask'),
1598
	ExtHostWorkspace: createExtId<ExtHostWorkspaceShape>('ExtHostWorkspace'),
1599
	ExtHostWindow: createExtId<ExtHostWindowShape>('ExtHostWindow'),
1600
	ExtHostWebviews: createExtId<ExtHostWebviewsShape>('ExtHostWebviews'),
1601
	ExtHostEditorInsets: createExtId<ExtHostEditorInsetsShape>('ExtHostEditorInsets'),
M
Matt Bierner 已提交
1602
	ExtHostProgress: createMainId<ExtHostProgressShape>('ExtHostProgress'),
1603
	ExtHostComments: createMainId<ExtHostCommentsShape>('ExtHostComments'),
1604
	ExtHostStorage: createMainId<ExtHostStorageShape>('ExtHostStorage'),
1605 1606
	ExtHostUrls: createExtId<ExtHostUrlsShape>('ExtHostUrls'),
	ExtHostOutputService: createMainId<ExtHostOutputServiceShape>('ExtHostOutputService'),
R
rebornix 已提交
1607
	ExtHosLabelService: createMainId<ExtHostLabelServiceShape>('ExtHostLabelService'),
1608
	ExtHostNotebook: createMainId<ExtHostNotebookShape>('ExtHostNotebook'),
1609
	ExtHostTheming: createMainId<ExtHostThemingShape>('ExtHostTheming'),
1610
	ExtHostTunnelService: createMainId<ExtHostTunnelServiceShape>('ExtHostTunnelService'),
1611 1612
	ExtHostAuthentication: createMainId<ExtHostAuthenticationShape>('ExtHostAuthentication'),
	ExtHostTimeline: createMainId<ExtHostTimelineShape>('ExtHostTimeline')
1613
};