extHost.protocol.ts 29.8 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,
10
	ProxyIdentifier
11
} from 'vs/workbench/services/thread/common/threadService';
12

13 14 15 16
import * as vscode from 'vscode';

import URI from 'vs/base/common/uri';
import Severity from 'vs/base/common/severity';
17
import { TPromise } from 'vs/base/common/winjs.base';
18

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

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

S
Sandeep Somavarapu 已提交
31
import { IConfigurationData, ConfigurationTarget, IConfigurationModel } from 'vs/platform/configuration/common/configuration';
32

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

38

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

45
import { ITreeItem } from 'vs/workbench/common/views';
B
Benjamin Pasero 已提交
46
import { ThemeColor } from 'vs/platform/theme/common/themeService';
B
Benjamin Pasero 已提交
47 48
import { IDisposable } from 'vs/base/common/lifecycle';
import { SerializedError } from 'vs/base/common/errors';
49
import { IWorkspaceFolderData } from 'vs/platform/workspace/common/workspace';
50
import { IStat, IFileChange } from 'vs/platform/files/common/files';
S
Sandeep Somavarapu 已提交
51
import { ConfigurationScope } from 'vs/platform/configuration/common/configurationRegistry';
J
Joao Moreno 已提交
52
import { ParsedArgs } from 'vs/platform/environment/common/environment';
S
Sandeep Somavarapu 已提交
53

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

66 67
export interface IWorkspaceData {
	id: string;
68
	name: string;
69
	folders: IWorkspaceFolderData[];
70 71
}

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

S
Sandeep Somavarapu 已提交
83 84 85 86
export interface IConfigurationInitData extends IConfigurationData {
	configurationScopes: ConfigurationScope[];
}

87
export interface IWorkspaceConfigurationChangeEventData {
S
Sandeep Somavarapu 已提交
88 89
	changedConfiguration: IConfigurationModel;
	changedConfigurationByResource: { [folder: string]: IConfigurationModel };
90 91
}

92 93 94 95 96
export interface IExtHostContext {
	/**
	 * Returns a proxy to an object addressable/named in the extension host process.
	 */
	get<T>(identifier: ProxyIdentifier<T>): T;
97

98 99 100 101
	/**
	 * Register manually created instance.
	 */
	set<T, R extends T>(identifier: ProxyIdentifier<T>, instance: R): R;
102 103 104 105 106 107 108 109 110
}

export interface IMainContext {
	/**
	 * Returns a proxy to an object addressable/named in the main/renderer process.
	 */
	get<T>(identifier: ProxyIdentifier<T>): T;
}

111 112
// --- main thread

113
export interface MainThreadCommandsShape extends IDisposable {
114 115 116 117
	$registerCommand(id: string): TPromise<any>;
	$unregisterCommand(id: string): TPromise<any>;
	$executeCommand<T>(id: string, args: any[]): Thenable<T>;
	$getCommands(): Thenable<string[]>;
118 119
}

120
export interface MainThreadConfigurationShape extends IDisposable {
121 122
	$updateConfigurationOption(target: ConfigurationTarget, key: string, value: any, resource: URI): TPromise<void>;
	$removeConfigurationOption(target: ConfigurationTarget, key: string, resource: URI): TPromise<void>;
123 124
}

125
export interface MainThreadDiagnosticsShape extends IDisposable {
126 127
	$changeMany(owner: string, entries: [URI, IMarkerData[]][]): TPromise<any>;
	$clear(owner: string): TPromise<any>;
128 129
}

130
export interface MainThreadDialogOpenOptions {
J
Johannes Rieken 已提交
131
	defaultUri?: URI;
132
	openLabel?: string;
133 134 135
	canSelectFiles?: boolean;
	canSelectFolders?: boolean;
	canSelectMany?: boolean;
J
Johannes Rieken 已提交
136
	filters?: { [name: string]: string[] };
137 138
}

139
export interface MainThreadDialogSaveOptions {
J
Johannes Rieken 已提交
140
	defaultUri?: URI;
141
	saveLabel?: string;
J
Johannes Rieken 已提交
142
	filters?: { [name: string]: string[] };
143 144
}

145
export interface MainThreadDiaglogsShape extends IDisposable {
146 147
	$showOpenDialog(options: MainThreadDialogOpenOptions): TPromise<string[]>;
	$showSaveDialog(options: MainThreadDialogSaveOptions): TPromise<string>;
148 149
}

150 151 152 153 154 155
export interface MainThreadDecorationsShape extends IDisposable {
	$registerDecorationProvider(handle: number, label: string): void;
	$unregisterDecorationProvider(handle: number): void;
	$onDidChange(handle: number, resources: URI[]): void;
}

156
export interface MainThreadDocumentContentProvidersShape extends IDisposable {
157 158 159
	$registerTextContentProvider(handle: number, scheme: string): void;
	$unregisterTextContentProvider(handle: number): void;
	$onVirtualDocumentChange(uri: URI, value: ITextSource): void;
160 161
}

162
export interface MainThreadDocumentsShape extends IDisposable {
163 164 165
	$tryCreateDocument(options?: { language?: string; content?: string; }): TPromise<any>;
	$tryOpenDocument(uri: URI): TPromise<any>;
	$trySaveDocument(uri: URI): TPromise<boolean>;
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 197 198 199 200 201 202 203 204
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;
}



205 206 207 208
export interface ITextDocumentShowOptions {
	position?: EditorPosition;
	preserveFocus?: boolean;
	pinned?: boolean;
209
	selection?: IRange;
210 211
}

212 213 214 215 216 217 218 219 220 221
export interface IWorkspaceResourceEdit {
	resource: URI;
	modelVersionId?: number;
	edits: {
		range?: IRange;
		newText: string;
		newEol?: editorCommon.EndOfLineSequence;
	}[];
}

222
export interface MainThreadEditorsShape extends IDisposable {
223 224 225 226 227 228 229
	$tryShowTextDocument(resource: URI, options: ITextDocumentShowOptions): TPromise<string>;
	$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>;
230
	$trySetDecorationsFast(id: string, key: string, ranges: string): TPromise<any>;
231 232 233
	$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>;
234
	$tryApplyWorkspaceEdit(workspaceResourceEdits: IWorkspaceResourceEdit[]): TPromise<boolean>;
235 236
	$tryInsertSnippet(id: string, template: string, selections: IRange[], opts: IUndoStopOptions): TPromise<any>;
	$getDiffInformation(id: string): TPromise<editorCommon.ILineChange[]>;
237 238
}

239
export interface MainThreadTreeViewsShape extends IDisposable {
240 241
	$registerView(treeViewId: string): void;
	$refresh(treeViewId: string, treeItemHandles: number[]): void;
242 243
}

244
export interface MainThreadErrorsShape extends IDisposable {
245
	$onUnexpectedError(err: any | SerializedError, extensionId: string | undefined): void;
246 247
}

248
export interface MainThreadLanguageFeaturesShape extends IDisposable {
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
	$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>;
265
	$registerSuggestSupport(handle: number, selector: vscode.DocumentSelector, triggerCharacters: string[], supportsResolveDetails: boolean): TPromise<any>;
266 267 268 269
	$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>;
	$setLanguageConfiguration(handle: number, languageId: string, configuration: vscode.LanguageConfiguration): TPromise<any>;
270 271
}

272
export interface MainThreadLanguagesShape extends IDisposable {
273
	$getLanguages(): TPromise<string[]>;
274 275
}

276
export interface MainThreadMessageOptions {
277
	extension?: IExtensionDescription;
278
	modal?: boolean;
279 280
}

281
export interface MainThreadMessageServiceShape extends IDisposable {
282
	$showMessage(severity: Severity, message: string, options: MainThreadMessageOptions, commands: { title: string; isCloseAffordance: boolean; handle: number; }[]): Thenable<number>;
283 284
}

285
export interface MainThreadOutputServiceShape extends IDisposable {
286 287 288 289 290
	$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>;
291 292
}

293
export interface MainThreadProgressShape extends IDisposable {
294

295 296 297
	$startProgress(handle: number, options: IProgressOptions): void;
	$progressReport(handle: number, message: IProgressStep): void;
	$progressEnd(handle: number): void;
298 299
}

300
export interface MainThreadTerminalServiceShape extends IDisposable {
301
	$createTerminal(name?: string, shellPath?: string, shellArgs?: string[], env?: { [key: string]: string }, waitOnExit?: boolean): TPromise<number>;
302 303 304 305
	$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 已提交
306 307
}

308 309 310
export interface MyQuickPickItems extends IPickOpenEntry {
	handle: number;
}
311
export interface MainThreadQuickOpenShape extends IDisposable {
312 313 314 315
	$show(options: IPickOptions): TPromise<number>;
	$setItems(items: MyQuickPickItems[]): TPromise<any>;
	$setError(error: Error): TPromise<any>;
	$input(options: vscode.InputBoxOptions, validateInput: boolean): TPromise<string>;
316 317
}

318
export interface MainThreadStatusBarShape extends IDisposable {
319
	$setEntry(id: number, extensionId: string, text: string, tooltip: string, command: string, color: string | ThemeColor, alignment: MainThreadStatusBarAlignment, priority: number): void;
320
	$dispose(id: number): void;
321 322
}

323
export interface MainThreadStorageShape extends IDisposable {
324 325
	$getValue<T>(shared: boolean, key: string): TPromise<T>;
	$setValue(shared: boolean, key: string, value: any): TPromise<any>;
326 327
}

328
export interface MainThreadTelemetryShape extends IDisposable {
329
	$publicLog(eventName: string, data?: any): void;
330 331
}

332
export interface MainThreadWorkspaceShape extends IDisposable {
333
	$startSearch(includePattern: string, includeFolder: string, excludePattern: string, maxResults: number, requestId: number): Thenable<URI[]>;
334 335
	$cancelSearch(requestId: number): Thenable<boolean>;
	$saveAll(includeUntitled?: boolean): Thenable<boolean>;
336
}
337

338 339
export interface MainThreadFileSystemShape extends IDisposable {
	$registerFileSystemProvider(handle: number, scheme: string): void;
340
	$unregisterFileSystemProvider(handle: number): void;
341 342 343 344

	$onDidAddFileSystemRoot(root: URI): void;
	$onFileSystemChange(handle: number, resource: IFileChange[]): void;
	$reportFileChunk(handle: number, resource: URI, chunk: number[] | null): void;
J
Johannes Rieken 已提交
345 346

	$handleSearchProgress(handle: number, session: number, resource: URI): void;
347 348
}

349
export interface MainThreadTaskShape extends IDisposable {
350 351
	$registerTaskProvider(handle: number): TPromise<any>;
	$unregisterTaskProvider(handle: number): TPromise<any>;
352 353
}

354
export interface MainThreadExtensionServiceShape extends IDisposable {
355
	$localShowMessage(severity: Severity, msg: string): void;
356
	$onExtensionActivated(extensionId: string, startup: boolean, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number): void;
357
	$onExtensionActivationFailed(extensionId: string): void;
358 359
}

J
Joao Moreno 已提交
360
export interface SCMProviderFeatures {
J
Joao Moreno 已提交
361 362
	hasQuickDiffProvider?: boolean;
	count?: number;
363 364 365
	commitTemplate?: string;
	acceptInputCommand?: modes.Command;
	statusBarCommands?: modes.Command[];
J
Joao Moreno 已提交
366 367 368 369
}

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

J
Joao Moreno 已提交
372
export type SCMRawResource = [
373
	number /*handle*/,
J
Joao Moreno 已提交
374
	string /*resourceUri*/,
J
Joao Moreno 已提交
375
	string[] /*icons: light, dark*/,
376
	string /*tooltip*/,
377
	boolean /*strike through*/,
378 379
	boolean /*faded*/,

J
Joao Moreno 已提交
380 381 382
	string | undefined /*source*/,
	string | undefined /*letter*/,
	ThemeColor | null /*color*/
J
Joao Moreno 已提交
383
];
384

385 386 387
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
388 389 390
	SCMRawResource[]
];

391 392 393 394 395
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

396
export interface MainThreadSCMShape extends IDisposable {
J
Joao Moreno 已提交
397
	$registerSourceControl(handle: number, id: string, label: string, rootUri: string | undefined): void;
398 399
	$updateSourceControl(handle: number, features: SCMProviderFeatures): void;
	$unregisterSourceControl(handle: number): void;
J
Joao Moreno 已提交
400

401 402 403 404
	$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 已提交
405

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

J
Joao Moreno 已提交
408
	$setInputBoxValue(sourceControlHandle: number, value: string): void;
409
	$setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
J
Joao Moreno 已提交
410 411
}

412 413
export type DebugSessionUUID = string;

414
export interface MainThreadDebugServiceShape extends IDisposable {
415 416
	$registerDebugConfigurationProvider(type: string, hasProvideMethod: boolean, hasResolveMethod: boolean, handle: number): TPromise<any>;
	$unregisterDebugConfigurationProvider(handle: number): TPromise<any>;
417
	$startDebugging(folder: URI | undefined, nameOrConfig: string | vscode.DebugConfiguration): TPromise<boolean>;
418
	$customDebugAdapterRequest(id: DebugSessionUUID, command: string, args: any): TPromise<any>;
419
	$appendDebugConsole(value: string): TPromise<any>;
420 421
}

422 423
export interface MainThreadWindowShape extends IDisposable {
	$getWindowVisibility(): TPromise<boolean>;
424 425
}

426 427
// -- extension host

428
export interface ExtHostCommandsShape {
J
Johannes Rieken 已提交
429
	$executeContributedCommand<T>(id: string, ...args: any[]): Thenable<T>;
430
	$getContributedCommandHandlerDescriptions(): TPromise<{ [id: string]: string | ICommandHandlerDescription }>;
431 432
}

433
export interface ExtHostConfigurationShape {
434
	$acceptConfigurationChanged(data: IConfigurationData, eventData: IWorkspaceConfigurationChangeEventData): void;
435 436
}

437
export interface ExtHostDiagnosticsShape {
438 439 440

}

441 442
export interface ExtHostDocumentContentProvidersShape {
	$provideTextDocumentContent(handle: number, uri: URI): TPromise<string>;
443 444
}

445 446 447
export interface IModelAddedData {
	url: URI;
	versionId: number;
448 449
	lines: string[];
	EOL: string;
450 451 452
	modeId: string;
	isDirty: boolean;
}
453 454 455 456 457
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;
458 459
}

460 461
export interface ExtHostDocumentSaveParticipantShape {
	$participateInSave(resource: URI, reason: SaveReason): TPromise<boolean[]>;
462 463
}

464 465 466 467
export interface ITextEditorAddData {
	id: string;
	document: URI;
	options: IResolvedTextEditorConfiguration;
A
Alex Dima 已提交
468
	selections: ISelection[];
469 470 471 472 473
	editorPosition: EditorPosition;
}
export interface ITextEditorPositionData {
	[id: string]: EditorPosition;
}
474 475 476 477
export interface ExtHostEditorsShape {
	$acceptOptionsChanged(id: string, opts: IResolvedTextEditorConfiguration): void;
	$acceptSelectionsChanged(id: string, event: ISelectionChangeEvent): void;
	$acceptEditorPositionData(data: ITextEditorPositionData): void;
478 479
}

J
Johannes Rieken 已提交
480 481 482 483 484 485 486 487
export interface IDocumentsAndEditorsDelta {
	removedDocuments?: string[];
	addedDocuments?: IModelAddedData[];
	removedEditors?: string[];
	addedEditors?: ITextEditorAddData[];
	newActiveEditor?: string;
}

488 489
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
490 491
}

492 493 494
export interface ExtHostTreeViewsShape {
	$getElements(treeViewId: string): TPromise<ITreeItem[]>;
	$getChildren(treeViewId: string, treeItemHandle: number): TPromise<ITreeItem[]>;
S
Sandeep Somavarapu 已提交
495 496
}

497 498
export interface ExtHostWorkspaceShape {
	$acceptWorkspaceData(workspace: IWorkspaceData): void;
499
}
500

501
export interface ExtHostFileSystemShape {
J
Johannes Rieken 已提交
502
	$utimes(handle: number, resource: URI, mtime: number, atime: number): TPromise<IStat>;
503
	$stat(handle: number, resource: URI): TPromise<IStat>;
504
	$read(handle: number, offset: number, count: number, resource: URI): TPromise<number>;
505 506
	$write(handle: number, resource: URI, content: number[]): TPromise<void>;
	$unlink(handle: number, resource: URI): TPromise<void>;
507 508
	$move(handle: number, resource: URI, target: URI): TPromise<IStat>;
	$mkdir(handle: number, resource: URI): TPromise<IStat>;
509
	$readdir(handle: number, resource: URI): TPromise<[URI, IStat][]>;
510
	$rmdir(handle: number, resource: URI): TPromise<void>;
J
Johannes Rieken 已提交
511
	$fileFiles(handle: number, session: number, query: string): TPromise<void>;
512 513
}

514 515
export interface ExtHostExtensionServiceShape {
	$activateByEvent(activationEvent: string): TPromise<void>;
516 517 518 519 520 521 522
}

export interface FileSystemEvents {
	created: URI[];
	changed: URI[];
	deleted: URI[];
}
523
export interface ExtHostFileSystemEventServiceShape {
524
	$onFileEvent(events: FileSystemEvents): void;
525 526
}

J
Johannes Rieken 已提交
527 528 529 530 531
export interface ObjectIdentifier {
	$ident: number;
}

export namespace ObjectIdentifier {
532
	export const name = '$ident';
J
Johannes Rieken 已提交
533
	export function mixin<T>(obj: T, id: number): T & ObjectIdentifier {
534
		Object.defineProperty(obj, name, { value: id, enumerable: true });
J
Johannes Rieken 已提交
535 536
		return <T & ObjectIdentifier>obj;
	}
537 538
	export function of(obj: any): number {
		return obj[name];
J
Johannes Rieken 已提交
539 540 541
	}
}

542 543
export interface ExtHostHeapServiceShape {
	$onGarbageCollection(ids: number[]): void;
544
}
545
export interface IRawColorInfo {
J
Joao Moreno 已提交
546
	color: [number, number, number, number];
547 548 549
	range: IRange;
}

550 551 552 553 554 555 556 557 558 559 560
export interface IExtHostSuggestion extends modes.ISuggestion {
	_id: number;
	_parentId: number;
}

export interface IExtHostSuggestResult {
	_id: number;
	suggestions: IExtHostSuggestion[];
	incomplete?: boolean;
}

561 562 563 564 565 566 567 568 569 570 571 572 573
export interface IdObject {
	_id: number;
}

export namespace IdObject {
	let n = 0;
	export function mixin<T extends object>(object: T): T & IdObject {
		(<any>object)._id = n++;
		return <any>object;
	}
}

export type IWorkspaceSymbol = IdObject & modes.SymbolInformation;
574
export interface IWorkspaceSymbols extends IdObject { symbols: IWorkspaceSymbol[]; }
575

576 577 578 579 580 581 582 583 584 585
export interface ExtHostLanguageFeaturesShape {
	$provideDocumentSymbols(handle: number, resource: URI): TPromise<modes.SymbolInformation[]>;
	$provideCodeLenses(handle: number, resource: URI): TPromise<modes.ICodeLensSymbol[]>;
	$resolveCodeLens(handle: number, resource: URI, symbol: modes.ICodeLensSymbol): TPromise<modes.ICodeLensSymbol>;
	$provideDefinition(handle: number, resource: URI, position: IPosition): TPromise<modes.Definition>;
	$provideImplementation(handle: number, resource: URI, position: IPosition): TPromise<modes.Definition>;
	$provideTypeDefinition(handle: number, resource: URI, position: IPosition): TPromise<modes.Definition>;
	$provideHover(handle: number, resource: URI, position: IPosition): TPromise<modes.Hover>;
	$provideDocumentHighlights(handle: number, resource: URI, position: IPosition): TPromise<modes.DocumentHighlight[]>;
	$provideReferences(handle: number, resource: URI, position: IPosition, context: modes.ReferenceContext): TPromise<modes.Location[]>;
586
	$provideCodeActions(handle: number, resource: URI, range: IRange): TPromise<modes.CodeAction[]>;
587 588 589
	$provideDocumentFormattingEdits(handle: number, resource: URI, options: modes.FormattingOptions): TPromise<editorCommon.ISingleEditOperation[]>;
	$provideDocumentRangeFormattingEdits(handle: number, resource: URI, range: IRange, options: modes.FormattingOptions): TPromise<editorCommon.ISingleEditOperation[]>;
	$provideOnTypeFormattingEdits(handle: number, resource: URI, position: IPosition, ch: string, options: modes.FormattingOptions): TPromise<editorCommon.ISingleEditOperation[]>;
590 591 592
	$provideWorkspaceSymbols(handle: number, search: string): TPromise<IWorkspaceSymbols>;
	$resolveWorkspaceSymbol(handle: number, symbol: modes.SymbolInformation): TPromise<IWorkspaceSymbol>;
	$releaseWorkspaceSymbols(handle: number, id: number): void;
593
	$provideRenameEdits(handle: number, resource: URI, position: IPosition, newName: string): TPromise<modes.WorkspaceEdit>;
594
	$provideCompletionItems(handle: number, resource: URI, position: IPosition, context: modes.SuggestContext): TPromise<IExtHostSuggestResult>;
595
	$resolveCompletionItem(handle: number, resource: URI, position: IPosition, suggestion: modes.ISuggestion): TPromise<modes.ISuggestion>;
596
	$releaseCompletionItems(handle: number, id: number): void;
597 598 599
	$provideSignatureHelp(handle: number, resource: URI, position: IPosition): TPromise<modes.SignatureHelp>;
	$provideDocumentLinks(handle: number, resource: URI): TPromise<modes.ILink[]>;
	$resolveDocumentLink(handle: number, link: modes.ILink): TPromise<modes.ILink>;
600
	$provideDocumentColors(handle: number, resource: URI): TPromise<IRawColorInfo[]>;
601
	$provideColorPresentations(handle: number, resource: URI, colorInfo: IRawColorInfo): TPromise<modes.IColorPresentation[]>;
602 603
}

604 605 606
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
	$validateInput(input: string): TPromise<string>;
607 608
}

609 610 611
export interface ExtHostTerminalServiceShape {
	$acceptTerminalClosed(id: number): void;
	$acceptTerminalProcessId(id: number, processId: number): void;
612 613
}

614 615
export interface ExtHostSCMShape {
	$provideOriginalResource(sourceControlHandle: number, uri: URI): TPromise<URI>;
J
Joao Moreno 已提交
616
	$onInputBoxValueChange(sourceControlHandle: number, value: string): TPromise<void>;
617
	$executeResourceCommand(sourceControlHandle: number, groupHandle: number, handle: number): TPromise<void>;
J
Joao Moreno 已提交
618 619
}

620 621
export interface ExtHostTaskShape {
	$provideTasks(handle: number): TPromise<TaskSet>;
622 623
}

624
export interface ExtHostDebugServiceShape {
625 626
	$resolveDebugConfiguration(handle: number, folder: URI | undefined, debugConfiguration: any): TPromise<any>;
	$provideDebugConfigurations(handle: number, folder: URI | undefined): TPromise<any[]>;
627 628 629 630
	$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;
631 632
}

633

634
export type DecorationData = [number, boolean, string, string, ThemeColor, string];
635 636 637 638 639

export interface ExtHostDecorationsShape {
	$providerDecorations(handle: number, uri: URI): TPromise<DecorationData>;
}

640 641
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
642 643
}

644 645 646
// --- proxy identifiers

export const MainContext = {
647 648 649
	MainThreadCommands: createMainId<MainThreadCommandsShape>('MainThreadCommands'),
	MainThreadConfiguration: createMainId<MainThreadConfigurationShape>('MainThreadConfiguration'),
	MainThreadDebugService: createMainId<MainThreadDebugServiceShape>('MainThreadDebugService'),
650
	MainThreadDecorations: createMainId<MainThreadDecorationsShape>('MainThreadDecorations'),
651
	MainThreadDiagnostics: createMainId<MainThreadDiagnosticsShape>('MainThreadDiagnostics'),
652
	MainThreadDialogs: createMainId<MainThreadDiaglogsShape>('MainThreadDiaglogs'),
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
	MainThreadDocuments: createMainId<MainThreadDocumentsShape>('MainThreadDocuments'),
	MainThreadDocumentContentProviders: createMainId<MainThreadDocumentContentProvidersShape>('MainThreadDocumentContentProviders'),
	MainThreadEditors: createMainId<MainThreadEditorsShape>('MainThreadEditors'),
	MainThreadErrors: createMainId<MainThreadErrorsShape>('MainThreadErrors'),
	MainThreadTreeViews: createMainId<MainThreadTreeViewsShape>('MainThreadTreeViews'),
	MainThreadLanguageFeatures: createMainId<MainThreadLanguageFeaturesShape>('MainThreadLanguageFeatures'),
	MainThreadLanguages: createMainId<MainThreadLanguagesShape>('MainThreadLanguages'),
	MainThreadMessageService: createMainId<MainThreadMessageServiceShape>('MainThreadMessageService'),
	MainThreadOutputService: createMainId<MainThreadOutputServiceShape>('MainThreadOutputService'),
	MainThreadProgress: createMainId<MainThreadProgressShape>('MainThreadProgress'),
	MainThreadQuickOpen: createMainId<MainThreadQuickOpenShape>('MainThreadQuickOpen'),
	MainThreadStatusBar: createMainId<MainThreadStatusBarShape>('MainThreadStatusBar'),
	MainThreadStorage: createMainId<MainThreadStorageShape>('MainThreadStorage'),
	MainThreadTelemetry: createMainId<MainThreadTelemetryShape>('MainThreadTelemetry'),
	MainThreadTerminalService: createMainId<MainThreadTerminalServiceShape>('MainThreadTerminalService'),
	MainThreadWorkspace: createMainId<MainThreadWorkspaceShape>('MainThreadWorkspace'),
669
	MainThreadFileSystem: createMainId<MainThreadFileSystemShape>('MainThreadFileSystem'),
670
	MainThreadExtensionService: createMainId<MainThreadExtensionServiceShape>('MainThreadExtensionService'),
671 672
	MainThreadSCM: createMainId<MainThreadSCMShape>('MainThreadSCM'),
	MainThreadTask: createMainId<MainThreadTaskShape>('MainThreadTask'),
673
	MainThreadWindow: createMainId<MainThreadWindowShape>('MainThreadWindow'),
674 675 676
};

export const ExtHostContext = {
677 678 679 680
	ExtHostCommands: createExtId<ExtHostCommandsShape>('ExtHostCommands'),
	ExtHostConfiguration: createExtId<ExtHostConfigurationShape>('ExtHostConfiguration'),
	ExtHostDiagnostics: createExtId<ExtHostDiagnosticsShape>('ExtHostDiagnostics'),
	ExtHostDebugService: createExtId<ExtHostDebugServiceShape>('ExtHostDebugService'),
681
	ExtHostDecorations: createExtId<ExtHostDecorationsShape>('ExtHostDecorations'),
682 683 684 685 686 687
	ExtHostDocumentsAndEditors: createExtId<ExtHostDocumentsAndEditorsShape>('ExtHostDocumentsAndEditors'),
	ExtHostDocuments: createExtId<ExtHostDocumentsShape>('ExtHostDocuments'),
	ExtHostDocumentContentProviders: createExtId<ExtHostDocumentContentProvidersShape>('ExtHostDocumentContentProviders'),
	ExtHostDocumentSaveParticipant: createExtId<ExtHostDocumentSaveParticipantShape>('ExtHostDocumentSaveParticipant'),
	ExtHostEditors: createExtId<ExtHostEditorsShape>('ExtHostEditors'),
	ExtHostTreeViews: createExtId<ExtHostTreeViewsShape>('ExtHostTreeViews'),
688
	ExtHostFileSystem: createExtId<ExtHostFileSystemShape>('ExtHostFileSystem'),
689 690 691 692 693 694 695 696 697
	ExtHostFileSystemEventService: createExtId<ExtHostFileSystemEventServiceShape>('ExtHostFileSystemEventService'),
	ExtHostHeapService: createExtId<ExtHostHeapServiceShape>('ExtHostHeapMonitor'),
	ExtHostLanguageFeatures: createExtId<ExtHostLanguageFeaturesShape>('ExtHostLanguageFeatures'),
	ExtHostQuickOpen: createExtId<ExtHostQuickOpenShape>('ExtHostQuickOpen'),
	ExtHostExtensionService: createExtId<ExtHostExtensionServiceShape>('ExtHostExtensionService'),
	ExtHostTerminalService: createExtId<ExtHostTerminalServiceShape>('ExtHostTerminalService'),
	ExtHostSCM: createExtId<ExtHostSCMShape>('ExtHostSCM'),
	ExtHostTask: createExtId<ExtHostTaskShape>('ExtHostTask'),
	ExtHostWorkspace: createExtId<ExtHostWorkspaceShape>('ExtHostWorkspace'),
698
	ExtHostWindow: createExtId<ExtHostWindowShape>('ExtHostWindow'),
699
};