postext 1.51.1 → 1.53.0

package/dist/pipeline/headerFooter.js

@@ -1,26 +1,47 @@
-import { resolvedComics } from '../defaults/comics';
-import { fontFamilyOf, getMeasureRegion, getMeasureUprightDigits, getMeasureWritingMode, measureCentralBaseline, setMeasureWritingMode, withMeasureWritingMode } from '../measure/vertical';
-import { applyPartPalettesToFlow } from './partPalette';
-import { recolorLineNumbers } from './lineNumbers';
-import { applyTitleBreaks, parseInlineFormatting, replaceTitleBreaks } from '../parse/inlineFormatting';
-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 { 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 { 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';
-import { withDigits } from '../arabicNumerals';
+import { resolvedComics } from '../defaults/comics.js';
+import { fontFamilyOf, getMeasureRegion, getMeasureUprightDigits, getMeasureWritingMode, measureCentralBaseline, setMeasureWritingMode, withMeasureWritingMode } from '../measure/vertical.js';
+import { applyPartPalettesToFlow } from './partPalette.js';
+import { recolorLineNumbers } from './lineNumbers.js';
+import { CHIP_PLACEHOLDER, applyTitleBreaks, extractInlineChips, injectChipSpans, parseInlineFormatting, replaceTitleBreaks, withoutChips } from '../parse/inlineFormatting.js';
+import { createBoundingBox, flowRectToPage, pageIsMirrored, pageIsVertical, } from '../vdt.js';
+import { computeChapterTitles, computeChapterTitlesAtTop, computeChapterNumbers, computeChapterNumbersAtTop, computeChapterNumbersByBlock, computeChapterAttrs, computePageMarks, computePartValues, lineJoin, markSourceOf } from './placeholders.js';
+import { parsePartNumber, parsePartPalette, partMarkPages } from './parts.js';
+import { composedLeafConfig, computePageMetrics, onComposedLeaf, sheetRectToFlow } from './buildHelpers.js';
+import { arabicNumbersOf, resolvedLocale } from './config.js';
+import { classifyPages } from './pageRoles.js';
+import { computeSectionStyles, createHeadingLevelResolver, headingIsHidden } from './headingStyles.js';
+import { dimensionToPx } from '../units.js';
+import { resolveDesignLineHeight, resolveDesignSlot } from '../defaults/headerFooter.js';
+import { repeatInstance, resolvePageTemplate } from '../composed/templates.js';
+import { splitSpreadDecoration } from '../composed/spread.js';
+import { pathInkBox } from '../design/pathBlock.js';
+import { frameOfBlock, framePageRect } from '../composed/paint.js';
+import { figureAnchorPointOnPage } from '../composed/labels.js';
+import { expectedFurniture, folioMissingWarnings } from '../composed/furniture.js';
+import { layoutDesignSlot, textVerticalOffset, trailingTracking, } from '../design/layout.js';
+import { resolveDesignText } from '../design/placeholders.js';
+import { plainDesignText } from '../design/richText.js';
+import { withDigits } from '../arabicNumerals.js';
+/** The leader a contents part row's `{leader}` draws (#889): the contents'
+ *  character, gap and switch, and the face of `toc.parts.leader` field by
+ *  field over `toc.leader`'s (#1121); a field neither sets keeps the text
+ *  element's own. */
+function tocPartLeader(toc) {
+    const own = toc.parts.leader ?? {};
+    const color = own.color ?? toc.leader.color;
+    const fontFamily = own.fontFamily ?? toc.leader.fontFamily;
+    const fontSize = own.fontSize ?? toc.leader.fontSize;
+    const fontWeight = own.fontWeight ?? toc.leader.fontWeight;
+    return {
+        enabled: toc.leader.enabled,
+        char: toc.leader.char,
+        gap: toc.leader.gap,
+        ...(color ? { color: color.hex } : {}),
+        ...(fontFamily ? { fontFamily } : {}),
+        ...(fontSize ? { fontSize } : {}),
+        ...(fontWeight !== undefined ? { fontWeight } : {}),
+    };
+}
 /** Slots live in the page margin area between the body edge and the trim
  *  edge. Header slot container: from the trim top down to body top.
  *  Footer slot container: from body bottom down to the trim bottom.
@@ -128,6 +149,7 @@ function textPrimitiveToBlock(prim) {
         ...(l.wordSpacingPx !== undefined ? { wordSpacingPx: l.wordSpacingPx } : {}),
         ...(l.order ? { order: [...l.order] } : {}),
         ...(l.wordOverflow ? { wordOverflow: true } : {}),
+        ...(l.wordDivided ? { wordDivided: l.wordDivided } : {}),
     }));
     return {
         kind: 'text',
@@ -657,19 +679,51 @@ const PLAIN_RUN = { bold: false, italic: false };
 const TITLE_ESCAPE_RE = /[*_^~`]/g;
 const escapeTitleRun = (text) => text.replace(TITLE_ESCAPE_RE, (c) => `\\${c}`);
 const sameEmphasis = (a, b) => a.bold === b.bold && a.italic === b.italic;
-/** The title a page-span heading's default opener prints, from the lines the
- *  heading was measured into (see {@link DefaultOpenerTitle}). The same
- *  reading serves the band's measure (`build.ts`) and its paint, so the
- *  two lay out one text. */
-export function defaultOpenerTitle(lines, numberPrefix, titleBreaks, titleLength, 
-/** What joins the number to the title in the lines
- *  (`HeadingLevelConfig.numberSeparator`). */
-numberSeparator = ' ') {
+/** The characters a chip's label escapes: the inline markers and the
+ *  brackets (`\]`, see `extractInlineChips`). */
+const CHIP_LABEL_ESCAPE_RE = /[*_^~`[\]]/g;
+/** A chip style id that can be written back as `{style="…"}`. */
+const CHIP_STYLE_ID_RE = /^[^"{}\n]*$/;
+/** A laid-out chip written back as `:chip[…]{style="…"}` (#1162): its
+ *  runs in logical order, each with its own bold, italic and script, so a
+ *  design text that reads inline marks sets the same words. Undefined when
+ *  the style id cannot be written in an attribute. */
+function chipMarkdown(chip) {
+    if (!CHIP_STYLE_ID_RE.test(chip.styleId))
+        return undefined;
+    let label = '';
+    for (const run of chip.runs) {
+        if (run.text.length === 0)
+            continue;
+        let t = run.text.replace(CHIP_LABEL_ESCAPE_RE, (c) => `\\${c}`);
+        if (run.baselineShift !== undefined && run.baselineShift !== 0)
+            t = run.baselineShift < 0 ? `^${t}^` : `~${t}~`;
+        const marker = run.bold && run.italic ? '***' : run.bold ? '**' : run.italic ? '*' : '';
+        // Markers go round the words, their edge spaces outside them.
+        const core = t.trim();
+        label += marker && core ? t.replace(core, `${marker}${core}${marker}`) : t;
+    }
+    if (label.trim() === '')
+        label = ' ';
+    return `:chip[${label}]${chip.styleId ? `{style="${chip.styleId}"}` : ''}`;
+}
+/** The characters of a heading's lines read back as the title, with the
+ *  run flags of each (see {@link defaultOpenerTitle}). With `keepChips`
+ *  each chip stays one {@link CHIP_PLACEHOLDER} carrying its box; else it
+ *  is left out with the space beside it (#1100), recorded in `removedAt`.
+ *  Undefined when a chip is to be kept and its segment carries no box. */
+function readTitleChars(lines, keepChips) {
     const chars = [];
     const flags = [];
     /** Where a line break was read back as a space or a no-break space. */
     const separators = new Set();
     let hasMarks = false;
+    /** Where each chip of the title was left out (#1100), in `chars`, with
+     *  the space after it when a space or the start of the line comes
+     *  before it: a chip is a box of the page, not words of the title. */
+    const removedAt = [];
+    let afterChip = false;
+    let missing = false;
     lines.forEach((ln, i) => {
         const start = chars.length;
         // The hyphen repeated from the line before (`repeatHyphen`) is not part
@@ -682,6 +736,25 @@ numberSeparator = ' ') {
                     from = 1;
                 skipRepeated = false;
             }
+            if (s.text === CHIP_PLACEHOLDER) {
+                if (keepChips) {
+                    // The chip, one character with its box (#1162).
+                    if (!s.chip)
+                        missing = true;
+                    chars.push(CHIP_PLACEHOLDER);
+                    flags.push({ bold: false, italic: false, ...(s.chip ? { chip: s.chip } : {}) });
+                    continue;
+                }
+                removedAt.push(chars.length);
+                afterChip = true;
+                continue;
+            }
+            if (afterChip && s.text === ' ' && (chars.length === start || chars[chars.length - 1] === ' ')) {
+                removedAt.push(chars.length);
+                afterChip = false;
+                continue;
+            }
+            afterChip = false;
             const f = s.bold || s.italic || s.script
                 ? { bold: !!s.bold, italic: !!s.italic, ...(s.script ? { script: s.script } : {}) }
                 : PLAIN_RUN;
@@ -712,6 +785,8 @@ numberSeparator = ' ') {
             flags.push(PLAIN_RUN);
         }
     });
+    if (missing)
+        return undefined;
     // The space two lines were broken at takes the emphasis of the words on
     // both sides of it, when they share one.
     for (let i = 1; i < chars.length - 1; i++) {
@@ -721,14 +796,14 @@ numberSeparator = ' ') {
                 flags[i] = { bold: f.bold, italic: f.italic };
         }
     }
-    const full = chars.join('');
-    const drop = numberPrefix && full.startsWith(`${numberPrefix}${numberSeparator}`) ? numberPrefix.length + numberSeparator.length : 0;
-    const title = full.slice(drop);
-    const titleText = applyTitleBreaks(title, titleBreaks, titleLength);
-    if (!hasMarks)
-        return { titleText };
-    let tChars = chars.slice(drop);
-    let tFlags = flags.slice(drop);
+    return { chars, flags, hasMarks, removedAt };
+}
+/** The title written as inline Markdown from its characters and their run
+ *  flags (the number prefix dropped), when it reads back as `expected`
+ *  with the same runs; a chip is written as `:chip[…]` (#1162). */
+function markedTitle(chars, flags, titleBreaks, titleLength, title, expected) {
+    let tChars = chars.slice();
+    let tFlags = flags.slice();
     // The forced breaks, as `applyTitleBreaks` sets them: a newline at each
     // recorded index, the spaces and tabs around it dropped.
     if (titleBreaks && titleBreaks.length > 0 && title.length === titleLength) {
@@ -749,15 +824,26 @@ numberSeparator = ' ') {
         tFlags = tFlags.filter((_, i) => keep[i]);
         tChars = tChars.filter((_, i) => keep[i]);
     }
-    if (tChars.join('') !== titleText)
-        return { titleText };
+    if (tChars.join('') !== expected)
+        return undefined;
+    const chips = tFlags.some((f) => f.chip);
+    let failed = false;
     const scripted = (a, b) => {
         let out = '';
         let i = a;
         while (i < b) {
+            const chip = tFlags[i].chip;
+            if (chip) {
+                const md = chipMarkdown(chip);
+                if (md === undefined)
+                    failed = true;
+                out += md ?? '';
+                i++;
+                continue;
+            }
             const script = tFlags[i].script;
             let j = i + 1;
-            while (j < b && tFlags[j].script === script)
+            while (j < b && tFlags[j].script === script && !tFlags[j].chip)
                 j++;
             const text = escapeTitleRun(tChars.slice(i, j).join(''));
             out += script === 'sup' ? `^${text}^` : script === 'sub' ? `~${text}~` : text;
@@ -796,23 +882,109 @@ numberSeparator = ' ') {
         }
         i = j;
     }
-    // Kept only when it reads back as the same text with the same runs.
-    const spans = parseInlineFormatting(marked);
-    if (spans.map((s) => s.text).join('') !== titleText)
-        return { titleText };
+    if (failed)
+        return undefined;
+    // Kept only when it reads back as the same text with the same runs (a
+    // chip as a chip).
+    let spans;
+    if (chips) {
+        const { cleaned, chips: metas } = extractInlineChips(marked, 0);
+        spans = injectChipSpans(parseInlineFormatting(cleaned), metas);
+    }
+    else
+        spans = parseInlineFormatting(marked);
+    if (spans.map((s) => s.text).join('') !== expected)
+        return undefined;
     let at = 0;
     for (const s of spans) {
         if (s.smallCaps || s.links || s.math)
-            return { titleText };
+            return undefined;
         for (let k = 0; k < s.text.length; k++, at++) {
-            if (/\s/.test(s.text[k]))
-                continue;
             const f = tFlags[at];
+            if ((s.chip !== undefined) !== (f.chip !== undefined))
+                return undefined;
+            if (s.chip || /\s/.test(s.text[k]))
+                continue;
             if (f.bold !== !!s.bold || f.italic !== !!s.italic || f.script !== s.script)
-                return { titleText };
+                return undefined;
+        }
+    }
+    return marked;
+}
+/** The title a page-span heading's default opener prints, from the lines the
+ *  heading was measured into (see {@link DefaultOpenerTitle}). The same
+ *  reading serves the band's measure (`build.ts`) and its paint, so the
+ *  two lay out one text. */
+export function defaultOpenerTitle(lines, numberPrefix, titleBreaks, titleLength, 
+/** What joins the number to the title in the lines
+ *  (`HeadingLevelConfig.numberSeparator`). */
+numberSeparator = ' ') {
+    const { chars, flags, hasMarks, removedAt } = readTitleChars(lines, false);
+    const keptBreaks = titleBreaks;
+    const keptLength = titleLength;
+    const full = chars.join('');
+    const drop = numberPrefix && full.startsWith(`${numberPrefix}${numberSeparator}`) ? numberPrefix.length + numberSeparator.length : 0;
+    if (removedAt.length > 0) {
+        // The forced breaks and the length of the title without what was left
+        // out; a space a closing chip stood after goes too.
+        titleBreaks = titleBreaks?.map((i) => i - removedAt.filter((c, k) => c - drop + k < i).length);
+        titleLength -= removedAt.length;
+        while (chars.length > drop && chars[chars.length - 1] === ' ') {
+            chars.pop();
+            flags.pop();
+            titleLength--;
+        }
+        // A chip alone on the first line leaves the space its line was
+        // broken at (#1162).
+        while (chars.length > drop && chars[drop] === ' ') {
+            chars.splice(drop, 1);
+            flags.splice(drop, 1);
+            titleLength--;
+            titleBreaks = titleBreaks?.map((i) => Math.max(0, i - 1));
         }
     }
-    return { titleText, marked };
+    const title = chars.join('').slice(drop);
+    const titleText = applyTitleBreaks(title, titleBreaks, titleLength);
+    // The heading's chips (#1162): the title with them, written as Markdown
+    // a design text that reads inline marks sets them from. The plain title
+    // leaves them out.
+    if (removedAt.length > 0) {
+        const marked = markedTitleWithChips(lines, numberPrefix, numberSeparator, keptBreaks, keptLength, titleText);
+        if (marked !== undefined)
+            return { titleText, marked, chips: true };
+    }
+    if (!hasMarks)
+        return { titleText };
+    const marked = markedTitle(chars.slice(drop), flags.slice(drop), titleBreaks, titleLength, title, titleText);
+    return marked === undefined ? { titleText } : { titleText, marked };
+}
+/** {@link DefaultOpenerTitle.marked} of a heading with chips (#1162): its
+ *  lines read back with each chip kept, the title written with them, when
+ *  it reads as `titleText` once its chips are left out again. */
+function markedTitleWithChips(lines, numberPrefix, numberSeparator, titleBreaks, titleLength, titleText) {
+    const kept = readTitleChars(lines, true);
+    if (!kept)
+        return undefined;
+    const full = kept.chars.join('');
+    const drop = numberPrefix && full.startsWith(`${numberPrefix}${numberSeparator}`) ? numberPrefix.length + numberSeparator.length : 0;
+    const title = full.slice(drop);
+    const withChips = applyTitleBreaks(title, titleBreaks, titleLength);
+    if (withoutChips(withChips) !== titleText)
+        return undefined;
+    // Text written as `:chip[…]` in a code span would read as a chip.
+    if (titleText.includes(':chip['))
+        return undefined;
+    return markedTitle(kept.chars.slice(drop), kept.flags.slice(drop), titleBreaks, titleLength, title, withChips);
+}
+/** The marked title of a heading placeholder (`titleMarked`), with the
+ *  document's chip styles when it holds the heading's chips (#1162). A
+ *  title with chips and no styles to set them in is left plain. */
+export function markedTitleFields(title, chipStyles) {
+    if (title.marked === undefined)
+        return {};
+    if (!title.chips)
+        return { titleMarked: title.marked };
+    return chipStyles ? { titleMarked: title.marked, chipStyles } : {};
 }
 /** The height of the title a page-span heading's default opener paints
  *  across `width`, with the opener's own painter (a greedy wrap at natural
@@ -821,9 +993,11 @@ numberSeparator = ' ') {
  *  even where the heading's own measure fits more on a line: a justified
  *  line whose spaces shrink, a forced break, a run the opener sets plain
  *  (EF-100). */
-export function measureDefaultOpenerHeight(level, textAlign, title, numberPrefix, width, dpi, metadata, pageIndex) {
+export function measureDefaultOpenerHeight(level, textAlign, title, numberPrefix, width, dpi, metadata, pageIndex, 
+/** The document's chip styles, for a title with chips (#1162). */
+chipStyles) {
     const slot = synthesiseDefaultOpenerSlot(level, numberPrefix.length > 0, textAlign, title.marked !== undefined);
-    const placeholders = headingPlaceholders({ titleText: title.titleText, ...(title.marked !== undefined ? { titleMarked: title.marked } : {}), formattedNumber: numberPrefix }, metadata, pageIndex);
+    const placeholders = headingPlaceholders({ titleText: title.titleText, ...markedTitleFields(title, chipStyles), formattedNumber: numberPrefix }, metadata, pageIndex);
     const result = layoutDesignSlot(slot, { container: { x: 0, y: 0, width, height: MEASURE_CONTAINER_HEIGHT }, dpi, placeholders }, pageIndex);
     let bottom = 0;
     for (const prim of result.primitives) {
@@ -985,6 +1159,15 @@ export function framesInFrame(frames, frame) {
  *  (#1057), per document, as `labelAnchorUnknown` warnings with the
  *  connector's id (read by {@link connectorAnchorUnknownWarnings}). */
 const connectorAnchorWarnings = new WeakMap();
+/** Per document, the furniture each composed page's running heads and
+ *  decoration meant to draw (#1163), read by {@link pageFurnitureWarnings}. */
+const pageFurnitureByDoc = new WeakMap();
+/** The `folioMissing` warnings of `doc` (#1163): a composed page that draws
+ *  no folio or running head most pages of its template and side draw. */
+export function pageFurnitureWarnings(doc) {
+    const records = pageFurnitureByDoc.get(doc);
+    return records && records.length > 0 ? folioMissingWarnings(doc.pages, records) : [];
+}
 /** 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) {
@@ -1052,6 +1235,9 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
     // Parity (odd/even elements) counts the pages before a continued document.
     const pageIndexOffset = doc.pageIndexOffset ?? 0;
     const chapterAttrsByPageIndex = computeChapterAttrs(doc.blocks, doc.pages.length, doc.pages);
+    /** Per composed page, the furniture its slots mean to draw (#1163). */
+    const furnitureRecords = [];
+    pageFurnitureByDoc.set(doc, furnitureRecords);
     // `{bookTotalPages}`: the host's count of the whole book, else the pages
     // up to the end of this document.
     const bookTotalPages = doc.bookPageCount ?? pageIndexOffset + doc.pages.length;
@@ -1302,7 +1488,7 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
                     partPaletteByPageIndex,
                     heading: {
                         titleText: opener.title.titleText,
-                        ...(marked !== undefined ? { titleMarked: marked } : {}),
+                        ...markedTitleFields(opener.title, resolved.chipStyles),
                         formattedNumber: opener.numberPrefix,
                         numericValue: opener.block.headingNumber,
                         locale,
@@ -1358,9 +1544,10 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
             // 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
+            const read = own
                 ? defaultOpenerTitle(block.lines, pref, own.titleBreaks, own.titleLength ?? -1, block.numberSeparator)
                 : defaultOpenerTitle(block.lines, pref, block.titleBreaks, block.titleLength ?? -1, block.numberSeparator);
+            const { titleText: title, marked } = read;
             const placeholders = {
                 kind: 'heading',
                 page,
@@ -1377,7 +1564,7 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
                 partPaletteByPageIndex,
                 heading: {
                     titleText: title,
-                    ...(marked !== undefined ? { titleMarked: marked } : {}),
+                    ...markedTitleFields(read, resolved.chipStyles),
                     formattedNumber: pref,
                     numericValue: block.headingNumber,
                     locale,
@@ -1417,7 +1604,7 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
             const placeholders = {
                 kind: 'part',
                 // `{leader}` fills the row with the contents' leader (#889).
-                leader: { enabled: resolved.toc.leader.enabled, char: resolved.toc.leader.char, gap: resolved.toc.leader.gap },
+                leader: tocPartLeader(resolved.toc),
                 page: rowPage,
                 allPages: doc.pages,
                 metadata: doc.metadata,
@@ -1497,6 +1684,21 @@ function layoutHeadersAndFooters(doc, resourceById, inputs) {
             };
             page.footer = asFurniture(withMeasureWritingMode('horizontal-tb', () => layoutSlotToVdt(footerSlot, footerContainerBbox(sheetArea, pageMetrics.physical.trimBox), page.index + pageIndexOffset, placeholders, dpi, { ...headExtras, slot: 'footer', ...withPath(slotPath('footer')) })));
         }
+        // What the page's running heads and decoration mean to draw on it, for
+        // `folioMissing` (#1163). A spread's decoration is laid on its sheet of
+        // two pages, so only its running heads are compared.
+        if (page.composed && template) {
+            const role = page.composed.role ?? page.role;
+            const at = page.index + pageIndexOffset;
+            const expected = [
+                ...(furniture ? expectedFurniture(headerSlot.elements, 'header', at, role, pageAttrs) : []),
+                ...(furniture ? expectedFurniture(footerSlot.elements, 'footer', at, role, pageAttrs) : []),
+                ...(page.composed.spread === undefined && template.decoration.elements.some((el) => el.kind === 'text')
+                    ? expectedFurniture(resolveDesignSlot(template.decoration, 'header').elements, 'decoration', at, role, pageAttrs)
+                    : []),
+            ];
+            furnitureRecords.push({ pageIndex: page.index, template: page.composed.template, side: recto ? 'recto' : 'verso', expected });
+        }
         // The template's decoration, laid with the frames' final boxes (its
         // elements may anchor to `'#frame'`), on the sheet like the running
         // heads; painted under the frames of layer 1 and up. A spread's (#861)