editor.ts 25.1 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';

J
Johannes Rieken 已提交
7
import { TPromise } from 'vs/base/common/winjs.base';
S
Sandeep Somavarapu 已提交
8
import Event, { Emitter, once } from 'vs/base/common/event';
9
import * as objects from 'vs/base/common/objects';
E
Erich Gamma 已提交
10 11
import types = require('vs/base/common/types');
import URI from 'vs/base/common/uri';
S
Sandeep Somavarapu 已提交
12
import { IDisposable, dispose, Disposable } from 'vs/base/common/lifecycle';
13
import { IEditor, IEditorViewState, ScrollType } from 'vs/editor/common/editorCommon';
14
import { IEditorInput, IEditorModel, IEditorOptions, ITextEditorOptions, IBaseResourceInput, Position, Verbosity, IEditor as IBaseEditor, IRevertOptions } from 'vs/platform/editor/common/editor';
J
Johannes Rieken 已提交
15
import { IInstantiationService, IConstructorSignature0 } from 'vs/platform/instantiation/common/instantiation';
I
isidor 已提交
16
import { RawContextKey } from 'vs/platform/contextkey/common/contextkey';
17
import { Registry } from 'vs/platform/registry/common/platform';
18
import { IModel } from 'vs/editor/common/model/model';
19 20

export const TextCompareEditorVisible = new RawContextKey<boolean>('textCompareEditorVisible', false);
E
Erich Gamma 已提交
21

22 23 24 25 26 27
export enum ConfirmResult {
	SAVE,
	DONT_SAVE,
	CANCEL
}

28 29 30 31 32 33 34 35 36 37
/**
 * Text diff editor id.
 */
export const TEXT_DIFF_EDITOR_ID = 'workbench.editors.textDiffEditor';

/**
 * Binary diff editor id.
 */
export const BINARY_DIFF_EDITOR_ID = 'workbench.editors.binaryResourceDiffEditor';

38 39 40 41
export interface IFileInputFactory {
	createFileInput(resource: URI, encoding: string, instantiationService: IInstantiationService): IFileEditorInput;
}

42
export interface IEditorInputFactoryRegistry {
B
Benjamin Pasero 已提交
43 44

	/**
45
	 * Registers the file input factory to use for file inputs.
B
Benjamin Pasero 已提交
46
	 */
47
	registerFileInputFactory(factory: IFileInputFactory): void;
B
Benjamin Pasero 已提交
48 49

	/**
50
	 * Returns the file input factory to use for file inputs.
B
Benjamin Pasero 已提交
51
	 */
52
	getFileInputFactory(): IFileInputFactory;
B
Benjamin Pasero 已提交
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87

	/**
	 * Registers a editor input factory for the given editor input to the registry. An editor input factory
	 * is capable of serializing and deserializing editor inputs from string data.
	 *
	 * @param editorInputId the identifier of the editor input
	 * @param factory the editor input factory for serialization/deserialization
	 */
	registerEditorInputFactory(editorInputId: string, ctor: IConstructorSignature0<IEditorInputFactory>): void;

	/**
	 * Returns the editor input factory for the given editor input.
	 *
	 * @param editorInputId the identifier of the editor input
	 */
	getEditorInputFactory(editorInputId: string): IEditorInputFactory;

	setInstantiationService(service: IInstantiationService): void;
}

export interface IEditorInputFactory {

	/**
	 * Returns a string representation of the provided editor input that contains enough information
	 * to deserialize back to the original editor input from the deserialize() method.
	 */
	serialize(editorInput: EditorInput): string;

	/**
	 * Returns an editor input from the provided serialized form of the editor input. This form matches
	 * the value returned from the serialize() method.
	 */
	deserialize(instantiationService: IInstantiationService, serializedEditorInput: string): EditorInput;
}

E
Erich Gamma 已提交
88 89 90 91
/**
 * Editor inputs are lightweight objects that can be passed to the workbench API to open inside the editor part.
 * Each editor input is mapped to an editor that is capable of opening it through the Platform facade.
 */
92 93
export abstract class EditorInput implements IEditorInput {
	private _onDispose: Emitter<void>;
94
	protected _onDidChangeDirty: Emitter<void>;
B
Benjamin Pasero 已提交
95
	protected _onDidChangeLabel: Emitter<void>;
96

E
Erich Gamma 已提交
97 98
	private disposed: boolean;

99
	constructor() {
100
		this._onDidChangeDirty = new Emitter<void>();
B
Benjamin Pasero 已提交
101
		this._onDidChangeLabel = new Emitter<void>();
102 103
		this._onDispose = new Emitter<void>();

104 105 106
		this.disposed = false;
	}

107 108 109 110 111 112 113
	/**
	 * Fired when the dirty state of this input changes.
	 */
	public get onDidChangeDirty(): Event<void> {
		return this._onDidChangeDirty.event;
	}

B
Benjamin Pasero 已提交
114 115 116 117 118 119 120
	/**
	 * Fired when the label this input changes.
	 */
	public get onDidChangeLabel(): Event<void> {
		return this._onDidChangeLabel.event;
	}

121 122 123 124 125 126 127
	/**
	 * Fired when the model gets disposed.
	 */
	public get onDispose(): Event<void> {
		return this._onDispose.event;
	}

B
Benjamin Pasero 已提交
128 129 130 131 132 133 134
	/**
	 * Returns the associated resource of this input if any.
	 */
	public getResource(): URI {
		return null;
	}

E
Erich Gamma 已提交
135 136 137 138 139 140 141 142 143 144 145 146
	/**
	 * Returns the name of this input that can be shown to the user. Examples include showing the name of the input
	 * above the editor area when the input is shown.
	 */
	public getName(): string {
		return null;
	}

	/**
	 * Returns the description of this input that can be shown to the user. Examples include showing the description of
	 * the input above the editor area to the side of the name of the input.
	 */
147
	public getDescription(verbosity?: Verbosity): string {
E
Erich Gamma 已提交
148 149 150
		return null;
	}

151 152 153 154
	public getTitle(verbosity?: Verbosity): string {
		return this.getName();
	}

155 156 157 158 159
	/**
	 * Returns the unique type identifier of this input.
	 */
	public abstract getTypeId(): string;

E
Erich Gamma 已提交
160 161 162 163 164 165 166 167 168 169 170 171
	/**
	 * Returns the preferred editor for this input. A list of candidate editors is passed in that whee registered
	 * for the input. This allows subclasses to decide late which editor to use for the input on a case by case basis.
	 */
	public getPreferredEditorId(candidates: string[]): string {
		if (candidates && candidates.length > 0) {
			return candidates[0];
		}

		return null;
	}

172 173 174 175 176
	/**
	 * Returns a descriptor suitable for telemetry events or null if none is available.
	 *
	 * Subclasses should extend if they can contribute.
	 */
B
Benjamin Pasero 已提交
177
	public getTelemetryDescriptor(): object {
K
kieferrm 已提交
178
		/* __GDPR__FRAGMENT__
K
kieferrm 已提交
179 180 181 182
			"EditorTelemetryDescriptor" : {
				"typeId" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
			}
		*/
183 184 185
		return { typeId: this.getTypeId() };
	}

E
Erich Gamma 已提交
186 187 188 189 190 191
	/**
	 * Returns a type of EditorModel that represents the resolved input. Subclasses should
	 * override to provide a meaningful model. The optional second argument allows to specify
	 * if the EditorModel should be refreshed before returning it. Depending on the implementation
	 * this could mean to refresh the editor model contents with the version from disk.
	 */
192
	public abstract resolve(refresh?: boolean): TPromise<IEditorModel>;
E
Erich Gamma 已提交
193

194 195 196 197 198 199 200 201 202 203
	/**
	 * An editor that is dirty will be asked to be saved once it closes.
	 */
	public isDirty(): boolean {
		return false;
	}

	/**
	 * Subclasses should bring up a proper dialog for the user if the editor is dirty and return the result.
	 */
204 205
	public confirmSave(): TPromise<ConfirmResult> {
		return TPromise.wrap(ConfirmResult.DONT_SAVE);
206 207 208 209 210 211 212 213 214 215 216 217
	}

	/**
	 * Saves the editor if it is dirty. Subclasses return a promise with a boolean indicating the success of the operation.
	 */
	public save(): TPromise<boolean> {
		return TPromise.as(true);
	}

	/**
	 * Reverts the editor if it is dirty. Subclasses return a promise with a boolean indicating the success of the operation.
	 */
218
	public revert(options?: IRevertOptions): TPromise<boolean> {
219 220 221 222
		return TPromise.as(true);
	}

	/**
223
	 * Called when this input is no longer opened in any editor. Subclasses can free resources as needed.
224 225
	 */
	public close(): void {
226 227 228
		this.dispose();
	}

229 230 231 232 233 234 235
	/**
	 * Subclasses can set this to false if it does not make sense to split the editor input.
	 */
	public supportsSplitEditor(): boolean {
		return true;
	}

236 237 238 239 240
	/**
	 * Returns true if this input is identical to the otherInput.
	 */
	public matches(otherInput: any): boolean {
		return this === otherInput;
241 242
	}

E
Erich Gamma 已提交
243 244 245 246 247 248
	/**
	 * Called when an editor input is no longer needed. Allows to free up any resources taken by
	 * resolving the editor input.
	 */
	public dispose(): void {
		this.disposed = true;
249
		this._onDispose.fire();
E
Erich Gamma 已提交
250

251
		this._onDidChangeDirty.dispose();
B
Benjamin Pasero 已提交
252
		this._onDidChangeLabel.dispose();
253
		this._onDispose.dispose();
E
Erich Gamma 已提交
254 255 256
	}

	/**
P
Pascal Borreli 已提交
257
	 * Returns whether this input was disposed or not.
E
Erich Gamma 已提交
258 259 260 261 262 263
	 */
	public isDisposed(): boolean {
		return this.disposed;
	}
}

264 265
export interface IEditorOpeningEvent {
	input: IEditorInput;
266
	options?: IEditorOptions;
267 268 269 270 271 272 273 274 275 276 277 278
	position: Position;

	/**
	 * Allows to prevent the opening of an editor by providing a callback
	 * that will be executed instead. By returning another editor promise
	 * it is possible to override the opening with another editor. It is ok
	 * to return a promise that resolves to NULL to prevent the opening
	 * altogether.
	 */
	prevent(callback: () => TPromise<IBaseEditor>): void;
}

279
export class EditorOpeningEvent implements IEditorOpeningEvent {
280 281
	private override: () => TPromise<IBaseEditor>;

282
	constructor(private _input: IEditorInput, private _options: IEditorOptions, private _position: Position) {
283 284 285
	}

	public get input(): IEditorInput {
286 287 288 289 290
		return this._input;
	}

	public get options(): IEditorOptions {
		return this._options;
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
	}

	public get position(): Position {
		return this._position;
	}

	public prevent(callback: () => TPromise<IBaseEditor>): void {
		this.override = callback;
	}

	public isPrevented(): () => TPromise<IBaseEditor> {
		return this.override;
	}
}

306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
export enum EncodingMode {

	/**
	 * Instructs the encoding support to encode the current input with the provided encoding
	 */
	Encode,

	/**
	 * Instructs the encoding support to decode the current input with the provided encoding
	 */
	Decode
}

export interface IEncodingSupport {

	/**
	 * Gets the encoding of the input if known.
	 */
	getEncoding(): string;

	/**
	 * Sets the encoding for the input for saving.
	 */
	setEncoding(encoding: string, mode: EncodingMode): void;
}

/**
 * This is a tagging interface to declare an editor input being capable of dealing with files. It is only used in the editor registry
 * to register this kind of input to the platform.
 */
336
export interface IFileEditorInput extends IEditorInput, IEncodingSupport {
337

338 339 340 341
	/**
	 * Sets the preferred encodingt to use for this input.
	 */
	setPreferredEncoding(encoding: string): void;
342 343 344 345 346

	/**
	 * Forces this file input to open as binary instead of text.
	 */
	setForceOpenAsBinary(): void;
347 348
}

E
Erich Gamma 已提交
349
/**
S
Sandeep Somavarapu 已提交
350
 * Side by side editor inputs that have a master and details side.
E
Erich Gamma 已提交
351
 */
S
Sandeep Somavarapu 已提交
352
export class SideBySideEditorInput extends EditorInput {
E
Erich Gamma 已提交
353

354 355
	public static ID: string = 'workbench.editorinputs.sidebysideEditorInput';

S
Sandeep Somavarapu 已提交
356
	private _toUnbind: IDisposable[];
E
Erich Gamma 已提交
357

S
Sandeep Somavarapu 已提交
358
	constructor(private name: string, private description: string, private _details: EditorInput, private _master: EditorInput) {
S
Sandeep Somavarapu 已提交
359 360 361
		super();
		this._toUnbind = [];
		this.registerListeners();
E
Erich Gamma 已提交
362 363
	}

S
Sandeep Somavarapu 已提交
364 365
	get master(): EditorInput {
		return this._master;
E
Erich Gamma 已提交
366 367
	}

S
Sandeep Somavarapu 已提交
368 369
	get details(): EditorInput {
		return this._details;
E
Erich Gamma 已提交
370 371
	}

372
	public isDirty(): boolean {
S
Sandeep Somavarapu 已提交
373
		return this.master.isDirty();
374 375
	}

376
	public confirmSave(): TPromise<ConfirmResult> {
S
Sandeep Somavarapu 已提交
377
		return this.master.confirmSave();
378 379 380
	}

	public save(): TPromise<boolean> {
S
Sandeep Somavarapu 已提交
381
		return this.master.save();
382 383 384
	}

	public revert(): TPromise<boolean> {
S
Sandeep Somavarapu 已提交
385
		return this.master.revert();
386
	}
387

B
Benjamin Pasero 已提交
388
	public getTelemetryDescriptor(): object {
S
Sandeep Somavarapu 已提交
389
		const descriptor = this.master.getTelemetryDescriptor();
390 391
		return objects.assign(descriptor, super.getTelemetryDescriptor());
	}
S
Sandeep Somavarapu 已提交
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423

	private registerListeners(): void {

		// When the details or master input gets disposed, dispose this diff editor input
		const onceDetailsDisposed = once(this.details.onDispose);
		this._toUnbind.push(onceDetailsDisposed(() => {
			if (!this.isDisposed()) {
				this.dispose();
			}
		}));

		const onceMasterDisposed = once(this.master.onDispose);
		this._toUnbind.push(onceMasterDisposed(() => {
			if (!this.isDisposed()) {
				this.dispose();
			}
		}));

		// Reemit some events from the master side to the outside
		this._toUnbind.push(this.master.onDidChangeDirty(() => this._onDidChangeDirty.fire()));
		this._toUnbind.push(this.master.onDidChangeLabel(() => this._onDidChangeLabel.fire()));
	}

	public get toUnbind() {
		return this._toUnbind;
	}

	public resolve(refresh?: boolean): TPromise<EditorModel> {
		return TPromise.as(null);
	}

	getTypeId(): string {
424
		return SideBySideEditorInput.ID;
S
Sandeep Somavarapu 已提交
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
	}

	public getName(): string {
		return this.name;
	}

	public getDescription(): string {
		return this.description;
	}

	public supportsSplitEditor(): boolean {
		return false;
	}

	public matches(otherInput: any): boolean {
		if (super.matches(otherInput) === true) {
			return true;
		}

		if (otherInput) {
			if (!(otherInput instanceof SideBySideEditorInput)) {
				return false;
			}

			const otherDiffInput = <SideBySideEditorInput>otherInput;
			return this.details.matches(otherDiffInput.details) && this.master.matches(otherDiffInput.master);
		}

		return false;
	}

	public dispose(): void {
		this._toUnbind = dispose(this._toUnbind);
		super.dispose();
	}
E
Erich Gamma 已提交
460 461
}

462 463 464 465
export interface ITextEditorModel extends IEditorModel {
	textEditorModel: IModel;
}

E
Erich Gamma 已提交
466 467 468 469 470
/**
 * The editor model is the heavyweight counterpart of editor input. Depending on the editor input, it
 * connects to the disk to retrieve content and may allow for saving it back or reverting it. Editor models
 * are typically cached for some while because they are expensive to construct.
 */
S
Sandeep Somavarapu 已提交
471
export class EditorModel extends Disposable implements IEditorModel {
472 473 474
	private _onDispose: Emitter<void>;

	constructor() {
S
Sandeep Somavarapu 已提交
475
		super();
476 477 478 479 480 481 482 483 484
		this._onDispose = new Emitter<void>();
	}

	/**
	 * Fired when the model gets disposed.
	 */
	public get onDispose(): Event<void> {
		return this._onDispose.event;
	}
E
Erich Gamma 已提交
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503

	/**
	 * Causes this model to load returning a promise when loading is completed.
	 */
	public load(): TPromise<EditorModel> {
		return TPromise.as(this);
	}

	/**
	 * Returns whether this model was loaded or not.
	 */
	public isResolved(): boolean {
		return true;
	}

	/**
	 * Subclasses should implement to free resources that have been claimed through loading.
	 */
	public dispose(): void {
504 505
		this._onDispose.fire();
		this._onDispose.dispose();
S
Sandeep Somavarapu 已提交
506
		super.dispose();
E
Erich Gamma 已提交
507 508 509 510 511 512 513 514 515 516 517
	}
}

/**
 * The editor options is the base class of options that can be passed in when opening an editor.
 */
export class EditorOptions implements IEditorOptions {

	/**
	 * Helper to create EditorOptions inline.
	 */
518
	public static create(settings: IEditorOptions): EditorOptions {
519
		const options = new EditorOptions();
520

E
Erich Gamma 已提交
521 522
		options.preserveFocus = settings.preserveFocus;
		options.forceOpen = settings.forceOpen;
523
		options.revealIfVisible = settings.revealIfVisible;
524
		options.revealIfOpened = settings.revealIfOpened;
B
Benjamin Pasero 已提交
525 526
		options.pinned = settings.pinned;
		options.index = settings.index;
527
		options.inactive = settings.inactive;
E
Erich Gamma 已提交
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

		return options;
	}

	/**
	 * Tells the editor to not receive keyboard focus when the editor is being opened. By default,
	 * the editor will receive keyboard focus on open.
	 */
	public preserveFocus: boolean;

	/**
	 * Tells the editor to replace the editor input in the editor even if it is identical to the one
	 * already showing. By default, the editor will not replace the input if it is identical to the
	 * one showing.
	 */
	public forceOpen: boolean;

545
	/**
546
	 * Will reveal the editor if it is already opened and visible in any of the opened editor groups.
547
	 */
548
	public revealIfVisible: boolean;
549

550 551 552 553 554
	/**
	 * Will reveal the editor if it is already opened (even when not visible) in any of the opened editor groups.
	 */
	public revealIfOpened: boolean;

B
Benjamin Pasero 已提交
555
	/**
B
Benjamin Pasero 已提交
556 557
	 * An editor that is pinned remains in the editor stack even when another editor is being opened.
	 * An editor that is not pinned will always get replaced by another editor that is not pinned.
B
Benjamin Pasero 已提交
558 559
	 */
	public pinned: boolean;
B
Benjamin Pasero 已提交
560 561 562 563

	/**
	 * The index in the document stack where to insert the editor into when opening.
	 */
B
Benjamin Pasero 已提交
564
	public index: number;
565 566 567 568 569 570

	/**
	 * An active editor that is opened will show its contents directly. Set to true to open an editor
	 * in the background.
	 */
	public inactive: boolean;
E
Erich Gamma 已提交
571 572 573 574 575 576
}

/**
 * Base Text Editor Options.
 */
export class TextEditorOptions extends EditorOptions {
577 578 579 580
	private startLineNumber: number;
	private startColumn: number;
	private endLineNumber: number;
	private endColumn: number;
581

I
isidor 已提交
582
	private revealInCenterIfOutsideViewport: boolean;
E
Erich Gamma 已提交
583 584
	private editorViewState: IEditorViewState;

585
	public static from(input?: IBaseResourceInput): TextEditorOptions {
586 587 588 589
		if (!input || !input.options) {
			return null;
		}

590 591
		return TextEditorOptions.create(input.options);
	}
E
Erich Gamma 已提交
592

593 594 595 596 597
	/**
	 * Helper to convert options bag to real class
	 */
	public static create(options: ITextEditorOptions = Object.create(null)): TextEditorOptions {
		const textEditorOptions = new TextEditorOptions();
E
Erich Gamma 已提交
598

599 600 601
		if (options.selection) {
			const selection = options.selection;
			textEditorOptions.selection(selection.startLineNumber, selection.startColumn, selection.endLineNumber, selection.endColumn);
602
		}
E
Erich Gamma 已提交
603

604 605
		if (options.viewState) {
			textEditorOptions.editorViewState = options.viewState as IEditorViewState;
606
		}
607

608 609
		if (options.forceOpen) {
			textEditorOptions.forceOpen = true;
610
		}
611

612 613
		if (options.revealIfVisible) {
			textEditorOptions.revealIfVisible = true;
614
		}
615

616 617
		if (options.revealIfOpened) {
			textEditorOptions.revealIfOpened = true;
618
		}
619

620 621
		if (options.preserveFocus) {
			textEditorOptions.preserveFocus = true;
622
		}
623

624 625
		if (options.revealInCenterIfOutsideViewport) {
			textEditorOptions.revealInCenterIfOutsideViewport = true;
626
		}
I
isidor 已提交
627

628 629
		if (options.pinned) {
			textEditorOptions.pinned = true;
630
		}
B
Benjamin Pasero 已提交
631

632 633
		if (options.inactive) {
			textEditorOptions.inactive = true;
E
Erich Gamma 已提交
634 635
		}

636 637
		if (typeof options.index === 'number') {
			textEditorOptions.index = options.index;
E
Erich Gamma 已提交
638 639
		}

640
		return textEditorOptions;
E
Erich Gamma 已提交
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
	}

	/**
	 * Returns if this options object has objects defined for the editor.
	 */
	public hasOptionsDefined(): boolean {
		return !!this.editorViewState || (!types.isUndefinedOrNull(this.startLineNumber) && !types.isUndefinedOrNull(this.startColumn));
	}

	/**
	 * Tells the editor to set show the given selection when the editor is being opened.
	 */
	public selection(startLineNumber: number, startColumn: number, endLineNumber: number = startLineNumber, endColumn: number = startColumn): EditorOptions {
		this.startLineNumber = startLineNumber;
		this.startColumn = startColumn;
		this.endLineNumber = endLineNumber;
		this.endColumn = endColumn;

		return this;
	}

	/**
663
	 * Create a TextEditorOptions inline to be used when the editor is opening.
E
Erich Gamma 已提交
664
	 */
665 666
	public static fromEditor(editor: IEditor, settings?: IEditorOptions): TextEditorOptions {
		const options = TextEditorOptions.create(settings);
667 668

		// View state
669
		options.editorViewState = editor.saveViewState();
670

671
		return options;
E
Erich Gamma 已提交
672 673 674 675 676 677 678
	}

	/**
	 * Apply the view state or selection to the given editor.
	 *
	 * @return if something was applied
	 */
679
	public apply(editor: IEditor, scrollType: ScrollType): boolean {
680 681

		// View state
682
		return this.applyViewState(editor, scrollType);
683 684
	}

685
	private applyViewState(editor: IEditor, scrollType: ScrollType): boolean {
E
Erich Gamma 已提交
686 687 688 689
		let gotApplied = false;

		// First try viewstate
		if (this.editorViewState) {
690
			editor.restoreViewState(this.editorViewState);
E
Erich Gamma 已提交
691 692 693 694 695 696 697 698
			gotApplied = true;
		}

		// Otherwise check for selection
		else if (!types.isUndefinedOrNull(this.startLineNumber) && !types.isUndefinedOrNull(this.startColumn)) {

			// Select
			if (!types.isUndefinedOrNull(this.endLineNumber) && !types.isUndefinedOrNull(this.endColumn)) {
699
				const range = {
E
Erich Gamma 已提交
700 701 702 703 704
					startLineNumber: this.startLineNumber,
					startColumn: this.startColumn,
					endLineNumber: this.endLineNumber,
					endColumn: this.endColumn
				};
705
				editor.setSelection(range);
I
isidor 已提交
706
				if (this.revealInCenterIfOutsideViewport) {
707
					editor.revealRangeInCenterIfOutsideViewport(range, scrollType);
I
isidor 已提交
708
				} else {
709
					editor.revealRangeInCenter(range, scrollType);
I
isidor 已提交
710
				}
E
Erich Gamma 已提交
711 712 713 714
			}

			// Reveal
			else {
715
				const pos = {
E
Erich Gamma 已提交
716 717 718
					lineNumber: this.startLineNumber,
					column: this.startColumn
				};
719
				editor.setPosition(pos);
I
isidor 已提交
720
				if (this.revealInCenterIfOutsideViewport) {
721
					editor.revealPositionInCenterIfOutsideViewport(pos, scrollType);
I
isidor 已提交
722
				} else {
723
					editor.revealPositionInCenter(pos, scrollType);
I
isidor 已提交
724
				}
E
Erich Gamma 已提交
725 726 727 728 729 730 731 732 733
			}

			gotApplied = true;
		}

		return gotApplied;
	}
}

734 735 736 737 738 739
export interface IStacksModelChangeEvent {
	group: IEditorGroup;
	editor?: IEditorInput;
	structural?: boolean;
}

740 741
export interface IEditorStacksModel {

742
	onModelChanged: Event<IStacksModelChangeEvent>;
743

B
Benjamin Pasero 已提交
744 745
	onWillCloseEditor: Event<IEditorCloseEvent>;
	onEditorClosed: Event<IEditorCloseEvent>;
746 747 748

	groups: IEditorGroup[];
	activeGroup: IEditorGroup;
B
Benjamin Pasero 已提交
749
	isActive(group: IEditorGroup): boolean;
750 751 752 753 754 755

	getGroup(id: GroupIdentifier): IEditorGroup;

	positionOfGroup(group: IEditorGroup): Position;
	groupAt(position: Position): IEditorGroup;

756 757
	next(jumpGroups: boolean, cycleAtEnd?: boolean): IEditorIdentifier;
	previous(jumpGroups: boolean, cycleAtStart?: boolean): IEditorIdentifier;
758
	last(): IEditorIdentifier;
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773

	isOpen(resource: URI): boolean;

	toString(): string;
}

export interface IEditorGroup {

	id: GroupIdentifier;
	label: string;
	count: number;
	activeEditor: IEditorInput;
	previewEditor: IEditorInput;

	getEditor(index: number): IEditorInput;
B
Benjamin Pasero 已提交
774
	getEditor(resource: URI): IEditorInput;
775 776
	indexOf(editor: IEditorInput): number;

777
	contains(editorOrResource: IEditorInput | URI): boolean;
778 779 780 781

	getEditors(mru?: boolean): IEditorInput[];
	isActive(editor: IEditorInput): boolean;
	isPreview(editor: IEditorInput): boolean;
782
	isPinned(index: number): boolean;
783 784 785 786 787 788 789 790
	isPinned(editor: IEditorInput): boolean;
}

export interface IEditorIdentifier {
	group: IEditorGroup;
	editor: IEditorInput;
}

B
Benjamin Pasero 已提交
791
export interface IEditorContext extends IEditorIdentifier {
792
	event?: any;
B
Benjamin Pasero 已提交
793 794
}

B
Benjamin Pasero 已提交
795
export interface IEditorCloseEvent extends IEditorIdentifier {
796
	replaced: boolean;
797
	index: number;
798 799
}

800 801
export type GroupIdentifier = number;

802 803 804
export const EditorOpenPositioning = {
	LEFT: 'left',
	RIGHT: 'right',
805 806
	FIRST: 'first',
	LAST: 'last'
807 808
};

809 810
export const OPEN_POSITIONING_CONFIG = 'workbench.editor.openPositioning';

811 812
export interface IWorkbenchEditorConfiguration {
	workbench: {
813 814
		editor: {
			showTabs: boolean;
815
			tabCloseButton: 'left' | 'right' | 'off';
816
			tabSizing: 'fit' | 'shrink';
817
			showIcons: boolean;
818 819
			enablePreview: boolean;
			enablePreviewFromQuickOpen: boolean;
820
			closeOnFileDelete: boolean;
821
			openPositioning: 'left' | 'right' | 'first' | 'last';
822
			revealIfOpen: boolean;
823
			swipeToNavigate: boolean,
824
			labelFormat: 'default' | 'short' | 'medium' | 'long';
B
Benjamin Pasero 已提交
825 826
		},
		iconTheme: string;
827
	};
S
Sandeep Somavarapu 已提交
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
}

export const ActiveEditorMovePositioning = {
	FIRST: 'first',
	LAST: 'last',
	LEFT: 'left',
	RIGHT: 'right',
	CENTER: 'center',
	POSITION: 'position',
};

export const ActiveEditorMovePositioningBy = {
	TAB: 'tab',
	GROUP: 'group'
};

export interface ActiveEditorMoveArguments {
	to?: string;
	by?: string;
847
	value?: number;
S
Sandeep Somavarapu 已提交
848 849
}

850
export const EditorCommands = {
851
	MoveActiveEditor: 'moveActiveEditor'
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
};

export interface IResourceOptions {
	supportSideBySide?: boolean;
	filter?: 'file' | 'untitled' | ['file', 'untitled'] | ['untitled', 'file'];
}

export function toResource(editor: IEditorInput, options?: IResourceOptions): URI {
	if (!editor) {
		return null;
	}

	// Check for side by side if we are asked to
	if (options && options.supportSideBySide && editor instanceof SideBySideEditorInput) {
		editor = editor.master;
	}

B
Benjamin Pasero 已提交
869
	const resource = editor.getResource();
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
	if (!options || !options.filter) {
		return resource; // return early if no filter is specified
	}

	if (!resource) {
		return null;
	}

	let includeFiles: boolean;
	let includeUntitled: boolean;
	if (Array.isArray(options.filter)) {
		includeFiles = (options.filter.indexOf('file') >= 0);
		includeUntitled = (options.filter.indexOf('untitled') >= 0);
	} else {
		includeFiles = (options.filter === 'file');
		includeUntitled = (options.filter === 'untitled');
	}

	if (includeFiles && resource.scheme === 'file') {
		return resource;
	}

	if (includeUntitled && resource.scheme === 'untitled') {
		return resource;
	}

	return null;
}

899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
class EditorInputFactoryRegistry implements IEditorInputFactoryRegistry {
	private instantiationService: IInstantiationService;
	private fileInputFactory: IFileInputFactory;
	private editorInputFactoryConstructors: { [editorInputId: string]: IConstructorSignature0<IEditorInputFactory> } = Object.create(null);
	private editorInputFactoryInstances: { [editorInputId: string]: IEditorInputFactory } = Object.create(null);

	constructor() {
	}

	public setInstantiationService(service: IInstantiationService): void {
		this.instantiationService = service;

		for (let key in this.editorInputFactoryConstructors) {
			const element = this.editorInputFactoryConstructors[key];
			this.createEditorInputFactory(key, element);
		}

		this.editorInputFactoryConstructors = {};
	}

	private createEditorInputFactory(editorInputId: string, ctor: IConstructorSignature0<IEditorInputFactory>): void {
		const instance = this.instantiationService.createInstance(ctor);
		this.editorInputFactoryInstances[editorInputId] = instance;
	}

	public registerFileInputFactory(factory: IFileInputFactory): void {
		this.fileInputFactory = factory;
	}

	public getFileInputFactory(): IFileInputFactory {
		return this.fileInputFactory;
	}

	public registerEditorInputFactory(editorInputId: string, ctor: IConstructorSignature0<IEditorInputFactory>): void {
		if (!this.instantiationService) {
			this.editorInputFactoryConstructors[editorInputId] = ctor;
		} else {
			this.createEditorInputFactory(editorInputId, ctor);
		}
	}

	public getEditorInputFactory(editorInputId: string): IEditorInputFactory {
		return this.editorInputFactoryInstances[editorInputId];
	}
}

export const Extensions = {
	EditorInputFactories: 'workbench.contributions.editor.inputFactories'
};

I
isidor 已提交
949
Registry.add(Extensions.EditorInputFactories, new EditorInputFactoryRegistry());