fonttools 4.56.0__cp39-cp39-win32.whl → 4.58.0__cp39-cp39-win32.whl

fontTools/varLib/__init__.py

@@ -12,13 +12,13 @@ a Glyphs source, eg., using noto-source as an example:
 
     .. code-block:: sh
 
-	$ fontmake -o ttf-interpolatable -g NotoSansArabic-MM.glyphs
+        $ fontmake -o ttf-interpolatable -g NotoSansArabic-MM.glyphs
 
 Then you can make a variable-font this way:
 
     .. code-block:: sh
 
-	$ fonttools varLib master_ufo/NotoSansArabic.designspace
+        $ fonttools varLib master_ufo/NotoSansArabic.designspace
 
 API *will* change in near future.
 """
@@ -479,7 +479,15 @@ def _merge_TTHinting(font, masterModel, master_ttfs):
 
 _MetricsFields = namedtuple(
     "_MetricsFields",
-    ["tableTag", "metricsTag", "sb1", "sb2", "advMapping", "vOrigMapping"],
+    [
+        "tableTag",
+        "metricsTag",
+        "sb1",
+        "sb2",
+        "advMapping",
+        "vOrigMapping",
+        "phantomIndex",
+    ],
 )
 
 HVAR_FIELDS = _MetricsFields(
@@ -489,6 +497,7 @@ HVAR_FIELDS = _MetricsFields(
     sb2="RsbMap",
     advMapping="AdvWidthMap",
     vOrigMapping=None,
+    phantomIndex=0,
 )
 
 VVAR_FIELDS = _MetricsFields(
@@ -498,109 +507,43 @@ VVAR_FIELDS = _MetricsFields(
     sb2="BsbMap",
     advMapping="AdvHeightMap",
     vOrigMapping="VOrgMap",
+    phantomIndex=1,
 )
 
 
 def _add_HVAR(font, masterModel, master_ttfs, axisTags):
-    _add_VHVAR(font, masterModel, master_ttfs, axisTags, HVAR_FIELDS)
+    getAdvanceMetrics = partial(
+        _get_advance_metrics, font, masterModel, master_ttfs, axisTags, HVAR_FIELDS
+    )
+    _add_VHVAR(font, axisTags, HVAR_FIELDS, getAdvanceMetrics)
 
 
 def _add_VVAR(font, masterModel, master_ttfs, axisTags):
-    _add_VHVAR(font, masterModel, master_ttfs, axisTags, VVAR_FIELDS)
+    getAdvanceMetrics = partial(
+        _get_advance_metrics, font, masterModel, master_ttfs, axisTags, VVAR_FIELDS
+    )
+    _add_VHVAR(font, axisTags, VVAR_FIELDS, getAdvanceMetrics)
 
 
-def _add_VHVAR(font, masterModel, master_ttfs, axisTags, tableFields):
+def _add_VHVAR(font, axisTags, tableFields, getAdvanceMetrics):
     tableTag = tableFields.tableTag
     assert tableTag not in font
+    glyphOrder = font.getGlyphOrder()
     log.info("Generating " + tableTag)
     VHVAR = newTable(tableTag)
     tableClass = getattr(ot, tableTag)
     vhvar = VHVAR.table = tableClass()
     vhvar.Version = 0x00010000
 
-    glyphOrder = font.getGlyphOrder()
-
-    # Build list of source font advance widths for each glyph
-    metricsTag = tableFields.metricsTag
-    advMetricses = [m[metricsTag].metrics for m in master_ttfs]
-
-    # Build list of source font vertical origin coords for each glyph
-    if tableTag == "VVAR" and "VORG" in master_ttfs[0]:
-        vOrigMetricses = [m["VORG"].VOriginRecords for m in master_ttfs]
-        defaultYOrigs = [m["VORG"].defaultVertOriginY for m in master_ttfs]
-        vOrigMetricses = list(zip(vOrigMetricses, defaultYOrigs))
-    else:
-        vOrigMetricses = None
-
-    metricsStore, advanceMapping, vOrigMapping = _get_advance_metrics(
-        font,
-        masterModel,
-        master_ttfs,
-        axisTags,
-        glyphOrder,
-        advMetricses,
-        vOrigMetricses,
-    )
+    vhAdvanceDeltasAndSupports, vOrigDeltasAndSupports = getAdvanceMetrics()
 
-    vhvar.VarStore = metricsStore
-    if advanceMapping is None:
-        setattr(vhvar, tableFields.advMapping, None)
+    if vOrigDeltasAndSupports:
+        singleModel = False
     else:
-        setattr(vhvar, tableFields.advMapping, advanceMapping)
-    if vOrigMapping is not None:
-        setattr(vhvar, tableFields.vOrigMapping, vOrigMapping)
-    setattr(vhvar, tableFields.sb1, None)
-    setattr(vhvar, tableFields.sb2, None)
-
-    font[tableTag] = VHVAR
-    return
-
-
-def _get_advance_metrics(
-    font,
-    masterModel,
-    master_ttfs,
-    axisTags,
-    glyphOrder,
-    advMetricses,
-    vOrigMetricses=None,
-):
-    vhAdvanceDeltasAndSupports = {}
-    vOrigDeltasAndSupports = {}
-    # HACK: we treat width 65535 as a sentinel value to signal that a glyph
-    # from a non-default master should not participate in computing {H,V}VAR,
-    # as if it were missing. Allows to variate other glyph-related data independently
-    # from glyph metrics
-    sparse_advance = 0xFFFF
-    for glyph in glyphOrder:
-        vhAdvances = [
-            (
-                metrics[glyph][0]
-                if glyph in metrics and metrics[glyph][0] != sparse_advance
-                else None
-            )
-            for metrics in advMetricses
-        ]
-        vhAdvanceDeltasAndSupports[glyph] = masterModel.getDeltasAndSupports(
-            vhAdvances, round=round
+        singleModel = models.allEqual(
+            id(v[1]) for v in vhAdvanceDeltasAndSupports.values()
         )
 
-    singleModel = models.allEqual(id(v[1]) for v in vhAdvanceDeltasAndSupports.values())
-
-    if vOrigMetricses:
-        singleModel = False
-        for glyph in glyphOrder:
-            # We need to supply a vOrigs tuple with non-None default values
-            # for each glyph. vOrigMetricses contains values only for those
-            # glyphs which have a non-default vOrig.
-            vOrigs = [
-                metrics[glyph] if glyph in metrics else defaultVOrig
-                for metrics, defaultVOrig in vOrigMetricses
-            ]
-            vOrigDeltasAndSupports[glyph] = masterModel.getDeltasAndSupports(
-                vOrigs, round=round
-            )
-
     directStore = None
     if singleModel:
         # Build direct mapping
@@ -612,6 +555,8 @@ def _get_advance_metrics(
             varData.addItem(vhAdvanceDeltasAndSupports[glyphName][0], round=noRound)
         varData.optimize()
         directStore = builder.buildVarStore(varTupleList, [varData])
+        # remove unused regions from VarRegionList
+        directStore.prune_regions()
 
     # Build optimized indirect mapping
     storeBuilder = varStore.OnlineVarStoreBuilder(axisTags)
@@ -621,7 +566,7 @@ def _get_advance_metrics(
         storeBuilder.setSupports(supports)
         advMapping[glyphName] = storeBuilder.storeDeltas(deltas, round=noRound)
 
-    if vOrigMetricses:
+    if vOrigDeltasAndSupports:
         vOrigMap = {}
         for glyphName in glyphOrder:
             deltas, supports = vOrigDeltasAndSupports[glyphName]
@@ -633,7 +578,7 @@ def _get_advance_metrics(
     advMapping = [mapping2[advMapping[g]] for g in glyphOrder]
     advanceMapping = builder.buildVarIdxMap(advMapping, glyphOrder)
 
-    if vOrigMetricses:
+    if vOrigDeltasAndSupports:
         vOrigMap = [mapping2[vOrigMap[g]] for g in glyphOrder]
 
     useDirect = False
@@ -657,10 +602,70 @@ def _get_advance_metrics(
         advanceMapping = None
     else:
         metricsStore = indirectStore
-        if vOrigMetricses:
+        if vOrigDeltasAndSupports:
             vOrigMapping = builder.buildVarIdxMap(vOrigMap, glyphOrder)
 
-    return metricsStore, advanceMapping, vOrigMapping
+    vhvar.VarStore = metricsStore
+    setattr(vhvar, tableFields.advMapping, advanceMapping)
+    if vOrigMapping is not None:
+        setattr(vhvar, tableFields.vOrigMapping, vOrigMapping)
+    setattr(vhvar, tableFields.sb1, None)
+    setattr(vhvar, tableFields.sb2, None)
+
+    font[tableTag] = VHVAR
+    return
+
+
+def _get_advance_metrics(font, masterModel, master_ttfs, axisTags, tableFields):
+    tableTag = tableFields.tableTag
+    glyphOrder = font.getGlyphOrder()
+
+    # Build list of source font advance widths for each glyph
+    metricsTag = tableFields.metricsTag
+    advMetricses = [m[metricsTag].metrics for m in master_ttfs]
+
+    # Build list of source font vertical origin coords for each glyph
+    if tableTag == "VVAR" and "VORG" in master_ttfs[0]:
+        vOrigMetricses = [m["VORG"].VOriginRecords for m in master_ttfs]
+        defaultYOrigs = [m["VORG"].defaultVertOriginY for m in master_ttfs]
+        vOrigMetricses = list(zip(vOrigMetricses, defaultYOrigs))
+    else:
+        vOrigMetricses = None
+
+    vhAdvanceDeltasAndSupports = {}
+    vOrigDeltasAndSupports = {}
+    # HACK: we treat width 65535 as a sentinel value to signal that a glyph
+    # from a non-default master should not participate in computing {H,V}VAR,
+    # as if it were missing. Allows to variate other glyph-related data independently
+    # from glyph metrics
+    sparse_advance = 0xFFFF
+    for glyph in glyphOrder:
+        vhAdvances = [
+            (
+                metrics[glyph][0]
+                if glyph in metrics and metrics[glyph][0] != sparse_advance
+                else None
+            )
+            for metrics in advMetricses
+        ]
+        vhAdvanceDeltasAndSupports[glyph] = masterModel.getDeltasAndSupports(
+            vhAdvances, round=round
+        )
+
+    if vOrigMetricses:
+        for glyph in glyphOrder:
+            # We need to supply a vOrigs tuple with non-None default values
+            # for each glyph. vOrigMetricses contains values only for those
+            # glyphs which have a non-default vOrig.
+            vOrigs = [
+                metrics[glyph] if glyph in metrics else defaultVOrig
+                for metrics, defaultVOrig in vOrigMetricses
+            ]
+            vOrigDeltasAndSupports[glyph] = masterModel.getDeltasAndSupports(
+                vOrigs, round=round
+            )
+
+    return vhAdvanceDeltasAndSupports, vOrigDeltasAndSupports
 
 
 def _add_MVAR(font, masterModel, master_ttfs, axisTags):

fontTools/varLib/hvar.py

@@ -0,0 +1,113 @@
+from fontTools.misc.roundTools import noRound
+from fontTools.ttLib import TTFont, newTable
+from fontTools.ttLib.tables import otTables as ot
+from fontTools.ttLib.tables.otBase import OTTableWriter
+from fontTools.varLib import HVAR_FIELDS, VVAR_FIELDS, _add_VHVAR
+from fontTools.varLib import builder, models, varStore
+from fontTools.misc.fixedTools import fixedToFloat as fi2fl
+from fontTools.misc.cliTools import makeOutputFileName
+from functools import partial
+import logging
+
+log = logging.getLogger("fontTools.varLib.avar")
+
+
+def _get_advance_metrics(font, axisTags, tableFields):
+    # There's two ways we can go from here:
+    # 1. For each glyph, at each master peak, compute the value of the
+    #    advance width at that peak.  Then pass these all to a VariationModel
+    #    builder to compute back the deltas.
+    # 2. For each master peak, pull out the deltas of the advance width directly,
+    #    and feed these to the VarStoreBuilder, forgoing the remoding step.
+    # We'll go with the second option, as it's simpler, faster, and more direct.
+    gvar = font["gvar"]
+    vhAdvanceDeltasAndSupports = {}
+    glyphOrder = font.getGlyphOrder()
+    phantomIndex = tableFields.phantomIndex
+    for glyphName in glyphOrder:
+        supports = []
+        deltas = []
+        variations = gvar.variations.get(glyphName, [])
+
+        for tv in variations:
+            supports.append(tv.axes)
+            phantoms = tv.coordinates[-4:]
+            phantoms = phantoms[phantomIndex * 2 : phantomIndex * 2 + 2]
+            assert len(phantoms) == 2
+            phantoms[0] = phantoms[0][phantomIndex] if phantoms[0] is not None else 0
+            phantoms[1] = phantoms[1][phantomIndex] if phantoms[1] is not None else 0
+            deltas.append(phantoms[1] - phantoms[0])
+
+        vhAdvanceDeltasAndSupports[glyphName] = (deltas, supports)
+
+    vOrigDeltasAndSupports = None  # TODO
+
+    return vhAdvanceDeltasAndSupports, vOrigDeltasAndSupports
+
+
+def add_HVAR(font):
+    if "HVAR" in font:
+        del font["HVAR"]
+    axisTags = [axis.axisTag for axis in font["fvar"].axes]
+    getAdvanceMetrics = partial(_get_advance_metrics, font, axisTags, HVAR_FIELDS)
+    _add_VHVAR(font, axisTags, HVAR_FIELDS, getAdvanceMetrics)
+
+
+def add_VVAR(font):
+    if "VVAR" in font:
+        del font["VVAR"]
+    getAdvanceMetrics = partial(_get_advance_metrics, font, axisTags, HVAR_FIELDS)
+    axisTags = [axis.axisTag for axis in font["fvar"].axes]
+    _add_VHVAR(font, axisTags, VVAR_FIELDS, getAdvanceMetrics)
+
+
+def main(args=None):
+    """Add `HVAR` table to variable font."""
+
+    if args is None:
+        import sys
+
+        args = sys.argv[1:]
+
+    from fontTools import configLogger
+    from fontTools.designspaceLib import DesignSpaceDocument
+    import argparse
+
+    parser = argparse.ArgumentParser(
+        "fonttools varLib.hvar",
+        description="Add `HVAR` table from to variable font.",
+    )
+    parser.add_argument("font", metavar="varfont.ttf", help="Variable-font file.")
+    parser.add_argument(
+        "-o",
+        "--output-file",
+        type=str,
+        help="Output font file name.",
+    )
+
+    options = parser.parse_args(args)
+
+    configLogger(level="WARNING")
+
+    font = TTFont(options.font)
+    if not "fvar" in font:
+        log.error("Not a variable font.")
+        return 1
+
+    add_HVAR(font)
+    if "vmtx" in font:
+        add_VVAR(font)
+
+    if options.output_file is None:
+        outfile = makeOutputFileName(options.font, overWrite=True, suffix=".hvar")
+    else:
+        outfile = options.output_file
+    if outfile:
+        log.info("Saving %s", outfile)
+        font.save(outfile)
+
+
+if __name__ == "__main__":
+    import sys
+
+    sys.exit(main())

fontTools/varLib/varStore.py

@@ -41,7 +41,7 @@ class OnlineVarStoreBuilder(object):
     def setSupports(self, supports):
         self._model = None
         self._supports = list(supports)
-        if not self._supports[0]:
+        if self._supports and not self._supports[0]:
             del self._supports[0]  # Drop base master support
         self._cache = None
         self._data = None

fontTools/voltLib/__main__.py

@@ -0,0 +1,206 @@
+import argparse
+import logging
+import sys
+from io import StringIO
+from pathlib import Path
+
+from fontTools import configLogger
+from fontTools.feaLib.builder import addOpenTypeFeaturesFromString
+from fontTools.feaLib.error import FeatureLibError
+from fontTools.feaLib.lexer import Lexer
+from fontTools.misc.cliTools import makeOutputFileName
+from fontTools.ttLib import TTFont, TTLibError
+from fontTools.voltLib.parser import Parser
+from fontTools.voltLib.voltToFea import TABLES, VoltToFea
+
+log = logging.getLogger("fontTools.feaLib")
+
+SUPPORTED_TABLES = TABLES + ["cmap"]
+
+
+def invalid_fea_glyph_name(name):
+    """Check if the glyph name is valid according to FEA syntax."""
+    if name[0] not in Lexer.CHAR_NAME_START_:
+        return True
+    if any(c not in Lexer.CHAR_NAME_CONTINUATION_ for c in name[1:]):
+        return True
+    return False
+
+
+def sanitize_glyph_name(name):
+    """Sanitize the glyph name to ensure it is valid according to FEA syntax."""
+    sanitized = ""
+    for i, c in enumerate(name):
+        if i == 0 and c not in Lexer.CHAR_NAME_START_:
+            sanitized += "a" + c
+        elif c not in Lexer.CHAR_NAME_CONTINUATION_:
+            sanitized += "_"
+        else:
+            sanitized += c
+
+    return sanitized
+
+
+def main(args=None):
+    """Build tables from a MS VOLT project into an OTF font"""
+    parser = argparse.ArgumentParser(
+        description="Use fontTools to compile MS VOLT projects."
+    )
+    parser.add_argument(
+        "input",
+        metavar="INPUT",
+        help="Path to the input font/VTP file to process",
+        type=Path,
+    )
+    parser.add_argument(
+        "-f",
+        "--font",
+        metavar="INPUT_FONT",
+        help="Path to the input font (if INPUT is a VTP file)",
+        type=Path,
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        dest="output",
+        metavar="OUTPUT",
+        help="Path to the output font.",
+        type=Path,
+    )
+    parser.add_argument(
+        "-t",
+        "--tables",
+        metavar="TABLE_TAG",
+        choices=SUPPORTED_TABLES,
+        nargs="+",
+        help="Specify the table(s) to be built.",
+    )
+    parser.add_argument(
+        "-F",
+        "--debug-feature-file",
+        help="Write the generated feature file to disk.",
+        action="store_true",
+    )
+    parser.add_argument(
+        "--ship",
+        help="Remove source VOLT tables from output font.",
+        action="store_true",
+    )
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        help="Increase the logger verbosity. Multiple -v options are allowed.",
+        action="count",
+        default=0,
+    )
+    parser.add_argument(
+        "-T",
+        "--traceback",
+        help="show traceback for exceptions.",
+        action="store_true",
+    )
+    options = parser.parse_args(args)
+
+    levels = ["WARNING", "INFO", "DEBUG"]
+    configLogger(level=levels[min(len(levels) - 1, options.verbose)])
+
+    output_font = options.output or Path(
+        makeOutputFileName(options.font or options.input)
+    )
+    log.info(f"Compiling MS VOLT to '{output_font}'")
+
+    file_or_path = options.input
+    font = None
+
+    # If the input is a font file, extract the VOLT data from the "TSIV" table
+    try:
+        font = TTFont(file_or_path)
+        if "TSIV" in font:
+            file_or_path = StringIO(font["TSIV"].data.decode("utf-8"))
+        else:
+            log.error('"TSIV" table is missing')
+            return 1
+    except TTLibError:
+        pass
+
+    # If input is not a font file, the font must be provided
+    if font is None:
+        if not options.font:
+            log.error("Please provide an input font")
+            return 1
+        font = TTFont(options.font)
+
+    # FEA syntax does not allow some glyph names that VOLT accepts, so if we
+    # found such glyph name we will temporarily rename such glyphs.
+    glyphOrder = font.getGlyphOrder()
+    tempGlyphOrder = None
+    if any(invalid_fea_glyph_name(n) for n in glyphOrder):
+        tempGlyphOrder = []
+        for n in glyphOrder:
+            if invalid_fea_glyph_name(n):
+                n = sanitize_glyph_name(n)
+                existing = set(tempGlyphOrder) | set(glyphOrder)
+                while n in existing:
+                    n = "a" + n
+            tempGlyphOrder.append(n)
+        font.setGlyphOrder(tempGlyphOrder)
+
+    doc = Parser(file_or_path).parse()
+
+    log.info("Converting VTP data to FEA")
+    converter = VoltToFea(doc, font)
+    try:
+        fea = converter.convert(options.tables, ignore_unsupported_settings=True)
+    except NotImplementedError as e:
+        if options.traceback:
+            raise
+        location = getattr(e.args[0], "location", None)
+        message = f'"{e}" is not supported'
+        if location:
+            path, line, column = location
+            log.error(f"{path}:{line}:{column}: {message}")
+        else:
+            log.error(message)
+        return 1
+
+    fea_filename = options.input
+    if options.debug_feature_file:
+        fea_filename = output_font.with_suffix(".fea")
+        log.info(f"Writing FEA to '{fea_filename}'")
+        with open(fea_filename, "w") as fp:
+            fp.write(fea)
+
+    log.info("Compiling FEA to OpenType tables")
+    try:
+        addOpenTypeFeaturesFromString(
+            font,
+            fea,
+            filename=fea_filename,
+            tables=options.tables,
+        )
+    except FeatureLibError as e:
+        if options.traceback:
+            raise
+        log.error(e)
+        return 1
+
+    if options.ship:
+        for tag in ["TSIV", "TSIS", "TSIP", "TSID"]:
+            if tag in font:
+                del font[tag]
+
+    # Restore original glyph names.
+    if tempGlyphOrder:
+        import io
+
+        f = io.BytesIO()
+        font.save(f)
+        font = TTFont(f)
+        font.setGlyphOrder(glyphOrder)
+        font["post"].extraNames = []
+
+    font.save(output_font)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

fontTools/voltLib/ast.py

@@ -317,6 +317,10 @@ class SubstitutionLigatureDefinition(SubstitutionDefinition):
     pass
 
 
+class SubstitutionAlternateDefinition(SubstitutionDefinition):
+    pass
+
+
 class SubstitutionReverseChainingSingleDefinition(SubstitutionDefinition):
     pass
 

fontTools/voltLib/parser.py

@@ -313,19 +313,27 @@ class Parser(object):
         self.expect_keyword_("END_SUBSTITUTION")
         max_src = max([len(cov) for cov in src])
         max_dest = max([len(cov) for cov in dest])
+
         # many to many or mixed is invalid
-        if (max_src > 1 and max_dest > 1) or (
-            reversal and (max_src > 1 or max_dest > 1)
-        ):
+        if max_src > 1 and max_dest > 1:
             raise VoltLibError("Invalid substitution type", location)
+
         mapping = dict(zip(tuple(src), tuple(dest)))
         if max_src == 1 and max_dest == 1:
-            if reversal:
-                sub = ast.SubstitutionReverseChainingSingleDefinition(
-                    mapping, location=location
-                )
+            # Alternate substitutions are represented by adding multiple
+            # substitutions for the same glyph, so we detect that here
+            glyphs = [x.glyphSet() for cov in src for x in cov]  # flatten src
+            if len(set(glyphs)) != len(glyphs):  # src has duplicates
+                sub = ast.SubstitutionAlternateDefinition(mapping, location=location)
             else:
-                sub = ast.SubstitutionSingleDefinition(mapping, location=location)
+                if reversal:
+                    # Reversal is valid only for single glyph substitutions
+                    # and VOLT ignores it otherwise.
+                    sub = ast.SubstitutionReverseChainingSingleDefinition(
+                        mapping, location=location
+                    )
+                else:
+                    sub = ast.SubstitutionSingleDefinition(mapping, location=location)
         elif max_src == 1 and max_dest > 1:
             sub = ast.SubstitutionMultipleDefinition(mapping, location=location)
         elif max_src > 1 and max_dest == 1: