@peter.prib/renderengine 0.2.6 → 0.2.7

package/src/workspace/parts/ModelFile.js

@@ -1,187 +1,216 @@
-import { pickFile } from '../../charting/toolbar/pickFile.js';
-import { downloadBlob } from '../../exportImage.js';
-
-/** Each page's own title, as it was before any model's file name went in front of it (several models share one page). */
-const PAGE_TITLES = new WeakMap();
-
-/**
- * ModelFile — the file an EditorPart's model is open from and saved to: its
- * name, its format (one of the part's ModelFileFormats) and, where the
- * browser lets a page write a file back (the File System Access API, in
- * Chrome and Edge), its handle. Open… and Save As… choose one; Save writes
- * back to it, or (no handle, or no such browser) asks where (Save As). After
- * opening or saving, the model is marked saved; its edits since make the part
- * "dirty", which `label` and the page title show.
- */
-export class ModelFile {
-    /** @param {EditorPart} part */
-    constructor(part) {
-        this.part = part;
-        this.name = null;
-        this.format = null;
-        this.handle = null;
-    }
-
-    get doc() { return this.part.document; }
-    get win() { return this.doc?.defaultView ?? globalThis; }
-
-    /** The format a new file is saved in: the part's `saveFormat()`, else its first. */
-    get defaultFormat() {
-        return this.part.saveFormat?.() ?? this.part.fileFormats()[0] ?? null;
-    }
-
-    /**
-     * What the model is called: the file's name, else (not from a file) the
-     * model's own name, else Untitled; and • when it has changed since it was
-     * opened or saved.
-     */
-    get label() {
-        return `${this.name ?? (this.part.model.name || 'Untitled')}${this.part.model.isDirty?.() ? ' •' : ''}`;
-    }
-
-    /** Open…, Save, Save As… for the File menu. */
-    menuItems() {
-        return [
-            { label: 'Open…', action: () => this.open() },
-            { label: `Save${this.name ? ` (${this.name})` : ''}`, action: () => this.save() },
-            { label: 'Save As…', action: () => this.saveAs() },
-        ];
-    }
-
-    /** Ctrl+O, Ctrl+S and Ctrl+Shift+S, while the part is on the page. */
-    onKey(e) {
-        // Only the part on screen: another in a hidden tab has its own file.
-        if (!(e.ctrlKey || e.metaKey) || e.altKey || !this.part.isShown()) return;
-        const key = e.key.toLowerCase();
-        if (key === 's') { e.preventDefault(); e.shiftKey ? this.saveAs() : this.save(); }
-        else if (key === 'o' && !e.shiftKey) { e.preventDefault(); this.open(); }
-    }
-
-    /**
-     * Ask for a file and open it, replacing the model: its format is the first
-     * of the part's whose extension and contents fit. Keeps its handle, so Save
-     * writes back to it. Returns the new model, or null.
-     */
-    async open() {
-        const chosen = await this.choose();
-        return chosen ? this.adopt(chosen) : null;
-    }
-
-    /**
-     * Ask for a file and read it as a model, without opening it anywhere yet:
-     * `{ model, name, format, handle }`, or null (cancelled, or not a model).
-     * `adopt()` opens it, in this part or another of its kind.
-     */
-    async choose() {
-        const formats = this.part.fileFormats().filter(f => f.imports !== false);
-        const accept = [...new Set(formats.flatMap(f => f.accept.split(',').map(e => e.trim()).filter(Boolean)))];
-        let file = null, handle = null;
-        if (typeof this.win.showOpenFilePicker === 'function') {
-            try {
-                [handle] = await this.win.showOpenFilePicker({ types: [{ description: 'Models', accept: { 'application/octet-stream': accept } }] });
-                file = await handle.getFile();
-            } catch (err) {
-                if (err?.name === 'AbortError') return null;
-                throw err;
-            }
-        } else {
-            file = await pickFile(accept.join(','), this.doc);
-        }
-        if (!file) return null;
-        const bytes = new Uint8Array(await file.arrayBuffer());
-        const text = () => new TextDecoder().decode(bytes);
-        const format = formats.find(f => f.acceptsName(file.name) && f.recognizes(f.readsBytes ? bytes : text()))
-            ?? formats.find(f => f.acceptsName(file.name));
-        if (!format) { this.tell(`Not a file this editor opens: ${file.name}`); return null; }
-        try {
-            return { model: format.import(format.readsBytes ? bytes : text()), name: file.name, format, handle };
-        } catch (err) {
-            this.tell(`Open failed: ${err.message}`);
-            return null;
-        }
-    }
-
-    /** Open what `choose()` read: the part edits its model, from that file. Returns the model. */
-    adopt({ model, name, format, handle = null }) {
-        this.part.replaceModel(model);
-        Object.assign(this, { name, format, handle });
-        this.showState();
-        return model;
-    }
-
-    /** Save to the open file (where the browser can write it back), else Save As. */
-    async save() {
-        if (!this.handle?.createWritable || !this.format) return this.saveAs();
-        return this._write(this.handle, this.format, this.name);
-    }
-
-    /**
-     * Ask where to save (the browser's save dialog where it has one, else a
-     * download), in the open file's format or the default one, and keep it.
-     */
-    async saveAs() {
-        const format = this.format ?? this.defaultFormat;
-        if (!format) return false;
-        const suggested = this.name ?? format.fileName;
-        if (typeof this.win.showSaveFilePicker === 'function') {
-            let handle;
-            try {
-                const ext = format.accept.split(',')[0].trim();
-                handle = await this.win.showSaveFilePicker({ suggestedName: suggested, types: [{ description: format.label, accept: { 'application/octet-stream': [ext] } }] });
-            } catch (err) {
-                if (err?.name === 'AbortError') return false;
-                throw err;
-            }
-            return this._write(handle, format, handle.name ?? suggested);
-        }
-        // No way to write a file: download it (the page cannot write it back later).
-        const { data, mimeType } = format.export(this.part.model);
-        downloadBlob(new this.win.Blob([data], { type: mimeType }), suggested);
-        Object.assign(this, { name: suggested, format, handle: null });
-        this._saved();
-        return true;
-    }
-
-    /** @private */
-    async _write(handle, format, name) {
-        const { data } = format.export(this.part.model);
-        const writable = await handle.createWritable();
-        await writable.write(data);
-        await writable.close();
-        Object.assign(this, { name, format, handle });
-        this._saved();
-        return true;
-    }
-
-    /** @private */
-    _saved() {
-        this.part.model.markSaved?.();
-        this.showState();
-    }
-
-    /** The model now is not from a file (an import, a new model). */
-    forget() {
-        Object.assign(this, { name: null, format: null, handle: null });
-        this.showState();
-    }
-
-    /** Show the saved state: the page title, and anything listening (the part's toolbar). */
-    showState() {
-        const doc = this.doc;
-        if (doc && this.part.isShown()) {
-            if (!PAGE_TITLES.has(doc)) PAGE_TITLES.set(doc, doc.title);
-            doc.title = `${this.label} — ${PAGE_TITLES.get(doc)}`;
-        }
-        this.part.onFileState?.(this);
-    }
-
-    /** Put the page title back (the part is going). */
-    restoreTitle() {
-        if (this.doc && PAGE_TITLES.has(this.doc)) this.doc.title = PAGE_TITLES.get(this.doc);
-    }
-
-    /** @private */
-    tell(message) {
-        (this.win.alert ?? (() => {}))(message);
-    }
-}
+import { pickFile } from '../../charting/toolbar/pickFile.js';
+import { downloadBlob } from '../../exportImage.js';
+
+/** Each page's own title, as it was before any model's file name went in front of it (several models share one page). */
+const PAGE_TITLES = new WeakMap();
+
+/**
+ * ModelFile — the file an EditorPart's model is open from and saved to: its
+ * name, its format (one of the part's ModelFileFormats) and, where the
+ * browser lets a page write a file back (the File System Access API, in
+ * Chrome and Edge), its handle. Open… and Save As… choose one; Save writes
+ * back to it, or (no handle, or no such browser) asks where (Save As). After
+ * opening or saving, the model is marked saved; its edits since make the part
+ * "dirty", which `label` and the page title show.
+ */
+export class ModelFile {
+    /** @param {EditorPart} part */
+    constructor(part) {
+        this.part = part;
+        this.name = null;
+        this.format = null;
+        this.handle = null;
+    }
+
+    get doc() { return this.part.document; }
+    get win() { return this.doc?.defaultView ?? globalThis; }
+
+    /** The format a new file is saved in: the part's `saveFormat()`, else its first. */
+    get defaultFormat() {
+        return this.part.saveFormat?.() ?? this.part.fileFormats()[0] ?? null;
+    }
+
+    /**
+     * What the model is called: the file's name, else (not from a file) the
+     * model's own name, else Untitled; and • when it has changed since it was
+     * opened or saved.
+     */
+    get label() {
+        return `${this.name ?? (this.part.model.name || 'Untitled')}${this.part.model.isDirty?.() ? ' •' : ''}`;
+    }
+
+    /**
+     * The model as kept in this browser (ModelLibrary, by a ModelsPart with
+     * `keep`): in this file's format, else the part's save format, with its
+     * name and this file's name; null when the part has no format.
+     */
+    keepEntry() {
+        const format = this.format ?? this.defaultFormat;
+        if (!format) return null;
+        const { data } = format.export(this.part.model);
+        return { name: this.part.model.name || this.name || 'Untitled', format: format.label, data, fileName: this.name };
+    }
+
+    /**
+     * Ctrl+O, Ctrl+S and Ctrl+Shift+S on the page (onKey), and asking before
+     * the page is left with changes unsaved; through the part's `listen`, so
+     * they go with it.
+     */
+    listen() {
+        const win = this.doc?.defaultView;
+        this.part.listen(this.doc, 'keydown', (e) => this.onKey(e));
+        if (win) {
+            this.part.listen(win, 'beforeunload', (e) => {
+                if (!this.part.model.isDirty?.()) return;
+                e.preventDefault();
+                e.returnValue = '';
+            });
+        }
+    }
+
+    /** Open…, Save, Save As… for the File menu. */
+    menuItems() {
+        return [
+            { label: 'Open…', action: () => this.open() },
+            { label: `Save${this.name ? ` (${this.name})` : ''}`, action: () => this.save() },
+            { label: 'Save As…', action: () => this.saveAs() },
+        ];
+    }
+
+    /** Ctrl+O, Ctrl+S and Ctrl+Shift+S, while the part is on the page. */
+    onKey(e) {
+        // Only the part on screen: another in a hidden tab has its own file.
+        if (!(e.ctrlKey || e.metaKey) || e.altKey || !this.part.isShown()) return;
+        const key = e.key.toLowerCase();
+        if (key === 's') { e.preventDefault(); e.shiftKey ? this.saveAs() : this.save(); }
+        else if (key === 'o' && !e.shiftKey) { e.preventDefault(); this.open(); }
+    }
+
+    /**
+     * Ask for a file and open it, replacing the model: its format is the first
+     * of the part's whose extension and contents fit. Keeps its handle, so Save
+     * writes back to it. Returns the new model, or null.
+     */
+    async open() {
+        const chosen = await this.choose();
+        return chosen ? this.adopt(chosen) : null;
+    }
+
+    /**
+     * Ask for a file and read it as a model, without opening it anywhere yet:
+     * `{ model, name, format, handle }`, or null (cancelled, or not a model).
+     * `adopt()` opens it, in this part or another of its kind.
+     */
+    async choose() {
+        const formats = this.part.fileFormats().filter(f => f.imports !== false);
+        const accept = [...new Set(formats.flatMap(f => f.accept.split(',').map(e => e.trim()).filter(Boolean)))];
+        let file = null, handle = null;
+        if (typeof this.win.showOpenFilePicker === 'function') {
+            try {
+                [handle] = await this.win.showOpenFilePicker({ types: [{ description: 'Models', accept: { 'application/octet-stream': accept } }] });
+                file = await handle.getFile();
+            } catch (err) {
+                if (err?.name === 'AbortError') return null;
+                throw err;
+            }
+        } else {
+            file = await pickFile(accept.join(','), this.doc);
+        }
+        if (!file) return null;
+        const bytes = new Uint8Array(await file.arrayBuffer());
+        const text = () => new TextDecoder().decode(bytes);
+        const format = formats.find(f => f.acceptsName(file.name) && f.recognizes(f.readsBytes ? bytes : text()))
+            ?? formats.find(f => f.acceptsName(file.name));
+        if (!format) { this.tell(`Not a file this editor opens: ${file.name}`); return null; }
+        try {
+            return { model: format.import(format.readsBytes ? bytes : text()), name: file.name, format, handle };
+        } catch (err) {
+            this.tell(`Open failed: ${err.message}`);
+            return null;
+        }
+    }
+
+    /** Open what `choose()` read: the part edits its model, from that file. Returns the model. */
+    adopt({ model, name, format, handle = null }) {
+        this.part.replaceModel(model);
+        Object.assign(this, { name, format, handle });
+        this.showState();
+        return model;
+    }
+
+    /** Save to the open file (where the browser can write it back), else Save As. */
+    async save() {
+        if (!this.handle?.createWritable || !this.format) return this.saveAs();
+        return this._write(this.handle, this.format, this.name);
+    }
+
+    /**
+     * Ask where to save (the browser's save dialog where it has one, else a
+     * download), in the open file's format or the default one, and keep it.
+     */
+    async saveAs() {
+        const format = this.format ?? this.defaultFormat;
+        if (!format) return false;
+        const suggested = this.name ?? format.fileName;
+        if (typeof this.win.showSaveFilePicker === 'function') {
+            let handle;
+            try {
+                const ext = format.accept.split(',')[0].trim();
+                handle = await this.win.showSaveFilePicker({ suggestedName: suggested, types: [{ description: format.label, accept: { 'application/octet-stream': [ext] } }] });
+            } catch (err) {
+                if (err?.name === 'AbortError') return false;
+                throw err;
+            }
+            return this._write(handle, format, handle.name ?? suggested);
+        }
+        // No way to write a file: download it (the page cannot write it back later).
+        const { data, mimeType } = format.export(this.part.model);
+        downloadBlob(new this.win.Blob([data], { type: mimeType }), suggested);
+        Object.assign(this, { name: suggested, format, handle: null });
+        this._saved();
+        return true;
+    }
+
+    /** @private */
+    async _write(handle, format, name) {
+        const { data } = format.export(this.part.model);
+        const writable = await handle.createWritable();
+        await writable.write(data);
+        await writable.close();
+        Object.assign(this, { name, format, handle });
+        this._saved();
+        return true;
+    }
+
+    /** @private */
+    _saved() {
+        this.part.model.markSaved?.();
+        this.showState();
+    }
+
+    /** The model now is not from a file (an import, a new model). */
+    forget() {
+        Object.assign(this, { name: null, format: null, handle: null });
+        this.showState();
+    }
+
+    /** Show the saved state: the page title, and anything listening (the part's toolbar). */
+    showState() {
+        const doc = this.doc;
+        if (doc && this.part.isShown()) {
+            if (!PAGE_TITLES.has(doc)) PAGE_TITLES.set(doc, doc.title);
+            doc.title = `${this.label} — ${PAGE_TITLES.get(doc)}`;
+        }
+        this.part.onFileState?.(this);
+    }
+
+    /** Put the page title back (the part is going). */
+    restoreTitle() {
+        if (this.doc && PAGE_TITLES.has(this.doc)) this.doc.title = PAGE_TITLES.get(this.doc);
+    }
+
+    /** @private */
+    tell(message) {
+        (this.win.alert ?? (() => {}))(message);
+    }
+}