editor.ts 25.0 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, IModel, ScrollType } from 'vs/editor/common/editorCommon';
14
import { IEditorInput, IEditorModel, IEditorOptions, ITextEditorOptions, IBaseResourceInput, Position, Verbosity, IEditor as IBaseEditor } from 'vs/platform/editor/common/editor';
J
Johannes Rieken 已提交
15
import { IInstantiationService, IConstructorSignature0 } from 'vs/platform/instantiation/common/instantiation';
16
import { RawContextKey } from 'vs/platform/contextkey/common/contextkey';
17
import { Registry } from 'vs/platform/registry/common/platform';
18 19

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

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

27 28 29 30 31 32 33 34 35 36
/**
 * 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';

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

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

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

	/**
49
	 * Returns the file input factory to use for file inputs.
B
Benjamin Pasero 已提交
50
	 */
51
	getFileInputFactory(): IFileInputFactory;
B
Benjamin Pasero 已提交
52 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

	/**
	 * 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 已提交
87 88 89 90
/**
 * 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.
 */
91 92
export abstract class EditorInput implements IEditorInput {
	private _onDispose: Emitter<void>;
93
	protected _onDidChangeDirty: Emitter<void>;
B
Benjamin Pasero 已提交
94
	protected _onDidChangeLabel: Emitter<void>;
95

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

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

103 104 105
		this.disposed = false;
	}

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

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

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

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

E
Erich Gamma 已提交
134 135 136 137 138 139 140 141 142 143 144 145
	/**
	 * 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.
	 */
146
	public getDescription(verbosity?: Verbosity): string {
E
Erich Gamma 已提交
147 148 149
		return null;
	}

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

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

E
Erich Gamma 已提交
159 160 161 162 163 164 165 166 167 168 169 170
	/**
	 * 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;
	}

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

E
Erich Gamma 已提交
185 186 187 188 189 190
	/**
	 * 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.
	 */
191
	public abstract resolve(refresh?: boolean): TPromise<IEditorModel>;
E
Erich Gamma 已提交
192

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
	/**
	 * 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.
	 */
	public confirmSave(): ConfirmResult {
		return ConfirmResult.DONT_SAVE;
	}

	/**
	 * 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.
	 */
	public revert(): TPromise<boolean> {
		return TPromise.as(true);
	}

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

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

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

E
Erich Gamma 已提交
242 243 244 245 246 247
	/**
	 * 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;
248
		this._onDispose.fire();
E
Erich Gamma 已提交
249

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

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

263 264
export interface IEditorOpeningEvent {
	input: IEditorInput;
265
	options?: IEditorOptions;
266 267 268 269 270 271 272 273 274 275 276 277
	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;
}

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

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

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

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

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

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

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

305 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
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.
 */
335
export interface IFileEditorInput extends IEditorInput, IEncodingSupport {
336

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

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

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

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

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

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

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

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

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

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

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

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

B
Benjamin Pasero 已提交
387
	public getTelemetryDescriptor(): object {
S
Sandeep Somavarapu 已提交
388
		const descriptor = this.master.getTelemetryDescriptor();
389 390
		return objects.assign(descriptor, super.getTelemetryDescriptor());
	}
S
Sandeep Somavarapu 已提交
391 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

	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 {
423
		return SideBySideEditorInput.ID;
S
Sandeep Somavarapu 已提交
424 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
	}

	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 已提交
459 460
}

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

E
Erich Gamma 已提交
465 466 467 468 469
/**
 * 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 已提交
470
export class EditorModel extends Disposable implements IEditorModel {
471 472 473
	private _onDispose: Emitter<void>;

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

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

	/**
	 * 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 {
503 504
		this._onDispose.fire();
		this._onDispose.dispose();
S
Sandeep Somavarapu 已提交
505
		super.dispose();
E
Erich Gamma 已提交
506 507 508 509 510 511 512 513 514 515 516
	}
}

/**
 * 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.
	 */
517
	public static create(settings: IEditorOptions): EditorOptions {
518
		const options = new EditorOptions();
519

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

		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;

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

549 550 551 552 553
	/**
	 * 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 已提交
554
	/**
B
Benjamin Pasero 已提交
555 556
	 * 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 已提交
557 558
	 */
	public pinned: boolean;
B
Benjamin Pasero 已提交
559 560 561 562

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

	/**
	 * 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 已提交
570 571 572 573 574 575
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		// First try viewstate
		if (this.editorViewState) {
689
			editor.restoreViewState(this.editorViewState);
E
Erich Gamma 已提交
690 691 692 693 694 695 696 697
			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)) {
698
				const range = {
E
Erich Gamma 已提交
699 700 701 702 703
					startLineNumber: this.startLineNumber,
					startColumn: this.startColumn,
					endLineNumber: this.endLineNumber,
					endColumn: this.endColumn
				};
704
				editor.setSelection(range);
I
isidor 已提交
705
				if (this.revealInCenterIfOutsideViewport) {
706
					editor.revealRangeInCenterIfOutsideViewport(range, scrollType);
I
isidor 已提交
707
				} else {
708
					editor.revealRangeInCenter(range, scrollType);
I
isidor 已提交
709
				}
E
Erich Gamma 已提交
710 711 712 713
			}

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

			gotApplied = true;
		}

		return gotApplied;
	}
}

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

739 740
export interface IEditorStacksModel {

741
	onModelChanged: Event<IStacksModelChangeEvent>;
742

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

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

	getGroup(id: GroupIdentifier): IEditorGroup;

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

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

	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 已提交
773
	getEditor(resource: URI): IEditorInput;
774 775
	indexOf(editor: IEditorInput): number;

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

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

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

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

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

799 800
export type GroupIdentifier = number;

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

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

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

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;
845
	value?: number;
S
Sandeep Somavarapu 已提交
846 847
}

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

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 已提交
867
	const resource = editor.getResource();
868 869 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
	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;
}

897 898 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
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'
};

Registry.add(Extensions.EditorInputFactories, new EditorInputFactoryRegistry());