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

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

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

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

83
export interface IWorkspaceData extends IStaticWorkspaceData {
84
	folders: { uri: UriComponents, name: string, index: number; }[];
85 86
}

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

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

A
Alex Dima 已提交
109
export interface IExtHostContext extends IRPCProtocol {
110
	remoteAuthority: string | null;
111 112
}

A
Alex Dima 已提交
113
export interface IMainContext extends IRPCProtocol {
114 115
}

116 117 118 119 120
export enum UIKind {
	Desktop = 1,
	Web = 2
}

121 122
// --- main thread

123 124 125 126 127
export interface MainThreadClipboardShape extends IDisposable {
	$readText(): Promise<string>;
	$writeText(value: string): Promise<void>;
}

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

R
rebornix 已提交
135
export interface CommentProviderFeatures {
P
Peng Lyu 已提交
136
	reactionGroup?: modes.CommentReaction[];
P
Peng Lyu 已提交
137
	reactionHandler?: boolean;
138
	options?: modes.CommentOptions;
R
rebornix 已提交
139 140
}

141 142 143 144 145
export type CommentThreadChanges = Partial<{
	range: IRange,
	label: string,
	contextValue: string,
	comments: modes.Comment[],
146
	collapseState: modes.CommentThreadCollapsibleState;
147 148
}>;

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

159
export interface MainThreadAuthenticationShape extends IDisposable {
160
	$registerAuthenticationProvider(id: string, label: string, supportsMultipleAccounts: boolean): void;
161
	$unregisterAuthenticationProvider(id: string): void;
162
	$ensureProvider(id: string): Promise<void>;
163 164 165 166
	$getProviderIds(): Promise<string[]>;
	$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>;
	$selectSession(providerId: string, providerName: string, extensionId: string, extensionName: string, potentialSessions: modes.AuthenticationSession[], scopes: string[], clearSessionPreference: boolean): Promise<modes.AuthenticationSession>;
167
	$getSessionsPrompt(providerId: string, accountName: string, providerName: string, extensionId: string, extensionName: string): Promise<boolean>;
168
	$loginPrompt(providerName: string, extensionName: string): Promise<boolean>;
169
	$setTrustedExtensionAndAccountPreference(providerId: string, accountName: string, extensionId: string, extensionName: string, sessionId: string): Promise<void>;
170
	$requestNewSession(providerId: string, scopes: string[], extensionId: string, extensionName: string): Promise<void>;
171 172 173 174

	$getSessions(providerId: string): Promise<ReadonlyArray<modes.AuthenticationSession>>;
	$login(providerId: string, scopes: string[]): Promise<modes.AuthenticationSession>;
	$logout(providerId: string, sessionId: string): Promise<void>;
175 176
}

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

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

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

197
export interface MainThreadDialogSaveOptions {
198
	defaultUri?: UriComponents;
199
	saveLabel?: string;
200
	filters?: { [name: string]: string[]; };
201
	title?: string;
202 203
}

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

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

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

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

227 228
export interface ITextEditorConfigurationUpdate {
	tabSize?: number | 'auto';
A
Alex Dima 已提交
229
	indentSize?: number | 'tabSize';
230 231
	insertSpaces?: boolean | 'auto';
	cursorStyle?: TextEditorCursorStyle;
232
	lineNumbers?: RenderLineNumbersType;
233 234 235 236
}

export interface IResolvedTextEditorConfiguration {
	tabSize: number;
D
David Lechner 已提交
237
	indentSize: number;
238 239
	insertSpaces: boolean;
	cursorStyle: TextEditorCursorStyle;
240
	lineNumbers: RenderLineNumbersType;
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
}

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

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

266 267 268 269
export interface MainThreadBulkEditsShape extends IDisposable {
	$tryApplyWorkspaceEdit(workspaceEditDto: IWorkspaceEditDto): Promise<boolean>;
}

270
export interface MainThreadTextEditorsShape extends IDisposable {
271
	$tryShowTextDocument(resource: UriComponents, options: ITextDocumentShowOptions): Promise<string | undefined>;
272 273
	$registerTextEditorDecorationType(key: string, options: editorCommon.IDecorationRenderOptions): void;
	$removeTextEditorDecorationType(key: string): void;
J
Johannes Rieken 已提交
274 275 276 277 278 279 280 281
	$tryShowEditor(id: string, position: EditorViewColumn): Promise<void>;
	$tryHideEditor(id: string): Promise<void>;
	$trySetOptions(id: string, options: ITextEditorConfigurationUpdate): Promise<void>;
	$trySetDecorations(id: string, key: string, ranges: editorCommon.IDecorationOptions[]): Promise<void>;
	$trySetDecorationsFast(id: string, key: string, ranges: number[]): Promise<void>;
	$tryRevealRange(id: string, range: IRange, revealType: TextEditorRevealType): Promise<void>;
	$trySetSelections(id: string, selections: ISelection[]): Promise<void>;
	$tryApplyEdits(id: string, modelVersionId: number, edits: ISingleEditOperation[], opts: IApplyEditsOptions): Promise<boolean>;
M
Matt Bierner 已提交
282
	$tryInsertSnippet(id: string, template: string, selections: readonly IRange[], opts: IUndoStopOptions): Promise<boolean>;
J
Johannes Rieken 已提交
283
	$getDiffInformation(id: string): Promise<editorCommon.ILineChange[]>;
284 285
}

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

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

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

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

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

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

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

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

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

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

402
export interface MainThreadLanguagesShape extends IDisposable {
J
Johannes Rieken 已提交
403 404
	$getLanguages(): Promise<string[]>;
	$changeLanguage(resource: UriComponents, languageId: string): Promise<void>;
405
	$tokensAtPosition(resource: UriComponents, position: IPosition): Promise<undefined | { type: modes.StandardTokenType, range: IRange }>;
406 407
}

408
export interface MainThreadMessageOptions {
409
	extension?: IExtensionDescription;
410
	modal?: boolean;
411 412
}

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

417
export interface MainThreadOutputServiceShape extends IDisposable {
J
Johannes Rieken 已提交
418
	$register(label: string, log: boolean, file?: UriComponents): Promise<string>;
419 420 421 422 423 424
	$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;
425 426
}

427
export interface MainThreadProgressShape extends IDisposable {
428

B
Benjamin Pasero 已提交
429
	$startProgress(handle: number, options: IProgressOptions, extension?: IExtensionDescription): void;
430 431
	$progressReport(handle: number, message: IProgressStep): void;
	$progressEnd(handle: number): void;
432 433
}

D
Daniel Imms 已提交
434 435 436 437 438
export interface TerminalLaunchConfig {
	name?: string;
	shellPath?: string;
	shellArgs?: string[] | string;
	cwd?: string | UriComponents;
439
	env?: { [key: string]: string | null; };
D
Daniel Imms 已提交
440 441 442
	waitOnExit?: boolean;
	strictEnv?: boolean;
	hideFromUser?: boolean;
443
	isExtensionTerminal?: boolean;
D
Daniel Imms 已提交
444 445
}

446
export interface MainThreadTerminalServiceShape extends IDisposable {
447
	$createTerminal(config: TerminalLaunchConfig): Promise<{ id: number, name: string; }>;
448 449 450 451
	$dispose(terminalId: number): void;
	$hide(terminalId: number): void;
	$sendText(terminalId: number, text: string, addNewLine: boolean): void;
	$show(terminalId: number, preserveFocus: boolean): void;
452 453
	$startSendingDataEvents(): void;
	$stopSendingDataEvents(): void;
454 455
	$startLinkProvider(): void;
	$stopLinkProvider(): void;
D
Daniel Imms 已提交
456
	$registerProcessSupport(isSupported: boolean): void;
457
	$setEnvironmentVariableCollection(extensionIdentifier: string, persistent: boolean, collection: ISerializableEnvironmentVariableCollection | undefined): void;
458

459
	// Process
460 461
	$sendProcessTitle(terminalId: number, title: string): void;
	$sendProcessData(terminalId: number, data: string): void;
D
Daniel Imms 已提交
462
	$sendProcessReady(terminalId: number, pid: number, cwd: string): void;
D
Daniel Imms 已提交
463
	$sendProcessExit(terminalId: number, exitCode: number | undefined): void;
464 465
	$sendProcessInitialCwd(terminalId: number, cwd: string): void;
	$sendProcessCwd(terminalId: number, initialCwd: string): void;
466
	$sendOverrideDimensions(terminalId: number, dimensions: ITerminalDimensions | undefined): void;
467
	$sendResolvedLaunchConfig(terminalId: number, shellLaunchConfig: IShellLaunchConfig): void;
D
Daniel Imms 已提交
468 469
}

J
Johannes Rieken 已提交
470
export interface TransferQuickPickItems extends quickInput.IQuickPickItem {
471 472
	handle: number;
}
C
Christof Marti 已提交
473

474
export interface TransferQuickInputButton {
475
	handle: number;
476 477
	iconPath: { dark: URI; light?: URI; } | { id: string; };
	tooltip?: string;
478
}
479 480 481 482 483

export type TransferQuickInput = TransferQuickPick | TransferInputBox;

export interface BaseTransferQuickInput {

484 485
	[key: string]: any;

486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
	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 已提交
505
	buttons?: TransferQuickInputButton[];
506

C
Christof Marti 已提交
507
	items?: TransferQuickPickItems[];
508

509 510 511 512
	activeItems?: number[];

	selectedItems?: number[];

513 514 515 516 517 518 519
	canSelectMany?: boolean;

	ignoreFocusOut?: boolean;

	matchOnDescription?: boolean;

	matchOnDetail?: boolean;
520 521

	sortByLabel?: boolean;
522 523 524 525 526 527 528 529 530 531 532 533
}

export interface TransferInputBox extends BaseTransferQuickInput {

	type?: 'inputBox';

	value?: string;

	placeholder?: string;

	password?: boolean;

C
Christof Marti 已提交
534
	buttons?: TransferQuickInputButton[];
535 536 537 538 539 540

	prompt?: string;

	validationMessage?: string;
}

541 542 543 544 545 546 547 548 549
export interface IInputBoxOptions {
	value?: string;
	valueSelection?: [number, number];
	prompt?: string;
	placeHolder?: string;
	password?: boolean;
	ignoreFocusOut?: boolean;
}

550
export interface MainThreadQuickOpenShape extends IDisposable {
J
Johannes Rieken 已提交
551
	$show(instance: number, options: quickInput.IPickOptions<TransferQuickPickItems>, token: CancellationToken): Promise<number | number[] | undefined>;
J
Johannes Rieken 已提交
552 553
	$setItems(instance: number, items: TransferQuickPickItems[]): Promise<void>;
	$setError(instance: number, error: Error): Promise<void>;
554
	$input(options: IInputBoxOptions | undefined, validateInput: boolean, token: CancellationToken): Promise<string | undefined>;
J
Johannes Rieken 已提交
555 556
	$createOrUpdate(params: TransferQuickInput): Promise<void>;
	$dispose(id: number): Promise<void>;
557 558
}

559
export interface MainThreadStatusBarShape extends IDisposable {
560
	$setEntry(id: number, statusId: string, statusName: string, text: string, tooltip: string | undefined, command: ICommandDto | undefined, color: string | ThemeColor | undefined, alignment: statusbar.StatusbarAlignment, priority: number | undefined, accessibilityInformation: IAccessibilityInformation | undefined): void;
561
	$dispose(id: number): void;
562 563
}

564
export interface MainThreadStorageShape extends IDisposable {
565
	$getValue<T>(shared: boolean, key: string): Promise<T | undefined>;
J
Johannes Rieken 已提交
566
	$setValue(shared: boolean, key: string, value: object): Promise<void>;
567 568
}

569
export interface MainThreadTelemetryShape extends IDisposable {
570
	$publicLog(eventName: string, data?: any): void;
571
	$publicLog2<E extends ClassifiedEvent<T> = never, T extends GDPRClassification<T> = never>(eventName: string, data?: StrictPropertyCheck<T, E>): void;
572 573
}

574
export interface MainThreadEditorInsetsShape extends IDisposable {
575
	$createEditorInset(handle: number, id: string, uri: UriComponents, line: number, height: number, options: modes.IWebviewOptions, extensionId: ExtensionIdentifier, extensionLocation: UriComponents): Promise<void>;
576 577 578 579 580 581
	$disposeEditorInset(handle: number): void;

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

583 584 585 586 587
export interface ExtHostEditorInsetsShape {
	$onDidDispose(handle: number): void;
	$onDidReceiveMessage(handle: number, message: any): void;
}

588
export type WebviewHandle = string;
589

M
Matt Bierner 已提交
590 591 592 593 594
export interface WebviewPanelShowOptions {
	readonly viewColumn?: EditorViewColumn;
	readonly preserveFocus?: boolean;
}

595 596 597 598 599
export interface WebviewExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
}

R
rebornix 已提交
600 601 602
export interface NotebookExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
R
rebornix 已提交
603
	readonly description?: string;
R
rebornix 已提交
604 605
}

606
export enum WebviewEditorCapabilities {
M
Matt Bierner 已提交
607
	Editable,
608
	SupportsHotExit,
609 610
}

611 612 613 614
export interface CustomTextEditorCapabilities {
	readonly supportsMove?: boolean;
}

M
Matt Bierner 已提交
615
export interface MainThreadWebviewsShape extends IDisposable {
616 617 618
	$setHtml(handle: WebviewHandle, value: string): void;
	$setOptions(handle: WebviewHandle, options: modes.IWebviewOptions): void;
	$postMessage(handle: WebviewHandle, value: any): Promise<boolean>
619
}
620

621
export interface MainThreadWebviewPanelsShape extends IDisposable {
622 623 624 625 626
	$createWebviewPanel(extension: WebviewExtensionDescription, handle: WebviewHandle, viewType: string, title: string, showOptions: WebviewPanelShowOptions, options: modes.IWebviewPanelOptions & modes.IWebviewOptions): void;
	$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;
627 628 629

	$registerSerializer(viewType: string): void;
	$unregisterSerializer(viewType: string): void;
630
}
631

632
export interface MainThreadCustomEditorsShape extends IDisposable {
633
	$registerTextEditorProvider(extension: WebviewExtensionDescription, viewType: string, options: modes.IWebviewPanelOptions, capabilities: CustomTextEditorCapabilities): void;
634
	$registerCustomEditorProvider(extension: WebviewExtensionDescription, viewType: string, options: modes.IWebviewPanelOptions, supportsMultipleEditorsPerDocument: boolean): void;
635
	$unregisterEditorProvider(viewType: string): void;
636

637
	$onDidEdit(resource: UriComponents, viewType: string, editId: number, label: string | undefined): void;
638
	$onContentChange(resource: UriComponents, viewType: string): void;
639
}
640

641
export interface MainThreadWebviewViewsShape extends IDisposable {
642
	$registerWebviewViewProvider(viewType: string, options?: { retainContextWhenHidden?: boolean }): void;
643
	$unregisterWebviewViewProvider(viewType: string): void;
644

645
	$setWebviewViewTitle(handle: WebviewHandle, value: string | undefined): void;
M
Matt Bierner 已提交
646
	$setWebviewViewDescription(handle: WebviewHandle, value: string | undefined): void;
M
Matt Bierner 已提交
647 648

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

651 652 653 654 655 656
export interface WebviewPanelViewStateData {
	[handle: string]: {
		readonly active: boolean;
		readonly visible: boolean;
		readonly position: EditorViewColumn;
	};
M
Matt Bierner 已提交
657 658
}

M
Matt Bierner 已提交
659
export interface ExtHostWebviewsShape {
660 661
	$onMessage(handle: WebviewHandle, message: any): void;
	$onMissingCsp(handle: WebviewHandle, extensionId: string): void;
662
}
663

664
export interface ExtHostWebviewPanelsShape {
665
	$onDidChangeWebviewPanelViewStates(newState: WebviewPanelViewStateData): void;
666 667
	$onDidDisposeWebviewPanel(handle: WebviewHandle): Promise<void>;
	$deserializeWebviewPanel(newWebviewHandle: WebviewHandle, viewType: string, title: string, state: any, position: EditorViewColumn, options: modes.IWebviewOptions & modes.IWebviewPanelOptions): Promise<void>;
668
}
669

670
export interface ExtHostCustomEditorsShape {
671
	$resolveWebviewEditor(resource: UriComponents, newWebviewHandle: WebviewHandle, viewType: string, title: string, position: EditorViewColumn, options: modes.IWebviewOptions & modes.IWebviewPanelOptions, cancellation: CancellationToken): Promise<void>;
M
Matt Bierner 已提交
672 673
	$createCustomDocument(resource: UriComponents, viewType: string, backupId: string | undefined, cancellation: CancellationToken): Promise<{ editable: boolean }>;
	$disposeCustomDocument(resource: UriComponents, viewType: string): Promise<void>;
674

M
Matt Bierner 已提交
675 676 677
	$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>;
678 679
	$disposeEdits(resourceComponents: UriComponents, viewType: string, editIds: number[]): void;

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

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

685
	$onMoveCustomEditor(handle: WebviewHandle, newResource: UriComponents, viewType: string): Promise<void>;
686
}
687

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

691
	$onDidChangeWebviewViewVisibility(webviewHandle: WebviewHandle, visible: boolean): void;
692

693
	$disposeWebviewView(webviewHandle: WebviewHandle): void;
M
Matt Bierner 已提交
694 695
}

R
rebornix 已提交
696 697 698 699 700 701 702 703 704 705 706
export enum CellKind {
	Markdown = 1,
	Code = 2
}

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

707 708
export interface ICellDto {
	handle: number;
709
	uri: UriComponents,
710 711
	source: string[];
	language: string;
R
rebornix 已提交
712
	cellKind: CellKind;
713
	outputs: IProcessedOutput[];
714
	metadata?: NotebookCellMetadata;
715 716
}

717 718 719 720 721 722 723 724 725
export type NotebookCellsSplice = [
	number /* start */,
	number /* delete count */,
	ICellDto[]
];

export type NotebookCellOutputsSplice = [
	number /* start */,
	number /* delete count */,
726
	IProcessedOutput[]
727 728
];

R
rebornix 已提交
729 730 731 732 733 734
export enum NotebookEditorRevealType {
	Default = 0,
	InCenter = 1,
	InCenterIfOutsideViewport = 2,
}

735 736
export type INotebookCellStatusBarEntryDto = Dto<INotebookCellStatusBarEntry>;

R
rebornix 已提交
737
export interface MainThreadNotebookShape extends IDisposable {
738 739 740 741 742
	$registerNotebookProvider(extension: NotebookExtensionDescription, viewType: string, supportBackup: boolean, options: {
		transientOutputs: boolean;
		transientMetadata: TransientMetadata;
		viewOptions?: { displayName: string; filenamePattern: string | IRelativePattern | INotebookExclusiveDocumentFilter; exclusive: boolean; };
	}): Promise<void>;
R
rebornix 已提交
743
	$unregisterNotebookProvider(viewType: string): Promise<void>;
R
rebornix 已提交
744 745
	$registerNotebookKernelProvider(extension: NotebookExtensionDescription, handle: number, documentFilter: INotebookDocumentFilter): Promise<void>;
	$unregisterNotebookKernelProvider(handle: number): Promise<void>;
R
rebornix 已提交
746
	$onNotebookKernelChange(handle: number, uri: UriComponents | undefined): void;
747
	$tryApplyEdits(viewType: string, resource: UriComponents, modelVersionId: number, edits: ICellEditOperation[]): Promise<boolean>;
R
rebornix 已提交
748
	$updateNotebookLanguages(viewType: string, resource: UriComponents, languages: string[]): Promise<void>;
749
	$spliceNotebookCellOutputs(viewType: string, resource: UriComponents, cellHandle: number, splices: NotebookCellOutputsSplice[]): Promise<void>;
750
	$postMessage(editorId: string, forRendererId: string | undefined, value: any): Promise<boolean>;
751
	$setStatusBarEntry(id: number, statusBarEntry: INotebookCellStatusBarEntryDto): Promise<void>;
R
rebornix 已提交
752
	$tryRevealRange(id: string, range: ICellRange, revealType: NotebookEditorRevealType): Promise<void>;
R
rebornix 已提交
753 754 755
	$registerNotebookEditorDecorationType(key: string, options: INotebookDecorationRenderOptions): void;
	$removeNotebookEditorDecorationType(key: string): void;
	$trySetDecorations(id: string, range: ICellRange, decorationKey: string): void;
756
	$onUndoableContentChange(resource: UriComponents, viewType: string, editId: number, label: string | undefined): void;
757
	$onContentChange(resource: UriComponents, viewType: string): void;
M
Matt Bierner 已提交
758 759
}

J
Joao Moreno 已提交
760
export interface MainThreadUrlsShape extends IDisposable {
761
	$registerUriHandler(handle: number, extensionId: ExtensionIdentifier): Promise<void>;
J
Johannes Rieken 已提交
762
	$unregisterUriHandler(handle: number): Promise<void>;
763
	$createAppUri(uri: UriComponents): Promise<UriComponents>;
J
Joao Moreno 已提交
764 765 766
}

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

770 771 772 773
export interface ITextSearchComplete {
	limitHit?: boolean;
}

774
export interface MainThreadWorkspaceShape extends IDisposable {
775
	$startFileSearch(includePattern: string | null, includeFolder: UriComponents | null, excludePatternOrDisregardExcludes: string | false | null, maxResults: number | null, token: CancellationToken): Promise<UriComponents[] | null>;
776
	$startTextSearch(query: search.IPatternInfo, folder: UriComponents | null, options: ITextQueryBuilderOptions, requestId: number, token: CancellationToken): Promise<ITextSearchComplete | null>;
777
	$checkExists(folders: readonly UriComponents[], includes: string[], token: CancellationToken): Promise<boolean>;
J
Johannes Rieken 已提交
778
	$saveAll(includeUntitled?: boolean): Promise<boolean>;
779
	$updateWorkspaceFolders(extensionName: string, index: number, deleteCount: number, workspaceFoldersToAdd: { uri: UriComponents, name?: string; }[]): Promise<void>;
780
	$resolveProxy(url: string): Promise<string | undefined>;
781
}
782

J
Johannes Rieken 已提交
783 784
export interface IFileChangeDto {
	resource: UriComponents;
J
Johannes Rieken 已提交
785
	type: files.FileChangeType;
J
Johannes Rieken 已提交
786 787
}

788
export interface MainThreadFileSystemShape extends IDisposable {
789
	$registerFileSystemProvider(handle: number, scheme: string, capabilities: files.FileSystemProviderCapabilities): Promise<void>;
790
	$unregisterProvider(handle: number): void;
J
Johannes Rieken 已提交
791
	$onFileSystemChange(handle: number, resource: IFileChangeDto[]): void;
792 793 794 795

	$stat(uri: UriComponents): Promise<files.IStat>;
	$readdir(resource: UriComponents): Promise<[string, files.FileType][]>;
	$readFile(resource: UriComponents): Promise<VSBuffer>;
796
	$writeFile(resource: UriComponents, content: VSBuffer): Promise<void>;
797 798 799 800
	$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>;
801
}
J
Johannes Rieken 已提交
802

803 804 805 806 807
export interface MainThreadLabelServiceShape extends IDisposable {
	$registerResourceLabelFormatter(handle: number, formatter: ResourceLabelFormatter): void;
	$unregisterResourceLabelFormatter(handle: number): void;
}

808
export interface MainThreadSearchShape extends IDisposable {
809 810
	$registerFileSearchProvider(handle: number, scheme: string): void;
	$registerTextSearchProvider(handle: number, scheme: string): void;
811
	$unregisterProvider(handle: number): void;
812
	$handleFileMatch(handle: number, session: number, data: UriComponents[]): void;
J
Johannes Rieken 已提交
813
	$handleTextMatch(handle: number, session: number, data: search.IRawFileMatch2[]): void;
814
	$handleTelemetry(eventName: string, data: any): void;
815 816
}

817
export interface MainThreadTaskShape extends IDisposable {
J
Johannes Rieken 已提交
818
	$createTaskId(task: tasks.TaskDTO): Promise<string>;
819
	$registerTaskProvider(handle: number, type: string): Promise<void>;
J
Johannes Rieken 已提交
820
	$unregisterTaskProvider(handle: number): Promise<void>;
J
Johannes Rieken 已提交
821
	$fetchTasks(filter?: tasks.TaskFilterDTO): Promise<tasks.TaskDTO[]>;
822
	$getTaskExecution(value: tasks.TaskHandleDTO | tasks.TaskDTO): Promise<tasks.TaskExecutionDTO>;
J
Johannes Rieken 已提交
823
	$executeTask(task: tasks.TaskHandleDTO | tasks.TaskDTO): Promise<tasks.TaskExecutionDTO>;
J
Johannes Rieken 已提交
824
	$terminateTask(id: string): Promise<void>;
J
Johannes Rieken 已提交
825
	$registerTaskSystem(scheme: string, info: tasks.TaskSystemInfoDTO): void;
G
Gabriel DeBacker 已提交
826
	$customExecutionComplete(id: string, result?: number): Promise<void>;
827
	$registerSupportedExecutions(custom?: boolean, shell?: boolean, process?: boolean): Promise<void>;
828 829
}

830
export interface MainThreadExtensionServiceShape extends IDisposable {
831
	$activateExtension(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<void>;
832
	$onWillActivateExtension(extensionId: ExtensionIdentifier): void;
833
	$onDidActivateExtension(extensionId: ExtensionIdentifier, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number, activationReason: ExtensionActivationReason): void;
834
	$onExtensionActivationError(extensionId: ExtensionIdentifier, error: ExtensionActivationError): Promise<void>;
835
	$onExtensionRuntimeError(extensionId: ExtensionIdentifier, error: SerializedError): void;
836
	$onExtensionHostExit(code: number): Promise<void>;
837 838
}

J
Joao Moreno 已提交
839
export interface SCMProviderFeatures {
J
Joao Moreno 已提交
840 841
	hasQuickDiffProvider?: boolean;
	count?: number;
842 843
	commitTemplate?: string;
	acceptInputCommand?: modes.Command;
J
Johannes Rieken 已提交
844
	statusBarCommands?: ICommandDto[];
J
Joao Moreno 已提交
845 846 847 848
}

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

J
Joao Moreno 已提交
851
export type SCMRawResource = [
852
	number /*handle*/,
853
	UriComponents /*resourceUri*/,
854
	UriComponents[] /*icons: light, dark*/,
855
	string /*tooltip*/,
856
	boolean /*strike through*/,
857 858
	boolean /*faded*/,
	string /*context value*/
J
Joao Moreno 已提交
859
];
860

861 862 863
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
864 865 866
	SCMRawResource[]
];

867 868 869 870 871
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

872
export interface MainThreadSCMShape extends IDisposable {
873
	$registerSourceControl(handle: number, id: string, label: string, rootUri: UriComponents | undefined): void;
874 875
	$updateSourceControl(handle: number, features: SCMProviderFeatures): void;
	$unregisterSourceControl(handle: number): void;
J
Joao Moreno 已提交
876

877
	$registerGroups(sourceControlHandle: number, groups: [number /*handle*/, string /*id*/, string /*label*/, SCMGroupFeatures][], splices: SCMRawResourceSplices[]): void;
878 879 880
	$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 已提交
881

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

J
Joao Moreno 已提交
884
	$setInputBoxValue(sourceControlHandle: number, value: string): void;
885
	$setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
886
	$setInputBoxVisibility(sourceControlHandle: number, visible: boolean): void;
887
	$setValidationProviderIsEnabled(sourceControlHandle: number, enabled: boolean): void;
J
Joao Moreno 已提交
888 889
}

890 891
export type DebugSessionUUID = string;

892 893 894 895 896 897 898
export interface IDebugConfiguration {
	type: string;
	name: string;
	request: string;
	[key: string]: any;
}

899 900 901
export interface IStartDebuggingOptions {
	parentSessionID?: DebugSessionUUID;
	repl?: IDebugSessionReplMode;
I
isidor 已提交
902
	noDebug?: boolean;
903
	compact?: boolean;
904 905
}

906
export interface MainThreadDebugServiceShape extends IDisposable {
A
Alex Dima 已提交
907
	$registerDebugTypes(debugTypes: string[]): void;
908
	$sessionCached(sessionID: string): void;
A
Alex Dima 已提交
909
	$acceptDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
910 911
	$acceptDAError(handle: number, name: string, message: string, stack: string | undefined): void;
	$acceptDAExit(handle: number, code: number | undefined, signal: string | undefined): void;
912
	$registerDebugConfigurationProvider(type: string, triggerKind: DebugConfigurationProviderTriggerKind, hasProvideMethod: boolean, hasResolveMethod: boolean, hasResolve2Method: boolean, hasProvideDaMethod: boolean, handle: number): Promise<void>;
J
Johannes Rieken 已提交
913
	$registerDebugAdapterDescriptorFactory(type: string, handle: number): Promise<void>;
914
	$unregisterDebugConfigurationProvider(handle: number): void;
A
Andre Weinand 已提交
915
	$unregisterDebugAdapterDescriptorFactory(handle: number): void;
I
isidor 已提交
916
	$startDebugging(folder: UriComponents | undefined, nameOrConfig: string | IDebugConfiguration, options: IStartDebuggingOptions): Promise<boolean>;
917
	$stopDebugging(sessionId: DebugSessionUUID | undefined): Promise<void>;
918
	$setDebugSessionName(id: DebugSessionUUID, name: string): void;
J
Johannes Rieken 已提交
919
	$customDebugAdapterRequest(id: DebugSessionUUID, command: string, args: any): Promise<any>;
920
	$getDebugProtocolBreakpoint(id: DebugSessionUUID, breakpoinId: string): Promise<DebugProtocol.Breakpoint | undefined>;
921 922
	$appendDebugConsole(value: string): void;
	$startBreakpointEvents(): void;
I
isidor 已提交
923 924
	$registerBreakpoints(breakpoints: Array<ISourceMultiBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>): Promise<void>;
	$unregisterBreakpoints(breakpointIds: string[], functionBreakpointIds: string[], dataBreakpointIds: string[]): Promise<void>;
925 926
}

927 928 929 930
export interface IOpenUriOptions {
	readonly allowTunneling?: boolean;
}

931
export interface MainThreadWindowShape extends IDisposable {
J
Johannes Rieken 已提交
932
	$getWindowVisibility(): Promise<boolean>;
933
	$openUri(uri: UriComponents, uriString: string | undefined, options: IOpenUriOptions): Promise<boolean>;
934
	$asExternalUri(uri: UriComponents, options: IOpenUriOptions): Promise<UriComponents>;
935 936
}

A
Alex Ross 已提交
937 938
export interface MainThreadTunnelServiceShape extends IDisposable {
	$openTunnel(tunnelOptions: TunnelOptions): Promise<TunnelDto | undefined>;
939
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
940
	$getTunnels(): Promise<TunnelDescription[]>;
A
Alex Ross 已提交
941
	$registerCandidateFinder(): Promise<void>;
942
	$setTunnelProvider(): Promise<void>;
943
	$setCandidateFilter(): Promise<void>;
944
	$tunnelServiceReady(): Promise<void>;
A
Alex Ross 已提交
945 946
}

947
export interface MainThreadTimelineShape extends IDisposable {
948 949
	$registerTimelineProvider(provider: TimelineProviderDescriptor): void;
	$unregisterTimelineProvider(source: string): void;
E
Eric Amodio 已提交
950
	$emitTimelineChangeEvent(e: TimelineChangeEvent | undefined): void;
951 952
}

953 954
// -- extension host

955
export interface ExtHostCommandsShape {
J
Johannes Rieken 已提交
956
	$executeContributedCommand<T>(id: string, ...args: any[]): Promise<T>;
957
	$getContributedCommandHandlerDescriptions(): Promise<{ [id: string]: string | ICommandHandlerDescription; }>;
958 959
}

960
export interface ExtHostConfigurationShape {
961
	$initializeConfiguration(data: IConfigurationInitData): void;
962
	$acceptConfigurationChanged(data: IConfigurationInitData, change: IConfigurationChange): void;
963 964
}

965
export interface ExtHostDiagnosticsShape {
J
Johannes Rieken 已提交
966
	$acceptMarkersChange(data: [UriComponents, IMarkerData[]][]): void;
967 968
}

969
export interface ExtHostDocumentContentProvidersShape {
M
Matt Bierner 已提交
970
	$provideTextDocumentContent(handle: number, uri: UriComponents): Promise<string | null | undefined>;
971 972
}

973
export interface IModelAddedData {
974
	uri: UriComponents;
975
	versionId: number;
976 977
	lines: string[];
	EOL: string;
978 979 980
	modeId: string;
	isDirty: boolean;
}
981
export interface ExtHostDocumentsShape {
982 983 984 985
	$acceptModelModeChanged(strURL: UriComponents, oldModeId: string, newModeId: string): void;
	$acceptModelSaved(strURL: UriComponents): void;
	$acceptDirtyStateChanged(strURL: UriComponents, isDirty: boolean): void;
	$acceptModelChanged(strURL: UriComponents, e: IModelChangedEvent, isDirty: boolean): void;
986 987
}

988
export interface ExtHostDocumentSaveParticipantShape {
J
Johannes Rieken 已提交
989
	$participateInSave(resource: UriComponents, reason: SaveReason): Promise<boolean[]>;
990 991
}

992 993
export interface ITextEditorAddData {
	id: string;
994
	documentUri: UriComponents;
995
	options: IResolvedTextEditorConfiguration;
A
Alex Dima 已提交
996
	selections: ISelection[];
997
	visibleRanges: IRange[];
A
Alex Dima 已提交
998
	editorPosition: EditorViewColumn | undefined;
999 1000
}
export interface ITextEditorPositionData {
1001
	[id: string]: EditorViewColumn;
1002
}
1003 1004 1005
export interface IEditorPropertiesChangeData {
	options: IResolvedTextEditorConfiguration | null;
	selections: ISelectionChangeEvent | null;
1006
	visibleRanges: IRange[] | null;
1007 1008 1009 1010 1011 1012
}
export interface ISelectionChangeEvent {
	selections: Selection[];
	source?: string;
}

1013
export interface ExtHostEditorsShape {
1014
	$acceptEditorPropertiesChanged(id: string, props: IEditorPropertiesChangeData): void;
1015
	$acceptEditorPositionData(data: ITextEditorPositionData): void;
1016 1017
}

J
Johannes Rieken 已提交
1018
export interface IDocumentsAndEditorsDelta {
1019
	removedDocuments?: UriComponents[];
J
Johannes Rieken 已提交
1020 1021 1022
	addedDocuments?: IModelAddedData[];
	removedEditors?: string[];
	addedEditors?: ITextEditorAddData[];
A
Alex Dima 已提交
1023
	newActiveEditor?: string | null;
J
Johannes Rieken 已提交
1024 1025
}

1026 1027
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
1028 1029
}

1030
export interface ExtHostTreeViewsShape {
J
Johannes Rieken 已提交
1031
	$getChildren(treeViewId: string, treeItemHandle?: string): Promise<ITreeItem[]>;
1032
	$setExpanded(treeViewId: string, treeItemHandle: string, expanded: boolean): void;
1033
	$setSelection(treeViewId: string, treeItemHandles: string[]): void;
1034
	$setVisible(treeViewId: string, visible: boolean): void;
A
Alex Ross 已提交
1035 1036
	$hasResolve(treeViewId: string): Promise<boolean>;
	$resolve(treeViewId: string, treeItemHandle: string): Promise<ITreeItem | undefined>;
S
Sandeep Somavarapu 已提交
1037 1038
}

1039
export interface ExtHostWorkspaceShape {
1040
	$initializeWorkspace(workspace: IWorkspaceData | null): void;
1041
	$acceptWorkspaceData(workspace: IWorkspaceData | null): void;
J
Johannes Rieken 已提交
1042
	$handleTextSearchResult(result: search.IRawFileMatch2, requestId: number): void;
1043
}
1044

1045 1046 1047 1048
export interface ExtHostFileSystemInfoShape {
	$acceptProviderInfos(scheme: string, capabilities: number | null): void;
}

1049
export interface ExtHostFileSystemShape {
J
Johannes Rieken 已提交
1050 1051
	$stat(handle: number, resource: UriComponents): Promise<files.IStat>;
	$readdir(handle: number, resource: UriComponents): Promise<[string, files.FileType][]>;
1052 1053
	$readFile(handle: number, resource: UriComponents): Promise<VSBuffer>;
	$writeFile(handle: number, resource: UriComponents, content: VSBuffer, opts: files.FileWriteOptions): Promise<void>;
J
Johannes Rieken 已提交
1054 1055
	$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 已提交
1056
	$mkdir(handle: number, resource: UriComponents): Promise<void>;
J
Johannes Rieken 已提交
1057 1058
	$delete(handle: number, resource: UriComponents, opts: files.FileDeleteOptions): Promise<void>;
	$watch(handle: number, session: number, resource: UriComponents, opts: files.IWatchOptions): void;
1059
	$unwatch(handle: number, session: number): void;
J
Johannes Rieken 已提交
1060
	$open(handle: number, resource: UriComponents, opts: files.FileOpenOptions): Promise<number>;
J
Johannes Rieken 已提交
1061
	$close(handle: number, fd: number): Promise<void>;
1062 1063
	$read(handle: number, fd: number, pos: number, length: number): Promise<VSBuffer>;
	$write(handle: number, fd: number, pos: number, data: VSBuffer): Promise<number>;
1064
}
1065

1066 1067 1068 1069
export interface ExtHostLabelServiceShape {
	$registerResourceLabelFormatter(formatter: ResourceLabelFormatter): IDisposable;
}

1070
export interface ExtHostAuthenticationShape {
1071
	$getSessions(id: string): Promise<ReadonlyArray<modes.AuthenticationSession>>;
1072
	$getSessionAccessToken(id: string, sessionId: string): Promise<string>;
1073
	$login(id: string, scopes: string[]): Promise<modes.AuthenticationSession>;
1074
	$logout(id: string, sessionId: string): Promise<void>;
1075 1076
	$onDidChangeAuthenticationSessions(id: string, label: string, event: modes.AuthenticationSessionsChangeEvent): Promise<void>;
	$onDidChangeAuthenticationProviders(added: modes.AuthenticationProviderInformation[], removed: modes.AuthenticationProviderInformation[]): Promise<void>;
1077
	$setProviders(providers: modes.AuthenticationProviderInformation[]): Promise<void>;
1078 1079
}

1080
export interface ExtHostSearchShape {
J
Johannes Rieken 已提交
1081 1082
	$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 已提交
1083
	$clearCache(cacheKey: string): Promise<void>;
1084 1085
}

A
Tweaks  
Alex Dima 已提交
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
export interface IResolveAuthorityErrorResult {
	type: 'error';
	error: {
		message: string | undefined;
		code: RemoteAuthorityResolverErrorCode;
		detail: any;
	};
}

export interface IResolveAuthorityOKResult {
	type: 'ok';
1097
	value: ResolverResult;
A
Tweaks  
Alex Dima 已提交
1098 1099 1100 1101
}

export type IResolveAuthorityResult = IResolveAuthorityErrorResult | IResolveAuthorityOKResult;

1102
export interface ExtHostExtensionServiceShape {
A
Tweaks  
Alex Dima 已提交
1103
	$resolveAuthority(remoteAuthority: string, resolveAttempt: number): Promise<IResolveAuthorityResult>;
1104
	$startExtensionHost(enabledExtensionIds: ExtensionIdentifier[]): Promise<void>;
1105
	$activateByEvent(activationEvent: string, activationKind: ActivationKind): Promise<void>;
1106
	$activate(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<boolean>;
1107
	$setRemoteEnvironment(env: { [key: string]: string | null; }): Promise<void>;
1108
	$updateRemoteConnectionData(connectionData: IRemoteConnectionData): Promise<void>;
1109

1110
	$deltaExtensions(toAdd: IExtensionDescription[], toRemove: ExtensionIdentifier[]): Promise<void>;
1111 1112

	$test_latency(n: number): Promise<number>;
1113 1114
	$test_up(b: VSBuffer): Promise<number>;
	$test_down(size: number): Promise<VSBuffer>;
1115 1116 1117
}

export interface FileSystemEvents {
J
Johannes Rieken 已提交
1118 1119 1120
	created: UriComponents[];
	changed: UriComponents[];
	deleted: UriComponents[];
1121
}
1122

1123 1124 1125 1126 1127
export interface SourceTargetPair {
	source?: UriComponents;
	target: UriComponents;
}

1128
export interface ExtHostFileSystemEventServiceShape {
1129
	$onFileEvent(events: FileSystemEvents): void;
1130 1131
	$onWillRunFileOperation(operation: files.FileOperation, files: SourceTargetPair[], timeout: number, token: CancellationToken): Promise<any>;
	$onDidRunFileOperation(operation: files.FileOperation, files: SourceTargetPair[]): void;
1132 1133
}

J
Johannes Rieken 已提交
1134
export interface ObjectIdentifier {
1135
	$ident?: number;
J
Johannes Rieken 已提交
1136 1137 1138
}

export namespace ObjectIdentifier {
1139
	export const name = '$ident';
J
Johannes Rieken 已提交
1140
	export function mixin<T>(obj: T, id: number): T & ObjectIdentifier {
1141
		Object.defineProperty(obj, name, { value: id, enumerable: true });
J
Johannes Rieken 已提交
1142 1143
		return <T & ObjectIdentifier>obj;
	}
1144 1145
	export function of(obj: any): number {
		return obj[name];
J
Johannes Rieken 已提交
1146 1147 1148
	}
}

1149 1150
export interface ExtHostHeapServiceShape {
	$onGarbageCollection(ids: number[]): void;
1151
}
1152
export interface IRawColorInfo {
J
Joao Moreno 已提交
1153
	color: [number, number, number, number];
1154 1155 1156
	range: IRange;
}

1157 1158 1159 1160 1161 1162 1163 1164 1165
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;
	}
}

1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
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 已提交
1181 1182 1183

	// to merge into label
	label2 = 'o',
1184 1185
}

J
Johannes Rieken 已提交
1186
export interface ISuggestDataDto {
P
label2  
Pine Wu 已提交
1187 1188
	[ISuggestDataDtoField.label]: string;
	[ISuggestDataDtoField.label2]?: string | modes.CompletionItemLabel;
1189
	[ISuggestDataDtoField.kind]?: modes.CompletionItemKind;
1190 1191 1192 1193
	[ISuggestDataDtoField.detail]?: string;
	[ISuggestDataDtoField.documentation]?: string | IMarkdownString;
	[ISuggestDataDtoField.sortText]?: string;
	[ISuggestDataDtoField.filterText]?: string;
1194
	[ISuggestDataDtoField.preselect]?: true;
1195 1196
	[ISuggestDataDtoField.insertText]?: string;
	[ISuggestDataDtoField.insertTextRules]?: modes.CompletionItemInsertTextRule;
1197
	[ISuggestDataDtoField.range]?: IRange | { insert: IRange, replace: IRange; };
1198 1199 1200 1201
	[ISuggestDataDtoField.commitCharacters]?: string[];
	[ISuggestDataDtoField.additionalTextEdits]?: ISingleEditOperation[];
	[ISuggestDataDtoField.command]?: modes.Command;
	[ISuggestDataDtoField.kindModifier]?: modes.CompletionItemTag[];
J
Johannes Rieken 已提交
1202
	// not-standard
1203
	x?: ChainedCacheId;
J
Johannes Rieken 已提交
1204 1205
}

1206 1207 1208 1209 1210 1211
export const enum ISuggestResultDtoField {
	defaultRanges = 'a',
	completions = 'b',
	isIncomplete = 'c'
}

J
Johannes Rieken 已提交
1212
export interface ISuggestResultDto {
1213 1214 1215
	[ISuggestResultDtoField.defaultRanges]: { insert: IRange, replace: IRange; };
	[ISuggestResultDtoField.completions]: ISuggestDataDto[];
	[ISuggestResultDtoField.isIncomplete]: undefined | true;
1216
	x?: number;
1217 1218
}

J
Johannes Rieken 已提交
1219
export interface ISignatureHelpDto {
1220 1221 1222 1223 1224 1225
	id: CacheId;
	signatures: modes.SignatureInformation[];
	activeSignature: number;
	activeParameter: number;
}

J
Johannes Rieken 已提交
1226
export interface ISignatureHelpContextDto {
1227 1228 1229
	readonly triggerKind: modes.SignatureHelpTriggerKind;
	readonly triggerCharacter?: string;
	readonly isRetrigger: boolean;
J
Johannes Rieken 已提交
1230
	readonly activeSignatureHelp?: ISignatureHelpDto;
1231 1232
}

J
Johannes Rieken 已提交
1233
export interface ILocationDto {
1234 1235
	uri: UriComponents;
	range: IRange;
1236 1237
}

J
Johannes Rieken 已提交
1238
export interface IDefinitionLinkDto {
J
Johannes Rieken 已提交
1239
	originSelectionRange?: IRange;
M
Matt Bierner 已提交
1240 1241
	uri: UriComponents;
	range: IRange;
J
Johannes Rieken 已提交
1242
	targetSelectionRange?: IRange;
M
Matt Bierner 已提交
1243 1244
}

J
Johannes Rieken 已提交
1245
export interface IWorkspaceSymbolDto extends IdObject {
1246 1247 1248
	name: string;
	containerName?: string;
	kind: modes.SymbolKind;
J
Johannes Rieken 已提交
1249
	location: ILocationDto;
1250 1251
}

J
Johannes Rieken 已提交
1252 1253
export interface IWorkspaceSymbolsDto extends IdObject {
	symbols: IWorkspaceSymbolDto[];
1254 1255
}

1256 1257 1258 1259 1260 1261 1262
export interface IWorkspaceEditEntryMetadataDto {
	needsConfirmation: boolean;
	label: string;
	description?: string;
	iconPath?: { id: string } | UriComponents | { light: UriComponents, dark: UriComponents };
}

1263 1264 1265
export const enum WorkspaceEditType {
	File = 1,
	Text = 2,
1266
	Cell = 3,
1267 1268
}

1269
export interface IWorkspaceFileEditDto {
1270
	_type: WorkspaceEditType.File;
M
Matt Bierner 已提交
1271 1272
	oldUri?: UriComponents;
	newUri?: UriComponents;
1273
	options?: modes.WorkspaceFileEditOptions
1274
	metadata?: IWorkspaceEditEntryMetadataDto;
1275 1276
}

1277
export interface IWorkspaceTextEditDto {
1278
	_type: WorkspaceEditType.Text;
1279
	resource: UriComponents;
1280
	edit: modes.TextEdit;
1281
	modelVersionId?: number;
1282
	metadata?: IWorkspaceEditEntryMetadataDto;
1283 1284
}

1285 1286 1287
export interface IWorkspaceCellEditDto {
	_type: WorkspaceEditType.Cell;
	resource: UriComponents;
1288
	edit: ICellEditOperation;
1289
	notebookVersionId?: number;
1290 1291 1292
	metadata?: IWorkspaceEditEntryMetadataDto;
}

J
Johannes Rieken 已提交
1293
export interface IWorkspaceEditDto {
1294
	edits: Array<IWorkspaceFileEditDto | IWorkspaceTextEditDto | IWorkspaceCellEditDto>;
1295 1296

	// todo@joh reject should go into rename
1297 1298 1299
	rejectReason?: string;
}

J
Johannes Rieken 已提交
1300
export function reviveWorkspaceEditDto(data: IWorkspaceEditDto | undefined): modes.WorkspaceEdit {
1301 1302
	if (data && data.edits) {
		for (const edit of data.edits) {
1303 1304
			if (typeof (<IWorkspaceTextEditDto>edit).resource === 'object') {
				(<IWorkspaceTextEditDto>edit).resource = URI.revive((<IWorkspaceTextEditDto>edit).resource);
1305
			} else {
1306 1307
				(<IWorkspaceFileEditDto>edit).newUri = URI.revive((<IWorkspaceFileEditDto>edit).newUri);
				(<IWorkspaceFileEditDto>edit).oldUri = URI.revive((<IWorkspaceFileEditDto>edit).oldUri);
1308
			}
1309 1310 1311
			if (edit.metadata && edit.metadata.iconPath) {
				edit.metadata = revive(edit.metadata);
			}
1312 1313 1314 1315 1316
		}
	}
	return <modes.WorkspaceEdit>data;
}

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

J
Johannes Rieken 已提交
1319
export interface ICodeActionDto {
1320
	cacheId?: ChainedCacheId;
1321
	title: string;
J
Johannes Rieken 已提交
1322
	edit?: IWorkspaceEditDto;
1323
	diagnostics?: IMarkerData[];
J
Johannes Rieken 已提交
1324
	command?: ICommandDto;
J
Johannes Rieken 已提交
1325
	kind?: string;
1326
	isPreferred?: boolean;
M
Matt Bierner 已提交
1327
	disabled?: string;
1328
}
1329

J
Johannes Rieken 已提交
1330
export interface ICodeActionListDto {
1331
	cacheId: CacheId;
J
Johannes Rieken 已提交
1332
	actions: ReadonlyArray<ICodeActionDto>;
1333 1334
}

1335 1336 1337 1338 1339
export interface ICodeActionProviderMetadataDto {
	readonly providedKinds?: readonly string[];
	readonly documentation?: ReadonlyArray<{ readonly kind: string, readonly command: ICommandDto }>;
}

1340 1341 1342
export type CacheId = number;
export type ChainedCacheId = [CacheId, CacheId];

J
Johannes Rieken 已提交
1343
export interface ILinksListDto {
1344
	id?: CacheId;
J
Johannes Rieken 已提交
1345
	links: ILinkDto[];
1346 1347
}

J
Johannes Rieken 已提交
1348
export interface ILinkDto {
1349
	cacheId?: ChainedCacheId;
M
Martin Aeschlimann 已提交
1350 1351
	range: IRange;
	url?: string | UriComponents;
1352
	tooltip?: string;
M
Martin Aeschlimann 已提交
1353
}
1354

J
Johannes Rieken 已提交
1355
export interface ICodeLensListDto {
1356
	cacheId?: number;
J
Johannes Rieken 已提交
1357
	lenses: ICodeLensDto[];
1358 1359
}

J
Johannes Rieken 已提交
1360
export interface ICodeLensDto {
1361
	cacheId?: ChainedCacheId;
1362
	range: IRange;
J
Johannes Rieken 已提交
1363
	command?: ICommandDto;
1364
}
1365

J
Johannes Rieken 已提交
1366
export type ICallHierarchyItemDto = Dto<CallHierarchyItem>;
1367

1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
export interface IIncomingCallDto {
	from: ICallHierarchyItemDto;
	fromRanges: IRange[];
}

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

A
Alex Dima 已提交
1378 1379 1380 1381 1382 1383
export interface ILanguageWordDefinitionDto {
	languageId: string;
	regexSource: string;
	regexFlags: string
}

1384
export interface ExtHostLanguageFeaturesShape {
1385
	$provideDocumentSymbols(handle: number, resource: UriComponents, token: CancellationToken): Promise<modes.DocumentSymbol[] | undefined>;
J
Johannes Rieken 已提交
1386 1387
	$provideCodeLenses(handle: number, resource: UriComponents, token: CancellationToken): Promise<ICodeLensListDto | undefined>;
	$resolveCodeLens(handle: number, symbol: ICodeLensDto, token: CancellationToken): Promise<ICodeLensDto | undefined>;
1388
	$releaseCodeLenses(handle: number, id: number): void;
J
Johannes Rieken 已提交
1389 1390 1391 1392
	$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[]>;
1393
	$provideHover(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.Hover | undefined>;
1394
	$provideEvaluatableExpression(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.EvaluatableExpression | undefined>;
1395
	$provideDocumentHighlights(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.DocumentHighlight[] | undefined>;
1396
	$provideOnTypeRenameRanges(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<{ ranges: IRange[]; wordPattern?: IRegExpDto; } | undefined>;
J
Johannes Rieken 已提交
1397 1398
	$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>;
1399
	$resolveCodeAction(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<IWorkspaceEditDto | undefined>;
1400
	$releaseCodeActions(handle: number, cacheId: number): void;
1401 1402 1403
	$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 已提交
1404 1405
	$provideWorkspaceSymbols(handle: number, search: string, token: CancellationToken): Promise<IWorkspaceSymbolsDto>;
	$resolveWorkspaceSymbol(handle: number, symbol: IWorkspaceSymbolDto, token: CancellationToken): Promise<IWorkspaceSymbolDto | undefined>;
1406
	$releaseWorkspaceSymbols(handle: number, id: number): void;
J
Johannes Rieken 已提交
1407
	$provideRenameEdits(handle: number, resource: UriComponents, position: IPosition, newName: string, token: CancellationToken): Promise<IWorkspaceEditDto | undefined>;
1408
	$resolveRenameLocation(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.RenameLocation | undefined>;
1409 1410 1411
	$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 已提交
1412
	$provideCompletionItems(handle: number, resource: UriComponents, position: IPosition, context: modes.CompletionContext, token: CancellationToken): Promise<ISuggestResultDto | undefined>;
1413
	$resolveCompletionItem(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<ISuggestDataDto | undefined>;
1414
	$releaseCompletionItems(handle: number, id: number): void;
J
Johannes Rieken 已提交
1415
	$provideSignatureHelp(handle: number, resource: UriComponents, position: IPosition, context: modes.SignatureHelpContext, token: CancellationToken): Promise<ISignatureHelpDto | undefined>;
1416
	$releaseSignatureHelp(handle: number, id: number): void;
J
Johannes Rieken 已提交
1417 1418
	$provideDocumentLinks(handle: number, resource: UriComponents, token: CancellationToken): Promise<ILinksListDto | undefined>;
	$resolveDocumentLink(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<ILinkDto | undefined>;
1419
	$releaseDocumentLinks(handle: number, id: number): void;
J
Johannes Rieken 已提交
1420
	$provideDocumentColors(handle: number, resource: UriComponents, token: CancellationToken): Promise<IRawColorInfo[]>;
M
Matt Bierner 已提交
1421 1422
	$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>;
1423
	$provideSelectionRanges(handle: number, resource: UriComponents, positions: IPosition[], token: CancellationToken): Promise<modes.SelectionRange[][]>;
1424
	$prepareCallHierarchy(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<ICallHierarchyItemDto[] | undefined>;
1425 1426
	$provideCallHierarchyIncomingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IIncomingCallDto[] | undefined>;
	$provideCallHierarchyOutgoingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IOutgoingCallDto[] | undefined>;
1427
	$releaseCallHierarchy(handle: number, sessionId: string): void;
A
Alex Dima 已提交
1428
	$setWordDefinitions(wordDefinitions: ILanguageWordDefinitionDto[]): void;
1429 1430
}

1431 1432
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
M
Matt Bierner 已提交
1433
	$validateInput(input: string): Promise<string | null | undefined>;
1434 1435 1436
	$onDidChangeActive(sessionId: number, handles: number[]): void;
	$onDidChangeSelection(sessionId: number, handles: number[]): void;
	$onDidAccept(sessionId: number): void;
1437
	$onDidChangeValue(sessionId: number, value: string): void;
C
Christof Marti 已提交
1438
	$onDidTriggerButton(sessionId: number, handle: number): void;
1439
	$onDidHide(sessionId: number): void;
1440 1441
}

J
Johannes Rieken 已提交
1442
export interface IShellLaunchConfigDto {
1443 1444 1445
	name?: string;
	executable?: string;
	args?: string[] | string;
1446
	cwd?: string | UriComponents;
1447
	env?: { [key: string]: string | null; };
1448
	hideFromUser?: boolean;
1449 1450
}

D
Daniel Imms 已提交
1451 1452 1453 1454 1455
export interface IShellDefinitionDto {
	label: string;
	path: string;
}

D
Daniel Imms 已提交
1456 1457 1458 1459 1460
export interface IShellAndArgsDto {
	shell: string;
	args: string[] | string | undefined;
}

1461
export interface ITerminalLinkDto {
D
Daniel Imms 已提交
1462 1463
	/** The ID of the link to enable activation and disposal. */
	id: number;
1464 1465 1466 1467 1468 1469 1470 1471
	/** 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;
}

1472 1473 1474 1475 1476
export interface ITerminalDimensionsDto {
	columns: number;
	rows: number;
}

1477
export interface ExtHostTerminalServiceShape {
D
Daniel Imms 已提交
1478
	$acceptTerminalClosed(id: number, exitCode: number | undefined): void;
1479
	$acceptTerminalOpened(id: number, name: string, shellLaunchConfig: IShellLaunchConfigDto): void;
1480
	$acceptActiveTerminalChanged(id: number | null): void;
1481
	$acceptTerminalProcessId(id: number, processId: number): void;
A
Alex Dima 已提交
1482
	$acceptTerminalProcessData(id: number, data: string): void;
1483
	$acceptTerminalTitleChange(id: number, name: string): void;
1484
	$acceptTerminalDimensions(id: number, cols: number, rows: number): void;
1485
	$acceptTerminalMaximumDimensions(id: number, cols: number, rows: number): void;
1486 1487
	$spawnExtHostProcess(id: number, shellLaunchConfig: IShellLaunchConfigDto, activeWorkspaceRootUri: UriComponents | undefined, cols: number, rows: number, isWorkspaceShellAllowed: boolean): Promise<ITerminalLaunchError | undefined>;
	$startExtensionTerminal(id: number, initialDimensions: ITerminalDimensionsDto | undefined): Promise<ITerminalLaunchError | undefined>;
D
Daniel Imms 已提交
1488 1489
	$acceptProcessInput(id: number, data: string): void;
	$acceptProcessResize(id: number, cols: number, rows: number): void;
1490
	$acceptProcessShutdown(id: number, immediate: boolean): void;
1491 1492
	$acceptProcessRequestInitialCwd(id: number): void;
	$acceptProcessRequestCwd(id: number): void;
1493
	$acceptProcessRequestLatency(id: number): number;
1494
	$acceptWorkspacePermissionsChanged(isAllowed: boolean): void;
1495
	$getAvailableShells(): Promise<IShellDefinitionDto[]>;
1496
	$getDefaultShellAndArgs(useAutomationShell: boolean): Promise<IShellAndArgsDto>;
1497
	$provideLinks(id: number, line: string): Promise<ITerminalLinkDto[]>;
D
Daniel Imms 已提交
1498
	$activateLink(id: number, linkId: number): void;
1499
	$initEnvironmentVariableCollections(collections: [string, ISerializableEnvironmentVariableCollection][]): void;
1500 1501
}

1502
export interface ExtHostSCMShape {
M
Matt Bierner 已提交
1503
	$provideOriginalResource(sourceControlHandle: number, uri: UriComponents, token: CancellationToken): Promise<UriComponents | null>;
A
Alex Dima 已提交
1504
	$onInputBoxValueChange(sourceControlHandle: number, value: string): void;
J
João Moreno 已提交
1505
	$executeResourceCommand(sourceControlHandle: number, groupHandle: number, handle: number, preserveFocus: boolean): Promise<void>;
J
Johannes Rieken 已提交
1506
	$validateInput(sourceControlHandle: number, value: string, cursorPosition: number): Promise<[string, number] | undefined>;
J
João Moreno 已提交
1507
	$setSelectedSourceControl(selectedSourceControlHandle: number | undefined): Promise<void>;
J
Joao Moreno 已提交
1508 1509
}

1510
export interface ExtHostTaskShape {
J
Johannes Rieken 已提交
1511
	$provideTasks(handle: number, validTypes: { [key: string]: boolean; }): Thenable<tasks.TaskSetDTO>;
1512
	$resolveTask(handle: number, taskDTO: tasks.TaskDTO): Thenable<tasks.TaskDTO | undefined>;
1513
	$onDidStartTask(execution: tasks.TaskExecutionDTO, terminalId: number, resolvedDefinition: tasks.TaskDefinitionDTO): void;
J
Johannes Rieken 已提交
1514 1515 1516
	$onDidStartTaskProcess(value: tasks.TaskProcessStartedDTO): void;
	$onDidEndTaskProcess(value: tasks.TaskProcessEndedDTO): void;
	$OnDidEndTask(execution: tasks.TaskExecutionDTO): void;
1517 1518
	$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 已提交
1519
	$jsonTasksSupported(): Thenable<boolean>;
1520
	$findExecutable(command: string, cwd?: string, paths?: string[]): Promise<string | undefined>;
1521 1522
}

1523 1524
export interface IBreakpointDto {
	type: string;
1525
	id?: string;
1526 1527 1528
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
1529 1530 1531 1532 1533
	logMessage?: string;
}

export interface IFunctionBreakpointDto extends IBreakpointDto {
	type: 'function';
1534
	functionName: string;
1535 1536
}

I
isidor 已提交
1537 1538 1539 1540 1541
export interface IDataBreakpointDto extends IBreakpointDto {
	type: 'data';
	dataId: string;
	canPersist: boolean;
	label: string;
1542
	accessTypes?: DebugProtocol.DataBreakpointAccessType[];
I
isidor 已提交
1543 1544
}

1545
export interface ISourceBreakpointDto extends IBreakpointDto {
1546
	type: 'source';
1547
	uri: UriComponents;
1548 1549
	line: number;
	character: number;
1550 1551
}

1552
export interface IBreakpointsDeltaDto {
I
isidor 已提交
1553
	added?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1554
	removed?: string[];
I
isidor 已提交
1555
	changed?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1556 1557
}

1558 1559 1560 1561
export interface ISourceMultiBreakpointDto {
	type: 'sourceMulti';
	uri: UriComponents;
	lines: {
1562
		id: string;
1563 1564 1565
		enabled: boolean;
		condition?: string;
		hitCondition?: string;
1566
		logMessage?: string;
1567 1568 1569
		line: number;
		character: number;
	}[];
1570 1571
}

A
Andre Weinand 已提交
1572
export interface IDebugSessionFullDto {
1573 1574 1575
	id: DebugSessionUUID;
	type: string;
	name: string;
1576
	folderUri: UriComponents | undefined;
A
Andre Weinand 已提交
1577
	configuration: IConfig;
1578 1579
}

A
Andre Weinand 已提交
1580 1581
export type IDebugSessionDto = IDebugSessionFullDto | DebugSessionUUID;

1582
export interface ExtHostDebugServiceShape {
J
Johannes Rieken 已提交
1583
	$substituteVariables(folder: UriComponents | undefined, config: IConfig): Promise<IConfig>;
1584
	$runInTerminal(args: DebugProtocol.RunInTerminalRequestArguments): Promise<number | undefined>;
J
Johannes Rieken 已提交
1585 1586
	$startDASession(handle: number, session: IDebugSessionDto): Promise<void>;
	$stopDASession(handle: number): Promise<void>;
1587
	$sendDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
1588
	$resolveDebugConfiguration(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1589
	$resolveDebugConfigurationWithSubstitutedVariables(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1590
	$provideDebugConfigurations(handle: number, folder: UriComponents | undefined, token: CancellationToken): Promise<IConfig[]>;
J
Johannes Rieken 已提交
1591 1592
	$legacyDebugAdapterExecutable(handle: number, folderUri: UriComponents | undefined): Promise<IAdapterDescriptor>; // TODO@AW legacy
	$provideDebugAdapter(handle: number, session: IDebugSessionDto): Promise<IAdapterDescriptor>;
1593 1594
	$acceptDebugSessionStarted(session: IDebugSessionDto): void;
	$acceptDebugSessionTerminated(session: IDebugSessionDto): void;
1595
	$acceptDebugSessionActiveChanged(session: IDebugSessionDto | undefined): void;
1596 1597
	$acceptDebugSessionCustomEvent(session: IDebugSessionDto, event: any): void;
	$acceptBreakpointsDelta(delta: IBreakpointsDeltaDto): void;
1598
	$acceptDebugSessionNameChanged(session: IDebugSessionDto, name: string): void;
1599 1600
}

1601

1602 1603 1604 1605 1606
export interface DecorationRequest {
	readonly id: number;
	readonly uri: UriComponents;
}

1607
export type DecorationData = [number, boolean, string, string, ThemeColor];
1608
export type DecorationReply = { [id: number]: DecorationData; };
1609 1610

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

1614 1615
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
1616 1617
}

S
Sandeep Somavarapu 已提交
1618
export interface ExtHostLogServiceShape {
A
Alex Dima 已提交
1619
	$setLevel(level: LogLevel): void;
S
Sandeep Somavarapu 已提交
1620 1621
}

J
Johannes Rieken 已提交
1622 1623 1624 1625
export interface MainThreadLogShape {
	$log(file: UriComponents, level: LogLevel, args: any[]): void;
}

1626 1627 1628 1629
export interface ExtHostOutputServiceShape {
	$setVisibleChannel(channelId: string | null): void;
}

1630 1631 1632 1633
export interface ExtHostProgressShape {
	$acceptProgressCanceled(handle: number): void;
}

M
Matt Bierner 已提交
1634
export interface ExtHostCommentsShape {
P
Peng Lyu 已提交
1635
	$createCommentThreadTemplate(commentControllerHandle: number, uriComponents: UriComponents, range: IRange): void;
1636
	$updateCommentThreadTemplate(commentControllerHandle: number, threadHandle: number, range: IRange): Promise<void>;
1637
	$deleteCommentThread(commentControllerHandle: number, commentThreadHandle: number): void;
P
Peng Lyu 已提交
1638
	$provideCommentingRanges(commentControllerHandle: number, uriComponents: UriComponents, token: CancellationToken): Promise<IRange[] | undefined>;
P
Peng Lyu 已提交
1639
	$toggleReaction(commentControllerHandle: number, threadHandle: number, uri: UriComponents, comment: modes.Comment, reaction: modes.CommentReaction): Promise<void>;
M
Matt Bierner 已提交
1640 1641
}

R
rebornix 已提交
1642 1643 1644 1645 1646
export interface INotebookSelectionChangeEvent {
	// handles
	selections: number[];
}

1647 1648 1649 1650 1651 1652 1653 1654 1655
export interface INotebookCellVisibleRange {
	start: number;
	end: number;
}

export interface INotebookVisibleRangesEvent {
	ranges: INotebookCellVisibleRange[];
}

R
rebornix 已提交
1656
export interface INotebookEditorPropertiesChangeData {
1657
	visibleRanges: INotebookVisibleRangesEvent | null;
1658
	selections: INotebookSelectionChangeEvent | null;
1659 1660 1661
}

export interface INotebookDocumentPropertiesChangeData {
R
rebornix 已提交
1662
	metadata: NotebookDocumentMetadata | null;
R
rebornix 已提交
1663 1664
}

R
rebornix 已提交
1665 1666
export interface INotebookModelAddedData {
	uri: UriComponents;
R
rebornix 已提交
1667 1668
	versionId: number;
	cells: IMainCellDto[],
R
rebornix 已提交
1669
	viewType: string;
R
rebornix 已提交
1670
	metadata?: NotebookDocumentMetadata;
1671
	attachedEditor?: { id: string; selections: number[]; visibleRanges: ICellRange[] }
R
rebornix 已提交
1672
	contentOptions: { transientOutputs: boolean; transientMetadata: TransientMetadata; }
R
rebornix 已提交
1673 1674
}

R
rebornix 已提交
1675 1676 1677 1678
export interface INotebookEditorAddData {
	id: string;
	documentUri: UriComponents;
	selections: number[];
1679
	visibleRanges: ICellRange[];
R
rebornix 已提交
1680 1681 1682 1683 1684
}

export interface INotebookDocumentsAndEditorsDelta {
	removedDocuments?: UriComponents[];
	addedDocuments?: INotebookModelAddedData[];
R
rebornix 已提交
1685 1686 1687
	removedEditors?: string[];
	addedEditors?: INotebookEditorAddData[];
	newActiveEditor?: string | null;
R
rebornix 已提交
1688
	visibleEditors?: string[];
R
rebornix 已提交
1689 1690
}

R
rebornix 已提交
1691
export interface ExtHostNotebookShape {
1692
	$resolveNotebookData(viewType: string, uri: UriComponents, backupId?: string): Promise<NotebookDataDto>;
1693
	$resolveNotebookEditor(viewType: string, uri: UriComponents, editorId: string): Promise<void>;
R
rebornix 已提交
1694 1695
	$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 已提交
1696
	$executeNotebookKernelFromProvider(handle: number, uri: UriComponents, kernelId: string, cellHandle: number | undefined): Promise<void>;
1697
	$cancelNotebookKernelFromProvider(handle: number, uri: UriComponents, kernelId: string, cellHandle: number | undefined): Promise<void>;
R
Rob Lourens 已提交
1698
	$executeNotebook2(kernelId: string, viewType: string, uri: UriComponents, cellHandle: number | undefined): Promise<void>;
R
rebornix 已提交
1699
	$saveNotebook(viewType: string, uri: UriComponents, token: CancellationToken): Promise<boolean>;
R
saveAs  
rebornix 已提交
1700
	$saveNotebookAs(viewType: string, uri: UriComponents, target: UriComponents, token: CancellationToken): Promise<boolean>;
1701
	$backup(viewType: string, uri: UriComponents, cancellation: CancellationToken): Promise<string | undefined>;
R
rebornix 已提交
1702
	$acceptDisplayOrder(displayOrder: INotebookDisplayOrder): void;
R
rebornix 已提交
1703
	$acceptNotebookActiveKernelChange(event: { uri: UriComponents, providerHandle: number | undefined, kernelId: string | undefined }): void;
1704
	$onDidReceiveMessage(editorId: string, rendererId: string | undefined, message: unknown): void;
R
rebornix 已提交
1705
	$acceptModelChanged(uriComponents: UriComponents, event: NotebookCellsChangedEventDto, isDirty: boolean): void;
1706
	$acceptModelSaved(uriComponents: UriComponents): void;
1707 1708
	$acceptEditorPropertiesChanged(id: string, data: INotebookEditorPropertiesChangeData): void;
	$acceptDocumentPropertiesChanged(uriComponents: UriComponents, data: INotebookDocumentPropertiesChangeData): void;
J
Johannes Rieken 已提交
1709
	$acceptDocumentAndEditorsDelta(delta: INotebookDocumentsAndEditorsDelta): void;
1710 1711 1712
	$undoNotebook(viewType: string, uri: UriComponents, editId: number, isDirty: boolean): Promise<void>;
	$redoNotebook(viewType: string, uri: UriComponents, editId: number, isDirty: boolean): Promise<void>;

R
rebornix 已提交
1713 1714
}

1715
export interface ExtHostStorageShape {
1716
	$acceptValue(shared: boolean, key: string, value: object | undefined): void;
1717 1718
}

M
Martin Aeschlimann 已提交
1719 1720 1721 1722 1723 1724
export interface ExtHostThemingShape {
	$onColorThemeChange(themeType: string): void;
}

export interface MainThreadThemingShape extends IDisposable {
}
1725 1726

export interface ExtHostTunnelServiceShape {
1727
	$findCandidatePorts(): Promise<{ host: string, port: number, detail: string }[]>;
1728
	$filterCandidates(candidates: { host: string, port: number, detail: string }[]): Promise<boolean[]>;
1729 1730
	$forwardPort(tunnelOptions: TunnelOptions): Promise<TunnelDto> | undefined;
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
A
Alex Ross 已提交
1731
	$onDidTunnelsChange(): Promise<void>;
1732 1733
}

1734
export interface ExtHostTimelineShape {
1735
	$getTimeline(source: string, uri: UriComponents, options: TimelineOptions, token: CancellationToken, internalOptions?: InternalTimelineOptions): Promise<Timeline | undefined>;
1736 1737
}

1738 1739 1740
// --- proxy identifiers

export const MainContext = {
1741
	MainThreadAuthentication: createMainId<MainThreadAuthenticationShape>('MainThreadAuthentication'),
1742
	MainThreadBulkEdits: createMainId<MainThreadBulkEditsShape>('MainThreadBulkEdits'),
1743 1744
	MainThreadClipboard: createMainId<MainThreadClipboardShape>('MainThreadClipboard'),
	MainThreadCommands: createMainId<MainThreadCommandsShape>('MainThreadCommands'),
M
Matt Bierner 已提交
1745
	MainThreadComments: createMainId<MainThreadCommentsShape>('MainThreadComments'),
1746
	MainThreadConfiguration: createMainId<MainThreadConfigurationShape>('MainThreadConfiguration'),
1747
	MainThreadConsole: createMainId<MainThreadConsoleShape>('MainThreadConsole'),
1748
	MainThreadDebugService: createMainId<MainThreadDebugServiceShape>('MainThreadDebugService'),
1749 1750 1751 1752
	MainThreadDecorations: createMainId<MainThreadDecorationsShape>('MainThreadDecorations'),
	MainThreadDiagnostics: createMainId<MainThreadDiagnosticsShape>('MainThreadDiagnostics'),
	MainThreadDialogs: createMainId<MainThreadDiaglogsShape>('MainThreadDiaglogs'),
	MainThreadDocuments: createMainId<MainThreadDocumentsShape>('MainThreadDocuments'),
1753
	MainThreadDocumentContentProviders: createMainId<MainThreadDocumentContentProvidersShape>('MainThreadDocumentContentProviders'),
1754
	MainThreadTextEditors: createMainId<MainThreadTextEditorsShape>('MainThreadTextEditors'),
1755
	MainThreadEditorInsets: createMainId<MainThreadEditorInsetsShape>('MainThreadEditorInsets'),
1756 1757
	MainThreadErrors: createMainId<MainThreadErrorsShape>('MainThreadErrors'),
	MainThreadTreeViews: createMainId<MainThreadTreeViewsShape>('MainThreadTreeViews'),
1758
	MainThreadDownloadService: createMainId<MainThreadDownloadServiceShape>('MainThreadDownloadService'),
A
Alex Dima 已提交
1759
	MainThreadKeytar: createMainId<MainThreadKeytarShape>('MainThreadKeytar'),
1760
	MainThreadLanguageFeatures: createMainId<MainThreadLanguageFeaturesShape>('MainThreadLanguageFeatures'),
1761
	MainThreadLanguages: createMainId<MainThreadLanguagesShape>('MainThreadLanguages'),
J
Johannes Rieken 已提交
1762
	MainThreadLog: createMainId<MainThreadLogShape>('MainThread'),
1763
	MainThreadMessageService: createMainId<MainThreadMessageServiceShape>('MainThreadMessageService'),
1764 1765
	MainThreadOutputService: createMainId<MainThreadOutputServiceShape>('MainThreadOutputService'),
	MainThreadProgress: createMainId<MainThreadProgressShape>('MainThreadProgress'),
1766
	MainThreadQuickOpen: createMainId<MainThreadQuickOpenShape>('MainThreadQuickOpen'),
1767
	MainThreadStatusBar: createMainId<MainThreadStatusBarShape>('MainThreadStatusBar'),
1768
	MainThreadStorage: createMainId<MainThreadStorageShape>('MainThreadStorage'),
1769
	MainThreadTelemetry: createMainId<MainThreadTelemetryShape>('MainThreadTelemetry'),
1770
	MainThreadTerminalService: createMainId<MainThreadTerminalServiceShape>('MainThreadTerminalService'),
M
Matt Bierner 已提交
1771
	MainThreadWebviews: createMainId<MainThreadWebviewsShape>('MainThreadWebviews'),
1772
	MainThreadWebviewPanels: createMainId<MainThreadWebviewPanelsShape>('MainThreadWebviewPanels'),
1773 1774
	MainThreadWebviewViews: createMainId<MainThreadWebviewViewsShape>('MainThreadWebviewViews'),
	MainThreadCustomEditors: createMainId<MainThreadCustomEditorsShape>('MainThreadCustomEditors'),
J
Joao Moreno 已提交
1775
	MainThreadUrls: createMainId<MainThreadUrlsShape>('MainThreadUrls'),
1776
	MainThreadWorkspace: createMainId<MainThreadWorkspaceShape>('MainThreadWorkspace'),
1777
	MainThreadFileSystem: createMainId<MainThreadFileSystemShape>('MainThreadFileSystem'),
1778
	MainThreadExtensionService: createMainId<MainThreadExtensionServiceShape>('MainThreadExtensionService'),
J
Joao Moreno 已提交
1779
	MainThreadSCM: createMainId<MainThreadSCMShape>('MainThreadSCM'),
1780
	MainThreadSearch: createMainId<MainThreadSearchShape>('MainThreadSearch'),
1781
	MainThreadTask: createMainId<MainThreadTaskShape>('MainThreadTask'),
1782
	MainThreadWindow: createMainId<MainThreadWindowShape>('MainThreadWindow'),
M
Martin Aeschlimann 已提交
1783
	MainThreadLabelService: createMainId<MainThreadLabelServiceShape>('MainThreadLabelService'),
1784
	MainThreadNotebook: createMainId<MainThreadNotebookShape>('MainThreadNotebook'),
1785
	MainThreadTheming: createMainId<MainThreadThemingShape>('MainThreadTheming'),
1786 1787
	MainThreadTunnelService: createMainId<MainThreadTunnelServiceShape>('MainThreadTunnelService'),
	MainThreadTimeline: createMainId<MainThreadTimelineShape>('MainThreadTimeline')
1788 1789 1790
};

export const ExtHostContext = {
1791
	ExtHostCommands: createExtId<ExtHostCommandsShape>('ExtHostCommands'),
1792
	ExtHostConfiguration: createExtId<ExtHostConfigurationShape>('ExtHostConfiguration'),
1793
	ExtHostDiagnostics: createExtId<ExtHostDiagnosticsShape>('ExtHostDiagnostics'),
1794
	ExtHostDebugService: createExtId<ExtHostDebugServiceShape>('ExtHostDebugService'),
J
Johannes Rieken 已提交
1795
	ExtHostDecorations: createExtId<ExtHostDecorationsShape>('ExtHostDecorations'),
1796
	ExtHostDocumentsAndEditors: createExtId<ExtHostDocumentsAndEditorsShape>('ExtHostDocumentsAndEditors'),
1797
	ExtHostDocuments: createExtId<ExtHostDocumentsShape>('ExtHostDocuments'),
J
Johannes Rieken 已提交
1798
	ExtHostDocumentContentProviders: createExtId<ExtHostDocumentContentProvidersShape>('ExtHostDocumentContentProviders'),
J
Johannes Rieken 已提交
1799
	ExtHostDocumentSaveParticipant: createExtId<ExtHostDocumentSaveParticipantShape>('ExtHostDocumentSaveParticipant'),
J
Johannes Rieken 已提交
1800
	ExtHostEditors: createExtId<ExtHostEditorsShape>('ExtHostEditors'),
1801
	ExtHostTreeViews: createExtId<ExtHostTreeViewsShape>('ExtHostTreeViews'),
J
Johannes Rieken 已提交
1802
	ExtHostFileSystem: createExtId<ExtHostFileSystemShape>('ExtHostFileSystem'),
1803
	ExtHostFileSystemInfo: createExtId<ExtHostFileSystemInfoShape>('ExtHostFileSystemInfo'),
J
Johannes Rieken 已提交
1804
	ExtHostFileSystemEventService: createExtId<ExtHostFileSystemEventServiceShape>('ExtHostFileSystemEventService'),
1805
	ExtHostLanguageFeatures: createExtId<ExtHostLanguageFeaturesShape>('ExtHostLanguageFeatures'),
1806 1807
	ExtHostQuickOpen: createExtId<ExtHostQuickOpenShape>('ExtHostQuickOpen'),
	ExtHostExtensionService: createExtId<ExtHostExtensionServiceShape>('ExtHostExtensionService'),
1808
	ExtHostLogService: createExtId<ExtHostLogServiceShape>('ExtHostLogService'),
1809
	ExtHostTerminalService: createExtId<ExtHostTerminalServiceShape>('ExtHostTerminalService'),
J
Joao Moreno 已提交
1810
	ExtHostSCM: createExtId<ExtHostSCMShape>('ExtHostSCM'),
1811
	ExtHostSearch: createExtId<ExtHostSearchShape>('ExtHostSearch'),
1812
	ExtHostTask: createExtId<ExtHostTaskShape>('ExtHostTask'),
1813
	ExtHostWorkspace: createExtId<ExtHostWorkspaceShape>('ExtHostWorkspace'),
1814
	ExtHostWindow: createExtId<ExtHostWindowShape>('ExtHostWindow'),
1815
	ExtHostWebviews: createExtId<ExtHostWebviewsShape>('ExtHostWebviews'),
1816
	ExtHostWebviewPanels: createExtId<ExtHostWebviewPanelsShape>('ExtHostWebviewPanels'),
1817
	ExtHostCustomEditors: createExtId<ExtHostCustomEditorsShape>('ExtHostCustomEditors'),
1818
	ExtHostWebviewViews: createExtId<ExtHostWebviewViewsShape>('ExtHostWebviewViews'),
1819
	ExtHostEditorInsets: createExtId<ExtHostEditorInsetsShape>('ExtHostEditorInsets'),
M
Matt Bierner 已提交
1820
	ExtHostProgress: createMainId<ExtHostProgressShape>('ExtHostProgress'),
1821
	ExtHostComments: createMainId<ExtHostCommentsShape>('ExtHostComments'),
1822
	ExtHostStorage: createMainId<ExtHostStorageShape>('ExtHostStorage'),
1823 1824
	ExtHostUrls: createExtId<ExtHostUrlsShape>('ExtHostUrls'),
	ExtHostOutputService: createMainId<ExtHostOutputServiceShape>('ExtHostOutputService'),
R
rebornix 已提交
1825
	ExtHosLabelService: createMainId<ExtHostLabelServiceShape>('ExtHostLabelService'),
1826
	ExtHostNotebook: createMainId<ExtHostNotebookShape>('ExtHostNotebook'),
1827
	ExtHostTheming: createMainId<ExtHostThemingShape>('ExtHostTheming'),
1828
	ExtHostTunnelService: createMainId<ExtHostTunnelServiceShape>('ExtHostTunnelService'),
1829 1830
	ExtHostAuthentication: createMainId<ExtHostAuthenticationShape>('ExtHostAuthentication'),
	ExtHostTimeline: createMainId<ExtHostTimelineShape>('ExtHostTimeline')
1831
};