postext 1.35.1 → 1.37.0

package/dist/pipeline/headerFooter.js

@@ -14,6 +14,7 @@ import { dimensionToPx } from '../units';
 import { resolveDesignLineHeight, resolveDesignSlot } from '../defaults/headerFooter';
 import { resolvePageTemplate } from '../composed/templates';
 import { splitSpreadDecoration } from '../composed/spread';
+import { frameOfBlock } from '../composed/paint';
 import { layoutDesignSlot, textVerticalOffset, trailingTracking, } from '../design/layout';
 import { resolveDesignText } from '../design/placeholders';
 import { plainDesignText } from '../design/richText';
@@ -315,6 +316,9 @@ export function measureHeadingDesign(level, heading, width, dpi, metadata, pageI
     });
     return { height: Math.max(bottom, minHeightPx), textFloor };
 }
+/** `{ configPath }` when there is one. */
+const withPath = (configPath) => (configPath !== undefined ? { configPath } : {});
+const ATTR_ELEMENT = /^\s*\{attr\.([A-Za-z_][A-Za-z0-9_-]*)\}\s*$/;
 const HEADING_LINE_PLACEHOLDER = /\{(number|numberDecimal|numberRoman|numberRomanLower|numberAlpha|numberAlphaLower|numberWords|numberWordsLower|numberOrdinalWords|numberOrdinalWordsLower|numberHan|chapterNumber|chapterTitle)\}/;
 const METADATA_ELEMENT = /^\s*\{(title|subtitle|author|publishDate)\}\s*$/;
 /** The source a text element maps back to, from what its content renders:
@@ -407,7 +411,9 @@ export function layoutSlotToVdt(slot, container, pageIndex, placeholders, dpi, e
             // maps back.
             const keepMap = !el.inlineMarks || src.text === undefined
                 || plainDesignText(resolveDesignText(el.content, placeholders, el.inlineMarks === true)).includes(src.text);
-            sourceByElement.set(el.id, keepMap ? withPrintedTitle(el, src, placeholders) : { start: src.start, end: src.end });
+            const attr = ATTR_ELEMENT.exec(el.content)?.[1];
+            const mapped = keepMap ? withPrintedTitle(el, src, placeholders) : { start: src.start, end: src.end };
+            sourceByElement.set(el.id, attr !== undefined && extras.attrSources?.[attr] ? { ...mapped, attr } : mapped);
         }
     }
     // The texts cut to fit (#628), flagged on the element's own block (not
@@ -419,8 +425,30 @@ export function layoutSlotToVdt(slot, container, pageIndex, placeholders, dpi, e
                 truncated.set(issue.elementId, { mode: issue.mode, text: issue.text });
         }
     }
+    // Where each element is written in the configuration (#857).
+    const pathById = new Map();
+    if (extras?.configPath !== undefined)
+        slot.elements.forEach((el, i) => pathById.set(el.id, `${extras.configPath}/elements/${i}`));
+    for (const [id, path] of extras?.elementPaths ?? [])
+        pathById.set(id, path);
+    // An image picked by an attribute (`resourceId: '{attr.fondo}'`).
+    const imageAttrById = new Map();
+    for (const el of slot.elements) {
+        const attr = el.kind === 'image' ? ATTR_ELEMENT.exec(el.resourceId ?? '')?.[1] : undefined;
+        if (attr !== undefined && extras?.attrs?.[attr] !== undefined)
+            imageAttrById.set(el.id, attr);
+    }
     const blocks = result.primitives.map((prim) => {
         const block = primitiveToBlock(prim);
+        if (prim.id) {
+            block.elementId = prim.id;
+            const path = pathById.get(prim.id);
+            if (path !== undefined)
+                block.configPath = path;
+            const attr = block.kind === 'image' ? imageAttrById.get(prim.id) : undefined;
+            if (attr !== undefined)
+                block.attr = attr;
+        }
         const cut = prim.kind === 'text' && !prim.dropCap ? truncated.get(prim.id) : undefined;
         if (block.kind === 'text' && cut && extras?.slot)
             block.truncated = { elementId: prim.id, slot: extras.slot, mode: cut.mode, text: cut.text };
@@ -434,6 +462,8 @@ export function layoutSlotToVdt(slot, container, pageIndex, placeholders, dpi, e
                 if (src.prefixLen)
                     block.sourcePrefixLen = src.prefixLen;
             }
+            if (src.attr !== undefined)
+                block.attr = src.attr;
         }
         return block;
     });
@@ -852,6 +882,23 @@ function pagesWithPartMarks(doc) {
     });
     return doc.pages.map((p, i) => (marked.has(i) && !p.partInfo ? { ...p, partInfo: marked.get(i) } : p));
 }
+/**
+ * The page frames a heading design inside a composed-page frame is laid out
+ * with (#906): in the frame's blocks' own coordinates, where a frame whose
+ * text the reflow ladder scaled (#858) lays its content out `1 / scale` as
+ * large from its top-left, so a design element anchored to the page lands
+ * on the page once the frame is painted scaled. A turned frame's
+ * (`rotate`) are left upright: what is anchored to the page turns with the
+ * frame.
+ */
+export function framesInFrame(frames, frame) {
+    const s = frame.scale;
+    if (!frames || !(s > 0) || Math.abs(s - 1) < 1e-9)
+        return frames;
+    const o = frame.rect;
+    const back = (r) => ({ x: o.x + (r.x - o.x) / s, y: o.y + (r.y - o.y) / s, width: r.width / s, height: r.height / s });
+    return { ...frames, page: back(frames.page), bleed: back(frames.bleed), ...(frames.outer ? { outer: back(frames.outer) } : {}) };
+}
 export function buildHeadersAndFooters(doc, resourceById, inputs = {}) {
     // Each page's slots measure their text in the writing mode they are set
     // in (see the loop); the mode in force before is put back.
@@ -878,7 +925,10 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
     };
     // Page roles drive the per-element `pages` filter of every slot below.
     classifyPages(doc, resolved);
-    const chapterTitleByPageIndex = computeChapterTitles(doc.blocks, doc.pages.length, doc.pages);
+    // The headings a composed page's frames set (#874) count as running
+    // marks too: they live in the page's floats, not in `doc.blocks`.
+    const markBlocks = withComposedHeadings(doc);
+    const chapterTitleByPageIndex = computeChapterTitles(markBlocks, doc.pages.length, doc.pages);
     // A heading style with an empty `numberingTemplate` prints no number, not
     // even the chapter ordinal `{chapterNumber}` falls back to.
     const numberlessStyles = new Set(resolved.headingStyles.filter((s) => s.numberingTemplate === '').map((s) => s.id));
@@ -887,12 +937,12 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
         : undefined;
     // The digits of the chapter ordinals and page counts the slots print.
     const numerals = resolved.numerals;
-    const chapterNumberByPageIndex = computeChapterNumbers(doc.blocks, doc.pages.length, doc.pages, doc.chapterOrdinalOffset ?? 0, numberless, numerals);
+    const chapterNumberByPageIndex = computeChapterNumbers(markBlocks, doc.pages.length, doc.pages, doc.chapterOrdinalOffset ?? 0, numberless, numerals);
     // The chapter in force at the top of each page (`{chapterTitleAtTop}`,
     // `{chapterNumberAtTop}`): the one a page runs on from, even where a new
     // chapter starts lower down (EF-187).
-    const chapterTitleAtTopByPageIndex = computeChapterTitlesAtTop(doc.blocks, doc.pages.length, doc.pages);
-    const chapterNumberAtTopByPageIndex = computeChapterNumbersAtTop(doc.blocks, doc.pages.length, doc.pages, doc.chapterOrdinalOffset ?? 0, numberless, numerals);
+    const chapterTitleAtTopByPageIndex = computeChapterTitlesAtTop(markBlocks, doc.pages.length, doc.pages);
+    const chapterNumberAtTopByPageIndex = computeChapterNumbersAtTop(markBlocks, doc.pages.length, doc.pages, doc.chapterOrdinalOffset ?? 0, numberless, numerals);
     // A heading design (opener, in-column overlay, contents part row) prints
     // the chapter its block belongs to, not the page's: where two chapters
     // meet on a page, the page value is the later one's. Its height was
@@ -947,7 +997,9 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
         // and bleed boxes are the sheet's (centred, so their own mirror images).
         const frames = pageIsVertical(page) ? verticalFrames : physicalFrames;
         const extras = {
-            frames, pageRole: page.role, resourceById,
+            // A composed page reports its template's role (`role`, default
+            // `'composed'`) to the `pages` filter of its slots' elements.
+            frames, pageRole: page.composed?.role ?? page.role, resourceById,
             metadataSources: doc.metadataSources, metadata: doc.metadata,
             // Right-to-left text: the document's direction, and the mirror of a
             // right-to-left page's flow, which the slots below are painted in.
@@ -977,6 +1029,25 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
         const templateSlot = (own, kind, inherited) => own === false ? { elements: [] } : own ? resolveDesignSlot(own, kind) : inherited;
         const headerSlot = templateSlot(template?.header, 'header', section?.header ?? resolved.header);
         const footerSlot = templateSlot(template?.footer, 'footer', section?.footer ?? resolved.footer);
+        // Where each running head is written (#857): the template's own, the
+        // styled section's, or the document's.
+        const sectionAt = section ? resolved.headingStyles.indexOf(section) : -1;
+        const slotPath = (kind) => {
+            const own = template?.[kind];
+            if (own === false)
+                return undefined;
+            if (own)
+                return kind === 'header' ? template.headerPath : template.footerPath;
+            if (section?.[kind] && sectionAt >= 0)
+                return `/headingStyles/${sectionAt}/${kind}`;
+            return `/${kind}`;
+        };
+        // `{attr.x}` of the page fence in the running heads of a composed page
+        // maps back to the attribute (#857).
+        const pageAttrSources = page.composed
+            ? Object.fromEntries(Object.entries(page.composed.attrSources).map(([k, v]) => [k, { start: v.sourceStart, end: v.sourceEnd }]))
+            : undefined;
+        const headExtras = page.composed ? { ...sheetExtras, attrs: page.composed.attrs, attrSources: pageAttrSources } : sheetExtras;
         // A comic page is all panels: no running heads or folio unless
         // `comics.runningHeads` asks for them (its folio still counts).
         const furniture = !page.comic || resolvedComics(resolved).runningHeads;
@@ -999,7 +1070,7 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
                 partNumberByPageIndex,
                 partPaletteByPageIndex,
             };
-            page.header = asFurniture(withMeasureWritingMode('horizontal-tb', () => layoutSlotToVdt(headerSlot, headerContainerBbox(sheetArea, metrics.physical.trimBox), page.index + pageIndexOffset, placeholders, dpi, { ...sheetExtras, slot: 'header' })));
+            page.header = asFurniture(withMeasureWritingMode('horizontal-tb', () => layoutSlotToVdt(headerSlot, headerContainerBbox(sheetArea, metrics.physical.trimBox), page.index + pageIndexOffset, placeholders, dpi, { ...headExtras, slot: 'header', ...withPath(slotPath('header')) })));
         }
         // Back of a part divider: a blank page right after a part page takes the
         // part's verso design (the model book tints the whole leaf). The part
@@ -1124,11 +1195,84 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
                 }
             }
         }
-        // In-column heading advanced-design overlays: any heading whose level
-        // has `advancedDesign.enabled` and a non-empty slot gets its default
-        // text rendering replaced with a design overlay laid out inside the
-        // block's bbox. `span: 'page'` headings are handled via `openerBand`
-        // above (and are already `hidden`), so they're skipped here.
+        // Heading advanced-design overlays: any heading whose level has
+        // `advancedDesign.enabled` and a non-empty slot gets its default text
+        // rendering replaced with a design overlay laid out inside the block's
+        // bbox. `span: 'page'` headings are handled via `openerBand` above (and
+        // are already `hidden`), so they're skipped here, except in a box.
+        // `boxFrames`: the page frames in the coordinates of the frame the
+        // heading is set in (see `framesInFrame`).
+        const overlayHeading = (block, col, boxFrames) => {
+            if (block.type !== 'heading' || !block.headingLevel)
+                return;
+            // A heading set in a box or a frame (#906) is laid out as in a page
+            // column, against its own block, whatever its span: there is no page
+            // band to open inside a box. Its style and attributes are on
+            // `boxDesign`.
+            const inBox = block.containerId !== undefined;
+            const own = inBox ? block.boxDesign : undefined;
+            if (inBox && !own)
+                return;
+            const lvl = headingLevels.forLevel(block.headingLevel, own ? own.styleId : block.headingStyleId);
+            if (!lvl)
+                return;
+            const attrs = own ? own.attrs : block.attrs;
+            // A page-span heading opened mid-page (`spanBreak: false`, #539)
+            // heads a band under the page's first: its design, or the default
+            // opener, is laid out across the content area at the heading.
+            const midPage = !inBox && lvl.span === 'page' && (col?.band ?? 0) > 0 && !headingIsHidden(block, lvl);
+            const designed = lvl.advancedDesign.enabled && lvl.advancedDesign.slot.elements.length > 0;
+            if (lvl.span === 'page' && !midPage && !inBox)
+                return;
+            if (!midPage && !designed)
+                return;
+            const pref = block.numberPrefix ?? '';
+            // The lines joined back into the title (EF-162), with a forced break
+            // (`\\`) as a newline, as the block's height was measured
+            // (`build.ts`) and as an opener prints it (EF-152).
+            const { titleText: title, marked } = own
+                ? defaultOpenerTitle(block.lines, pref, own.titleBreaks, own.titleLength ?? -1, block.numberSeparator)
+                : defaultOpenerTitle(block.lines, pref, block.titleBreaks, block.titleLength ?? -1, block.numberSeparator);
+            const placeholders = {
+                kind: 'heading',
+                page,
+                allPages: doc.pages,
+                metadata: doc.metadata,
+                chapterTitleByPageIndex,
+                chapterNumberByPageIndex,
+                chapterAttrsByPageIndex,
+                bookTotalPages,
+                numerals,
+                marksFor,
+                partTitleByPageIndex,
+                partNumberByPageIndex,
+                partPaletteByPageIndex,
+                heading: {
+                    titleText: title,
+                    ...(marked !== undefined ? { titleMarked: marked } : {}),
+                    formattedNumber: pref,
+                    numericValue: block.headingNumber,
+                    locale,
+                    chapterNumber: chapterNumberOf(block, page.index),
+                    attrs,
+                },
+            };
+            const overlay = layoutSlotToVdt(designed
+                ? lvl.advancedDesign.slot
+                : synthesiseDefaultOpenerSlot(lvl, pref.length > 0, resolved.headings.textAlign, marked !== undefined), midPage
+                ? openerContainerBbox(block, contentArea)
+                : { x: block.bbox.x, y: block.bbox.y, width: block.bbox.width, height: block.bbox.height }, page.index + pageIndexOffset, placeholders, dpi, {
+                ...extras,
+                ...(boxFrames ? { frames: boxFrames } : {}),
+                titleSource: headingTitleSource(block, title),
+                attrSources: own ? own.attrSources : block.attrSources,
+                attrs,
+                headingSource: headingLineSource(block),
+                slot: 'heading',
+            });
+            if (overlay)
+                block.designOverlay = overlay;
+        };
         for (const col of page.columns) {
             for (const block of col.blocks) {
                 if (block.hidden)
@@ -1171,63 +1315,24 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
                         block.designOverlay = overlay;
                     continue;
                 }
-                if (block.type !== 'heading' || !block.headingLevel)
-                    continue;
-                const lvl = headingLevels.forLevel(block.headingLevel, block.headingStyleId);
-                if (!lvl)
-                    continue;
-                // A page-span heading opened mid-page (`spanBreak: false`, #539)
-                // heads a band under the page's first: its design, or the default
-                // opener, is laid out across the content area at the heading.
-                const midPage = lvl.span === 'page' && (col.band ?? 0) > 0 && !headingIsHidden(block, lvl);
-                const designed = lvl.advancedDesign.enabled && lvl.advancedDesign.slot.elements.length > 0;
-                if (lvl.span === 'page' && !midPage)
-                    continue;
-                if (!midPage && !designed)
+                overlayHeading(block, col);
+            }
+        }
+        // The headings of boxes and frames set out of the columns (#906): fixed
+        // and floated callouts, the frames of a composed page and the halves of
+        // a spread's frames shown on this page.
+        const composed = page.composed;
+        for (const block of page.floats ?? []) {
+            if (block.type !== 'heading' || block.hidden || block.containerId === undefined)
+                continue;
+            const frame = composed ? frameOfBlock(composed, block.id) : undefined;
+            overlayHeading(block, undefined, frame ? framesInFrame(extras.frames, frame) : undefined);
+        }
+        for (const frame of composed?.frames ?? []) {
+            for (const block of frame.facingBlocks ?? []) {
+                if (block.type !== 'heading' || block.hidden || block.containerId === undefined)
                     continue;
-                const pref = block.numberPrefix ?? '';
-                // The lines joined back into the title (EF-162), with a forced break
-                // (`\\`) as a newline, as the block's height was measured
-                // (`build.ts`) and as an opener prints it (EF-152).
-                const { titleText: title, marked } = defaultOpenerTitle(block.lines, pref, block.titleBreaks, block.titleLength ?? -1, block.numberSeparator);
-                const placeholders = {
-                    kind: 'heading',
-                    page,
-                    allPages: doc.pages,
-                    metadata: doc.metadata,
-                    chapterTitleByPageIndex,
-                    chapterNumberByPageIndex,
-                    chapterAttrsByPageIndex,
-                    bookTotalPages,
-                    numerals,
-                    marksFor,
-                    partTitleByPageIndex,
-                    partNumberByPageIndex,
-                    partPaletteByPageIndex,
-                    heading: {
-                        titleText: title,
-                        ...(marked !== undefined ? { titleMarked: marked } : {}),
-                        formattedNumber: pref,
-                        numericValue: block.headingNumber,
-                        locale,
-                        chapterNumber: chapterNumberOf(block, page.index),
-                        attrs: block.attrs,
-                    },
-                };
-                const overlay = layoutSlotToVdt(designed
-                    ? lvl.advancedDesign.slot
-                    : synthesiseDefaultOpenerSlot(lvl, pref.length > 0, resolved.headings.textAlign, marked !== undefined), midPage
-                    ? openerContainerBbox(block, contentArea)
-                    : { x: block.bbox.x, y: block.bbox.y, width: block.bbox.width, height: block.bbox.height }, page.index + pageIndexOffset, placeholders, dpi, {
-                    ...extras,
-                    titleSource: headingTitleSource(block, title),
-                    attrSources: block.attrSources,
-                    attrs: block.attrs,
-                    headingSource: headingLineSource(block),
-                    slot: 'heading',
-                });
-                if (overlay)
-                    block.designOverlay = overlay;
+                overlayHeading(block, undefined, framesInFrame(extras.frames, frame));
             }
         }
         if (furniture && footerSlot.elements.length > 0) {
@@ -1249,7 +1354,7 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
                 partNumberByPageIndex,
                 partPaletteByPageIndex,
             };
-            page.footer = asFurniture(withMeasureWritingMode('horizontal-tb', () => layoutSlotToVdt(footerSlot, footerContainerBbox(sheetArea, metrics.physical.trimBox), page.index + pageIndexOffset, placeholders, dpi, { ...sheetExtras, slot: 'footer' })));
+            page.footer = asFurniture(withMeasureWritingMode('horizontal-tb', () => layoutSlotToVdt(footerSlot, footerContainerBbox(sheetArea, metrics.physical.trimBox), page.index + pageIndexOffset, placeholders, dpi, { ...headExtras, slot: 'footer', ...withPath(slotPath('footer')) })));
         }
         // The template's decoration, laid with the frames' final boxes (its
         // elements may anchor to `'#frame'`), on the sheet like the running
@@ -1318,7 +1423,11 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
                 partNumberByPageIndex,
                 partPaletteByPageIndex,
             };
-            const decoration = withMeasureWritingMode('horizontal-tb', () => layoutSlotToVdt(resolveDesignSlot(template.decoration, 'header'), container, page.index + pageIndexOffset, placeholders, dpi, { ...sheetExtras, frames: { ...slotFrames, named, declared }, attrs: page.composed.attrs, attrSources }));
+            const decoration = withMeasureWritingMode('horizontal-tb', () => layoutSlotToVdt(resolveDesignSlot(template.decoration, 'header'), container, page.index + pageIndexOffset, placeholders, dpi, {
+                ...sheetExtras, frames: { ...slotFrames, named, declared }, attrs: page.composed.attrs, attrSources,
+                // Each element's pointer, from the template that sets it (#857).
+                elementPaths: new Map(resolveDesignSlot(template.decoration, 'header').elements.map((el, i) => [el.id, template.decorationPaths[i]])),
+            }));
             if (decoration && pair) {
                 const halves = splitSpreadDecoration(decoration, shift, { left: bleedBox, right: { ...bleedBox, x: bleedBox.x + shift } });
                 pair.left.composed.decoration = halves.left;
@@ -1353,4 +1462,50 @@ export function stampPageBackgrounds(doc, palettes, pageColor, basePalette) {
             page.background = hex;
     }
 }
+/** `doc.blocks` as the running marks read them (#874): on a composed page
+ *  only its headings count, in frame order, so a chapter that opens in one
+ *  of its frames opens the page (`{chapterTitleAtTop}`) even though the
+ *  story boxes of the frames come first. The same array when the document
+ *  has no composed page. */
+function withComposedHeadings(doc) {
+    const composed = new Set();
+    for (const page of doc.pages)
+        if (page.composed)
+            composed.add(page.index);
+    if (composed.size === 0)
+        return doc.blocks;
+    const out = [];
+    const seen = new Set();
+    let lastComposed = -1;
+    const pushFrames = (index) => {
+        const page = doc.pages[index];
+        if (!page?.composed)
+            return;
+        const byId = new Map((page.floats ?? []).map((b) => [b.id, b]));
+        for (const f of page.composed.frames) {
+            for (const id of f.blockIds) {
+                const b = byId.get(id);
+                if (b && b.headingLevel !== undefined && !seen.has(b.id)) {
+                    seen.add(b.id);
+                    out.push(b);
+                }
+            }
+        }
+    };
+    for (const b of doc.blocks) {
+        if (!composed.has(b.pageIndex)) {
+            out.push(b);
+            continue;
+        }
+        if (b.pageIndex !== lastComposed) {
+            lastComposed = b.pageIndex;
+            pushFrames(b.pageIndex);
+        }
+        if (b.headingLevel !== undefined && !seen.has(b.id)) {
+            seen.add(b.id);
+            out.push(b);
+        }
+    }
+    return out;
+}
 //# sourceMappingURL=headerFooter.js.map