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

import {
	createMainContextProxyIdentifier as createMainId,
	createExtHostContextProxyIdentifier as createExtId,
A
Alex Dima 已提交
10
	ProxyIdentifier,
11 12
	IRPCProtocol,
	ProxyType
A
Alex Dima 已提交
13
} from 'vs/workbench/services/extensions/node/proxyIdentifier';
14

15 16
import * as vscode from 'vscode';

S
Sandeep Somavarapu 已提交
17
import { UriComponents } from 'vs/base/common/uri';
18
import Severity from 'vs/base/common/severity';
19
import { TPromise } from 'vs/base/common/winjs.base';
20

21 22
import { IMarkerData } from 'vs/platform/markers/common/markers';
import { Position as EditorPosition } from 'vs/platform/editor/common/editor';
A
Alex Dima 已提交
23
import { IExtensionDescription } from 'vs/platform/extensions/common/extensions';
24 25
import { StatusbarAlignment as MainThreadStatusBarAlignment } from 'vs/platform/statusbar/common/statusbar';
import { ITelemetryInfo } from 'vs/platform/telemetry/common/telemetry';
26
import { ICommandHandlerDescription } from 'vs/platform/commands/common/commands';
J
Johannes Rieken 已提交
27
import { IProgressOptions, IProgressStep } from 'vs/platform/progress/common/progress';
28 29 30 31

import * as editorCommon from 'vs/editor/common/editorCommon';
import * as modes from 'vs/editor/common/modes';

S
Sandeep Somavarapu 已提交
32
import { IConfigurationData, ConfigurationTarget, IConfigurationModel } from 'vs/platform/configuration/common/configuration';
33
import { IConfig } from 'vs/workbench/parts/debug/common/debug';
34

J
Johannes Rieken 已提交
35
import { IPickOpenEntry, IPickOptions } from 'vs/platform/quickOpen/common/quickOpen';
36
import { SaveReason } from 'vs/workbench/services/textfile/common/textfiles';
37
import { TextEditorCursorStyle } from 'vs/editor/common/config/editorOptions';
38
import { EndOfLine, TextEditorLineNumbersStyle } from 'vs/workbench/api/node/extHostTypes';
39

40

41
import { TaskSet } from 'vs/workbench/parts/tasks/common/tasks';
42
import { IModelChangedEvent } from 'vs/editor/common/model/mirrorTextModel';
43 44
import { IPosition } from 'vs/editor/common/core/position';
import { IRange } from 'vs/editor/common/core/range';
45
import { ISelection, Selection } from 'vs/editor/common/core/selection';
46

47
import { ITreeItem } from 'vs/workbench/common/views';
B
Benjamin Pasero 已提交
48
import { ThemeColor } from 'vs/platform/theme/common/themeService';
B
Benjamin Pasero 已提交
49 50
import { IDisposable } from 'vs/base/common/lifecycle';
import { SerializedError } from 'vs/base/common/errors';
J
Johannes Rieken 已提交
51
import { IStat, FileChangeType } from 'vs/platform/files/common/files';
S
Sandeep Somavarapu 已提交
52
import { ConfigurationScope } from 'vs/platform/configuration/common/configurationRegistry';
J
Joao Moreno 已提交
53
import { ParsedArgs } from 'vs/platform/environment/common/environment';
54
import { CommentRule, CharacterPair, EnterAction } from 'vs/editor/common/modes/languageConfiguration';
A
Alex Dima 已提交
55
import { EndOfLineSequence, ISingleEditOperation } from 'vs/editor/common/model';
56
import { ILineMatch, IPatternInfo } from 'vs/platform/search/common/search';
S
Sandeep Somavarapu 已提交
57

58
export interface IEnvironment {
59
	isExtensionDevelopmentDebug: boolean;
60 61
	enableProposedApiForAll: boolean;
	enableProposedApiFor: string | string[];
J
Johannes Rieken 已提交
62
	appRoot: string;
63 64 65 66 67 68 69
	appSettingsHome: string;
	disableExtensions: boolean;
	userExtensionsHome: string;
	extensionDevelopmentPath: string;
	extensionTestsPath: string;
}

70 71
export interface IWorkspaceData {
	id: string;
72
	name: string;
73
	folders: { uri: UriComponents, name: string, index: number }[];
74 75
}

76 77 78
export interface IInitData {
	parentPid: number;
	environment: IEnvironment;
79
	workspace: IWorkspaceData;
80
	extensions: IExtensionDescription[];
S
Sandeep Somavarapu 已提交
81
	configuration: IConfigurationInitData;
82
	telemetryInfo: ITelemetryInfo;
83
	windowId: number;
J
Joao Moreno 已提交
84 85
	args: ParsedArgs;
	execPath: string;
86 87
}

S
Sandeep Somavarapu 已提交
88 89 90 91
export interface IConfigurationInitData extends IConfigurationData {
	configurationScopes: ConfigurationScope[];
}

92
export interface IWorkspaceConfigurationChangeEventData {
S
Sandeep Somavarapu 已提交
93 94
	changedConfiguration: IConfigurationModel;
	changedConfigurationByResource: { [folder: string]: IConfigurationModel };
95 96
}

A
Alex Dima 已提交
97
export interface IExtHostContext extends IRPCProtocol {
98 99
}

A
Alex Dima 已提交
100
export interface IMainContext extends IRPCProtocol {
101 102
}

103 104
// --- main thread

105
export interface MainThreadCommandsShape extends IDisposable {
106 107
	$registerCommand(id: string): void;
	$unregisterCommand(id: string): void;
108 109
	$executeCommand<T>(id: string, args: any[]): Thenable<T>;
	$getCommands(): Thenable<string[]>;
110 111
}

112
export interface MainThreadConfigurationShape extends IDisposable {
113 114
	$updateConfigurationOption(target: ConfigurationTarget, key: string, value: any, resource: UriComponents): TPromise<void>;
	$removeConfigurationOption(target: ConfigurationTarget, key: string, resource: UriComponents): TPromise<void>;
115 116
}

117
export interface MainThreadDiagnosticsShape extends IDisposable {
118 119
	$changeMany(owner: string, entries: [UriComponents, IMarkerData[]][]): void;
	$clear(owner: string): void;
120 121
}

122
export interface MainThreadDialogOpenOptions {
123
	defaultUri?: UriComponents;
124
	openLabel?: string;
125 126 127
	canSelectFiles?: boolean;
	canSelectFolders?: boolean;
	canSelectMany?: boolean;
J
Johannes Rieken 已提交
128
	filters?: { [name: string]: string[] };
129 130
}

131
export interface MainThreadDialogSaveOptions {
132
	defaultUri?: UriComponents;
133
	saveLabel?: string;
J
Johannes Rieken 已提交
134
	filters?: { [name: string]: string[] };
135 136
}

137
export interface MainThreadDiaglogsShape extends IDisposable {
138 139
	$showOpenDialog(options: MainThreadDialogOpenOptions): Thenable<string[]>;
	$showSaveDialog(options: MainThreadDialogSaveOptions): Thenable<string>;
140 141
}

142 143 144
export interface MainThreadDecorationsShape extends IDisposable {
	$registerDecorationProvider(handle: number, label: string): void;
	$unregisterDecorationProvider(handle: number): void;
145
	$onDidChange(handle: number, resources: UriComponents[]): void;
146 147
}

148
export interface MainThreadDocumentContentProvidersShape extends IDisposable {
149 150
	$registerTextContentProvider(handle: number, scheme: string): void;
	$unregisterTextContentProvider(handle: number): void;
151
	$onVirtualDocumentChange(uri: UriComponents, value: string): void;
152 153
}

154
export interface MainThreadDocumentsShape extends IDisposable {
J
Johannes Rieken 已提交
155
	$tryCreateDocument(options?: { language?: string; content?: string; }): TPromise<UriComponents>;
156
	$tryOpenDocument(uri: UriComponents): TPromise<void>;
157
	$trySaveDocument(uri: UriComponents): TPromise<boolean>;
158 159
}

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
export interface ISelectionChangeEvent {
	selections: Selection[];
	source?: string;
}

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;
}



197 198 199 200
export interface ITextDocumentShowOptions {
	position?: EditorPosition;
	preserveFocus?: boolean;
	pinned?: boolean;
201
	selection?: IRange;
202 203
}

204
export interface IWorkspaceResourceEdit {
205
	resource: UriComponents;
206 207 208 209
	modelVersionId?: number;
	edits: {
		range?: IRange;
		newText: string;
210
		newEol?: EndOfLineSequence;
211 212 213
	}[];
}

214
export interface MainThreadEditorsShape extends IDisposable {
215
	$tryShowTextDocument(resource: UriComponents, options: ITextDocumentShowOptions): TPromise<string>;
216 217 218 219
	$registerTextEditorDecorationType(key: string, options: editorCommon.IDecorationRenderOptions): void;
	$removeTextEditorDecorationType(key: string): void;
	$tryShowEditor(id: string, position: EditorPosition): TPromise<void>;
	$tryHideEditor(id: string): TPromise<void>;
220 221 222 223 224
	$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>;
225
	$tryApplyEdits(id: string, modelVersionId: number, edits: ISingleEditOperation[], opts: IApplyEditsOptions): TPromise<boolean>;
226
	$tryApplyWorkspaceEdit(workspaceResourceEdits: IWorkspaceResourceEdit[]): TPromise<boolean>;
227
	$tryInsertSnippet(id: string, template: string, selections: IRange[], opts: IUndoStopOptions): TPromise<boolean>;
228
	$getDiffInformation(id: string): TPromise<editorCommon.ILineChange[]>;
229 230
}

231
export interface MainThreadTreeViewsShape extends IDisposable {
232
	$registerView(treeViewId: string): void;
S
Sandeep Somavarapu 已提交
233
	$refresh(treeViewId: string, itemsToRefresh?: { [treeItemHandle: string]: ITreeItem }): void;
234 235
}

236
export interface MainThreadErrorsShape extends IDisposable {
237
	$onUnexpectedError(err: any | SerializedError): void;
238 239
}

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
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[];
		}[];
	};
}

279
export interface MainThreadLanguageFeaturesShape extends IDisposable {
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
	$unregister(handle: number): void;
	$registerOutlineSupport(handle: number, selector: vscode.DocumentSelector): void;
	$registerCodeLensSupport(handle: number, selector: vscode.DocumentSelector, eventHandle: number): void;
	$emitCodeLensEvent(eventHandle: number, event?: any): void;
	$registerDeclaractionSupport(handle: number, selector: vscode.DocumentSelector): void;
	$registerImplementationSupport(handle: number, selector: vscode.DocumentSelector): void;
	$registerTypeDefinitionSupport(handle: number, selector: vscode.DocumentSelector): void;
	$registerHoverProvider(handle: number, selector: vscode.DocumentSelector): void;
	$registerDocumentHighlightProvider(handle: number, selector: vscode.DocumentSelector): void;
	$registerReferenceSupport(handle: number, selector: vscode.DocumentSelector): void;
	$registerQuickFixSupport(handle: number, selector: vscode.DocumentSelector): void;
	$registerDocumentFormattingSupport(handle: number, selector: vscode.DocumentSelector): void;
	$registerRangeFormattingSupport(handle: number, selector: vscode.DocumentSelector): void;
	$registerOnTypeFormattingSupport(handle: number, selector: vscode.DocumentSelector, autoFormatTriggerCharacters: string[]): void;
	$registerNavigateTypeSupport(handle: number): void;
	$registerRenameSupport(handle: number, selector: vscode.DocumentSelector): void;
	$registerSuggestSupport(handle: number, selector: vscode.DocumentSelector, triggerCharacters: string[], supportsResolveDetails: boolean): void;
	$registerSignatureHelpProvider(handle: number, selector: vscode.DocumentSelector, triggerCharacter: string[]): void;
	$registerDocumentLinkProvider(handle: number, selector: vscode.DocumentSelector): void;
	$registerDocumentColorProvider(handle: number, selector: vscode.DocumentSelector): void;
	$setLanguageConfiguration(handle: number, languageId: string, configuration: ISerializedLanguageConfiguration): void;
301 302
}

303
export interface MainThreadLanguagesShape extends IDisposable {
304
	$getLanguages(): TPromise<string[]>;
305 306
}

307
export interface MainThreadMessageOptions {
308
	extension?: IExtensionDescription;
309
	modal?: boolean;
310 311
}

312
export interface MainThreadMessageServiceShape extends IDisposable {
313
	$showMessage(severity: Severity, message: string, options: MainThreadMessageOptions, commands: { title: string; isCloseAffordance: boolean; handle: number; }[]): Thenable<number>;
314 315
}

316
export interface MainThreadOutputServiceShape extends IDisposable {
317 318 319 320 321
	$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>;
322 323
}

324
export interface MainThreadProgressShape extends IDisposable {
325

326 327 328
	$startProgress(handle: number, options: IProgressOptions): void;
	$progressReport(handle: number, message: IProgressStep): void;
	$progressEnd(handle: number): void;
329 330
}

331
export interface MainThreadTerminalServiceShape extends IDisposable {
332
	$createTerminal(name?: string, shellPath?: string, shellArgs?: string[], cwd?: string, env?: { [key: string]: string }, waitOnExit?: boolean): TPromise<number>;
333 334 335 336
	$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 已提交
337 338
}

339 340 341
export interface MyQuickPickItems extends IPickOpenEntry {
	handle: number;
}
342
export interface MainThreadQuickOpenShape extends IDisposable {
343 344 345 346
	$show(options: IPickOptions): TPromise<number>;
	$setItems(items: MyQuickPickItems[]): TPromise<any>;
	$setError(error: Error): TPromise<any>;
	$input(options: vscode.InputBoxOptions, validateInput: boolean): TPromise<string>;
347 348
}

349
export interface MainThreadStatusBarShape extends IDisposable {
350
	$setEntry(id: number, extensionId: string, text: string, tooltip: string, command: string, color: string | ThemeColor, alignment: MainThreadStatusBarAlignment, priority: number): void;
351
	$dispose(id: number): void;
352 353
}

354
export interface MainThreadStorageShape extends IDisposable {
355
	$getValue<T>(shared: boolean, key: string): TPromise<T>;
356
	$setValue(shared: boolean, key: string, value: any): TPromise<void>;
357 358
}

359
export interface MainThreadTelemetryShape extends IDisposable {
360
	$publicLog(eventName: string, data?: any): void;
361 362
}

363
export interface MainThreadWorkspaceShape extends IDisposable {
364
	$startSearch(includePattern: string, includeFolder: string, excludePattern: string, maxResults: number, requestId: number): Thenable<UriComponents[]>;
365 366
	$cancelSearch(requestId: number): Thenable<boolean>;
	$saveAll(includeUntitled?: boolean): Thenable<boolean>;
367
}
368

J
Johannes Rieken 已提交
369 370 371 372 373
export interface IFileChangeDto {
	resource: UriComponents;
	type: FileChangeType;
}

374 375
export interface MainThreadFileSystemShape extends IDisposable {
	$registerFileSystemProvider(handle: number, scheme: string): void;
376
	$unregisterFileSystemProvider(handle: number): void;
377

378
	$onDidAddFileSystemRoot(root: UriComponents): void;
J
Johannes Rieken 已提交
379
	$onFileSystemChange(handle: number, resource: IFileChangeDto[]): void;
J
Johannes Rieken 已提交
380
	$reportFileChunk(handle: number, session: number, chunk: number[] | null): void;
J
Johannes Rieken 已提交
381

382
	$handleFindMatch(handle: number, session, data: UriComponents | [UriComponents, ILineMatch]): void;
383 384
}

385
export interface MainThreadTaskShape extends IDisposable {
386 387
	$registerTaskProvider(handle: number): TPromise<any>;
	$unregisterTaskProvider(handle: number): TPromise<any>;
388 389
}

390
export interface MainThreadExtensionServiceShape extends IDisposable {
391
	$localShowMessage(severity: Severity, msg: string): void;
A
Alex Dima 已提交
392
	$onExtensionActivated(extensionId: string, startup: boolean, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number, activationEvent: string): void;
393
	$onExtensionActivationFailed(extensionId: string): void;
394
	$onExtensionRuntimeError(extensionId: string, error: SerializedError): void;
A
Alex Dima 已提交
395
	$addMessage(extensionId: string, severity: Severity, message: string): void;
396 397
}

J
Joao Moreno 已提交
398
export interface SCMProviderFeatures {
J
Joao Moreno 已提交
399 400
	hasQuickDiffProvider?: boolean;
	count?: number;
401 402 403
	commitTemplate?: string;
	acceptInputCommand?: modes.Command;
	statusBarCommands?: modes.Command[];
J
Joao Moreno 已提交
404 405 406 407
}

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

J
Joao Moreno 已提交
410
export type SCMRawResource = [
411
	number /*handle*/,
J
Joao Moreno 已提交
412
	string /*resourceUri*/,
J
Joao Moreno 已提交
413
	string[] /*icons: light, dark*/,
414
	string /*tooltip*/,
415
	boolean /*strike through*/,
416 417
	boolean /*faded*/,

J
Joao Moreno 已提交
418 419 420
	string | undefined /*source*/,
	string | undefined /*letter*/,
	ThemeColor | null /*color*/
J
Joao Moreno 已提交
421
];
422

423 424 425
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
426 427 428
	SCMRawResource[]
];

429 430 431 432 433
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

434
export interface MainThreadSCMShape extends IDisposable {
J
Joao Moreno 已提交
435
	$registerSourceControl(handle: number, id: string, label: string, rootUri: string | undefined): void;
436 437
	$updateSourceControl(handle: number, features: SCMProviderFeatures): void;
	$unregisterSourceControl(handle: number): void;
J
Joao Moreno 已提交
438

439 440 441 442
	$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 已提交
443

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

J
Joao Moreno 已提交
446
	$setInputBoxValue(sourceControlHandle: number, value: string): void;
447
	$setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
J
Joao Moreno 已提交
448
	$setLineWarningLength(sourceControlHandle: number, lineWarningLength: number): void;
J
Joao Moreno 已提交
449 450
}

451 452
export type DebugSessionUUID = string;

453
export interface MainThreadDebugServiceShape extends IDisposable {
454 455
	$registerDebugConfigurationProvider(type: string, hasProvideMethod: boolean, hasResolveMethod: boolean, handle: number): TPromise<any>;
	$unregisterDebugConfigurationProvider(handle: number): TPromise<any>;
456
	$startDebugging(folder: UriComponents | undefined, nameOrConfig: string | vscode.DebugConfiguration): TPromise<boolean>;
457
	$customDebugAdapterRequest(id: DebugSessionUUID, command: string, args: any): TPromise<any>;
458
	$appendDebugConsole(value: string): TPromise<any>;
459
	$startBreakpointEvents(): TPromise<any>;
460 461
}

462 463
export interface MainThreadWindowShape extends IDisposable {
	$getWindowVisibility(): TPromise<boolean>;
464 465
}

466 467
// -- extension host

468
export interface ExtHostCommandsShape {
J
Johannes Rieken 已提交
469
	$executeContributedCommand<T>(id: string, ...args: any[]): Thenable<T>;
470
	$getContributedCommandHandlerDescriptions(): Thenable<{ [id: string]: string | ICommandHandlerDescription }>;
471 472
}

473
export interface ExtHostConfigurationShape {
474
	$acceptConfigurationChanged(data: IConfigurationData, eventData: IWorkspaceConfigurationChangeEventData): void;
475 476
}

477
export interface ExtHostDiagnosticsShape {
478 479 480

}

481
export interface ExtHostDocumentContentProvidersShape {
J
Johannes Rieken 已提交
482
	$provideTextDocumentContent(handle: number, uri: UriComponents): TPromise<string>;
483 484
}

485
export interface IModelAddedData {
486
	uri: UriComponents;
487
	versionId: number;
488 489
	lines: string[];
	EOL: string;
490 491 492
	modeId: string;
	isDirty: boolean;
}
493 494 495 496 497
export interface ExtHostDocumentsShape {
	$acceptModelModeChanged(strURL: string, oldModeId: string, newModeId: string): void;
	$acceptModelSaved(strURL: string): void;
	$acceptDirtyStateChanged(strURL: string, isDirty: boolean): void;
	$acceptModelChanged(strURL: string, e: IModelChangedEvent, isDirty: boolean): void;
498 499
}

500
export interface ExtHostDocumentSaveParticipantShape {
J
Johannes Rieken 已提交
501
	$participateInSave(resource: UriComponents, reason: SaveReason): Thenable<boolean[]>;
502 503
}

504 505
export interface ITextEditorAddData {
	id: string;
506
	documentUri: UriComponents;
507
	options: IResolvedTextEditorConfiguration;
A
Alex Dima 已提交
508
	selections: ISelection[];
509 510 511 512 513
	editorPosition: EditorPosition;
}
export interface ITextEditorPositionData {
	[id: string]: EditorPosition;
}
514 515 516 517
export interface ExtHostEditorsShape {
	$acceptOptionsChanged(id: string, opts: IResolvedTextEditorConfiguration): void;
	$acceptSelectionsChanged(id: string, event: ISelectionChangeEvent): void;
	$acceptEditorPositionData(data: ITextEditorPositionData): void;
518 519
}

J
Johannes Rieken 已提交
520 521 522 523 524 525 526 527
export interface IDocumentsAndEditorsDelta {
	removedDocuments?: string[];
	addedDocuments?: IModelAddedData[];
	removedEditors?: string[];
	addedEditors?: ITextEditorAddData[];
	newActiveEditor?: string;
}

528 529
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
530 531
}

532 533
export interface ExtHostTreeViewsShape {
	$getElements(treeViewId: string): TPromise<ITreeItem[]>;
S
Sandeep Somavarapu 已提交
534
	$getChildren(treeViewId: string, treeItemHandle: string): TPromise<ITreeItem[]>;
S
Sandeep Somavarapu 已提交
535 536
}

537 538
export interface ExtHostWorkspaceShape {
	$acceptWorkspaceData(workspace: IWorkspaceData): void;
539
}
540

541
export interface ExtHostFileSystemShape {
J
Johannes Rieken 已提交
542 543
	$utimes(handle: number, resource: UriComponents, mtime: number, atime: number): TPromise<IStat>;
	$stat(handle: number, resource: UriComponents): TPromise<IStat>;
J
Johannes Rieken 已提交
544
	$read(handle: number, session: number, offset: number, count: number, resource: UriComponents): TPromise<number>;
J
Johannes Rieken 已提交
545 546 547 548 549 550
	$write(handle: number, resource: UriComponents, content: number[]): TPromise<void>;
	$unlink(handle: number, resource: UriComponents): TPromise<void>;
	$move(handle: number, resource: UriComponents, target: UriComponents): TPromise<IStat>;
	$mkdir(handle: number, resource: UriComponents): TPromise<IStat>;
	$readdir(handle: number, resource: UriComponents): TPromise<[UriComponents, IStat][]>;
	$rmdir(handle: number, resource: UriComponents): TPromise<void>;
J
Johannes Rieken 已提交
551
	$findFiles(handle: number, session: number, query: string): TPromise<void>;
J
Johannes Rieken 已提交
552
	$provideTextSearchResults(handle: number, session: number, pattern: IPatternInfo, include: string, exclude: string): TPromise<void>;
553 554
}

555 556
export interface ExtHostExtensionServiceShape {
	$activateByEvent(activationEvent: string): TPromise<void>;
557 558 559
}

export interface FileSystemEvents {
J
Johannes Rieken 已提交
560 561 562
	created: UriComponents[];
	changed: UriComponents[];
	deleted: UriComponents[];
563
}
564
export interface ExtHostFileSystemEventServiceShape {
565
	$onFileEvent(events: FileSystemEvents): void;
566 567
}

J
Johannes Rieken 已提交
568 569 570 571 572
export interface ObjectIdentifier {
	$ident: number;
}

export namespace ObjectIdentifier {
573
	export const name = '$ident';
J
Johannes Rieken 已提交
574
	export function mixin<T>(obj: T, id: number): T & ObjectIdentifier {
575
		Object.defineProperty(obj, name, { value: id, enumerable: true });
J
Johannes Rieken 已提交
576 577
		return <T & ObjectIdentifier>obj;
	}
578 579
	export function of(obj: any): number {
		return obj[name];
J
Johannes Rieken 已提交
580 581 582
	}
}

583 584
export interface ExtHostHeapServiceShape {
	$onGarbageCollection(ids: number[]): void;
585
}
586
export interface IRawColorInfo {
J
Joao Moreno 已提交
587
	color: [number, number, number, number];
588 589 590
	range: IRange;
}

591 592 593 594 595 596 597 598 599 600
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 {
601 602 603 604
	_id: number;
	_parentId: number;
}

605 606
export interface SuggestResultDto extends IdObject {
	suggestions: SuggestionDto[];
607 608 609
	incomplete?: boolean;
}

610 611 612
export interface LocationDto {
	uri: UriComponents;
	range: IRange;
613 614
}

615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
export interface SymbolInformationDto extends IdObject {
	name: string;
	containerName?: string;
	kind: modes.SymbolKind;
	location: LocationDto;
}

export interface WorkspaceSymbolsDto extends IdObject {
	symbols: SymbolInformationDto[];
}

export interface ResourceEditDto {
	resource: UriComponents;
	range: IRange;
	newText: string;
630 631
}

632 633 634 635 636 637 638
export interface WorkspaceEditDto {
	edits: ResourceEditDto[];
	rejectReason?: string;
}

export interface CodeActionDto {
	title: string;
639
	edit?: WorkspaceEditDto;
640 641 642
	diagnostics?: IMarkerData[];
	command?: modes.Command;
}
643

644
export interface ExtHostLanguageFeaturesShape {
645
	$provideDocumentSymbols(handle: number, resource: UriComponents): TPromise<SymbolInformationDto[]>;
646 647
	$provideCodeLenses(handle: number, resource: UriComponents): TPromise<modes.ICodeLensSymbol[]>;
	$resolveCodeLens(handle: number, resource: UriComponents, symbol: modes.ICodeLensSymbol): TPromise<modes.ICodeLensSymbol>;
648 649 650
	$provideDefinition(handle: number, resource: UriComponents, position: IPosition): TPromise<LocationDto | LocationDto[]>;
	$provideImplementation(handle: number, resource: UriComponents, position: IPosition): TPromise<LocationDto | LocationDto[]>;
	$provideTypeDefinition(handle: number, resource: UriComponents, position: IPosition): TPromise<LocationDto | LocationDto[]>;
651 652
	$provideHover(handle: number, resource: UriComponents, position: IPosition): TPromise<modes.Hover>;
	$provideDocumentHighlights(handle: number, resource: UriComponents, position: IPosition): TPromise<modes.DocumentHighlight[]>;
653 654
	$provideReferences(handle: number, resource: UriComponents, position: IPosition, context: modes.ReferenceContext): TPromise<LocationDto[]>;
	$provideCodeActions(handle: number, resource: UriComponents, range: IRange): TPromise<CodeActionDto[]>;
655 656 657
	$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[]>;
658 659
	$provideWorkspaceSymbols(handle: number, search: string): TPromise<WorkspaceSymbolsDto>;
	$resolveWorkspaceSymbol(handle: number, symbol: SymbolInformationDto): TPromise<SymbolInformationDto>;
660
	$releaseWorkspaceSymbols(handle: number, id: number): void;
661 662
	$provideRenameEdits(handle: number, resource: UriComponents, position: IPosition, newName: string): TPromise<WorkspaceEditDto>;
	$provideCompletionItems(handle: number, resource: UriComponents, position: IPosition, context: modes.SuggestContext): TPromise<SuggestResultDto>;
663
	$resolveCompletionItem(handle: number, resource: UriComponents, position: IPosition, suggestion: modes.ISuggestion): TPromise<modes.ISuggestion>;
664
	$releaseCompletionItems(handle: number, id: number): void;
665 666
	$provideSignatureHelp(handle: number, resource: UriComponents, position: IPosition): TPromise<modes.SignatureHelp>;
	$provideDocumentLinks(handle: number, resource: UriComponents): TPromise<modes.ILink[]>;
667
	$resolveDocumentLink(handle: number, link: modes.ILink): TPromise<modes.ILink>;
668 669
	$provideDocumentColors(handle: number, resource: UriComponents): TPromise<IRawColorInfo[]>;
	$provideColorPresentations(handle: number, resource: UriComponents, colorInfo: IRawColorInfo): TPromise<modes.IColorPresentation[]>;
670 671
}

672 673 674
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
	$validateInput(input: string): TPromise<string>;
675 676
}

677 678 679
export interface ExtHostTerminalServiceShape {
	$acceptTerminalClosed(id: number): void;
	$acceptTerminalProcessId(id: number, processId: number): void;
680 681
}

682
export interface ExtHostSCMShape {
683
	$provideOriginalResource(sourceControlHandle: number, uri: string): TPromise<string>;
J
Joao Moreno 已提交
684
	$onInputBoxValueChange(sourceControlHandle: number, value: string): TPromise<void>;
685
	$executeResourceCommand(sourceControlHandle: number, groupHandle: number, handle: number): TPromise<void>;
J
Joao Moreno 已提交
686 687
}

688 689
export interface ExtHostTaskShape {
	$provideTasks(handle: number): TPromise<TaskSet>;
690 691
}

692 693 694 695 696 697 698 699 700 701
export interface IBreakpointData {
	type: 'source' | 'function';
	id: string;
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
}

export interface ISourceBreakpointData extends IBreakpointData {
	type: 'source';
702
	uri: UriComponents;
703 704
	line: number;
	character: number;
705 706 707 708 709 710 711 712 713 714 715 716 717
}

export interface IFunctionBreakpointData extends IBreakpointData {
	type: 'function';
	functionName: string;
}

export interface IBreakpointsDelta {
	added?: (ISourceBreakpointData | IFunctionBreakpointData)[];
	removed?: string[];
	changed?: (ISourceBreakpointData | IFunctionBreakpointData)[];
}

718
export interface ExtHostDebugServiceShape {
719 720
	$resolveDebugConfiguration(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig): TPromise<IConfig>;
	$provideDebugConfigurations(handle: number, folder: UriComponents | undefined): TPromise<IConfig[]>;
721 722 723 724
	$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;
725
	$acceptBreakpointsDelta(delat: IBreakpointsDelta): void;
726 727
}

728

729 730 731 732 733 734
export interface DecorationRequest {
	readonly id: number;
	readonly handle: number;
	readonly uri: UriComponents;
}

735
export type DecorationData = [number, boolean, string, string, ThemeColor, string];
736
export type DecorationReply = { [id: number]: DecorationData };
737 738

export interface ExtHostDecorationsShape {
739
	$provideDecorations(requests: DecorationRequest[]): TPromise<DecorationReply>;
740 741
}

742 743
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
744 745
}

746 747 748
// --- proxy identifiers

export const MainContext = {
749
	MainThreadCommands: <ProxyIdentifier<MainThreadCommandsShape>>createMainId<MainThreadCommandsShape>('MainThreadCommands'),
750
	MainThreadConfiguration: createMainId<MainThreadConfigurationShape>('MainThreadConfiguration'),
751
	MainThreadDebugService: createMainId<MainThreadDebugServiceShape>('MainThreadDebugService'),
752 753 754 755
	MainThreadDecorations: createMainId<MainThreadDecorationsShape>('MainThreadDecorations'),
	MainThreadDiagnostics: createMainId<MainThreadDiagnosticsShape>('MainThreadDiagnostics'),
	MainThreadDialogs: createMainId<MainThreadDiaglogsShape>('MainThreadDiaglogs'),
	MainThreadDocuments: createMainId<MainThreadDocumentsShape>('MainThreadDocuments'),
756
	MainThreadDocumentContentProviders: createMainId<MainThreadDocumentContentProvidersShape>('MainThreadDocumentContentProviders'),
757
	MainThreadEditors: createMainId<MainThreadEditorsShape>('MainThreadEditors'),
758 759
	MainThreadErrors: createMainId<MainThreadErrorsShape>('MainThreadErrors'),
	MainThreadTreeViews: createMainId<MainThreadTreeViewsShape>('MainThreadTreeViews'),
760
	MainThreadLanguageFeatures: createMainId<MainThreadLanguageFeaturesShape>('MainThreadLanguageFeatures'),
761
	MainThreadLanguages: createMainId<MainThreadLanguagesShape>('MainThreadLanguages'),
762
	MainThreadMessageService: createMainId<MainThreadMessageServiceShape>('MainThreadMessageService'),
763 764
	MainThreadOutputService: createMainId<MainThreadOutputServiceShape>('MainThreadOutputService'),
	MainThreadProgress: createMainId<MainThreadProgressShape>('MainThreadProgress'),
765
	MainThreadQuickOpen: createMainId<MainThreadQuickOpenShape>('MainThreadQuickOpen'),
766
	MainThreadStatusBar: createMainId<MainThreadStatusBarShape>('MainThreadStatusBar'),
767
	MainThreadStorage: createMainId<MainThreadStorageShape>('MainThreadStorage'),
768
	MainThreadTelemetry: createMainId<MainThreadTelemetryShape>('MainThreadTelemetry'),
769
	MainThreadTerminalService: createMainId<MainThreadTerminalServiceShape>('MainThreadTerminalService'),
770
	MainThreadWorkspace: createMainId<MainThreadWorkspaceShape>('MainThreadWorkspace'),
771
	MainThreadFileSystem: createMainId<MainThreadFileSystemShape>('MainThreadFileSystem'),
772
	MainThreadExtensionService: createMainId<MainThreadExtensionServiceShape>('MainThreadExtensionService'),
J
Joao Moreno 已提交
773
	MainThreadSCM: createMainId<MainThreadSCMShape>('MainThreadSCM'),
774
	MainThreadTask: createMainId<MainThreadTaskShape>('MainThreadTask', ProxyType.CustomMarshaller),
775
	MainThreadWindow: createMainId<MainThreadWindowShape>('MainThreadWindow'),
776 777 778
};

export const ExtHostContext = {
779
	ExtHostCommands: createExtId<ExtHostCommandsShape>('ExtHostCommands'),
780
	ExtHostConfiguration: createExtId<ExtHostConfigurationShape>('ExtHostConfiguration'),
781
	ExtHostDiagnostics: createExtId<ExtHostDiagnosticsShape>('ExtHostDiagnostics'),
782
	ExtHostDebugService: createExtId<ExtHostDebugServiceShape>('ExtHostDebugService'),
J
Johannes Rieken 已提交
783
	ExtHostDecorations: createExtId<ExtHostDecorationsShape>('ExtHostDecorations'),
784
	ExtHostDocumentsAndEditors: createExtId<ExtHostDocumentsAndEditorsShape>('ExtHostDocumentsAndEditors'),
785
	ExtHostDocuments: createExtId<ExtHostDocumentsShape>('ExtHostDocuments'),
J
Johannes Rieken 已提交
786
	ExtHostDocumentContentProviders: createExtId<ExtHostDocumentContentProvidersShape>('ExtHostDocumentContentProviders'),
J
Johannes Rieken 已提交
787
	ExtHostDocumentSaveParticipant: createExtId<ExtHostDocumentSaveParticipantShape>('ExtHostDocumentSaveParticipant'),
J
Johannes Rieken 已提交
788
	ExtHostEditors: createExtId<ExtHostEditorsShape>('ExtHostEditors'),
789
	ExtHostTreeViews: createExtId<ExtHostTreeViewsShape>('ExtHostTreeViews'),
J
Johannes Rieken 已提交
790
	ExtHostFileSystem: createExtId<ExtHostFileSystemShape>('ExtHostFileSystem'),
J
Johannes Rieken 已提交
791
	ExtHostFileSystemEventService: createExtId<ExtHostFileSystemEventServiceShape>('ExtHostFileSystemEventService'),
792
	ExtHostHeapService: createExtId<ExtHostHeapServiceShape>('ExtHostHeapMonitor'),
793
	ExtHostLanguageFeatures: createExtId<ExtHostLanguageFeaturesShape>('ExtHostLanguageFeatures'),
794 795
	ExtHostQuickOpen: createExtId<ExtHostQuickOpenShape>('ExtHostQuickOpen'),
	ExtHostExtensionService: createExtId<ExtHostExtensionServiceShape>('ExtHostExtensionService'),
796
	// ExtHostLogService: createExtId<ExtHostLogServiceShape>('ExtHostLogService'),
797
	ExtHostTerminalService: createExtId<ExtHostTerminalServiceShape>('ExtHostTerminalService'),
J
Joao Moreno 已提交
798
	ExtHostSCM: createExtId<ExtHostSCMShape>('ExtHostSCM'),
799
	ExtHostTask: createExtId<ExtHostTaskShape>('ExtHostTask', ProxyType.CustomMarshaller),
800
	ExtHostWorkspace: createExtId<ExtHostWorkspaceShape>('ExtHostWorkspace'),
801
	ExtHostWindow: createExtId<ExtHostWindowShape>('ExtHostWindow'),
802
};