extHost.api.impl.ts 34.7 KB
Newer Older
E
Erich Gamma 已提交
1 2 3 4 5 6
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
'use strict';

7
import { Emitter } from 'vs/base/common/event';
8
import { TernarySearchTree } from 'vs/base/common/map';
J
Johannes Rieken 已提交
9
import { score } from 'vs/editor/common/modes/languageSelector';
10
import * as Platform from 'vs/base/common/platform';
E
Erich Gamma 已提交
11
import * as errors from 'vs/base/common/errors';
12 13
import product from 'vs/platform/node/product';
import pkg from 'vs/platform/node/package';
J
Johannes Rieken 已提交
14
import { ExtHostFileSystemEventService } from 'vs/workbench/api/node/extHostFileSystemEventService';
J
Johannes Rieken 已提交
15
import { ExtHostDocumentsAndEditors } from 'vs/workbench/api/node/extHostDocumentsAndEditors';
J
Johannes Rieken 已提交
16
import { ExtHostDocuments } from 'vs/workbench/api/node/extHostDocuments';
17
import { ExtHostDocumentContentProvider } from 'vs/workbench/api/node/extHostDocumentContentProviders';
J
Johannes Rieken 已提交
18 19 20
import { ExtHostDocumentSaveParticipant } from 'vs/workbench/api/node/extHostDocumentSaveParticipant';
import { ExtHostConfiguration } from 'vs/workbench/api/node/extHostConfiguration';
import { ExtHostDiagnostics } from 'vs/workbench/api/node/extHostDiagnostics';
S
Sandeep Somavarapu 已提交
21
import { ExtHostTreeViews } from 'vs/workbench/api/node/extHostTreeViews';
J
Johannes Rieken 已提交
22 23
import { ExtHostWorkspace } from 'vs/workbench/api/node/extHostWorkspace';
import { ExtHostQuickOpen } from 'vs/workbench/api/node/extHostQuickOpen';
24
import { ExtHostProgress } from 'vs/workbench/api/node/extHostProgress';
J
Joao Moreno 已提交
25
import { ExtHostSCM } from 'vs/workbench/api/node/extHostSCM';
J
Johannes Rieken 已提交
26 27 28 29 30 31
import { ExtHostHeapService } from 'vs/workbench/api/node/extHostHeapService';
import { ExtHostStatusBar } from 'vs/workbench/api/node/extHostStatusBar';
import { ExtHostCommands } from 'vs/workbench/api/node/extHostCommands';
import { ExtHostOutputService } from 'vs/workbench/api/node/extHostOutputService';
import { ExtHostTerminalService } from 'vs/workbench/api/node/extHostTerminalService';
import { ExtHostMessageService } from 'vs/workbench/api/node/extHostMessageService';
J
Johannes Rieken 已提交
32
import { ExtHostEditors } from 'vs/workbench/api/node/extHostTextEditors';
J
Johannes Rieken 已提交
33 34
import { ExtHostLanguages } from 'vs/workbench/api/node/extHostLanguages';
import { ExtHostLanguageFeatures } from 'vs/workbench/api/node/extHostLanguageFeatures';
35
import { ExtHostApiCommands } from 'vs/workbench/api/node/extHostApiCommands';
36
import { ExtHostTask } from 'vs/workbench/api/node/extHostTask';
37
import { ExtHostDebugService } from 'vs/workbench/api/node/extHostDebugService';
38
import { ExtHostWindow } from 'vs/workbench/api/node/extHostWindow';
J
Johannes Rieken 已提交
39
import * as extHostTypes from 'vs/workbench/api/node/extHostTypes';
E
Erich Gamma 已提交
40 41
import URI from 'vs/base/common/uri';
import Severity from 'vs/base/common/severity';
J
Johannes Rieken 已提交
42 43 44 45
import { IExtensionDescription } from 'vs/platform/extensions/common/extensions';
import { ExtHostExtensionService } from 'vs/workbench/api/node/extHostExtensionService';
import { TPromise } from 'vs/base/common/winjs.base';
import { CancellationTokenSource } from 'vs/base/common/cancellation';
46
import * as vscode from 'vscode';
E
Erich Gamma 已提交
47
import * as paths from 'vs/base/common/paths';
48
import { MainContext, ExtHostContext, IInitData, IExtHostContext } from './extHost.protocol';
49
import * as languageConfiguration from 'vs/editor/common/modes/languageConfiguration';
50
import { TextEditorCursorStyle } from 'vs/editor/common/config/editorOptions';
A
Alex Dima 已提交
51
import { ProxyIdentifier } from 'vs/workbench/services/extensions/node/proxyIdentifier';
B
Benjamin Pasero 已提交
52
import { ExtHostDialogs } from 'vs/workbench/api/node/extHostDialogs';
53
import { ExtHostFileSystem } from 'vs/workbench/api/node/extHostFileSystem';
54
import { ExtHostDecorations } from 'vs/workbench/api/node/extHostDecorations';
55
import { toGlobPattern, toLanguageSelector } from 'vs/workbench/api/node/extHostTypeConverters';
A
Alex Dima 已提交
56
import { ExtensionActivatedByAPI } from 'vs/workbench/api/node/extHostExtensionActivator';
57
import { isFalsyOrEmpty } from 'vs/base/common/arrays';
A
Alex Dima 已提交
58
import { OverviewRulerLane } from 'vs/editor/common/model';
59
import { ExtHostLogService } from 'vs/workbench/api/node/extHostLogService';
E
Erich Gamma 已提交
60

61
export interface IExtensionApiFactory {
62
	(extension: IExtensionDescription): typeof vscode;
63 64
}

65 66 67 68 69 70 71 72 73 74
export function checkProposedApiEnabled(extension: IExtensionDescription): void {
	if (!extension.enableProposedApi) {
		throwProposedApiError(extension);
	}
}

function throwProposedApiError(extension: IExtensionDescription): never {
	throw new Error(`[${extension.id}]: Proposed API is only available when running out of dev or with the following command line switch: --enable-proposed-api ${extension.id}`);
}

75
function proposedApiFunction<T>(extension: IExtensionDescription, fn: T): T {
76
	if (extension.enableProposedApi) {
77 78
		return fn;
	} else {
79
		return <any>throwProposedApiError;
80 81 82
	}
}

E
Erich Gamma 已提交
83
/**
84
 * This method instantiates and returns the extension API surface
E
Erich Gamma 已提交
85
 */
86 87
export function createApiFactory(
	initData: IInitData,
A
Alex Dima 已提交
88
	rpcProtocol: IExtHostContext,
89 90
	extHostWorkspace: ExtHostWorkspace,
	extHostConfiguration: ExtHostConfiguration,
J
Joao Moreno 已提交
91
	extensionService: ExtHostExtensionService,
92
	extHostLogService: ExtHostLogService
93
): IExtensionApiFactory {
94

95
	// Addressable instances
96
	rpcProtocol.set(ExtHostContext.ExtHostLogService, extHostLogService);
A
Alex Dima 已提交
97 98 99 100 101
	const extHostHeapService = rpcProtocol.set(ExtHostContext.ExtHostHeapService, new ExtHostHeapService());
	const extHostDecorations = rpcProtocol.set(ExtHostContext.ExtHostDecorations, new ExtHostDecorations(rpcProtocol));
	const extHostDocumentsAndEditors = rpcProtocol.set(ExtHostContext.ExtHostDocumentsAndEditors, new ExtHostDocumentsAndEditors(rpcProtocol));
	const extHostDocuments = rpcProtocol.set(ExtHostContext.ExtHostDocuments, new ExtHostDocuments(rpcProtocol, extHostDocumentsAndEditors));
	const extHostDocumentContentProviders = rpcProtocol.set(ExtHostContext.ExtHostDocumentContentProviders, new ExtHostDocumentContentProvider(rpcProtocol, extHostDocumentsAndEditors));
102
	const extHostDocumentSaveParticipant = rpcProtocol.set(ExtHostContext.ExtHostDocumentSaveParticipant, new ExtHostDocumentSaveParticipant(extHostLogService, extHostDocuments, rpcProtocol.getProxy(MainContext.MainThreadEditors)));
A
Alex Dima 已提交
103
	const extHostEditors = rpcProtocol.set(ExtHostContext.ExtHostEditors, new ExtHostEditors(rpcProtocol, extHostDocumentsAndEditors));
104
	const extHostCommands = rpcProtocol.set(ExtHostContext.ExtHostCommands, new ExtHostCommands(rpcProtocol, extHostHeapService, extHostLogService));
A
Alex Dima 已提交
105 106 107 108 109
	const extHostTreeViews = rpcProtocol.set(ExtHostContext.ExtHostTreeViews, new ExtHostTreeViews(rpcProtocol.getProxy(MainContext.MainThreadTreeViews), extHostCommands));
	rpcProtocol.set(ExtHostContext.ExtHostWorkspace, extHostWorkspace);
	const extHostDebugService = rpcProtocol.set(ExtHostContext.ExtHostDebugService, new ExtHostDebugService(rpcProtocol, extHostWorkspace));
	rpcProtocol.set(ExtHostContext.ExtHostConfiguration, extHostConfiguration);
	const extHostDiagnostics = rpcProtocol.set(ExtHostContext.ExtHostDiagnostics, new ExtHostDiagnostics(rpcProtocol));
110 111
	const extHostLanguageFeatures = rpcProtocol.set(ExtHostContext.ExtHostLanguageFeatures, new ExtHostLanguageFeatures(rpcProtocol, extHostDocuments, extHostCommands, extHostHeapService, extHostDiagnostics));
	const extHostFileSystem = rpcProtocol.set(ExtHostContext.ExtHostFileSystem, new ExtHostFileSystem(rpcProtocol, extHostLanguageFeatures));
A
Alex Dima 已提交
112 113 114
	const extHostFileSystemEvent = rpcProtocol.set(ExtHostContext.ExtHostFileSystemEventService, new ExtHostFileSystemEventService());
	const extHostQuickOpen = rpcProtocol.set(ExtHostContext.ExtHostQuickOpen, new ExtHostQuickOpen(rpcProtocol, extHostWorkspace, extHostCommands));
	const extHostTerminalService = rpcProtocol.set(ExtHostContext.ExtHostTerminalService, new ExtHostTerminalService(rpcProtocol));
115
	const extHostSCM = rpcProtocol.set(ExtHostContext.ExtHostSCM, new ExtHostSCM(rpcProtocol, extHostCommands, extHostLogService));
A
Alex Dima 已提交
116 117 118
	const extHostTask = rpcProtocol.set(ExtHostContext.ExtHostTask, new ExtHostTask(rpcProtocol, extHostWorkspace));
	const extHostWindow = rpcProtocol.set(ExtHostContext.ExtHostWindow, new ExtHostWindow(rpcProtocol));
	rpcProtocol.set(ExtHostContext.ExtHostExtensionService, extensionService);
119 120 121

	// Check that no named customers are missing
	const expected: ProxyIdentifier<any>[] = Object.keys(ExtHostContext).map((key) => ExtHostContext[key]);
A
Alex Dima 已提交
122
	rpcProtocol.assertRegistered(expected);
123

124
	// Other instances
A
Alex Dima 已提交
125 126 127 128 129 130
	const extHostMessageService = new ExtHostMessageService(rpcProtocol);
	const extHostDialogs = new ExtHostDialogs(rpcProtocol);
	const extHostStatusBar = new ExtHostStatusBar(rpcProtocol);
	const extHostProgress = new ExtHostProgress(rpcProtocol.getProxy(MainContext.MainThreadProgress));
	const extHostOutputService = new ExtHostOutputService(rpcProtocol);
	const extHostLanguages = new ExtHostLanguages(rpcProtocol);
131

132 133
	// Register API-ish commands
	ExtHostApiCommands.register(extHostCommands);
134

135
	return function (extension: IExtensionDescription): typeof vscode {
136

137 138 139 140 141 142
		if (!isFalsyOrEmpty(product.extensionAllowedProposedApi)
			&& product.extensionAllowedProposedApi.indexOf(extension.id) >= 0
		) {
			// fast lane -> proposed api is available to all extensions
			// that are listed in product.json-files
			extension.enableProposedApi = true;
143

144
		} else if (extension.enableProposedApi && !extension.isBuiltin) {
145 146 147 148
			if (
				!initData.environment.enableProposedApiForAll &&
				initData.environment.enableProposedApiFor.indexOf(extension.id) < 0
			) {
149
				extension.enableProposedApi = false;
150
				console.error(`Extension '${extension.id} cannot use PROPOSED API (must started out of dev or enabled via --enable-proposed-api)`);
151 152

			} else {
153 154 155
				// proposed api is available when developing or when an extension was explicitly
				// spelled out via a command line argument
				console.warn(`Extension '${extension.id}' uses PROPOSED API which is subject to change and removal without notice.`);
156
			}
157 158
		}

159 160
		// namespace: commands
		const commands: typeof vscode.commands = {
M
Matt Bierner 已提交
161
			registerCommand(id: string, command: <T>(...args: any[]) => T | Thenable<T>, thisArgs?: any): vscode.Disposable {
162
				return extHostCommands.registerCommand(id, command, thisArgs);
163
			},
164
			registerTextEditorCommand(id: string, callback: (textEditor: vscode.TextEditor, edit: vscode.TextEditorEdit, ...args: any[]) => void, thisArg?: any): vscode.Disposable {
165
				return extHostCommands.registerCommand(id, (...args: any[]): any => {
166 167 168
					let activeTextEditor = extHostEditors.getActiveTextEditor();
					if (!activeTextEditor) {
						console.warn('Cannot execute ' + id + ' because there is no active text editor.');
169
						return undefined;
170
					}
171 172 173 174 175 176 177 178 179 180

					return activeTextEditor.edit((edit: vscode.TextEditorEdit) => {
						args.unshift(activeTextEditor, edit);
						callback.apply(thisArg, args);

					}).then((result) => {
						if (!result) {
							console.warn('Edits from command ' + id + ' were not applied.');
						}
					}, (err) => {
181
						console.warn('An error occurred while running command ' + id, err);
182
					});
183
				});
184 185
			},
			registerDiffInformationCommand: proposedApiFunction(extension, (id: string, callback: (diff: vscode.LineChange[], ...args: any[]) => any, thisArg?: any): vscode.Disposable => {
186 187 188 189 190 191 192 193 194 195
				return extHostCommands.registerCommand(id, async (...args: any[]) => {
					let activeTextEditor = extHostEditors.getActiveTextEditor();
					if (!activeTextEditor) {
						console.warn('Cannot execute ' + id + ' because there is no active text editor.');
						return undefined;
					}

					const diff = await extHostEditors.getDiffInformation(activeTextEditor.id);
					callback.apply(thisArg, [diff, ...args]);
				});
196
			}),
197
			executeCommand<T>(id: string, ...args: any[]): Thenable<T> {
198
				return extHostCommands.executeCommand<T>(id, ...args);
199
			},
200 201 202
			getCommands(filterInternal: boolean = false): Thenable<string[]> {
				return extHostCommands.getCommands(filterInternal);
			}
203
		};
204

205 206
		// namespace: env
		const env: typeof vscode.env = Object.freeze({
207 208
			get machineId() { return initData.telemetryInfo.machineId; },
			get sessionId() { return initData.telemetryInfo.sessionId; },
209
			get language() { return Platform.language; },
J
Johannes Rieken 已提交
210 211
			get appName() { return product.nameLong; },
			get appRoot() { return initData.environment.appRoot; },
212
		});
E
Erich Gamma 已提交
213

214 215 216
		// namespace: extensions
		const extensions: typeof vscode.extensions = {
			getExtension(extensionId: string): Extension<any> {
217
				let desc = extensionService.getExtensionDescription(extensionId);
218 219 220
				if (desc) {
					return new Extension(extensionService, desc);
				}
221
				return undefined;
222 223
			},
			get all(): Extension<any>[] {
224
				return extensionService.getAllExtensionDescriptions().map((desc) => new Extension(extensionService, desc));
E
Erich Gamma 已提交
225
			}
226
		};
E
Erich Gamma 已提交
227

228 229 230 231 232 233 234 235 236
		// namespace: languages
		const languages: typeof vscode.languages = {
			createDiagnosticCollection(name?: string): vscode.DiagnosticCollection {
				return extHostDiagnostics.createDiagnosticCollection(name);
			},
			getLanguages(): TPromise<string[]> {
				return extHostLanguages.getLanguages();
			},
			match(selector: vscode.DocumentSelector, document: vscode.TextDocument): number {
237
				return score(toLanguageSelector(selector), document.uri, document.languageId);
238 239
			},
			registerCodeActionsProvider(selector: vscode.DocumentSelector, provider: vscode.CodeActionProvider): vscode.Disposable {
240
				return extHostLanguageFeatures.registerCodeActionProvider(selector, provider);
241 242
			},
			registerCodeLensProvider(selector: vscode.DocumentSelector, provider: vscode.CodeLensProvider): vscode.Disposable {
243
				return extHostLanguageFeatures.registerCodeLensProvider(selector, provider);
244 245
			},
			registerDefinitionProvider(selector: vscode.DocumentSelector, provider: vscode.DefinitionProvider): vscode.Disposable {
246
				return extHostLanguageFeatures.registerDefinitionProvider(selector, provider);
247
			},
M
Matt Bierner 已提交
248
			registerImplementationProvider(selector: vscode.DocumentSelector, provider: vscode.ImplementationProvider): vscode.Disposable {
249
				return extHostLanguageFeatures.registerImplementationProvider(selector, provider);
250
			},
251
			registerTypeDefinitionProvider(selector: vscode.DocumentSelector, provider: vscode.TypeDefinitionProvider): vscode.Disposable {
252
				return extHostLanguageFeatures.registerTypeDefinitionProvider(selector, provider);
253
			},
254
			registerHoverProvider(selector: vscode.DocumentSelector, provider: vscode.HoverProvider): vscode.Disposable {
255
				return extHostLanguageFeatures.registerHoverProvider(selector, provider, extension.id);
256 257
			},
			registerDocumentHighlightProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentHighlightProvider): vscode.Disposable {
258
				return extHostLanguageFeatures.registerDocumentHighlightProvider(selector, provider);
259 260
			},
			registerReferenceProvider(selector: vscode.DocumentSelector, provider: vscode.ReferenceProvider): vscode.Disposable {
261
				return extHostLanguageFeatures.registerReferenceProvider(selector, provider);
262 263
			},
			registerRenameProvider(selector: vscode.DocumentSelector, provider: vscode.RenameProvider): vscode.Disposable {
264
				return extHostLanguageFeatures.registerRenameProvider(selector, provider);
265 266
			},
			registerDocumentSymbolProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentSymbolProvider): vscode.Disposable {
267
				return extHostLanguageFeatures.registerDocumentSymbolProvider(selector, provider);
268 269
			},
			registerWorkspaceSymbolProvider(provider: vscode.WorkspaceSymbolProvider): vscode.Disposable {
270
				return extHostLanguageFeatures.registerWorkspaceSymbolProvider(provider);
271 272
			},
			registerDocumentFormattingEditProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentFormattingEditProvider): vscode.Disposable {
273
				return extHostLanguageFeatures.registerDocumentFormattingEditProvider(selector, provider);
274 275
			},
			registerDocumentRangeFormattingEditProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentRangeFormattingEditProvider): vscode.Disposable {
276
				return extHostLanguageFeatures.registerDocumentRangeFormattingEditProvider(selector, provider);
277 278
			},
			registerOnTypeFormattingEditProvider(selector: vscode.DocumentSelector, provider: vscode.OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacters: string[]): vscode.Disposable {
279
				return extHostLanguageFeatures.registerOnTypeFormattingEditProvider(selector, provider, [firstTriggerCharacter].concat(moreTriggerCharacters));
280 281
			},
			registerSignatureHelpProvider(selector: vscode.DocumentSelector, provider: vscode.SignatureHelpProvider, ...triggerCharacters: string[]): vscode.Disposable {
282
				return extHostLanguageFeatures.registerSignatureHelpProvider(selector, provider, triggerCharacters);
283 284
			},
			registerCompletionItemProvider(selector: vscode.DocumentSelector, provider: vscode.CompletionItemProvider, ...triggerCharacters: string[]): vscode.Disposable {
285
				return extHostLanguageFeatures.registerCompletionItemProvider(selector, provider, triggerCharacters);
286 287
			},
			registerDocumentLinkProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentLinkProvider): vscode.Disposable {
288
				return extHostLanguageFeatures.registerDocumentLinkProvider(selector, provider);
289
			},
290
			registerColorProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentColorProvider): vscode.Disposable {
291
				return extHostLanguageFeatures.registerColorProvider(selector, provider);
292
			},
293
			setLanguageConfiguration: (language: string, configuration: vscode.LanguageConfiguration): vscode.Disposable => {
294
				return extHostLanguageFeatures.setLanguageConfiguration(language, configuration);
295
			}
296
		};
E
Erich Gamma 已提交
297

298 299 300 301 302 303 304 305
		// namespace: window
		const window: typeof vscode.window = {
			get activeTextEditor() {
				return extHostEditors.getActiveTextEditor();
			},
			get visibleTextEditors() {
				return extHostEditors.getVisibleTextEditors();
			},
J
Johannes Rieken 已提交
306
			showTextDocument(documentOrUri: vscode.TextDocument | vscode.Uri, columnOrOptions?: vscode.ViewColumn | vscode.TextDocumentShowOptions, preserveFocus?: boolean): TPromise<vscode.TextEditor> {
B
Benjamin Pasero 已提交
307
				let documentPromise: TPromise<vscode.TextDocument>;
J
Johannes Rieken 已提交
308 309
				if (URI.isUri(documentOrUri)) {
					documentPromise = TPromise.wrap(workspace.openTextDocument(documentOrUri));
B
Benjamin Pasero 已提交
310
				} else {
J
Johannes Rieken 已提交
311
					documentPromise = TPromise.wrap(<vscode.TextDocument>documentOrUri);
B
Benjamin Pasero 已提交
312 313 314 315
				}
				return documentPromise.then(document => {
					return extHostEditors.showTextDocument(document, columnOrOptions, preserveFocus);
				});
316 317 318 319
			},
			createTextEditorDecorationType(options: vscode.DecorationRenderOptions): vscode.TextEditorDecorationType {
				return extHostEditors.createTextEditorDecorationType(options);
			},
320 321 322
			onDidChangeActiveTextEditor(listener, thisArg?, disposables?) {
				return extHostEditors.onDidChangeActiveTextEditor(listener, thisArg, disposables);
			},
323 324 325
			onDidChangeVisibleTextEditors(listener, thisArg, disposables) {
				return extHostEditors.onDidChangeVisibleTextEditors(listener, thisArg, disposables);
			},
326
			onDidChangeTextEditorSelection(listener: (e: vscode.TextEditorSelectionChangeEvent) => any, thisArgs?: any, disposables?: extHostTypes.Disposable[]) {
327 328
				return extHostEditors.onDidChangeTextEditorSelection(listener, thisArgs, disposables);
			},
329
			onDidChangeTextEditorOptions(listener: (e: vscode.TextEditorOptionsChangeEvent) => any, thisArgs?: any, disposables?: extHostTypes.Disposable[]) {
330 331 332 333 334
				return extHostEditors.onDidChangeTextEditorOptions(listener, thisArgs, disposables);
			},
			onDidChangeTextEditorViewColumn(listener, thisArg?, disposables?) {
				return extHostEditors.onDidChangeTextEditorViewColumn(listener, thisArg, disposables);
			},
335 336 337
			onDidCloseTerminal(listener, thisArg?, disposables?) {
				return extHostTerminalService.onDidCloseTerminal(listener, thisArg, disposables);
			},
J
Joao Moreno 已提交
338 339
			get state() {
				return extHostWindow.state;
340
			},
J
Joao Moreno 已提交
341
			onDidChangeWindowState(listener, thisArg?, disposables?) {
J
Joao Moreno 已提交
342
				return extHostWindow.onDidChangeWindowState(listener, thisArg, disposables);
J
Joao Moreno 已提交
343
			},
J
Joao Moreno 已提交
344
			showInformationMessage(message, first, ...rest) {
345
				return extHostMessageService.showMessage(extension, Severity.Info, message, first, rest);
346
			},
J
Joao Moreno 已提交
347
			showWarningMessage(message, first, ...rest) {
348
				return extHostMessageService.showMessage(extension, Severity.Warning, message, first, rest);
349
			},
J
Joao Moreno 已提交
350
			showErrorMessage(message, first, ...rest) {
351
				return extHostMessageService.showMessage(extension, Severity.Error, message, first, rest);
352
			},
353
			showQuickPick(items: any, options: vscode.QuickPickOptions, token?: vscode.CancellationToken) {
354 355
				return extHostQuickOpen.showQuickPick(items, options, token);
			},
356
			showWorkspaceFolderPick(options: vscode.WorkspaceFolderPickOptions) {
357
				return extHostQuickOpen.showWorkspaceFolderPick(options);
358
			},
359 360 361
			showInputBox(options?: vscode.InputBoxOptions, token?: vscode.CancellationToken) {
				return extHostQuickOpen.showInput(options, token);
			},
362 363 364 365 366 367
			showOpenDialog(options) {
				return extHostDialogs.showOpenDialog(options);
			},
			showSaveDialog(options) {
				return extHostDialogs.showSaveDialog(options);
			},
368
			createStatusBarItem(position?: vscode.StatusBarAlignment, priority?: number): vscode.StatusBarItem {
369
				return extHostStatusBar.createStatusBarEntry(extension.id, <number>position, priority);
370 371 372 373
			},
			setStatusBarMessage(text: string, timeoutOrThenable?: number | Thenable<any>): vscode.Disposable {
				return extHostStatusBar.setStatusBarMessage(text, timeoutOrThenable);
			},
374
			withScmProgress<R>(task: (progress: vscode.Progress<number>) => Thenable<R>) {
375
				console.warn(`[Deprecation Warning] function 'withScmProgress' is deprecated and should no longer be used. Use 'withProgress' instead.`);
376
				return extHostProgress.withProgress(extension, { location: extHostTypes.ProgressLocation.SourceControl }, (progress, token) => task({ report(n: number) { /*noop*/ } }));
J
Johannes Rieken 已提交
377 378 379
			},
			withProgress<R>(options: vscode.ProgressOptions, task: (progress: vscode.Progress<{ message?: string; percentage?: number }>) => Thenable<R>) {
				return extHostProgress.withProgress(extension, options, task);
380
			},
381 382 383
			createOutputChannel(name: string): vscode.OutputChannel {
				return extHostOutputService.createOutputChannel(name);
			},
384 385 386 387
			createTerminal(nameOrOptions: vscode.TerminalOptions | string, shellPath?: string, shellArgs?: string[]): vscode.Terminal {
				if (typeof nameOrOptions === 'object') {
					return extHostTerminalService.createTerminalFromOptions(<vscode.TerminalOptions>nameOrOptions);
				}
D
Daniel Imms 已提交
388
				return extHostTerminalService.createTerminal(<string>nameOrOptions, shellPath, shellArgs);
389
			},
S
Sandeep Somavarapu 已提交
390 391 392
			registerTreeDataProvider(viewId: string, treeDataProvider: vscode.TreeDataProvider<any>): vscode.Disposable {
				return extHostTreeViews.registerTreeDataProvider(viewId, treeDataProvider);
			},
393 394
			// proposed API
			sampleFunction: proposedApiFunction(extension, () => {
395
				return extHostMessageService.showMessage(extension, Severity.Info, 'Hello Proposed Api!', {}, []);
396
			}),
397 398
			registerDecorationProvider: proposedApiFunction(extension, (provider: vscode.DecorationProvider) => {
				return extHostDecorations.registerDecorationProvider(provider, extension.id);
399
			})
400
		};
E
Erich Gamma 已提交
401

402 403 404 405 406 407 408 409
		// namespace: workspace
		const workspace: typeof vscode.workspace = {
			get rootPath() {
				return extHostWorkspace.getPath();
			},
			set rootPath(value) {
				throw errors.readonly();
			},
410 411
			getWorkspaceFolder(resource) {
				return extHostWorkspace.getWorkspaceFolder(resource);
412
			},
413
			get workspaceFolders() {
414
				return extHostWorkspace.getWorkspaceFolders();
415
			},
416 417 418 419 420 421
			get name() {
				return extHostWorkspace.workspace ? extHostWorkspace.workspace.name : undefined;
			},
			set name(value) {
				throw errors.readonly();
			},
B
Benjamin Pasero 已提交
422
			updateWorkspaceFolders: proposedApiFunction(extension, (index, deleteCount, ...workspaceFoldersToAdd) => {
B
Benjamin Pasero 已提交
423
				return extHostWorkspace.updateWorkspaceFolders(extension, index, deleteCount, ...workspaceFoldersToAdd);
424
			}),
425
			onDidChangeWorkspaceFolders: function (listener, thisArgs?, disposables?) {
426
				return extHostWorkspace.onDidChangeWorkspace(listener, thisArgs, disposables);
427
			},
J
Johannes Rieken 已提交
428 429
			asRelativePath: (pathOrUri, includeWorkspace) => {
				return extHostWorkspace.getRelativePath(pathOrUri, includeWorkspace);
430 431
			},
			findFiles: (include, exclude, maxResults?, token?) => {
432
				return extHostWorkspace.findFiles(toGlobPattern(include), toGlobPattern(exclude), maxResults, token);
433 434 435 436 437
			},
			saveAll: (includeUntitled?) => {
				return extHostWorkspace.saveAll(includeUntitled);
			},
			applyEdit(edit: vscode.WorkspaceEdit): TPromise<boolean> {
438
				return extHostEditors.applyWorkspaceEdit(edit);
439 440
			},
			createFileSystemWatcher: (pattern, ignoreCreate, ignoreChange, ignoreDelete): vscode.FileSystemWatcher => {
441
				return extHostFileSystemEvent.createFileSystemWatcher(toGlobPattern(pattern), ignoreCreate, ignoreChange, ignoreDelete);
442 443 444 445 446 447 448
			},
			get textDocuments() {
				return extHostDocuments.getAllDocumentData().map(data => data.document);
			},
			set textDocuments(value) {
				throw errors.readonly();
			},
449
			openTextDocument(uriOrFileNameOrOptions?: vscode.Uri | string | { language?: string; content?: string; }) {
B
Benjamin Pasero 已提交
450 451
				let uriPromise: TPromise<URI>;

452
				let options = uriOrFileNameOrOptions as { language?: string; content?: string; };
B
Benjamin Pasero 已提交
453
				if (typeof uriOrFileNameOrOptions === 'string') {
B
Benjamin Pasero 已提交
454 455
					uriPromise = TPromise.as(URI.file(uriOrFileNameOrOptions));
				} else if (uriOrFileNameOrOptions instanceof URI) {
J
Johannes Rieken 已提交
456
					uriPromise = TPromise.as(uriOrFileNameOrOptions);
B
Benjamin Pasero 已提交
457 458
				} else if (!options || typeof options === 'object') {
					uriPromise = extHostDocuments.createDocumentData(options);
459
				} else {
B
Benjamin Pasero 已提交
460
					throw new Error('illegal argument - uriOrFileNameOrOptions');
461
				}
B
Benjamin Pasero 已提交
462 463 464 465 466 467

				return uriPromise.then(uri => {
					return extHostDocuments.ensureDocumentData(uri).then(() => {
						const data = extHostDocuments.getDocumentData(uri);
						return data && data.document;
					});
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
				});
			},
			onDidOpenTextDocument: (listener, thisArgs?, disposables?) => {
				return extHostDocuments.onDidAddDocument(listener, thisArgs, disposables);
			},
			onDidCloseTextDocument: (listener, thisArgs?, disposables?) => {
				return extHostDocuments.onDidRemoveDocument(listener, thisArgs, disposables);
			},
			onDidChangeTextDocument: (listener, thisArgs?, disposables?) => {
				return extHostDocuments.onDidChangeDocument(listener, thisArgs, disposables);
			},
			onDidSaveTextDocument: (listener, thisArgs?, disposables?) => {
				return extHostDocuments.onDidSaveDocument(listener, thisArgs, disposables);
			},
			onWillSaveTextDocument: (listener, thisArgs?, disposables?) => {
483
				return extHostDocumentSaveParticipant.getOnWillSaveTextDocumentEvent(extension)(listener, thisArgs, disposables);
484
			},
485
			onDidChangeConfiguration: (listener: (_: any) => any, thisArgs?: any, disposables?: extHostTypes.Disposable[]) => {
486 487
				return extHostConfiguration.onDidChangeConfiguration(listener, thisArgs, disposables);
			},
488 489
			getConfiguration(section?: string, resource?: vscode.Uri): vscode.WorkspaceConfiguration {
				resource = arguments.length === 1 ? void 0 : resource;
S
Sandeep Somavarapu 已提交
490
				return extHostConfiguration.getConfiguration(section, resource, extension.id);
491
			},
492 493
			registerTextDocumentContentProvider(scheme: string, provider: vscode.TextDocumentContentProvider) {
				return extHostDocumentContentProviders.registerTextDocumentContentProvider(scheme, provider);
494
			},
495
			registerTaskProvider: (type: string, provider: vscode.TaskProvider) => {
496
				return extHostTask.registerTaskProvider(extension, provider);
J
Johannes Rieken 已提交
497 498
			},
			registerFileSystemProvider: proposedApiFunction(extension, (authority, provider) => {
499
				return extHostFileSystem.registerFileSystemProvider(authority, provider);
J
Johannes Rieken 已提交
500
			})
501
		};
502

503 504
		// namespace: scm
		const scm: typeof vscode.scm = {
505
			get inputBox() {
J
Joao Moreno 已提交
506
				return extHostSCM.getLastInputBox(extension);
507
			},
J
Joao Moreno 已提交
508 509
			createSourceControl(id: string, label: string, rootUri?: vscode.Uri) {
				return extHostSCM.createSourceControl(extension, id, label, rootUri);
J
Joao Moreno 已提交
510
			}
511
		};
J
Joao Moreno 已提交
512

513 514
		// namespace: debug
		const debug: typeof vscode.debug = {
515 516 517
			get activeDebugSession() {
				return extHostDebugService.activeDebugSession;
			},
518 519
			get activeDebugConsole() {
				return extHostDebugService.activeDebugConsole;
520
			},
521 522
			get breakpoints() {
				return extHostDebugService.breakpoints;
523
			},
524 525 526
			onDidStartDebugSession(listener, thisArg?, disposables?) {
				return extHostDebugService.onDidStartDebugSession(listener, thisArg, disposables);
			},
527
			onDidTerminateDebugSession(listener, thisArg?, disposables?) {
528
				return extHostDebugService.onDidTerminateDebugSession(listener, thisArg, disposables);
529
			},
A
Andre Weinand 已提交
530
			onDidChangeActiveDebugSession(listener, thisArg?, disposables?) {
531
				return extHostDebugService.onDidChangeActiveDebugSession(listener, thisArg, disposables);
A
Andre Weinand 已提交
532 533
			},
			onDidReceiveDebugSessionCustomEvent(listener, thisArg?, disposables?) {
A
Andre Weinand 已提交
534
				return extHostDebugService.onDidReceiveDebugSessionCustomEvent(listener, thisArg, disposables);
535
			},
536 537 538 539 540 541
			onDidChangeBreakpoints: proposedApiFunction(extension, (listener, thisArgs?, disposables?) => {
				return extHostDebugService.onDidChangeBreakpoints(listener, thisArgs, disposables);
			}),
			startDebugging(folder: vscode.WorkspaceFolder | undefined, nameOrConfig: string | vscode.DebugConfiguration) {
				return extHostDebugService.startDebugging(folder, nameOrConfig);
			},
A
Andre Weinand 已提交
542
			registerDebugConfigurationProvider(debugType: string, provider: vscode.DebugConfigurationProvider) {
543
				return extHostDebugService.registerDebugConfigurationProvider(debugType, provider);
544 545 546 547 548 549 550
			},
			addBreakpoints: proposedApiFunction(extension, (breakpoints: vscode.Breakpoint[]) => {
				return extHostDebugService.addBreakpoints(breakpoints);
			}),
			removeBreakpoints: proposedApiFunction(extension, (breakpoints: vscode.Breakpoint[]) => {
				return extHostDebugService.removeBreakpoints(breakpoints);
			})
551 552 553
		};


554
		return <typeof vscode>{
555 556 557 558 559 560 561 562
			version: pkg.version,
			// namespaces
			commands,
			env,
			extensions,
			languages,
			window,
			workspace,
J
Joao Moreno 已提交
563
			scm,
564
			debug,
565
			// types
566
			Breakpoint: extHostTypes.Breakpoint,
567
			CancellationTokenSource: CancellationTokenSource,
568
			CodeAction: extHostTypes.CodeAction,
M
Matt Bierner 已提交
569
			CodeActionKind: extHostTypes.CodeActionKind,
570
			CodeLens: extHostTypes.CodeLens,
571
			Color: extHostTypes.Color,
572 573
			ColorPresentation: extHostTypes.ColorPresentation,
			ColorInformation: extHostTypes.ColorInformation,
574
			EndOfLine: extHostTypes.EndOfLine,
575 576 577
			CompletionItem: extHostTypes.CompletionItem,
			CompletionItemKind: extHostTypes.CompletionItemKind,
			CompletionList: extHostTypes.CompletionList,
M
Matt Bierner 已提交
578
			CompletionTriggerKind: extHostTypes.CompletionTriggerKind,
579 580 581 582 583
			Diagnostic: extHostTypes.Diagnostic,
			DiagnosticSeverity: extHostTypes.DiagnosticSeverity,
			Disposable: extHostTypes.Disposable,
			DocumentHighlight: extHostTypes.DocumentHighlight,
			DocumentHighlightKind: extHostTypes.DocumentHighlightKind,
584
			DocumentLink: extHostTypes.DocumentLink,
585
			EventEmitter: Emitter,
586
			FunctionBreakpoint: extHostTypes.FunctionBreakpoint,
587
			Hover: extHostTypes.Hover,
588
			IndentAction: languageConfiguration.IndentAction,
589
			Location: extHostTypes.Location,
590
			LogLevel: extHostTypes.LogLevel,
591
			MarkdownString: extHostTypes.MarkdownString,
592
			OverviewRulerLane: OverviewRulerLane,
593 594 595 596 597 598 599
			ParameterInformation: extHostTypes.ParameterInformation,
			Position: extHostTypes.Position,
			Range: extHostTypes.Range,
			Selection: extHostTypes.Selection,
			SignatureHelp: extHostTypes.SignatureHelp,
			SignatureInformation: extHostTypes.SignatureInformation,
			SnippetString: extHostTypes.SnippetString,
600
			SourceBreakpoint: extHostTypes.SourceBreakpoint,
601 602 603 604 605
			StatusBarAlignment: extHostTypes.StatusBarAlignment,
			SymbolInformation: extHostTypes.SymbolInformation,
			SymbolKind: extHostTypes.SymbolKind,
			TextDocumentSaveReason: extHostTypes.TextDocumentSaveReason,
			TextEdit: extHostTypes.TextEdit,
606
			TextEditorCursorStyle: TextEditorCursorStyle,
607
			TextEditorLineNumbersStyle: extHostTypes.TextEditorLineNumbersStyle,
608
			TextEditorRevealType: extHostTypes.TextEditorRevealType,
609
			TextEditorSelectionChangeKind: extHostTypes.TextEditorSelectionChangeKind,
610
			DecorationRangeBehavior: extHostTypes.DecorationRangeBehavior,
611
			Uri: URI,
612 613
			ViewColumn: extHostTypes.ViewColumn,
			WorkspaceEdit: extHostTypes.WorkspaceEdit,
J
Johannes Rieken 已提交
614
			ProgressLocation: extHostTypes.ProgressLocation,
S
Sandeep Somavarapu 已提交
615
			TreeItemCollapsibleState: extHostTypes.TreeItemCollapsibleState,
S
Sandeep Somavarapu 已提交
616
			TreeItem: extHostTypes.TreeItem,
617
			ThemeColor: extHostTypes.ThemeColor,
J
Joao Moreno 已提交
618
			// functions
619
			TaskRevealKind: extHostTypes.TaskRevealKind,
620
			TaskPanelKind: extHostTypes.TaskPanelKind,
621
			TaskGroup: extHostTypes.TaskGroup,
D
Dirk Baeumer 已提交
622 623
			ProcessExecution: extHostTypes.ProcessExecution,
			ShellExecution: extHostTypes.ShellExecution,
D
Dirk Baeumer 已提交
624
			TaskScope: extHostTypes.TaskScope,
S
Sandeep Somavarapu 已提交
625
			Task: extHostTypes.Task,
626
			ConfigurationTarget: extHostTypes.ConfigurationTarget,
627
			RelativePattern: extHostTypes.RelativePattern,
628

J
Johannes Rieken 已提交
629 630
			FileChangeType: extHostTypes.FileChangeType,
			FileType: extHostTypes.FileType
631
		};
632
	};
E
Erich Gamma 已提交
633 634 635 636
}

class Extension<T> implements vscode.Extension<T> {

A
Alex Dima 已提交
637
	private _extensionService: ExtHostExtensionService;
E
Erich Gamma 已提交
638 639 640 641 642

	public id: string;
	public extensionPath: string;
	public packageJSON: any;

J
Johannes Rieken 已提交
643
	constructor(extensionService: ExtHostExtensionService, description: IExtensionDescription) {
A
Alex Dima 已提交
644
		this._extensionService = extensionService;
E
Erich Gamma 已提交
645 646 647 648 649 650
		this.id = description.id;
		this.extensionPath = paths.normalize(description.extensionFolderPath, true);
		this.packageJSON = description;
	}

	get isActive(): boolean {
A
Alex Dima 已提交
651
		return this._extensionService.isActivated(this.id);
E
Erich Gamma 已提交
652 653 654
	}

	get exports(): T {
A
Alex Dima 已提交
655
		return <T>this._extensionService.getExtensionExports(this.id);
E
Erich Gamma 已提交
656 657 658
	}

	activate(): Thenable<T> {
A
Alex Dima 已提交
659
		return this._extensionService.activateById(this.id, new ExtensionActivatedByAPI(false)).then(() => this.exports);
E
Erich Gamma 已提交
660 661 662
	}
}

J
Johannes Rieken 已提交
663
export function initializeExtensionApi(extensionService: ExtHostExtensionService, apiFactory: IExtensionApiFactory): TPromise<void> {
664
	return extensionService.getExtensionPathIndex().then(trie => defineAPI(apiFactory, trie));
J
Johannes Rieken 已提交
665 666
}

667
function defineAPI(factory: IExtensionApiFactory, extensionPaths: TernarySearchTree<IExtensionDescription>): void {
J
Johannes Rieken 已提交
668 669

	// each extension is meant to get its own api implementation
J
Johannes Rieken 已提交
670
	const extApiImpl = new Map<string, typeof vscode>();
J
Johannes Rieken 已提交
671
	let defaultApiImpl: typeof vscode;
672 673 674

	const node_module = <any>require.__$__nodeRequire('module');
	const original = node_module._load;
E
Erich Gamma 已提交
675
	node_module._load = function load(request, parent, isMain) {
676 677 678 679 680
		if (request !== 'vscode') {
			return original.apply(this, arguments);
		}

		// get extension id from filename and api for extension
J
Johannes Rieken 已提交
681
		const ext = extensionPaths.findSubstr(parent.filename);
682
		if (ext) {
J
Johannes Rieken 已提交
683
			let apiImpl = extApiImpl.get(ext.id);
684
			if (!apiImpl) {
J
Johannes Rieken 已提交
685 686
				apiImpl = factory(ext);
				extApiImpl.set(ext.id, apiImpl);
687 688 689 690 691 692
			}
			return apiImpl;
		}

		// fall back to a default implementation
		if (!defaultApiImpl) {
693
			defaultApiImpl = factory(nullExtensionDescription);
E
Erich Gamma 已提交
694
		}
695
		return defaultApiImpl;
E
Erich Gamma 已提交
696 697
	};
}
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712

const nullExtensionDescription: IExtensionDescription = {
	id: 'nullExtensionDescription',
	name: 'Null Extension Description',
	publisher: 'vscode',
	activationEvents: undefined,
	contributes: undefined,
	enableProposedApi: false,
	engines: undefined,
	extensionDependencies: undefined,
	extensionFolderPath: undefined,
	isBuiltin: false,
	main: undefined,
	version: undefined
};