“1738c3e6d0d7958a4f31bd5386983abd2cd2d870”上不存在“src/vs/workbench/api/common/extHost.protocol.ts”
extHost.protocol.ts 81.5 KB
Newer Older
1 2 3 4 5
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

6
import { VSBuffer } from 'vs/base/common/buffer';
A
Alex Dima 已提交
7
import { CancellationToken } from 'vs/base/common/cancellation';
8
import { IRemoteConsoleLog } from 'vs/base/common/console';
R
Rob Lourens 已提交
9
import { SerializedError } from 'vs/base/common/errors';
10 11
import { IRelativePattern } from 'vs/base/common/glob';
import { IMarkdownString } from 'vs/base/common/htmlContent';
R
Rob Lourens 已提交
12
import { IDisposable } from 'vs/base/common/lifecycle';
13
import Severity from 'vs/base/common/severity';
14
import { URI, UriComponents } from 'vs/base/common/uri';
15
import { RenderLineNumbersType, TextEditorCursorStyle } from 'vs/editor/common/config/editorOptions';
16 17
import { IPosition } from 'vs/editor/common/core/position';
import { IRange } from 'vs/editor/common/core/range';
18
import { ISelection, Selection } from 'vs/editor/common/core/selection';
R
Rob Lourens 已提交
19
import * as editorCommon from 'vs/editor/common/editorCommon';
20
import { EndOfLineSequence, ISingleEditOperation } from 'vs/editor/common/model';
R
Rob Lourens 已提交
21 22 23
import { IModelChangedEvent } from 'vs/editor/common/model/mirrorTextModel';
import * as modes from 'vs/editor/common/modes';
import { CharacterPair, CommentRule, EnterAction } from 'vs/editor/common/modes/languageConfiguration';
24
import { ICommandHandlerDescription } from 'vs/platform/commands/common/commands';
25
import { ConfigurationTarget, IConfigurationData, IConfigurationChange, IConfigurationOverrides } from 'vs/platform/configuration/common/configuration';
R
Rob Lourens 已提交
26
import { ConfigurationScope } from 'vs/platform/configuration/common/configurationRegistry';
27
import { ExtensionIdentifier, IExtensionDescription } from 'vs/platform/extensions/common/extensions';
J
Johannes Rieken 已提交
28
import * as files from 'vs/platform/files/common/files';
29
import { ResourceLabelFormatter } from 'vs/platform/label/common/label';
S
Sandeep Somavarapu 已提交
30
import { LogLevel } from 'vs/platform/log/common/log';
R
Rob Lourens 已提交
31
import { IMarkerData } from 'vs/platform/markers/common/markers';
32
import { IProgressOptions, IProgressStep } from 'vs/platform/progress/common/progress';
J
Johannes Rieken 已提交
33
import * as quickInput from 'vs/platform/quickinput/common/quickInput';
34
import { RemoteAuthorityResolverErrorCode, ResolverResult, TunnelDescription, 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, NotebookCellsChangedEvent, NotebookDataDto, IMainCellDto, INotebookDocumentFilter, INotebookKernelInfoDto2, TransientMetadata, INotebookCellStatusBarEntry, ICellRange } 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
export interface MainThreadTextEditorsShape extends IDisposable {
267
	$tryShowTextDocument(resource: UriComponents, options: ITextDocumentShowOptions): Promise<string | undefined>;
268 269
	$registerTextEditorDecorationType(key: string, options: editorCommon.IDecorationRenderOptions): void;
	$removeTextEditorDecorationType(key: string): void;
J
Johannes Rieken 已提交
270 271 272 273 274 275 276 277
	$tryShowEditor(id: string, position: EditorViewColumn): Promise<void>;
	$tryHideEditor(id: string): Promise<void>;
	$trySetOptions(id: string, options: ITextEditorConfigurationUpdate): Promise<void>;
	$trySetDecorations(id: string, key: string, ranges: editorCommon.IDecorationOptions[]): Promise<void>;
	$trySetDecorationsFast(id: string, key: string, ranges: number[]): Promise<void>;
	$tryRevealRange(id: string, range: IRange, revealType: TextEditorRevealType): Promise<void>;
	$trySetSelections(id: string, selections: ISelection[]): Promise<void>;
	$tryApplyEdits(id: string, modelVersionId: number, edits: ISingleEditOperation[], opts: IApplyEditsOptions): Promise<boolean>;
J
Johannes Rieken 已提交
278
	$tryApplyWorkspaceEdit(workspaceEditDto: IWorkspaceEditDto): Promise<boolean>;
M
Matt Bierner 已提交
279
	$tryInsertSnippet(id: string, template: string, selections: readonly IRange[], opts: IUndoStopOptions): Promise<boolean>;
J
Johannes Rieken 已提交
280
	$getDiffInformation(id: string): Promise<editorCommon.ILineChange[]>;
281 282
}

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

291 292 293 294
export interface MainThreadDownloadServiceShape extends IDisposable {
	$download(uri: UriComponents, to: UriComponents): Promise<void>;
}

295
export interface MainThreadErrorsShape extends IDisposable {
296
	$onUnexpectedError(err: any | SerializedError): void;
297 298
}

299
export interface MainThreadConsoleShape extends IDisposable {
300
	$logExtensionHostMessage(msg: IRemoteConsoleLog): void;
301 302
}

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

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

351
export type GlobPattern = string | { base: string; pattern: string; };
352

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

J
Johannes Rieken 已提交
361
export interface ISignatureHelpProviderMetadataDto {
362 363
	readonly triggerCharacters: readonly string[];
	readonly retriggerCharacters: readonly string[];
364 365
}

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

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

405
export interface MainThreadMessageOptions {
406
	extension?: IExtensionDescription;
407
	modal?: boolean;
408 409
}

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

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

424
export interface MainThreadProgressShape extends IDisposable {
425

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

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

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

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

J
Johannes Rieken 已提交
467
export interface TransferQuickPickItems extends quickInput.IQuickPickItem {
468 469
	handle: number;
}
C
Christof Marti 已提交
470

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

export type TransferQuickInput = TransferQuickPick | TransferInputBox;

export interface BaseTransferQuickInput {

481 482
	[key: string]: any;

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

C
Christof Marti 已提交
504
	items?: TransferQuickPickItems[];
505

506 507 508 509
	activeItems?: number[];

	selectedItems?: number[];

510 511 512 513 514 515 516
	canSelectMany?: boolean;

	ignoreFocusOut?: boolean;

	matchOnDescription?: boolean;

	matchOnDetail?: boolean;
517 518

	sortByLabel?: boolean;
519 520 521 522 523 524 525 526 527 528 529 530
}

export interface TransferInputBox extends BaseTransferQuickInput {

	type?: 'inputBox';

	value?: string;

	placeholder?: string;

	password?: boolean;

C
Christof Marti 已提交
531
	buttons?: TransferQuickInputButton[];
532 533 534 535 536 537

	prompt?: string;

	validationMessage?: string;
}

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

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

556
export interface MainThreadStatusBarShape extends IDisposable {
557
	$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;
558
	$dispose(id: number): void;
559 560
}

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

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

571
export interface MainThreadEditorInsetsShape extends IDisposable {
572
	$createEditorInset(handle: number, id: string, uri: UriComponents, line: number, height: number, options: modes.IWebviewOptions, extensionId: ExtensionIdentifier, extensionLocation: UriComponents): Promise<void>;
573 574 575 576 577 578
	$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 已提交
579

580 581 582 583 584
export interface ExtHostEditorInsetsShape {
	$onDidDispose(handle: number): void;
	$onDidReceiveMessage(handle: number, message: any): void;
}

585
export type WebviewHandle = string;
586

M
Matt Bierner 已提交
587 588 589 590 591
export interface WebviewPanelShowOptions {
	readonly viewColumn?: EditorViewColumn;
	readonly preserveFocus?: boolean;
}

592 593 594 595 596
export interface WebviewExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
}

R
rebornix 已提交
597 598 599
export interface NotebookExtensionDescription {
	readonly id: ExtensionIdentifier;
	readonly location: UriComponents;
R
rebornix 已提交
600
	readonly description?: string;
R
rebornix 已提交
601 602
}

603
export enum WebviewEditorCapabilities {
M
Matt Bierner 已提交
604
	Editable,
605
	SupportsHotExit,
606 607
}

608 609 610 611
export interface CustomTextEditorCapabilities {
	readonly supportsMove?: boolean;
}

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

618
export interface MainThreadWebviewPanelsShape extends IDisposable {
619 620 621 622 623
	$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;
624 625 626

	$registerSerializer(viewType: string): void;
	$unregisterSerializer(viewType: string): void;
627
}
628

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

634
	$onDidEdit(resource: UriComponents, viewType: string, editId: number, label: string | undefined): void;
635
	$onContentChange(resource: UriComponents, viewType: string): void;
636
}
637

638
export interface MainThreadWebviewViewsShape extends IDisposable {
639
	$registerWebviewViewProvider(viewType: string, options?: { retainContextWhenHidden?: boolean }): void;
640
	$unregisterWebviewViewProvider(viewType: string): void;
641

642
	$setWebviewViewTitle(handle: WebviewHandle, value: string | undefined): void;
M
Matt Bierner 已提交
643
}
644

645 646 647 648 649 650
export interface WebviewPanelViewStateData {
	[handle: string]: {
		readonly active: boolean;
		readonly visible: boolean;
		readonly position: EditorViewColumn;
	};
M
Matt Bierner 已提交
651 652
}

M
Matt Bierner 已提交
653
export interface ExtHostWebviewsShape {
654 655
	$onMessage(handle: WebviewHandle, message: any): void;
	$onMissingCsp(handle: WebviewHandle, extensionId: string): void;
656
}
657

658
export interface ExtHostWebviewPanelsShape {
659
	$onDidChangeWebviewPanelViewStates(newState: WebviewPanelViewStateData): void;
660 661
	$onDidDisposeWebviewPanel(handle: WebviewHandle): Promise<void>;
	$deserializeWebviewPanel(newWebviewHandle: WebviewHandle, viewType: string, title: string, state: any, position: EditorViewColumn, options: modes.IWebviewOptions & modes.IWebviewPanelOptions): Promise<void>;
662
}
663

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

M
Matt Bierner 已提交
669 670 671
	$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>;
672 673
	$disposeEdits(resourceComponents: UriComponents, viewType: string, editIds: number[]): void;

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

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

679
	$onMoveCustomEditor(handle: WebviewHandle, newResource: UriComponents, viewType: string): Promise<void>;
680
}
681

682
export interface ExtHostWebviewViewsShape {
683
	$resolveWebviewView(webviewHandle: WebviewHandle, viewType: string, state: any, cancellation: CancellationToken): Promise<void>;
684

685
	$onDidChangeWebviewViewVisibility(webviewHandle: WebviewHandle, visible: boolean): void;
686

687
	$disposeWebviewView(webviewHandle: WebviewHandle): void;
M
Matt Bierner 已提交
688 689
}

R
rebornix 已提交
690 691 692 693 694 695 696 697 698 699 700
export enum CellKind {
	Markdown = 1,
	Code = 2
}

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

701 702
export interface ICellDto {
	handle: number;
703
	uri: UriComponents,
704 705
	source: string[];
	language: string;
R
rebornix 已提交
706
	cellKind: CellKind;
707
	outputs: IProcessedOutput[];
708
	metadata?: NotebookCellMetadata;
709 710
}

711 712 713 714 715 716 717 718 719
export type NotebookCellsSplice = [
	number /* start */,
	number /* delete count */,
	ICellDto[]
];

export type NotebookCellOutputsSplice = [
	number /* start */,
	number /* delete count */,
720
	IProcessedOutput[]
721 722
];

723 724
export type INotebookCellStatusBarEntryDto = Dto<INotebookCellStatusBarEntry>;

R
rebornix 已提交
725
export interface MainThreadNotebookShape extends IDisposable {
726
	$registerNotebookProvider(extension: NotebookExtensionDescription, viewType: string, supportBackup: boolean, options: { transientOutputs: boolean; transientMetadata: TransientMetadata }): Promise<void>;
727
	$onNotebookChange(viewType: string, resource: UriComponents): Promise<void>;
R
rebornix 已提交
728
	$unregisterNotebookProvider(viewType: string): Promise<void>;
R
rebornix 已提交
729
	$registerNotebookKernel(extension: NotebookExtensionDescription, id: string, label: string, selectors: (string | IRelativePattern)[], preloads: UriComponents[]): Promise<void>;
R
rebornix 已提交
730 731 732
	$registerNotebookKernelProvider(extension: NotebookExtensionDescription, handle: number, documentFilter: INotebookDocumentFilter): Promise<void>;
	$unregisterNotebookKernelProvider(handle: number): Promise<void>;
	$onNotebookKernelChange(handle: number): void;
R
rebornix 已提交
733
	$unregisterNotebookKernel(id: string): Promise<void>;
734
	$tryApplyEdits(viewType: string, resource: UriComponents, modelVersionId: number, edits: ICellEditOperation[]): Promise<boolean>;
R
rebornix 已提交
735
	$updateNotebookLanguages(viewType: string, resource: UriComponents, languages: string[]): Promise<void>;
R
rebornix 已提交
736
	$updateNotebookMetadata(viewType: string, resource: UriComponents, metadata: NotebookDocumentMetadata): Promise<void>;
737
	$updateNotebookCellMetadata(viewType: string, resource: UriComponents, handle: number, metadata: NotebookCellMetadata | undefined): Promise<void>;
738
	$spliceNotebookCellOutputs(viewType: string, resource: UriComponents, cellHandle: number, splices: NotebookCellOutputsSplice[]): Promise<void>;
739
	$postMessage(editorId: string, forRendererId: string | undefined, value: any): Promise<boolean>;
740
	$setStatusBarEntry(id: number, statusBarEntry: INotebookCellStatusBarEntryDto): Promise<void>;
741 742 743

	$onDidEdit(resource: UriComponents, viewType: string, editId: number, label: string | undefined): void;
	$onContentChange(resource: UriComponents, viewType: string): void;
M
Matt Bierner 已提交
744 745
}

J
Joao Moreno 已提交
746
export interface MainThreadUrlsShape extends IDisposable {
747
	$registerUriHandler(handle: number, extensionId: ExtensionIdentifier): Promise<void>;
J
Johannes Rieken 已提交
748
	$unregisterUriHandler(handle: number): Promise<void>;
749
	$createAppUri(uri: UriComponents): Promise<UriComponents>;
J
Joao Moreno 已提交
750 751 752
}

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

756 757 758 759
export interface ITextSearchComplete {
	limitHit?: boolean;
}

760
export interface MainThreadWorkspaceShape extends IDisposable {
761
	$startFileSearch(includePattern: string | null, includeFolder: UriComponents | null, excludePatternOrDisregardExcludes: string | false | null, maxResults: number | null, token: CancellationToken): Promise<UriComponents[] | null>;
762
	$startTextSearch(query: search.IPatternInfo, folder: UriComponents | null, options: ITextQueryBuilderOptions, requestId: number, token: CancellationToken): Promise<ITextSearchComplete | null>;
763
	$checkExists(folders: readonly UriComponents[], includes: string[], token: CancellationToken): Promise<boolean>;
J
Johannes Rieken 已提交
764
	$saveAll(includeUntitled?: boolean): Promise<boolean>;
765
	$updateWorkspaceFolders(extensionName: string, index: number, deleteCount: number, workspaceFoldersToAdd: { uri: UriComponents, name?: string; }[]): Promise<void>;
766
	$resolveProxy(url: string): Promise<string | undefined>;
767
}
768

J
Johannes Rieken 已提交
769 770
export interface IFileChangeDto {
	resource: UriComponents;
J
Johannes Rieken 已提交
771
	type: files.FileChangeType;
J
Johannes Rieken 已提交
772 773
}

774
export interface MainThreadFileSystemShape extends IDisposable {
J
Johannes Rieken 已提交
775
	$registerFileSystemProvider(handle: number, scheme: string, capabilities: files.FileSystemProviderCapabilities): void;
776
	$unregisterProvider(handle: number): void;
J
Johannes Rieken 已提交
777
	$onFileSystemChange(handle: number, resource: IFileChangeDto[]): void;
778 779 780 781

	$stat(uri: UriComponents): Promise<files.IStat>;
	$readdir(resource: UriComponents): Promise<[string, files.FileType][]>;
	$readFile(resource: UriComponents): Promise<VSBuffer>;
782
	$writeFile(resource: UriComponents, content: VSBuffer): Promise<void>;
783 784 785 786
	$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>;
787
}
J
Johannes Rieken 已提交
788

789 790 791 792 793
export interface MainThreadLabelServiceShape extends IDisposable {
	$registerResourceLabelFormatter(handle: number, formatter: ResourceLabelFormatter): void;
	$unregisterResourceLabelFormatter(handle: number): void;
}

794
export interface MainThreadSearchShape extends IDisposable {
795 796
	$registerFileSearchProvider(handle: number, scheme: string): void;
	$registerTextSearchProvider(handle: number, scheme: string): void;
797
	$unregisterProvider(handle: number): void;
798
	$handleFileMatch(handle: number, session: number, data: UriComponents[]): void;
J
Johannes Rieken 已提交
799
	$handleTextMatch(handle: number, session: number, data: search.IRawFileMatch2[]): void;
800
	$handleTelemetry(eventName: string, data: any): void;
801 802
}

803
export interface MainThreadTaskShape extends IDisposable {
J
Johannes Rieken 已提交
804
	$createTaskId(task: tasks.TaskDTO): Promise<string>;
805
	$registerTaskProvider(handle: number, type: string): Promise<void>;
J
Johannes Rieken 已提交
806
	$unregisterTaskProvider(handle: number): Promise<void>;
J
Johannes Rieken 已提交
807
	$fetchTasks(filter?: tasks.TaskFilterDTO): Promise<tasks.TaskDTO[]>;
808
	$getTaskExecution(value: tasks.TaskHandleDTO | tasks.TaskDTO): Promise<tasks.TaskExecutionDTO>;
J
Johannes Rieken 已提交
809
	$executeTask(task: tasks.TaskHandleDTO | tasks.TaskDTO): Promise<tasks.TaskExecutionDTO>;
J
Johannes Rieken 已提交
810
	$terminateTask(id: string): Promise<void>;
J
Johannes Rieken 已提交
811
	$registerTaskSystem(scheme: string, info: tasks.TaskSystemInfoDTO): void;
G
Gabriel DeBacker 已提交
812
	$customExecutionComplete(id: string, result?: number): Promise<void>;
813
	$registerSupportedExecutions(custom?: boolean, shell?: boolean, process?: boolean): Promise<void>;
814 815
}

816
export interface MainThreadExtensionServiceShape extends IDisposable {
817
	$activateExtension(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<void>;
818
	$onWillActivateExtension(extensionId: ExtensionIdentifier): void;
819
	$onDidActivateExtension(extensionId: ExtensionIdentifier, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number, activationReason: ExtensionActivationReason): void;
820
	$onExtensionActivationError(extensionId: ExtensionIdentifier, error: ExtensionActivationError): Promise<void>;
821
	$onExtensionRuntimeError(extensionId: ExtensionIdentifier, error: SerializedError): void;
822
	$onExtensionHostExit(code: number): Promise<void>;
823 824
}

J
Joao Moreno 已提交
825
export interface SCMProviderFeatures {
J
Joao Moreno 已提交
826 827
	hasQuickDiffProvider?: boolean;
	count?: number;
828 829
	commitTemplate?: string;
	acceptInputCommand?: modes.Command;
J
Johannes Rieken 已提交
830
	statusBarCommands?: ICommandDto[];
J
Joao Moreno 已提交
831 832 833 834
}

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

J
Joao Moreno 已提交
837
export type SCMRawResource = [
838
	number /*handle*/,
839
	UriComponents /*resourceUri*/,
840
	UriComponents[] /*icons: light, dark*/,
841
	string /*tooltip*/,
842
	boolean /*strike through*/,
843 844
	boolean /*faded*/,
	string /*context value*/
J
Joao Moreno 已提交
845
];
846

847 848 849
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
850 851 852
	SCMRawResource[]
];

853 854 855 856 857
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

858
export interface MainThreadSCMShape extends IDisposable {
859
	$registerSourceControl(handle: number, id: string, label: string, rootUri: UriComponents | undefined): void;
860 861
	$updateSourceControl(handle: number, features: SCMProviderFeatures): void;
	$unregisterSourceControl(handle: number): void;
J
Joao Moreno 已提交
862

863
	$registerGroups(sourceControlHandle: number, groups: [number /*handle*/, string /*id*/, string /*label*/, SCMGroupFeatures][], splices: SCMRawResourceSplices[]): void;
864 865 866
	$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 已提交
867

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

J
Joao Moreno 已提交
870
	$setInputBoxValue(sourceControlHandle: number, value: string): void;
871
	$setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
872
	$setInputBoxVisibility(sourceControlHandle: number, visible: boolean): void;
873
	$setValidationProviderIsEnabled(sourceControlHandle: number, enabled: boolean): void;
J
Joao Moreno 已提交
874 875
}

876 877
export type DebugSessionUUID = string;

878 879 880 881 882 883 884
export interface IDebugConfiguration {
	type: string;
	name: string;
	request: string;
	[key: string]: any;
}

885 886 887
export interface IStartDebuggingOptions {
	parentSessionID?: DebugSessionUUID;
	repl?: IDebugSessionReplMode;
I
isidor 已提交
888
	noDebug?: boolean;
889
	compact?: boolean;
890 891
}

892
export interface MainThreadDebugServiceShape extends IDisposable {
A
Alex Dima 已提交
893
	$registerDebugTypes(debugTypes: string[]): void;
894
	$sessionCached(sessionID: string): void;
A
Alex Dima 已提交
895
	$acceptDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
896 897
	$acceptDAError(handle: number, name: string, message: string, stack: string | undefined): void;
	$acceptDAExit(handle: number, code: number | undefined, signal: string | undefined): void;
898
	$registerDebugConfigurationProvider(type: string, triggerKind: DebugConfigurationProviderTriggerKind, hasProvideMethod: boolean, hasResolveMethod: boolean, hasResolve2Method: boolean, hasProvideDaMethod: boolean, handle: number): Promise<void>;
J
Johannes Rieken 已提交
899
	$registerDebugAdapterDescriptorFactory(type: string, handle: number): Promise<void>;
900
	$unregisterDebugConfigurationProvider(handle: number): void;
A
Andre Weinand 已提交
901
	$unregisterDebugAdapterDescriptorFactory(handle: number): void;
I
isidor 已提交
902
	$startDebugging(folder: UriComponents | undefined, nameOrConfig: string | IDebugConfiguration, options: IStartDebuggingOptions): Promise<boolean>;
903
	$stopDebugging(sessionId: DebugSessionUUID | undefined): Promise<void>;
904
	$setDebugSessionName(id: DebugSessionUUID, name: string): void;
J
Johannes Rieken 已提交
905
	$customDebugAdapterRequest(id: DebugSessionUUID, command: string, args: any): Promise<any>;
906
	$getDebugProtocolBreakpoint(id: DebugSessionUUID, breakpoinId: string): Promise<DebugProtocol.Breakpoint | undefined>;
907 908
	$appendDebugConsole(value: string): void;
	$startBreakpointEvents(): void;
I
isidor 已提交
909 910
	$registerBreakpoints(breakpoints: Array<ISourceMultiBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>): Promise<void>;
	$unregisterBreakpoints(breakpointIds: string[], functionBreakpointIds: string[], dataBreakpointIds: string[]): Promise<void>;
911 912
}

913 914 915 916
export interface IOpenUriOptions {
	readonly allowTunneling?: boolean;
}

917
export interface MainThreadWindowShape extends IDisposable {
J
Johannes Rieken 已提交
918
	$getWindowVisibility(): Promise<boolean>;
919
	$openUri(uri: UriComponents, uriString: string | undefined, options: IOpenUriOptions): Promise<boolean>;
920
	$asExternalUri(uri: UriComponents, options: IOpenUriOptions): Promise<UriComponents>;
921 922
}

A
Alex Ross 已提交
923 924
export interface MainThreadTunnelServiceShape extends IDisposable {
	$openTunnel(tunnelOptions: TunnelOptions): Promise<TunnelDto | undefined>;
925
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
926
	$getTunnels(): Promise<TunnelDescription[]>;
A
Alex Ross 已提交
927
	$registerCandidateFinder(): Promise<void>;
928
	$setTunnelProvider(): Promise<void>;
929
	$setCandidateFilter(): Promise<void>;
930
	$tunnelServiceReady(): Promise<void>;
A
Alex Ross 已提交
931 932
}

933
export interface MainThreadTimelineShape extends IDisposable {
934 935
	$registerTimelineProvider(provider: TimelineProviderDescriptor): void;
	$unregisterTimelineProvider(source: string): void;
E
Eric Amodio 已提交
936
	$emitTimelineChangeEvent(e: TimelineChangeEvent | undefined): void;
937 938
}

939 940
// -- extension host

941
export interface ExtHostCommandsShape {
J
Johannes Rieken 已提交
942
	$executeContributedCommand<T>(id: string, ...args: any[]): Promise<T>;
943
	$getContributedCommandHandlerDescriptions(): Promise<{ [id: string]: string | ICommandHandlerDescription; }>;
944 945
}

946
export interface ExtHostConfigurationShape {
947
	$initializeConfiguration(data: IConfigurationInitData): void;
948
	$acceptConfigurationChanged(data: IConfigurationInitData, change: IConfigurationChange): void;
949 950
}

951
export interface ExtHostDiagnosticsShape {
J
Johannes Rieken 已提交
952
	$acceptMarkersChange(data: [UriComponents, IMarkerData[]][]): void;
953 954
}

955
export interface ExtHostDocumentContentProvidersShape {
M
Matt Bierner 已提交
956
	$provideTextDocumentContent(handle: number, uri: UriComponents): Promise<string | null | undefined>;
957 958
}

959
export interface IModelAddedData {
960
	uri: UriComponents;
961
	versionId: number;
962 963
	lines: string[];
	EOL: string;
964 965 966
	modeId: string;
	isDirty: boolean;
}
967
export interface ExtHostDocumentsShape {
968 969 970 971
	$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;
972 973
}

974
export interface ExtHostDocumentSaveParticipantShape {
J
Johannes Rieken 已提交
975
	$participateInSave(resource: UriComponents, reason: SaveReason): Promise<boolean[]>;
976 977
}

978 979
export interface ITextEditorAddData {
	id: string;
980
	documentUri: UriComponents;
981
	options: IResolvedTextEditorConfiguration;
A
Alex Dima 已提交
982
	selections: ISelection[];
983
	visibleRanges: IRange[];
A
Alex Dima 已提交
984
	editorPosition: EditorViewColumn | undefined;
985 986
}
export interface ITextEditorPositionData {
987
	[id: string]: EditorViewColumn;
988
}
989 990 991
export interface IEditorPropertiesChangeData {
	options: IResolvedTextEditorConfiguration | null;
	selections: ISelectionChangeEvent | null;
992
	visibleRanges: IRange[] | null;
993 994 995 996 997 998
}
export interface ISelectionChangeEvent {
	selections: Selection[];
	source?: string;
}

999
export interface ExtHostEditorsShape {
1000
	$acceptEditorPropertiesChanged(id: string, props: IEditorPropertiesChangeData): void;
1001
	$acceptEditorPositionData(data: ITextEditorPositionData): void;
1002 1003
}

J
Johannes Rieken 已提交
1004
export interface IDocumentsAndEditorsDelta {
1005
	removedDocuments?: UriComponents[];
J
Johannes Rieken 已提交
1006 1007 1008
	addedDocuments?: IModelAddedData[];
	removedEditors?: string[];
	addedEditors?: ITextEditorAddData[];
A
Alex Dima 已提交
1009
	newActiveEditor?: string | null;
J
Johannes Rieken 已提交
1010 1011
}

1012 1013
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
1014 1015
}

1016
export interface ExtHostTreeViewsShape {
J
Johannes Rieken 已提交
1017
	$getChildren(treeViewId: string, treeItemHandle?: string): Promise<ITreeItem[]>;
1018
	$setExpanded(treeViewId: string, treeItemHandle: string, expanded: boolean): void;
1019
	$setSelection(treeViewId: string, treeItemHandles: string[]): void;
1020
	$setVisible(treeViewId: string, visible: boolean): void;
A
Alex Ross 已提交
1021 1022
	$hasResolve(treeViewId: string): Promise<boolean>;
	$resolve(treeViewId: string, treeItemHandle: string): Promise<ITreeItem | undefined>;
S
Sandeep Somavarapu 已提交
1023 1024
}

1025
export interface ExtHostWorkspaceShape {
1026
	$initializeWorkspace(workspace: IWorkspaceData | null): void;
1027
	$acceptWorkspaceData(workspace: IWorkspaceData | null): void;
J
Johannes Rieken 已提交
1028
	$handleTextSearchResult(result: search.IRawFileMatch2, requestId: number): void;
1029
}
1030

1031
export interface ExtHostFileSystemShape {
J
Johannes Rieken 已提交
1032 1033
	$stat(handle: number, resource: UriComponents): Promise<files.IStat>;
	$readdir(handle: number, resource: UriComponents): Promise<[string, files.FileType][]>;
1034 1035
	$readFile(handle: number, resource: UriComponents): Promise<VSBuffer>;
	$writeFile(handle: number, resource: UriComponents, content: VSBuffer, opts: files.FileWriteOptions): Promise<void>;
J
Johannes Rieken 已提交
1036 1037
	$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 已提交
1038
	$mkdir(handle: number, resource: UriComponents): Promise<void>;
J
Johannes Rieken 已提交
1039 1040
	$delete(handle: number, resource: UriComponents, opts: files.FileDeleteOptions): Promise<void>;
	$watch(handle: number, session: number, resource: UriComponents, opts: files.IWatchOptions): void;
1041
	$unwatch(handle: number, session: number): void;
J
Johannes Rieken 已提交
1042
	$open(handle: number, resource: UriComponents, opts: files.FileOpenOptions): Promise<number>;
J
Johannes Rieken 已提交
1043
	$close(handle: number, fd: number): Promise<void>;
1044 1045
	$read(handle: number, fd: number, pos: number, length: number): Promise<VSBuffer>;
	$write(handle: number, fd: number, pos: number, data: VSBuffer): Promise<number>;
1046
}
1047

1048 1049 1050 1051
export interface ExtHostLabelServiceShape {
	$registerResourceLabelFormatter(formatter: ResourceLabelFormatter): IDisposable;
}

1052
export interface ExtHostAuthenticationShape {
1053
	$getSessions(id: string): Promise<ReadonlyArray<modes.AuthenticationSession>>;
1054
	$getSessionAccessToken(id: string, sessionId: string): Promise<string>;
1055
	$login(id: string, scopes: string[]): Promise<modes.AuthenticationSession>;
1056
	$logout(id: string, sessionId: string): Promise<void>;
1057 1058
	$onDidChangeAuthenticationSessions(id: string, label: string, event: modes.AuthenticationSessionsChangeEvent): Promise<void>;
	$onDidChangeAuthenticationProviders(added: modes.AuthenticationProviderInformation[], removed: modes.AuthenticationProviderInformation[]): Promise<void>;
1059
	$setProviders(providers: modes.AuthenticationProviderInformation[]): Promise<void>;
1060 1061
}

1062
export interface ExtHostSearchShape {
J
Johannes Rieken 已提交
1063 1064
	$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 已提交
1065
	$clearCache(cacheKey: string): Promise<void>;
1066 1067
}

A
Tweaks  
Alex Dima 已提交
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
export interface IResolveAuthorityErrorResult {
	type: 'error';
	error: {
		message: string | undefined;
		code: RemoteAuthorityResolverErrorCode;
		detail: any;
	};
}

export interface IResolveAuthorityOKResult {
	type: 'ok';
1079
	value: ResolverResult;
A
Tweaks  
Alex Dima 已提交
1080 1081 1082 1083
}

export type IResolveAuthorityResult = IResolveAuthorityErrorResult | IResolveAuthorityOKResult;

1084
export interface ExtHostExtensionServiceShape {
A
Tweaks  
Alex Dima 已提交
1085
	$resolveAuthority(remoteAuthority: string, resolveAttempt: number): Promise<IResolveAuthorityResult>;
1086
	$startExtensionHost(enabledExtensionIds: ExtensionIdentifier[]): Promise<void>;
1087
	$activateByEvent(activationEvent: string, activationKind: ActivationKind): Promise<void>;
1088
	$activate(extensionId: ExtensionIdentifier, reason: ExtensionActivationReason): Promise<boolean>;
1089
	$setRemoteEnvironment(env: { [key: string]: string | null; }): Promise<void>;
1090
	$updateRemoteConnectionData(connectionData: IRemoteConnectionData): Promise<void>;
1091

1092
	$deltaExtensions(toAdd: IExtensionDescription[], toRemove: ExtensionIdentifier[]): Promise<void>;
1093 1094

	$test_latency(n: number): Promise<number>;
1095 1096
	$test_up(b: VSBuffer): Promise<number>;
	$test_down(size: number): Promise<VSBuffer>;
1097 1098 1099
}

export interface FileSystemEvents {
J
Johannes Rieken 已提交
1100 1101 1102
	created: UriComponents[];
	changed: UriComponents[];
	deleted: UriComponents[];
1103
}
1104

1105 1106 1107 1108 1109
export interface SourceTargetPair {
	source?: UriComponents;
	target: UriComponents;
}

1110
export interface ExtHostFileSystemEventServiceShape {
1111
	$onFileEvent(events: FileSystemEvents): void;
1112 1113
	$onWillRunFileOperation(operation: files.FileOperation, files: SourceTargetPair[], timeout: number, token: CancellationToken): Promise<any>;
	$onDidRunFileOperation(operation: files.FileOperation, files: SourceTargetPair[]): void;
1114 1115
}

J
Johannes Rieken 已提交
1116
export interface ObjectIdentifier {
1117
	$ident?: number;
J
Johannes Rieken 已提交
1118 1119 1120
}

export namespace ObjectIdentifier {
1121
	export const name = '$ident';
J
Johannes Rieken 已提交
1122
	export function mixin<T>(obj: T, id: number): T & ObjectIdentifier {
1123
		Object.defineProperty(obj, name, { value: id, enumerable: true });
J
Johannes Rieken 已提交
1124 1125
		return <T & ObjectIdentifier>obj;
	}
1126 1127
	export function of(obj: any): number {
		return obj[name];
J
Johannes Rieken 已提交
1128 1129 1130
	}
}

1131 1132
export interface ExtHostHeapServiceShape {
	$onGarbageCollection(ids: number[]): void;
1133
}
1134
export interface IRawColorInfo {
J
Joao Moreno 已提交
1135
	color: [number, number, number, number];
1136 1137 1138
	range: IRange;
}

1139 1140 1141 1142 1143 1144 1145 1146 1147
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;
	}
}

1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
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 已提交
1163 1164 1165

	// to merge into label
	label2 = 'o',
1166 1167
}

J
Johannes Rieken 已提交
1168
export interface ISuggestDataDto {
P
label2  
Pine Wu 已提交
1169 1170
	[ISuggestDataDtoField.label]: string;
	[ISuggestDataDtoField.label2]?: string | modes.CompletionItemLabel;
1171
	[ISuggestDataDtoField.kind]?: modes.CompletionItemKind;
1172 1173 1174 1175
	[ISuggestDataDtoField.detail]?: string;
	[ISuggestDataDtoField.documentation]?: string | IMarkdownString;
	[ISuggestDataDtoField.sortText]?: string;
	[ISuggestDataDtoField.filterText]?: string;
1176
	[ISuggestDataDtoField.preselect]?: true;
1177 1178
	[ISuggestDataDtoField.insertText]?: string;
	[ISuggestDataDtoField.insertTextRules]?: modes.CompletionItemInsertTextRule;
1179
	[ISuggestDataDtoField.range]?: IRange | { insert: IRange, replace: IRange; };
1180 1181 1182 1183
	[ISuggestDataDtoField.commitCharacters]?: string[];
	[ISuggestDataDtoField.additionalTextEdits]?: ISingleEditOperation[];
	[ISuggestDataDtoField.command]?: modes.Command;
	[ISuggestDataDtoField.kindModifier]?: modes.CompletionItemTag[];
J
Johannes Rieken 已提交
1184
	// not-standard
1185
	x?: ChainedCacheId;
J
Johannes Rieken 已提交
1186 1187
}

1188 1189 1190 1191 1192 1193
export const enum ISuggestResultDtoField {
	defaultRanges = 'a',
	completions = 'b',
	isIncomplete = 'c'
}

J
Johannes Rieken 已提交
1194
export interface ISuggestResultDto {
1195 1196 1197
	[ISuggestResultDtoField.defaultRanges]: { insert: IRange, replace: IRange; };
	[ISuggestResultDtoField.completions]: ISuggestDataDto[];
	[ISuggestResultDtoField.isIncomplete]: undefined | true;
1198
	x?: number;
1199 1200
}

J
Johannes Rieken 已提交
1201
export interface ISignatureHelpDto {
1202 1203 1204 1205 1206 1207
	id: CacheId;
	signatures: modes.SignatureInformation[];
	activeSignature: number;
	activeParameter: number;
}

J
Johannes Rieken 已提交
1208
export interface ISignatureHelpContextDto {
1209 1210 1211
	readonly triggerKind: modes.SignatureHelpTriggerKind;
	readonly triggerCharacter?: string;
	readonly isRetrigger: boolean;
J
Johannes Rieken 已提交
1212
	readonly activeSignatureHelp?: ISignatureHelpDto;
1213 1214
}

J
Johannes Rieken 已提交
1215
export interface ILocationDto {
1216 1217
	uri: UriComponents;
	range: IRange;
1218 1219
}

J
Johannes Rieken 已提交
1220
export interface IDefinitionLinkDto {
J
Johannes Rieken 已提交
1221
	originSelectionRange?: IRange;
M
Matt Bierner 已提交
1222 1223
	uri: UriComponents;
	range: IRange;
J
Johannes Rieken 已提交
1224
	targetSelectionRange?: IRange;
M
Matt Bierner 已提交
1225 1226
}

J
Johannes Rieken 已提交
1227
export interface IWorkspaceSymbolDto extends IdObject {
1228 1229 1230
	name: string;
	containerName?: string;
	kind: modes.SymbolKind;
J
Johannes Rieken 已提交
1231
	location: ILocationDto;
1232 1233
}

J
Johannes Rieken 已提交
1234 1235
export interface IWorkspaceSymbolsDto extends IdObject {
	symbols: IWorkspaceSymbolDto[];
1236 1237
}

1238 1239 1240 1241 1242 1243 1244
export interface IWorkspaceEditEntryMetadataDto {
	needsConfirmation: boolean;
	label: string;
	description?: string;
	iconPath?: { id: string } | UriComponents | { light: UriComponents, dark: UriComponents };
}

1245 1246 1247
export const enum WorkspaceEditType {
	File = 1,
	Text = 2,
1248
	Cell = 3,
1249 1250
}

1251
export interface IWorkspaceFileEditDto {
1252
	_type: WorkspaceEditType.File;
M
Matt Bierner 已提交
1253 1254
	oldUri?: UriComponents;
	newUri?: UriComponents;
1255
	options?: modes.WorkspaceFileEditOptions
1256
	metadata?: IWorkspaceEditEntryMetadataDto;
1257 1258
}

1259
export interface IWorkspaceTextEditDto {
1260
	_type: WorkspaceEditType.Text;
1261
	resource: UriComponents;
1262
	edit: modes.TextEdit;
1263
	modelVersionId?: number;
1264
	metadata?: IWorkspaceEditEntryMetadataDto;
1265 1266
}

1267 1268 1269 1270 1271 1272 1273 1274
export interface IWorkspaceCellEditDto {
	_type: WorkspaceEditType.Cell;
	resource: UriComponents;
	edit: ICellEditOperation;
	modelVersionId?: number;
	metadata?: IWorkspaceEditEntryMetadataDto;
}

J
Johannes Rieken 已提交
1275
export interface IWorkspaceEditDto {
1276
	edits: Array<IWorkspaceFileEditDto | IWorkspaceTextEditDto | IWorkspaceCellEditDto>;
1277 1278

	// todo@joh reject should go into rename
1279 1280 1281
	rejectReason?: string;
}

J
Johannes Rieken 已提交
1282
export function reviveWorkspaceEditDto(data: IWorkspaceEditDto | undefined): modes.WorkspaceEdit {
1283 1284
	if (data && data.edits) {
		for (const edit of data.edits) {
1285 1286
			if (typeof (<IWorkspaceTextEditDto>edit).resource === 'object') {
				(<IWorkspaceTextEditDto>edit).resource = URI.revive((<IWorkspaceTextEditDto>edit).resource);
1287
			} else {
1288 1289
				(<IWorkspaceFileEditDto>edit).newUri = URI.revive((<IWorkspaceFileEditDto>edit).newUri);
				(<IWorkspaceFileEditDto>edit).oldUri = URI.revive((<IWorkspaceFileEditDto>edit).oldUri);
1290
			}
1291 1292 1293
			if (edit.metadata && edit.metadata.iconPath) {
				edit.metadata = revive(edit.metadata);
			}
1294 1295 1296 1297 1298
		}
	}
	return <modes.WorkspaceEdit>data;
}

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

J
Johannes Rieken 已提交
1301
export interface ICodeActionDto {
1302
	title: string;
J
Johannes Rieken 已提交
1303
	edit?: IWorkspaceEditDto;
1304
	diagnostics?: IMarkerData[];
J
Johannes Rieken 已提交
1305
	command?: ICommandDto;
J
Johannes Rieken 已提交
1306
	kind?: string;
1307
	isPreferred?: boolean;
M
Matt Bierner 已提交
1308
	disabled?: string;
1309
}
1310

J
Johannes Rieken 已提交
1311
export interface ICodeActionListDto {
1312
	cacheId: number;
J
Johannes Rieken 已提交
1313
	actions: ReadonlyArray<ICodeActionDto>;
1314 1315
}

1316 1317 1318 1319 1320
export interface ICodeActionProviderMetadataDto {
	readonly providedKinds?: readonly string[];
	readonly documentation?: ReadonlyArray<{ readonly kind: string, readonly command: ICommandDto }>;
}

1321 1322 1323
export type CacheId = number;
export type ChainedCacheId = [CacheId, CacheId];

J
Johannes Rieken 已提交
1324
export interface ILinksListDto {
1325
	id?: CacheId;
J
Johannes Rieken 已提交
1326
	links: ILinkDto[];
1327 1328
}

J
Johannes Rieken 已提交
1329
export interface ILinkDto {
1330
	cacheId?: ChainedCacheId;
M
Martin Aeschlimann 已提交
1331 1332
	range: IRange;
	url?: string | UriComponents;
1333
	tooltip?: string;
M
Martin Aeschlimann 已提交
1334
}
1335

J
Johannes Rieken 已提交
1336
export interface ICodeLensListDto {
1337
	cacheId?: number;
J
Johannes Rieken 已提交
1338
	lenses: ICodeLensDto[];
1339 1340
}

J
Johannes Rieken 已提交
1341
export interface ICodeLensDto {
1342
	cacheId?: ChainedCacheId;
1343
	range: IRange;
J
Johannes Rieken 已提交
1344
	command?: ICommandDto;
1345
}
1346

J
Johannes Rieken 已提交
1347
export type ICallHierarchyItemDto = Dto<CallHierarchyItem>;
1348

1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
export interface IIncomingCallDto {
	from: ICallHierarchyItemDto;
	fromRanges: IRange[];
}

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

A
Alex Dima 已提交
1359 1360 1361 1362 1363 1364
export interface ILanguageWordDefinitionDto {
	languageId: string;
	regexSource: string;
	regexFlags: string
}

1365
export interface ExtHostLanguageFeaturesShape {
1366
	$provideDocumentSymbols(handle: number, resource: UriComponents, token: CancellationToken): Promise<modes.DocumentSymbol[] | undefined>;
J
Johannes Rieken 已提交
1367 1368
	$provideCodeLenses(handle: number, resource: UriComponents, token: CancellationToken): Promise<ICodeLensListDto | undefined>;
	$resolveCodeLens(handle: number, symbol: ICodeLensDto, token: CancellationToken): Promise<ICodeLensDto | undefined>;
1369
	$releaseCodeLenses(handle: number, id: number): void;
J
Johannes Rieken 已提交
1370 1371 1372 1373
	$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[]>;
1374
	$provideHover(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.Hover | undefined>;
1375
	$provideEvaluatableExpression(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.EvaluatableExpression | undefined>;
1376
	$provideDocumentHighlights(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.DocumentHighlight[] | undefined>;
1377
	$provideOnTypeRenameRanges(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<{ ranges: IRange[]; wordPattern?: IRegExpDto; } | undefined>;
J
Johannes Rieken 已提交
1378 1379
	$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>;
1380
	$releaseCodeActions(handle: number, cacheId: number): void;
1381 1382 1383
	$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 已提交
1384 1385
	$provideWorkspaceSymbols(handle: number, search: string, token: CancellationToken): Promise<IWorkspaceSymbolsDto>;
	$resolveWorkspaceSymbol(handle: number, symbol: IWorkspaceSymbolDto, token: CancellationToken): Promise<IWorkspaceSymbolDto | undefined>;
1386
	$releaseWorkspaceSymbols(handle: number, id: number): void;
J
Johannes Rieken 已提交
1387
	$provideRenameEdits(handle: number, resource: UriComponents, position: IPosition, newName: string, token: CancellationToken): Promise<IWorkspaceEditDto | undefined>;
1388
	$resolveRenameLocation(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<modes.RenameLocation | undefined>;
1389 1390 1391
	$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 已提交
1392
	$provideCompletionItems(handle: number, resource: UriComponents, position: IPosition, context: modes.CompletionContext, token: CancellationToken): Promise<ISuggestResultDto | undefined>;
1393
	$resolveCompletionItem(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<ISuggestDataDto | undefined>;
1394
	$releaseCompletionItems(handle: number, id: number): void;
J
Johannes Rieken 已提交
1395
	$provideSignatureHelp(handle: number, resource: UriComponents, position: IPosition, context: modes.SignatureHelpContext, token: CancellationToken): Promise<ISignatureHelpDto | undefined>;
1396
	$releaseSignatureHelp(handle: number, id: number): void;
J
Johannes Rieken 已提交
1397 1398
	$provideDocumentLinks(handle: number, resource: UriComponents, token: CancellationToken): Promise<ILinksListDto | undefined>;
	$resolveDocumentLink(handle: number, id: ChainedCacheId, token: CancellationToken): Promise<ILinkDto | undefined>;
1399
	$releaseDocumentLinks(handle: number, id: number): void;
J
Johannes Rieken 已提交
1400
	$provideDocumentColors(handle: number, resource: UriComponents, token: CancellationToken): Promise<IRawColorInfo[]>;
M
Matt Bierner 已提交
1401 1402
	$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>;
1403
	$provideSelectionRanges(handle: number, resource: UriComponents, positions: IPosition[], token: CancellationToken): Promise<modes.SelectionRange[][]>;
1404
	$prepareCallHierarchy(handle: number, resource: UriComponents, position: IPosition, token: CancellationToken): Promise<ICallHierarchyItemDto[] | undefined>;
1405 1406
	$provideCallHierarchyIncomingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IIncomingCallDto[] | undefined>;
	$provideCallHierarchyOutgoingCalls(handle: number, sessionId: string, itemId: string, token: CancellationToken): Promise<IOutgoingCallDto[] | undefined>;
1407
	$releaseCallHierarchy(handle: number, sessionId: string): void;
A
Alex Dima 已提交
1408
	$setWordDefinitions(wordDefinitions: ILanguageWordDefinitionDto[]): void;
1409 1410
}

1411 1412
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
M
Matt Bierner 已提交
1413
	$validateInput(input: string): Promise<string | null | undefined>;
1414 1415 1416
	$onDidChangeActive(sessionId: number, handles: number[]): void;
	$onDidChangeSelection(sessionId: number, handles: number[]): void;
	$onDidAccept(sessionId: number): void;
1417
	$onDidChangeValue(sessionId: number, value: string): void;
C
Christof Marti 已提交
1418
	$onDidTriggerButton(sessionId: number, handle: number): void;
1419
	$onDidHide(sessionId: number): void;
1420 1421
}

J
Johannes Rieken 已提交
1422
export interface IShellLaunchConfigDto {
1423 1424 1425
	name?: string;
	executable?: string;
	args?: string[] | string;
1426
	cwd?: string | UriComponents;
1427
	env?: { [key: string]: string | null; };
1428
	hideFromUser?: boolean;
1429 1430
}

D
Daniel Imms 已提交
1431 1432 1433 1434 1435
export interface IShellDefinitionDto {
	label: string;
	path: string;
}

D
Daniel Imms 已提交
1436 1437 1438 1439 1440
export interface IShellAndArgsDto {
	shell: string;
	args: string[] | string | undefined;
}

1441
export interface ITerminalLinkDto {
D
Daniel Imms 已提交
1442 1443
	/** The ID of the link to enable activation and disposal. */
	id: number;
1444 1445 1446 1447 1448 1449 1450 1451
	/** 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;
}

1452 1453 1454 1455 1456
export interface ITerminalDimensionsDto {
	columns: number;
	rows: number;
}

1457
export interface ExtHostTerminalServiceShape {
D
Daniel Imms 已提交
1458
	$acceptTerminalClosed(id: number, exitCode: number | undefined): void;
1459
	$acceptTerminalOpened(id: number, name: string, shellLaunchConfig: IShellLaunchConfigDto): void;
1460
	$acceptActiveTerminalChanged(id: number | null): void;
1461
	$acceptTerminalProcessId(id: number, processId: number): void;
A
Alex Dima 已提交
1462
	$acceptTerminalProcessData(id: number, data: string): void;
1463
	$acceptTerminalTitleChange(id: number, name: string): void;
1464
	$acceptTerminalDimensions(id: number, cols: number, rows: number): void;
1465
	$acceptTerminalMaximumDimensions(id: number, cols: number, rows: number): void;
1466 1467
	$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 已提交
1468 1469
	$acceptProcessInput(id: number, data: string): void;
	$acceptProcessResize(id: number, cols: number, rows: number): void;
1470
	$acceptProcessShutdown(id: number, immediate: boolean): void;
1471 1472
	$acceptProcessRequestInitialCwd(id: number): void;
	$acceptProcessRequestCwd(id: number): void;
1473
	$acceptProcessRequestLatency(id: number): number;
1474
	$acceptWorkspacePermissionsChanged(isAllowed: boolean): void;
1475
	$getAvailableShells(): Promise<IShellDefinitionDto[]>;
1476
	$getDefaultShellAndArgs(useAutomationShell: boolean): Promise<IShellAndArgsDto>;
1477
	$provideLinks(id: number, line: string): Promise<ITerminalLinkDto[]>;
D
Daniel Imms 已提交
1478
	$activateLink(id: number, linkId: number): void;
1479
	$initEnvironmentVariableCollections(collections: [string, ISerializableEnvironmentVariableCollection][]): void;
1480 1481
}

1482
export interface ExtHostSCMShape {
M
Matt Bierner 已提交
1483
	$provideOriginalResource(sourceControlHandle: number, uri: UriComponents, token: CancellationToken): Promise<UriComponents | null>;
A
Alex Dima 已提交
1484
	$onInputBoxValueChange(sourceControlHandle: number, value: string): void;
J
João Moreno 已提交
1485
	$executeResourceCommand(sourceControlHandle: number, groupHandle: number, handle: number, preserveFocus: boolean): Promise<void>;
J
Johannes Rieken 已提交
1486
	$validateInput(sourceControlHandle: number, value: string, cursorPosition: number): Promise<[string, number] | undefined>;
J
João Moreno 已提交
1487
	$setSelectedSourceControl(selectedSourceControlHandle: number | undefined): Promise<void>;
J
Joao Moreno 已提交
1488 1489
}

1490
export interface ExtHostTaskShape {
J
Johannes Rieken 已提交
1491
	$provideTasks(handle: number, validTypes: { [key: string]: boolean; }): Thenable<tasks.TaskSetDTO>;
1492
	$resolveTask(handle: number, taskDTO: tasks.TaskDTO): Thenable<tasks.TaskDTO | undefined>;
1493
	$onDidStartTask(execution: tasks.TaskExecutionDTO, terminalId: number, resolvedDefinition: tasks.TaskDefinitionDTO): void;
J
Johannes Rieken 已提交
1494 1495 1496
	$onDidStartTaskProcess(value: tasks.TaskProcessStartedDTO): void;
	$onDidEndTaskProcess(value: tasks.TaskProcessEndedDTO): void;
	$OnDidEndTask(execution: tasks.TaskExecutionDTO): void;
1497 1498
	$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 已提交
1499
	$jsonTasksSupported(): Thenable<boolean>;
1500
	$findExecutable(command: string, cwd?: string, paths?: string[]): Promise<string | undefined>;
1501 1502
}

1503 1504
export interface IBreakpointDto {
	type: string;
1505
	id?: string;
1506 1507 1508
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
1509 1510 1511 1512 1513
	logMessage?: string;
}

export interface IFunctionBreakpointDto extends IBreakpointDto {
	type: 'function';
1514
	functionName: string;
1515 1516
}

I
isidor 已提交
1517 1518 1519 1520 1521
export interface IDataBreakpointDto extends IBreakpointDto {
	type: 'data';
	dataId: string;
	canPersist: boolean;
	label: string;
1522
	accessTypes?: DebugProtocol.DataBreakpointAccessType[];
I
isidor 已提交
1523 1524
}

1525
export interface ISourceBreakpointDto extends IBreakpointDto {
1526
	type: 'source';
1527
	uri: UriComponents;
1528 1529
	line: number;
	character: number;
1530 1531
}

1532
export interface IBreakpointsDeltaDto {
I
isidor 已提交
1533
	added?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1534
	removed?: string[];
I
isidor 已提交
1535
	changed?: Array<ISourceBreakpointDto | IFunctionBreakpointDto | IDataBreakpointDto>;
1536 1537
}

1538 1539 1540 1541
export interface ISourceMultiBreakpointDto {
	type: 'sourceMulti';
	uri: UriComponents;
	lines: {
1542
		id: string;
1543 1544 1545
		enabled: boolean;
		condition?: string;
		hitCondition?: string;
1546
		logMessage?: string;
1547 1548 1549
		line: number;
		character: number;
	}[];
1550 1551
}

A
Andre Weinand 已提交
1552
export interface IDebugSessionFullDto {
1553 1554 1555
	id: DebugSessionUUID;
	type: string;
	name: string;
1556
	folderUri: UriComponents | undefined;
A
Andre Weinand 已提交
1557
	configuration: IConfig;
1558 1559
}

A
Andre Weinand 已提交
1560 1561
export type IDebugSessionDto = IDebugSessionFullDto | DebugSessionUUID;

1562
export interface ExtHostDebugServiceShape {
J
Johannes Rieken 已提交
1563
	$substituteVariables(folder: UriComponents | undefined, config: IConfig): Promise<IConfig>;
1564
	$runInTerminal(args: DebugProtocol.RunInTerminalRequestArguments): Promise<number | undefined>;
J
Johannes Rieken 已提交
1565 1566
	$startDASession(handle: number, session: IDebugSessionDto): Promise<void>;
	$stopDASession(handle: number): Promise<void>;
1567
	$sendDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
1568
	$resolveDebugConfiguration(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1569
	$resolveDebugConfigurationWithSubstitutedVariables(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig, token: CancellationToken): Promise<IConfig | null | undefined>;
1570
	$provideDebugConfigurations(handle: number, folder: UriComponents | undefined, token: CancellationToken): Promise<IConfig[]>;
J
Johannes Rieken 已提交
1571 1572
	$legacyDebugAdapterExecutable(handle: number, folderUri: UriComponents | undefined): Promise<IAdapterDescriptor>; // TODO@AW legacy
	$provideDebugAdapter(handle: number, session: IDebugSessionDto): Promise<IAdapterDescriptor>;
1573 1574
	$acceptDebugSessionStarted(session: IDebugSessionDto): void;
	$acceptDebugSessionTerminated(session: IDebugSessionDto): void;
1575
	$acceptDebugSessionActiveChanged(session: IDebugSessionDto | undefined): void;
1576 1577
	$acceptDebugSessionCustomEvent(session: IDebugSessionDto, event: any): void;
	$acceptBreakpointsDelta(delta: IBreakpointsDeltaDto): void;
1578
	$acceptDebugSessionNameChanged(session: IDebugSessionDto, name: string): void;
1579 1580
}

1581

1582 1583 1584 1585 1586
export interface DecorationRequest {
	readonly id: number;
	readonly uri: UriComponents;
}

1587
export type DecorationData = [number, boolean, string, string, ThemeColor];
1588
export type DecorationReply = { [id: number]: DecorationData; };
1589 1590

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

1594 1595
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
1596 1597
}

S
Sandeep Somavarapu 已提交
1598
export interface ExtHostLogServiceShape {
A
Alex Dima 已提交
1599
	$setLevel(level: LogLevel): void;
S
Sandeep Somavarapu 已提交
1600 1601
}

J
Johannes Rieken 已提交
1602 1603 1604 1605
export interface MainThreadLogShape {
	$log(file: UriComponents, level: LogLevel, args: any[]): void;
}

1606 1607 1608 1609
export interface ExtHostOutputServiceShape {
	$setVisibleChannel(channelId: string | null): void;
}

1610 1611 1612 1613
export interface ExtHostProgressShape {
	$acceptProgressCanceled(handle: number): void;
}

M
Matt Bierner 已提交
1614
export interface ExtHostCommentsShape {
P
Peng Lyu 已提交
1615
	$createCommentThreadTemplate(commentControllerHandle: number, uriComponents: UriComponents, range: IRange): void;
1616
	$updateCommentThreadTemplate(commentControllerHandle: number, threadHandle: number, range: IRange): Promise<void>;
1617
	$deleteCommentThread(commentControllerHandle: number, commentThreadHandle: number): void;
P
Peng Lyu 已提交
1618
	$provideCommentingRanges(commentControllerHandle: number, uriComponents: UriComponents, token: CancellationToken): Promise<IRange[] | undefined>;
P
Peng Lyu 已提交
1619
	$toggleReaction(commentControllerHandle: number, threadHandle: number, uri: UriComponents, comment: modes.Comment, reaction: modes.CommentReaction): Promise<void>;
M
Matt Bierner 已提交
1620 1621
}

R
rebornix 已提交
1622 1623 1624 1625 1626
export interface INotebookSelectionChangeEvent {
	// handles
	selections: number[];
}

1627 1628 1629 1630 1631 1632 1633 1634 1635
export interface INotebookCellVisibleRange {
	start: number;
	end: number;
}

export interface INotebookVisibleRangesEvent {
	ranges: INotebookCellVisibleRange[];
}

R
rebornix 已提交
1636
export interface INotebookEditorPropertiesChangeData {
1637 1638 1639 1640
	visibleRanges: INotebookVisibleRangesEvent | null;
}

export interface INotebookDocumentPropertiesChangeData {
R
rebornix 已提交
1641
	metadata: NotebookDocumentMetadata | null;
1642
	selections: INotebookSelectionChangeEvent | null;
R
rebornix 已提交
1643 1644
}

R
rebornix 已提交
1645 1646 1647
export interface INotebookModelAddedData {
	uri: UriComponents;
	handle: number;
R
rebornix 已提交
1648 1649
	versionId: number;
	cells: IMainCellDto[],
R
rebornix 已提交
1650
	viewType: string;
R
rebornix 已提交
1651
	metadata?: NotebookDocumentMetadata;
1652
	attachedEditor?: { id: string; selections: number[]; visibleRanges: ICellRange[] }
R
rebornix 已提交
1653 1654
}

R
rebornix 已提交
1655 1656 1657 1658
export interface INotebookEditorAddData {
	id: string;
	documentUri: UriComponents;
	selections: number[];
1659
	visibleRanges: ICellRange[];
R
rebornix 已提交
1660 1661 1662 1663 1664
}

export interface INotebookDocumentsAndEditorsDelta {
	removedDocuments?: UriComponents[];
	addedDocuments?: INotebookModelAddedData[];
R
rebornix 已提交
1665 1666 1667
	removedEditors?: string[];
	addedEditors?: INotebookEditorAddData[];
	newActiveEditor?: string | null;
R
rebornix 已提交
1668
	visibleEditors?: string[];
R
rebornix 已提交
1669 1670
}

R
rebornix 已提交
1671
export interface ExtHostNotebookShape {
1672
	$resolveNotebookData(viewType: string, uri: UriComponents, backupId?: string): Promise<NotebookDataDto | undefined>;
1673
	$resolveNotebookEditor(viewType: string, uri: UriComponents, editorId: string): Promise<void>;
R
rebornix 已提交
1674 1675
	$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 已提交
1676
	$executeNotebookKernelFromProvider(handle: number, uri: UriComponents, kernelId: string, cellHandle: number | undefined): Promise<void>;
1677
	$cancelNotebookKernelFromProvider(handle: number, uri: UriComponents, kernelId: string, cellHandle: number | undefined): Promise<void>;
R
Rob Lourens 已提交
1678
	$executeNotebook2(kernelId: string, viewType: string, uri: UriComponents, cellHandle: number | undefined): Promise<void>;
R
rebornix 已提交
1679
	$saveNotebook(viewType: string, uri: UriComponents, token: CancellationToken): Promise<boolean>;
R
saveAs  
rebornix 已提交
1680
	$saveNotebookAs(viewType: string, uri: UriComponents, target: UriComponents, token: CancellationToken): Promise<boolean>;
1681
	$backup(viewType: string, uri: UriComponents, cancellation: CancellationToken): Promise<string | undefined>;
R
rebornix 已提交
1682
	$acceptDisplayOrder(displayOrder: INotebookDisplayOrder): void;
R
rebornix 已提交
1683
	$acceptNotebookActiveKernelChange(event: { uri: UriComponents, providerHandle: number | undefined, kernelId: string | undefined }): void;
1684
	$onDidReceiveMessage(editorId: string, rendererId: string | undefined, message: unknown): void;
1685
	$acceptModelChanged(uriComponents: UriComponents, event: NotebookCellsChangedEvent, isDirty: boolean): void;
1686
	$acceptModelSaved(uriComponents: UriComponents): void;
1687 1688
	$acceptEditorPropertiesChanged(id: string, data: INotebookEditorPropertiesChangeData): void;
	$acceptDocumentPropertiesChanged(uriComponents: UriComponents, data: INotebookDocumentPropertiesChangeData): void;
J
Johannes Rieken 已提交
1689
	$acceptDocumentAndEditorsDelta(delta: INotebookDocumentsAndEditorsDelta): void;
1690 1691 1692
	$undoNotebook(viewType: string, uri: UriComponents, editId: number, isDirty: boolean): Promise<void>;
	$redoNotebook(viewType: string, uri: UriComponents, editId: number, isDirty: boolean): Promise<void>;

R
rebornix 已提交
1693 1694
}

1695
export interface ExtHostStorageShape {
1696
	$acceptValue(shared: boolean, key: string, value: object | undefined): void;
1697 1698
}

M
Martin Aeschlimann 已提交
1699 1700 1701 1702 1703 1704
export interface ExtHostThemingShape {
	$onColorThemeChange(themeType: string): void;
}

export interface MainThreadThemingShape extends IDisposable {
}
1705 1706

export interface ExtHostTunnelServiceShape {
1707
	$findCandidatePorts(): Promise<{ host: string, port: number, detail: string }[]>;
1708
	$filterCandidates(candidates: { host: string, port: number, detail: string }[]): Promise<boolean[]>;
1709 1710
	$forwardPort(tunnelOptions: TunnelOptions): Promise<TunnelDto> | undefined;
	$closeTunnel(remote: { host: string, port: number }): Promise<void>;
A
Alex Ross 已提交
1711
	$onDidTunnelsChange(): Promise<void>;
1712 1713
}

1714
export interface ExtHostTimelineShape {
1715
	$getTimeline(source: string, uri: UriComponents, options: TimelineOptions, token: CancellationToken, internalOptions?: InternalTimelineOptions): Promise<Timeline | undefined>;
1716 1717
}

1718 1719 1720
// --- proxy identifiers

export const MainContext = {
1721
	MainThreadAuthentication: createMainId<MainThreadAuthenticationShape>('MainThreadAuthentication'),
1722 1723
	MainThreadClipboard: createMainId<MainThreadClipboardShape>('MainThreadClipboard'),
	MainThreadCommands: createMainId<MainThreadCommandsShape>('MainThreadCommands'),
M
Matt Bierner 已提交
1724
	MainThreadComments: createMainId<MainThreadCommentsShape>('MainThreadComments'),
1725
	MainThreadConfiguration: createMainId<MainThreadConfigurationShape>('MainThreadConfiguration'),
1726
	MainThreadConsole: createMainId<MainThreadConsoleShape>('MainThreadConsole'),
1727
	MainThreadDebugService: createMainId<MainThreadDebugServiceShape>('MainThreadDebugService'),
1728 1729 1730 1731
	MainThreadDecorations: createMainId<MainThreadDecorationsShape>('MainThreadDecorations'),
	MainThreadDiagnostics: createMainId<MainThreadDiagnosticsShape>('MainThreadDiagnostics'),
	MainThreadDialogs: createMainId<MainThreadDiaglogsShape>('MainThreadDiaglogs'),
	MainThreadDocuments: createMainId<MainThreadDocumentsShape>('MainThreadDocuments'),
1732
	MainThreadDocumentContentProviders: createMainId<MainThreadDocumentContentProvidersShape>('MainThreadDocumentContentProviders'),
1733
	MainThreadTextEditors: createMainId<MainThreadTextEditorsShape>('MainThreadTextEditors'),
1734
	MainThreadEditorInsets: createMainId<MainThreadEditorInsetsShape>('MainThreadEditorInsets'),
1735 1736
	MainThreadErrors: createMainId<MainThreadErrorsShape>('MainThreadErrors'),
	MainThreadTreeViews: createMainId<MainThreadTreeViewsShape>('MainThreadTreeViews'),
1737
	MainThreadDownloadService: createMainId<MainThreadDownloadServiceShape>('MainThreadDownloadService'),
A
Alex Dima 已提交
1738
	MainThreadKeytar: createMainId<MainThreadKeytarShape>('MainThreadKeytar'),
1739
	MainThreadLanguageFeatures: createMainId<MainThreadLanguageFeaturesShape>('MainThreadLanguageFeatures'),
1740
	MainThreadLanguages: createMainId<MainThreadLanguagesShape>('MainThreadLanguages'),
J
Johannes Rieken 已提交
1741
	MainThreadLog: createMainId<MainThreadLogShape>('MainThread'),
1742
	MainThreadMessageService: createMainId<MainThreadMessageServiceShape>('MainThreadMessageService'),
1743 1744
	MainThreadOutputService: createMainId<MainThreadOutputServiceShape>('MainThreadOutputService'),
	MainThreadProgress: createMainId<MainThreadProgressShape>('MainThreadProgress'),
1745
	MainThreadQuickOpen: createMainId<MainThreadQuickOpenShape>('MainThreadQuickOpen'),
1746
	MainThreadStatusBar: createMainId<MainThreadStatusBarShape>('MainThreadStatusBar'),
1747
	MainThreadStorage: createMainId<MainThreadStorageShape>('MainThreadStorage'),
1748
	MainThreadTelemetry: createMainId<MainThreadTelemetryShape>('MainThreadTelemetry'),
1749
	MainThreadTerminalService: createMainId<MainThreadTerminalServiceShape>('MainThreadTerminalService'),
M
Matt Bierner 已提交
1750
	MainThreadWebviews: createMainId<MainThreadWebviewsShape>('MainThreadWebviews'),
1751
	MainThreadWebviewPanels: createMainId<MainThreadWebviewPanelsShape>('MainThreadWebviewPanels'),
1752 1753
	MainThreadWebviewViews: createMainId<MainThreadWebviewViewsShape>('MainThreadWebviewViews'),
	MainThreadCustomEditors: createMainId<MainThreadCustomEditorsShape>('MainThreadCustomEditors'),
J
Joao Moreno 已提交
1754
	MainThreadUrls: createMainId<MainThreadUrlsShape>('MainThreadUrls'),
1755
	MainThreadWorkspace: createMainId<MainThreadWorkspaceShape>('MainThreadWorkspace'),
1756
	MainThreadFileSystem: createMainId<MainThreadFileSystemShape>('MainThreadFileSystem'),
1757
	MainThreadExtensionService: createMainId<MainThreadExtensionServiceShape>('MainThreadExtensionService'),
J
Joao Moreno 已提交
1758
	MainThreadSCM: createMainId<MainThreadSCMShape>('MainThreadSCM'),
1759
	MainThreadSearch: createMainId<MainThreadSearchShape>('MainThreadSearch'),
1760
	MainThreadTask: createMainId<MainThreadTaskShape>('MainThreadTask'),
1761
	MainThreadWindow: createMainId<MainThreadWindowShape>('MainThreadWindow'),
M
Martin Aeschlimann 已提交
1762
	MainThreadLabelService: createMainId<MainThreadLabelServiceShape>('MainThreadLabelService'),
1763
	MainThreadNotebook: createMainId<MainThreadNotebookShape>('MainThreadNotebook'),
1764
	MainThreadTheming: createMainId<MainThreadThemingShape>('MainThreadTheming'),
1765 1766
	MainThreadTunnelService: createMainId<MainThreadTunnelServiceShape>('MainThreadTunnelService'),
	MainThreadTimeline: createMainId<MainThreadTimelineShape>('MainThreadTimeline')
1767 1768 1769
};

export const ExtHostContext = {
1770
	ExtHostCommands: createExtId<ExtHostCommandsShape>('ExtHostCommands'),
1771
	ExtHostConfiguration: createExtId<ExtHostConfigurationShape>('ExtHostConfiguration'),
1772
	ExtHostDiagnostics: createExtId<ExtHostDiagnosticsShape>('ExtHostDiagnostics'),
1773
	ExtHostDebugService: createExtId<ExtHostDebugServiceShape>('ExtHostDebugService'),
J
Johannes Rieken 已提交
1774
	ExtHostDecorations: createExtId<ExtHostDecorationsShape>('ExtHostDecorations'),
1775
	ExtHostDocumentsAndEditors: createExtId<ExtHostDocumentsAndEditorsShape>('ExtHostDocumentsAndEditors'),
1776
	ExtHostDocuments: createExtId<ExtHostDocumentsShape>('ExtHostDocuments'),
J
Johannes Rieken 已提交
1777
	ExtHostDocumentContentProviders: createExtId<ExtHostDocumentContentProvidersShape>('ExtHostDocumentContentProviders'),
J
Johannes Rieken 已提交
1778
	ExtHostDocumentSaveParticipant: createExtId<ExtHostDocumentSaveParticipantShape>('ExtHostDocumentSaveParticipant'),
J
Johannes Rieken 已提交
1779
	ExtHostEditors: createExtId<ExtHostEditorsShape>('ExtHostEditors'),
1780
	ExtHostTreeViews: createExtId<ExtHostTreeViewsShape>('ExtHostTreeViews'),
J
Johannes Rieken 已提交
1781
	ExtHostFileSystem: createExtId<ExtHostFileSystemShape>('ExtHostFileSystem'),
J
Johannes Rieken 已提交
1782
	ExtHostFileSystemEventService: createExtId<ExtHostFileSystemEventServiceShape>('ExtHostFileSystemEventService'),
1783
	ExtHostLanguageFeatures: createExtId<ExtHostLanguageFeaturesShape>('ExtHostLanguageFeatures'),
1784 1785
	ExtHostQuickOpen: createExtId<ExtHostQuickOpenShape>('ExtHostQuickOpen'),
	ExtHostExtensionService: createExtId<ExtHostExtensionServiceShape>('ExtHostExtensionService'),
1786
	ExtHostLogService: createExtId<ExtHostLogServiceShape>('ExtHostLogService'),
1787
	ExtHostTerminalService: createExtId<ExtHostTerminalServiceShape>('ExtHostTerminalService'),
J
Joao Moreno 已提交
1788
	ExtHostSCM: createExtId<ExtHostSCMShape>('ExtHostSCM'),
1789
	ExtHostSearch: createExtId<ExtHostSearchShape>('ExtHostSearch'),
1790
	ExtHostTask: createExtId<ExtHostTaskShape>('ExtHostTask'),
1791
	ExtHostWorkspace: createExtId<ExtHostWorkspaceShape>('ExtHostWorkspace'),
1792
	ExtHostWindow: createExtId<ExtHostWindowShape>('ExtHostWindow'),
1793
	ExtHostWebviews: createExtId<ExtHostWebviewsShape>('ExtHostWebviews'),
1794
	ExtHostWebviewPanels: createExtId<ExtHostWebviewPanelsShape>('ExtHostWebviewPanels'),
1795
	ExtHostCustomEditors: createExtId<ExtHostCustomEditorsShape>('ExtHostCustomEditors'),
1796
	ExtHostWebviewViews: createExtId<ExtHostWebviewViewsShape>('ExtHostWebviewViews'),
1797
	ExtHostEditorInsets: createExtId<ExtHostEditorInsetsShape>('ExtHostEditorInsets'),
M
Matt Bierner 已提交
1798
	ExtHostProgress: createMainId<ExtHostProgressShape>('ExtHostProgress'),
1799
	ExtHostComments: createMainId<ExtHostCommentsShape>('ExtHostComments'),
1800
	ExtHostStorage: createMainId<ExtHostStorageShape>('ExtHostStorage'),
1801 1802
	ExtHostUrls: createExtId<ExtHostUrlsShape>('ExtHostUrls'),
	ExtHostOutputService: createMainId<ExtHostOutputServiceShape>('ExtHostOutputService'),
R
rebornix 已提交
1803
	ExtHosLabelService: createMainId<ExtHostLabelServiceShape>('ExtHostLabelService'),
1804
	ExtHostNotebook: createMainId<ExtHostNotebookShape>('ExtHostNotebook'),
1805
	ExtHostTheming: createMainId<ExtHostThemingShape>('ExtHostTheming'),
1806
	ExtHostTunnelService: createMainId<ExtHostTunnelServiceShape>('ExtHostTunnelService'),
1807 1808
	ExtHostAuthentication: createMainId<ExtHostAuthenticationShape>('ExtHostAuthentication'),
	ExtHostTimeline: createMainId<ExtHostTimelineShape>('ExtHostTimeline')
1809
};