extHost.api.impl.ts 36.6 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';
42
import { IExtensionDescription } from 'vs/workbench/services/extensions/common/extensions';
J
Johannes Rieken 已提交
43 44 45
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';
M
Matt Bierner 已提交
60
import { ExtHostWebviews } from 'vs/workbench/api/node/extHostWebview';
E
Erich Gamma 已提交
61

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

66 67 68 69 70 71 72 73 74 75
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}`);
}

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

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

96
	// Addressable instances
97
	rpcProtocol.set(ExtHostContext.ExtHostLogService, extHostLogService);
A
Alex Dima 已提交
98 99
	const extHostHeapService = rpcProtocol.set(ExtHostContext.ExtHostHeapService, new ExtHostHeapService());
	const extHostDecorations = rpcProtocol.set(ExtHostContext.ExtHostDecorations, new ExtHostDecorations(rpcProtocol));
M
Matt Bierner 已提交
100 101
	const extHostWebviews = rpcProtocol.set(ExtHostContext.ExtHostWebviews, new ExtHostWebviews(rpcProtocol));
	const extHostDocumentsAndEditors = rpcProtocol.set(ExtHostContext.ExtHostDocumentsAndEditors, new ExtHostDocumentsAndEditors(rpcProtocol, extHostWebviews));
A
Alex Dima 已提交
102
	const extHostDocuments = rpcProtocol.set(ExtHostContext.ExtHostDocuments, new ExtHostDocuments(rpcProtocol, extHostDocumentsAndEditors));
103
	const extHostDocumentContentProviders = rpcProtocol.set(ExtHostContext.ExtHostDocumentContentProviders, new ExtHostDocumentContentProvider(rpcProtocol, extHostDocumentsAndEditors, extHostLogService));
104
	const extHostDocumentSaveParticipant = rpcProtocol.set(ExtHostContext.ExtHostDocumentSaveParticipant, new ExtHostDocumentSaveParticipant(extHostLogService, extHostDocuments, rpcProtocol.getProxy(MainContext.MainThreadTextEditors)));
A
Alex Dima 已提交
105
	const extHostEditors = rpcProtocol.set(ExtHostContext.ExtHostEditors, new ExtHostEditors(rpcProtocol, extHostDocumentsAndEditors));
106
	const extHostCommands = rpcProtocol.set(ExtHostContext.ExtHostCommands, new ExtHostCommands(rpcProtocol, extHostHeapService, extHostLogService));
A
Alex Dima 已提交
107 108 109 110 111
	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));
112 113
	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 已提交
114 115 116
	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));
117
	const extHostSCM = rpcProtocol.set(ExtHostContext.ExtHostSCM, new ExtHostSCM(rpcProtocol, extHostCommands, extHostLogService));
A
Alex Dima 已提交
118 119 120
	const extHostTask = rpcProtocol.set(ExtHostContext.ExtHostTask, new ExtHostTask(rpcProtocol, extHostWorkspace));
	const extHostWindow = rpcProtocol.set(ExtHostContext.ExtHostWindow, new ExtHostWindow(rpcProtocol));
	rpcProtocol.set(ExtHostContext.ExtHostExtensionService, extensionService);
121 122 123

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

126
	// Other instances
A
Alex Dima 已提交
127 128 129 130 131 132
	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);
133

134
	// Register API-ish commands
D
Dirk Baeumer 已提交
135
	ExtHostApiCommands.register(extHostCommands, extHostWorkspace);
136

137
	return function (extension: IExtensionDescription): typeof vscode {
138

139 140 141 142 143 144
		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;
145

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

			} else {
155 156 157
				// 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.`);
158
			}
159 160
		}

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

					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) => {
183
						console.warn('An error occurred while running command ' + id, err);
184
					});
185
				});
186 187
			},
			registerDiffInformationCommand: proposedApiFunction(extension, (id: string, callback: (diff: vscode.LineChange[], ...args: any[]) => any, thisArg?: any): vscode.Disposable => {
188 189 190 191 192 193 194 195 196 197
				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]);
				});
198
			}),
199
			executeCommand<T>(id: string, ...args: any[]): Thenable<T> {
200
				return extHostCommands.executeCommand<T>(id, ...args);
201
			},
202 203 204
			getCommands(filterInternal: boolean = false): Thenable<string[]> {
				return extHostCommands.getCommands(filterInternal);
			}
205
		};
206

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

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

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

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

423 424 425 426 427 428 429 430
		// namespace: workspace
		const workspace: typeof vscode.workspace = {
			get rootPath() {
				return extHostWorkspace.getPath();
			},
			set rootPath(value) {
				throw errors.readonly();
			},
431 432
			getWorkspaceFolder(resource) {
				return extHostWorkspace.getWorkspaceFolder(resource);
433
			},
434
			get workspaceFolders() {
435
				return extHostWorkspace.getWorkspaceFolders();
436
			},
437 438 439 440 441 442
			get name() {
				return extHostWorkspace.workspace ? extHostWorkspace.workspace.name : undefined;
			},
			set name(value) {
				throw errors.readonly();
			},
443 444 445
			updateWorkspaceFolders: (index, deleteCount, ...workspaceFoldersToAdd) => {
				return extHostWorkspace.updateWorkspaceFolders(extension, index, deleteCount || 0, ...workspaceFoldersToAdd);
			},
446
			onDidChangeWorkspaceFolders: function (listener, thisArgs?, disposables?) {
447
				return extHostWorkspace.onDidChangeWorkspace(listener, thisArgs, disposables);
448
			},
J
Johannes Rieken 已提交
449 450
			asRelativePath: (pathOrUri, includeWorkspace) => {
				return extHostWorkspace.getRelativePath(pathOrUri, includeWorkspace);
451 452
			},
			findFiles: (include, exclude, maxResults?, token?) => {
453
				return extHostWorkspace.findFiles(toGlobPattern(include), toGlobPattern(exclude), maxResults, extension.id, token);
454 455 456 457 458
			},
			saveAll: (includeUntitled?) => {
				return extHostWorkspace.saveAll(includeUntitled);
			},
			applyEdit(edit: vscode.WorkspaceEdit): TPromise<boolean> {
459
				return extHostEditors.applyWorkspaceEdit(edit);
460 461
			},
			createFileSystemWatcher: (pattern, ignoreCreate, ignoreChange, ignoreDelete): vscode.FileSystemWatcher => {
462
				return extHostFileSystemEvent.createFileSystemWatcher(toGlobPattern(pattern), ignoreCreate, ignoreChange, ignoreDelete);
463 464 465 466 467 468 469
			},
			get textDocuments() {
				return extHostDocuments.getAllDocumentData().map(data => data.document);
			},
			set textDocuments(value) {
				throw errors.readonly();
			},
470
			openTextDocument(uriOrFileNameOrOptions?: vscode.Uri | string | { language?: string; content?: string; }) {
B
Benjamin Pasero 已提交
471 472
				let uriPromise: TPromise<URI>;

473
				let options = uriOrFileNameOrOptions as { language?: string; content?: string; };
B
Benjamin Pasero 已提交
474
				if (typeof uriOrFileNameOrOptions === 'string') {
B
Benjamin Pasero 已提交
475 476
					uriPromise = TPromise.as(URI.file(uriOrFileNameOrOptions));
				} else if (uriOrFileNameOrOptions instanceof URI) {
J
Johannes Rieken 已提交
477
					uriPromise = TPromise.as(uriOrFileNameOrOptions);
B
Benjamin Pasero 已提交
478 479
				} else if (!options || typeof options === 'object') {
					uriPromise = extHostDocuments.createDocumentData(options);
480
				} else {
B
Benjamin Pasero 已提交
481
					throw new Error('illegal argument - uriOrFileNameOrOptions');
482
				}
B
Benjamin Pasero 已提交
483 484 485 486 487 488

				return uriPromise.then(uri => {
					return extHostDocuments.ensureDocumentData(uri).then(() => {
						const data = extHostDocuments.getDocumentData(uri);
						return data && data.document;
					});
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
				});
			},
			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?) => {
504
				return extHostDocumentSaveParticipant.getOnWillSaveTextDocumentEvent(extension)(listener, thisArgs, disposables);
505
			},
506
			onDidChangeConfiguration: (listener: (_: any) => any, thisArgs?: any, disposables?: extHostTypes.Disposable[]) => {
507 508
				return extHostConfiguration.onDidChangeConfiguration(listener, thisArgs, disposables);
			},
509 510
			getConfiguration(section?: string, resource?: vscode.Uri): vscode.WorkspaceConfiguration {
				resource = arguments.length === 1 ? void 0 : resource;
S
Sandeep Somavarapu 已提交
511
				return extHostConfiguration.getConfiguration(section, resource, extension.id);
512
			},
513 514
			registerTextDocumentContentProvider(scheme: string, provider: vscode.TextDocumentContentProvider) {
				return extHostDocumentContentProviders.registerTextDocumentContentProvider(scheme, provider);
515
			},
516
			registerTaskProvider: (type: string, provider: vscode.TaskProvider) => {
517
				return extHostTask.registerTaskProvider(extension, provider);
J
Johannes Rieken 已提交
518 519
			},
			registerFileSystemProvider: proposedApiFunction(extension, (authority, provider) => {
520
				return extHostFileSystem.registerFileSystemProvider(authority, provider);
J
Johannes Rieken 已提交
521
			})
522
		};
523

524 525
		// namespace: scm
		const scm: typeof vscode.scm = {
526
			get inputBox() {
J
Joao Moreno 已提交
527
				return extHostSCM.getLastInputBox(extension);
528
			},
J
Joao Moreno 已提交
529 530
			createSourceControl(id: string, label: string, rootUri?: vscode.Uri) {
				return extHostSCM.createSourceControl(extension, id, label, rootUri);
J
Joao Moreno 已提交
531
			}
532
		};
J
Joao Moreno 已提交
533

534 535
		// namespace: debug
		const debug: typeof vscode.debug = {
536 537 538
			get activeDebugSession() {
				return extHostDebugService.activeDebugSession;
			},
539 540
			get activeDebugConsole() {
				return extHostDebugService.activeDebugConsole;
541
			},
542 543
			get breakpoints() {
				return extHostDebugService.breakpoints;
544
			},
545 546 547
			onDidStartDebugSession(listener, thisArg?, disposables?) {
				return extHostDebugService.onDidStartDebugSession(listener, thisArg, disposables);
			},
548
			onDidTerminateDebugSession(listener, thisArg?, disposables?) {
549
				return extHostDebugService.onDidTerminateDebugSession(listener, thisArg, disposables);
550
			},
A
Andre Weinand 已提交
551
			onDidChangeActiveDebugSession(listener, thisArg?, disposables?) {
552
				return extHostDebugService.onDidChangeActiveDebugSession(listener, thisArg, disposables);
A
Andre Weinand 已提交
553 554
			},
			onDidReceiveDebugSessionCustomEvent(listener, thisArg?, disposables?) {
A
Andre Weinand 已提交
555
				return extHostDebugService.onDidReceiveDebugSessionCustomEvent(listener, thisArg, disposables);
556
			},
557
			onDidChangeBreakpoints(listener, thisArgs?, disposables?) {
558 559
				return extHostDebugService.onDidChangeBreakpoints(listener, thisArgs, disposables);
			},
A
Andre Weinand 已提交
560
			registerDebugConfigurationProvider(debugType: string, provider: vscode.DebugConfigurationProvider) {
561
				return extHostDebugService.registerDebugConfigurationProvider(debugType, provider);
562
			},
563 564 565 566
			startDebugging(folder: vscode.WorkspaceFolder | undefined, nameOrConfig: string | vscode.DebugConfiguration) {
				return extHostDebugService.startDebugging(folder, nameOrConfig);
			},
			addBreakpoints(breakpoints: vscode.Breakpoint[]) {
567
				return extHostDebugService.addBreakpoints(breakpoints);
568 569
			},
			removeBreakpoints(breakpoints: vscode.Breakpoint[]) {
570
				return extHostDebugService.removeBreakpoints(breakpoints);
571
			}
572 573 574
		};


575
		return <typeof vscode>{
576 577 578 579 580 581 582 583
			version: pkg.version,
			// namespaces
			commands,
			env,
			extensions,
			languages,
			window,
			workspace,
J
Joao Moreno 已提交
584
			scm,
585
			debug,
586
			// types
587
			Breakpoint: extHostTypes.Breakpoint,
588
			CancellationTokenSource: CancellationTokenSource,
589
			CodeAction: extHostTypes.CodeAction,
M
Matt Bierner 已提交
590
			CodeActionKind: extHostTypes.CodeActionKind,
591
			CodeLens: extHostTypes.CodeLens,
592
			Color: extHostTypes.Color,
593 594
			ColorPresentation: extHostTypes.ColorPresentation,
			ColorInformation: extHostTypes.ColorInformation,
595
			EndOfLine: extHostTypes.EndOfLine,
596 597 598
			CompletionItem: extHostTypes.CompletionItem,
			CompletionItemKind: extHostTypes.CompletionItemKind,
			CompletionList: extHostTypes.CompletionList,
M
Matt Bierner 已提交
599
			CompletionTriggerKind: extHostTypes.CompletionTriggerKind,
600
			DebugAdapterExecutable: extHostTypes.DebugAdapterExecutable,
601
			Diagnostic: extHostTypes.Diagnostic,
602
			DiagnosticRelatedInformation: extHostTypes.DiagnosticRelatedInformation,
603 604 605 606
			DiagnosticSeverity: extHostTypes.DiagnosticSeverity,
			Disposable: extHostTypes.Disposable,
			DocumentHighlight: extHostTypes.DocumentHighlight,
			DocumentHighlightKind: extHostTypes.DocumentHighlightKind,
607
			DocumentLink: extHostTypes.DocumentLink,
608
			EventEmitter: Emitter,
609
			FunctionBreakpoint: extHostTypes.FunctionBreakpoint,
610
			Hover: extHostTypes.Hover,
611
			IndentAction: languageConfiguration.IndentAction,
612
			Location: extHostTypes.Location,
613
			LogLevel: extHostTypes.LogLevel,
614
			MarkdownString: extHostTypes.MarkdownString,
615
			OverviewRulerLane: OverviewRulerLane,
616 617 618
			ParameterInformation: extHostTypes.ParameterInformation,
			Position: extHostTypes.Position,
			Range: extHostTypes.Range,
619
			RenameContext: extHostTypes.RenameContext,
620 621 622 623
			Selection: extHostTypes.Selection,
			SignatureHelp: extHostTypes.SignatureHelp,
			SignatureInformation: extHostTypes.SignatureInformation,
			SnippetString: extHostTypes.SnippetString,
624
			SourceBreakpoint: extHostTypes.SourceBreakpoint,
625 626 627
			StatusBarAlignment: extHostTypes.StatusBarAlignment,
			SymbolInformation: extHostTypes.SymbolInformation,
			SymbolKind: extHostTypes.SymbolKind,
628
			SourceControlInputBoxValidationType: extHostTypes.SourceControlInputBoxValidationType,
629 630
			TextDocumentSaveReason: extHostTypes.TextDocumentSaveReason,
			TextEdit: extHostTypes.TextEdit,
631
			TextEditorCursorStyle: TextEditorCursorStyle,
632
			TextEditorLineNumbersStyle: extHostTypes.TextEditorLineNumbersStyle,
633
			TextEditorRevealType: extHostTypes.TextEditorRevealType,
634
			TextEditorSelectionChangeKind: extHostTypes.TextEditorSelectionChangeKind,
635
			DecorationRangeBehavior: extHostTypes.DecorationRangeBehavior,
636
			Uri: URI,
637 638
			ViewColumn: extHostTypes.ViewColumn,
			WorkspaceEdit: extHostTypes.WorkspaceEdit,
J
Johannes Rieken 已提交
639
			ProgressLocation: extHostTypes.ProgressLocation,
S
Sandeep Somavarapu 已提交
640
			TreeItemCollapsibleState: extHostTypes.TreeItemCollapsibleState,
641
			ThemeIcon: extHostTypes.ThemeIcon,
S
Sandeep Somavarapu 已提交
642
			TreeItem: extHostTypes.TreeItem,
643
			ThemeColor: extHostTypes.ThemeColor,
J
Joao Moreno 已提交
644
			// functions
645
			TaskRevealKind: extHostTypes.TaskRevealKind,
646
			TaskPanelKind: extHostTypes.TaskPanelKind,
647
			TaskGroup: extHostTypes.TaskGroup,
D
Dirk Baeumer 已提交
648 649
			ProcessExecution: extHostTypes.ProcessExecution,
			ShellExecution: extHostTypes.ShellExecution,
650
			ShellQuoting: extHostTypes.ShellQuoting,
D
Dirk Baeumer 已提交
651
			TaskScope: extHostTypes.TaskScope,
S
Sandeep Somavarapu 已提交
652
			Task: extHostTypes.Task,
653
			ConfigurationTarget: extHostTypes.ConfigurationTarget,
654
			RelativePattern: extHostTypes.RelativePattern,
655

J
Johannes Rieken 已提交
656
			FileChangeType: extHostTypes.FileChangeType,
657 658 659 660
			FileType: extHostTypes.FileType,
			FoldingRangeList: extHostTypes.FoldingRangeList,
			FoldingRange: extHostTypes.FoldingRange,
			FoldingRangeType: extHostTypes.FoldingRangeType
661
		};
662
	};
E
Erich Gamma 已提交
663 664 665 666
}

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

A
Alex Dima 已提交
667
	private _extensionService: ExtHostExtensionService;
E
Erich Gamma 已提交
668 669 670 671 672

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

J
Johannes Rieken 已提交
673
	constructor(extensionService: ExtHostExtensionService, description: IExtensionDescription) {
A
Alex Dima 已提交
674
		this._extensionService = extensionService;
E
Erich Gamma 已提交
675 676 677 678 679 680
		this.id = description.id;
		this.extensionPath = paths.normalize(description.extensionFolderPath, true);
		this.packageJSON = description;
	}

	get isActive(): boolean {
A
Alex Dima 已提交
681
		return this._extensionService.isActivated(this.id);
E
Erich Gamma 已提交
682 683 684
	}

	get exports(): T {
A
Alex Dima 已提交
685
		return <T>this._extensionService.getExtensionExports(this.id);
E
Erich Gamma 已提交
686 687 688
	}

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

J
Johannes Rieken 已提交
693
export function initializeExtensionApi(extensionService: ExtHostExtensionService, apiFactory: IExtensionApiFactory): TPromise<void> {
694
	return extensionService.getExtensionPathIndex().then(trie => defineAPI(apiFactory, trie));
J
Johannes Rieken 已提交
695 696
}

697
function defineAPI(factory: IExtensionApiFactory, extensionPaths: TernarySearchTree<IExtensionDescription>): void {
J
Johannes Rieken 已提交
698 699

	// each extension is meant to get its own api implementation
J
Johannes Rieken 已提交
700
	const extApiImpl = new Map<string, typeof vscode>();
J
Johannes Rieken 已提交
701
	let defaultApiImpl: typeof vscode;
702 703 704

	const node_module = <any>require.__$__nodeRequire('module');
	const original = node_module._load;
E
Erich Gamma 已提交
705
	node_module._load = function load(request, parent, isMain) {
706 707 708 709 710
		if (request !== 'vscode') {
			return original.apply(this, arguments);
		}

		// get extension id from filename and api for extension
J
Johannes Rieken 已提交
711
		const ext = extensionPaths.findSubstr(parent.filename);
712
		if (ext) {
J
Johannes Rieken 已提交
713
			let apiImpl = extApiImpl.get(ext.id);
714
			if (!apiImpl) {
J
Johannes Rieken 已提交
715 716
				apiImpl = factory(ext);
				extApiImpl.set(ext.id, apiImpl);
717 718 719 720 721 722
			}
			return apiImpl;
		}

		// fall back to a default implementation
		if (!defaultApiImpl) {
723
			defaultApiImpl = factory(nullExtensionDescription);
E
Erich Gamma 已提交
724
		}
725
		return defaultApiImpl;
E
Erich Gamma 已提交
726 727
	};
}
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742

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