1
>
/*---------------------------------------------------------------------------------------------
editorInput.ts
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import { Emitter } from '../../../base/common/event.js';
7
>
import { URI } from '../../../base/common/uri.js';
8
>
import { EditorInputCapabilities, Verbosity, GroupIdentifier, ISaveOptions, IRevertOptions, IMoveResult, IEditorDescriptor, IEditorPane, IUntypedEditorInput, EditorResourceAccessor, AbstractEditorInput, isEditorInput, IEditorIdentifier } from '../editor.js';
9
>
import { isEqual } from '../../../base/common/resources.js';
10
>
import { ConfirmResult } from '../../../platform/dialogs/common/dialogs.js';
11
>
import { IMarkdownString } from '../../../base/common/htmlContent.js';
12
>
import { IDisposable } from '../../../base/common/lifecycle.js';
13
>
import { ThemeIcon } from '../../../base/common/themables.js';
14
>
15
>
export interface IEditorCloseHandler {
16
>
17
>
/**
18
>
* If `true`, will call into the `confirm` method to ask for confirmation
19
>
* before closing the editor.
20
>
*/
21
>
showConfirm(): boolean;
22
>
23
>
/**
24
>
* Allows an editor to control what should happen when the editor
25
>
* (or a list of editor of the same kind) is being closed.
26
>
*
27
>
* By default a file specific dialog will open if the editor is
28
>
* dirty and not in the process of saving.
29
>
*
30
>
* If the editor is not dealing with files or another condition
31
>
* should be used besides dirty state, this method should be
32
>
* implemented to show a different dialog.
33
>
*
34
>
* @param editors All editors of the same kind that are being closed. Should be used
35
>
* to show a combined dialog.
36
>
*/
37
>
confirm(editors: ReadonlyArray<IEditorIdentifier>): Promise<ConfirmResult>;
38
>
}
39
>
40
>
export interface IUntypedEditorOptions {
41
>
42
>
/**
43
>
* Implementations should try to preserve as much
44
>
* view state as possible from the typed input based
45
>
* on the group the editor is opened.
46
>
*/
47
>
readonly preserveViewState?: GroupIdentifier;
48
>
49
>
/**
50
>
* Implementations should preserve the original
51
>
* resource of the typed input and not alter
52
>
* it.
53
>
*/
54
>
readonly preserveResource?: boolean;
55
>
}
56
>
57
>
/**
58
>
* Editor inputs are lightweight objects that can be passed to the workbench API to open inside the editor part.
59
>
* Each editor input is mapped to an editor that is capable of opening it through the Platform facade.
60
>
*/
61
>
export abstract class EditorInput extends AbstractEditorInput {
62
63
protected readonly _onDidChangeDirty = this._register(new Emitter<void>());