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

R
Rob Lourens 已提交
7 8
import { SerializedError } from 'vs/base/common/errors';
import { IDisposable } from 'vs/base/common/lifecycle';
9
import Severity from 'vs/base/common/severity';
R
Rob Lourens 已提交
10
import URI, { UriComponents } from 'vs/base/common/uri';
11
import { TPromise } from 'vs/base/common/winjs.base';
12
import { TextEditorCursorStyle } from 'vs/editor/common/config/editorOptions';
13 14
import { IPosition } from 'vs/editor/common/core/position';
import { IRange } from 'vs/editor/common/core/range';
15
import { ISelection, Selection } from 'vs/editor/common/core/selection';
R
Rob Lourens 已提交
16
import * as editorCommon from 'vs/editor/common/editorCommon';
J
Johannes Rieken 已提交
17
import { ISingleEditOperation } from 'vs/editor/common/model';
R
Rob Lourens 已提交
18 19 20 21 22 23 24
import { IModelChangedEvent } from 'vs/editor/common/model/mirrorTextModel';
import * as modes from 'vs/editor/common/modes';
import { CharacterPair, CommentRule, EnterAction } from 'vs/editor/common/modes/languageConfiguration';
import { ICommandHandlerDescription } from 'vs/platform/commands/common/commands';
import { ConfigurationTarget, IConfigurationData, IConfigurationModel } from 'vs/platform/configuration/common/configuration';
import { ConfigurationScope } from 'vs/platform/configuration/common/configurationRegistry';
import { FileChangeType, FileDeleteOptions, FileOverwriteOptions, FileSystemProviderCapabilities, FileType, FileWriteOptions, IStat, IWatchOptions } from 'vs/platform/files/common/files';
S
Sandeep Somavarapu 已提交
25
import { LogLevel } from 'vs/platform/log/common/log';
R
Rob Lourens 已提交
26 27 28 29 30 31 32 33 34 35 36 37
import { IMarkerData } from 'vs/platform/markers/common/markers';
import { IPickOptions, IQuickInputButton, IQuickPickItem } from 'vs/platform/quickinput/common/quickInput';
import { IPatternInfo, IQueryOptions, IRawFileMatch2, IRawSearchQuery, ISearchCompleteStats } from 'vs/platform/search/common/search';
import { StatusbarAlignment as MainThreadStatusBarAlignment } from 'vs/platform/statusbar/common/statusbar';
import { ITelemetryInfo } from 'vs/platform/telemetry/common/telemetry';
import { ThemeColor } from 'vs/platform/theme/common/themeService';
import { EndOfLine, IFileOperationOptions, TextEditorLineNumbersStyle } from 'vs/workbench/api/node/extHostTypes';
import { EditorViewColumn } from 'vs/workbench/api/shared/editor';
import { TaskDTO, TaskExecutionDTO, TaskFilterDTO, TaskHandleDTO, TaskProcessEndedDTO, TaskProcessStartedDTO, TaskSystemInfoDTO } from 'vs/workbench/api/shared/tasks';
import { ITreeItem } from 'vs/workbench/common/views';
import { IAdapterExecutable, IConfig, ITerminalSettings } from 'vs/workbench/parts/debug/common/debug';
import { TaskSet } from 'vs/workbench/parts/tasks/common/tasks';
D
Daniel Imms 已提交
38
import { ITerminalDimensions } from 'vs/workbench/parts/terminal/common/terminal';
R
Rob Lourens 已提交
39 40 41 42 43
import { IExtensionDescription } from 'vs/workbench/services/extensions/common/extensions';
import { createExtHostContextProxyIdentifier as createExtId, createMainContextProxyIdentifier as createMainId, IRPCProtocol, ProxyIdentifier } from 'vs/workbench/services/extensions/node/proxyIdentifier';
import { IProgressOptions, IProgressStep } from 'vs/workbench/services/progress/common/progress';
import { SaveReason } from 'vs/workbench/services/textfile/common/textfiles';
import * as vscode from 'vscode';
S
Sandeep Somavarapu 已提交
44

45
export interface IEnvironment {
46
	isExtensionDevelopmentDebug: boolean;
J
Johannes Rieken 已提交
47
	appRoot: string;
48 49 50 51 52
	appSettingsHome: string;
	extensionDevelopmentPath: string;
	extensionTestsPath: string;
}

53 54
export interface IWorkspaceData {
	id: string;
55
	name: string;
56
	folders: { uri: UriComponents, name: string, index: number }[];
J
Johannes Rieken 已提交
57
	configuration?: UriComponents;
58 59
}

60 61 62
export interface IInitData {
	parentPid: number;
	environment: IEnvironment;
63
	workspace: IWorkspaceData;
64
	extensions: IExtensionDescription[];
S
Sandeep Somavarapu 已提交
65
	configuration: IConfigurationInitData;
66
	telemetryInfo: ITelemetryInfo;
67
	windowId: number;
S
Sandeep Somavarapu 已提交
68
	logLevel: LogLevel;
A
Alex Dima 已提交
69
	logsPath: string;
70 71
}

S
Sandeep Somavarapu 已提交
72
export interface IConfigurationInitData extends IConfigurationData {
S
Sandeep Somavarapu 已提交
73
	configurationScopes: { [key: string]: ConfigurationScope };
S
Sandeep Somavarapu 已提交
74 75
}

76
export interface IWorkspaceConfigurationChangeEventData {
S
Sandeep Somavarapu 已提交
77 78
	changedConfiguration: IConfigurationModel;
	changedConfigurationByResource: { [folder: string]: IConfigurationModel };
79 80
}

A
Alex Dima 已提交
81
export interface IExtHostContext extends IRPCProtocol {
82 83
}

A
Alex Dima 已提交
84
export interface IMainContext extends IRPCProtocol {
85 86
}

87 88
// --- main thread

89
export interface MainThreadCommandsShape extends IDisposable {
90 91
	$registerCommand(id: string): void;
	$unregisterCommand(id: string): void;
92 93
	$executeCommand<T>(id: string, args: any[]): Thenable<T>;
	$getCommands(): Thenable<string[]>;
94 95
}

M
Matt Bierner 已提交
96
export interface MainThreadCommentsShape extends IDisposable {
97 98 99 100
	$registerDocumentCommentProvider(handle: number): void;
	$unregisterDocumentCommentProvider(handle: number): void;
	$registerWorkspaceCommentProvider(handle: number): void;
	$unregisterWorkspaceCommentProvider(handle: number): void;
101
	$onDidCommentThreadsChange(handle: number, event: modes.CommentThreadChangedEvent): void;
M
Matt Bierner 已提交
102 103
}

104
export interface MainThreadConfigurationShape extends IDisposable {
105 106
	$updateConfigurationOption(target: ConfigurationTarget, key: string, value: any, resource: UriComponents): TPromise<void>;
	$removeConfigurationOption(target: ConfigurationTarget, key: string, resource: UriComponents): TPromise<void>;
107 108
}

109
export interface MainThreadDiagnosticsShape extends IDisposable {
110 111
	$changeMany(owner: string, entries: [UriComponents, IMarkerData[]][]): void;
	$clear(owner: string): void;
112 113
}

114
export interface MainThreadDialogOpenOptions {
115
	defaultUri?: UriComponents;
116
	openLabel?: string;
117 118 119
	canSelectFiles?: boolean;
	canSelectFolders?: boolean;
	canSelectMany?: boolean;
J
Johannes Rieken 已提交
120
	filters?: { [name: string]: string[] };
121 122
}

123
export interface MainThreadDialogSaveOptions {
124
	defaultUri?: UriComponents;
125
	saveLabel?: string;
J
Johannes Rieken 已提交
126
	filters?: { [name: string]: string[] };
127 128
}

129
export interface MainThreadDiaglogsShape extends IDisposable {
130 131
	$showOpenDialog(options: MainThreadDialogOpenOptions): Thenable<string[]>;
	$showSaveDialog(options: MainThreadDialogSaveOptions): Thenable<string>;
132 133
}

134 135 136
export interface MainThreadDecorationsShape extends IDisposable {
	$registerDecorationProvider(handle: number, label: string): void;
	$unregisterDecorationProvider(handle: number): void;
137
	$onDidChange(handle: number, resources: UriComponents[]): void;
138 139
}

140
export interface MainThreadDocumentContentProvidersShape extends IDisposable {
141 142
	$registerTextContentProvider(handle: number, scheme: string): void;
	$unregisterTextContentProvider(handle: number): void;
143
	$onVirtualDocumentChange(uri: UriComponents, value: string): void;
144 145
}

146
export interface MainThreadDocumentsShape extends IDisposable {
J
Johannes Rieken 已提交
147
	$tryCreateDocument(options?: { language?: string; content?: string; }): TPromise<UriComponents>;
148
	$tryOpenDocument(uri: UriComponents): TPromise<void>;
149
	$trySaveDocument(uri: UriComponents): TPromise<boolean>;
150 151
}

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
export interface ITextEditorConfigurationUpdate {
	tabSize?: number | 'auto';
	insertSpaces?: boolean | 'auto';
	cursorStyle?: TextEditorCursorStyle;
	lineNumbers?: TextEditorLineNumbersStyle;
}

export interface IResolvedTextEditorConfiguration {
	tabSize: number;
	insertSpaces: boolean;
	cursorStyle: TextEditorCursorStyle;
	lineNumbers: TextEditorLineNumbersStyle;
}

export enum TextEditorRevealType {
	Default = 0,
	InCenter = 1,
	InCenterIfOutsideViewport = 2,
	AtTop = 3
}

export interface IUndoStopOptions {
	undoStopBefore: boolean;
	undoStopAfter: boolean;
}

export interface IApplyEditsOptions extends IUndoStopOptions {
	setEndOfLine: EndOfLine;
}

182
export interface ITextDocumentShowOptions {
183
	position?: EditorViewColumn;
184 185
	preserveFocus?: boolean;
	pinned?: boolean;
186
	selection?: IRange;
187 188
}

189
export interface MainThreadTextEditorsShape extends IDisposable {
190
	$tryShowTextDocument(resource: UriComponents, options: ITextDocumentShowOptions): TPromise<string>;
191 192
	$registerTextEditorDecorationType(key: string, options: editorCommon.IDecorationRenderOptions): void;
	$removeTextEditorDecorationType(key: string): void;
193
	$tryShowEditor(id: string, position: EditorViewColumn): TPromise<void>;
194
	$tryHideEditor(id: string): TPromise<void>;
195 196 197 198 199
	$trySetOptions(id: string, options: ITextEditorConfigurationUpdate): TPromise<void>;
	$trySetDecorations(id: string, key: string, ranges: editorCommon.IDecorationOptions[]): TPromise<void>;
	$trySetDecorationsFast(id: string, key: string, ranges: number[]): TPromise<void>;
	$tryRevealRange(id: string, range: IRange, revealType: TextEditorRevealType): TPromise<void>;
	$trySetSelections(id: string, selections: ISelection[]): TPromise<void>;
200
	$tryApplyEdits(id: string, modelVersionId: number, edits: ISingleEditOperation[], opts: IApplyEditsOptions): TPromise<boolean>;
201
	$tryApplyWorkspaceEdit(workspaceEditDto: WorkspaceEditDto): TPromise<boolean>;
202
	$tryInsertSnippet(id: string, template: string, selections: IRange[], opts: IUndoStopOptions): TPromise<boolean>;
203
	$getDiffInformation(id: string): TPromise<editorCommon.ILineChange[]>;
204 205
}

206
export interface MainThreadTreeViewsShape extends IDisposable {
S
Sandeep Somavarapu 已提交
207
	$registerTreeViewDataProvider(treeViewId: string): void;
S
Sandeep Somavarapu 已提交
208
	$refresh(treeViewId: string, itemsToRefresh?: { [treeItemHandle: string]: ITreeItem }): TPromise<void>;
209
	$reveal(treeViewId: string, treeItem: ITreeItem, parentChain: ITreeItem[], options: { select: boolean, focus: boolean }): TPromise<void>;
210 211
}

212
export interface MainThreadErrorsShape extends IDisposable {
213
	$onUnexpectedError(err: any | SerializedError): void;
214 215
}

216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
export interface ISerializedRegExp {
	pattern: string;
	flags?: string;
}
export interface ISerializedIndentationRule {
	decreaseIndentPattern: ISerializedRegExp;
	increaseIndentPattern: ISerializedRegExp;
	indentNextLinePattern?: ISerializedRegExp;
	unIndentedLinePattern?: ISerializedRegExp;
}
export interface ISerializedOnEnterRule {
	beforeText: ISerializedRegExp;
	afterText?: ISerializedRegExp;
	action: EnterAction;
}
export interface ISerializedLanguageConfiguration {
	comments?: CommentRule;
	brackets?: CharacterPair[];
	wordPattern?: ISerializedRegExp;
	indentationRules?: ISerializedIndentationRule;
	onEnterRules?: ISerializedOnEnterRule[];
	__electricCharacterSupport?: {
		brackets?: any;
		docComment?: {
			scope: string;
			open: string;
			lineStart: string;
			close?: string;
		};
	};
	__characterPairSupport?: {
		autoClosingPairs: {
			open: string;
			close: string;
			notIn?: string[];
		}[];
	};
}

A
Alex Dima 已提交
255 256 257 258 259
export interface ISerializedDocumentFilter {
	$serialized: true;
	language?: string;
	scheme?: string;
	pattern?: vscode.GlobPattern;
260
	exclusive?: boolean;
A
Alex Dima 已提交
261 262
}

263
export interface MainThreadLanguageFeaturesShape extends IDisposable {
264
	$unregister(handle: number): void;
265
	$registerOutlineSupport(handle: number, selector: ISerializedDocumentFilter[], extensionId: string): void;
A
Alex Dima 已提交
266
	$registerCodeLensSupport(handle: number, selector: ISerializedDocumentFilter[], eventHandle: number): void;
267
	$emitCodeLensEvent(eventHandle: number, event?: any): void;
A
Alex Dima 已提交
268 269 270 271 272 273
	$registerDeclaractionSupport(handle: number, selector: ISerializedDocumentFilter[]): void;
	$registerImplementationSupport(handle: number, selector: ISerializedDocumentFilter[]): void;
	$registerTypeDefinitionSupport(handle: number, selector: ISerializedDocumentFilter[]): void;
	$registerHoverProvider(handle: number, selector: ISerializedDocumentFilter[]): void;
	$registerDocumentHighlightProvider(handle: number, selector: ISerializedDocumentFilter[]): void;
	$registerReferenceSupport(handle: number, selector: ISerializedDocumentFilter[]): void;
274
	$registerQuickFixSupport(handle: number, selector: ISerializedDocumentFilter[], supportedKinds?: string[]): void;
A
Alex Dima 已提交
275 276 277
	$registerDocumentFormattingSupport(handle: number, selector: ISerializedDocumentFilter[]): void;
	$registerRangeFormattingSupport(handle: number, selector: ISerializedDocumentFilter[]): void;
	$registerOnTypeFormattingSupport(handle: number, selector: ISerializedDocumentFilter[], autoFormatTriggerCharacters: string[]): void;
278
	$registerNavigateTypeSupport(handle: number): void;
A
Alex Dima 已提交
279 280 281 282 283
	$registerRenameSupport(handle: number, selector: ISerializedDocumentFilter[], supportsResolveInitialValues: boolean): void;
	$registerSuggestSupport(handle: number, selector: ISerializedDocumentFilter[], triggerCharacters: string[], supportsResolveDetails: boolean): void;
	$registerSignatureHelpProvider(handle: number, selector: ISerializedDocumentFilter[], triggerCharacter: string[]): void;
	$registerDocumentLinkProvider(handle: number, selector: ISerializedDocumentFilter[]): void;
	$registerDocumentColorProvider(handle: number, selector: ISerializedDocumentFilter[]): void;
284
	$registerFoldingRangeProvider(handle: number, selector: ISerializedDocumentFilter[]): void;
285
	$setLanguageConfiguration(handle: number, languageId: string, configuration: ISerializedLanguageConfiguration): void;
286 287
}

288
export interface MainThreadLanguagesShape extends IDisposable {
289
	$getLanguages(): TPromise<string[]>;
290 291
}

292
export interface MainThreadMessageOptions {
293
	extension?: IExtensionDescription;
294
	modal?: boolean;
295 296
}

297
export interface MainThreadMessageServiceShape extends IDisposable {
298
	$showMessage(severity: Severity, message: string, options: MainThreadMessageOptions, commands: { title: string; isCloseAffordance: boolean; handle: number; }[]): Thenable<number>;
299 300
}

301
export interface MainThreadOutputServiceShape extends IDisposable {
302 303 304 305 306
	$append(channelId: string, label: string, value: string): TPromise<void>;
	$clear(channelId: string, label: string): TPromise<void>;
	$dispose(channelId: string, label: string): TPromise<void>;
	$reveal(channelId: string, label: string, preserveFocus: boolean): TPromise<void>;
	$close(channelId: string): TPromise<void>;
307 308
}

309
export interface MainThreadProgressShape extends IDisposable {
310

311 312 313
	$startProgress(handle: number, options: IProgressOptions): void;
	$progressReport(handle: number, message: IProgressStep): void;
	$progressEnd(handle: number): void;
314 315
}

316
export interface MainThreadTerminalServiceShape extends IDisposable {
317
	$createTerminal(name?: string, shellPath?: string, shellArgs?: string[], cwd?: string, env?: { [key: string]: string }, waitOnExit?: boolean): TPromise<number>;
318
	$createTerminalRenderer(name: string): TPromise<number>;
319 320 321 322
	$dispose(terminalId: number): void;
	$hide(terminalId: number): void;
	$sendText(terminalId: number, text: string, addNewLine: boolean): void;
	$show(terminalId: number, preserveFocus: boolean): void;
D
Daniel Imms 已提交
323
	$registerOnDataListener(terminalId: number): void;
324

325
	// Process
326 327 328
	$sendProcessTitle(terminalId: number, title: string): void;
	$sendProcessData(terminalId: number, data: string): void;
	$sendProcessPid(terminalId: number, pid: number): void;
D
Daniel Imms 已提交
329
	$sendProcessExit(terminalId: number, exitCode: number): void;
330 331 332

	// Renderer
	$terminalRendererSetName(terminalId: number, name: string): void;
D
Daniel Imms 已提交
333
	$terminalRendererSetDimensions(terminalId: number, dimensions: ITerminalDimensions): void;
334
	$terminalRendererWrite(terminalId: number, text: string): void;
D
Daniel Imms 已提交
335
	$terminalRendererRegisterOnInputListener(terminalId: number): void;
D
Daniel Imms 已提交
336 337
}

C
Christof Marti 已提交
338 339 340 341 342
export interface TransferQuickPickItems extends IQuickPickItem {
	handle: number;
}

export interface TransferQuickInputButton extends IQuickInputButton {
343 344
	handle: number;
}
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368

export type TransferQuickInput = TransferQuickPick | TransferInputBox;

export interface BaseTransferQuickInput {

	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 已提交
369
	buttons?: TransferQuickInputButton[];
370

C
Christof Marti 已提交
371
	items?: TransferQuickPickItems[];
372

373 374 375 376
	activeItems?: number[];

	selectedItems?: number[];

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
	canSelectMany?: boolean;

	ignoreFocusOut?: boolean;

	matchOnDescription?: boolean;

	matchOnDetail?: boolean;
}

export interface TransferInputBox extends BaseTransferQuickInput {

	type?: 'inputBox';

	value?: string;

	placeholder?: string;

	password?: boolean;

C
Christof Marti 已提交
396
	buttons?: TransferQuickInputButton[];
397 398 399 400 401 402

	prompt?: string;

	validationMessage?: string;
}

403
export interface MainThreadQuickOpenShape extends IDisposable {
J
Joao Moreno 已提交
404
	$show(options: IPickOptions<TransferQuickPickItems>): TPromise<number | number[]>;
C
Christof Marti 已提交
405
	$setItems(items: TransferQuickPickItems[]): TPromise<any>;
406
	$setError(error: Error): TPromise<any>;
407 408 409
	$input(options: vscode.InputBoxOptions, validateInput: boolean): TPromise<string>;
	$createOrUpdate(params: TransferQuickInput): TPromise<void>;
	$dispose(id: number): TPromise<void>;
410 411
}

412
export interface MainThreadStatusBarShape extends IDisposable {
413
	$setEntry(id: number, extensionId: string, text: string, tooltip: string, command: string, color: string | ThemeColor, alignment: MainThreadStatusBarAlignment, priority: number): void;
414
	$dispose(id: number): void;
415 416
}

417
export interface MainThreadStorageShape extends IDisposable {
418
	$getValue<T>(shared: boolean, key: string): TPromise<T>;
419
	$setValue(shared: boolean, key: string, value: any): TPromise<void>;
420 421
}

422
export interface MainThreadTelemetryShape extends IDisposable {
423
	$publicLog(eventName: string, data?: any): void;
424 425
}

426
export type WebviewPanelHandle = string;
M
Matt Bierner 已提交
427

M
Matt Bierner 已提交
428 429 430 431 432
export interface WebviewPanelShowOptions {
	readonly viewColumn?: EditorViewColumn;
	readonly preserveFocus?: boolean;
}

M
Matt Bierner 已提交
433
export interface MainThreadWebviewsShape extends IDisposable {
M
Matt Bierner 已提交
434
	$createWebviewPanel(handle: WebviewPanelHandle, viewType: string, title: string, showOptions: WebviewPanelShowOptions, options: vscode.WebviewPanelOptions & vscode.WebviewOptions, extensionLocation: UriComponents): void;
435
	$disposeWebview(handle: WebviewPanelHandle): void;
M
Matt Bierner 已提交
436
	$reveal(handle: WebviewPanelHandle, showOptions: WebviewPanelShowOptions): void;
437
	$setTitle(handle: WebviewPanelHandle, value: string): void;
438
	$setIconPath(handle: WebviewPanelHandle, value: { light: UriComponents, dark: UriComponents } | undefined): void;
439
	$setHtml(handle: WebviewPanelHandle, value: string): void;
440
	$setOptions(handle: WebviewPanelHandle, options: vscode.WebviewOptions): void;
M
Matt Bierner 已提交
441
	$postMessage(handle: WebviewPanelHandle, value: any): Thenable<boolean>;
442 443 444

	$registerSerializer(viewType: string): void;
	$unregisterSerializer(viewType: string): void;
M
Matt Bierner 已提交
445
}
446

M
Matt Bierner 已提交
447 448 449 450 451 452
export interface WebviewPanelViewState {
	readonly active: boolean;
	readonly visible: boolean;
	readonly position: EditorViewColumn;
}

M
Matt Bierner 已提交
453
export interface ExtHostWebviewsShape {
454
	$onMessage(handle: WebviewPanelHandle, message: any): void;
M
Matt Bierner 已提交
455
	$onDidChangeWebviewPanelViewState(handle: WebviewPanelHandle, newState: WebviewPanelViewState): void;
456
	$onDidDisposeWebviewPanel(handle: WebviewPanelHandle): Thenable<void>;
457
	$deserializeWebviewPanel(newWebviewHandle: WebviewPanelHandle, viewType: string, title: string, state: any, position: EditorViewColumn, options: vscode.WebviewOptions): Thenable<void>;
M
Matt Bierner 已提交
458 459
}

J
Joao Moreno 已提交
460
export interface MainThreadUrlsShape extends IDisposable {
J
Joao Moreno 已提交
461 462
	$registerUriHandler(handle: number, extensionId: string): TPromise<void>;
	$unregisterUriHandler(handle: number): TPromise<void>;
J
Joao Moreno 已提交
463 464 465
}

export interface ExtHostUrlsShape {
J
Joao Moreno 已提交
466
	$handleExternalUri(handle: number, uri: UriComponents): TPromise<void>;
M
Matt Bierner 已提交
467 468
}

469
export interface MainThreadWorkspaceShape extends IDisposable {
R
Rob Lourens 已提交
470 471
	$startFileSearch(includePattern: string, includeFolder: string, excludePatternOrDisregardExcludes: string | false, maxResults: number, requestId: number): Thenable<UriComponents[]>;
	$startTextSearch(query: IPatternInfo, options: IQueryOptions, requestId: number): TPromise<void>;
472 473
	$cancelSearch(requestId: number): Thenable<boolean>;
	$saveAll(includeUntitled?: boolean): Thenable<boolean>;
474
	$updateWorkspaceFolders(extensionName: string, index: number, deleteCount: number, workspaceFoldersToAdd: { uri: UriComponents, name?: string }[]): Thenable<void>;
475
}
476

J
Johannes Rieken 已提交
477 478 479 480 481
export interface IFileChangeDto {
	resource: UriComponents;
	type: FileChangeType;
}

482
export interface MainThreadFileSystemShape extends IDisposable {
483
	$registerFileSystemProvider(handle: number, scheme: string, capabilities: FileSystemProviderCapabilities): void;
484
	$unregisterProvider(handle: number): void;
J
Johannes Rieken 已提交
485
	$onFileSystemChange(handle: number, resource: IFileChangeDto[]): void;
486
}
J
Johannes Rieken 已提交
487

488
export interface MainThreadSearchShape extends IDisposable {
489 490 491
	$registerFileSearchProvider(handle: number, scheme: string): void;
	$registerTextSearchProvider(handle: number, scheme: string): void;
	$registerFileIndexProvider(handle: number, scheme: string): void;
492
	$unregisterProvider(handle: number): void;
493
	$handleFileMatch(handle: number, session: number, data: UriComponents[]): void;
R
Rob Lourens 已提交
494
	$handleTextMatch(handle: number, session: number, data: IRawFileMatch2[]): void;
495
	$handleTelemetry(eventName: string, data: any): void;
496 497
}

498
export interface MainThreadTaskShape extends IDisposable {
499
	$registerTaskProvider(handle: number): TPromise<void>;
500
	$unregisterTaskProvider(handle: number): TPromise<void>;
501
	$fetchTasks(filter?: TaskFilterDTO): TPromise<TaskDTO[]>;
502
	$executeTask(task: TaskHandleDTO | TaskDTO): TPromise<TaskExecutionDTO>;
D
Dirk Baeumer 已提交
503
	$terminateTask(id: string): TPromise<void>;
504
	$registerTaskSystem(scheme: string, info: TaskSystemInfoDTO): void;
505 506
}

507
export interface MainThreadExtensionServiceShape extends IDisposable {
508
	$localShowMessage(severity: Severity, msg: string): void;
A
Alex Dima 已提交
509
	$onExtensionActivated(extensionId: string, startup: boolean, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number, activationEvent: string): void;
510
	$onExtensionActivationFailed(extensionId: string): void;
511
	$onExtensionRuntimeError(extensionId: string, error: SerializedError): void;
A
Alex Dima 已提交
512
	$addMessage(extensionId: string, severity: Severity, message: string): void;
513 514
}

J
Joao Moreno 已提交
515
export interface SCMProviderFeatures {
J
Joao Moreno 已提交
516 517
	hasQuickDiffProvider?: boolean;
	count?: number;
518 519 520
	commitTemplate?: string;
	acceptInputCommand?: modes.Command;
	statusBarCommands?: modes.Command[];
J
Joao Moreno 已提交
521 522 523 524
}

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

J
Joao Moreno 已提交
527
export type SCMRawResource = [
528
	number /*handle*/,
529
	UriComponents /*resourceUri*/,
J
Joao Moreno 已提交
530
	string[] /*icons: light, dark*/,
531
	string /*tooltip*/,
532
	boolean /*strike through*/,
533 534
	boolean /*faded*/,

J
Joao Moreno 已提交
535 536 537
	string | undefined /*source*/,
	string | undefined /*letter*/,
	ThemeColor | null /*color*/
J
Joao Moreno 已提交
538
];
539

540 541 542
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
543 544 545
	SCMRawResource[]
];

546 547 548 549 550
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

551
export interface MainThreadSCMShape extends IDisposable {
552
	$registerSourceControl(handle: number, id: string, label: string, rootUri: UriComponents | undefined): void;
553 554
	$updateSourceControl(handle: number, features: SCMProviderFeatures): void;
	$unregisterSourceControl(handle: number): void;
J
Joao Moreno 已提交
555

556 557 558 559
	$registerGroup(sourceControlHandle: number, handle: number, id: string, label: string): void;
	$updateGroup(sourceControlHandle: number, handle: number, features: SCMGroupFeatures): void;
	$updateGroupLabel(sourceControlHandle: number, handle: number, label: string): void;
	$unregisterGroup(sourceControlHandle: number, handle: number): void;
J
Joao Moreno 已提交
560

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

J
Joao Moreno 已提交
563
	$setInputBoxValue(sourceControlHandle: number, value: string): void;
564
	$setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
565
	$setValidationProviderIsEnabled(sourceControlHandle: number, enabled: boolean): void;
J
Joao Moreno 已提交
566 567
}

568 569
export type DebugSessionUUID = string;

570
export interface MainThreadDebugServiceShape extends IDisposable {
A
Alex Dima 已提交
571 572 573 574
	$registerDebugTypes(debugTypes: string[]): void;
	$acceptDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): void;
	$acceptDAError(handle: number, name: string, message: string, stack: string): void;
	$acceptDAExit(handle: number, code: number, signal: string): void;
575
	$registerDebugConfigurationProvider(type: string, hasProvideMethod: boolean, hasResolveMethod: boolean, hasDebugAdapterExecutable: boolean, handle: number): TPromise<any>;
576
	$unregisterDebugConfigurationProvider(handle: number): TPromise<any>;
577
	$startDebugging(folder: UriComponents | undefined, nameOrConfig: string | vscode.DebugConfiguration): TPromise<boolean>;
578
	$customDebugAdapterRequest(id: DebugSessionUUID, command: string, args: any): TPromise<any>;
579
	$appendDebugConsole(value: string): TPromise<any>;
580
	$startBreakpointEvents(): TPromise<any>;
581
	$registerBreakpoints(breakpoints: (ISourceMultiBreakpointDto | IFunctionBreakpointDto)[]): TPromise<void>;
582
	$unregisterBreakpoints(breakpointIds: string[], functionBreakpointIds: string[]): TPromise<void>;
583 584
}

585 586
export interface MainThreadWindowShape extends IDisposable {
	$getWindowVisibility(): TPromise<boolean>;
587 588
}

589 590
// -- extension host

591
export interface ExtHostCommandsShape {
J
Johannes Rieken 已提交
592
	$executeContributedCommand<T>(id: string, ...args: any[]): Thenable<T>;
593
	$getContributedCommandHandlerDescriptions(): Thenable<{ [id: string]: string | ICommandHandlerDescription }>;
594 595
}

596
export interface ExtHostConfigurationShape {
597
	$acceptConfigurationChanged(data: IConfigurationData, eventData: IWorkspaceConfigurationChangeEventData): void;
598 599
}

600
export interface ExtHostDiagnosticsShape {
601 602 603

}

604
export interface ExtHostDocumentContentProvidersShape {
J
Johannes Rieken 已提交
605
	$provideTextDocumentContent(handle: number, uri: UriComponents): TPromise<string>;
606 607
}

608
export interface IModelAddedData {
609
	uri: UriComponents;
610
	versionId: number;
611 612
	lines: string[];
	EOL: string;
613 614 615
	modeId: string;
	isDirty: boolean;
}
616
export interface ExtHostDocumentsShape {
617 618 619 620
	$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;
621 622
}

623
export interface ExtHostDocumentSaveParticipantShape {
J
Johannes Rieken 已提交
624
	$participateInSave(resource: UriComponents, reason: SaveReason): Thenable<boolean[]>;
625 626
}

627 628
export interface ITextEditorAddData {
	id: string;
629
	documentUri: UriComponents;
630
	options: IResolvedTextEditorConfiguration;
A
Alex Dima 已提交
631
	selections: ISelection[];
632
	visibleRanges: IRange[];
633
	editorPosition: EditorViewColumn;
634 635
}
export interface ITextEditorPositionData {
636
	[id: string]: EditorViewColumn;
637
}
638 639 640
export interface IEditorPropertiesChangeData {
	options: IResolvedTextEditorConfiguration | null;
	selections: ISelectionChangeEvent | null;
641
	visibleRanges: IRange[] | null;
642 643 644 645 646 647
}
export interface ISelectionChangeEvent {
	selections: Selection[];
	source?: string;
}

648
export interface ExtHostEditorsShape {
649
	$acceptEditorPropertiesChanged(id: string, props: IEditorPropertiesChangeData): void;
650
	$acceptEditorPositionData(data: ITextEditorPositionData): void;
651 652
}

J
Johannes Rieken 已提交
653
export interface IDocumentsAndEditorsDelta {
654
	removedDocuments?: UriComponents[];
J
Johannes Rieken 已提交
655 656 657 658 659 660
	addedDocuments?: IModelAddedData[];
	removedEditors?: string[];
	addedEditors?: ITextEditorAddData[];
	newActiveEditor?: string;
}

661 662
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
663 664
}

665
export interface ExtHostTreeViewsShape {
666
	$getChildren(treeViewId: string, treeItemHandle?: string): TPromise<ITreeItem[]>;
667
	$setExpanded(treeViewId: string, treeItemHandle: string, expanded: boolean): void;
668
	$setSelection(treeViewId: string, treeItemHandles: string[]): void;
669
	$setVisible(treeViewId: string, visible: boolean): void;
S
Sandeep Somavarapu 已提交
670 671
}

672 673
export interface ExtHostWorkspaceShape {
	$acceptWorkspaceData(workspace: IWorkspaceData): void;
R
Rob Lourens 已提交
674
	$handleTextSearchResult(result: IRawFileMatch2, requestId: number): void;
675
}
676

677
export interface ExtHostFileSystemShape {
J
Johannes Rieken 已提交
678
	$stat(handle: number, resource: UriComponents): TPromise<IStat>;
679
	$readdir(handle: number, resource: UriComponents): TPromise<[string, FileType][]>;
680 681
	$readFile(handle: number, resource: UriComponents): TPromise<string>;
	$writeFile(handle: number, resource: UriComponents, base64Encoded: string, opts: FileWriteOptions): TPromise<void>;
682 683 684
	$rename(handle: number, resource: UriComponents, target: UriComponents, opts: FileOverwriteOptions): TPromise<void>;
	$copy(handle: number, resource: UriComponents, target: UriComponents, opts: FileOverwriteOptions): TPromise<void>;
	$mkdir(handle: number, resource: UriComponents): TPromise<void>;
685
	$delete(handle: number, resource: UriComponents, opts: FileDeleteOptions): TPromise<void>;
686 687
	$watch(handle: number, session: number, resource: UriComponents, opts: IWatchOptions): void;
	$unwatch(handle: number, session: number): void;
688
}
689

690
export interface ExtHostSearchShape {
691
	$provideFileSearchResults(handle: number, session: number, query: IRawSearchQuery): TPromise<ISearchCompleteStats>;
692
	$clearCache(handle: number, cacheKey: string): TPromise<void>;
693
	$provideTextSearchResults(handle: number, session: number, pattern: IPatternInfo, query: IRawSearchQuery): TPromise<ISearchCompleteStats>;
694 695
}

696 697
export interface ExtHostExtensionServiceShape {
	$activateByEvent(activationEvent: string): TPromise<void>;
698 699 700
}

export interface FileSystemEvents {
J
Johannes Rieken 已提交
701 702 703
	created: UriComponents[];
	changed: UriComponents[];
	deleted: UriComponents[];
704
}
705
export interface ExtHostFileSystemEventServiceShape {
706
	$onFileEvent(events: FileSystemEvents): void;
707
	$onFileRename(oldUri: UriComponents, newUri: UriComponents): void;
708
	$onWillRename(oldUri: UriComponents, newUri: UriComponents): TPromise<any>;
709 710
}

J
Johannes Rieken 已提交
711 712 713 714 715
export interface ObjectIdentifier {
	$ident: number;
}

export namespace ObjectIdentifier {
716
	export const name = '$ident';
J
Johannes Rieken 已提交
717
	export function mixin<T>(obj: T, id: number): T & ObjectIdentifier {
718
		Object.defineProperty(obj, name, { value: id, enumerable: true });
J
Johannes Rieken 已提交
719 720
		return <T & ObjectIdentifier>obj;
	}
721 722
	export function of(obj: any): number {
		return obj[name];
J
Johannes Rieken 已提交
723 724 725
	}
}

726 727
export interface ExtHostHeapServiceShape {
	$onGarbageCollection(ids: number[]): void;
728
}
729
export interface IRawColorInfo {
J
Joao Moreno 已提交
730
	color: [number, number, number, number];
731 732 733
	range: IRange;
}

734 735 736 737 738 739 740 741 742 743
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;
	}
}

export interface SuggestionDto extends modes.ISuggestion {
744 745 746 747
	_id: number;
	_parentId: number;
}

748 749
export interface SuggestResultDto extends IdObject {
	suggestions: SuggestionDto[];
750 751 752
	incomplete?: boolean;
}

753 754 755
export interface LocationDto {
	uri: UriComponents;
	range: IRange;
756 757
}

M
Matt Bierner 已提交
758 759 760 761 762 763 764
export interface DefinitionLinkDto {
	origin?: IRange;
	uri: UriComponents;
	range: IRange;
	selectionRange?: IRange;
}

765
export interface WorkspaceSymbolDto extends IdObject {
766 767 768 769 770 771 772
	name: string;
	containerName?: string;
	kind: modes.SymbolKind;
	location: LocationDto;
}

export interface WorkspaceSymbolsDto extends IdObject {
773
	symbols: WorkspaceSymbolDto[];
774 775
}

776 777 778
export interface ResourceFileEditDto {
	oldUri: UriComponents;
	newUri: UriComponents;
779
	options: IFileOperationOptions;
780 781 782
}

export interface ResourceTextEditDto {
783
	resource: UriComponents;
784 785
	modelVersionId?: number;
	edits: modes.TextEdit[];
786 787
}

788
export interface WorkspaceEditDto {
789 790 791
	edits: (ResourceFileEditDto | ResourceTextEditDto)[];

	// todo@joh reject should go into rename
792 793 794
	rejectReason?: string;
}

795 796 797 798 799 800 801 802 803 804 805 806 807 808
export function reviveWorkspaceEditDto(data: WorkspaceEditDto): modes.WorkspaceEdit {
	if (data && data.edits) {
		for (const edit of data.edits) {
			if (typeof (<ResourceTextEditDto>edit).resource === 'object') {
				(<ResourceTextEditDto>edit).resource = URI.revive((<ResourceTextEditDto>edit).resource);
			} else {
				(<ResourceFileEditDto>edit).newUri = URI.revive((<ResourceFileEditDto>edit).newUri);
				(<ResourceFileEditDto>edit).oldUri = URI.revive((<ResourceFileEditDto>edit).oldUri);
			}
		}
	}
	return <modes.WorkspaceEdit>data;
}

809 810
export interface CodeActionDto {
	title: string;
811
	edit?: WorkspaceEditDto;
812 813
	diagnostics?: IMarkerData[];
	command?: modes.Command;
J
Johannes Rieken 已提交
814
	kind?: string;
815
}
816

817
export interface ExtHostLanguageFeaturesShape {
818
	$provideDocumentSymbols(handle: number, resource: UriComponents): TPromise<modes.DocumentSymbol[]>;
819 820
	$provideCodeLenses(handle: number, resource: UriComponents): TPromise<modes.ICodeLensSymbol[]>;
	$resolveCodeLens(handle: number, resource: UriComponents, symbol: modes.ICodeLensSymbol): TPromise<modes.ICodeLensSymbol>;
M
Matt Bierner 已提交
821
	$provideDefinition(handle: number, resource: UriComponents, position: IPosition): TPromise<DefinitionLinkDto[]>;
M
Matt Bierner 已提交
822 823
	$provideImplementation(handle: number, resource: UriComponents, position: IPosition): TPromise<DefinitionLinkDto[]>;
	$provideTypeDefinition(handle: number, resource: UriComponents, position: IPosition): TPromise<DefinitionLinkDto[]>;
824 825
	$provideHover(handle: number, resource: UriComponents, position: IPosition): TPromise<modes.Hover>;
	$provideDocumentHighlights(handle: number, resource: UriComponents, position: IPosition): TPromise<modes.DocumentHighlight[]>;
826
	$provideReferences(handle: number, resource: UriComponents, position: IPosition, context: modes.ReferenceContext): TPromise<LocationDto[]>;
827
	$provideCodeActions(handle: number, resource: UriComponents, rangeOrSelection: IRange | ISelection, context: modes.CodeActionContext): TPromise<CodeActionDto[]>;
828 829 830
	$provideDocumentFormattingEdits(handle: number, resource: UriComponents, options: modes.FormattingOptions): TPromise<ISingleEditOperation[]>;
	$provideDocumentRangeFormattingEdits(handle: number, resource: UriComponents, range: IRange, options: modes.FormattingOptions): TPromise<ISingleEditOperation[]>;
	$provideOnTypeFormattingEdits(handle: number, resource: UriComponents, position: IPosition, ch: string, options: modes.FormattingOptions): TPromise<ISingleEditOperation[]>;
831
	$provideWorkspaceSymbols(handle: number, search: string): TPromise<WorkspaceSymbolsDto>;
832
	$resolveWorkspaceSymbol(handle: number, symbol: WorkspaceSymbolDto): TPromise<WorkspaceSymbolDto>;
833
	$releaseWorkspaceSymbols(handle: number, id: number): void;
834
	$provideRenameEdits(handle: number, resource: UriComponents, position: IPosition, newName: string): TPromise<WorkspaceEditDto>;
835
	$resolveRenameLocation(handle: number, resource: UriComponents, position: IPosition): TPromise<modes.RenameLocation>;
836
	$provideCompletionItems(handle: number, resource: UriComponents, position: IPosition, context: modes.SuggestContext): TPromise<SuggestResultDto>;
837
	$resolveCompletionItem(handle: number, resource: UriComponents, position: IPosition, suggestion: modes.ISuggestion): TPromise<modes.ISuggestion>;
838
	$releaseCompletionItems(handle: number, id: number): void;
839 840
	$provideSignatureHelp(handle: number, resource: UriComponents, position: IPosition): TPromise<modes.SignatureHelp>;
	$provideDocumentLinks(handle: number, resource: UriComponents): TPromise<modes.ILink[]>;
841
	$resolveDocumentLink(handle: number, link: modes.ILink): TPromise<modes.ILink>;
842 843
	$provideDocumentColors(handle: number, resource: UriComponents): TPromise<IRawColorInfo[]>;
	$provideColorPresentations(handle: number, resource: UriComponents, colorInfo: IRawColorInfo): TPromise<modes.IColorPresentation[]>;
844
	$provideFoldingRanges(handle: number, resource: UriComponents, context: modes.FoldingContext): TPromise<modes.FoldingRange[]>;
845 846
}

847 848 849
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
	$validateInput(input: string): TPromise<string>;
850 851 852
	$onDidChangeActive(sessionId: number, handles: number[]): void;
	$onDidChangeSelection(sessionId: number, handles: number[]): void;
	$onDidAccept(sessionId: number): void;
853
	$onDidChangeValue(sessionId: number, value: string): void;
C
Christof Marti 已提交
854
	$onDidTriggerButton(sessionId: number, handle: number): void;
855
	$onDidHide(sessionId: number): void;
856 857
}

858 859 860 861 862 863 864 865
export interface ShellLaunchConfigDto {
	name?: string;
	executable?: string;
	args?: string[] | string;
	cwd?: string;
	env?: { [key: string]: string };
}

866 867
export interface ExtHostTerminalServiceShape {
	$acceptTerminalClosed(id: number): void;
868
	$acceptTerminalOpened(id: number, name: string): void;
869
	$acceptActiveTerminalChanged(id: number | null): void;
870
	$acceptTerminalProcessId(id: number, processId: number): void;
A
Alex Dima 已提交
871
	$acceptTerminalProcessData(id: number, data: string): void;
D
Daniel Imms 已提交
872
	$acceptTerminalRendererInput(id: number, data: string): void;
D
Daniel Imms 已提交
873
	$acceptTerminalRendererDimensions(id: number, cols: number, rows: number): void;
874
	$createProcess(id: number, shellLaunchConfig: ShellLaunchConfigDto, cols: number, rows: number): void;
D
Daniel Imms 已提交
875 876 877
	$acceptProcessInput(id: number, data: string): void;
	$acceptProcessResize(id: number, cols: number, rows: number): void;
	$acceptProcessShutdown(id: number): void;
878 879
}

880
export interface ExtHostSCMShape {
881
	$provideOriginalResource(sourceControlHandle: number, uri: UriComponents): TPromise<UriComponents>;
J
Joao Moreno 已提交
882
	$onInputBoxValueChange(sourceControlHandle: number, value: string): TPromise<void>;
883
	$executeResourceCommand(sourceControlHandle: number, groupHandle: number, handle: number): TPromise<void>;
884
	$validateInput(sourceControlHandle: number, value: string, cursorPosition: number): TPromise<[string, number] | undefined>;
J
Joao Moreno 已提交
885 886
}

887
export interface ExtHostTaskShape {
888
	$provideTasks(handle: number, validTypes: { [key: string]: boolean; }): TPromise<TaskSet>;
889 890 891 892
	$onDidStartTask(execution: TaskExecutionDTO): void;
	$onDidStartTaskProcess(value: TaskProcessStartedDTO): void;
	$onDidEndTaskProcess(value: TaskProcessEndedDTO): void;
	$OnDidEndTask(execution: TaskExecutionDTO): void;
893
	$resolveVariables(workspaceFolder: UriComponents, variables: string[]): TPromise<any>;
894 895
}

896 897
export interface IBreakpointDto {
	type: string;
898
	id?: string;
899 900 901
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
902 903 904 905 906
	logMessage?: string;
}

export interface IFunctionBreakpointDto extends IBreakpointDto {
	type: 'function';
907
	functionName: string;
908 909
}

910
export interface ISourceBreakpointDto extends IBreakpointDto {
911
	type: 'source';
912
	uri: UriComponents;
913 914
	line: number;
	character: number;
915 916
}

917 918 919 920
export interface IBreakpointsDeltaDto {
	added?: (ISourceBreakpointDto | IFunctionBreakpointDto)[];
	removed?: string[];
	changed?: (ISourceBreakpointDto | IFunctionBreakpointDto)[];
921 922
}

923 924 925 926
export interface ISourceMultiBreakpointDto {
	type: 'sourceMulti';
	uri: UriComponents;
	lines: {
927
		id: string;
928 929 930
		enabled: boolean;
		condition?: string;
		hitCondition?: string;
931
		logMessage?: string;
932 933 934
		line: number;
		character: number;
	}[];
935 936
}

937
export interface ExtHostDebugServiceShape {
A
Andre Weinand 已提交
938
	$substituteVariables(folder: UriComponents | undefined, config: IConfig): TPromise<IConfig>;
939
	$runInTerminal(args: DebugProtocol.RunInTerminalRequestArguments, config: ITerminalSettings): TPromise<void>;
A
Andre Weinand 已提交
940
	$startDASession(handle: number, debugType: string, adapterExecutableInfo: IAdapterExecutable | null, debugPort: number): TPromise<void>;
941 942
	$stopDASession(handle: number): TPromise<void>;
	$sendDAMessage(handle: number, message: DebugProtocol.ProtocolMessage): TPromise<void>;
943 944
	$resolveDebugConfiguration(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig): TPromise<IConfig>;
	$provideDebugConfigurations(handle: number, folder: UriComponents | undefined): TPromise<IConfig[]>;
945
	$debugAdapterExecutable(handle: number, folder: UriComponents | undefined): TPromise<IAdapterExecutable>;
946 947 948 949
	$acceptDebugSessionStarted(id: DebugSessionUUID, type: string, name: string): void;
	$acceptDebugSessionTerminated(id: DebugSessionUUID, type: string, name: string): void;
	$acceptDebugSessionActiveChanged(id: DebugSessionUUID | undefined, type?: string, name?: string): void;
	$acceptDebugSessionCustomEvent(id: DebugSessionUUID, type: string, name: string, event: any): void;
950
	$acceptBreakpointsDelta(delat: IBreakpointsDeltaDto): void;
951 952
}

953

954 955 956 957 958 959
export interface DecorationRequest {
	readonly id: number;
	readonly handle: number;
	readonly uri: UriComponents;
}

960
export type DecorationData = [number, boolean, string, string, ThemeColor, string];
961
export type DecorationReply = { [id: number]: DecorationData };
962 963

export interface ExtHostDecorationsShape {
964
	$provideDecorations(requests: DecorationRequest[]): TPromise<DecorationReply>;
965 966
}

967 968
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
969 970
}

S
Sandeep Somavarapu 已提交
971
export interface ExtHostLogServiceShape {
A
Alex Dima 已提交
972
	$setLevel(level: LogLevel): void;
S
Sandeep Somavarapu 已提交
973 974
}

975 976 977 978
export interface ExtHostProgressShape {
	$acceptProgressCanceled(handle: number): void;
}

M
Matt Bierner 已提交
979
export interface ExtHostCommentsShape {
980
	$provideDocumentComments(handle: number, document: UriComponents): TPromise<modes.CommentInfo>;
981 982
	$createNewCommentThread?(handle: number, document: UriComponents, range: IRange, text: string): TPromise<modes.CommentThread>;
	$replyToCommentThread?(handle: number, document: UriComponents, range: IRange, commentThread: modes.CommentThread, text: string): TPromise<modes.CommentThread>;
983
	$provideWorkspaceComments(handle: number): TPromise<modes.CommentThread[]>;
M
Matt Bierner 已提交
984 985
}

986 987 988
// --- proxy identifiers

export const MainContext = {
989
	MainThreadCommands: <ProxyIdentifier<MainThreadCommandsShape>>createMainId<MainThreadCommandsShape>('MainThreadCommands'),
M
Matt Bierner 已提交
990
	MainThreadComments: createMainId<MainThreadCommentsShape>('MainThreadComments'),
991
	MainThreadConfiguration: createMainId<MainThreadConfigurationShape>('MainThreadConfiguration'),
992
	MainThreadDebugService: createMainId<MainThreadDebugServiceShape>('MainThreadDebugService'),
993 994 995 996
	MainThreadDecorations: createMainId<MainThreadDecorationsShape>('MainThreadDecorations'),
	MainThreadDiagnostics: createMainId<MainThreadDiagnosticsShape>('MainThreadDiagnostics'),
	MainThreadDialogs: createMainId<MainThreadDiaglogsShape>('MainThreadDiaglogs'),
	MainThreadDocuments: createMainId<MainThreadDocumentsShape>('MainThreadDocuments'),
997
	MainThreadDocumentContentProviders: createMainId<MainThreadDocumentContentProvidersShape>('MainThreadDocumentContentProviders'),
998
	MainThreadTextEditors: createMainId<MainThreadTextEditorsShape>('MainThreadTextEditors'),
999 1000
	MainThreadErrors: createMainId<MainThreadErrorsShape>('MainThreadErrors'),
	MainThreadTreeViews: createMainId<MainThreadTreeViewsShape>('MainThreadTreeViews'),
1001
	MainThreadLanguageFeatures: createMainId<MainThreadLanguageFeaturesShape>('MainThreadLanguageFeatures'),
1002
	MainThreadLanguages: createMainId<MainThreadLanguagesShape>('MainThreadLanguages'),
1003
	MainThreadMessageService: createMainId<MainThreadMessageServiceShape>('MainThreadMessageService'),
1004 1005
	MainThreadOutputService: createMainId<MainThreadOutputServiceShape>('MainThreadOutputService'),
	MainThreadProgress: createMainId<MainThreadProgressShape>('MainThreadProgress'),
1006
	MainThreadQuickOpen: createMainId<MainThreadQuickOpenShape>('MainThreadQuickOpen'),
1007
	MainThreadStatusBar: createMainId<MainThreadStatusBarShape>('MainThreadStatusBar'),
1008
	MainThreadStorage: createMainId<MainThreadStorageShape>('MainThreadStorage'),
1009
	MainThreadTelemetry: createMainId<MainThreadTelemetryShape>('MainThreadTelemetry'),
1010
	MainThreadTerminalService: createMainId<MainThreadTerminalServiceShape>('MainThreadTerminalService'),
M
Matt Bierner 已提交
1011
	MainThreadWebviews: createMainId<MainThreadWebviewsShape>('MainThreadWebviews'),
J
Joao Moreno 已提交
1012
	MainThreadUrls: createMainId<MainThreadUrlsShape>('MainThreadUrls'),
1013
	MainThreadWorkspace: createMainId<MainThreadWorkspaceShape>('MainThreadWorkspace'),
1014
	MainThreadFileSystem: createMainId<MainThreadFileSystemShape>('MainThreadFileSystem'),
1015
	MainThreadExtensionService: createMainId<MainThreadExtensionServiceShape>('MainThreadExtensionService'),
J
Joao Moreno 已提交
1016
	MainThreadSCM: createMainId<MainThreadSCMShape>('MainThreadSCM'),
1017
	MainThreadSearch: createMainId<MainThreadSearchShape>('MainThreadSearch'),
1018
	MainThreadTask: createMainId<MainThreadTaskShape>('MainThreadTask'),
1019
	MainThreadWindow: createMainId<MainThreadWindowShape>('MainThreadWindow'),
1020 1021 1022
};

export const ExtHostContext = {
1023
	ExtHostCommands: createExtId<ExtHostCommandsShape>('ExtHostCommands'),
1024
	ExtHostConfiguration: createExtId<ExtHostConfigurationShape>('ExtHostConfiguration'),
1025
	ExtHostDiagnostics: createExtId<ExtHostDiagnosticsShape>('ExtHostDiagnostics'),
1026
	ExtHostDebugService: createExtId<ExtHostDebugServiceShape>('ExtHostDebugService'),
J
Johannes Rieken 已提交
1027
	ExtHostDecorations: createExtId<ExtHostDecorationsShape>('ExtHostDecorations'),
1028
	ExtHostDocumentsAndEditors: createExtId<ExtHostDocumentsAndEditorsShape>('ExtHostDocumentsAndEditors'),
1029
	ExtHostDocuments: createExtId<ExtHostDocumentsShape>('ExtHostDocuments'),
J
Johannes Rieken 已提交
1030
	ExtHostDocumentContentProviders: createExtId<ExtHostDocumentContentProvidersShape>('ExtHostDocumentContentProviders'),
J
Johannes Rieken 已提交
1031
	ExtHostDocumentSaveParticipant: createExtId<ExtHostDocumentSaveParticipantShape>('ExtHostDocumentSaveParticipant'),
J
Johannes Rieken 已提交
1032
	ExtHostEditors: createExtId<ExtHostEditorsShape>('ExtHostEditors'),
1033
	ExtHostTreeViews: createExtId<ExtHostTreeViewsShape>('ExtHostTreeViews'),
J
Johannes Rieken 已提交
1034
	ExtHostFileSystem: createExtId<ExtHostFileSystemShape>('ExtHostFileSystem'),
J
Johannes Rieken 已提交
1035
	ExtHostFileSystemEventService: createExtId<ExtHostFileSystemEventServiceShape>('ExtHostFileSystemEventService'),
1036
	ExtHostHeapService: createExtId<ExtHostHeapServiceShape>('ExtHostHeapMonitor'),
1037
	ExtHostLanguageFeatures: createExtId<ExtHostLanguageFeaturesShape>('ExtHostLanguageFeatures'),
1038 1039
	ExtHostQuickOpen: createExtId<ExtHostQuickOpenShape>('ExtHostQuickOpen'),
	ExtHostExtensionService: createExtId<ExtHostExtensionServiceShape>('ExtHostExtensionService'),
1040
	ExtHostLogService: createExtId<ExtHostLogServiceShape>('ExtHostLogService'),
1041
	ExtHostTerminalService: createExtId<ExtHostTerminalServiceShape>('ExtHostTerminalService'),
J
Joao Moreno 已提交
1042
	ExtHostSCM: createExtId<ExtHostSCMShape>('ExtHostSCM'),
1043
	ExtHostSearch: createExtId<ExtHostSearchShape>('ExtHostSearch'),
1044
	ExtHostTask: createExtId<ExtHostTaskShape>('ExtHostTask'),
1045
	ExtHostWorkspace: createExtId<ExtHostWorkspaceShape>('ExtHostWorkspace'),
1046
	ExtHostWindow: createExtId<ExtHostWindowShape>('ExtHostWindow'),
1047
	ExtHostWebviews: createExtId<ExtHostWebviewsShape>('ExtHostWebviews'),
M
Matt Bierner 已提交
1048
	ExtHostProgress: createMainId<ExtHostProgressShape>('ExtHostProgress'),
1049
	ExtHostComments: createMainId<ExtHostCommentsShape>('ExtHostComments'),
P
Peng Lyu 已提交
1050
	ExtHostUrls: createExtId<ExtHostUrlsShape>('ExtHostUrls')
1051
};