extHost.api.impl.ts 32.8 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 42
import URI from 'vs/base/common/uri';
import Severity from 'vs/base/common/severity';
import EditorCommon = require('vs/editor/common/editorCommon');
J
Johannes Rieken 已提交
43 44 45 46
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';
47
import * as vscode from 'vscode';
E
Erich Gamma 已提交
48
import * as paths from 'vs/base/common/paths';
49
import { MainContext, ExtHostContext, IInitData } from './extHost.protocol';
50
import * as languageConfiguration from 'vs/editor/common/modes/languageConfiguration';
51
import { TextEditorCursorStyle } from 'vs/editor/common/config/editorOptions';
B
Benjamin Pasero 已提交
52 53 54
import { ExtHostThreadService } from 'vs/workbench/services/thread/node/extHostThreadService';
import { ProxyIdentifier } from 'vs/workbench/services/thread/common/threadService';
import { ExtHostDialogs } from 'vs/workbench/api/node/extHostDialogs';
55 56
import { ExtHostFileSystem } from 'vs/workbench/api/node/extHostFileSystem';
import { FileChangeType, FileType } from 'vs/platform/files/common/files';
57
import { ExtHostDecorations } from 'vs/workbench/api/node/extHostDecorations';
58
import { toGlobPattern, toLanguageSelector } from 'vs/workbench/api/node/extHostTypeConverters';
E
Erich Gamma 已提交
59

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

64
function proposedApiFunction<T>(extension: IExtensionDescription, fn: T): T {
65
	if (extension.enableProposedApi) {
66 67 68
		return fn;
	} else {
		return <any>(() => {
69
			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}`);
70 71 72 73
		});
	}
}

E
Erich Gamma 已提交
74
/**
75
 * This method instantiates and returns the extension API surface
E
Erich Gamma 已提交
76
 */
77 78
export function createApiFactory(
	initData: IInitData,
79
	threadService: ExtHostThreadService,
80 81
	extHostWorkspace: ExtHostWorkspace,
	extHostConfiguration: ExtHostConfiguration,
82
	extensionService: ExtHostExtensionService
83
): IExtensionApiFactory {
84

85
	// Addressable instances
86
	const extHostHeapService = threadService.set(ExtHostContext.ExtHostHeapService, new ExtHostHeapService());
87
	const extHostDecorations = threadService.set(ExtHostContext.ExtHostDecorations, new ExtHostDecorations(threadService));
88
	const extHostDocumentsAndEditors = threadService.set(ExtHostContext.ExtHostDocumentsAndEditors, new ExtHostDocumentsAndEditors(threadService));
89 90
	const extHostDocuments = threadService.set(ExtHostContext.ExtHostDocuments, new ExtHostDocuments(threadService, extHostDocumentsAndEditors));
	const extHostDocumentContentProviders = threadService.set(ExtHostContext.ExtHostDocumentContentProviders, new ExtHostDocumentContentProvider(threadService, extHostDocumentsAndEditors));
91
	const extHostDocumentSaveParticipant = threadService.set(ExtHostContext.ExtHostDocumentSaveParticipant, new ExtHostDocumentSaveParticipant(extHostDocuments, threadService.get(MainContext.MainThreadEditors)));
92 93 94
	const extHostEditors = threadService.set(ExtHostContext.ExtHostEditors, new ExtHostEditors(threadService, extHostDocumentsAndEditors));
	const extHostCommands = threadService.set(ExtHostContext.ExtHostCommands, new ExtHostCommands(threadService, extHostHeapService));
	const extHostTreeViews = threadService.set(ExtHostContext.ExtHostTreeViews, new ExtHostTreeViews(threadService.get(MainContext.MainThreadTreeViews), extHostCommands));
95
	threadService.set(ExtHostContext.ExtHostWorkspace, extHostWorkspace);
96
	const extHostDebugService = threadService.set(ExtHostContext.ExtHostDebugService, new ExtHostDebugService(threadService, extHostWorkspace));
97
	threadService.set(ExtHostContext.ExtHostConfiguration, extHostConfiguration);
98 99
	const extHostDiagnostics = threadService.set(ExtHostContext.ExtHostDiagnostics, new ExtHostDiagnostics(threadService));
	const languageFeatures = threadService.set(ExtHostContext.ExtHostLanguageFeatures, new ExtHostLanguageFeatures(threadService, extHostDocuments, extHostCommands, extHostHeapService, extHostDiagnostics));
100
	const extHostFileSystem = threadService.set(ExtHostContext.ExtHostFileSystem, new ExtHostFileSystem(threadService));
101
	const extHostFileSystemEvent = threadService.set(ExtHostContext.ExtHostFileSystemEventService, new ExtHostFileSystemEventService());
102
	const extHostQuickOpen = threadService.set(ExtHostContext.ExtHostQuickOpen, new ExtHostQuickOpen(threadService, extHostWorkspace, extHostCommands));
103 104
	const extHostTerminalService = threadService.set(ExtHostContext.ExtHostTerminalService, new ExtHostTerminalService(threadService));
	const extHostSCM = threadService.set(ExtHostContext.ExtHostSCM, new ExtHostSCM(threadService, extHostCommands));
D
Dirk Baeumer 已提交
105
	const extHostTask = threadService.set(ExtHostContext.ExtHostTask, new ExtHostTask(threadService, extHostWorkspace));
106
	const extHostWindow = threadService.set(ExtHostContext.ExtHostWindow, new ExtHostWindow(threadService));
107 108 109 110 111
	threadService.set(ExtHostContext.ExtHostExtensionService, extensionService);

	// Check that no named customers are missing
	const expected: ProxyIdentifier<any>[] = Object.keys(ExtHostContext).map((key) => ExtHostContext[key]);
	threadService.assertRegistered(expected);
112

113 114
	// Other instances
	const extHostMessageService = new ExtHostMessageService(threadService);
115
	const extHostDialogs = new ExtHostDialogs(threadService);
116
	const extHostStatusBar = new ExtHostStatusBar(threadService);
117
	const extHostProgress = new ExtHostProgress(threadService.get(MainContext.MainThreadProgress));
118 119
	const extHostOutputService = new ExtHostOutputService(threadService);
	const extHostLanguages = new ExtHostLanguages(threadService);
120

121 122
	// Register API-ish commands
	ExtHostApiCommands.register(extHostCommands);
123

124
	return function (extension: IExtensionDescription): typeof vscode {
125

126
		if (extension.enableProposedApi && !extension.isBuiltin) {
127

128 129 130 131
			if (
				!initData.environment.enableProposedApiForAll &&
				initData.environment.enableProposedApiFor.indexOf(extension.id) < 0
			) {
132
				extension.enableProposedApi = false;
133
				console.error(`Extension '${extension.id} cannot use PROPOSED API (must started out of dev or enabled via --enable-proposed-api)`);
134 135

			} else {
136 137 138
				// 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.`);
139
			}
140 141
		}

142 143
		// namespace: commands
		const commands: typeof vscode.commands = {
M
Matt Bierner 已提交
144
			registerCommand(id: string, command: <T>(...args: any[]) => T | Thenable<T>, thisArgs?: any): vscode.Disposable {
145
				return extHostCommands.registerCommand(id, command, thisArgs);
146
			},
147
			registerTextEditorCommand(id: string, callback: (textEditor: vscode.TextEditor, edit: vscode.TextEditorEdit, ...args: any[]) => void, thisArg?: any): vscode.Disposable {
148
				return extHostCommands.registerCommand(id, (...args: any[]): any => {
149 150 151
					let activeTextEditor = extHostEditors.getActiveTextEditor();
					if (!activeTextEditor) {
						console.warn('Cannot execute ' + id + ' because there is no active text editor.');
152
						return undefined;
153
					}
154 155 156 157 158 159 160 161 162 163

					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) => {
164
						console.warn('An error occurred while running command ' + id, err);
165
					});
166
				});
167 168
			},
			registerDiffInformationCommand: proposedApiFunction(extension, (id: string, callback: (diff: vscode.LineChange[], ...args: any[]) => any, thisArg?: any): vscode.Disposable => {
169 170 171 172 173 174 175 176 177 178
				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]);
				});
179
			}),
180
			executeCommand<T>(id: string, ...args: any[]): Thenable<T> {
181
				return extHostCommands.executeCommand<T>(id, ...args);
182
			},
183 184 185
			getCommands(filterInternal: boolean = false): Thenable<string[]> {
				return extHostCommands.getCommands(filterInternal);
			}
186
		};
187

188 189
		// namespace: env
		const env: typeof vscode.env = Object.freeze({
190 191
			get machineId() { return initData.telemetryInfo.machineId; },
			get sessionId() { return initData.telemetryInfo.sessionId; },
192
			get language() { return Platform.language; },
J
Johannes Rieken 已提交
193 194
			get appName() { return product.nameLong; },
			get appRoot() { return initData.environment.appRoot; },
195
		});
E
Erich Gamma 已提交
196

197 198 199
		// namespace: extensions
		const extensions: typeof vscode.extensions = {
			getExtension(extensionId: string): Extension<any> {
200
				let desc = extensionService.getExtensionDescription(extensionId);
201 202 203
				if (desc) {
					return new Extension(extensionService, desc);
				}
204
				return undefined;
205 206
			},
			get all(): Extension<any>[] {
207
				return extensionService.getAllExtensionDescriptions().map((desc) => new Extension(extensionService, desc));
E
Erich Gamma 已提交
208
			}
209
		};
E
Erich Gamma 已提交
210

211 212 213 214 215 216 217 218 219
		// 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 {
220
				return score(toLanguageSelector(selector), <any>document.uri, document.languageId);
221 222 223 224 225 226 227 228 229 230
			},
			registerCodeActionsProvider(selector: vscode.DocumentSelector, provider: vscode.CodeActionProvider): vscode.Disposable {
				return languageFeatures.registerCodeActionProvider(selector, provider);
			},
			registerCodeLensProvider(selector: vscode.DocumentSelector, provider: vscode.CodeLensProvider): vscode.Disposable {
				return languageFeatures.registerCodeLensProvider(selector, provider);
			},
			registerDefinitionProvider(selector: vscode.DocumentSelector, provider: vscode.DefinitionProvider): vscode.Disposable {
				return languageFeatures.registerDefinitionProvider(selector, provider);
			},
M
Matt Bierner 已提交
231 232
			registerImplementationProvider(selector: vscode.DocumentSelector, provider: vscode.ImplementationProvider): vscode.Disposable {
				return languageFeatures.registerImplementationProvider(selector, provider);
233
			},
234 235 236
			registerTypeDefinitionProvider(selector: vscode.DocumentSelector, provider: vscode.TypeDefinitionProvider): vscode.Disposable {
				return languageFeatures.registerTypeDefinitionProvider(selector, provider);
			},
237
			registerHoverProvider(selector: vscode.DocumentSelector, provider: vscode.HoverProvider): vscode.Disposable {
238
				return languageFeatures.registerHoverProvider(selector, provider, extension.id);
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
			},
			registerDocumentHighlightProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentHighlightProvider): vscode.Disposable {
				return languageFeatures.registerDocumentHighlightProvider(selector, provider);
			},
			registerReferenceProvider(selector: vscode.DocumentSelector, provider: vscode.ReferenceProvider): vscode.Disposable {
				return languageFeatures.registerReferenceProvider(selector, provider);
			},
			registerRenameProvider(selector: vscode.DocumentSelector, provider: vscode.RenameProvider): vscode.Disposable {
				return languageFeatures.registerRenameProvider(selector, provider);
			},
			registerDocumentSymbolProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentSymbolProvider): vscode.Disposable {
				return languageFeatures.registerDocumentSymbolProvider(selector, provider);
			},
			registerWorkspaceSymbolProvider(provider: vscode.WorkspaceSymbolProvider): vscode.Disposable {
				return languageFeatures.registerWorkspaceSymbolProvider(provider);
			},
			registerDocumentFormattingEditProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentFormattingEditProvider): vscode.Disposable {
				return languageFeatures.registerDocumentFormattingEditProvider(selector, provider);
			},
			registerDocumentRangeFormattingEditProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentRangeFormattingEditProvider): vscode.Disposable {
				return languageFeatures.registerDocumentRangeFormattingEditProvider(selector, provider);
			},
			registerOnTypeFormattingEditProvider(selector: vscode.DocumentSelector, provider: vscode.OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacters: string[]): vscode.Disposable {
				return languageFeatures.registerOnTypeFormattingEditProvider(selector, provider, [firstTriggerCharacter].concat(moreTriggerCharacters));
			},
			registerSignatureHelpProvider(selector: vscode.DocumentSelector, provider: vscode.SignatureHelpProvider, ...triggerCharacters: string[]): vscode.Disposable {
				return languageFeatures.registerSignatureHelpProvider(selector, provider, triggerCharacters);
			},
			registerCompletionItemProvider(selector: vscode.DocumentSelector, provider: vscode.CompletionItemProvider, ...triggerCharacters: string[]): vscode.Disposable {
268
				return languageFeatures.registerCompletionItemProvider(selector, provider, triggerCharacters);
269 270 271 272
			},
			registerDocumentLinkProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentLinkProvider): vscode.Disposable {
				return languageFeatures.registerDocumentLinkProvider(selector, provider);
			},
273 274 275
			registerColorProvider(selector: vscode.DocumentSelector, provider: vscode.DocumentColorProvider): vscode.Disposable {
				return languageFeatures.registerColorProvider(selector, provider);
			},
276 277
			setLanguageConfiguration: (language: string, configuration: vscode.LanguageConfiguration): vscode.Disposable => {
				return languageFeatures.setLanguageConfiguration(language, configuration);
278
			}
279
		};
E
Erich Gamma 已提交
280

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

385 386 387 388 389 390 391 392
		// namespace: workspace
		const workspace: typeof vscode.workspace = {
			get rootPath() {
				return extHostWorkspace.getPath();
			},
			set rootPath(value) {
				throw errors.readonly();
			},
393 394
			getWorkspaceFolder(resource) {
				return extHostWorkspace.getWorkspaceFolder(resource);
395
			},
396
			get workspaceFolders() {
397
				return extHostWorkspace.getWorkspaceFolders();
398
			},
399 400 401 402 403 404
			get name() {
				return extHostWorkspace.workspace ? extHostWorkspace.workspace.name : undefined;
			},
			set name(value) {
				throw errors.readonly();
			},
405
			onDidChangeWorkspaceFolders: function (listener, thisArgs?, disposables?) {
406
				return extHostWorkspace.onDidChangeWorkspace(listener, thisArgs, disposables);
407
			},
J
Johannes Rieken 已提交
408 409
			asRelativePath: (pathOrUri, includeWorkspace) => {
				return extHostWorkspace.getRelativePath(pathOrUri, includeWorkspace);
410 411
			},
			findFiles: (include, exclude, maxResults?, token?) => {
412
				return extHostWorkspace.findFiles(toGlobPattern(include), toGlobPattern(exclude), maxResults, token);
413 414 415 416 417
			},
			saveAll: (includeUntitled?) => {
				return extHostWorkspace.saveAll(includeUntitled);
			},
			applyEdit(edit: vscode.WorkspaceEdit): TPromise<boolean> {
418
				return extHostEditors.applyWorkspaceEdit(edit);
419 420
			},
			createFileSystemWatcher: (pattern, ignoreCreate, ignoreChange, ignoreDelete): vscode.FileSystemWatcher => {
421
				return extHostFileSystemEvent.createFileSystemWatcher(toGlobPattern(pattern), ignoreCreate, ignoreChange, ignoreDelete);
422 423 424 425 426 427 428
			},
			get textDocuments() {
				return extHostDocuments.getAllDocumentData().map(data => data.document);
			},
			set textDocuments(value) {
				throw errors.readonly();
			},
429
			openTextDocument(uriOrFileNameOrOptions?: vscode.Uri | string | { language?: string; content?: string; }) {
B
Benjamin Pasero 已提交
430 431
				let uriPromise: TPromise<URI>;

432
				let options = uriOrFileNameOrOptions as { language?: string; content?: string; };
B
Benjamin Pasero 已提交
433
				if (typeof uriOrFileNameOrOptions === 'string') {
B
Benjamin Pasero 已提交
434 435
					uriPromise = TPromise.as(URI.file(uriOrFileNameOrOptions));
				} else if (uriOrFileNameOrOptions instanceof URI) {
J
Johannes Rieken 已提交
436
					uriPromise = TPromise.as(uriOrFileNameOrOptions);
B
Benjamin Pasero 已提交
437 438
				} else if (!options || typeof options === 'object') {
					uriPromise = extHostDocuments.createDocumentData(options);
439
				} else {
B
Benjamin Pasero 已提交
440
					throw new Error('illegal argument - uriOrFileNameOrOptions');
441
				}
B
Benjamin Pasero 已提交
442 443 444 445 446 447

				return uriPromise.then(uri => {
					return extHostDocuments.ensureDocumentData(uri).then(() => {
						const data = extHostDocuments.getDocumentData(uri);
						return data && data.document;
					});
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
				});
			},
			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?) => {
				return extHostDocumentSaveParticipant.onWillSaveTextDocumentEvent(listener, thisArgs, disposables);
464
			},
465
			onDidChangeConfiguration: (listener: (_: any) => any, thisArgs?: any, disposables?: extHostTypes.Disposable[]) => {
466 467
				return extHostConfiguration.onDidChangeConfiguration(listener, thisArgs, disposables);
			},
468 469
			getConfiguration(section?: string, resource?: vscode.Uri): vscode.WorkspaceConfiguration {
				resource = arguments.length === 1 ? void 0 : resource;
S
Sandeep Somavarapu 已提交
470
				return extHostConfiguration.getConfiguration(section, resource, extension.id);
471
			},
472 473
			registerTextDocumentContentProvider(scheme: string, provider: vscode.TextDocumentContentProvider) {
				return extHostDocumentContentProviders.registerTextDocumentContentProvider(scheme, provider);
474
			},
475
			registerTaskProvider: (type: string, provider: vscode.TaskProvider) => {
476
				return extHostTask.registerTaskProvider(extension, provider);
J
Johannes Rieken 已提交
477 478
			},
			registerFileSystemProvider: proposedApiFunction(extension, (authority, provider) => {
479
				return extHostFileSystem.registerFileSystemProvider(authority, provider);
J
Johannes Rieken 已提交
480
			})
481
		};
482

483 484
		// namespace: scm
		const scm: typeof vscode.scm = {
485
			get inputBox() {
J
Joao Moreno 已提交
486
				return extHostSCM.getLastInputBox(extension);
487
			},
J
Joao Moreno 已提交
488 489
			createSourceControl(id: string, label: string, rootUri?: vscode.Uri) {
				return extHostSCM.createSourceControl(extension, id, label, rootUri);
J
Joao Moreno 已提交
490
			}
491
		};
J
Joao Moreno 已提交
492

493 494
		// namespace: debug
		const debug: typeof vscode.debug = {
495 496 497
			get activeDebugSession() {
				return extHostDebugService.activeDebugSession;
			},
498 499
			get activeDebugConsole() {
				return extHostDebugService.activeDebugConsole;
500
			},
501
			startDebugging(folder: vscode.WorkspaceFolder | undefined, nameOrConfig: string | vscode.DebugConfiguration) {
502
				return extHostDebugService.startDebugging(folder, nameOrConfig);
503
			},
504 505 506
			onDidStartDebugSession(listener, thisArg?, disposables?) {
				return extHostDebugService.onDidStartDebugSession(listener, thisArg, disposables);
			},
507
			onDidTerminateDebugSession(listener, thisArg?, disposables?) {
508
				return extHostDebugService.onDidTerminateDebugSession(listener, thisArg, disposables);
509
			},
A
Andre Weinand 已提交
510
			onDidChangeActiveDebugSession(listener, thisArg?, disposables?) {
511
				return extHostDebugService.onDidChangeActiveDebugSession(listener, thisArg, disposables);
A
Andre Weinand 已提交
512 513
			},
			onDidReceiveDebugSessionCustomEvent(listener, thisArg?, disposables?) {
A
Andre Weinand 已提交
514
				return extHostDebugService.onDidReceiveDebugSessionCustomEvent(listener, thisArg, disposables);
515
			},
A
Andre Weinand 已提交
516
			registerDebugConfigurationProvider(debugType: string, provider: vscode.DebugConfigurationProvider) {
517
				return extHostDebugService.registerDebugConfigurationProvider(debugType, provider);
518
			}
519 520 521
		};


522
		return <typeof vscode>{
523 524 525 526 527 528 529 530
			version: pkg.version,
			// namespaces
			commands,
			env,
			extensions,
			languages,
			window,
			workspace,
J
Joao Moreno 已提交
531
			scm,
532
			debug,
533 534
			// types
			CancellationTokenSource: CancellationTokenSource,
535
			CodeAction: extHostTypes.CodeAction,
536
			CodeLens: extHostTypes.CodeLens,
537
			Color: extHostTypes.Color,
538 539
			ColorPresentation: extHostTypes.ColorPresentation,
			ColorInformation: extHostTypes.ColorInformation,
540
			EndOfLine: extHostTypes.EndOfLine,
541 542 543
			CompletionItem: extHostTypes.CompletionItem,
			CompletionItemKind: extHostTypes.CompletionItemKind,
			CompletionList: extHostTypes.CompletionList,
M
Matt Bierner 已提交
544
			CompletionTriggerKind: extHostTypes.CompletionTriggerKind,
545 546 547 548 549
			Diagnostic: extHostTypes.Diagnostic,
			DiagnosticSeverity: extHostTypes.DiagnosticSeverity,
			Disposable: extHostTypes.Disposable,
			DocumentHighlight: extHostTypes.DocumentHighlight,
			DocumentHighlightKind: extHostTypes.DocumentHighlightKind,
550
			DocumentLink: extHostTypes.DocumentLink,
551 552
			EventEmitter: Emitter,
			Hover: extHostTypes.Hover,
553
			IndentAction: languageConfiguration.IndentAction,
554
			Location: extHostTypes.Location,
555
			MarkdownString: extHostTypes.MarkdownString,
556
			OverviewRulerLane: EditorCommon.OverviewRulerLane,
557 558 559 560 561 562 563 564 565 566 567 568
			ParameterInformation: extHostTypes.ParameterInformation,
			Position: extHostTypes.Position,
			Range: extHostTypes.Range,
			Selection: extHostTypes.Selection,
			SignatureHelp: extHostTypes.SignatureHelp,
			SignatureInformation: extHostTypes.SignatureInformation,
			SnippetString: extHostTypes.SnippetString,
			StatusBarAlignment: extHostTypes.StatusBarAlignment,
			SymbolInformation: extHostTypes.SymbolInformation,
			SymbolKind: extHostTypes.SymbolKind,
			TextDocumentSaveReason: extHostTypes.TextDocumentSaveReason,
			TextEdit: extHostTypes.TextEdit,
569
			TextEditorCursorStyle: TextEditorCursorStyle,
570
			TextEditorLineNumbersStyle: extHostTypes.TextEditorLineNumbersStyle,
571
			TextEditorRevealType: extHostTypes.TextEditorRevealType,
572
			TextEditorSelectionChangeKind: extHostTypes.TextEditorSelectionChangeKind,
573
			DecorationRangeBehavior: extHostTypes.DecorationRangeBehavior,
574
			Uri: URI,
575 576
			ViewColumn: extHostTypes.ViewColumn,
			WorkspaceEdit: extHostTypes.WorkspaceEdit,
J
Johannes Rieken 已提交
577
			ProgressLocation: extHostTypes.ProgressLocation,
S
Sandeep Somavarapu 已提交
578
			TreeItemCollapsibleState: extHostTypes.TreeItemCollapsibleState,
S
Sandeep Somavarapu 已提交
579
			TreeItem: extHostTypes.TreeItem,
580
			ThemeColor: extHostTypes.ThemeColor,
J
Joao Moreno 已提交
581
			// functions
582
			TaskRevealKind: extHostTypes.TaskRevealKind,
583
			TaskPanelKind: extHostTypes.TaskPanelKind,
584
			TaskGroup: extHostTypes.TaskGroup,
D
Dirk Baeumer 已提交
585 586
			ProcessExecution: extHostTypes.ProcessExecution,
			ShellExecution: extHostTypes.ShellExecution,
D
Dirk Baeumer 已提交
587
			TaskScope: extHostTypes.TaskScope,
S
Sandeep Somavarapu 已提交
588
			Task: extHostTypes.Task,
589
			ConfigurationTarget: extHostTypes.ConfigurationTarget,
590
			RelativePattern: extHostTypes.RelativePattern,
591

592
			// TODO@JOH,remote
593 594
			FileChangeType: <any>FileChangeType,
			FileType: <any>FileType
595
		};
596
	};
E
Erich Gamma 已提交
597 598 599 600
}

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

A
Alex Dima 已提交
601
	private _extensionService: ExtHostExtensionService;
E
Erich Gamma 已提交
602 603 604 605 606

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

J
Johannes Rieken 已提交
607
	constructor(extensionService: ExtHostExtensionService, description: IExtensionDescription) {
A
Alex Dima 已提交
608
		this._extensionService = extensionService;
E
Erich Gamma 已提交
609 610 611 612 613 614
		this.id = description.id;
		this.extensionPath = paths.normalize(description.extensionFolderPath, true);
		this.packageJSON = description;
	}

	get isActive(): boolean {
A
Alex Dima 已提交
615
		return this._extensionService.isActivated(this.id);
E
Erich Gamma 已提交
616 617 618
	}

	get exports(): T {
A
Alex Dima 已提交
619
		return <T>this._extensionService.getExtensionExports(this.id);
E
Erich Gamma 已提交
620 621 622
	}

	activate(): Thenable<T> {
623
		return this._extensionService.activateById(this.id, false).then(() => this.exports);
E
Erich Gamma 已提交
624 625 626
	}
}

J
Johannes Rieken 已提交
627
export function initializeExtensionApi(extensionService: ExtHostExtensionService, apiFactory: IExtensionApiFactory): TPromise<void> {
628
	return extensionService.getExtensionPathIndex().then(trie => defineAPI(apiFactory, trie));
J
Johannes Rieken 已提交
629 630
}

631
function defineAPI(factory: IExtensionApiFactory, extensionPaths: TernarySearchTree<IExtensionDescription>): void {
J
Johannes Rieken 已提交
632 633

	// each extension is meant to get its own api implementation
J
Johannes Rieken 已提交
634
	const extApiImpl = new Map<string, typeof vscode>();
J
Johannes Rieken 已提交
635
	let defaultApiImpl: typeof vscode;
636 637 638

	const node_module = <any>require.__$__nodeRequire('module');
	const original = node_module._load;
E
Erich Gamma 已提交
639
	node_module._load = function load(request, parent, isMain) {
640 641 642 643 644
		if (request !== 'vscode') {
			return original.apply(this, arguments);
		}

		// get extension id from filename and api for extension
J
Johannes Rieken 已提交
645
		const ext = extensionPaths.findSubstr(parent.filename);
646
		if (ext) {
J
Johannes Rieken 已提交
647
			let apiImpl = extApiImpl.get(ext.id);
648
			if (!apiImpl) {
J
Johannes Rieken 已提交
649 650
				apiImpl = factory(ext);
				extApiImpl.set(ext.id, apiImpl);
651 652 653 654 655 656
			}
			return apiImpl;
		}

		// fall back to a default implementation
		if (!defaultApiImpl) {
657
			defaultApiImpl = factory(nullExtensionDescription);
E
Erich Gamma 已提交
658
		}
659
		return defaultApiImpl;
E
Erich Gamma 已提交
660 661
	};
}
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676

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