@theia/monaco 1.34.1 → 1.34.3

package/lib/browser/monaco-editor-model.d.ts

@@ -1,157 +1,157 @@
-import { Position, Range, TextDocumentSaveReason, TextDocumentContentChangeEvent } from '@theia/core/shared/vscode-languageserver-protocol';
-import { TextEditorDocument, EncodingMode, FindMatchesOptions, FindMatch, EditorPreferences } from '@theia/editor/lib/browser';
-import { DisposableCollection } from '@theia/core/lib/common/disposable';
-import { Emitter, Event } from '@theia/core/lib/common/event';
-import { CancellationTokenSource, CancellationToken } from '@theia/core/lib/common/cancellation';
-import { Resource, ResourceVersion } from '@theia/core/lib/common/resource';
-import { Saveable, SaveOptions } from '@theia/core/lib/browser/saveable';
-import { MonacoToProtocolConverter } from './monaco-to-protocol-converter';
-import { ProtocolToMonacoConverter } from './protocol-to-monaco-converter';
-import { ILogger, Loggable } from '@theia/core/lib/common/logger';
-import { IIdentifiedSingleEditOperation, ITextBufferFactory, ITextModel, ITextSnapshot } from '@theia/monaco-editor-core/esm/vs/editor/common/model';
-import { IResolvedTextEditorModel } from '@theia/monaco-editor-core/esm/vs/editor/common/services/resolverService';
-import * as monaco from '@theia/monaco-editor-core';
-export { TextDocumentSaveReason };
-export interface WillSaveMonacoModelEvent {
-    readonly model: MonacoEditorModel;
-    readonly reason: TextDocumentSaveReason;
-    readonly options?: SaveOptions;
-    waitUntil(thenable: Thenable<IIdentifiedSingleEditOperation[]>): void;
-}
-export interface MonacoModelContentChangedEvent {
-    readonly model: MonacoEditorModel;
-    readonly contentChanges: TextDocumentContentChangeEvent[];
-}
-export declare class MonacoEditorModel implements IResolvedTextEditorModel, TextEditorDocument {
-    protected readonly resource: Resource;
-    protected readonly m2p: MonacoToProtocolConverter;
-    protected readonly p2m: ProtocolToMonacoConverter;
-    protected readonly logger?: ILogger | undefined;
-    protected readonly editorPreferences?: EditorPreferences | undefined;
-    autoSave: EditorPreferences['files.autoSave'];
-    autoSaveDelay: number;
-    suppressOpenEditorWhenDirty: boolean;
-    lineNumbersMinChars: number;
-    readonly onWillSaveLoopTimeOut = 1500;
-    protected bufferSavedVersionId: number;
-    protected model: ITextModel;
-    protected readonly resolveModel: Promise<void>;
-    protected readonly toDispose: DisposableCollection;
-    protected readonly toDisposeOnAutoSave: DisposableCollection;
-    protected readonly onDidChangeContentEmitter: Emitter<MonacoModelContentChangedEvent>;
-    readonly onDidChangeContent: Event<MonacoModelContentChangedEvent>;
-    protected readonly onDidSaveModelEmitter: Emitter<ITextModel>;
-    readonly onDidSaveModel: Event<ITextModel>;
-    protected readonly onWillSaveModelEmitter: Emitter<WillSaveMonacoModelEvent>;
-    readonly onWillSaveModel: Event<WillSaveMonacoModelEvent>;
-    protected readonly onDidChangeValidEmitter: Emitter<void>;
-    readonly onDidChangeValid: Event<void>;
-    protected readonly onDidChangeEncodingEmitter: Emitter<string>;
-    readonly onDidChangeEncoding: Event<string>;
-    private preferredEncoding;
-    private contentEncoding;
-    protected resourceVersion: ResourceVersion | undefined;
-    constructor(resource: Resource, m2p: MonacoToProtocolConverter, p2m: ProtocolToMonacoConverter, logger?: ILogger | undefined, editorPreferences?: EditorPreferences | undefined);
-    dispose(): void;
-    isDisposed(): boolean;
-    resolve(): Promise<void>;
-    isResolved(): boolean;
-    setEncoding(encoding: string, mode: EncodingMode): Promise<void>;
-    getEncoding(): string | undefined;
-    protected setPreferredEncoding(encoding: string): boolean;
-    protected updateContentEncoding(): void;
-    /**
-     * #### Important
-     * Only this method can create an instance of `monaco.editor.IModel`,
-     * there should not be other calls to `monaco.editor.createModel`.
-     */
-    protected initialize(value: string | ITextBufferFactory): void;
-    /**
-     * Use `valid` to access it.
-     * Use `setValid` to mutate it.
-     */
-    protected _valid: boolean;
-    /**
-     * Whether it is possible to load content from the underlying resource.
-     */
-    get valid(): boolean;
-    protected setValid(valid: boolean): void;
-    protected _dirty: boolean;
-    get dirty(): boolean;
-    protected setDirty(dirty: boolean): void;
-    private updateSavedVersionId;
-    protected readonly onDirtyChangedEmitter: Emitter<void>;
-    get onDirtyChanged(): Event<void>;
-    get uri(): string;
-    protected _languageId: string | undefined;
-    get languageId(): string;
-    getLanguageId(): string | undefined;
-    /**
-     * It's a hack to dispatch close notification with an old language id; don't use it.
-     */
-    setLanguageId(languageId: string | undefined): void;
-    get version(): number;
-    /**
-     * Return selected text by Range or all text by default
-     */
-    getText(range?: Range): string;
-    positionAt(offset: number): Position;
-    offsetAt(position: Position): number;
-    get lineCount(): number;
-    /**
-     * Retrieves a line in a text document expressed as a one-based position.
-     */
-    getLineContent(lineNumber: number): string;
-    getLineMaxColumn(lineNumber: number): number;
-    toValidPosition(position: Position): Position;
-    toValidRange(range: Range): Range;
-    get readOnly(): boolean;
-    isReadonly(): boolean;
-    get onDispose(): monaco.IEvent<void>;
-    get onWillDispose(): Event<void>;
-    get textEditorModel(): monaco.editor.ITextModel & ITextModel;
-    /**
-     * Find all matches in an editor for the given options.
-     * @param options the options for finding matches.
-     *
-     * @returns the list of matches.
-     */
-    findMatches(options: FindMatchesOptions): FindMatch[];
-    load(): Promise<MonacoEditorModel>;
-    save(options?: SaveOptions): Promise<void>;
-    protected pendingOperation: Promise<void>;
-    protected run(operation: () => Promise<void>): Promise<void>;
-    protected syncCancellationTokenSource: CancellationTokenSource;
-    protected cancelSync(): CancellationToken;
-    sync(): Promise<void>;
-    protected doSync(token: CancellationToken): Promise<void>;
-    protected readContents(): Promise<string | ITextBufferFactory | undefined>;
-    protected ignoreDirtyEdits: boolean;
-    protected markAsDirty(): void;
-    protected doAutoSave(): void;
-    protected saveCancellationTokenSource: CancellationTokenSource;
-    protected cancelSave(): CancellationToken;
-    protected scheduleSave(reason: TextDocumentSaveReason, token?: CancellationToken, overwriteEncoding?: boolean, options?: SaveOptions): Promise<void>;
-    protected ignoreContentChanges: boolean;
-    protected readonly contentChanges: TextDocumentContentChangeEvent[];
-    protected pushContentChanges(contentChanges: TextDocumentContentChangeEvent[]): void;
-    protected fireDidChangeContent(event: monaco.editor.IModelContentChangedEvent): void;
-    protected asContentChangedEvent(event: monaco.editor.IModelContentChangedEvent): MonacoModelContentChangedEvent;
-    protected asTextDocumentContentChangeEvent(change: monaco.editor.IModelContentChange): TextDocumentContentChangeEvent;
-    protected applyEdits(operations: monaco.editor.IIdentifiedSingleEditOperation[], options?: Partial<MonacoEditorModel.ApplyEditsOptions>): void;
-    protected updateModel<T>(doUpdate: () => T, options?: Partial<MonacoEditorModel.ApplyEditsOptions>): T;
-    protected doSave(reason: TextDocumentSaveReason, token: CancellationToken, overwriteEncoding?: boolean, options?: SaveOptions): Promise<void>;
-    protected fireWillSaveModel(reason: TextDocumentSaveReason, token: CancellationToken, options?: SaveOptions): Promise<void>;
-    protected fireDidSaveModel(): void;
-    revert(options?: Saveable.RevertOptions): Promise<void>;
-    createSnapshot(preserveBOM?: boolean): ITextSnapshot;
-    applySnapshot(snapshot: Saveable.Snapshot): void;
-    protected trace(loggable: Loggable): void;
-}
-export declare namespace MonacoEditorModel {
-    interface ApplyEditsOptions {
-        ignoreDirty: boolean;
-        ignoreContentChanges: boolean;
-    }
-}
+import { Position, Range, TextDocumentSaveReason, TextDocumentContentChangeEvent } from '@theia/core/shared/vscode-languageserver-protocol';
+import { TextEditorDocument, EncodingMode, FindMatchesOptions, FindMatch, EditorPreferences } from '@theia/editor/lib/browser';
+import { DisposableCollection } from '@theia/core/lib/common/disposable';
+import { Emitter, Event } from '@theia/core/lib/common/event';
+import { CancellationTokenSource, CancellationToken } from '@theia/core/lib/common/cancellation';
+import { Resource, ResourceVersion } from '@theia/core/lib/common/resource';
+import { Saveable, SaveOptions } from '@theia/core/lib/browser/saveable';
+import { MonacoToProtocolConverter } from './monaco-to-protocol-converter';
+import { ProtocolToMonacoConverter } from './protocol-to-monaco-converter';
+import { ILogger, Loggable } from '@theia/core/lib/common/logger';
+import { IIdentifiedSingleEditOperation, ITextBufferFactory, ITextModel, ITextSnapshot } from '@theia/monaco-editor-core/esm/vs/editor/common/model';
+import { IResolvedTextEditorModel } from '@theia/monaco-editor-core/esm/vs/editor/common/services/resolverService';
+import * as monaco from '@theia/monaco-editor-core';
+export { TextDocumentSaveReason };
+export interface WillSaveMonacoModelEvent {
+    readonly model: MonacoEditorModel;
+    readonly reason: TextDocumentSaveReason;
+    readonly options?: SaveOptions;
+    waitUntil(thenable: Thenable<IIdentifiedSingleEditOperation[]>): void;
+}
+export interface MonacoModelContentChangedEvent {
+    readonly model: MonacoEditorModel;
+    readonly contentChanges: TextDocumentContentChangeEvent[];
+}
+export declare class MonacoEditorModel implements IResolvedTextEditorModel, TextEditorDocument {
+    protected readonly resource: Resource;
+    protected readonly m2p: MonacoToProtocolConverter;
+    protected readonly p2m: ProtocolToMonacoConverter;
+    protected readonly logger?: ILogger | undefined;
+    protected readonly editorPreferences?: EditorPreferences | undefined;
+    autoSave: EditorPreferences['files.autoSave'];
+    autoSaveDelay: number;
+    suppressOpenEditorWhenDirty: boolean;
+    lineNumbersMinChars: number;
+    readonly onWillSaveLoopTimeOut = 1500;
+    protected bufferSavedVersionId: number;
+    protected model: ITextModel;
+    protected readonly resolveModel: Promise<void>;
+    protected readonly toDispose: DisposableCollection;
+    protected readonly toDisposeOnAutoSave: DisposableCollection;
+    protected readonly onDidChangeContentEmitter: Emitter<MonacoModelContentChangedEvent>;
+    readonly onDidChangeContent: Event<MonacoModelContentChangedEvent>;
+    protected readonly onDidSaveModelEmitter: Emitter<ITextModel>;
+    readonly onDidSaveModel: Event<ITextModel>;
+    protected readonly onWillSaveModelEmitter: Emitter<WillSaveMonacoModelEvent>;
+    readonly onWillSaveModel: Event<WillSaveMonacoModelEvent>;
+    protected readonly onDidChangeValidEmitter: Emitter<void>;
+    readonly onDidChangeValid: Event<void>;
+    protected readonly onDidChangeEncodingEmitter: Emitter<string>;
+    readonly onDidChangeEncoding: Event<string>;
+    private preferredEncoding;
+    private contentEncoding;
+    protected resourceVersion: ResourceVersion | undefined;
+    constructor(resource: Resource, m2p: MonacoToProtocolConverter, p2m: ProtocolToMonacoConverter, logger?: ILogger | undefined, editorPreferences?: EditorPreferences | undefined);
+    dispose(): void;
+    isDisposed(): boolean;
+    resolve(): Promise<void>;
+    isResolved(): boolean;
+    setEncoding(encoding: string, mode: EncodingMode): Promise<void>;
+    getEncoding(): string | undefined;
+    protected setPreferredEncoding(encoding: string): boolean;
+    protected updateContentEncoding(): void;
+    /**
+     * #### Important
+     * Only this method can create an instance of `monaco.editor.IModel`,
+     * there should not be other calls to `monaco.editor.createModel`.
+     */
+    protected initialize(value: string | ITextBufferFactory): void;
+    /**
+     * Use `valid` to access it.
+     * Use `setValid` to mutate it.
+     */
+    protected _valid: boolean;
+    /**
+     * Whether it is possible to load content from the underlying resource.
+     */
+    get valid(): boolean;
+    protected setValid(valid: boolean): void;
+    protected _dirty: boolean;
+    get dirty(): boolean;
+    protected setDirty(dirty: boolean): void;
+    private updateSavedVersionId;
+    protected readonly onDirtyChangedEmitter: Emitter<void>;
+    get onDirtyChanged(): Event<void>;
+    get uri(): string;
+    protected _languageId: string | undefined;
+    get languageId(): string;
+    getLanguageId(): string | undefined;
+    /**
+     * It's a hack to dispatch close notification with an old language id; don't use it.
+     */
+    setLanguageId(languageId: string | undefined): void;
+    get version(): number;
+    /**
+     * Return selected text by Range or all text by default
+     */
+    getText(range?: Range): string;
+    positionAt(offset: number): Position;
+    offsetAt(position: Position): number;
+    get lineCount(): number;
+    /**
+     * Retrieves a line in a text document expressed as a one-based position.
+     */
+    getLineContent(lineNumber: number): string;
+    getLineMaxColumn(lineNumber: number): number;
+    toValidPosition(position: Position): Position;
+    toValidRange(range: Range): Range;
+    get readOnly(): boolean;
+    isReadonly(): boolean;
+    get onDispose(): monaco.IEvent<void>;
+    get onWillDispose(): Event<void>;
+    get textEditorModel(): monaco.editor.ITextModel & ITextModel;
+    /**
+     * Find all matches in an editor for the given options.
+     * @param options the options for finding matches.
+     *
+     * @returns the list of matches.
+     */
+    findMatches(options: FindMatchesOptions): FindMatch[];
+    load(): Promise<MonacoEditorModel>;
+    save(options?: SaveOptions): Promise<void>;
+    protected pendingOperation: Promise<void>;
+    protected run(operation: () => Promise<void>): Promise<void>;
+    protected syncCancellationTokenSource: CancellationTokenSource;
+    protected cancelSync(): CancellationToken;
+    sync(): Promise<void>;
+    protected doSync(token: CancellationToken): Promise<void>;
+    protected readContents(): Promise<string | ITextBufferFactory | undefined>;
+    protected ignoreDirtyEdits: boolean;
+    protected markAsDirty(): void;
+    protected doAutoSave(): void;
+    protected saveCancellationTokenSource: CancellationTokenSource;
+    protected cancelSave(): CancellationToken;
+    protected scheduleSave(reason: TextDocumentSaveReason, token?: CancellationToken, overwriteEncoding?: boolean, options?: SaveOptions): Promise<void>;
+    protected ignoreContentChanges: boolean;
+    protected readonly contentChanges: TextDocumentContentChangeEvent[];
+    protected pushContentChanges(contentChanges: TextDocumentContentChangeEvent[]): void;
+    protected fireDidChangeContent(event: monaco.editor.IModelContentChangedEvent): void;
+    protected asContentChangedEvent(event: monaco.editor.IModelContentChangedEvent): MonacoModelContentChangedEvent;
+    protected asTextDocumentContentChangeEvent(change: monaco.editor.IModelContentChange): TextDocumentContentChangeEvent;
+    protected applyEdits(operations: monaco.editor.IIdentifiedSingleEditOperation[], options?: Partial<MonacoEditorModel.ApplyEditsOptions>): void;
+    protected updateModel<T>(doUpdate: () => T, options?: Partial<MonacoEditorModel.ApplyEditsOptions>): T;
+    protected doSave(reason: TextDocumentSaveReason, token: CancellationToken, overwriteEncoding?: boolean, options?: SaveOptions): Promise<void>;
+    protected fireWillSaveModel(reason: TextDocumentSaveReason, token: CancellationToken, options?: SaveOptions): Promise<void>;
+    protected fireDidSaveModel(): void;
+    revert(options?: Saveable.RevertOptions): Promise<void>;
+    createSnapshot(preserveBOM?: boolean): ITextSnapshot;
+    applySnapshot(snapshot: Saveable.Snapshot): void;
+    protected trace(loggable: Loggable): void;
+}
+export declare namespace MonacoEditorModel {
+    interface ApplyEditsOptions {
+        ignoreDirty: boolean;
+        ignoreContentChanges: boolean;
+    }
+}
 //# sourceMappingURL=monaco-editor-model.d.ts.map