ntk 8.14.5 → 8.14.6

package/lib/text/font.js

@@ -3,6 +3,7 @@ import * as fontkit from 'fontkit';
 import { flatten, rasterizePath } from '../rasterize.js';
 import { NO_ANCHOR, tolerateAnchors, watchAnchors } from './anchors.js';
 import { marksCover, standInMarks } from './marks.js';
+import { pairGlyphs, pairsCover } from './pairs.js';
 
 // Axis coordinates are rounded to this many decimals before anything is
 // instantiated or cached. Every distinct coordinate is a font in its own
@@ -154,6 +155,8 @@ export default class Font {
     // whether the face's mark attachment is watched for a NULL anchor
     // (./anchors.js): set at its first shaping, false once one has been met
     this._anchors = false;
+    // the glyphs its pairs can move (./pairs.js), read when first asked
+    this._pairs = undefined;
   }
 
   static loadSync(path, postscriptName) {
@@ -356,6 +359,17 @@ export default class Font {
     return this._drawable;
   }
 
+  /**
+   * Whether two glyphs side by side can be set otherwise than apart: the
+   * left one moved against what follows it, or the right one against what
+   * comes before it (./pairs.js). True where the tables cannot tell.
+   */
+  mayKern(left, right) {
+    if (this._pairs === undefined) this._pairs = pairGlyphs(this.fk);
+    const pairs = this._pairs;
+    return pairs === null || pairsCover(pairs.left, left) || pairsCover(pairs.right, right);
+  }
+
   hasGlyph(codepoint) {
     return this.drawable && this.fk.hasGlyphForCodePoint(codepoint);
   }

package/lib/text/fontmanager.js

@@ -235,6 +235,8 @@ export default class FontManager {
     this._shapeCount = 0;
     // whether two letters shape otherwise together than apart (`_meets`)
     this._meetings = new Map();
+    // how much two letters kern across a break opportunity (`_kernAcross`)
+    this._kerns = new Map();
     // a paragraph's layout up to the line fill, for its next width
     // (text/paragraphs.js, TextLayout)
     this._paragraphs = new ParagraphCache();
@@ -580,6 +582,28 @@ export default class FontManager {
     return meets;
   }
 
+  /**
+   * How much wider the two letters of `pair`, cut at `cut`, are set
+   * together than apart in this style: their kerning, negative for a pair
+   * set closer. 0 where they do not kern, and where shaping them together
+   * changes a glyph — a ligature, a contextual form — which no offset
+   * between the two stands for. Kept, as `_meets` keeps its answers.
+   */
+  _kernAcross(pair, cut, style, levelsKey = '0') {
+    const key = `${shapeGroupOf(style, levelsKey)}|${cut}|${pair}`;
+    let kern = this._kerns.get(key);
+    if (kern !== undefined) return kern;
+    const whole = this._shapeCached(pair, style, levelsKey);
+    const left = this._shapeCached(pair.slice(0, cut), style, sliceKey(levelsKey, 0, cut));
+    const right = this._shapeCached(pair.slice(cut), style, sliceKey(levelsKey, cut, pair.length));
+    const ids = (...shaped) => shaped.flatMap((s) => s.runs.flatMap((r) => r.glyphs.map((g) => g.id))).join(',');
+    kern = whole.width - left.width - right.width;
+    if (Math.abs(kern) <= 1e-6 || ids(whole) !== ids(left, right)) kern = 0;
+    if (this._kerns.size >= SHAPE_GENERATION) this._kerns.clear();
+    this._kerns.set(key, kern);
+    return kern;
+  }
+
   _shapeCached(text, style, levelsKey = '0') {
     // A hit in this generation is the whole cost of a word a paragraph has
     // shaped before — a relayout at a new width asks for every word again,

package/lib/text/layout.js

@@ -21,10 +21,16 @@ const UNSPACED =
 /** How wide a line's tokens are, the white space it ends on left out. */
 function tokensWidth(toks) {
   let width = 0;
-  for (const token of toks) width += token.width;
+  for (let i = 0; i < toks.length; i++) width += toks[i].width + (i ? kernBefore(toks[i]) : 0);
   return toks.length ? width - toks[toks.length - 1].wsWidth : 0;
 }
 
+/** The kerning between a token and the one before it on its line
+ *  (`TextLayout._kernBefore`); none for a token a line starts with. */
+function kernBefore(token) {
+  return token.kernBefore ?? 0;
+}
+
 function isWsGlyph(g) {
   return g.codePoints.length > 0 && g.codePoints.every((cp) => WS.has(cp));
 }
@@ -121,7 +127,7 @@ export class TextLayout {
         curWidth = 0;
       };
       for (let token of tokens) {
-        while (wraps && curWidth + token.width - token.wsWidth > maxWidth) {
+        while (wraps && curWidth + (cur.length ? kernBefore(token) : 0) + token.width - token.wsWidth > maxWidth) {
           if (cur.length > 0) {
             flush();
           } else if (whole && !UNSPACED.test(text.slice(token.start, token.end))) {
@@ -135,8 +141,8 @@ export class TextLayout {
             token = rest;
           }
         }
+        curWidth += token.width + (cur.length ? kernBefore(token) : 0);
         cur.push(token);
-        curWidth += token.width;
         if (token.required) flush();
       }
       if (cur.length) lineTokens.push(cur);
@@ -185,16 +191,24 @@ export class TextLayout {
       // .start/.end are absolute code-unit ranges into the full text, kept
       // for caret positioning (caretPosition / indexAt)
       let entries = [];
-      for (const token of toks) {
+      for (let t = 0; t < toks.length; t++) {
+        const token = toks[t];
+        // the kerning with the token before it goes before its first run
+        let kern = t ? kernBefore(token) : 0;
         for (const frag of token.fragments) {
           for (const run of frag.shaped.runs) {
-            entries.push({
+            const entry = {
               run,
               span: frag.span,
               level: run.level,
               start: frag.start + run.start,
               end: frag.start + run.end
-            });
+            };
+            if (kern) {
+              entry.kern = kern;
+              kern = 0;
+            }
+            entries.push(entry);
           }
         }
       }
@@ -234,6 +248,7 @@ export class TextLayout {
       const runs = [];
       let x = 0;
       for (const e of entries) {
+        if (e.kern) x += e.kern;
         const positioned = { x, width: e.run.width, run: e.run, span: e.span, start: e.start, end: e.end };
         if (e.ellipsis) positioned.ellipsis = true;
         runs.push(positioned);
@@ -396,10 +411,48 @@ export class TextLayout {
         tokens.push(this._makeToken(text, prev, text.length, levels, spanAt, false));
       }
     }
+    for (let i = 1; i < tokens.length; i++) {
+      const kern = this._kernBefore(text, tokens[i - 1], tokens[i], levels);
+      if (kern) tokens[i].kernBefore = kern;
+    }
 
     return { spans, text, baseLevel, tokens };
   }
 
+  /**
+   * The kerning between the last letter of one token and the first of the
+   * next, where the two are on one line. Each token is shaped apart, so a
+   * pair either side of a break opportunity was never kerned — Trebuchet MS
+   * sets a space closer to an A, a T or a Y — and a line of it came out
+   * wider than a browser's, which shapes a line whole: shaping breaks only
+   * at an inline box's margin, border or padding (CSS Text 3, 7.3). Only
+   * between letters shaped alike at one left-to-right level; a line that
+   * breaks there never meets it.
+   */
+  _kernBefore(text, prev, next, levels) {
+    if (prev.required) return 0;
+    const a = prev.fragments[prev.fragments.length - 1];
+    const b = next.fragments[0];
+    if (!a || !b || a.shaping !== b.shaping || a.span.shapeApart || b.span.shapeApart) return 0;
+    const at = a.start + a.text.length;
+    if (at !== b.start) return 0;
+    // two glyphs the face's tables cannot move against each other are set
+    // together as apart, and asked about no further: most faces kern no
+    // space, and a paragraph meets one at every word
+    const l = a.shaped.runs[a.shaped.runs.length - 1];
+    const r = b.shaped.runs[0];
+    if (!l || !r || l.font !== r.font) return 0;
+    const lg = l.glyphs[l.glyphs.length - 1];
+    const rg = r.glyphs[0];
+    if (!lg || !rg || (l.font.mayKern && !l.font.mayKern(lg.id, rg.id))) return 0;
+    const low = text.charCodeAt(at - 1);
+    const before = low >= 0xdc00 && low < 0xe000 && at >= 2 ? 2 : 1;
+    const after = text.codePointAt(at) > 0xffff ? 2 : 1;
+    const key = normalizedLevels(levels, at - before, at + after);
+    if (key.includes(',') || Number(key) & 1) return 0;
+    return this.fonts._kernAcross(text.slice(at - before, at + after), before, a.shaping, key);
+  }
+
   /**
    * Whether the letters that meet at an edge between two spans of a group
    * shape otherwise together than apart: their glyphs or their advances
@@ -537,9 +590,10 @@ export class TextLayout {
     for (const token of toks) {
       // trailing whitespace does not count against the budget, exactly as it
       // does not count during the greedy fill
-      if (used + token.width - token.wsWidth <= budget) {
+      const kern = kept.length ? kernBefore(token) : 0;
+      if (used + kern + token.width - token.wsWidth <= budget) {
         kept.push(token);
-        used += token.width;
+        used += kern + token.width;
         continue;
       }
       const [head] = this._forceBreak(token, budget - used);

package/lib/text/marks.js

@@ -102,7 +102,7 @@ export function marksCover(bits, id) {
  * base)` reads the 16-bit offset stored at `pos` and answers where it
  * points, `base` being what the format measures it from.
  */
-function table(fk, tag) {
+export function table(fk, tag) {
   const entry = fk.directory?.tables?.[tag];
   if (!entry) return null;
   const stream = fk._getTableStream(tag);
@@ -163,7 +163,7 @@ function coverLookup(t, lookupList, index, bits) {
  * Where the coverage a subtable is entered from starts, or -1 for a
  * subtable this does not know.
  */
-function firstCoverage(t, type, sub) {
+export function firstCoverage(t, type, sub) {
   const format = t.u16(sub);
   switch (type) {
     case 1: // single adjustment
@@ -191,7 +191,7 @@ function firstCoverage(t, type, sub) {
   }
 }
 
-function addCoverage(t, coverage, bits) {
+export function addCoverage(t, coverage, bits) {
   const format = t.u16(coverage);
   const count = t.u16(coverage + 2);
   if (format === 1) {

package/lib/text/pairs.js

@@ -0,0 +1,88 @@
+// The glyphs a face can set closer or further from the glyph beside them,
+// read from its tables' bytes the way ./marks.js reads its marks: a pair of
+// letters that neither can be is set together as it is set apart, and the
+// layout need not shape the two to find that out (`TextLayout._kernBefore`).
+//
+// A pair's left glyph can be moved by a pair adjustment it enters, by a
+// cursive attachment, by a context it is the first input of, or by the
+// pairs of a legacy `kern` table; its right glyph only by a context it is
+// the first input of, with the left glyph behind it. Every GPOS lookup is
+// read, whatever feature names it — a superset of what fontkit applies,
+// which only widens what counts.
+//
+// Null — ask the shaper — for a face shaped through AAT's morx, a `kern`
+// table in a format this does not read, or tables it cannot read to the end.
+
+import { addCoverage, firstCoverage, table } from './marks.js';
+
+/**
+ * @param {object} fk a fontkit font
+ * @returns {{ left: Uint8Array, right: Uint8Array }|null} a bit per glyph id,
+ *   set for every glyph that can be moved against the glyph after it
+ *   (`left`) or before it (`right`); null where this cannot tell
+ */
+export function pairGlyphs(fk) {
+  try {
+    if (fk.directory?.tables?.morx) return null;
+    const left = new Uint8Array(8192);
+    const right = new Uint8Array(8192);
+    const gpos = table(fk, 'GPOS');
+    if (gpos) {
+      const lookupList = gpos.offset(8, 0);
+      for (let index = 0, n = gpos.u16(lookupList); index < n; index++) {
+        if (!coverPairs(gpos, lookupList, index, left, right)) return null;
+      }
+    }
+    const kern = table(fk, 'kern');
+    if (kern && !kernLefts(kern, left)) return null;
+    return { left, right };
+  } catch {
+    return null;
+  }
+}
+
+/** Whether `bits` (from `pairGlyphs`) has glyph `id`. */
+export function pairsCover(bits, id) {
+  return (bits[id >> 3] & (1 << (id & 7))) !== 0;
+}
+
+/** Adds what a lookup can move against a neighbour; false for one it cannot read. */
+function coverPairs(t, lookupList, index, left, right) {
+  const lookup = t.offset(lookupList + 2 + index * 2, lookupList);
+  const type = t.u16(lookup);
+  for (let i = 0, n = t.u16(lookup + 4); i < n; i++) {
+    let sub = t.offset(lookup + 6 + i * 2, lookup);
+    let subType = type;
+    if (subType === 9) {
+      if (t.u16(sub) !== 1) return false;
+      subType = t.u16(sub + 2);
+      sub += t.u32(sub + 4);
+    }
+    // a single adjustment moves a glyph whatever is beside it, and a mark
+    // attaches with no advance of its own
+    if (subType !== 2 && subType !== 3 && subType !== 7 && subType !== 8) continue;
+    const coverage = firstCoverage(t, subType, sub);
+    if (coverage < 0) return false;
+    addCoverage(t, coverage, left);
+    if (subType === 7 || subType === 8) addCoverage(t, coverage, right);
+  }
+  return true;
+}
+
+/** Adds the left glyphs of a Microsoft `kern` table's pairs; false for a
+ *  table or subtable format this does not read. */
+function kernLefts(t, left) {
+  if (t.u16(0) !== 0) return false;
+  let at = 4;
+  for (let i = 0, n = t.u16(2); i < n; i++) {
+    const length = t.u16(at + 2);
+    const format = t.u16(at + 4) >> 8;
+    if (format !== 0) return false;
+    for (let j = 0, pairs = t.u16(at + 6); j < pairs; j++) {
+      const id = t.u16(at + 14 + j * 6);
+      left[id >> 3] |= 1 << (id & 7);
+    }
+    at += length;
+  }
+  return true;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ntk",
-  "version": "8.14.5",
+  "version": "8.14.6",
   "description": "Desktop UI toolkit for X11 with canvas-like 2d and OpenGL rendering",
   "author": "Andrey Sidorov <sidorares@yandex.ru>",
   "license": "MIT",