import { IDisposable } from '../../../base/common/lifecycle.js'; import { URI } from '../../../base/common/uri.js'; export declare const IUndoRedoService: import("../../instantiation/common/instantiation.js").ServiceIdentifier; export declare enum UndoRedoElementType { Resource = 0, Workspace = 1 } export interface IResourceUndoRedoElement { readonly type: UndoRedoElementType.Resource; /** * The resource impacted by this element. */ readonly resource: URI; /** * A user presentable label. May be localized. */ readonly label: string; /** * A code describing the operation. Will not be localized. */ readonly code: string; /** * Show a message to the user confirming when trying to undo this element */ readonly confirmBeforeUndo?: boolean; undo(): Promise | void; redo(): Promise | void; } export interface IWorkspaceUndoRedoElement { readonly type: UndoRedoElementType.Workspace; /** * The resources impacted by this element. */ readonly resources: readonly URI[]; /** * A user presentable label. May be localized. */ readonly label: string; /** * A code describing the operation. Will not be localized. */ readonly code: string; /** * Show a message to the user confirming when trying to undo this element */ readonly confirmBeforeUndo?: boolean; undo(): Promise | void; redo(): Promise | void; /** * If implemented, indicates that this undo/redo element can be split into multiple per resource elements. */ split?(): IResourceUndoRedoElement[]; /** * If implemented, will be invoked before calling `undo()` or `redo()`. * This is a good place to prepare everything such that the calls to `undo()` or `redo()` are synchronous. * If a disposable is returned, it will be invoked to clean things up. */ prepareUndoRedo?(): Promise | IDisposable | void; } export type IUndoRedoElement = IResourceUndoRedoElement | IWorkspaceUndoRedoElement; export interface IPastFutureElements { past: IUndoRedoElement[]; future: IUndoRedoElement[]; } export interface UriComparisonKeyComputer { getComparisonKey(uri: URI): string; } export declare class ResourceEditStackSnapshot { readonly resource: URI; readonly elements: number[]; constructor(resource: URI, elements: number[]); } export declare class UndoRedoGroup { private static _ID; readonly id: number; private order; constructor(); nextOrder(): number; static None: UndoRedoGroup; } export declare class UndoRedoSource { private static _ID; readonly id: number; private order; constructor(); nextOrder(): number; static None: UndoRedoSource; } export interface IUndoRedoService { readonly _serviceBrand: undefined; /** * Register an URI -> string hasher. * This is useful for making multiple URIs share the same undo-redo stack. */ registerUriComparisonKeyComputer(scheme: string, uriComparisonKeyComputer: UriComparisonKeyComputer): IDisposable; /** * Get the hash used internally for a certain URI. * This uses any registered `UriComparisonKeyComputer`. */ getUriComparisonKey(resource: URI): string; /** * Add a new element to the `undo` stack. * This will destroy the `redo` stack. */ pushElement(element: IUndoRedoElement, group?: UndoRedoGroup, source?: UndoRedoSource): void; /** * Get the last pushed element for a resource. * If the last pushed element has been undone, returns null. */ getLastElement(resource: URI): IUndoRedoElement | null; /** * Get all the elements associated with a resource. * This includes the past and the future. */ getElements(resource: URI): IPastFutureElements; /** * Validate or invalidate stack elements associated with a resource. */ setElementsValidFlag(resource: URI, isValid: boolean, filter: (element: IUndoRedoElement) => boolean): void; /** * Remove elements that target `resource`. */ removeElements(resource: URI): void; /** * Create a snapshot of the current elements on the undo-redo stack for a resource. */ createSnapshot(resource: URI): ResourceEditStackSnapshot; /** * Attempt (as best as possible) to restore a certain snapshot previously created with `createSnapshot` for a resource. */ restoreSnapshot(snapshot: ResourceEditStackSnapshot): void; canUndo(resource: URI | UndoRedoSource): boolean; undo(resource: URI | UndoRedoSource): Promise | void; canRedo(resource: URI | UndoRedoSource): boolean; redo(resource: URI | UndoRedoSource): Promise | void; }