editor.ts 25.5 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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
export interface IEditorOpeningEvent {
	input: IEditorInput;
	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;
}

export class EditorOpeningEvent {
	private override: () => TPromise<IBaseEditor>;

	constructor(private _editorInput: IEditorInput, private _position: Position) {
	}

	public get input(): IEditorInput {
		return this._editorInput;
	}

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

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

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

300 301 302 303 304 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
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.
 */
330
export interface IFileEditorInput extends IEditorInput, IEncodingSupport {
331

332 333 334 335
	/**
	 * Sets the preferred encodingt to use for this input.
	 */
	setPreferredEncoding(encoding: string): void;
336 337 338 339 340

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

E
Erich Gamma 已提交
343
/**
S
Sandeep Somavarapu 已提交
344
 * Side by side editor inputs that have a master and details side.
E
Erich Gamma 已提交
345
 */
S
Sandeep Somavarapu 已提交
346
export class SideBySideEditorInput extends EditorInput {
E
Erich Gamma 已提交
347

348 349
	public static ID: string = 'workbench.editorinputs.sidebysideEditorInput';

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

S
Sandeep Somavarapu 已提交
352
	constructor(private name: string, private description: string, private _details: EditorInput, private _master: EditorInput) {
S
Sandeep Somavarapu 已提交
353 354 355
		super();
		this._toUnbind = [];
		this.registerListeners();
E
Erich Gamma 已提交
356 357
	}

S
Sandeep Somavarapu 已提交
358 359
	get master(): EditorInput {
		return this._master;
E
Erich Gamma 已提交
360 361
	}

S
Sandeep Somavarapu 已提交
362 363
	get details(): EditorInput {
		return this._details;
E
Erich Gamma 已提交
364 365
	}

366
	public isDirty(): boolean {
S
Sandeep Somavarapu 已提交
367
		return this.master.isDirty();
368 369 370
	}

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

	public save(): TPromise<boolean> {
S
Sandeep Somavarapu 已提交
375
		return this.master.save();
376 377 378
	}

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

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

	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 {
418
		return SideBySideEditorInput.ID;
S
Sandeep Somavarapu 已提交
419 420 421 422 423 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
	}

	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 已提交
454 455
}

456 457 458 459
export interface ITextEditorModel extends IEditorModel {
	textEditorModel: IModel;
}

E
Erich Gamma 已提交
460 461 462 463 464
/**
 * 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 已提交
465
export class EditorModel extends Disposable implements IEditorModel {
466 467 468
	private _onDispose: Emitter<void>;

	constructor() {
S
Sandeep Somavarapu 已提交
469
		super();
470 471 472 473 474 475 476 477 478
		this._onDispose = new Emitter<void>();
	}

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

	/**
	 * 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 {
498 499
		this._onDispose.fire();
		this._onDispose.dispose();
S
Sandeep Somavarapu 已提交
500
		super.dispose();
E
Erich Gamma 已提交
501 502 503 504 505 506 507 508 509 510 511
	}
}

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

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

		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;

539
	/**
540
	 * Will reveal the editor if it is already opened and visible in any of the opened editor groups.
541
	 */
542
	public revealIfVisible: boolean;
543

544 545 546 547 548
	/**
	 * 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 已提交
549
	/**
B
Benjamin Pasero 已提交
550 551
	 * 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 已提交
552 553
	 */
	public pinned: boolean;
B
Benjamin Pasero 已提交
554 555 556 557

	/**
	 * The index in the document stack where to insert the editor into when opening.
	 */
B
Benjamin Pasero 已提交
558
	public index: number;
559 560 561 562 563 564

	/**
	 * 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 已提交
565 566 567 568 569 570
}

/**
 * Base Text Editor Options.
 */
export class TextEditorOptions extends EditorOptions {
571 572 573 574
	private startLineNumber: number;
	private startColumn: number;
	private endLineNumber: number;
	private endColumn: number;
575

I
isidor 已提交
576
	private revealInCenterIfOutsideViewport: boolean;
E
Erich Gamma 已提交
577 578
	private editorViewState: IEditorViewState;

579
	public static from(input?: IBaseResourceInput): TextEditorOptions {
580 581 582 583
		if (!input || !input.options) {
			return null;
		}

584 585
		return TextEditorOptions.create(input.options);
	}
E
Erich Gamma 已提交
586

587 588 589 590 591
	/**
	 * Helper to convert options bag to real class
	 */
	public static create(options: ITextEditorOptions = Object.create(null)): TextEditorOptions {
		const textEditorOptions = new TextEditorOptions();
E
Erich Gamma 已提交
592

593 594 595
		if (options.selection) {
			const selection = options.selection;
			textEditorOptions.selection(selection.startLineNumber, selection.startColumn, selection.endLineNumber, selection.endColumn);
596
		}
E
Erich Gamma 已提交
597

598 599
		if (options.viewState) {
			textEditorOptions.editorViewState = options.viewState as IEditorViewState;
600
		}
601

602 603
		if (options.forceOpen) {
			textEditorOptions.forceOpen = true;
604
		}
605

606 607
		if (options.revealIfVisible) {
			textEditorOptions.revealIfVisible = true;
608
		}
609

610 611
		if (options.revealIfOpened) {
			textEditorOptions.revealIfOpened = true;
612
		}
613

614 615
		if (options.preserveFocus) {
			textEditorOptions.preserveFocus = true;
616
		}
617

618 619
		if (options.revealInCenterIfOutsideViewport) {
			textEditorOptions.revealInCenterIfOutsideViewport = true;
620
		}
I
isidor 已提交
621

622 623
		if (options.pinned) {
			textEditorOptions.pinned = true;
624
		}
B
Benjamin Pasero 已提交
625

626 627
		if (options.inactive) {
			textEditorOptions.inactive = true;
E
Erich Gamma 已提交
628 629
		}

630 631
		if (typeof options.index === 'number') {
			textEditorOptions.index = options.index;
E
Erich Gamma 已提交
632 633
		}

634
		return textEditorOptions;
E
Erich Gamma 已提交
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
	}

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

	/**
657
	 * Create a TextEditorOptions inline to be used when the editor is opening.
E
Erich Gamma 已提交
658
	 */
659 660
	public static fromEditor(editor: IEditor, settings?: IEditorOptions): TextEditorOptions {
		const options = TextEditorOptions.create(settings);
661 662

		// View state
663
		options.editorViewState = editor.saveViewState();
664

665
		return options;
E
Erich Gamma 已提交
666 667 668 669 670 671 672
	}

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

		// View state
676
		return this.applyViewState(editor, scrollType);
677 678
	}

679
	private applyViewState(editor: IEditor, scrollType: ScrollType): boolean {
E
Erich Gamma 已提交
680 681 682 683
		let gotApplied = false;

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

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

			gotApplied = true;
		}

		return gotApplied;
	}
}

728 729 730 731 732 733
export interface IStacksModelChangeEvent {
	group: IEditorGroup;
	editor?: IEditorInput;
	structural?: boolean;
}

734 735
export interface IEditorStacksModel {

736
	onModelChanged: Event<IStacksModelChangeEvent>;
737

B
Benjamin Pasero 已提交
738 739
	onWillCloseEditor: Event<IEditorCloseEvent>;
	onEditorClosed: Event<IEditorCloseEvent>;
740 741 742

	groups: IEditorGroup[];
	activeGroup: IEditorGroup;
B
Benjamin Pasero 已提交
743
	isActive(group: IEditorGroup): boolean;
744 745 746 747 748 749

	getGroup(id: GroupIdentifier): IEditorGroup;

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

750 751
	next(jumpGroups: boolean, cycleAtEnd?: boolean): IEditorIdentifier;
	previous(jumpGroups: boolean, cycleAtStart?: boolean): IEditorIdentifier;
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766

	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 已提交
767
	getEditor(resource: URI): IEditorInput;
768 769
	indexOf(editor: IEditorInput): number;

770
	contains(editorOrResource: IEditorInput | URI): boolean;
771 772 773 774

	getEditors(mru?: boolean): IEditorInput[];
	isActive(editor: IEditorInput): boolean;
	isPreview(editor: IEditorInput): boolean;
775
	isPinned(index: number): boolean;
776 777 778 779 780 781 782 783
	isPinned(editor: IEditorInput): boolean;
}

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

B
Benjamin Pasero 已提交
784
export interface IEditorContext extends IEditorIdentifier {
785
	event?: any;
B
Benjamin Pasero 已提交
786 787
}

B
Benjamin Pasero 已提交
788
export interface IEditorCloseEvent extends IEditorIdentifier {
789
	pinned: boolean;
790
	index: number;
791 792
}

793 794
export type GroupIdentifier = number;

795 796 797
export const EditorOpenPositioning = {
	LEFT: 'left',
	RIGHT: 'right',
798 799
	FIRST: 'first',
	LAST: 'last'
800 801
};

802
export interface IWorkbenchEditorConfiguration {
K
kieferrm 已提交
803
	/* __GDPR__FRAGMENT__
K
kieferrm 已提交
804 805 806 807 808 809 810 811 812 813 814 815
		"IWorkbenchEditorConfiguration" : {
			"showTabs" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
			"tabCloseButton": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
			"showIcons": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
			"enablePreview": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
			"enablePreviewFromQuickOpen": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
			"closeOnFileDelete": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
			"openPositioning": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
			"revealIfOpen": { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
			"swipeToNavigate": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
		}
	*/
816
	workbench: {
817 818
		editor: {
			showTabs: boolean;
819
			tabCloseButton: 'left' | 'right' | 'off';
820
			showIcons: boolean;
821 822
			enablePreview: boolean;
			enablePreviewFromQuickOpen: boolean;
823
			closeOnFileDelete: boolean;
824
			openPositioning: 'left' | 'right' | 'first' | 'last';
825
			revealIfOpen: boolean;
826
			swipeToNavigate: boolean,
827
			labelFormat: 'default' | 'short' | 'medium' | 'long';
828
		}
829
	};
S
Sandeep Somavarapu 已提交
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
}

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;
849
	value?: number;
S
Sandeep Somavarapu 已提交
850 851
}

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

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 已提交
871
	const resource = editor.getResource();
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 899 900
	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;
}

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 949 950 951
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());