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

import * as editorCommon from 'vs/editor/common/editorCommon';
import * as modes from 'vs/editor/common/modes';
A
Alex Dima 已提交
31
import { ITextSource } from 'vs/editor/common/model/textSource';
32

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

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

41

42
import { TaskSet } from 'vs/workbench/parts/tasks/common/tasks';
A
Alex Dima 已提交
43
import { IModelChangedEvent } from 'vs/editor/common/model/mirrorModel';
44 45
import { IPosition } from 'vs/editor/common/core/position';
import { IRange } from 'vs/editor/common/core/range';
46
import { ISelection, Selection } from 'vs/editor/common/core/selection';
47

48
import { ITreeItem } from 'vs/workbench/common/views';
B
Benjamin Pasero 已提交
49
import { ThemeColor } from 'vs/platform/theme/common/themeService';
B
Benjamin Pasero 已提交
50 51
import { IDisposable } from 'vs/base/common/lifecycle';
import { SerializedError } from 'vs/base/common/errors';
52
import { IStat, IFileChange } from 'vs/platform/files/common/files';
S
Sandeep Somavarapu 已提交
53
import { ConfigurationScope } from 'vs/platform/configuration/common/configurationRegistry';
J
Joao Moreno 已提交
54
import { ParsedArgs } from 'vs/platform/environment/common/environment';
55
import { CommentRule, CharacterPair, EnterAction } from 'vs/editor/common/modes/languageConfiguration';
S
Sandeep Somavarapu 已提交
56

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

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

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

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

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

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

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

102 103
// --- main thread

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

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

116
export interface MainThreadDiagnosticsShape extends IDisposable {
117
	$changeMany(owner: string, entries: [UriComponents, IMarkerData[]][]): TPromise<any>;
118
	$clear(owner: string): TPromise<any>;
119 120
}

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

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

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

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

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

153
export interface MainThreadDocumentsShape extends IDisposable {
J
Johannes Rieken 已提交
154
	$tryCreateDocument(options?: { language?: string; content?: string; }): TPromise<UriComponents>;
155 156
	$tryOpenDocument(uri: UriComponents): TPromise<any>;
	$trySaveDocument(uri: UriComponents): TPromise<boolean>;
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 182 183 184 185 186 187 188 189 190 191 192 193 194 195
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;
}



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

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

213
export interface MainThreadEditorsShape extends IDisposable {
214
	$tryShowTextDocument(resource: UriComponents, options: ITextDocumentShowOptions): TPromise<string>;
215 216 217 218 219 220
	$registerTextEditorDecorationType(key: string, options: editorCommon.IDecorationRenderOptions): void;
	$removeTextEditorDecorationType(key: string): void;
	$tryShowEditor(id: string, position: EditorPosition): TPromise<void>;
	$tryHideEditor(id: string): TPromise<void>;
	$trySetOptions(id: string, options: ITextEditorConfigurationUpdate): TPromise<any>;
	$trySetDecorations(id: string, key: string, ranges: editorCommon.IDecorationOptions[]): TPromise<any>;
221
	$trySetDecorationsFast(id: string, key: string, ranges: number[]): TPromise<any>;
222 223 224
	$tryRevealRange(id: string, range: IRange, revealType: TextEditorRevealType): TPromise<any>;
	$trySetSelections(id: string, selections: ISelection[]): TPromise<any>;
	$tryApplyEdits(id: string, modelVersionId: number, edits: editorCommon.ISingleEditOperation[], opts: IApplyEditsOptions): TPromise<boolean>;
225
	$tryApplyWorkspaceEdit(workspaceResourceEdits: IWorkspaceResourceEdit[]): TPromise<boolean>;
226 227
	$tryInsertSnippet(id: string, template: string, selections: IRange[], opts: IUndoStopOptions): TPromise<any>;
	$getDiffInformation(id: string): TPromise<editorCommon.ILineChange[]>;
228 229
}

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

235
export interface MainThreadErrorsShape extends IDisposable {
236
	$onUnexpectedError(err: any | SerializedError): void;
237 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
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[];
		}[];
	};
}

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

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

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

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

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

323
export interface MainThreadProgressShape extends IDisposable {
324

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

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

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

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

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

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

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

368 369
export interface MainThreadFileSystemShape extends IDisposable {
	$registerFileSystemProvider(handle: number, scheme: string): void;
370
	$unregisterFileSystemProvider(handle: number): void;
371

372
	$onDidAddFileSystemRoot(root: UriComponents): void;
373
	$onFileSystemChange(handle: number, resource: IFileChange[]): void;
374
	$reportFileChunk(handle: number, resource: UriComponents, chunk: number[] | null): void;
J
Johannes Rieken 已提交
375

376
	$handleSearchProgress(handle: number, session: number, resource: UriComponents): void;
377 378
}

379
export interface MainThreadTaskShape extends IDisposable {
380 381
	$registerTaskProvider(handle: number): TPromise<any>;
	$unregisterTaskProvider(handle: number): TPromise<any>;
382 383
}

384
export interface MainThreadExtensionServiceShape extends IDisposable {
385
	$localShowMessage(severity: Severity, msg: string): void;
A
Alex Dima 已提交
386
	$onExtensionActivated(extensionId: string, startup: boolean, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number, activationEvent: string): void;
387
	$onExtensionActivationFailed(extensionId: string): void;
388
	$onExtensionRuntimeError(extensionId: string, error: SerializedError): void;
A
Alex Dima 已提交
389
	$addMessage(extensionId: string, severity: Severity, message: string): void;
390 391
}

J
Joao Moreno 已提交
392
export interface SCMProviderFeatures {
J
Joao Moreno 已提交
393 394
	hasQuickDiffProvider?: boolean;
	count?: number;
395 396 397
	commitTemplate?: string;
	acceptInputCommand?: modes.Command;
	statusBarCommands?: modes.Command[];
J
Joao Moreno 已提交
398 399 400 401
}

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

J
Joao Moreno 已提交
404
export type SCMRawResource = [
405
	number /*handle*/,
J
Joao Moreno 已提交
406
	string /*resourceUri*/,
J
Joao Moreno 已提交
407
	string[] /*icons: light, dark*/,
408
	string /*tooltip*/,
409
	boolean /*strike through*/,
410 411
	boolean /*faded*/,

J
Joao Moreno 已提交
412 413 414
	string | undefined /*source*/,
	string | undefined /*letter*/,
	ThemeColor | null /*color*/
J
Joao Moreno 已提交
415
];
416

417 418 419
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
420 421 422
	SCMRawResource[]
];

423 424 425 426 427
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

428
export interface MainThreadSCMShape extends IDisposable {
J
Joao Moreno 已提交
429
	$registerSourceControl(handle: number, id: string, label: string, rootUri: string | undefined): void;
430 431
	$updateSourceControl(handle: number, features: SCMProviderFeatures): void;
	$unregisterSourceControl(handle: number): void;
J
Joao Moreno 已提交
432

433 434 435 436
	$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 已提交
437

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

J
Joao Moreno 已提交
440
	$setInputBoxValue(sourceControlHandle: number, value: string): void;
441
	$setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
J
Joao Moreno 已提交
442
	$setLineWarningLength(sourceControlHandle: number, lineWarningLength: number): void;
J
Joao Moreno 已提交
443 444
}

445 446
export type DebugSessionUUID = string;

447
export interface MainThreadDebugServiceShape extends IDisposable {
448 449
	$registerDebugConfigurationProvider(type: string, hasProvideMethod: boolean, hasResolveMethod: boolean, handle: number): TPromise<any>;
	$unregisterDebugConfigurationProvider(handle: number): TPromise<any>;
450
	$startDebugging(folder: UriComponents | undefined, nameOrConfig: string | vscode.DebugConfiguration): TPromise<boolean>;
451
	$customDebugAdapterRequest(id: DebugSessionUUID, command: string, args: any): TPromise<any>;
452
	$appendDebugConsole(value: string): TPromise<any>;
453
	$startBreakpointEvents(): TPromise<any>;
454 455
}

456 457
export interface MainThreadWindowShape extends IDisposable {
	$getWindowVisibility(): TPromise<boolean>;
458 459
}

460 461
// -- extension host

462
export interface ExtHostCommandsShape {
J
Johannes Rieken 已提交
463
	$executeContributedCommand<T>(id: string, ...args: any[]): Thenable<T>;
464
	$getContributedCommandHandlerDescriptions(): Thenable<{ [id: string]: string | ICommandHandlerDescription }>;
465 466
}

467
export interface ExtHostConfigurationShape {
468
	$acceptConfigurationChanged(data: IConfigurationData, eventData: IWorkspaceConfigurationChangeEventData): void;
469 470
}

471
export interface ExtHostDiagnosticsShape {
472 473 474

}

475
export interface ExtHostDocumentContentProvidersShape {
J
Johannes Rieken 已提交
476
	$provideTextDocumentContent(handle: number, uri: UriComponents): TPromise<string>;
477 478
}

479
export interface IModelAddedData {
480
	uri: UriComponents;
481
	versionId: number;
482 483
	lines: string[];
	EOL: string;
484 485 486
	modeId: string;
	isDirty: boolean;
}
487 488 489 490 491
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;
492 493
}

494
export interface ExtHostDocumentSaveParticipantShape {
J
Johannes Rieken 已提交
495
	$participateInSave(resource: UriComponents, reason: SaveReason): Thenable<boolean[]>;
496 497
}

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

J
Johannes Rieken 已提交
514 515 516 517 518 519 520 521
export interface IDocumentsAndEditorsDelta {
	removedDocuments?: string[];
	addedDocuments?: IModelAddedData[];
	removedEditors?: string[];
	addedEditors?: ITextEditorAddData[];
	newActiveEditor?: string;
}

522 523
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
524 525
}

526 527
export interface ExtHostTreeViewsShape {
	$getElements(treeViewId: string): TPromise<ITreeItem[]>;
S
Sandeep Somavarapu 已提交
528
	$getChildren(treeViewId: string, treeItemHandle: string): TPromise<ITreeItem[]>;
S
Sandeep Somavarapu 已提交
529 530
}

531 532
export interface ExtHostWorkspaceShape {
	$acceptWorkspaceData(workspace: IWorkspaceData): void;
533
}
534

535
export interface ExtHostFileSystemShape {
J
Johannes Rieken 已提交
536 537 538 539 540 541 542 543 544
	$utimes(handle: number, resource: UriComponents, mtime: number, atime: number): TPromise<IStat>;
	$stat(handle: number, resource: UriComponents): TPromise<IStat>;
	$read(handle: number, offset: number, count: number, resource: UriComponents): TPromise<number>;
	$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 已提交
545
	$fileFiles(handle: number, session: number, query: string): TPromise<void>;
546 547
}

548 549
export interface ExtHostExtensionServiceShape {
	$activateByEvent(activationEvent: string): TPromise<void>;
550 551 552
}

export interface FileSystemEvents {
J
Johannes Rieken 已提交
553 554 555
	created: UriComponents[];
	changed: UriComponents[];
	deleted: UriComponents[];
556
}
557
export interface ExtHostFileSystemEventServiceShape {
558
	$onFileEvent(events: FileSystemEvents): void;
559 560
}

J
Johannes Rieken 已提交
561 562 563 564 565
export interface ObjectIdentifier {
	$ident: number;
}

export namespace ObjectIdentifier {
566
	export const name = '$ident';
J
Johannes Rieken 已提交
567
	export function mixin<T>(obj: T, id: number): T & ObjectIdentifier {
568
		Object.defineProperty(obj, name, { value: id, enumerable: true });
J
Johannes Rieken 已提交
569 570
		return <T & ObjectIdentifier>obj;
	}
571 572
	export function of(obj: any): number {
		return obj[name];
J
Johannes Rieken 已提交
573 574 575
	}
}

576 577
export interface ExtHostHeapServiceShape {
	$onGarbageCollection(ids: number[]): void;
578
}
579
export interface IRawColorInfo {
J
Joao Moreno 已提交
580
	color: [number, number, number, number];
581 582 583
	range: IRange;
}

584 585 586 587 588 589 590 591 592 593
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 {
594 595 596 597
	_id: number;
	_parentId: number;
}

598 599
export interface SuggestResultDto extends IdObject {
	suggestions: SuggestionDto[];
600 601 602
	incomplete?: boolean;
}

603 604 605
export interface LocationDto {
	uri: UriComponents;
	range: IRange;
606 607
}

608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
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;
623 624
}

625 626 627 628 629 630 631 632 633 634 635
export interface WorkspaceEditDto {
	edits: ResourceEditDto[];
	rejectReason?: string;
}

export interface CodeActionDto {
	title: string;
	edits?: WorkspaceEditDto;
	diagnostics?: IMarkerData[];
	command?: modes.Command;
}
636

637
export interface ExtHostLanguageFeaturesShape {
638
	$provideDocumentSymbols(handle: number, resource: UriComponents): TPromise<SymbolInformationDto[]>;
639 640
	$provideCodeLenses(handle: number, resource: UriComponents): TPromise<modes.ICodeLensSymbol[]>;
	$resolveCodeLens(handle: number, resource: UriComponents, symbol: modes.ICodeLensSymbol): TPromise<modes.ICodeLensSymbol>;
641 642 643
	$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[]>;
644 645
	$provideHover(handle: number, resource: UriComponents, position: IPosition): TPromise<modes.Hover>;
	$provideDocumentHighlights(handle: number, resource: UriComponents, position: IPosition): TPromise<modes.DocumentHighlight[]>;
646 647
	$provideReferences(handle: number, resource: UriComponents, position: IPosition, context: modes.ReferenceContext): TPromise<LocationDto[]>;
	$provideCodeActions(handle: number, resource: UriComponents, range: IRange): TPromise<CodeActionDto[]>;
648 649 650
	$provideDocumentFormattingEdits(handle: number, resource: UriComponents, options: modes.FormattingOptions): TPromise<editorCommon.ISingleEditOperation[]>;
	$provideDocumentRangeFormattingEdits(handle: number, resource: UriComponents, range: IRange, options: modes.FormattingOptions): TPromise<editorCommon.ISingleEditOperation[]>;
	$provideOnTypeFormattingEdits(handle: number, resource: UriComponents, position: IPosition, ch: string, options: modes.FormattingOptions): TPromise<editorCommon.ISingleEditOperation[]>;
651 652
	$provideWorkspaceSymbols(handle: number, search: string): TPromise<WorkspaceSymbolsDto>;
	$resolveWorkspaceSymbol(handle: number, symbol: SymbolInformationDto): TPromise<SymbolInformationDto>;
653
	$releaseWorkspaceSymbols(handle: number, id: number): void;
654 655
	$provideRenameEdits(handle: number, resource: UriComponents, position: IPosition, newName: string): TPromise<WorkspaceEditDto>;
	$provideCompletionItems(handle: number, resource: UriComponents, position: IPosition, context: modes.SuggestContext): TPromise<SuggestResultDto>;
656
	$resolveCompletionItem(handle: number, resource: UriComponents, position: IPosition, suggestion: modes.ISuggestion): TPromise<modes.ISuggestion>;
657
	$releaseCompletionItems(handle: number, id: number): void;
658 659
	$provideSignatureHelp(handle: number, resource: UriComponents, position: IPosition): TPromise<modes.SignatureHelp>;
	$provideDocumentLinks(handle: number, resource: UriComponents): TPromise<modes.ILink[]>;
660
	$resolveDocumentLink(handle: number, link: modes.ILink): TPromise<modes.ILink>;
661 662
	$provideDocumentColors(handle: number, resource: UriComponents): TPromise<IRawColorInfo[]>;
	$provideColorPresentations(handle: number, resource: UriComponents, colorInfo: IRawColorInfo): TPromise<modes.IColorPresentation[]>;
663 664
}

665 666 667
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
	$validateInput(input: string): TPromise<string>;
668 669
}

670 671 672
export interface ExtHostTerminalServiceShape {
	$acceptTerminalClosed(id: number): void;
	$acceptTerminalProcessId(id: number, processId: number): void;
673 674
}

675
export interface ExtHostSCMShape {
676
	$provideOriginalResource(sourceControlHandle: number, uri: string): TPromise<string>;
J
Joao Moreno 已提交
677
	$onInputBoxValueChange(sourceControlHandle: number, value: string): TPromise<void>;
678
	$executeResourceCommand(sourceControlHandle: number, groupHandle: number, handle: number): TPromise<void>;
J
Joao Moreno 已提交
679 680
}

681 682
export interface ExtHostTaskShape {
	$provideTasks(handle: number): TPromise<TaskSet>;
683 684
}

685 686 687 688 689 690 691 692 693 694
export interface IBreakpointData {
	type: 'source' | 'function';
	id: string;
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
}

export interface ISourceBreakpointData extends IBreakpointData {
	type: 'source';
695
	uri: UriComponents;
696 697
	line: number;
	character: number;
698 699 700 701 702 703 704 705 706 707 708 709 710
}

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

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

711
export interface ExtHostDebugServiceShape {
712 713
	$resolveDebugConfiguration(handle: number, folder: UriComponents | undefined, debugConfiguration: IConfig): TPromise<IConfig>;
	$provideDebugConfigurations(handle: number, folder: UriComponents | undefined): TPromise<IConfig[]>;
714 715 716 717
	$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;
718
	$acceptBreakpointsDelta(delat: IBreakpointsDelta): void;
719 720
}

721

722 723 724 725 726 727
export interface DecorationRequest {
	readonly id: number;
	readonly handle: number;
	readonly uri: UriComponents;
}

728
export type DecorationData = [number, boolean, string, string, ThemeColor, string];
729
export type DecorationReply = { [id: number]: DecorationData };
730 731

export interface ExtHostDecorationsShape {
732
	$provideDecorations(requests: DecorationRequest[]): TPromise<DecorationReply>;
733 734
}

735 736
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
737 738
}

739 740 741
// --- proxy identifiers

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

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