@theia/notebook 1.53.0-next.5 → 1.53.0-next.55

package/src/browser/service/notebook-model-resolver-service.ts

@@ -1,160 +1,160 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { Emitter, Resource, ResourceProvider, UNTITLED_SCHEME, URI } from '@theia/core';
-import { inject, injectable } from '@theia/core/shared/inversify';
-import { UriComponents } from '@theia/core/lib/common/uri';
-import { FileService } from '@theia/filesystem/lib/browser/file-service';
-import { NotebookData } from '../../common';
-import { NotebookModel } from '../view-model/notebook-model';
-import { NotebookService } from './notebook-service';
-import { NotebookTypeRegistry } from '../notebook-type-registry';
-import { NotebookFileSelector } from '../../common/notebook-protocol';
-import { match } from '@theia/core/lib/common/glob';
-
-export interface UntitledResource {
-    untitledResource: URI | undefined
-}
-
-@injectable()
-export class NotebookModelResolverService {
-
-    @inject(FileService)
-    protected fileService: FileService;
-
-    @inject(ResourceProvider)
-    protected resourceProvider: ResourceProvider;
-
-    @inject(NotebookService)
-    protected notebookService: NotebookService;
-
-    @inject(NotebookTypeRegistry)
-    protected notebookTypeRegistry: NotebookTypeRegistry;
-
-    protected onDidChangeDirtyEmitter = new Emitter<NotebookModel>();
-    readonly onDidChangeDirty = this.onDidChangeDirtyEmitter.event;
-    protected onDidSaveNotebookEmitter = new Emitter<UriComponents>();
-    readonly onDidSaveNotebook = this.onDidSaveNotebookEmitter.event;
-
-    async resolve(resource: URI, viewType?: string): Promise<NotebookModel> {
-        const existingModel = this.notebookService.getNotebookEditorModel(resource);
-        if (!viewType) {
-            if (existingModel) {
-                return existingModel;
-            } else {
-                viewType = this.findViewTypeForResource(resource);
-            }
-        } else if (existingModel?.viewType === viewType) {
-            return existingModel;
-        }
-
-        if (!viewType) {
-            throw new Error(`Missing viewType for '${resource}'`);
-        }
-
-        const actualResource = await this.resourceProvider(resource);
-        const notebookData = await this.resolveExistingNotebookData(actualResource, viewType!);
-        const notebookModel = await this.notebookService.createNotebookModel(notebookData, viewType, actualResource);
-
-        notebookModel.onDirtyChanged(() => this.onDidChangeDirtyEmitter.fire(notebookModel));
-        notebookModel.onDidSaveNotebook(() => this.onDidSaveNotebookEmitter.fire(notebookModel.uri.toComponents()));
-
-        return notebookModel;
-    }
-
-    async resolveUntitledResource(arg: UntitledResource, viewType: string): Promise<NotebookModel> {
-        let resource: URI;
-        // let hasAssociatedFilePath = false;
-        arg = arg as UntitledResource;
-        if (!arg.untitledResource) {
-            const notebookTypeInfo = this.notebookTypeRegistry.notebookTypes.find(info => info.type === viewType);
-            if (!notebookTypeInfo) {
-                throw new Error('UNKNOWN view type: ' + viewType);
-            }
-
-            const suffix = this.getPossibleFileEnding(notebookTypeInfo.selector ?? []) ?? '';
-            for (let counter = 1; ; counter++) {
-                const candidate = new URI()
-                    .withScheme(UNTITLED_SCHEME)
-                    .withPath(`Untitled-notebook-${counter}${suffix}`)
-                    .withQuery(viewType);
-                if (!this.notebookService.getNotebookEditorModel(candidate)) {
-                    resource = candidate;
-                    break;
-                }
-            }
-        } else if (arg.untitledResource.scheme === UNTITLED_SCHEME) {
-            resource = arg.untitledResource;
-        } else {
-            throw new Error('Invalid untitled resource: ' + arg.untitledResource.toString() + ' untitled resources with associated file path are not supported yet');
-            // TODO implement associated file path support
-            // resource = arg.untitledResource.withScheme('untitled');
-            // hasAssociatedFilePath = true;
-        }
-
-        return this.resolve(resource, viewType);
-    }
-
-    async resolveExistingNotebookData(resource: Resource, viewType: string): Promise<NotebookData> {
-        if (resource.uri.scheme === 'untitled') {
-            return {
-                cells: [],
-                metadata: {}
-            };
-        } else {
-            const [dataProvider, contents] = await Promise.all([
-                this.notebookService.getNotebookDataProvider(viewType),
-                this.fileService.readFile(resource.uri)
-            ]);
-            const notebook = await dataProvider.serializer.toNotebook(contents.value);
-
-            return notebook;
-        }
-    }
-
-    protected getPossibleFileEnding(selectors: readonly NotebookFileSelector[]): string | undefined {
-        for (const selector of selectors) {
-            const ending = this.possibleFileEnding(selector);
-            if (ending) {
-                return ending;
-            }
-        }
-        return undefined;
-    }
-
-    protected possibleFileEnding(selector: NotebookFileSelector): string | undefined {
-
-        const pattern = /^.*(\.[a-zA-Z0-9_-]+)$/;
-
-        const candidate = typeof selector === 'string' ? selector : selector.filenamePattern;
-
-        if (candidate) {
-            const matches = pattern.exec(candidate);
-            if (matches) {
-                return matches[1];
-            }
-        }
-
-        return undefined;
-    }
-
-    protected findViewTypeForResource(resource: URI): string | undefined {
-        return this.notebookTypeRegistry.notebookTypes.find(info =>
-            info.selector?.some(selector => selector.filenamePattern && match(selector.filenamePattern, resource.path.name + resource.path.ext))
-        )?.type;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { Emitter, Resource, ResourceProvider, UNTITLED_SCHEME, URI } from '@theia/core';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { UriComponents } from '@theia/core/lib/common/uri';
+import { FileService } from '@theia/filesystem/lib/browser/file-service';
+import { NotebookData } from '../../common';
+import { NotebookModel } from '../view-model/notebook-model';
+import { NotebookService } from './notebook-service';
+import { NotebookTypeRegistry } from '../notebook-type-registry';
+import { NotebookFileSelector } from '../../common/notebook-protocol';
+import { match } from '@theia/core/lib/common/glob';
+
+export interface UntitledResource {
+    untitledResource: URI | undefined
+}
+
+@injectable()
+export class NotebookModelResolverService {
+
+    @inject(FileService)
+    protected fileService: FileService;
+
+    @inject(ResourceProvider)
+    protected resourceProvider: ResourceProvider;
+
+    @inject(NotebookService)
+    protected notebookService: NotebookService;
+
+    @inject(NotebookTypeRegistry)
+    protected notebookTypeRegistry: NotebookTypeRegistry;
+
+    protected onDidChangeDirtyEmitter = new Emitter<NotebookModel>();
+    readonly onDidChangeDirty = this.onDidChangeDirtyEmitter.event;
+    protected onDidSaveNotebookEmitter = new Emitter<UriComponents>();
+    readonly onDidSaveNotebook = this.onDidSaveNotebookEmitter.event;
+
+    async resolve(resource: URI, viewType?: string): Promise<NotebookModel> {
+        const existingModel = this.notebookService.getNotebookEditorModel(resource);
+        if (!viewType) {
+            if (existingModel) {
+                return existingModel;
+            } else {
+                viewType = this.findViewTypeForResource(resource);
+            }
+        } else if (existingModel?.viewType === viewType) {
+            return existingModel;
+        }
+
+        if (!viewType) {
+            throw new Error(`Missing viewType for '${resource}'`);
+        }
+
+        const actualResource = await this.resourceProvider(resource);
+        const notebookData = await this.resolveExistingNotebookData(actualResource, viewType!);
+        const notebookModel = await this.notebookService.createNotebookModel(notebookData, viewType, actualResource);
+
+        notebookModel.onDirtyChanged(() => this.onDidChangeDirtyEmitter.fire(notebookModel));
+        notebookModel.onDidSaveNotebook(() => this.onDidSaveNotebookEmitter.fire(notebookModel.uri.toComponents()));
+
+        return notebookModel;
+    }
+
+    async resolveUntitledResource(arg: UntitledResource, viewType: string): Promise<NotebookModel> {
+        let resource: URI;
+        // let hasAssociatedFilePath = false;
+        arg = arg as UntitledResource;
+        if (!arg.untitledResource) {
+            const notebookTypeInfo = this.notebookTypeRegistry.notebookTypes.find(info => info.type === viewType);
+            if (!notebookTypeInfo) {
+                throw new Error('UNKNOWN view type: ' + viewType);
+            }
+
+            const suffix = this.getPossibleFileEnding(notebookTypeInfo.selector ?? []) ?? '';
+            for (let counter = 1; ; counter++) {
+                const candidate = new URI()
+                    .withScheme(UNTITLED_SCHEME)
+                    .withPath(`Untitled-notebook-${counter}${suffix}`)
+                    .withQuery(viewType);
+                if (!this.notebookService.getNotebookEditorModel(candidate)) {
+                    resource = candidate;
+                    break;
+                }
+            }
+        } else if (arg.untitledResource.scheme === UNTITLED_SCHEME) {
+            resource = arg.untitledResource;
+        } else {
+            throw new Error('Invalid untitled resource: ' + arg.untitledResource.toString() + ' untitled resources with associated file path are not supported yet');
+            // TODO implement associated file path support
+            // resource = arg.untitledResource.withScheme('untitled');
+            // hasAssociatedFilePath = true;
+        }
+
+        return this.resolve(resource, viewType);
+    }
+
+    async resolveExistingNotebookData(resource: Resource, viewType: string): Promise<NotebookData> {
+        if (resource.uri.scheme === 'untitled') {
+            return {
+                cells: [],
+                metadata: {}
+            };
+        } else {
+            const [dataProvider, contents] = await Promise.all([
+                this.notebookService.getNotebookDataProvider(viewType),
+                this.fileService.readFile(resource.uri)
+            ]);
+            const notebook = await dataProvider.serializer.toNotebook(contents.value);
+
+            return notebook;
+        }
+    }
+
+    protected getPossibleFileEnding(selectors: readonly NotebookFileSelector[]): string | undefined {
+        for (const selector of selectors) {
+            const ending = this.possibleFileEnding(selector);
+            if (ending) {
+                return ending;
+            }
+        }
+        return undefined;
+    }
+
+    protected possibleFileEnding(selector: NotebookFileSelector): string | undefined {
+
+        const pattern = /^.*(\.[a-zA-Z0-9_-]+)$/;
+
+        const candidate = typeof selector === 'string' ? selector : selector.filenamePattern;
+
+        if (candidate) {
+            const matches = pattern.exec(candidate);
+            if (matches) {
+                return matches[1];
+            }
+        }
+
+        return undefined;
+    }
+
+    protected findViewTypeForResource(resource: URI): string | undefined {
+        return this.notebookTypeRegistry.notebookTypes.find(info =>
+            info.selector?.some(selector => selector.filenamePattern && match(selector.filenamePattern, resource.path.name + resource.path.ext))
+        )?.type;
+    }
+
+}

package/src/browser/service/notebook-monaco-text-model-service.ts

@@ -1,48 +1,48 @@
-// *****************************************************************************
-// Copyright (C) 2024 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { ReferenceCollection, URI, Reference, Event } from '@theia/core';
-import { inject, injectable } from '@theia/core/shared/inversify';
-import { MonacoTextModelService } from '@theia/monaco/lib/browser/monaco-text-model-service';
-import { MonacoEditorModel } from '@theia/monaco/lib/browser/monaco-editor-model';
-import { NotebookModel } from '../view-model/notebook-model';
-
-/**
- * special service for creating monaco textmodels for notebook cells.
- * Its for optimization purposes since there is alot of overhead otherwise with calling the backend to create a document for each cell and other smaller things.
- */
-@injectable()
-export class NotebookMonacoTextModelService {
-
-    @inject(MonacoTextModelService)
-    protected readonly monacoTextModelService: MonacoTextModelService;
-
-    protected readonly cellmodels = new ReferenceCollection<string, MonacoEditorModel>(
-        uri => this.monacoTextModelService.createUnmanagedModel(new URI(uri))
-    );
-
-    getOrCreateNotebookCellModelReference(uri: URI): Promise<Reference<MonacoEditorModel>> {
-        return this.cellmodels.acquire(uri.toString());
-    }
-
-    async createTextModelsForNotebook(notebook: NotebookModel): Promise<void> {
-        await Promise.all(notebook.cells.map(cell => cell.resolveTextModel()));
-    }
-
-    get onDidCreateNotebookCellModel(): Event<MonacoEditorModel> {
-        return this.cellmodels.onDidCreate;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2024 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { ReferenceCollection, URI, Reference, Event } from '@theia/core';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { MonacoTextModelService } from '@theia/monaco/lib/browser/monaco-text-model-service';
+import { MonacoEditorModel } from '@theia/monaco/lib/browser/monaco-editor-model';
+import { NotebookModel } from '../view-model/notebook-model';
+
+/**
+ * special service for creating monaco textmodels for notebook cells.
+ * Its for optimization purposes since there is alot of overhead otherwise with calling the backend to create a document for each cell and other smaller things.
+ */
+@injectable()
+export class NotebookMonacoTextModelService {
+
+    @inject(MonacoTextModelService)
+    protected readonly monacoTextModelService: MonacoTextModelService;
+
+    protected readonly cellmodels = new ReferenceCollection<string, MonacoEditorModel>(
+        uri => this.monacoTextModelService.createUnmanagedModel(new URI(uri))
+    );
+
+    getOrCreateNotebookCellModelReference(uri: URI): Promise<Reference<MonacoEditorModel>> {
+        return this.cellmodels.acquire(uri.toString());
+    }
+
+    async createTextModelsForNotebook(notebook: NotebookModel): Promise<void> {
+        await Promise.all(notebook.cells.map(cell => cell.resolveTextModel()));
+    }
+
+    get onDidCreateNotebookCellModel(): Event<MonacoEditorModel> {
+        return this.cellmodels.onDidCreate;
+    }
+}