extHost.protocol.ts 88.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 * as performance from 'vs/base/common/performance';
7
import { VSBuffer } from 'vs/base/common/buffer';
A
Alex Dima 已提交
8
import { CancellationToken } from 'vs/base/common/cancellation';
9
import { IRemoteConsoleLog } from 'vs/base/common/console';
R
Rob Lourens 已提交
10
import { SerializedError } from 'vs/base/common/errors';
11 12
import { IRelativePattern } from 'vs/base/common/glob';
import { IMarkdownString } from 'vs/base/common/htmlContent';
R
Rob Lourens 已提交
13
import { IDisposable } from 'vs/base/common/lifecycle';
14
import Severity from 'vs/base/common/severity';
15
import { URI, UriComponents } from 'vs/base/common/uri';
16
import { RenderLineNumbersType, TextEditorCursorStyle } from 'vs/editor/common/config/editorOptions';
17 18
import { IPosition } from 'vs/editor/common/core/position';
import { IRange } from 'vs/editor/common/core/range';
19
import { ISelection, Selection } from 'vs/editor/common/core/selection';
R
Rob Lourens 已提交
20
import * as editorCommon from 'vs/editor/common/editorCommon';
21
import { EndOfLineSequence, ISingleEditOperation } from 'vs/editor/common/model';
R
Rob Lourens 已提交
22 23 24
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';
25
import { ICommandHandlerDescription } from 'vs/platform/commands/common/commands';
26
import { ConfigurationTarget, IConfigurationData, IConfigurationChange, IConfigurationOverrides } from 'vs/platform/configuration/common/configuration';
R
Rob Lourens 已提交
27
import { ConfigurationScope } from 'vs/platform/configuration/common/configurationRegistry';
28
import { ExtensionIdentifier, IExtensionDescription } from 'vs/platform/extensions/common/extensions';
J
Johannes Rieken 已提交
29
import * as files from 'vs/platform/files/common/files';
30
import { ResourceLabelFormatter } from 'vs/platform/label/common/label';
S
Sandeep Somavarapu 已提交
31
import { LogLevel } from 'vs/platform/log/common/log';
R
Rob Lourens 已提交
32
import { IMarkerData } from 'vs/platform/markers/common/markers';
33
import { IProgressOptions, IProgressStep } from 'vs/platform/progress/common/progress';
J
Johannes Rieken 已提交
34
import * as quickInput from 'vs/platform/quickinput/common/quickInput';
35
import { RemoteAuthorityResolverErrorCode, ResolverResult, TunnelDescription, IRemoteConnectionData } from 'vs/platform/remote/common/remoteAuthorityResolver';
36
import * as statusbar from 'vs/workbench/services/statusbar/common/statusbar';
37
import { ClassifiedEvent, GDPRClassification, StrictPropertyCheck } from 'vs/platform/telemetry/common/gdprTypings';
R
Rob Lourens 已提交
38 39
import { ITelemetryInfo } from 'vs/platform/telemetry/common/telemetry';
import { ThemeColor } from 'vs/platform/theme/common/themeService';
40
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 { ActivationKind, ExtensionActivationError, ExtensionHostKind } from 'vs/workbench/services/extensions/common/extensions';
45 46
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';
47
import { EditorGroupColumn, SaveReason } from 'vs/workbench/common/editor';
48
import { ExtensionActivationReason } from 'vs/workbench/api/common/extHostExtensionActivator';
A
Alex Ross 已提交
49
import { TunnelDto } from 'vs/workbench/api/common/extHostTunnelService';
50
import { TunnelCreationOptions, TunnelProviderFeatures, TunnelOptions, ProvidedPortAttributes } from 'vs/platform/remote/common/tunnel';
51
import { Timeline, TimelineChangeEvent, TimelineOptions, TimelineProviderDescriptor, InternalTimelineOptions } from 'vs/workbench/contrib/timeline/common/timeline';
52
import { revive } from 'vs/base/common/marshalling';
53
import { NotebookCellMetadata, NotebookDocumentMetadata, ICellEditOperation, NotebookCellsChangedEventDto, NotebookDataDto, IMainCellDto, INotebookDocumentFilter, TransientMetadata, INotebookCellStatusBarEntry, ICellRange, INotebookDecorationRenderOptions, INotebookExclusiveDocumentFilter, IOutputDto } from 'vs/workbench/contrib/notebook/common/notebookCommon';
J
Johannes Rieken 已提交
54
import { CallHierarchyItem } from 'vs/workbench/contrib/callHierarchy/common/callHierarchy';
J
Johannes Rieken 已提交
55
import { Dto } from 'vs/base/common/types';
56
import { DebugConfigurationProviderTriggerKind, WorkspaceTrustState } from 'vs/workbench/api/common/extHostTypes';
57
import { IAccessibilityInformation } from 'vs/platform/accessibility/common/accessibility';
58
import { IExtensionIdWithVersion } from 'vs/platform/userDataSync/common/extensionsStorageSync';
59
import { InternalTestItem, ITestState, RunTestForProviderRequest, RunTestsRequest, TestIdWithProvider, TestsDiff, ISerializedTestResults } from 'vs/workbench/contrib/testing/common/testCollection';
60
import { CandidatePort } from 'vs/workbench/services/remote/common/remoteExplorerService';
L
Ladislau Szomoru 已提交
61
import { WorkspaceTrustRequest, WorkspaceTrustStateChangeEvent } from 'vs/platform/workspace/common/workspaceTrust';
62
import { ISerializableEnvironmentVariableCollection } from 'vs/workbench/contrib/terminal/common/environmentVariable';
63
import { IShellLaunchConfig, ITerminalDimensions, ITerminalLaunchError } from 'vs/platform/terminal/common/terminal';
S
Sandeep Somavarapu 已提交
64

65
export interface IEnvironment {
66
	isExtensionDevelopmentDebug: boolean;
67
	appName: string;
68
	appRoot?: URI;
69 70
	appLanguage: string;
	appUriScheme: string;
71
	extensionDevelopmentLocationURI?: URI[];
72
	extensionTestsLocationURI?: URI;
A
Alex Dima 已提交
73
	globalStorageHome: URI;
74
	workspaceStorageHome: URI;
M
Matt Bierner 已提交
75
	webviewResourceRoot: string;
76
	webviewCspSource: string;
77
	useHostProxy?: boolean;
78 79
}

80
export interface IStaticWorkspaceData {
81
	id: string;
82
	name: string;
A
Alex Dima 已提交
83
	configuration?: UriComponents | null;
84
	isUntitled?: boolean | null;
85 86
}

87
export interface IWorkspaceData extends IStaticWorkspaceData {
88
	folders: { uri: UriComponents, name: string, index: number; }[];
89 90
}

91
export interface IInitData {
92
	version: string;
93
	commit?: string;
94 95
	parentPid: number;
	environment: IEnvironment;
A
Alex Dima 已提交
96
	workspace?: IStaticWorkspaceData | null;
A
Alex Dima 已提交
97
	resolvedExtensions: ExtensionIdentifier[];
98
	hostExtensions: ExtensionIdentifier[];
99
	extensions: IExtensionDescription[];
100
	telemetryInfo: ITelemetryInfo;
S
Sandeep Somavarapu 已提交
101
	logLevel: LogLevel;
102
	logsLocation: URI;
103
	logFile: URI;
A
Alex Dima 已提交
104
	autoStart: boolean;
105
	remote: { isRemote: boolean; authority: string | undefined; connectionData: IRemoteConnectionData | null; };
106
	uiKind: UIKind;
107 108
}

S
Sandeep Somavarapu 已提交
109
export interface IConfigurationInitData extends IConfigurationData {
S
Sandeep Somavarapu 已提交
110
	configurationScopes: [string, ConfigurationScope | undefined][];
S
Sandeep Somavarapu 已提交
111 112
}

A
Alex Dima 已提交
113
export interface IExtHostContext extends IRPCProtocol {
114 115
	readonly remoteAuthority: string | null;
	readonly extensionHostKind: ExtensionHostKind;
116 117
}

A
Alex Dima 已提交
118
export interface IMainContext extends IRPCProtocol {
119 120
}

121 122 123 124 125
export enum UIKind {
	Desktop = 1,
	Web = 2
}

126 127
// --- main thread

128 129 130 131 132
export interface MainThreadClipboardShape extends IDisposable {
	$readText(): Promise<string>;
	$writeText(value: string): Promise<void>;
}

133
export interface MainThreadCommandsShape extends IDisposable {
134 135
	$registerCommand(id: string): void;
	$unregisterCommand(id: string): void;
136
	$executeCommand<T>(id: string, args: any[], retry: boolean): Promise<T | undefined>;
J
Johannes Rieken 已提交
137
	$getCommands(): Promise<string[]>;
138 139
}

R
rebornix 已提交
140
export interface CommentProviderFeatures {
P
Peng Lyu 已提交
141
	reactionGroup?: modes.CommentReaction[];
P
Peng Lyu 已提交
142
	reactionHandler?: boolean;
143
	options?: modes.CommentOptions;
R
rebornix 已提交
144 145
}

146 147 148 149 150
export type CommentThreadChanges = Partial<{
	range: IRange,
	label: string,
	contextValue: string,
	comments: modes.Comment[],
151
	collapseState: modes.CommentThreadCollapsibleState;
R
rebornix 已提交
152
	canReply: boolean;
153 154
}>;

M
Matt Bierner 已提交
155
export interface MainThreadCommentsShape extends IDisposable {
P
Peng Lyu 已提交
156
	$registerCommentController(handle: number, id: string, label: string): void;
157
	$unregisterCommentController(handle: number): void;
P
Peng Lyu 已提交
158
	$updateCommentControllerFeatures(handle: number, features: CommentProviderFeatures): void;
159
	$createCommentThread(handle: number, commentThreadHandle: number, threadId: string, resource: UriComponents, range: IRange, extensionId: ExtensionIdentifier): modes.CommentThread | undefined;
160
	$updateCommentThread(handle: number, commentThreadHandle: number, threadId: string, resource: UriComponents, changes: CommentThreadChanges): void;
P
Peng Lyu 已提交
161
	$deleteCommentThread(handle: number, commentThreadHandle: number): void;
162
	$onDidCommentThreadsChange(handle: number, event: modes.CommentThreadChangedEvent): void;
M
Matt Bierner 已提交
163 164
}

165
export interface MainThreadAuthenticationShape extends IDisposable {
166
	$registerAuthenticationProvider(id: string, label: string, supportsMultipleAccounts: boolean): void;
167
	$unregisterAuthenticationProvider(id: string): void;
168
	$ensureProvider(id: string): Promise<void>;
169 170
	$sendDidChangeSessions(providerId: string, event: modes.AuthenticationSessionsChangeEvent): void;
	$getSession(providerId: string, scopes: string[], extensionId: string, extensionName: string, options: { createIfNone?: boolean, clearSessionPreference?: boolean }): Promise<modes.AuthenticationSession | undefined>;
171
	$removeSession(providerId: string, sessionId: string): Promise<void>;
172
}
173

174
export interface MainThreadSecretStateShape extends IDisposable {
175 176 177
	$getPassword(extensionId: string, key: string): Promise<string | undefined>;
	$setPassword(extensionId: string, key: string, value: string): Promise<void>;
	$deletePassword(extensionId: string, key: string): Promise<void>;
178 179
}

180
export interface MainThreadConfigurationShape extends IDisposable {
S
Sandeep Somavarapu 已提交
181 182
	$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>;
183 184
}

185
export interface MainThreadDiagnosticsShape extends IDisposable {
186
	$changeMany(owner: string, entries: [UriComponents, IMarkerData[] | undefined][]): void;
187
	$clear(owner: string): void;
188 189
}

190
export interface MainThreadDialogOpenOptions {
191
	defaultUri?: UriComponents;
192
	openLabel?: string;
193 194 195
	canSelectFiles?: boolean;
	canSelectFolders?: boolean;
	canSelectMany?: boolean;
196
	filters?: { [name: string]: string[]; };
197
	title?: string;
198 199
}

200
export interface MainThreadDialogSaveOptions {
201
	defaultUri?: UriComponents;
202
	saveLabel?: string;
203
	filters?: { [name: string]: string[]; };
204
	title?: string;
205 206
}

207
export interface MainThreadDiaglogsShape extends IDisposable {
208 209
	$showOpenDialog(options?: MainThreadDialogOpenOptions): Promise<UriComponents[] | undefined>;
	$showSaveDialog(options?: MainThreadDialogSaveOptions): Promise<UriComponents | undefined>;
210 211
}

212 213 214
export interface MainThreadDecorationsShape extends IDisposable {
	$registerDecorationProvider(handle: number, label: string): void;
	$unregisterDecorationProvider(handle: number): void;
215
	$onDidChange(handle: number, resources: UriComponents[] | null): void;
216 217
}

218
export interface MainThreadDocumentContentProvidersShape extends IDisposable {
219 220
	$registerTextContentProvider(handle: number, scheme: string): void;
	$unregisterTextContentProvider(handle: number): void;
221
	$onVirtualDocumentChange(uri: UriComponents, value: string): void;
222 223
}

224
export interface MainThreadDocumentsShape extends IDisposable {
J
Johannes Rieken 已提交
225
	$tryCreateDocument(options?: { language?: string; content?: string; }): Promise<UriComponents>;
226
	$tryOpenDocument(uri: UriComponents): Promise<UriComponents>;
J
Johannes Rieken 已提交
227
	$trySaveDocument(uri: UriComponents): Promise<boolean>;
228 229
}

230 231 232 233
export interface ITextEditorConfigurationUpdate {
	tabSize?: number | 'auto';
	insertSpaces?: boolean | 'auto';
	cursorStyle?: TextEditorCursorStyle;
234
	lineNumbers?: RenderLineNumbersType;
235 236 237 238 239 240
}

export interface IResolvedTextEditorConfiguration {
	tabSize: number;
	insertSpaces: boolean;
	cursorStyle: TextEditorCursorStyle;
241
	lineNumbers: RenderLineNumbersType;
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
}

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 已提交
257
	setEndOfLine?: EndOfLineSequence;
258 259
}

260
export interface ITextDocumentShowOptions {
261
	position?: EditorGroupColumn;
262 263
	preserveFocus?: boolean;
	pinned?: boolean;
264
	selection?: IRange;
265 266
}

267
export interface MainThreadBulkEditsShape extends IDisposable {
268
	$tryApplyWorkspaceEdit(workspaceEditDto: IWorkspaceEditDto, undoRedoGroupId?: number): Promise<boolean>;
269 270
}

271
export interface MainThreadTextEditorsShape extends IDisposable {
272
	$tryShowTextDocument(resource: UriComponents, options: ITextDocumentShowOptions): Promise<string | undefined>;
273 274
	$registerTextEditorDecorationType(key: string, options: editorCommon.IDecorationRenderOptions): void;
	$removeTextEditorDecorationType(key: string): void;
275
	$tryShowEditor(id: string, position: EditorGroupColumn): Promise<void>;
J
Johannes Rieken 已提交
276 277 278 279 280 281 282
	$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>;
M
Matt Bierner 已提交
283
	$tryInsertSnippet(id: string, template: string, selections: readonly IRange[], opts: IUndoStopOptions): Promise<boolean>;
J
Johannes Rieken 已提交
284
	$getDiffInformation(id: string): Promise<editorCommon.ILineChange[]>;
285 286
}

287
export interface MainThreadTreeViewsShape extends IDisposable {
288
	$registerTreeViewDataProvider(treeViewId: string, options: { showCollapseAll: boolean, canSelectMany: boolean; }): Promise<void>;
289
	$refresh(treeViewId: string, itemsToRefresh?: { [treeItemHandle: string]: ITreeItem; }): Promise<void>;
290
	$reveal(treeViewId: string, itemInfo: { item: ITreeItem, parentChain: ITreeItem[] } | undefined, options: IRevealOptions): Promise<void>;
291
	$setMessage(treeViewId: string, message: string): void;
292
	$setTitle(treeViewId: string, title: string, description: string | undefined): void;
293 294
}

295 296 297 298
export interface MainThreadDownloadServiceShape extends IDisposable {
	$download(uri: UriComponents, to: UriComponents): Promise<void>;
}

299
export interface MainThreadErrorsShape extends IDisposable {
300
	$onUnexpectedError(err: any | SerializedError): void;
301 302
}

303
export interface MainThreadConsoleShape extends IDisposable {
304
	$logExtensionHostMessage(msg: IRemoteConsoleLog): void;
305 306
}

A
Alex Dima 已提交
307 308 309 310 311
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>;
312
	$findCredentials(service: string): Promise<Array<{ account: string, password: string; }>>;
A
Alex Dima 已提交
313 314
}

J
Johannes Rieken 已提交
315
export interface IRegExpDto {
316 317 318
	pattern: string;
	flags?: string;
}
J
Johannes Rieken 已提交
319 320 321 322 323
export interface IIndentationRuleDto {
	decreaseIndentPattern: IRegExpDto;
	increaseIndentPattern: IRegExpDto;
	indentNextLinePattern?: IRegExpDto;
	unIndentedLinePattern?: IRegExpDto;
324
}
J
Johannes Rieken 已提交
325 326 327
export interface IOnEnterRuleDto {
	beforeText: IRegExpDto;
	afterText?: IRegExpDto;
328
	previousLineText?: IRegExpDto;
329 330
	action: EnterAction;
}
J
Johannes Rieken 已提交
331
export interface ILanguageConfigurationDto {
332 333
	comments?: CommentRule;
	brackets?: CharacterPair[];
J
Johannes Rieken 已提交
334 335 336
	wordPattern?: IRegExpDto;
	indentationRules?: IIndentationRuleDto;
	onEnterRules?: IOnEnterRuleDto[];
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
	__electricCharacterSupport?: {
		brackets?: any;
		docComment?: {
			scope: string;
			open: string;
			lineStart: string;
			close?: string;
		};
	};
	__characterPairSupport?: {
		autoClosingPairs: {
			open: string;
			close: string;
			notIn?: string[];
		}[];
	};
}

355
export type GlobPattern = string | { base: string; pattern: string; };
356

J
Johannes Rieken 已提交
357
export interface IDocumentFilterDto {
A
Alex Dima 已提交
358 359 360
	$serialized: true;
	language?: string;
	scheme?: string;
361
	pattern?: string | IRelativePattern;
362
	exclusive?: boolean;
A
Alex Dima 已提交
363 364
}

J
Johannes Rieken 已提交
365
export interface ISignatureHelpProviderMetadataDto {
366 367
	readonly triggerCharacters: readonly string[];
	readonly retriggerCharacters: readonly string[];
368 369
}

370
export interface MainThreadLanguageFeaturesShape extends IDisposable {
371
	$unregister(handle: number): void;
J
Johannes Rieken 已提交
372 373
	$registerDocumentSymbolProvider(handle: number, selector: IDocumentFilterDto[], label: string): void;
	$registerCodeLensSupport(handle: number, selector: IDocumentFilterDto[], eventHandle: number | undefined): void;
374
	$emitCodeLensEvent(eventHandle: number, event?: any): void;
J
Johannes Rieken 已提交
375 376 377 378 379
	$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;
380
	$registerEvaluatableExpressionProvider(handle: number, selector: IDocumentFilterDto[]): void;
381 382
	$registerInlineValuesProvider(handle: number, selector: IDocumentFilterDto[], eventHandle: number | undefined): void;
	$emitInlineValuesEvent(eventHandle: number, event?: any): void;
J
Johannes Rieken 已提交
383
	$registerDocumentHighlightProvider(handle: number, selector: IDocumentFilterDto[]): void;
384
	$registerLinkedEditingRangeProvider(handle: number, selector: IDocumentFilterDto[]): void;
J
Johannes Rieken 已提交
385
	$registerReferenceSupport(handle: number, selector: IDocumentFilterDto[]): void;
386
	$registerQuickFixSupport(handle: number, selector: IDocumentFilterDto[], metadata: ICodeActionProviderMetadataDto, displayName: string, supportsResolve: boolean): void;
J
Johannes Rieken 已提交
387 388 389
	$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;
390
	$registerNavigateTypeSupport(handle: number): void;
J
Johannes Rieken 已提交
391
	$registerRenameSupport(handle: number, selector: IDocumentFilterDto[], supportsResolveInitialValues: boolean): void;
392 393
	$registerDocumentSemanticTokensProvider(handle: number, selector: IDocumentFilterDto[], legend: modes.SemanticTokensLegend, eventHandle: number | undefined): void;
	$emitDocumentSemanticTokensEvent(eventHandle: number): void;
394
	$registerDocumentRangeSemanticTokensProvider(handle: number, selector: IDocumentFilterDto[], legend: modes.SemanticTokensLegend): void;
395
	$registerSuggestSupport(handle: number, selector: IDocumentFilterDto[], triggerCharacters: string[], supportsResolveDetails: boolean, displayName: string): void;
J
Johannes Rieken 已提交
396
	$registerSignatureHelpProvider(handle: number, selector: IDocumentFilterDto[], metadata: ISignatureHelpProviderMetadataDto): void;
W
Wenlu Wang 已提交
397 398
	$registerInlineHintsProvider(handle: number, selector: IDocumentFilterDto[], eventHandle: number | undefined): void;
	$emitInlineHintsEvent(eventHandle: number, event?: any): void;
J
Johannes Rieken 已提交
399 400
	$registerDocumentLinkProvider(handle: number, selector: IDocumentFilterDto[], supportsResolve: boolean): void;
	$registerDocumentColorProvider(handle: number, selector: IDocumentFilterDto[]): void;
401 402
	$registerFoldingRangeProvider(handle: number, selector: IDocumentFilterDto[], eventHandle: number | undefined): void;
	$emitFoldingRangeEvent(eventHandle: number, event?: any): void;
J
Johannes Rieken 已提交
403 404 405
	$registerSelectionRangeProvider(handle: number, selector: IDocumentFilterDto[]): void;
	$registerCallHierarchyProvider(handle: number, selector: IDocumentFilterDto[]): void;
	$setLanguageConfiguration(handle: number, languageId: string, configuration: ILanguageConfigurationDto): void;
406 407
}

408
export interface MainThreadLanguagesShape extends IDisposable {
J
Johannes Rieken 已提交
409 410
	$getLanguages(): Promise<string[]>;
	$changeLanguage(resource: UriComponents, languageId: string): Promise<void>;
411
	$tokensAtPosition(resource: UriComponents, position: IPosition): Promise<undefined | { type: modes.StandardTokenType, range: IRange }>;
412 413
}

414
export interface MainThreadMessageOptions {
415
	extension?: IExtensionDescription;
416
	modal?: boolean;
417
	useCustom?: boolean;
418 419
}

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

424
export interface MainThreadOutputServiceShape extends IDisposable {
J
Johannes Rieken 已提交
425
	$register(label: string, log: boolean, file?: UriComponents): Promise<string>;
426 427 428 429 430 431
	$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;
432 433
}

434
export interface MainThreadProgressShape extends IDisposable {
435

B
Benjamin Pasero 已提交
436
	$startProgress(handle: number, options: IProgressOptions, extension?: IExtensionDescription): void;
437 438
	$progressReport(handle: number, message: IProgressStep): void;
	$progressEnd(handle: number): void;
439 440
}

441 442 443 444 445 446 447 448 449 450
/**
 * A terminal that is created on the extension host side is temporarily assigned
 * a UUID by the extension host that created it. Once the renderer side has assigned
 * a real numeric id, the numeric id will be used.
 *
 * All other terminals (that are not created on the extension host side) always
 * use the numeric id.
 */
export type TerminalIdentifier = number | string;

D
Daniel Imms 已提交
451 452 453 454 455
export interface TerminalLaunchConfig {
	name?: string;
	shellPath?: string;
	shellArgs?: string[] | string;
	cwd?: string | UriComponents;
456
	env?: { [key: string]: string | null; };
D
Daniel Imms 已提交
457 458 459
	waitOnExit?: boolean;
	strictEnv?: boolean;
	hideFromUser?: boolean;
M
meganrogge 已提交
460
	isExtensionCustomPtyTerminal?: boolean;
R
Rob Lourens 已提交
461
	isFeatureTerminal?: boolean;
462
	isExtensionOwnedTerminal?: boolean;
D
Daniel Imms 已提交
463 464
}

465
export interface MainThreadTerminalServiceShape extends IDisposable {
466 467 468 469 470
	$createTerminal(extHostTerminalId: string, config: TerminalLaunchConfig): Promise<void>;
	$dispose(id: TerminalIdentifier): void;
	$hide(id: TerminalIdentifier): void;
	$sendText(id: TerminalIdentifier, text: string, addNewLine: boolean): void;
	$show(id: TerminalIdentifier, preserveFocus: boolean): void;
471 472
	$startSendingDataEvents(): void;
	$stopSendingDataEvents(): void;
473 474
	$startLinkProvider(): void;
	$stopLinkProvider(): void;
D
Daniel Imms 已提交
475
	$registerProcessSupport(isSupported: boolean): void;
476
	$setEnvironmentVariableCollection(extensionIdentifier: string, persistent: boolean, collection: ISerializableEnvironmentVariableCollection | undefined): void;
477

478
	// Process
479 480
	$sendProcessTitle(terminalId: number, title: string): void;
	$sendProcessData(terminalId: number, data: string): void;
D
Daniel Imms 已提交
481
	$sendProcessReady(terminalId: number, pid: number, cwd: string): void;
D
Daniel Imms 已提交
482
	$sendProcessExit(terminalId: number, exitCode: number | undefined): void;
483 484
	$sendProcessInitialCwd(terminalId: number, cwd: string): void;
	$sendProcessCwd(terminalId: number, initialCwd: string): void;
485
	$sendOverrideDimensions(terminalId: number, dimensions: ITerminalDimensions | undefined): void;
486
	$sendResolvedLaunchConfig(terminalId: number, shellLaunchConfig: IShellLaunchConfig): void;
D
Daniel Imms 已提交
487 488
}

J
Johannes Rieken 已提交
489
export interface TransferQuickPickItems extends quickInput.IQuickPickItem {
490 491
	handle: number;
}
C
Christof Marti 已提交
492

493
export interface TransferQuickInputButton {
494
	handle: number;
495 496
	iconPath: { dark: URI; light?: URI; } | { id: string; };
	tooltip?: string;
497
}
498 499 500 501 502

export type TransferQuickInput = TransferQuickPick | TransferInputBox;

export interface BaseTransferQuickInput {

503 504
	[key: string]: any;

505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
	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 已提交
524
	buttons?: TransferQuickInputButton[];
525

C
Christof Marti 已提交
526
	items?: TransferQuickPickItems[];
527

528 529 530 531
	activeItems?: number[];

	selectedItems?: number[];

532 533 534 535 536 537 538
	canSelectMany?: boolean;

	ignoreFocusOut?: boolean;

	matchOnDescription?: boolean;

	matchOnDetail?: boolean;
539 540

	sortByLabel?: boolean;
541 542 543 544 545 546 547 548 549 550 551 552
}

export interface TransferInputBox extends BaseTransferQuickInput {

	type?: 'inputBox';

	value?: string;

	placeholder?: string;

	password?: boolean;

C
Christof Marti 已提交
553
	buttons?: TransferQuickInputButton[];
554 555 556 557 558 559

	prompt?: string;

	validationMessage?: string;
}

560 561 562 563 564 565 566 567 568
export interface IInputBoxOptions {
	value?: string;
	valueSelection?: [number, number];
	prompt?: string;
	placeHolder?: string;
	password?: boolean;
	ignoreFocusOut?: boolean;
}

569
export interface MainThreadQuickOpenShape extends IDisposable {
J
Johannes Rieken 已提交
570
	$show(instance: number, options: quickInput.IPickOptions<TransferQuickPickItems>, token: CancellationToken): Promise<number | number[] | undefined>;
J
Johannes Rieken 已提交
571 572
	$setItems(instance: number, items: TransferQuickPickItems[]): Promise<void>;
	$setError(instance: number, error: Error): Promise<void>;
573
	$input(options: IInputBoxOptions | undefined, validateInput: boolean, token: CancellationToken): Promise<string | undefined>;
J
Johannes Rieken 已提交
574 575
	$createOrUpdate(params: TransferQuickInput): Promise<void>;
	$dispose(id: number): Promise<void>;
576 577
}

578
export interface MainThreadStatusBarShape extends IDisposable {
579
	$setEntry(id: number, statusId: string, statusName: string, text: string, tooltip: string | undefined, command: ICommandDto | undefined, color: string | ThemeColor | undefined, backgroundColor: string | ThemeColor | undefined, alignment: statusbar.StatusbarAlignment, priority: number | undefined, accessibilityInformation: IAccessibilityInformation | undefined): void;
580
	$dispose(id: number): void;
581 582
}

583
export interface MainThreadStorageShape extends IDisposable {
584
	$getValue<T>(shared: boolean, key: string): Promise<T | undefined>;
J
Johannes Rieken 已提交
585
	$setValue(shared: boolean, key: string, value: object): Promise<void>;
586
	$registerExtensionStorageKeysToSync(extension: IExtensionIdWithVersion, keys: string[]): void;
587 588
}

589
export interface MainThreadTelemetryShape extends IDisposable {
590
	$publicLog(eventName: string, data?: any): void;
591
	$publicLog2<E extends ClassifiedEvent<T> = never, T extends GDPRClassification<T> = never>(eventName: string, data?: StrictPropertyCheck<T, E>): void;
592 593
}

594
export interface MainThreadEditorInsetsShape extends IDisposable {
595
	$createEditorInset(handle: number, id: string, uri: UriComponents, line: number, height: number, options: IWebviewOptions, extensionId: ExtensionIdentifier, extensionLocation: UriComponents): Promise<void>;
596 597 598
	$disposeEditorInset(handle: number): void;

	$setHtml(handle: number, value: string): void;
599
	$setOptions(handle: number, options: IWebviewOptions): void;
600 601
	$postMessage(handle: number, value: any): Promise<boolean>;
}
M
Matt Bierner 已提交
602

603 604 605 606 607 608 609
export interface ExtHostEditorInsetsShape {
	$onDidDispose(handle: number): void;
	$onDidReceiveMessage(handle: number, message: any): void;
}

//#region --- open editors model

610
export interface MainThreadEditorTabsShape extends IDisposable {
611 612
	// manage tabs: move, close, rearrange etc
}
613

614 615 616 617
export interface IEditorTabDto {
	group: number;
	name: string;
	resource: UriComponents
618 619
}

620 621
export interface IExtHostEditorTabsShape {
	$acceptEditorTabs(tabs: IEditorTabDto[]): void;
622 623
}

624 625
//#endregion

626
export type WebviewHandle = string;
627

M
Matt Bierner 已提交
628
export interface WebviewPanelShowOptions {
629
	readonly viewColumn?: EditorGroupColumn;
M
Matt Bierner 已提交
630 631 632
	readonly preserveFocus?: boolean;
}

633 634 635 636 637
export interface WebviewExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
}

R
rebornix 已提交
638 639 640
export interface NotebookExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
R
rebornix 已提交
641
	readonly description?: string;
R
rebornix 已提交
642 643
}

644
export enum WebviewEditorCapabilities {
M
Matt Bierner 已提交
645
	Editable,
646
	SupportsHotExit,
647 648
}

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
export interface IWebviewPortMapping {
	readonly webviewPort: number;
	readonly extensionHostPort: number;
}

export interface IWebviewOptions {
	readonly enableScripts?: boolean;
	readonly enableCommandUris?: boolean;
	readonly localResourceRoots?: ReadonlyArray<UriComponents>;
	readonly portMapping?: ReadonlyArray<IWebviewPortMapping>;
}

export interface IWebviewPanelOptions {
	readonly enableFindWidget?: boolean;
	readonly retainContextWhenHidden?: boolean;
}

666 667 668 669
export interface CustomTextEditorCapabilities {
	readonly supportsMove?: boolean;
}

M
Matt Bierner 已提交
670
export interface MainThreadWebviewsShape extends IDisposable {
671
	$setHtml(handle: WebviewHandle, value: string): void;
672
	$setOptions(handle: WebviewHandle, options: IWebviewOptions): void;
673
	$postMessage(handle: WebviewHandle, value: any): Promise<boolean>
674
}
675

676
export interface MainThreadWebviewPanelsShape extends IDisposable {
677 678 679 680 681 682 683 684 685 686 687
	$createWebviewPanel(
		extension: WebviewExtensionDescription,
		handle: WebviewHandle,
		viewType: string,
		initData: {
			title: string;
			webviewOptions: IWebviewOptions;
			panelOptions: IWebviewPanelOptions;
		},
		showOptions: WebviewPanelShowOptions,
	): void;
688 689 690 691
	$disposeWebview(handle: WebviewHandle): void;
	$reveal(handle: WebviewHandle, showOptions: WebviewPanelShowOptions): void;
	$setTitle(handle: WebviewHandle, value: string): void;
	$setIconPath(handle: WebviewHandle, value: { light: UriComponents, dark: UriComponents; } | undefined): void;
692 693 694

	$registerSerializer(viewType: string): void;
	$unregisterSerializer(viewType: string): void;
695
}
696

697
export interface MainThreadCustomEditorsShape extends IDisposable {
698 699
	$registerTextEditorProvider(extension: WebviewExtensionDescription, viewType: string, options: IWebviewPanelOptions, capabilities: CustomTextEditorCapabilities): void;
	$registerCustomEditorProvider(extension: WebviewExtensionDescription, viewType: string, options: IWebviewPanelOptions, supportsMultipleEditorsPerDocument: boolean): void;
700
	$unregisterEditorProvider(viewType: string): void;
701

702
	$onDidEdit(resource: UriComponents, viewType: string, editId: number, label: string | undefined): void;
703
	$onContentChange(resource: UriComponents, viewType: string): void;
704
}
705

706
export interface MainThreadWebviewViewsShape extends IDisposable {
M
Matt Bierner 已提交
707
	$registerWebviewViewProvider(extension: WebviewExtensionDescription, viewType: string, options?: { retainContextWhenHidden?: boolean }): void;
708
	$unregisterWebviewViewProvider(viewType: string): void;
709

710
	$setWebviewViewTitle(handle: WebviewHandle, value: string | undefined): void;
M
Matt Bierner 已提交
711
	$setWebviewViewDescription(handle: WebviewHandle, value: string | undefined): void;
M
Matt Bierner 已提交
712 713

	$show(handle: WebviewHandle, preserveFocus: boolean): void;
M
Matt Bierner 已提交
714
}
715

716 717 718 719
export interface WebviewPanelViewStateData {
	[handle: string]: {
		readonly active: boolean;
		readonly visible: boolean;
720
		readonly position: EditorGroupColumn;
721
	};
M
Matt Bierner 已提交
722 723
}

M
Matt Bierner 已提交
724
export interface ExtHostWebviewsShape {
725 726
	$onMessage(handle: WebviewHandle, message: any): void;
	$onMissingCsp(handle: WebviewHandle, extensionId: string): void;
727
}
728

729
export interface ExtHostWebviewPanelsShape {
730
	$onDidChangeWebviewPanelViewStates(newState: WebviewPanelViewStateData): void;
731
	$onDidDisposeWebviewPanel(handle: WebviewHandle): Promise<void>;
732 733 734 735 736 737 738 739 740 741 742
	$deserializeWebviewPanel(
		newWebviewHandle: WebviewHandle,
		viewType: string,
		initData: {
			title: string;
			state: any;
			webviewOptions: IWebviewOptions;
			panelOptions: IWebviewPanelOptions;
		},
		position: EditorGroupColumn,
	): Promise<void>;
743
}
744

745
export interface ExtHostCustomEditorsShape {
746 747 748 749 750 751 752 753 754 755 756 757
	$resolveWebviewEditor(
		resource: UriComponents,
		newWebviewHandle: WebviewHandle,
		viewType: string,
		initData: {
			title: string;
			webviewOptions: IWebviewOptions;
			panelOptions: IWebviewPanelOptions;
		},
		position: EditorGroupColumn,
		cancellation: CancellationToken
	): Promise<void>;
758
	$createCustomDocument(resource: UriComponents, viewType: string, backupId: string | undefined, untitledDocumentData: VSBuffer | undefined, cancellation: CancellationToken): Promise<{ editable: boolean }>;
M
Matt Bierner 已提交
759
	$disposeCustomDocument(resource: UriComponents, viewType: string): Promise<void>;
760

M
Matt Bierner 已提交
761 762 763
	$undo(resource: UriComponents, viewType: string, editId: number, isDirty: boolean): Promise<void>;
	$redo(resource: UriComponents, viewType: string, editId: number, isDirty: boolean): Promise<void>;
	$revert(resource: UriComponents, viewType: string, cancellation: CancellationToken): Promise<void>;
764 765
	$disposeEdits(resourceComponents: UriComponents, viewType: string, editIds: number[]): void;

766
	$onSave(resource: UriComponents, viewType: string, cancellation: CancellationToken): Promise<void>;
M
Matt Bierner 已提交
767
	$onSaveAs(resource: UriComponents, viewType: string, targetResource: UriComponents, cancellation: CancellationToken): Promise<void>;
M
Matt Bierner 已提交
768

M
Matt Bierner 已提交
769
	$backup(resource: UriComponents, viewType: string, cancellation: CancellationToken): Promise<string>;
770

771
	$onMoveCustomEditor(handle: WebviewHandle, newResource: UriComponents, viewType: string): Promise<void>;
772
}
773

774
export interface ExtHostWebviewViewsShape {
775
	$resolveWebviewView(webviewHandle: WebviewHandle, viewType: string, title: string | undefined, state: any, cancellation: CancellationToken): Promise<void>;
776

777
	$onDidChangeWebviewViewVisibility(webviewHandle: WebviewHandle, visible: boolean): void;
778

779
	$disposeWebviewView(webviewHandle: WebviewHandle): void;
M
Matt Bierner 已提交
780 781
}

R
rebornix 已提交
782 783 784 785 786 787 788 789 790 791 792
export enum CellKind {
	Markdown = 1,
	Code = 2
}

export enum CellOutputKind {
	Text = 1,
	Error = 2,
	Rich = 3
}

793 794
export interface ICellDto {
	handle: number;
795
	uri: UriComponents,
796 797
	source: string[];
	language: string;
R
rebornix 已提交
798
	cellKind: CellKind;
799
	outputs: IOutputDto[];
800
	metadata?: NotebookCellMetadata;
801 802
}

803 804 805 806 807 808 809 810 811
export type NotebookCellsSplice = [
	number /* start */,
	number /* delete count */,
	ICellDto[]
];

export type NotebookCellOutputsSplice = [
	number /* start */,
	number /* delete count */,
812
	IOutputDto[]
813 814
];

R
rebornix 已提交
815 816 817 818
export enum NotebookEditorRevealType {
	Default = 0,
	InCenter = 1,
	InCenterIfOutsideViewport = 2,
R
rebornix 已提交
819
	AtTop = 3
R
rebornix 已提交
820 821
}

R
rebornix 已提交
822 823 824 825 826 827 828
export interface INotebookDocumentShowOptions {
	position?: EditorGroupColumn;
	preserveFocus?: boolean;
	pinned?: boolean;
	selection?: ICellRange;
}

829 830
export type INotebookCellStatusBarEntryDto = Dto<INotebookCellStatusBarEntry>;

R
rebornix 已提交
831
export interface MainThreadNotebookShape extends IDisposable {
832
	$registerNotebookProvider(extension: NotebookExtensionDescription, viewType: string, options: {
833 834
		transientOutputs: boolean;
		transientMetadata: TransientMetadata;
R
rebornix 已提交
835
		viewOptions?: { displayName: string; filenamePattern: (string | IRelativePattern | INotebookExclusiveDocumentFilter)[]; exclusive: boolean; };
836
	}): Promise<void>;
837
	$updateNotebookProviderOptions(viewType: string, options?: { transientOutputs: boolean; transientMetadata: TransientMetadata; }): Promise<void>;
R
rebornix 已提交
838
	$unregisterNotebookProvider(viewType: string): Promise<void>;
R
rebornix 已提交
839 840
	$registerNotebookKernelProvider(extension: NotebookExtensionDescription, handle: number, documentFilter: INotebookDocumentFilter): Promise<void>;
	$unregisterNotebookKernelProvider(handle: number): Promise<void>;
R
rebornix 已提交
841
	$onNotebookKernelChange(handle: number, uri: UriComponents | undefined): void;
R
rebornix 已提交
842
	$trySaveDocument(uri: UriComponents): Promise<boolean>;
843
	$tryApplyEdits(viewType: string, resource: UriComponents, modelVersionId: number, edits: ICellEditOperation[]): Promise<boolean>;
844
	$postMessage(editorId: string, forRendererId: string | undefined, value: any): Promise<boolean>;
845
	$setStatusBarEntry(id: number, statusBarEntry: INotebookCellStatusBarEntryDto): Promise<void>;
846
	$tryOpenDocument(uriComponents: UriComponents): Promise<UriComponents>;
R
rebornix 已提交
847
	$tryShowNotebookDocument(uriComponents: UriComponents, viewType: string, options: INotebookDocumentShowOptions): Promise<string>;
R
rebornix 已提交
848
	$tryRevealRange(id: string, range: ICellRange, revealType: NotebookEditorRevealType): Promise<void>;
R
rebornix 已提交
849 850 851
	$registerNotebookEditorDecorationType(key: string, options: INotebookDecorationRenderOptions): void;
	$removeNotebookEditorDecorationType(key: string): void;
	$trySetDecorations(id: string, range: ICellRange, decorationKey: string): void;
M
Matt Bierner 已提交
852 853
}

J
Joao Moreno 已提交
854
export interface MainThreadUrlsShape extends IDisposable {
855
	$registerUriHandler(handle: number, extensionId: ExtensionIdentifier): Promise<void>;
J
Johannes Rieken 已提交
856
	$unregisterUriHandler(handle: number): Promise<void>;
857
	$createAppUri(uri: UriComponents): Promise<UriComponents>;
J
Joao Moreno 已提交
858 859 860
}

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

864
export interface MainThreadUriOpenersShape extends IDisposable {
M
Matt Bierner 已提交
865 866
	$registerUriOpener(id: string, schemes: readonly string[], extensionId: ExtensionIdentifier, label: string): Promise<void>;
	$unregisterUriOpener(id: string): Promise<void>;
867 868 869
}

export interface ExtHostUriOpenersShape {
M
Matt Bierner 已提交
870
	$canOpenUri(id: string, uri: UriComponents, token: CancellationToken): Promise<modes.ExternalUriOpenerPriority>;
871
	$openUri(id: string, context: { resolvedUri: UriComponents, sourceUri: UriComponents }, token: CancellationToken): Promise<void>;
872 873
}

874 875 876 877
export interface ITextSearchComplete {
	limitHit?: boolean;
}

878
export interface MainThreadWorkspaceShape extends IDisposable {
879
	$startFileSearch(includePattern: string | null, includeFolder: UriComponents | null, excludePatternOrDisregardExcludes: string | false | null, maxResults: number | null, token: CancellationToken): Promise<UriComponents[] | null>;
880
	$startTextSearch(query: search.IPatternInfo, folder: UriComponents | null, options: ITextQueryBuilderOptions, requestId: number, token: CancellationToken): Promise<ITextSearchComplete | null>;
881
	$checkExists(folders: readonly UriComponents[], includes: string[], token: CancellationToken): Promise<boolean>;
J
Johannes Rieken 已提交
882
	$saveAll(includeUntitled?: boolean): Promise<boolean>;
883
	$updateWorkspaceFolders(extensionName: string, index: number, deleteCount: number, workspaceFoldersToAdd: { uri: UriComponents, name?: string; }[]): Promise<void>;
884
	$resolveProxy(url: string): Promise<string | undefined>;
L
Ladislau Szomoru 已提交
885
	$requireWorkspaceTrust(request?: WorkspaceTrustRequest): Promise<WorkspaceTrustState>;
886
}
887

J
Johannes Rieken 已提交
888 889
export interface IFileChangeDto {
	resource: UriComponents;
J
Johannes Rieken 已提交
890
	type: files.FileChangeType;
J
Johannes Rieken 已提交
891 892
}

893
export interface MainThreadFileSystemShape extends IDisposable {
894
	$registerFileSystemProvider(handle: number, scheme: string, capabilities: files.FileSystemProviderCapabilities): Promise<void>;
895
	$unregisterProvider(handle: number): void;
J
Johannes Rieken 已提交
896
	$onFileSystemChange(handle: number, resource: IFileChangeDto[]): void;
897 898 899 900

	$stat(uri: UriComponents): Promise<files.IStat>;
	$readdir(resource: UriComponents): Promise<[string, files.FileType][]>;
	$readFile(resource: UriComponents): Promise<VSBuffer>;
901
	$writeFile(resource: UriComponents, content: VSBuffer): Promise<void>;
902 903 904 905
	$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>;
906
}
J
Johannes Rieken 已提交
907

908 909 910 911 912
export interface MainThreadLabelServiceShape extends IDisposable {
	$registerResourceLabelFormatter(handle: number, formatter: ResourceLabelFormatter): void;
	$unregisterResourceLabelFormatter(handle: number): void;
}

913
export interface MainThreadSearchShape extends IDisposable {
914 915
	$registerFileSearchProvider(handle: number, scheme: string): void;
	$registerTextSearchProvider(handle: number, scheme: string): void;
916
	$unregisterProvider(handle: number): void;
917
	$handleFileMatch(handle: number, session: number, data: UriComponents[]): void;
J
Johannes Rieken 已提交
918
	$handleTextMatch(handle: number, session: number, data: search.IRawFileMatch2[]): void;
919
	$handleTelemetry(eventName: string, data: any): void;
920 921
}

922
export interface MainThreadTaskShape extends IDisposable {
J
Johannes Rieken 已提交
923
	$createTaskId(task: tasks.TaskDTO): Promise<string>;
924
	$registerTaskProvider(handle: number, type: string): Promise<void>;
J
Johannes Rieken 已提交
925
	$unregisterTaskProvider(handle: number): Promise<void>;
J
Johannes Rieken 已提交
926
	$fetchTasks(filter?: tasks.TaskFilterDTO): Promise<tasks.TaskDTO[]>;
927
	$getTaskExecution(value: tasks.TaskHandleDTO | tasks.TaskDTO): Promise<tasks.TaskExecutionDTO>;
J
Johannes Rieken 已提交
928
	$executeTask(task: tasks.TaskHandleDTO | tasks.TaskDTO): Promise<tasks.TaskExecutionDTO>;
J
Johannes Rieken 已提交
929
	$terminateTask(id: string): Promise<void>;
J
Johannes Rieken 已提交
930
	$registerTaskSystem(scheme: string, info: tasks.TaskSystemInfoDTO): void;
G
Gabriel DeBacker 已提交
931
	$customExecutionComplete(id: string, result?: number): Promise<void>;
932
	$registerSupportedExecutions(custom?: boolean, shell?: boolean, process?: boolean): Promise<void>;
933 934
}

935
export interface MainThreadExtensionServiceShape extends IDisposable {
936
	$activateExtension(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<void>;
937
	$onWillActivateExtension(extensionId: ExtensionIdentifier): Promise<void>;
938
	$onDidActivateExtension(extensionId: ExtensionIdentifier, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number, activationReason: ExtensionActivationReason): void;
939
	$onExtensionActivationError(extensionId: ExtensionIdentifier, error: ExtensionActivationError): Promise<void>;
940
	$onExtensionRuntimeError(extensionId: ExtensionIdentifier, error: SerializedError): void;
941
	$setPerformanceMarks(marks: performance.PerformanceMark[]): Promise<void>;
942 943
}

J
Joao Moreno 已提交
944
export interface SCMProviderFeatures {
J
Joao Moreno 已提交
945 946
	hasQuickDiffProvider?: boolean;
	count?: number;
947 948
	commitTemplate?: string;
	acceptInputCommand?: modes.Command;
J
Johannes Rieken 已提交
949
	statusBarCommands?: ICommandDto[];
J
Joao Moreno 已提交
950 951 952 953
}

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

J
Joao Moreno 已提交
956
export type SCMRawResource = [
957
	number /*handle*/,
958
	UriComponents /*resourceUri*/,
959
	UriComponents[] /*icons: light, dark*/,
960
	string /*tooltip*/,
961
	boolean /*strike through*/,
962
	boolean /*faded*/,
963 964
	string /*context value*/,
	ICommandDto | undefined /*command*/
J
Joao Moreno 已提交
965
];
966

967 968 969
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
970 971 972
	SCMRawResource[]
];

973 974 975 976 977
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

978
export interface MainThreadSCMShape extends IDisposable {
979
	$registerSourceControl(handle: number, id: string, label: string, rootUri: UriComponents | undefined): void;
980 981
	$updateSourceControl(handle: number, features: SCMProviderFeatures): void;
	$unregisterSourceControl(handle: number): void;
J
Joao Moreno 已提交
982

983
	$registerGroups(sourceControlHandle: number, groups: [number /*handle*/, string /*id*/, string /*label*/, SCMGroupFeatures][], splices: SCMRawResourceSplices[]): void;
984 985 986
	$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 已提交
987

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

J
Joao Moreno 已提交
990
	$setInputBoxValue(sourceControlHandle: number, value: string): void;
991
	$setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
992
	$setInputBoxVisibility(sourceControlHandle: number, visible: boolean): void;
993
	$setValidationProviderIsEnabled(sourceControlHandle: number, enabled: boolean): void;
J
Joao Moreno 已提交
994 995
}

996 997
export type DebugSessionUUID = string;

998 999 1000 1001 1002 1003 1004
export interface IDebugConfiguration {
	type: string;
	name: string;
	request: string;
	[key: string]: any;
}

1005 1006 1007
export interface IStartDebuggingOptions {
	parentSessionID?: DebugSessionUUID;
	repl?: IDebugSessionReplMode;
I
isidor 已提交
1008
	noDebug?: boolean;
1009
	compact?: boolean;
1010 1011
}

1012
export interface MainThreadDebugServiceShape extends IDisposable {
A
Alex Dima 已提交
1013
	$registerDebugTypes(debugTypes: string[]): void;
1014
	$sessionCached(sessionID: string): void;
A
Alex Dima 已提交
1015
	$acceptDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
1016 1017
	$acceptDAError(handle: number, name: string, message: string, stack: string | undefined): void;
	$acceptDAExit(handle: number, code: number | undefined, signal: string | undefined): void;
1018
	$registerDebugConfigurationProvider(type: string, triggerKind: DebugConfigurationProviderTriggerKind, hasProvideMethod: boolean, hasResolveMethod: boolean, hasResolve2Method: boolean, handle: number): Promise<void>;
J
Johannes Rieken 已提交
1019
	$registerDebugAdapterDescriptorFactory(type: string, handle: number): Promise<void>;
1020
	$unregisterDebugConfigurationProvider(handle: number): void;
A
Andre Weinand 已提交
1021
	$unregisterDebugAdapterDescriptorFactory(handle: number): void;
I
isidor 已提交
1022
	$startDebugging(folder: UriComponents | undefined, nameOrConfig: string | IDebugConfiguration, options: IStartDebuggingOptions): Promise<boolean>;
1023
	$stopDebugging(sessionId: DebugSessionUUID | undefined): Promise<void>;
1024
	$setDebugSessionName(id: DebugSessionUUID, name: string): void;
J
Johannes Rieken 已提交
1025
	$customDebugAdapterRequest(id: DebugSessionUUID, command: string, args: any): Promise<any>;
1026
	$getDebugProtocolBreakpoint(id: DebugSessionUUID, breakpoinId: string): Promise<DebugProtocol.Breakpoint | undefined>;
1027 1028
	$appendDebugConsole(value: string): void;
	$startBreakpointEvents(): void;
I
isidor 已提交
1029 1030
	$registerBreakpoints(breakpoints: Array<ISourceMultiBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>): Promise<void>;
	$unregisterBreakpoints(breakpointIds: string[], functionBreakpointIds: string[], dataBreakpointIds: string[]): Promise<void>;
1031 1032
}

1033 1034
export interface IOpenUriOptions {
	readonly allowTunneling?: boolean;
1035
	readonly allowContributedOpeners?: boolean | string;
1036 1037
}

1038
export interface MainThreadWindowShape extends IDisposable {
J
Johannes Rieken 已提交
1039
	$getWindowVisibility(): Promise<boolean>;
1040
	$openUri(uri: UriComponents, uriString: string | undefined, options: IOpenUriOptions): Promise<boolean>;
1041
	$asExternalUri(uri: UriComponents, options: IOpenUriOptions): Promise<UriComponents>;
1042 1043
}

1044 1045 1046 1047 1048 1049
export enum CandidatePortSource {
	None = 0,
	Process = 1,
	Output = 2
}

1050 1051 1052 1053 1054
export interface PortAttributesProviderSelector {
	pid?: number;
	portRange?: [number, number];
}

A
Alex Ross 已提交
1055
export interface MainThreadTunnelServiceShape extends IDisposable {
1056
	$openTunnel(tunnelOptions: TunnelOptions, source: string | undefined): Promise<TunnelDto | undefined>;
1057
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
1058
	$getTunnels(): Promise<TunnelDescription[]>;
1059
	$setTunnelProvider(features: TunnelProviderFeatures): Promise<void>;
1060
	$setRemoteTunnelService(processId: number): Promise<void>;
1061
	$setCandidateFilter(): Promise<void>;
A
Alex Ross 已提交
1062
	$onFoundNewCandidates(candidates: { host: string, port: number, detail: string }[]): Promise<void>;
1063
	$setCandidatePortSource(source: CandidatePortSource): Promise<void>;
1064 1065
	$registerPortsAttributesProvider(selector: PortAttributesProviderSelector, providerHandle: number): Promise<void>;
	$unregisterPortsAttributesProvider(providerHandle: number): Promise<void>;
A
Alex Ross 已提交
1066 1067
}

1068
export interface MainThreadTimelineShape extends IDisposable {
1069 1070
	$registerTimelineProvider(provider: TimelineProviderDescriptor): void;
	$unregisterTimelineProvider(source: string): void;
E
Eric Amodio 已提交
1071
	$emitTimelineChangeEvent(e: TimelineChangeEvent | undefined): void;
1072 1073
}

1074 1075
// -- extension host

1076
export interface ExtHostCommandsShape {
J
Johannes Rieken 已提交
1077
	$executeContributedCommand<T>(id: string, ...args: any[]): Promise<T>;
1078
	$getContributedCommandHandlerDescriptions(): Promise<{ [id: string]: string | ICommandHandlerDescription; }>;
1079 1080
}

1081
export interface ExtHostConfigurationShape {
1082
	$initializeConfiguration(data: IConfigurationInitData): void;
1083
	$acceptConfigurationChanged(data: IConfigurationInitData, change: IConfigurationChange): void;
1084 1085
}

1086
export interface ExtHostDiagnosticsShape {
J
Johannes Rieken 已提交
1087
	$acceptMarkersChange(data: [UriComponents, IMarkerData[]][]): void;
1088 1089
}

1090
export interface ExtHostDocumentContentProvidersShape {
M
Matt Bierner 已提交
1091
	$provideTextDocumentContent(handle: number, uri: UriComponents): Promise<string | null | undefined>;
1092 1093
}

1094
export interface IModelAddedData {
1095
	uri: UriComponents;
1096
	versionId: number;
1097 1098
	lines: string[];
	EOL: string;
1099 1100 1101
	modeId: string;
	isDirty: boolean;
}
1102
export interface ExtHostDocumentsShape {
1103
	$acceptModelModeChanged(strURL: UriComponents, newModeId: string): void;
1104 1105 1106
	$acceptModelSaved(strURL: UriComponents): void;
	$acceptDirtyStateChanged(strURL: UriComponents, isDirty: boolean): void;
	$acceptModelChanged(strURL: UriComponents, e: IModelChangedEvent, isDirty: boolean): void;
1107 1108
}

1109
export interface ExtHostDocumentSaveParticipantShape {
J
Johannes Rieken 已提交
1110
	$participateInSave(resource: UriComponents, reason: SaveReason): Promise<boolean[]>;
1111 1112
}

1113 1114
export interface ITextEditorAddData {
	id: string;
1115
	documentUri: UriComponents;
1116
	options: IResolvedTextEditorConfiguration;
A
Alex Dima 已提交
1117
	selections: ISelection[];
1118
	visibleRanges: IRange[];
1119
	editorPosition: EditorGroupColumn | undefined;
1120 1121
}
export interface ITextEditorPositionData {
1122
	[id: string]: EditorGroupColumn;
1123
}
1124 1125 1126
export interface IEditorPropertiesChangeData {
	options: IResolvedTextEditorConfiguration | null;
	selections: ISelectionChangeEvent | null;
1127
	visibleRanges: IRange[] | null;
1128 1129 1130 1131 1132 1133
}
export interface ISelectionChangeEvent {
	selections: Selection[];
	source?: string;
}

1134
export interface ExtHostEditorsShape {
1135
	$acceptEditorPropertiesChanged(id: string, props: IEditorPropertiesChangeData): void;
1136
	$acceptEditorPositionData(data: ITextEditorPositionData): void;
1137 1138
}

J
Johannes Rieken 已提交
1139
export interface IDocumentsAndEditorsDelta {
1140
	removedDocuments?: UriComponents[];
J
Johannes Rieken 已提交
1141 1142 1143
	addedDocuments?: IModelAddedData[];
	removedEditors?: string[];
	addedEditors?: ITextEditorAddData[];
A
Alex Dima 已提交
1144
	newActiveEditor?: string | null;
J
Johannes Rieken 已提交
1145 1146
}

1147 1148
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
1149 1150
}

1151
export interface ExtHostTreeViewsShape {
J
Johannes Rieken 已提交
1152
	$getChildren(treeViewId: string, treeItemHandle?: string): Promise<ITreeItem[]>;
1153
	$setExpanded(treeViewId: string, treeItemHandle: string, expanded: boolean): void;
1154
	$setSelection(treeViewId: string, treeItemHandles: string[]): void;
1155
	$setVisible(treeViewId: string, visible: boolean): void;
A
Alex Ross 已提交
1156
	$hasResolve(treeViewId: string): Promise<boolean>;
1157
	$resolve(treeViewId: string, treeItemHandle: string, token: CancellationToken): Promise<ITreeItem | undefined>;
S
Sandeep Somavarapu 已提交
1158 1159
}

1160
export interface ExtHostWorkspaceShape {
1161
	$initializeWorkspace(workspace: IWorkspaceData | null, trustState: WorkspaceTrustState): void;
1162
	$acceptWorkspaceData(workspace: IWorkspaceData | null): void;
J
Johannes Rieken 已提交
1163
	$handleTextSearchResult(result: search.IRawFileMatch2, requestId: number): void;
1164
	$onDidChangeWorkspaceTrustState(state: WorkspaceTrustStateChangeEvent): void;
1165
}
1166

1167 1168 1169 1170
export interface ExtHostFileSystemInfoShape {
	$acceptProviderInfos(scheme: string, capabilities: number | null): void;
}

1171
export interface ExtHostFileSystemShape {
J
Johannes Rieken 已提交
1172 1173
	$stat(handle: number, resource: UriComponents): Promise<files.IStat>;
	$readdir(handle: number, resource: UriComponents): Promise<[string, files.FileType][]>;
1174 1175
	$readFile(handle: number, resource: UriComponents): Promise<VSBuffer>;
	$writeFile(handle: number, resource: UriComponents, content: VSBuffer, opts: files.FileWriteOptions): Promise<void>;
J
Johannes Rieken 已提交
1176 1177
	$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 已提交
1178
	$mkdir(handle: number, resource: UriComponents): Promise<void>;
J
Johannes Rieken 已提交
1179 1180
	$delete(handle: number, resource: UriComponents, opts: files.FileDeleteOptions): Promise<void>;
	$watch(handle: number, session: number, resource: UriComponents, opts: files.IWatchOptions): void;
1181
	$unwatch(handle: number, session: number): void;
J
Johannes Rieken 已提交
1182
	$open(handle: number, resource: UriComponents, opts: files.FileOpenOptions): Promise<number>;
J
Johannes Rieken 已提交
1183
	$close(handle: number, fd: number): Promise<void>;
1184 1185
	$read(handle: number, fd: number, pos: number, length: number): Promise<VSBuffer>;
	$write(handle: number, fd: number, pos: number, data: VSBuffer): Promise<number>;
1186
}
1187

1188 1189 1190 1191
export interface ExtHostLabelServiceShape {
	$registerResourceLabelFormatter(formatter: ResourceLabelFormatter): IDisposable;
}

1192
export interface ExtHostAuthenticationShape {
1193
	$getSessions(id: string, scopes?: string[]): Promise<ReadonlyArray<modes.AuthenticationSession>>;
1194 1195
	$createSession(id: string, scopes: string[]): Promise<modes.AuthenticationSession>;
	$removeSession(id: string, sessionId: string): Promise<void>;
1196
	$onDidChangeAuthenticationSessions(id: string, label: string): Promise<void>;
1197
	$onDidChangeAuthenticationProviders(added: modes.AuthenticationProviderInformation[], removed: modes.AuthenticationProviderInformation[]): Promise<void>;
1198
	$setProviders(providers: modes.AuthenticationProviderInformation[]): Promise<void>;
1199 1200 1201
}

export interface ExtHostSecretStateShape {
1202
	$onDidChangePassword(e: { extensionId: string, key: string }): Promise<void>;
1203 1204
}

1205
export interface ExtHostSearchShape {
J
Johannes Rieken 已提交
1206 1207
	$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 已提交
1208
	$clearCache(cacheKey: string): Promise<void>;
1209 1210
}

A
Tweaks  
Alex Dima 已提交
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
export interface IResolveAuthorityErrorResult {
	type: 'error';
	error: {
		message: string | undefined;
		code: RemoteAuthorityResolverErrorCode;
		detail: any;
	};
}

export interface IResolveAuthorityOKResult {
	type: 'ok';
1222
	value: ResolverResult;
A
Tweaks  
Alex Dima 已提交
1223 1224 1225 1226
}

export type IResolveAuthorityResult = IResolveAuthorityErrorResult | IResolveAuthorityOKResult;

1227
export interface ExtHostExtensionServiceShape {
A
Tweaks  
Alex Dima 已提交
1228
	$resolveAuthority(remoteAuthority: string, resolveAttempt: number): Promise<IResolveAuthorityResult>;
1229
	$startExtensionHost(enabledExtensionIds: ExtensionIdentifier[]): Promise<void>;
1230 1231
	$extensionTestsExecute(): Promise<number>;
	$extensionTestsExit(code: number): Promise<void>;
1232
	$activateByEvent(activationEvent: string, activationKind: ActivationKind): Promise<void>;
1233
	$activate(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<boolean>;
1234
	$setRemoteEnvironment(env: { [key: string]: string | null; }): Promise<void>;
1235
	$updateRemoteConnectionData(connectionData: IRemoteConnectionData): Promise<void>;
1236

1237
	$deltaExtensions(toAdd: IExtensionDescription[], toRemove: ExtensionIdentifier[]): Promise<void>;
1238 1239

	$test_latency(n: number): Promise<number>;
1240 1241
	$test_up(b: VSBuffer): Promise<number>;
	$test_down(size: number): Promise<VSBuffer>;
1242 1243 1244
}

export interface FileSystemEvents {
J
Johannes Rieken 已提交
1245 1246 1247
	created: UriComponents[];
	changed: UriComponents[];
	deleted: UriComponents[];
1248
}
1249

1250 1251 1252 1253 1254
export interface SourceTargetPair {
	source?: UriComponents;
	target: UriComponents;
}

1255 1256 1257 1258 1259
export interface IWillRunFileOperationParticipation {
	edit: IWorkspaceEditDto;
	extensionNames: string[]
}

1260
export interface ExtHostFileSystemEventServiceShape {
1261
	$onFileEvent(events: FileSystemEvents): void;
1262
	$onWillRunFileOperation(operation: files.FileOperation, files: SourceTargetPair[], timeout: number, token: CancellationToken): Promise<IWillRunFileOperationParticipation | undefined>;
1263
	$onDidRunFileOperation(operation: files.FileOperation, files: SourceTargetPair[]): void;
1264 1265
}

J
Johannes Rieken 已提交
1266
export interface ObjectIdentifier {
1267
	$ident?: number;
J
Johannes Rieken 已提交
1268 1269 1270
}

export namespace ObjectIdentifier {
1271
	export const name = '$ident';
J
Johannes Rieken 已提交
1272
	export function mixin<T>(obj: T, id: number): T & ObjectIdentifier {
1273
		Object.defineProperty(obj, name, { value: id, enumerable: true });
J
Johannes Rieken 已提交
1274 1275
		return <T & ObjectIdentifier>obj;
	}
1276 1277
	export function of(obj: any): number {
		return obj[name];
J
Johannes Rieken 已提交
1278 1279 1280
	}
}

1281 1282
export interface ExtHostHeapServiceShape {
	$onGarbageCollection(ids: number[]): void;
1283
}
1284
export interface IRawColorInfo {
J
Joao Moreno 已提交
1285
	color: [number, number, number, number];
1286 1287 1288
	range: IRange;
}

1289 1290 1291 1292 1293 1294 1295 1296 1297
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;
	}
}

1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
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 已提交
1313 1314 1315

	// to merge into label
	label2 = 'o',
1316 1317
}

J
Johannes Rieken 已提交
1318
export interface ISuggestDataDto {
P
label2  
Pine Wu 已提交
1319 1320
	[ISuggestDataDtoField.label]: string;
	[ISuggestDataDtoField.label2]?: string | modes.CompletionItemLabel;
1321
	[ISuggestDataDtoField.kind]?: modes.CompletionItemKind;
1322 1323 1324 1325
	[ISuggestDataDtoField.detail]?: string;
	[ISuggestDataDtoField.documentation]?: string | IMarkdownString;
	[ISuggestDataDtoField.sortText]?: string;
	[ISuggestDataDtoField.filterText]?: string;
1326
	[ISuggestDataDtoField.preselect]?: true;
1327 1328
	[ISuggestDataDtoField.insertText]?: string;
	[ISuggestDataDtoField.insertTextRules]?: modes.CompletionItemInsertTextRule;
1329
	[ISuggestDataDtoField.range]?: IRange | { insert: IRange, replace: IRange; };
1330 1331 1332 1333
	[ISuggestDataDtoField.commitCharacters]?: string[];
	[ISuggestDataDtoField.additionalTextEdits]?: ISingleEditOperation[];
	[ISuggestDataDtoField.command]?: modes.Command;
	[ISuggestDataDtoField.kindModifier]?: modes.CompletionItemTag[];
J
Johannes Rieken 已提交
1334
	// not-standard
1335
	x?: ChainedCacheId;
J
Johannes Rieken 已提交
1336 1337
}

1338 1339 1340
export const enum ISuggestResultDtoField {
	defaultRanges = 'a',
	completions = 'b',
1341 1342
	isIncomplete = 'c',
	duration = 'd',
1343 1344
}

J
Johannes Rieken 已提交
1345
export interface ISuggestResultDto {
1346 1347 1348
	[ISuggestResultDtoField.defaultRanges]: { insert: IRange, replace: IRange; };
	[ISuggestResultDtoField.completions]: ISuggestDataDto[];
	[ISuggestResultDtoField.isIncomplete]: undefined | true;
1349
	[ISuggestResultDtoField.duration]: number;
1350
	x?: number;
1351 1352
}

J
Johannes Rieken 已提交
1353
export interface ISignatureHelpDto {
1354 1355 1356 1357 1358 1359
	id: CacheId;
	signatures: modes.SignatureInformation[];
	activeSignature: number;
	activeParameter: number;
}

J
Johannes Rieken 已提交
1360
export interface ISignatureHelpContextDto {
1361 1362 1363
	readonly triggerKind: modes.SignatureHelpTriggerKind;
	readonly triggerCharacter?: string;
	readonly isRetrigger: boolean;
J
Johannes Rieken 已提交
1364
	readonly activeSignatureHelp?: ISignatureHelpDto;
1365 1366
}

K
kingwl 已提交
1367
export interface IInlineHintDto {
W
Wenlu Wang 已提交
1368 1369
	text: string;
	range: IRange;
1370
	kind: modes.InlineHintKind;
W
Wenlu Wang 已提交
1371 1372
	whitespaceBefore?: boolean;
	whitespaceAfter?: boolean;
1373
	hoverMessage?: string;
K
WIP  
kingwl 已提交
1374 1375
}

K
kingwl 已提交
1376 1377
export interface IInlineHintsDto {
	hints: IInlineHintDto[]
K
WIP  
kingwl 已提交
1378 1379
}

J
Johannes Rieken 已提交
1380
export interface ILocationDto {
1381 1382
	uri: UriComponents;
	range: IRange;
1383 1384
}

J
Johannes Rieken 已提交
1385
export interface IDefinitionLinkDto {
J
Johannes Rieken 已提交
1386
	originSelectionRange?: IRange;
M
Matt Bierner 已提交
1387 1388
	uri: UriComponents;
	range: IRange;
J
Johannes Rieken 已提交
1389
	targetSelectionRange?: IRange;
M
Matt Bierner 已提交
1390 1391
}

J
Johannes Rieken 已提交
1392
export interface IWorkspaceSymbolDto extends IdObject {
1393 1394 1395
	name: string;
	containerName?: string;
	kind: modes.SymbolKind;
J
Johannes Rieken 已提交
1396
	location: ILocationDto;
1397 1398
}

J
Johannes Rieken 已提交
1399 1400
export interface IWorkspaceSymbolsDto extends IdObject {
	symbols: IWorkspaceSymbolDto[];
1401 1402
}

1403 1404 1405 1406 1407 1408 1409
export interface IWorkspaceEditEntryMetadataDto {
	needsConfirmation: boolean;
	label: string;
	description?: string;
	iconPath?: { id: string } | UriComponents | { light: UriComponents, dark: UriComponents };
}

1410 1411 1412
export const enum WorkspaceEditType {
	File = 1,
	Text = 2,
1413
	Cell = 3,
1414 1415
}

1416
export interface IWorkspaceFileEditDto {
1417
	_type: WorkspaceEditType.File;
M
Matt Bierner 已提交
1418 1419
	oldUri?: UriComponents;
	newUri?: UriComponents;
1420
	options?: modes.WorkspaceFileEditOptions
1421
	metadata?: IWorkspaceEditEntryMetadataDto;
1422 1423
}

1424
export interface IWorkspaceTextEditDto {
1425
	_type: WorkspaceEditType.Text;
1426
	resource: UriComponents;
1427
	edit: modes.TextEdit;
1428
	modelVersionId?: number;
1429
	metadata?: IWorkspaceEditEntryMetadataDto;
1430 1431
}

1432 1433 1434
export interface IWorkspaceCellEditDto {
	_type: WorkspaceEditType.Cell;
	resource: UriComponents;
1435
	edit: ICellEditOperation;
1436
	notebookVersionId?: number;
1437 1438 1439
	metadata?: IWorkspaceEditEntryMetadataDto;
}

J
Johannes Rieken 已提交
1440
export interface IWorkspaceEditDto {
1441
	edits: Array<IWorkspaceFileEditDto | IWorkspaceTextEditDto | IWorkspaceCellEditDto>;
1442 1443
}

J
Johannes Rieken 已提交
1444
export function reviveWorkspaceEditDto(data: IWorkspaceEditDto | undefined): modes.WorkspaceEdit {
1445 1446
	if (data && data.edits) {
		for (const edit of data.edits) {
1447 1448
			if (typeof (<IWorkspaceTextEditDto>edit).resource === 'object') {
				(<IWorkspaceTextEditDto>edit).resource = URI.revive((<IWorkspaceTextEditDto>edit).resource);
1449
			} else {
1450 1451
				(<IWorkspaceFileEditDto>edit).newUri = URI.revive((<IWorkspaceFileEditDto>edit).newUri);
				(<IWorkspaceFileEditDto>edit).oldUri = URI.revive((<IWorkspaceFileEditDto>edit).oldUri);
1452
			}
1453 1454 1455
			if (edit.metadata && edit.metadata.iconPath) {
				edit.metadata = revive(edit.metadata);
			}
1456 1457 1458 1459 1460
		}
	}
	return <modes.WorkspaceEdit>data;
}

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

J
Johannes Rieken 已提交
1463
export interface ICodeActionDto {
1464
	cacheId?: ChainedCacheId;
1465
	title: string;
J
Johannes Rieken 已提交
1466
	edit?: IWorkspaceEditDto;
1467
	diagnostics?: IMarkerData[];
J
Johannes Rieken 已提交
1468
	command?: ICommandDto;
J
Johannes Rieken 已提交
1469
	kind?: string;
1470
	isPreferred?: boolean;
M
Matt Bierner 已提交
1471
	disabled?: string;
1472
}
1473

J
Johannes Rieken 已提交
1474
export interface ICodeActionListDto {
1475
	cacheId: CacheId;
J
Johannes Rieken 已提交
1476
	actions: ReadonlyArray<ICodeActionDto>;
1477 1478
}

1479 1480 1481 1482 1483
export interface ICodeActionProviderMetadataDto {
	readonly providedKinds?: readonly string[];
	readonly documentation?: ReadonlyArray<{ readonly kind: string, readonly command: ICommandDto }>;
}

1484 1485 1486
export type CacheId = number;
export type ChainedCacheId = [CacheId, CacheId];

J
Johannes Rieken 已提交
1487
export interface ILinksListDto {
1488
	id?: CacheId;
J
Johannes Rieken 已提交
1489
	links: ILinkDto[];
1490 1491
}

J
Johannes Rieken 已提交
1492
export interface ILinkDto {
1493
	cacheId?: ChainedCacheId;
M
Martin Aeschlimann 已提交
1494 1495
	range: IRange;
	url?: string | UriComponents;
1496
	tooltip?: string;
M
Martin Aeschlimann 已提交
1497
}
1498

J
Johannes Rieken 已提交
1499
export interface ICodeLensListDto {
1500
	cacheId?: number;
J
Johannes Rieken 已提交
1501
	lenses: ICodeLensDto[];
1502 1503
}

J
Johannes Rieken 已提交
1504
export interface ICodeLensDto {
1505
	cacheId?: ChainedCacheId;
1506
	range: IRange;
J
Johannes Rieken 已提交
1507
	command?: ICommandDto;
1508
}
1509

J
Johannes Rieken 已提交
1510
export type ICallHierarchyItemDto = Dto<CallHierarchyItem>;
1511

1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
export interface IIncomingCallDto {
	from: ICallHierarchyItemDto;
	fromRanges: IRange[];
}

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

A
Alex Dima 已提交
1522 1523 1524 1525 1526 1527
export interface ILanguageWordDefinitionDto {
	languageId: string;
	regexSource: string;
	regexFlags: string
}

1528
export interface ILinkedEditingRangesDto {
M
Martin Aeschlimann 已提交
1529 1530 1531 1532
	ranges: IRange[];
	wordPattern?: IRegExpDto;
}

1533
export interface IInlineValueContextDto {
1534
	frameId: number;
1535 1536 1537
	stoppedLocation: IRange;
}

1538
export interface ExtHostLanguageFeaturesShape {
1539
	$provideDocumentSymbols(handle: number, resource: UriComponents, token: CancellationToken): Promise<modes.DocumentSymbol[] | undefined>;
J
Johannes Rieken 已提交
1540 1541
	$provideCodeLenses(handle: number, resource: UriComponents, token: CancellationToken): Promise<ICodeLensListDto | undefined>;
	$resolveCodeLens(handle: number, symbol: ICodeLensDto, token: CancellationToken): Promise<ICodeLensDto | undefined>;
1542
	$releaseCodeLenses(handle: number, id: number): void;
J
Johannes Rieken 已提交
1543 1544 1545 1546
	$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[]>;
1547
	$provideHover(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.Hover | undefined>;
1548
	$provideEvaluatableExpression(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.EvaluatableExpression | undefined>;
1549
	$provideInlineValues(handle: number, resource: UriComponents, range: IRange, context: modes.InlineValueContext, token: CancellationToken): Promise<modes.InlineValue[] | undefined>;
1550
	$provideDocumentHighlights(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.DocumentHighlight[] | undefined>;
1551
	$provideLinkedEditingRanges(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<ILinkedEditingRangesDto | undefined>;
J
Johannes Rieken 已提交
1552 1553
	$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>;
1554
	$resolveCodeAction(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<IWorkspaceEditDto | undefined>;
1555
	$releaseCodeActions(handle: number, cacheId: number): void;
1556 1557 1558
	$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 已提交
1559 1560
	$provideWorkspaceSymbols(handle: number, search: string, token: CancellationToken): Promise<IWorkspaceSymbolsDto>;
	$resolveWorkspaceSymbol(handle: number, symbol: IWorkspaceSymbolDto, token: CancellationToken): Promise<IWorkspaceSymbolDto | undefined>;
1561
	$releaseWorkspaceSymbols(handle: number, id: number): void;
J
Johannes Rieken 已提交
1562
	$provideRenameEdits(handle: number, resource: UriComponents, position: IPosition, newName: string, token: CancellationToken): Promise<IWorkspaceEditDto & { rejectReason?: string } | undefined>;
1563
	$resolveRenameLocation(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.RenameLocation | undefined>;
1564 1565 1566
	$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 已提交
1567
	$provideCompletionItems(handle: number, resource: UriComponents, position: IPosition, context: modes.CompletionContext, token: CancellationToken): Promise<ISuggestResultDto | undefined>;
1568
	$resolveCompletionItem(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<ISuggestDataDto | undefined>;
1569
	$releaseCompletionItems(handle: number, id: number): void;
J
Johannes Rieken 已提交
1570
	$provideSignatureHelp(handle: number, resource: UriComponents, position: IPosition, context: modes.SignatureHelpContext, token: CancellationToken): Promise<ISignatureHelpDto | undefined>;
1571
	$releaseSignatureHelp(handle: number, id: number): void;
K
kingwl 已提交
1572
	$provideInlineHints(handle: number, resource: UriComponents, range: IRange, token: CancellationToken): Promise<IInlineHintsDto | undefined>
J
Johannes Rieken 已提交
1573 1574
	$provideDocumentLinks(handle: number, resource: UriComponents, token: CancellationToken): Promise<ILinksListDto | undefined>;
	$resolveDocumentLink(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<ILinkDto | undefined>;
1575
	$releaseDocumentLinks(handle: number, id: number): void;
J
Johannes Rieken 已提交
1576
	$provideDocumentColors(handle: number, resource: UriComponents, token: CancellationToken): Promise<IRawColorInfo[]>;
M
Matt Bierner 已提交
1577 1578
	$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>;
1579
	$provideSelectionRanges(handle: number, resource: UriComponents, positions: IPosition[], token: CancellationToken): Promise<modes.SelectionRange[][]>;
1580
	$prepareCallHierarchy(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<ICallHierarchyItemDto[] | undefined>;
1581 1582
	$provideCallHierarchyIncomingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IIncomingCallDto[] | undefined>;
	$provideCallHierarchyOutgoingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IOutgoingCallDto[] | undefined>;
1583
	$releaseCallHierarchy(handle: number, sessionId: string): void;
A
Alex Dima 已提交
1584
	$setWordDefinitions(wordDefinitions: ILanguageWordDefinitionDto[]): void;
1585 1586
}

1587 1588
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
M
Matt Bierner 已提交
1589
	$validateInput(input: string): Promise<string | null | undefined>;
1590 1591 1592
	$onDidChangeActive(sessionId: number, handles: number[]): void;
	$onDidChangeSelection(sessionId: number, handles: number[]): void;
	$onDidAccept(sessionId: number): void;
1593
	$onDidChangeValue(sessionId: number, value: string): void;
C
Christof Marti 已提交
1594
	$onDidTriggerButton(sessionId: number, handle: number): void;
1595
	$onDidHide(sessionId: number): void;
1596 1597
}

1598 1599 1600 1601 1602
export interface ExtHostTelemetryShape {
	$initializeTelemetryEnabled(enabled: boolean): void;
	$onDidChangeTelemetryEnabled(enabled: boolean): void;
}

J
Johannes Rieken 已提交
1603
export interface IShellLaunchConfigDto {
1604 1605 1606
	name?: string;
	executable?: string;
	args?: string[] | string;
1607
	cwd?: string | UriComponents;
1608
	env?: { [key: string]: string | null; };
1609
	hideFromUser?: boolean;
1610 1611
}

D
Daniel Imms 已提交
1612 1613 1614 1615 1616
export interface IShellDefinitionDto {
	label: string;
	path: string;
}

D
Daniel Imms 已提交
1617 1618 1619 1620 1621
export interface IShellAndArgsDto {
	shell: string;
	args: string[] | string | undefined;
}

1622
export interface ITerminalLinkDto {
D
Daniel Imms 已提交
1623 1624
	/** The ID of the link to enable activation and disposal. */
	id: number;
1625 1626 1627 1628 1629 1630 1631 1632
	/** The startIndex of the link in the line. */
	startIndex: number;
	/** The length of the link in the line. */
	length: number;
	/** The descriptive label for what the link does when activated. */
	label?: string;
}

1633 1634 1635 1636 1637
export interface ITerminalDimensionsDto {
	columns: number;
	rows: number;
}

1638
export interface ExtHostTerminalServiceShape {
D
Daniel Imms 已提交
1639
	$acceptTerminalClosed(id: number, exitCode: number | undefined): void;
1640
	$acceptTerminalOpened(id: number, extHostTerminalId: string | undefined, name: string, shellLaunchConfig: IShellLaunchConfigDto): void;
1641
	$acceptActiveTerminalChanged(id: number | null): void;
1642
	$acceptTerminalProcessId(id: number, processId: number): void;
A
Alex Dima 已提交
1643
	$acceptTerminalProcessData(id: number, data: string): void;
1644
	$acceptTerminalTitleChange(id: number, name: string): void;
1645
	$acceptTerminalDimensions(id: number, cols: number, rows: number): void;
1646
	$acceptTerminalMaximumDimensions(id: number, cols: number, rows: number): void;
1647
	$startExtensionTerminal(id: number, initialDimensions: ITerminalDimensionsDto | undefined): Promise<ITerminalLaunchError | undefined>;
D
Daniel Imms 已提交
1648
	$acceptProcessAckDataEvent(id: number, charCount: number): void;
D
Daniel Imms 已提交
1649 1650
	$acceptProcessInput(id: number, data: string): void;
	$acceptProcessResize(id: number, cols: number, rows: number): void;
1651
	$acceptProcessShutdown(id: number, immediate: boolean): void;
1652 1653
	$acceptProcessRequestInitialCwd(id: number): void;
	$acceptProcessRequestCwd(id: number): void;
1654
	$acceptProcessRequestLatency(id: number): number;
1655
	$acceptWorkspacePermissionsChanged(isAllowed: boolean): void;
1656
	$getAvailableShells(): Promise<IShellDefinitionDto[]>;
1657
	$getDefaultShellAndArgs(useAutomationShell: boolean): Promise<IShellAndArgsDto>;
1658
	$provideLinks(id: number, line: string): Promise<ITerminalLinkDto[]>;
D
Daniel Imms 已提交
1659
	$activateLink(id: number, linkId: number): void;
1660
	$initEnvironmentVariableCollections(collections: [string, ISerializableEnvironmentVariableCollection][]): void;
1661 1662
}

1663
export interface ExtHostSCMShape {
M
Matt Bierner 已提交
1664
	$provideOriginalResource(sourceControlHandle: number, uri: UriComponents, token: CancellationToken): Promise<UriComponents | null>;
A
Alex Dima 已提交
1665
	$onInputBoxValueChange(sourceControlHandle: number, value: string): void;
J
João Moreno 已提交
1666
	$executeResourceCommand(sourceControlHandle: number, groupHandle: number, handle: number, preserveFocus: boolean): Promise<void>;
J
Johannes Rieken 已提交
1667
	$validateInput(sourceControlHandle: number, value: string, cursorPosition: number): Promise<[string, number] | undefined>;
J
João Moreno 已提交
1668
	$setSelectedSourceControl(selectedSourceControlHandle: number | undefined): Promise<void>;
J
Joao Moreno 已提交
1669 1670
}

1671
export interface ExtHostTaskShape {
J
Johannes Rieken 已提交
1672
	$provideTasks(handle: number, validTypes: { [key: string]: boolean; }): Thenable<tasks.TaskSetDTO>;
1673
	$resolveTask(handle: number, taskDTO: tasks.TaskDTO): Thenable<tasks.TaskDTO | undefined>;
1674
	$onDidStartTask(execution: tasks.TaskExecutionDTO, terminalId: number, resolvedDefinition: tasks.TaskDefinitionDTO): void;
J
Johannes Rieken 已提交
1675 1676 1677
	$onDidStartTaskProcess(value: tasks.TaskProcessStartedDTO): void;
	$onDidEndTaskProcess(value: tasks.TaskProcessEndedDTO): void;
	$OnDidEndTask(execution: tasks.TaskExecutionDTO): void;
1678 1679
	$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 已提交
1680
	$jsonTasksSupported(): Thenable<boolean>;
1681
	$findExecutable(command: string, cwd?: string, paths?: string[]): Promise<string | undefined>;
1682 1683
}

1684 1685
export interface IBreakpointDto {
	type: string;
1686
	id?: string;
1687 1688 1689
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
1690 1691 1692 1693 1694
	logMessage?: string;
}

export interface IFunctionBreakpointDto extends IBreakpointDto {
	type: 'function';
1695
	functionName: string;
1696 1697
}

I
isidor 已提交
1698 1699 1700 1701 1702
export interface IDataBreakpointDto extends IBreakpointDto {
	type: 'data';
	dataId: string;
	canPersist: boolean;
	label: string;
1703
	accessTypes?: DebugProtocol.DataBreakpointAccessType[];
I
isidor 已提交
1704 1705
}

1706
export interface ISourceBreakpointDto extends IBreakpointDto {
1707
	type: 'source';
1708
	uri: UriComponents;
1709 1710
	line: number;
	character: number;
1711 1712
}

1713
export interface IBreakpointsDeltaDto {
I
isidor 已提交
1714
	added?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1715
	removed?: string[];
I
isidor 已提交
1716
	changed?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1717 1718
}

1719 1720 1721 1722
export interface ISourceMultiBreakpointDto {
	type: 'sourceMulti';
	uri: UriComponents;
	lines: {
1723
		id: string;
1724 1725 1726
		enabled: boolean;
		condition?: string;
		hitCondition?: string;
1727
		logMessage?: string;
1728 1729 1730
		line: number;
		character: number;
	}[];
1731 1732
}

A
Andre Weinand 已提交
1733
export interface IDebugSessionFullDto {
1734 1735 1736
	id: DebugSessionUUID;
	type: string;
	name: string;
1737
	folderUri: UriComponents | undefined;
A
Andre Weinand 已提交
1738
	configuration: IConfig;
1739 1740
}

A
Andre Weinand 已提交
1741 1742
export type IDebugSessionDto = IDebugSessionFullDto | DebugSessionUUID;

1743
export interface ExtHostDebugServiceShape {
J
Johannes Rieken 已提交
1744
	$substituteVariables(folder: UriComponents | undefined, config: IConfig): Promise<IConfig>;
1745
	$runInTerminal(args: DebugProtocol.RunInTerminalRequestArguments, sessionId: string): Promise<number | undefined>;
J
Johannes Rieken 已提交
1746 1747
	$startDASession(handle: number, session: IDebugSessionDto): Promise<void>;
	$stopDASession(handle: number): Promise<void>;
1748
	$sendDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
1749
	$resolveDebugConfiguration(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1750
	$resolveDebugConfigurationWithSubstitutedVariables(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1751
	$provideDebugConfigurations(handle: number, folder: UriComponents | undefined, token: CancellationToken): Promise<IConfig[]>;
J
Johannes Rieken 已提交
1752
	$provideDebugAdapter(handle: number, session: IDebugSessionDto): Promise<IAdapterDescriptor>;
1753 1754
	$acceptDebugSessionStarted(session: IDebugSessionDto): void;
	$acceptDebugSessionTerminated(session: IDebugSessionDto): void;
1755
	$acceptDebugSessionActiveChanged(session: IDebugSessionDto | undefined): void;
1756 1757
	$acceptDebugSessionCustomEvent(session: IDebugSessionDto, event: any): void;
	$acceptBreakpointsDelta(delta: IBreakpointsDeltaDto): void;
1758
	$acceptDebugSessionNameChanged(session: IDebugSessionDto, name: string): void;
1759 1760
}

1761

1762 1763 1764 1765 1766
export interface DecorationRequest {
	readonly id: number;
	readonly uri: UriComponents;
}

1767
export type DecorationData = [boolean, string, string, ThemeColor];
1768
export type DecorationReply = { [id: number]: DecorationData; };
1769 1770

export interface ExtHostDecorationsShape {
1771
	$provideDecorations(handle: number, requests: DecorationRequest[], token: CancellationToken): Promise<DecorationReply>;
1772 1773
}

1774 1775
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
1776 1777
}

S
Sandeep Somavarapu 已提交
1778
export interface ExtHostLogServiceShape {
A
Alex Dima 已提交
1779
	$setLevel(level: LogLevel): void;
S
Sandeep Somavarapu 已提交
1780 1781
}

J
Johannes Rieken 已提交
1782 1783 1784 1785
export interface MainThreadLogShape {
	$log(file: UriComponents, level: LogLevel, args: any[]): void;
}

1786 1787 1788 1789
export interface ExtHostOutputServiceShape {
	$setVisibleChannel(channelId: string | null): void;
}

1790 1791 1792 1793
export interface ExtHostProgressShape {
	$acceptProgressCanceled(handle: number): void;
}

M
Matt Bierner 已提交
1794
export interface ExtHostCommentsShape {
P
Peng Lyu 已提交
1795
	$createCommentThreadTemplate(commentControllerHandle: number, uriComponents: UriComponents, range: IRange): void;
1796
	$updateCommentThreadTemplate(commentControllerHandle: number, threadHandle: number, range: IRange): Promise<void>;
1797
	$deleteCommentThread(commentControllerHandle: number, commentThreadHandle: number): void;
P
Peng Lyu 已提交
1798
	$provideCommentingRanges(commentControllerHandle: number, uriComponents: UriComponents, token: CancellationToken): Promise<IRange[] | undefined>;
P
Peng Lyu 已提交
1799
	$toggleReaction(commentControllerHandle: number, threadHandle: number, uri: UriComponents, comment: modes.Comment, reaction: modes.CommentReaction): Promise<void>;
M
Matt Bierner 已提交
1800 1801
}

R
rebornix 已提交
1802
export interface INotebookSelectionChangeEvent {
R
rebornix 已提交
1803
	selections: ICellRange[];
R
rebornix 已提交
1804 1805
}

1806
export interface INotebookVisibleRangesEvent {
1807
	ranges: ICellRange[];
1808 1809
}

R
rebornix 已提交
1810
export interface INotebookEditorPropertiesChangeData {
1811 1812
	visibleRanges?: INotebookVisibleRangesEvent;
	selections?: INotebookSelectionChangeEvent;
1813 1814 1815
}

export interface INotebookDocumentPropertiesChangeData {
1816
	metadata?: NotebookDocumentMetadata;
R
rebornix 已提交
1817 1818
}

R
rebornix 已提交
1819 1820
export interface INotebookModelAddedData {
	uri: UriComponents;
R
rebornix 已提交
1821 1822
	versionId: number;
	cells: IMainCellDto[],
R
rebornix 已提交
1823
	viewType: string;
R
rebornix 已提交
1824
	metadata?: NotebookDocumentMetadata;
R
rebornix 已提交
1825 1826
}

R
rebornix 已提交
1827 1828 1829
export interface INotebookEditorAddData {
	id: string;
	documentUri: UriComponents;
R
rebornix 已提交
1830
	selections: ICellRange[];
1831
	visibleRanges: ICellRange[];
1832
	viewColumn?: number
R
rebornix 已提交
1833 1834 1835 1836 1837
}

export interface INotebookDocumentsAndEditorsDelta {
	removedDocuments?: UriComponents[];
	addedDocuments?: INotebookModelAddedData[];
R
rebornix 已提交
1838 1839 1840
	removedEditors?: string[];
	addedEditors?: INotebookEditorAddData[];
	newActiveEditor?: string | null;
R
rebornix 已提交
1841
	visibleEditors?: string[];
R
rebornix 已提交
1842 1843
}

1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857
export interface INotebookKernelInfoDto2 {
	id?: string;
	friendlyId: string;
	label: string;
	extension: ExtensionIdentifier;
	extensionLocation: UriComponents;
	providerHandle?: number;
	description?: string;
	detail?: string;
	isPreferred?: boolean;
	preloads?: UriComponents[];
	supportedLanguages?: string[]
}

R
rebornix 已提交
1858
export interface ExtHostNotebookShape {
1859
	$resolveNotebookEditor(viewType: string, uri: UriComponents, editorId: string): Promise<void>;
J
Johannes Rieken 已提交
1860
	$acceptNotebookActiveKernelChange(event: { uri: UriComponents, providerHandle: number | undefined, kernelFriendlyId: string | undefined }): void;
R
rebornix 已提交
1861 1862
	$provideNotebookKernels(handle: number, uri: UriComponents, token: CancellationToken): Promise<INotebookKernelInfoDto2[]>;
	$resolveNotebookKernel(handle: number, editorId: string, uri: UriComponents, kernelId: string, token: CancellationToken): Promise<void>;
R
Rob Lourens 已提交
1863
	$executeNotebookKernelFromProvider(handle: number, uri: UriComponents, kernelId: string, cellHandle: number | undefined): Promise<void>;
1864
	$cancelNotebookKernelFromProvider(handle: number, uri: UriComponents, kernelId: string, cellHandle: number | undefined): Promise<void>;
J
Johannes Rieken 已提交
1865
	$onDidReceiveMessage(editorId: string, rendererId: string | undefined, message: unknown): void;
1866
	$openNotebook(viewType: string, uri: UriComponents, backupId: string | undefined, token: CancellationToken, untitledDocumentData?: VSBuffer): Promise<NotebookDataDto>;
R
rebornix 已提交
1867
	$saveNotebook(viewType: string, uri: UriComponents, token: CancellationToken): Promise<boolean>;
R
saveAs  
rebornix 已提交
1868
	$saveNotebookAs(viewType: string, uri: UriComponents, target: UriComponents, token: CancellationToken): Promise<boolean>;
J
Johannes Rieken 已提交
1869
	$backupNotebook(viewType: string, uri: UriComponents, cancellation: CancellationToken): Promise<string>;
R
rebornix 已提交
1870
	$acceptModelChanged(uriComponents: UriComponents, event: NotebookCellsChangedEventDto, isDirty: boolean): void;
1871
	$acceptDirtyStateChanged(uriComponents: UriComponents, isDirty: boolean): void;
1872
	$acceptModelSaved(uriComponents: UriComponents): void;
1873
	$acceptDocumentPropertiesChanged(uriComponents: UriComponents, data: INotebookDocumentPropertiesChangeData): void;
J
Johannes Rieken 已提交
1874
	$acceptDocumentAndEditorsDelta(delta: INotebookDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
1875
	$acceptEditorPropertiesChanged(id: string, data: INotebookEditorPropertiesChangeData): void;
R
rebornix 已提交
1876 1877
}

1878
export interface ExtHostStorageShape {
1879
	$acceptValue(shared: boolean, key: string, value: object | undefined): void;
1880 1881
}

M
Martin Aeschlimann 已提交
1882 1883 1884 1885 1886 1887
export interface ExtHostThemingShape {
	$onColorThemeChange(themeType: string): void;
}

export interface MainThreadThemingShape extends IDisposable {
}
1888 1889

export interface ExtHostTunnelServiceShape {
1890
	$forwardPort(tunnelOptions: TunnelOptions, tunnelCreationOptions: TunnelCreationOptions): Promise<TunnelDto | undefined>;
1891
	$closeTunnel(remote: { host: string, port: number }, silent?: boolean): Promise<void>;
A
Alex Ross 已提交
1892
	$onDidTunnelsChange(): Promise<void>;
1893
	$registerCandidateFinder(enable: boolean): Promise<void>;
1894
	$applyCandidateFilter(candidates: CandidatePort[]): Promise<CandidatePort[]>;
1895
	$providePortAttributes(handles: number[], ports: number[], pid: number | undefined, commandline: string | undefined, cancellationToken: CancellationToken): Promise<ProvidedPortAttributes[]>;
1896 1897
}

1898
export interface ExtHostTimelineShape {
1899
	$getTimeline(source: string, uri: UriComponents, options: TimelineOptions, token: CancellationToken, internalOptions?: InternalTimelineOptions): Promise<Timeline | undefined>;
1900 1901
}

C
Connor Peet 已提交
1902 1903 1904 1905 1906 1907
export const enum ExtHostTestingResource {
	Workspace,
	TextDocument
}

export interface ExtHostTestingShape {
1908
	$runTestsForProvider(req: RunTestForProviderRequest, token: CancellationToken): Promise<void>;
C
Connor Peet 已提交
1909 1910
	$subscribeToTests(resource: ExtHostTestingResource, uri: UriComponents): void;
	$unsubscribeFromTests(resource: ExtHostTestingResource, uri: UriComponents): void;
C
Connor Peet 已提交
1911
	$lookupTest(test: TestIdWithProvider): Promise<InternalTestItem | undefined>;
C
Connor Peet 已提交
1912
	$acceptDiff(resource: ExtHostTestingResource, uri: UriComponents, diff: TestsDiff): void;
1913
	$publishTestResults(results: ISerializedTestResults[]): void;
C
Connor Peet 已提交
1914 1915 1916 1917 1918 1919 1920 1921
}

export interface MainThreadTestingShape {
	$registerTestProvider(id: string): void;
	$unregisterTestProvider(id: string): void;
	$subscribeToDiffs(resource: ExtHostTestingResource, uri: UriComponents): void;
	$unsubscribeFromDiffs(resource: ExtHostTestingResource, uri: UriComponents): void;
	$publishDiff(resource: ExtHostTestingResource, uri: UriComponents, diff: TestsDiff): void;
1922 1923
	$updateTestStateInRun(runId: string, testId: string, state: ITestState): void;
	$runTests(req: RunTestsRequest, token: CancellationToken): Promise<string>;
1924
	$publishExtensionProvidedResults(results: ISerializedTestResults, persist: boolean): void;
1925
	$retireTest(extId: string): void;
C
Connor Peet 已提交
1926 1927
}

1928 1929 1930
// --- proxy identifiers

export const MainContext = {
1931
	MainThreadAuthentication: createMainId<MainThreadAuthenticationShape>('MainThreadAuthentication'),
1932
	MainThreadBulkEdits: createMainId<MainThreadBulkEditsShape>('MainThreadBulkEdits'),
1933 1934
	MainThreadClipboard: createMainId<MainThreadClipboardShape>('MainThreadClipboard'),
	MainThreadCommands: createMainId<MainThreadCommandsShape>('MainThreadCommands'),
M
Matt Bierner 已提交
1935
	MainThreadComments: createMainId<MainThreadCommentsShape>('MainThreadComments'),
1936
	MainThreadConfiguration: createMainId<MainThreadConfigurationShape>('MainThreadConfiguration'),
1937
	MainThreadConsole: createMainId<MainThreadConsoleShape>('MainThreadConsole'),
1938
	MainThreadDebugService: createMainId<MainThreadDebugServiceShape>('MainThreadDebugService'),
1939 1940 1941 1942
	MainThreadDecorations: createMainId<MainThreadDecorationsShape>('MainThreadDecorations'),
	MainThreadDiagnostics: createMainId<MainThreadDiagnosticsShape>('MainThreadDiagnostics'),
	MainThreadDialogs: createMainId<MainThreadDiaglogsShape>('MainThreadDiaglogs'),
	MainThreadDocuments: createMainId<MainThreadDocumentsShape>('MainThreadDocuments'),
1943
	MainThreadDocumentContentProviders: createMainId<MainThreadDocumentContentProvidersShape>('MainThreadDocumentContentProviders'),
1944
	MainThreadTextEditors: createMainId<MainThreadTextEditorsShape>('MainThreadTextEditors'),
1945
	MainThreadEditorInsets: createMainId<MainThreadEditorInsetsShape>('MainThreadEditorInsets'),
1946
	MainThreadEditorTabs: createMainId<MainThreadEditorTabsShape>('MainThreadEditorTabs'),
1947 1948
	MainThreadErrors: createMainId<MainThreadErrorsShape>('MainThreadErrors'),
	MainThreadTreeViews: createMainId<MainThreadTreeViewsShape>('MainThreadTreeViews'),
1949
	MainThreadDownloadService: createMainId<MainThreadDownloadServiceShape>('MainThreadDownloadService'),
A
Alex Dima 已提交
1950
	MainThreadKeytar: createMainId<MainThreadKeytarShape>('MainThreadKeytar'),
1951
	MainThreadLanguageFeatures: createMainId<MainThreadLanguageFeaturesShape>('MainThreadLanguageFeatures'),
1952
	MainThreadLanguages: createMainId<MainThreadLanguagesShape>('MainThreadLanguages'),
J
Johannes Rieken 已提交
1953
	MainThreadLog: createMainId<MainThreadLogShape>('MainThread'),
1954
	MainThreadMessageService: createMainId<MainThreadMessageServiceShape>('MainThreadMessageService'),
1955 1956
	MainThreadOutputService: createMainId<MainThreadOutputServiceShape>('MainThreadOutputService'),
	MainThreadProgress: createMainId<MainThreadProgressShape>('MainThreadProgress'),
1957
	MainThreadQuickOpen: createMainId<MainThreadQuickOpenShape>('MainThreadQuickOpen'),
1958
	MainThreadStatusBar: createMainId<MainThreadStatusBarShape>('MainThreadStatusBar'),
1959
	MainThreadSecretState: createMainId<MainThreadSecretStateShape>('MainThreadSecretState'),
1960
	MainThreadStorage: createMainId<MainThreadStorageShape>('MainThreadStorage'),
1961
	MainThreadTelemetry: createMainId<MainThreadTelemetryShape>('MainThreadTelemetry'),
1962
	MainThreadTerminalService: createMainId<MainThreadTerminalServiceShape>('MainThreadTerminalService'),
M
Matt Bierner 已提交
1963
	MainThreadWebviews: createMainId<MainThreadWebviewsShape>('MainThreadWebviews'),
1964
	MainThreadWebviewPanels: createMainId<MainThreadWebviewPanelsShape>('MainThreadWebviewPanels'),
1965 1966
	MainThreadWebviewViews: createMainId<MainThreadWebviewViewsShape>('MainThreadWebviewViews'),
	MainThreadCustomEditors: createMainId<MainThreadCustomEditorsShape>('MainThreadCustomEditors'),
J
Joao Moreno 已提交
1967
	MainThreadUrls: createMainId<MainThreadUrlsShape>('MainThreadUrls'),
1968
	MainThreadUriOpeners: createMainId<MainThreadUriOpenersShape>('MainThreadUriOpeners'),
1969
	MainThreadWorkspace: createMainId<MainThreadWorkspaceShape>('MainThreadWorkspace'),
1970
	MainThreadFileSystem: createMainId<MainThreadFileSystemShape>('MainThreadFileSystem'),
1971
	MainThreadExtensionService: createMainId<MainThreadExtensionServiceShape>('MainThreadExtensionService'),
J
Joao Moreno 已提交
1972
	MainThreadSCM: createMainId<MainThreadSCMShape>('MainThreadSCM'),
1973
	MainThreadSearch: createMainId<MainThreadSearchShape>('MainThreadSearch'),
1974
	MainThreadTask: createMainId<MainThreadTaskShape>('MainThreadTask'),
1975
	MainThreadWindow: createMainId<MainThreadWindowShape>('MainThreadWindow'),
M
Martin Aeschlimann 已提交
1976
	MainThreadLabelService: createMainId<MainThreadLabelServiceShape>('MainThreadLabelService'),
1977
	MainThreadNotebook: createMainId<MainThreadNotebookShape>('MainThreadNotebook'),
1978
	MainThreadTheming: createMainId<MainThreadThemingShape>('MainThreadTheming'),
1979
	MainThreadTunnelService: createMainId<MainThreadTunnelServiceShape>('MainThreadTunnelService'),
C
Connor Peet 已提交
1980 1981
	MainThreadTimeline: createMainId<MainThreadTimelineShape>('MainThreadTimeline'),
	MainThreadTesting: createMainId<MainThreadTestingShape>('MainThreadTesting'),
1982 1983 1984
};

export const ExtHostContext = {
1985
	ExtHostCommands: createExtId<ExtHostCommandsShape>('ExtHostCommands'),
1986
	ExtHostConfiguration: createExtId<ExtHostConfigurationShape>('ExtHostConfiguration'),
1987
	ExtHostDiagnostics: createExtId<ExtHostDiagnosticsShape>('ExtHostDiagnostics'),
1988
	ExtHostDebugService: createExtId<ExtHostDebugServiceShape>('ExtHostDebugService'),
J
Johannes Rieken 已提交
1989
	ExtHostDecorations: createExtId<ExtHostDecorationsShape>('ExtHostDecorations'),
1990
	ExtHostDocumentsAndEditors: createExtId<ExtHostDocumentsAndEditorsShape>('ExtHostDocumentsAndEditors'),
1991
	ExtHostDocuments: createExtId<ExtHostDocumentsShape>('ExtHostDocuments'),
J
Johannes Rieken 已提交
1992
	ExtHostDocumentContentProviders: createExtId<ExtHostDocumentContentProvidersShape>('ExtHostDocumentContentProviders'),
J
Johannes Rieken 已提交
1993
	ExtHostDocumentSaveParticipant: createExtId<ExtHostDocumentSaveParticipantShape>('ExtHostDocumentSaveParticipant'),
J
Johannes Rieken 已提交
1994
	ExtHostEditors: createExtId<ExtHostEditorsShape>('ExtHostEditors'),
1995
	ExtHostTreeViews: createExtId<ExtHostTreeViewsShape>('ExtHostTreeViews'),
J
Johannes Rieken 已提交
1996
	ExtHostFileSystem: createExtId<ExtHostFileSystemShape>('ExtHostFileSystem'),
1997
	ExtHostFileSystemInfo: createExtId<ExtHostFileSystemInfoShape>('ExtHostFileSystemInfo'),
J
Johannes Rieken 已提交
1998
	ExtHostFileSystemEventService: createExtId<ExtHostFileSystemEventServiceShape>('ExtHostFileSystemEventService'),
1999
	ExtHostLanguageFeatures: createExtId<ExtHostLanguageFeaturesShape>('ExtHostLanguageFeatures'),
2000 2001
	ExtHostQuickOpen: createExtId<ExtHostQuickOpenShape>('ExtHostQuickOpen'),
	ExtHostExtensionService: createExtId<ExtHostExtensionServiceShape>('ExtHostExtensionService'),
2002
	ExtHostLogService: createExtId<ExtHostLogServiceShape>('ExtHostLogService'),
2003
	ExtHostTerminalService: createExtId<ExtHostTerminalServiceShape>('ExtHostTerminalService'),
J
Joao Moreno 已提交
2004
	ExtHostSCM: createExtId<ExtHostSCMShape>('ExtHostSCM'),
2005
	ExtHostSearch: createExtId<ExtHostSearchShape>('ExtHostSearch'),
2006
	ExtHostTask: createExtId<ExtHostTaskShape>('ExtHostTask'),
2007
	ExtHostWorkspace: createExtId<ExtHostWorkspaceShape>('ExtHostWorkspace'),
2008
	ExtHostWindow: createExtId<ExtHostWindowShape>('ExtHostWindow'),
2009
	ExtHostWebviews: createExtId<ExtHostWebviewsShape>('ExtHostWebviews'),
2010
	ExtHostWebviewPanels: createExtId<ExtHostWebviewPanelsShape>('ExtHostWebviewPanels'),
2011
	ExtHostCustomEditors: createExtId<ExtHostCustomEditorsShape>('ExtHostCustomEditors'),
2012
	ExtHostWebviewViews: createExtId<ExtHostWebviewViewsShape>('ExtHostWebviewViews'),
2013
	ExtHostEditorInsets: createExtId<ExtHostEditorInsetsShape>('ExtHostEditorInsets'),
2014
	ExtHostEditorTabs: createExtId<IExtHostEditorTabsShape>('ExtHostEditorTabs'),
M
Matt Bierner 已提交
2015
	ExtHostProgress: createMainId<ExtHostProgressShape>('ExtHostProgress'),
2016
	ExtHostComments: createMainId<ExtHostCommentsShape>('ExtHostComments'),
2017
	ExtHostSecretState: createMainId<ExtHostSecretStateShape>('ExtHostSecretState'),
2018
	ExtHostStorage: createMainId<ExtHostStorageShape>('ExtHostStorage'),
2019
	ExtHostUrls: createExtId<ExtHostUrlsShape>('ExtHostUrls'),
2020
	ExtHostUriOpeners: createExtId<ExtHostUriOpenersShape>('ExtHostUriOpeners'),
2021
	ExtHostOutputService: createMainId<ExtHostOutputServiceShape>('ExtHostOutputService'),
R
rebornix 已提交
2022
	ExtHosLabelService: createMainId<ExtHostLabelServiceShape>('ExtHostLabelService'),
2023
	ExtHostNotebook: createMainId<ExtHostNotebookShape>('ExtHostNotebook'),
2024
	ExtHostTheming: createMainId<ExtHostThemingShape>('ExtHostTheming'),
2025
	ExtHostTunnelService: createMainId<ExtHostTunnelServiceShape>('ExtHostTunnelService'),
2026
	ExtHostAuthentication: createMainId<ExtHostAuthenticationShape>('ExtHostAuthentication'),
C
Connor Peet 已提交
2027 2028
	ExtHostTimeline: createMainId<ExtHostTimelineShape>('ExtHostTimeline'),
	ExtHostTesting: createMainId<ExtHostTestingShape>('ExtHostTesting'),
2029
	ExtHostTelemetry: createMainId<ExtHostTelemetryShape>('ExtHostTelemetry'),
2030
};