@cantoo/fontkit 2.0.4

package/src/layout/UnicodeLayoutEngine.js

@@ -0,0 +1,250 @@
+import {getCombiningClass} from '../packages/unicode-properties/index.js';
+
+/**
+ * This class is used when GPOS does not define 'mark' or 'mkmk' features
+ * for positioning marks relative to base glyphs. It uses the unicode
+ * combining class property to position marks.
+ *
+ * Based on code from Harfbuzz, thanks!
+ * https://github.com/behdad/harfbuzz/blob/master/src/hb-ot-shape-fallback.cc
+ */
+export default class UnicodeLayoutEngine {
+  constructor(font) {
+    this.font = font;
+  }
+
+  positionGlyphs(glyphs, positions) {
+    // find each base + mark cluster, and position the marks relative to the base
+    let clusterStart = 0;
+    let clusterEnd = 0;
+    for (let index = 0; index < glyphs.length; index++) {
+      let glyph = glyphs[index];
+      if (glyph.isMark) { // TODO: handle ligatures
+        clusterEnd = index;
+      } else {
+        if (clusterStart !== clusterEnd) {
+          this.positionCluster(glyphs, positions, clusterStart, clusterEnd);
+        }
+
+        clusterStart = clusterEnd = index;
+      }
+    }
+
+    if (clusterStart !== clusterEnd) {
+      this.positionCluster(glyphs, positions, clusterStart, clusterEnd);
+    }
+
+    return positions;
+  }
+
+  positionCluster(glyphs, positions, clusterStart, clusterEnd) {
+    let base = glyphs[clusterStart];
+    let baseBox = base.cbox.copy();
+
+    // adjust bounding box for ligature glyphs
+    if (base.codePoints.length > 1) {
+      // LTR. TODO: RTL support.
+      baseBox.minX += ((base.codePoints.length - 1) * baseBox.width) / base.codePoints.length;
+    }
+
+    let xOffset = -positions[clusterStart].xAdvance;
+    let yOffset = 0;
+    let yGap = this.font.unitsPerEm / 16;
+
+    // position each of the mark glyphs relative to the base glyph
+    for (let index = clusterStart + 1; index <= clusterEnd; index++) {
+      let mark = glyphs[index];
+      let markBox = mark.cbox;
+      let position = positions[index];
+
+      let combiningClass = this.getCombiningClass(mark.codePoints[0]);
+
+      if (combiningClass !== 'Not_Reordered') {
+        position.xOffset = position.yOffset = 0;
+
+        // x positioning
+        switch (combiningClass) {
+          case 'Double_Above':
+          case 'Double_Below':
+            // LTR. TODO: RTL support.
+            position.xOffset += baseBox.minX - markBox.width / 2 - markBox.minX;
+            break;
+
+          case 'Attached_Below_Left':
+          case 'Below_Left':
+          case 'Above_Left':
+            // left align
+            position.xOffset += baseBox.minX - markBox.minX;
+            break;
+
+          case 'Attached_Above_Right':
+          case 'Below_Right':
+          case 'Above_Right':
+            // right align
+            position.xOffset += baseBox.maxX - markBox.width - markBox.minX;
+            break;
+
+          default: // Attached_Below, Attached_Above, Below, Above, other
+            // center align
+            position.xOffset += baseBox.minX + (baseBox.width - markBox.width) / 2 - markBox.minX;
+        }
+
+        // y positioning
+        switch (combiningClass) {
+          case 'Double_Below':
+          case 'Below_Left':
+          case 'Below':
+          case 'Below_Right':
+          case 'Attached_Below_Left':
+          case 'Attached_Below':
+            // add a small gap between the glyphs if they are not attached
+            if (combiningClass === 'Attached_Below_Left' || combiningClass === 'Attached_Below') {
+              baseBox.minY += yGap;
+            }
+
+            position.yOffset = -baseBox.minY - markBox.maxY;
+            baseBox.minY += markBox.height;
+            break;
+
+          case 'Double_Above':
+          case 'Above_Left':
+          case 'Above':
+          case 'Above_Right':
+          case 'Attached_Above':
+          case 'Attached_Above_Right':
+            // add a small gap between the glyphs if they are not attached
+            if (combiningClass === 'Attached_Above' || combiningClass === 'Attached_Above_Right') {
+              baseBox.maxY += yGap;
+            }
+
+            position.yOffset = baseBox.maxY - markBox.minY;
+            baseBox.maxY += markBox.height;
+            break;
+        }
+
+        position.xAdvance = position.yAdvance = 0;
+        position.xOffset += xOffset;
+        position.yOffset += yOffset;
+
+      } else {
+        xOffset -= position.xAdvance;
+        yOffset -= position.yAdvance;
+      }
+    }
+
+    return;
+  }
+
+  getCombiningClass(codePoint) {
+    let combiningClass = getCombiningClass(codePoint);
+
+    // Thai / Lao need some per-character work
+    if ((codePoint & ~0xff) === 0x0e00) {
+      if (combiningClass === 'Not_Reordered') {
+        switch (codePoint) {
+          case 0x0e31:
+          case 0x0e34:
+          case 0x0e35:
+          case 0x0e36:
+          case 0x0e37:
+          case 0x0e47:
+          case 0x0e4c:
+          case 0x0e4d:
+          case 0x0e4e:
+            return 'Above_Right';
+
+          case 0x0eb1:
+          case 0x0eb4:
+          case 0x0eb5:
+          case 0x0eb6:
+          case 0x0eb7:
+          case 0x0ebb:
+          case 0x0ecc:
+          case 0x0ecd:
+            return 'Above';
+
+          case 0x0ebc:
+            return 'Below';
+        }
+      } else if (codePoint === 0x0e3a) { // virama
+        return 'Below_Right';
+      }
+    }
+
+    switch (combiningClass) {
+      // Hebrew
+
+      case 'CCC10': // sheva
+      case 'CCC11': // hataf segol
+      case 'CCC12': // hataf patah
+      case 'CCC13': // hataf qamats
+      case 'CCC14': // hiriq
+      case 'CCC15': // tsere
+      case 'CCC16': // segol
+      case 'CCC17': // patah
+      case 'CCC18': // qamats
+      case 'CCC20': // qubuts
+      case 'CCC22': // meteg
+        return 'Below';
+
+      case 'CCC23': // rafe
+        return 'Attached_Above';
+
+      case 'CCC24': // shin dot
+        return 'Above_Right';
+
+      case 'CCC25': // sin dot
+      case 'CCC19': // holam
+        return 'Above_Left';
+
+      case 'CCC26': // point varika
+        return 'Above';
+
+      case 'CCC21': // dagesh
+        break;
+
+      // Arabic and Syriac
+
+      case 'CCC27': // fathatan
+      case 'CCC28': // dammatan
+      case 'CCC30': // fatha
+      case 'CCC31': // damma
+      case 'CCC33': // shadda
+      case 'CCC34': // sukun
+      case 'CCC35': // superscript alef
+      case 'CCC36': // superscript alaph
+        return 'Above';
+
+      case 'CCC29': // kasratan
+      case 'CCC32': // kasra
+        return 'Below';
+
+      // Thai
+
+      case 'CCC103': // sara u / sara uu
+        return 'Below_Right';
+
+      case 'CCC107': // mai
+        return 'Above_Right';
+
+      // Lao
+
+      case 'CCC118': // sign u / sign uu
+        return 'Below';
+
+      case 'CCC122': // mai
+        return 'Above';
+
+      // Tibetan
+
+      case 'CCC129': // sign aa
+      case 'CCC132': // sign u
+        return 'Below';
+
+      case 'CCC130': // sign i
+        return 'Above';
+    }
+
+    return combiningClass;
+  }
+}

package/src/node.js

@@ -0,0 +1,16 @@
+import { registerFormat } from './base';
+import TTFFont from './TTFFont';
+import WOFFFont from './WOFFFont';
+import WOFF2Font from './WOFF2Font';
+import TrueTypeCollection from './TrueTypeCollection';
+import DFont from './DFont';
+
+// Register font formats
+registerFormat(TTFFont);
+registerFormat(WOFFFont);
+registerFormat(WOFF2Font);
+registerFormat(TrueTypeCollection);
+registerFormat(DFont);
+
+export * from './base';
+export * from './fs';

package/src/opentype/GPOSProcessor.js

@@ -0,0 +1,311 @@
+import OTProcessor from './OTProcessor';
+
+export default class GPOSProcessor extends OTProcessor {
+  applyPositionValue(sequenceIndex, value) {
+    let position = this.positions[this.glyphIterator.peekIndex(sequenceIndex)];
+    if (value.xAdvance != null) position.xAdvance += value.xAdvance;
+    if (value.yAdvance != null) position.yAdvance += value.yAdvance;
+    if (value.xPlacement != null) position.xOffset += value.xPlacement;
+    if (value.yPlacement != null) position.yOffset += value.yPlacement;
+
+    // Adjustments for font variations
+    let variationProcessor = this.font._variationProcessor;
+    let variationStore = this.font.GDEF && this.font.GDEF.itemVariationStore;
+    if (variationProcessor && variationStore) {
+      if (value.xPlaDevice) {
+        position.xOffset += variationProcessor.getDelta(variationStore, value.xPlaDevice.a, value.xPlaDevice.b);
+      }
+
+      if (value.yPlaDevice) {
+        position.yOffset += variationProcessor.getDelta(variationStore, value.yPlaDevice.a, value.yPlaDevice.b);
+      }
+
+      if (value.xAdvDevice) {
+        position.xAdvance += variationProcessor.getDelta(variationStore, value.xAdvDevice.a, value.xAdvDevice.b);
+      }
+
+      if (value.yAdvDevice) {
+        position.yAdvance += variationProcessor.getDelta(variationStore, value.yAdvDevice.a, value.yAdvDevice.b);
+      }
+    }
+
+    // TODO: device tables
+  }
+
+  applyLookup(lookupType, table) {
+    switch (lookupType) {
+      case 1: { // Single positioning value
+        let index = this.coverageIndex(table.coverage);
+        if (index === -1) return false;
+
+        switch (table.version) {
+          case 1:
+            this.applyPositionValue(0, table.value);
+            break;
+
+          case 2:
+            this.applyPositionValue(0, table.values.get(index));
+            break;
+        }
+
+        return true;
+      }
+
+      case 2: { // Pair Adjustment Positioning
+        let nextGlyph = this.glyphIterator.peek();
+        if (!nextGlyph) return false;
+
+        let index = this.coverageIndex(table.coverage);
+        if (index === -1) return false;
+
+        switch (table.version) {
+          case 1: { // Adjustments for glyph pairs
+            let set = table.pairSets.get(index);
+
+            for (let pair of set) {
+              if (pair.secondGlyph === nextGlyph.id) {
+                this.applyPositionValue(0, pair.value1);
+                this.applyPositionValue(1, pair.value2);
+                return true;
+              }
+            }
+
+            return false;
+          }
+
+          case 2: { // Class pair adjustment
+            let class1 = this.getClassID(this.glyphIterator.cur.id, table.classDef1);
+            let class2 = this.getClassID(nextGlyph.id, table.classDef2);
+            if (class1 === -1 || class2 === -1) return false;
+
+            let pair = table.classRecords.get(class1).get(class2);
+            this.applyPositionValue(0, pair.value1);
+            this.applyPositionValue(1, pair.value2);
+            return true;
+          }
+        }
+
+        return false;
+      }
+
+      case 3: { // Cursive Attachment Positioning
+        let nextIndex = this.glyphIterator.peekIndex();
+        let nextGlyph = this.glyphs[nextIndex];
+        if (!nextGlyph) return false;
+
+        let curRecord = table.entryExitRecords[this.coverageIndex(table.coverage)];
+        if (!curRecord || !curRecord.exitAnchor) return false;
+
+        let nextRecord = table.entryExitRecords[this.coverageIndex(table.coverage, nextGlyph.id)];
+        if (!nextRecord || !nextRecord.entryAnchor) return false;
+
+        let entry = this.getAnchor(nextRecord.entryAnchor);
+        let exit = this.getAnchor(curRecord.exitAnchor);
+
+        let cur = this.positions[this.glyphIterator.index];
+        let next = this.positions[nextIndex];
+        let d;
+
+        switch (this.direction) {
+          case 'ltr':
+            cur.xAdvance = exit.x + cur.xOffset;
+
+            d = entry.x + next.xOffset;
+            next.xAdvance -= d;
+            next.xOffset -= d;
+            break;
+
+          case 'rtl':
+            d = exit.x + cur.xOffset;
+            cur.xAdvance -= d;
+            cur.xOffset -= d;
+            next.xAdvance = entry.x + next.xOffset;
+            break;
+        }
+
+        if (this.glyphIterator.flags.rightToLeft) {
+          this.glyphIterator.cur.cursiveAttachment = nextIndex;
+          cur.yOffset = entry.y - exit.y;
+        } else {
+          nextGlyph.cursiveAttachment = this.glyphIterator.index;
+          cur.yOffset = exit.y - entry.y;
+        }
+
+        return true;
+      }
+
+      case 4: { // Mark to base positioning
+        let markIndex = this.coverageIndex(table.markCoverage);
+        if (markIndex === -1) return false;
+
+        // search backward for a base glyph
+        let baseGlyphIndex = this.glyphIterator.index;
+        while (--baseGlyphIndex >= 0 && (this.glyphs[baseGlyphIndex].isMark || this.glyphs[baseGlyphIndex].ligatureComponent > 0));
+
+        if (baseGlyphIndex < 0) return false;
+
+        let baseIndex = this.coverageIndex(table.baseCoverage, this.glyphs[baseGlyphIndex].id);
+        if (baseIndex === -1) return false;
+
+        let markRecord = table.markArray[markIndex];
+        let baseAnchor = table.baseArray[baseIndex][markRecord.class];
+        return this.applyAnchor(markRecord, baseAnchor, baseGlyphIndex);
+      }
+
+      case 5: { // Mark to ligature positioning
+        let markIndex = this.coverageIndex(table.markCoverage);
+        if (markIndex === -1) return false;
+
+        // search backward for a base glyph
+        let baseGlyphIndex = this.glyphIterator.index;
+        while (--baseGlyphIndex >= 0 && this.glyphs[baseGlyphIndex].isMark);
+
+        if (baseGlyphIndex < 0) return false;
+
+        let ligIndex = this.coverageIndex(table.ligatureCoverage, this.glyphs[baseGlyphIndex].id);
+        if (ligIndex === -1) return false;
+
+        let ligAttach = table.ligatureArray[ligIndex];
+        let markGlyph = this.glyphIterator.cur;
+        let ligGlyph = this.glyphs[baseGlyphIndex];
+        let compIndex = ligGlyph.ligatureID && ligGlyph.ligatureID === markGlyph.ligatureID && (markGlyph.ligatureComponent > 0)
+          ? Math.min(markGlyph.ligatureComponent, ligGlyph.codePoints.length) - 1
+          : ligGlyph.codePoints.length - 1;
+
+        let markRecord = table.markArray[markIndex];
+        let baseAnchor = ligAttach[compIndex][markRecord.class];
+        return this.applyAnchor(markRecord, baseAnchor, baseGlyphIndex);
+      }
+
+      case 6: { // Mark to mark positioning
+        let mark1Index = this.coverageIndex(table.mark1Coverage);
+        if (mark1Index === -1) return false;
+
+        // get the previous mark to attach to
+        let prevIndex = this.glyphIterator.peekIndex(-1);
+        let prev = this.glyphs[prevIndex];
+        if (!prev || !prev.isMark) return false;
+
+        let cur = this.glyphIterator.cur;
+
+        // The following logic was borrowed from Harfbuzz
+        let good = false;
+        if (cur.ligatureID === prev.ligatureID) {
+          if (!cur.ligatureID) { // Marks belonging to the same base
+            good = true;
+          } else if (cur.ligatureComponent === prev.ligatureComponent) { // Marks belonging to the same ligature component
+            good = true;
+          }
+        } else {
+          // If ligature ids don't match, it may be the case that one of the marks
+          // itself is a ligature, in which case match.
+          if ((cur.ligatureID && !cur.ligatureComponent) || (prev.ligatureID && !prev.ligatureComponent)) {
+            good = true;
+          }
+        }
+
+        if (!good) return false;
+
+        let mark2Index = this.coverageIndex(table.mark2Coverage, prev.id);
+        if (mark2Index === -1) return false;
+
+        let markRecord = table.mark1Array[mark1Index];
+        let baseAnchor = table.mark2Array[mark2Index][markRecord.class];
+        return this.applyAnchor(markRecord, baseAnchor, prevIndex);
+      }
+
+      case 7: // Contextual positioning
+        return this.applyContext(table);
+
+      case 8: // Chaining contextual positioning
+        return this.applyChainingContext(table);
+
+      case 9: // Extension positioning
+        return this.applyLookup(table.lookupType, table.extension);
+
+      default:
+        throw new Error(`Unsupported GPOS table: ${lookupType}`);
+    }
+  }
+
+  applyAnchor(markRecord, baseAnchor, baseGlyphIndex) {
+    // NULL offset = no anchor for this class; false so later subtables can try (HarfBuzz).
+    if (!baseAnchor || !markRecord.markAnchor) return false;
+
+    let baseCoords = this.getAnchor(baseAnchor);
+    let markCoords = this.getAnchor(markRecord.markAnchor);
+    let markPos = this.positions[this.glyphIterator.index];
+
+    markPos.xOffset = baseCoords.x - markCoords.x;
+    markPos.yOffset = baseCoords.y - markCoords.y;
+    this.glyphIterator.cur.markAttachment = baseGlyphIndex;
+    return true;
+  }
+
+  getAnchor(anchor) {
+    // TODO: contour point, device tables
+    let x = anchor.xCoordinate;
+    let y = anchor.yCoordinate;
+
+    // Adjustments for font variations
+    let variationProcessor = this.font._variationProcessor;
+    let variationStore = this.font.GDEF && this.font.GDEF.itemVariationStore;
+    if (variationProcessor && variationStore) {
+      if (anchor.xDeviceTable) {
+        x += variationProcessor.getDelta(variationStore, anchor.xDeviceTable.a, anchor.xDeviceTable.b);
+      }
+
+      if (anchor.yDeviceTable) {
+        y += variationProcessor.getDelta(variationStore, anchor.yDeviceTable.a, anchor.yDeviceTable.b);
+      }
+    }
+
+    return { x, y };
+  }
+
+  applyFeatures(userFeatures, glyphs, advances) {
+    super.applyFeatures(userFeatures, glyphs, advances);
+
+    for (var i = 0; i < this.glyphs.length; i++) {
+      this.fixCursiveAttachment(i);
+    }
+
+    this.fixMarkAttachment();
+  }
+
+  fixCursiveAttachment(i) {
+    let glyph = this.glyphs[i];
+    if (glyph.cursiveAttachment != null) {
+      let j = glyph.cursiveAttachment;
+
+      glyph.cursiveAttachment = null;
+      this.fixCursiveAttachment(j);
+
+      this.positions[i].yOffset += this.positions[j].yOffset;
+    }
+  }
+
+  fixMarkAttachment() {
+    for (let i = 0; i < this.glyphs.length; i++) {
+      let glyph = this.glyphs[i];
+      if (glyph.markAttachment != null) {
+        let j = glyph.markAttachment;
+
+        this.positions[i].xOffset += this.positions[j].xOffset;
+        this.positions[i].yOffset += this.positions[j].yOffset;
+
+        if (this.direction === 'ltr') {
+          for (let k = j; k < i; k++) {
+            this.positions[i].xOffset -= this.positions[k].xAdvance;
+            this.positions[i].yOffset -= this.positions[k].yAdvance;
+          }
+        } else {
+          for (let k = j + 1; k < i + 1; k++) {
+            this.positions[i].xOffset += this.positions[k].xAdvance;
+            this.positions[i].yOffset += this.positions[k].yAdvance;
+          }
+        }
+      }
+    }
+  }
+}