extHost.protocol.ts 30.6 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;
79
	windowId: number;
J
Joao Moreno 已提交
80 81
	args: ParsedArgs;
	execPath: string;
82 83
}

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

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

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

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

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

112 113
// --- main thread

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

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

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

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

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

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

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

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

163
export interface MainThreadDocumentsShape extends IDisposable {
164 165 166
	$tryCreateDocument(options?: { language?: string; content?: string; }): TPromise<any>;
	$tryOpenDocument(uri: URI): TPromise<any>;
	$trySaveDocument(uri: URI): TPromise<boolean>;
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 205
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;
}



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

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

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

240
export interface MainThreadTreeViewsShape extends IDisposable {
241
	$registerView(treeViewId: string): void;
S
Sandeep Somavarapu 已提交
242
	$refresh(treeViewId: string, itemsToRefresh?: { [treeItemHandle: string]: ITreeItem }): void;
243 244
}

245
export interface MainThreadErrorsShape extends IDisposable {
246
	$onUnexpectedError(err: any | SerializedError): void;
247 248
}

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

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

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

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

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

294
export interface MainThreadProgressShape extends IDisposable {
295

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

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

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

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

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

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

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

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

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

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

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

355
export interface MainThreadExtensionServiceShape extends IDisposable {
356
	$localShowMessage(severity: Severity, msg: string): void;
A
Alex Dima 已提交
357
	$onExtensionActivated(extensionId: string, startup: boolean, codeLoadingTime: number, activateCallTime: number, activateResolvedTime: number, activationEvent: string): void;
358
	$onExtensionActivationFailed(extensionId: string): void;
359
	$onExtensionRuntimeError(extensionId: string, error: SerializedError): void;
A
Alex Dima 已提交
360
	$addMessage(extensionId: string, severity: Severity, message: string): void;
361 362
}

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

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

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

J
Joao Moreno 已提交
383 384 385
	string | undefined /*source*/,
	string | undefined /*letter*/,
	ThemeColor | null /*color*/
J
Joao Moreno 已提交
386
];
387

388 389 390
export type SCMRawResourceSplice = [
	number /* start */,
	number /* delete count */,
J
Joao 已提交
391 392 393
	SCMRawResource[]
];

394 395 396 397 398
export type SCMRawResourceSplices = [
	number, /*handle*/
	SCMRawResourceSplice[]
];

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

404 405 406 407
	$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 已提交
408

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

J
Joao Moreno 已提交
411
	$setInputBoxValue(sourceControlHandle: number, value: string): void;
412
	$setInputBoxPlaceholder(sourceControlHandle: number, placeholder: string): void;
J
Joao Moreno 已提交
413 414
}

415 416
export type DebugSessionUUID = string;

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

426 427
export interface MainThreadWindowShape extends IDisposable {
	$getWindowVisibility(): TPromise<boolean>;
428 429
}

430 431
// -- extension host

432
export interface ExtHostCommandsShape {
J
Johannes Rieken 已提交
433
	$executeContributedCommand<T>(id: string, ...args: any[]): Thenable<T>;
434
	$getContributedCommandHandlerDescriptions(): Thenable<{ [id: string]: string | ICommandHandlerDescription }>;
435 436
}

437
export interface ExtHostConfigurationShape {
438
	$acceptConfigurationChanged(data: IConfigurationData, eventData: IWorkspaceConfigurationChangeEventData): void;
439 440
}

441
export interface ExtHostDiagnosticsShape {
442 443 444

}

445 446
export interface ExtHostDocumentContentProvidersShape {
	$provideTextDocumentContent(handle: number, uri: URI): TPromise<string>;
447 448
}

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

464 465
export interface ExtHostDocumentSaveParticipantShape {
	$participateInSave(resource: URI, reason: SaveReason): TPromise<boolean[]>;
466 467
}

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

J
Johannes Rieken 已提交
484 485 486 487 488 489 490 491
export interface IDocumentsAndEditorsDelta {
	removedDocuments?: string[];
	addedDocuments?: IModelAddedData[];
	removedEditors?: string[];
	addedEditors?: ITextEditorAddData[];
	newActiveEditor?: string;
}

492 493
export interface ExtHostDocumentsAndEditorsShape {
	$acceptDocumentsAndEditorsDelta(delta: IDocumentsAndEditorsDelta): void;
J
Johannes Rieken 已提交
494 495
}

496 497
export interface ExtHostTreeViewsShape {
	$getElements(treeViewId: string): TPromise<ITreeItem[]>;
S
Sandeep Somavarapu 已提交
498
	$getChildren(treeViewId: string, treeItemHandle: string): TPromise<ITreeItem[]>;
S
Sandeep Somavarapu 已提交
499 500
}

501 502
export interface ExtHostWorkspaceShape {
	$acceptWorkspaceData(workspace: IWorkspaceData): void;
503
}
504

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

518 519
export interface ExtHostExtensionServiceShape {
	$activateByEvent(activationEvent: string): TPromise<void>;
520 521 522 523 524 525 526
}

export interface FileSystemEvents {
	created: URI[];
	changed: URI[];
	deleted: URI[];
}
527
export interface ExtHostFileSystemEventServiceShape {
528
	$onFileEvent(events: FileSystemEvents): void;
529 530
}

J
Johannes Rieken 已提交
531 532 533 534 535
export interface ObjectIdentifier {
	$ident: number;
}

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

546 547
export interface ExtHostHeapServiceShape {
	$onGarbageCollection(ids: number[]): void;
548
}
549
export interface IRawColorInfo {
J
Joao Moreno 已提交
550
	color: [number, number, number, number];
551 552 553
	range: IRange;
}

554 555 556 557 558 559 560 561 562 563 564
export interface IExtHostSuggestion extends modes.ISuggestion {
	_id: number;
	_parentId: number;
}

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

565 566 567 568 569 570 571 572 573 574 575 576 577
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;
578
export interface IWorkspaceSymbols extends IdObject { symbols: IWorkspaceSymbol[]; }
579

580 581 582 583 584 585 586 587 588 589
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[]>;
590
	$provideCodeActions(handle: number, resource: URI, range: IRange): TPromise<modes.CodeAction[]>;
591 592 593
	$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[]>;
594 595 596
	$provideWorkspaceSymbols(handle: number, search: string): TPromise<IWorkspaceSymbols>;
	$resolveWorkspaceSymbol(handle: number, symbol: modes.SymbolInformation): TPromise<IWorkspaceSymbol>;
	$releaseWorkspaceSymbols(handle: number, id: number): void;
597
	$provideRenameEdits(handle: number, resource: URI, position: IPosition, newName: string): TPromise<modes.WorkspaceEdit>;
598
	$provideCompletionItems(handle: number, resource: URI, position: IPosition, context: modes.SuggestContext): TPromise<IExtHostSuggestResult>;
599
	$resolveCompletionItem(handle: number, resource: URI, position: IPosition, suggestion: modes.ISuggestion): TPromise<modes.ISuggestion>;
600
	$releaseCompletionItems(handle: number, id: number): void;
601 602 603
	$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>;
604
	$provideDocumentColors(handle: number, resource: URI): TPromise<IRawColorInfo[]>;
605
	$provideColorPresentations(handle: number, resource: URI, colorInfo: IRawColorInfo): TPromise<modes.IColorPresentation[]>;
606 607
}

608 609 610
export interface ExtHostQuickOpenShape {
	$onItemSelected(handle: number): void;
	$validateInput(input: string): TPromise<string>;
611 612
}

613 614 615
export interface ExtHostTerminalServiceShape {
	$acceptTerminalClosed(id: number): void;
	$acceptTerminalProcessId(id: number, processId: number): void;
616 617
}

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

624 625
export interface ExtHostTaskShape {
	$provideTasks(handle: number): TPromise<TaskSet>;
626 627
}

628 629 630 631 632 633 634 635 636 637
export interface IBreakpointData {
	type: 'source' | 'function';
	id: string;
	enabled: boolean;
	condition?: string;
	hitCondition?: string;
}

export interface ISourceBreakpointData extends IBreakpointData {
	type: 'source';
638
	uri: URI;
639 640
	line: number;
	character: number;
641 642 643 644 645 646 647 648 649 650 651 652 653
}

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

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

654
export interface ExtHostDebugServiceShape {
655 656
	$resolveDebugConfiguration(handle: number, folder: URI | undefined, debugConfiguration: any): TPromise<any>;
	$provideDebugConfigurations(handle: number, folder: URI | undefined): TPromise<any[]>;
657 658 659 660
	$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;
661
	$acceptBreakpointsDelta(delat: IBreakpointsDelta): void;
662 663
}

664

665
export type DecorationData = [number, boolean, string, string, ThemeColor, string];
666 667 668 669 670

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

671 672
export interface ExtHostWindowShape {
	$onDidChangeWindowFocus(value: boolean): void;
673 674
}

675 676 677
// --- proxy identifiers

export const MainContext = {
678 679 680
	MainThreadCommands: createMainId<MainThreadCommandsShape>('MainThreadCommands'),
	MainThreadConfiguration: createMainId<MainThreadConfigurationShape>('MainThreadConfiguration'),
	MainThreadDebugService: createMainId<MainThreadDebugServiceShape>('MainThreadDebugService'),
681
	MainThreadDecorations: createMainId<MainThreadDecorationsShape>('MainThreadDecorations'),
682
	MainThreadDiagnostics: createMainId<MainThreadDiagnosticsShape>('MainThreadDiagnostics'),
683
	MainThreadDialogs: createMainId<MainThreadDiaglogsShape>('MainThreadDiaglogs'),
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
	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'),
700
	MainThreadFileSystem: createMainId<MainThreadFileSystemShape>('MainThreadFileSystem'),
701
	MainThreadExtensionService: createMainId<MainThreadExtensionServiceShape>('MainThreadExtensionService'),
702 703
	MainThreadSCM: createMainId<MainThreadSCMShape>('MainThreadSCM'),
	MainThreadTask: createMainId<MainThreadTaskShape>('MainThreadTask'),
704
	MainThreadWindow: createMainId<MainThreadWindowShape>('MainThreadWindow'),
705 706 707
};

export const ExtHostContext = {
708 709 710 711
	ExtHostCommands: createExtId<ExtHostCommandsShape>('ExtHostCommands'),
	ExtHostConfiguration: createExtId<ExtHostConfigurationShape>('ExtHostConfiguration'),
	ExtHostDiagnostics: createExtId<ExtHostDiagnosticsShape>('ExtHostDiagnostics'),
	ExtHostDebugService: createExtId<ExtHostDebugServiceShape>('ExtHostDebugService'),
712
	ExtHostDecorations: createExtId<ExtHostDecorationsShape>('ExtHostDecorations'),
713 714 715 716 717 718
	ExtHostDocumentsAndEditors: createExtId<ExtHostDocumentsAndEditorsShape>('ExtHostDocumentsAndEditors'),
	ExtHostDocuments: createExtId<ExtHostDocumentsShape>('ExtHostDocuments'),
	ExtHostDocumentContentProviders: createExtId<ExtHostDocumentContentProvidersShape>('ExtHostDocumentContentProviders'),
	ExtHostDocumentSaveParticipant: createExtId<ExtHostDocumentSaveParticipantShape>('ExtHostDocumentSaveParticipant'),
	ExtHostEditors: createExtId<ExtHostEditorsShape>('ExtHostEditors'),
	ExtHostTreeViews: createExtId<ExtHostTreeViewsShape>('ExtHostTreeViews'),
719
	ExtHostFileSystem: createExtId<ExtHostFileSystemShape>('ExtHostFileSystem'),
720 721 722 723 724 725 726 727 728
	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'),
729
	ExtHostWindow: createExtId<ExtHostWindowShape>('ExtHostWindow'),
730
};