postext 1.46.4 → 1.48.0

package/dist/pipeline/headerFooter.js

@@ -6,15 +6,17 @@ import { applyTitleBreaks, parseInlineFormatting, replaceTitleBreaks } from '../
 import { createBoundingBox, flowRectToPage, pageIsMirrored, pageIsVertical, } from '../vdt';
 import { computeChapterTitles, computeChapterTitlesAtTop, computeChapterNumbers, computeChapterNumbersAtTop, computeChapterNumbersByBlock, computeChapterAttrs, computePageMarks, computePartValues, lineJoin, markSourceOf } from './placeholders';
 import { parsePartNumber, parsePartPalette, partMarkPages } from './parts';
-import { computePageMetrics, sheetRectToFlow } from './buildHelpers';
+import { composedLeafConfig, computePageMetrics, onComposedLeaf, sheetRectToFlow } from './buildHelpers';
 import { arabicNumbersOf, resolvedLocale } from './config';
 import { classifyPages } from './pageRoles';
 import { computeSectionStyles, createHeadingLevelResolver, headingIsHidden } from './headingStyles';
 import { dimensionToPx } from '../units';
 import { resolveDesignLineHeight, resolveDesignSlot } from '../defaults/headerFooter';
-import { resolvePageTemplate } from '../composed/templates';
+import { repeatInstance, resolvePageTemplate } from '../composed/templates';
 import { splitSpreadDecoration } from '../composed/spread';
+import { pathInkBox } from '../design/pathBlock';
 import { frameOfBlock, framePageRect } from '../composed/paint';
+import { figureAnchorPointOnPage } from '../composed/labels';
 import { layoutDesignSlot, textVerticalOffset, trailingTracking, } from '../design/layout';
 import { resolveDesignText } from '../design/placeholders';
 import { plainDesignText } from '../design/richText';
@@ -74,8 +76,27 @@ export function primitiveToBlock(prim) {
         return rulePrimitiveToBlock(prim);
     if (prim.kind === 'image')
         return imagePrimitiveToBlock(prim);
+    if (prim.kind === 'path')
+        return pathPrimitiveToBlock(prim);
     return boxPrimitiveToBlock(prim);
 }
+/** A path element's outline as the vector block (#1060): the block's box
+ *  is the ink's (`pathInkBox`), for hit tests and clips. */
+function pathPrimitiveToBlock(prim) {
+    const block = {
+        kind: 'path',
+        bbox: createBoundingBox(0, 0, 0, 0),
+        subpaths: prim.subpaths.map((sp) => sp.map((c) => ({ ...c }))),
+        ...(prim.fill ? { fill: prim.fill } : {}),
+        ...(prim.stroke ? { stroke: { ...prim.stroke, ...(prim.stroke.dash ? { dash: [...prim.stroke.dash] } : {}) } } : {}),
+        // A connector's end marks (#1056).
+        ...(prim.markers ? { markers: prim.markers.map((m) => ({ ...m })) } : {}),
+        // Painted after the frames (#1076).
+        ...(prim.over ? { over: true } : {}),
+    };
+    block.bbox = pathInkBox(block);
+    return block;
+}
 function imagePrimitiveToBlock(prim) {
     return {
         kind: 'image',
@@ -120,6 +141,7 @@ function textPrimitiveToBlock(prim) {
                 borderColor: prim.box.borderColor,
                 borderWidthPx: prim.box.borderWidthPx,
                 borderRadiusPx: prim.box.borderRadiusPx,
+                ...shapeFields(prim.box),
             }
             : undefined,
         clip: prim.needsClip,
@@ -167,9 +189,17 @@ function boxPrimitiveToBlock(prim) {
             borderColor: prim.box.borderColor,
             borderWidthPx: prim.box.borderWidthPx,
             borderRadiusPx: prim.box.borderRadiusPx,
+            ...shapeFields(prim.box),
         },
     };
 }
+/** A box's corners of their own and border per side (#1059), copied. */
+function shapeFields(box) {
+    return {
+        ...(box.borderRadiiPx ? { borderRadiiPx: [...box.borderRadiiPx] } : {}),
+        ...(box.borderSides ? { borderSides: { ...box.borderSides } } : {}),
+    };
+}
 /** Where a primitive's reservation ends: its foot, except for a drop cap,
  *  whose line box runs a quarter of its size under its baseline. The letter
  *  sits inside its paragraph's lines, so it reserves nothing below the text
@@ -211,7 +241,7 @@ export function headingDesignBoxes(level, heading, container, dpi, metadata, pag
     if (!level.advancedDesign.enabled || level.advancedDesign.slot.elements.length === 0)
         return [];
     const result = layoutDesignSlot(level.advancedDesign.slot, { container, dpi, placeholders: headingPlaceholders(heading, metadata, pageIndex), frames, resourceById }, pageIndex);
-    const excluded = new Set(level.advancedDesign.slot.elements.filter((el) => el.reserve === false).map((el) => el.id));
+    const excluded = new Set(level.advancedDesign.slot.elements.filter((el) => el.kind !== 'connector' && el.reserve === false).map((el) => el.id));
     const out = [];
     result.primitives.forEach((prim, i) => {
         if (excluded.has(result.elementIds[i]))
@@ -294,7 +324,7 @@ function measureDesignBand(design, heading, width, dpi, metadata, pageIndex, fra
     const taller = result.primitives.some((p) => p.y + p.height > MEASURE_CONTAINER_HEIGHT / 4)
         ? layoutAt(2 * MEASURE_CONTAINER_HEIGHT)
         : result;
-    const excluded = new Set(design.slot.elements.filter((el) => el.reserve === false).map((el) => el.id));
+    const excluded = new Set(design.slot.elements.filter((el) => el.kind !== 'connector' && el.reserve === false).map((el) => el.id));
     let bottom = 0;
     let claimedBy;
     let textFloor = 0;
@@ -433,6 +463,20 @@ export function layoutSlotToVdt(slot, container, pageIndex, placeholders, dpi, e
         ...(extras?.startRight ? { startRight: true } : {}),
         ...(extras?.arabicNumbers ? { arabicNumbers: true } : {}),
     }, pageIndex);
+    if (extras?.connectorDropped) {
+        for (const issue of result.issues)
+            if (issue.kind === 'connectorDropped')
+                extras.connectorDropped.push({ elementId: issue.elementId, targetId: issue.targetId });
+    }
+    if (extras?.connectorAnchorUnknown) {
+        for (const issue of result.issues) {
+            if (issue.kind !== 'connectorAnchorUnknown')
+                continue;
+            const { kind: _kind, ...rest } = issue;
+            void _kind;
+            extras.connectorAnchorUnknown.push(rest);
+        }
+    }
     if (result.primitives.length === 0)
         return undefined;
     const sourceByElement = new Map();
@@ -937,6 +981,15 @@ export function framesInFrame(frames, frame) {
     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) } : {}) };
 }
+/** The ends of connectors at an anchor no picture of their frame has
+ *  (#1057), per document, as `labelAnchorUnknown` warnings with the
+ *  connector's id (read by {@link connectorAnchorUnknownWarnings}). */
+const connectorAnchorWarnings = new WeakMap();
+/** The `labelAnchorUnknown` warnings of the connectors of `doc`'s composed
+ *  pages (#1057): an end set at an anchor no picture of its frame has. */
+export function connectorAnchorUnknownWarnings(doc) {
+    return connectorAnchorWarnings.get(doc) ?? [];
+}
 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.
@@ -955,12 +1008,21 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
     // Header and footer are laid out on the sheet on every page; every other
     // slot (openers, part pages, overlays) in the page's flow frame, so on a
     // vertical page their text reads vertically.
-    const physicalFrames = { page: metrics.physical.trimBox, bleed: metrics.physical.bleedBox };
-    const verticalFrames = {
-        page: sheetRectToFlow(metrics.physical.trimBox, metrics.pageWidthPx),
-        bleed: sheetRectToFlow(metrics.physical.bleedBox, metrics.pageWidthPx),
-        upright: true,
-    };
+    const framesOf = (m) => ({
+        physical: { page: m.physical.trimBox, bleed: m.physical.bleedBox },
+        vertical: {
+            page: sheetRectToFlow(m.physical.trimBox, m.pageWidthPx),
+            bleed: sheetRectToFlow(m.physical.bleedBox, m.pageWidthPx),
+            upright: true,
+        },
+    });
+    const docFrames = framesOf(metrics);
+    // A composed page laid out on a host's leaf (`composedViewerLeaf`,
+    // #1045) has the leaf's sheet: its decoration and furniture are laid on
+    // it.
+    const leafConfig = composedLeafConfig(resolved);
+    const leafMetrics = leafConfig ? computePageMetrics(leafConfig) : undefined;
+    const leafFrames = leafMetrics ? framesOf(leafMetrics) : undefined;
     // Page roles drive the per-element `pages` filter of every slot below.
     classifyPages(doc, resolved);
     // The headings a composed page's frames set (#874) count as running
@@ -1051,6 +1113,9 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
         // page's flow does; running heads and folios are horizontal on the
         // sheet, whatever the flow (see below).
         setMeasureWritingMode(pageIsVertical(page) ? 'vertical-rl' : 'horizontal-tb');
+        const onLeaf = leafMetrics !== undefined && onComposedLeaf(resolved, page);
+        const pageMetrics = onLeaf ? leafMetrics : metrics;
+        const { physical: physicalFrames, vertical: verticalFrames } = onLeaf ? leafFrames : docFrames;
         // Per-page content area: mirrored margins swap inner/outer on even pages.
         const contentArea = page.contentArea;
         // A right-to-left page lays these out in its mirrored flow, whose trim
@@ -1072,7 +1137,7 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
         // side away from the spine (it swaps with the binding and the page's
         // parity, as mirrored margins do).
         const sheetArea = flowRectToPage(page, contentArea);
-        const trim = metrics.physical.trimBox;
+        const trim = pageMetrics.physical.trimBox;
         const recto = (page.index + pageIndexOffset) % 2 === 0;
         const outerRight = recto !== (resolved.page.binding === 'right');
         const outer = outerRight
@@ -1086,7 +1151,7 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
         // A composed page (#855) takes its template's running heads: a slot of
         // its own, `false` for none, unset for the section's.
         const template = page.composed
-            ? resolvePageTemplate({ pageTemplates: resolved.pageTemplates, calloutStyles: resolved.calloutStyles }, page.composed.template, { parity: recto ? 'recto' : 'verso' })
+            ? resolvePageTemplate({ pageTemplates: resolved.pageTemplates, calloutStyles: resolved.calloutStyles }, page.composed.template, { parity: recto ? 'recto' : 'verso', ...(page.composed.modules ? { modules: page.composed.modules } : {}) })
             : undefined;
         const pageAttrs = page.composed && Object.keys(page.composed.attrs).length > 0 ? page.composed.attrs : undefined;
         const templateSlot = (own, kind, inherited) => own === false ? { elements: [] } : own ? resolveDesignSlot(own, kind) : inherited;
@@ -1133,7 +1198,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, { ...headExtras, slot: 'header', ...withPath(slotPath('header')) })));
+            page.header = asFurniture(withMeasureWritingMode('horizontal-tb', () => layoutSlotToVdt(headerSlot, headerContainerBbox(sheetArea, pageMetrics.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
@@ -1430,7 +1495,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, { ...headExtras, slot: 'footer', ...withPath(slotPath('footer')) })));
+            page.footer = asFurniture(withMeasureWritingMode('horizontal-tb', () => layoutSlotToVdt(footerSlot, footerContainerBbox(sheetArea, pageMetrics.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
@@ -1442,8 +1507,8 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
         const ruled = (p) => (p?.composed?.frames ?? []).some((f) => f.rules && !f.facingBlocks);
         if (page.composed && template && (template.decoration.elements.length > 0 || ruled(page) || ruled(facing)) && !(facing && spreadDecorated.has(page.index))) {
             const pair = facing?.composed?.spread && page.composed.spread ? { left: page.composed.spread === 'left' ? page : facing, right: page.composed.spread === 'left' ? facing : page } : undefined;
-            const trimBox = metrics.physical.trimBox;
-            const bleedBox = metrics.physical.bleedBox;
+            const trimBox = pageMetrics.physical.trimBox;
+            const bleedBox = pageMetrics.physical.bleedBox;
             const shift = trimBox.width;
             /** A frame's box on the sheet (of the spread, the right page's set
              *  `shift` along). */
@@ -1454,6 +1519,10 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
             /** Frames that take no room on the page (#912): what anchors to
              *  them is not drawn. */
             const collapsed = new Set();
+            /** Frames a connector does not reach (#1056): collapsed, or empty and
+             *  optional. */
+            const absent = new Set();
+            const optional = new Set(template.frames.filter((f) => f.optional).map((f) => f.name));
             /** Empty frames' ruled lines (#914), on the sheet. */
             const rules = [];
             /** The counter of the first numbered heading each frame holds
@@ -1461,12 +1530,17 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
             const headingNumberByFrame = {};
             let headingNumber;
             const floatById = new Map();
+            /** The page and the blocks of each frame, for a connector's end at
+             *  an anchor of the picture it holds (#1057). */
+            const frameBlocks = new Map();
             const nameFrames = (p, dx) => {
                 for (const b of p.floats ?? [])
                     floatById.set(b.id, b);
                 for (const f of p.composed?.frames ?? []) {
                     if (f.collapsed)
                         collapsed.add(f.name);
+                    if (f.collapsed || (optional.has(f.repeat?.frame ?? f.name) && f.sourceStart === undefined && f.continuedFrom === undefined))
+                        absent.add(f.name);
                     if (!f.facingBlocks) {
                         for (const id of f.blockIds) {
                             const n = floatById.get(id)?.headingNumber;
@@ -1485,12 +1559,23 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
                     const d = flowRectToPage(p, framePageRect({ rect: f.declaredRect ?? f.rect, writingMode: f.writingMode }));
                     named[f.name] = { ...r, x: r.x + dx };
                     declared[f.name] = { ...d, x: d.x + dx };
+                    frameBlocks.set(f.name, { page: p, dx, blocks: f.blockIds.map((id) => floatById.get(id)).filter((b) => b !== undefined) });
                     for (const rule of f.rules ?? []) {
                         // A vertical page's flow turns a rule across its lines.
                         const b = flowRectToPage(p, rule.bbox);
                         rules.push({ ...rule, bbox: { ...b, x: b.x + dx }, direction: b.height > b.width ? 'vertical' : 'horizontal' });
                     }
                 }
+                // A module's box (#1062): what its decoration anchored to its
+                // `'container'` reads (`#<name>`). A module laid elsewhere has none
+                // here, and its decoration is not drawn.
+                for (const m of p.composed?.modules ?? []) {
+                    if (!m.rect || named[m.name] !== undefined)
+                        continue;
+                    const r = flowRectToPage(p, m.rect);
+                    named[m.name] = { ...r, x: r.x + dx };
+                    declared[m.name] = { ...r, x: r.x + dx };
+                }
             };
             let container;
             let slotFrames = physicalFrames;
@@ -1534,12 +1619,76 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
                 ...(headingNumber !== undefined ? { headingNumber } : {}),
                 ...(Object.keys(headingNumberByFrame).length > 0 ? { headingNumberByFrame } : {}),
             };
+            // An element anchored to an instance of a repeated frame (#1061) the
+            // page does not have (`#card[5]` on a page of three cards) is not
+            // drawn, as one anchored to a frame that takes no room. So is one
+            // anchored to a module (#1062), or a frame of it, that went on whole.
+            const ofModule = new Set((template.modules ?? []).flatMap((m) => [m.name, ...m.frames, ...m.groups]));
+            for (const el of template.decoration.elements) {
+                const to = el.placement?.anchor?.to;
+                const t = typeof to === 'string' && to.startsWith('#') ? to.slice(1) : undefined;
+                if (t !== undefined && named[t] === undefined && (repeatInstance(t) !== undefined || ofModule.has(t)))
+                    collapsed.add(t);
+            }
             const slot = resolveDesignSlot(template.decoration, 'header');
+            const connectorDropped = [];
+            const connectorAnchorUnknown = [];
+            // A connector's end at an anchor of the picture its frame holds
+            // (#1057): the first figure of the frame whose resource has it.
+            const anchorPoint = (frame, anchor) => {
+                const held = frameBlocks.get(frame);
+                let first;
+                for (const b of held?.blocks ?? []) {
+                    const rb = b.resourceBlock;
+                    if (!rb || (rb.kind !== 'bitmap' && rb.kind !== 'svg'))
+                        continue;
+                    first ??= b;
+                    const at = figureAnchorPointOnPage(held.page, b, anchor);
+                    if (!at)
+                        continue;
+                    const p = { x: at.x + held.dx, y: at.y };
+                    // A point the frame cuts off (its picture runs past the frame's
+                    // foot) is not shown on the page.
+                    const box = named[frame];
+                    if (box && (p.x < box.x - 0.5 || p.x > box.x + box.width + 0.5 || p.y < box.y - 0.5 || p.y > box.y + box.height + 0.5))
+                        return { hidden: true };
+                    return p;
+                }
+                const res = first?.resourceBlock?.resource;
+                return res ? { resourceId: res.id, known: (res.anchors ?? []).map((a) => a.id) } : { known: [] };
+            };
             const laidDecoration = template.decoration.elements.length === 0 ? undefined : withMeasureWritingMode('horizontal-tb', () => layoutSlotToVdt(collapsed.size > 0 ? withoutAnchoredTo(slot, collapsed) : slot, container, page.index + pageIndexOffset, placeholders, dpi, {
-                ...sheetExtras, frames: { ...slotFrames, named, declared }, attrs: page.composed.attrs, attrSources,
+                ...sheetExtras, frames: { ...slotFrames, named, declared, ...(absent.size > 0 ? { absent } : {}), anchorPoint }, attrs: page.composed.attrs, attrSources, connectorDropped, connectorAnchorUnknown,
                 // 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]])),
             }));
+            // The ends connectors left out, in the reflow log of the page laid
+            // (of a spread, its first page); a pass that lays the decoration
+            // again replaces them.
+            for (const p of pair ? [pair.left, pair.right] : [page]) {
+                if (p.composed?.log.some((e) => e.kind === 'connectorDropped'))
+                    p.composed.log = p.composed.log.filter((e) => e.kind !== 'connectorDropped');
+            }
+            for (const d of connectorDropped)
+                page.composed.log.push({ frame: d.targetId, kind: 'connectorDropped', cause: d.elementId });
+            // Ends at an anchor the frame's picture lacks (#1057): a content
+            // warning on the page laid, once per pass.
+            const unknown = connectorAnchorWarnings.get(doc) ?? [];
+            const kept = unknown.filter((w) => !(pair ? [pair.left.index, pair.right.index] : [page.index]).includes(w.pageIndex ?? -1));
+            for (const d of connectorAnchorUnknown) {
+                kept.push({
+                    kind: 'labelAnchorUnknown',
+                    resourceId: d.resourceId ?? '',
+                    anchor: d.anchor,
+                    known: d.known,
+                    connector: d.elementId,
+                    frame: d.targetId,
+                    ...(doc.config?.locale ? { locale: doc.config.locale } : {}),
+                    pageIndex: page.index,
+                });
+            }
+            if (kept.length > 0 || unknown.length > 0)
+                connectorAnchorWarnings.set(doc, kept);
             const decoration = rules.length === 0 ? laidDecoration
                 : laidDecoration ? { ...laidDecoration, blocks: [...laidDecoration.blocks, ...rules] } : { bbox: { ...container }, blocks: rules };
             if (decoration && pair) {
@@ -1560,6 +1709,9 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
 function withoutAnchoredTo(slot, frames) {
     const dropped = new Set();
     const target = (el) => {
+        // A connector (#1056) drops its own ends on frames the page lacks.
+        if (el.kind === 'connector')
+            return undefined;
         const to = el.placement.anchor.to;
         return to.startsWith('#') ? to.slice(1) : undefined;
     };