# This code is derived from fontmake.instantiator (Apache License 2.0), which in
# turn was based on ufoProcessor code. The latter is licensed as follows.
# Copyright (c) 2017-2018 LettError and Erik van Blokland
# All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

"""Module for generating static font instances.

It is an alternative to ufoProcessor originally meant to be used internally by fontmake.
The aim is to be a minimal implementation that is focussed on using ufoLib2 for font data
abstraction, varLib for instance computation and fontMath as a font data shell for
instance computation directly and exclusively.
"""

from __future__ import annotations

import copy
import logging
import typing
from dataclasses import dataclass, field
from functools import cached_property
from typing import (
    TYPE_CHECKING,
    Any,
    Callable,
    Dict,
    List,
    Mapping,
    Optional,
    Set,
    Tuple,
    Union,
)

import fontMath
import fontTools.misc.fixedTools
from fontTools import designspaceLib, ufoLib, varLib
from fontTools.ttLib.tables._n_a_m_e import NameRecord as ftNameRecord
from fontTools.ttLib.tables._n_a_m_e import _makeWindowsName

from ufo2ft.util import (
    _getNewGlyphFactory,
    importUfoModule,
    openFontFactory,
    zip_strict,
)

if TYPE_CHECKING:
    from collections.abc import Iterable, KeysView

    from ufoLib2.objects import Font, Glyph, Info

# Type alias for name records - can be dict (defcon) or NameRecord object (ufoLib2)
NameRecordDict = Dict[str, Any]

logger = logging.getLogger(__name__)

# Use the same rounding function used by varLib to round things for the variable font
# to reduce differences between the variable and static instances.
fontMath.mathFunctions.setRoundIntegerFunction(fontTools.misc.fixedTools.otRound)

# Stand-in type for any of the fontMath classes we use.
FontMathObject = Union[fontMath.MathGlyph, fontMath.MathInfo, fontMath.MathKerning]

# MutatorMath-style location mapping type, i.e.
# `{"wght": 1.0, "wdth": 0.0, "bleep": 0.5}`.
# LocationKey is a Location turned into a tuple so we can use it as a dict key.
Location = Mapping[str, float]
LocationKey = Tuple[Tuple[str, float], ...]

# Type of mapping of axes to their minimum, default and maximum values, i.e.
# `{"wght": (100.0, 400.0, 900.0), "wdth": (75.0, 100.0, 100.0)}`.
AxisBounds = Dict[str, Tuple[float, float, float]]

# A bunch of glyphs at a given location (in design coordinates)
SourceLayer = Tuple[Location, Dict[str, "Glyph"]]

# For mapping `wdth` axis user values to the OS2 table's width class field.
WDTH_VALUE_TO_OS2_WIDTH_CLASS = {
    50: 1,
    62.5: 2,
    75: 3,
    87.5: 4,
    100: 5,
    112.5: 6,
    125: 7,
    150: 8,
    200: 9,
}

# Font info fields that are not interpolated and should be copied from the
# default font to the instance.
#
# fontMath at the time of this writing handles the following attributes:
# https://github.com/robotools/fontMath/blob/0.5.0/Lib/fontMath/mathInfo.py#L360-L422
#
# From the attributes that are left, we skip non-interpolating ones on purpose as
# they are instance-specific, unless the instance location is the same as the the
# default source:
# - guidelines
# - postscriptFontName
# - styleMapFamilyName
# - styleMapStyleName
# - styleName
# - openTypeNameCompatibleFullName
# - openTypeNamePreferredFamilyName
# - openTypeNamePreferredSubfamilyName
# - openTypeNameUniqueID
# - openTypeNameWWSFamilyName
# - openTypeNameWWSSubfamilyName
# - postscriptFullName
# - postscriptUniqueID
# - woffMetadataUniqueID
#
# Some, we skip because they are deprecated:
# - macintoshFONDFamilyID
# - macintoshFONDName
# - year
#
# This means we implicitly require the `stylename` attribute in the Designspace
# `<instance>` element.
UFO_INFO_ATTRIBUTES_TO_COPY_TO_INSTANCES = {
    "copyright",
    "familyName",
    "note",
    "openTypeGaspRangeRecords",
    "openTypeHeadCreated",
    "openTypeHeadFlags",
    "openTypeNameDescription",
    "openTypeNameDesigner",
    "openTypeNameDesignerURL",
    "openTypeNameLicense",
    "openTypeNameLicenseURL",
    "openTypeNameManufacturer",
    "openTypeNameManufacturerURL",
    "openTypeNameRecords",
    "openTypeNameSampleText",
    "openTypeNameVersion",
    "openTypeOS2CodePageRanges",
    "openTypeOS2FamilyClass",
    "openTypeOS2Panose",
    "openTypeOS2Selection",
    "openTypeOS2Type",
    "openTypeOS2UnicodeRanges",
    "openTypeOS2VendorID",
    "postscriptDefaultCharacter",
    "postscriptForceBold",
    "postscriptIsFixedPitch",
    "postscriptWindowsCharacterSet",
    "trademark",
    "versionMajor",
    "versionMinor",
    "woffMajorVersion",
    "woffMetadataCopyright",
    "woffMetadataCredits",
    "woffMetadataDescription",
    "woffMetadataExtensions",
    "woffMetadataLicense",
    "woffMetadataLicensee",
    "woffMetadataTrademark",
    "woffMetadataVendor",
    "woffMinorVersion",
}


# Custom exception for this module
class InstantiatorError(Exception):
    pass


def process_rules_swaps(rules, location, glyphNames):
    """Apply these rules at this location to these glyphnames
    - rule order matters

    Return a list of (oldName, newName) in the same order as the rules.
    """
    swaps = []
    glyphNames = set(glyphNames)
    for rule in rules:
        if designspaceLib.evaluateRule(rule, location):
            for oldName, newName in rule.subs:
                # Here I don't check if the new name is also in glyphNames...
                # I guess it should be, so that we can swap, and if it isn't,
                # then it's better to error out later when we try to swap,
                # instead of silently ignoring the rule here.
                if oldName in glyphNames:
                    swaps.append((oldName, newName))
    return swaps


def _override_name_record(
    openTypeNameRecords: list,
    new_value: NameRecordDict,
) -> bool:
    """Override an existing name record in the list of OpenType name records.

    Records can be dicts (defcon) or NameRecord objects (ufoLib2). Both support
    dict-style read access via []. For writing, dicts use [] while NameRecord
    uses setattr since it's read-only for the Mapping interface.
    """
    for record in openTypeNameRecords:
        if (
            record["platformID"] == new_value["platformID"]
            and record["encodingID"] == new_value["encodingID"]
            and record["languageID"] == new_value["languageID"]
            and record["nameID"] == new_value["nameID"]
        ):
            # Override existing name record
            if isinstance(record, dict):
                record["string"] = new_value["string"]
            else:
                record.string = new_value["string"]
            return True
    return False


def _make_name_record_dict(
    name_id: int,
    value: str,
    language_tag: str = "en",
) -> NameRecordDict:
    """Create a name record dict from name ID, value, and language tag."""
    temp_name_record: ftNameRecord = _makeWindowsName(value, name_id, language_tag)
    return {
        "platformID": temp_name_record.platformID,
        "encodingID": temp_name_record.platEncID,
        "languageID": temp_name_record.langID,
        "nameID": temp_name_record.nameID,
        "string": value.strip(),
    }


def merge_public_font_info(
    font: Font,
    override_public_font_info: Dict[str, Any],
    instance_location: Location,
) -> None:
    """Merge the public.fontInfo dict into the font's info object (fontinfo.plist)."""
    for key, value in override_public_font_info.items():
        try:
            if key == "openTypeNameRecords":
                # directly save if openTypeNameRecords is None
                if font.info.openTypeNameRecords is None:
                    for dict_name_record in value:
                        # strip the string value to prevent XML whitespace issues
                        dict_name_record["string"] = dict_name_record["string"].strip()
                    font.info.openTypeNameRecords = value
                    continue
                else:
                    # openTypeNameRecords is a list of dicts of name records
                    assert isinstance(value, list), "openTypeNameRecords must be a list"

                # merge the existing openTypeNameRecords with the new ones
                for dict_name_record in value:
                    name_record = {
                        "platformID": dict_name_record["platformID"],
                        "encodingID": dict_name_record["encodingID"],
                        "languageID": dict_name_record["languageID"],
                        "nameID": dict_name_record["nameID"],
                        "string": dict_name_record["string"].strip(),
                    }
                    if not _override_name_record(
                        font.info.openTypeNameRecords, name_record
                    ):
                        font.info.openTypeNameRecords.append(name_record)
            else:
                setattr(font.info, key, copy.deepcopy(value))
        except AttributeError:
            logger.warning(
                "Font '%s' at instance location %s has an unknown font info "
                "attribute '%s' with value %s. This will be ignored.",
                font.info.familyName,
                instance_location,
                key,
                value,
            )


@dataclass(frozen=True)
class Instantiator:
    """Data class that holds all necessary information to generate a static
    font instance object at an arbitary location within the design space."""

    axis_bounds: AxisBounds  # Design space!
    source_layers: List[SourceLayer]  # at least 1 default layer required (can be empty)
    copy_feature_text: str = ""
    copy_nonkerning_groups: Mapping[str, List[str]] = field(default_factory=dict)
    copy_info: Optional[Info] = None
    copy_lib: Mapping[str, Any] = field(default_factory=dict)
    designspace_rules: List[designspaceLib.RuleDescriptor] = field(default_factory=list)
    glyph_mutators: Mapping[str, Optional["Variator"]] = field(default_factory=dict)
    info_mutator: Optional["Variator"] = None
    kerning_mutator: Optional["Variator"] = None
    round_geometry: bool = False
    skip_export_glyphs: List[str] = field(default_factory=list)
    designspace_root_lib_font_info: Dict[str, Any] = field(default_factory=dict)
    special_axes: Mapping[str, designspaceLib.AxisDescriptor] = field(
        default_factory=dict
    )
    # computed attributes (see __post_init__ below)
    default_source_idx: int = field(init=False)
    default_design_location: Location = field(init=False)

    def __post_init__(self):
        default_location = {
            axis: default for axis, (_, default, _) in self.axis_bounds.items()
        }
        default_location_items = default_location.items()
        default_source_idx = None
        for i, (location, _) in enumerate(self.source_layers):
            if location.items() <= default_location_items:
                default_source_idx = i
                break
        else:
            raise InstantiatorError(
                f"Missing source layer at default location: {default_location}"
            )
        assert default_source_idx is not None
        object.__setattr__(self, "default_source_idx", default_source_idx)
        object.__setattr__(
            self, "default_design_location", {**default_location, **location}
        )

    @classmethod
    def from_designspace(
        cls,
        designspace: designspaceLib.DesignSpaceDocument,
        round_geometry: bool = True,
        do_info=True,
        do_kerning=True,
        do_glyphs=True,
    ):
        """Instantiates a new data class from a Designspace object."""
        if designspace.findDefault() is None:
            raise InstantiatorError(_error_msg_no_default(designspace))

        if any(hasattr(axis, "values") for axis in designspace.axes):
            raise InstantiatorError(
                "The given designspace has one or more discrete (= non-interpolating) "
                "axes. You should split this designspace into smaller interpolating "
                "spaces and use the Instantiator on each. See the method "
                "`fontTools.designspaceLib.split.splitInterpolable()`"
            )

        if any(anisotropic(instance.location) for instance in designspace.instances):
            raise InstantiatorError(
                "The Designspace contains anisotropic instance locations, which are "
                "not supported by varLib. Look for and remove all 'yvalue=\"...\"' or "
                "use MutatorMath instead."
            )

        designspace.loadSourceFonts(openFontFactory())

        # The default font (default layer) determines which glyphs are interpolated,
        # because the math behind varLib and MutatorMath uses the default font as the
        # point of reference for all data.
        default_font = designspace.default.font
        default_layer = default_font.layers.defaultLayer
        non_default_layer_name = designspace.default.layerName
        if non_default_layer_name is not None:
            try:
                layer = default_font.layers[non_default_layer_name]
            except KeyError as e:
                raise InstantiatorError(
                    f"Layer {non_default_layer_name!r} not found "
                    f"in {designspace.default.filename}"
                ) from e
            default_layer = default_font.layers[non_default_layer_name]
            logger.info(f"Building from layer {layer.name}")

        glyph_names: Set[str] = set(default_layer.keys())
        for source in designspace.sources:
            other_names = set(source.font.keys())
            diff_names = other_names - glyph_names
            if diff_names:
                max_diff_glyphs = 10
                logger.warning(
                    "The source %s (%s)%s contains glyphs that are missing from the "
                    "default source, which will be ignored: %s%s; if this is unintended, "
                    "check that these glyphs have the exact same name as the "
                    "corresponding glyphs in the default source.",
                    source.name,
                    source.filename,
                    (
                        f" [layer: {source.layerName}]"
                        if non_default_layer_name is not None
                        else ""
                    ),
                    ", ".join(sorted(diff_names)[0:max_diff_glyphs]),
                    (
                        f"... ({len(diff_names)} total)"
                        if len(diff_names) > max_diff_glyphs
                        else ""
                    ),
                )

        # Construct Variators
        axis_bounds: AxisBounds = {}  # Design space!
        default_design_location = {}
        axis_order: List[str] = []
        special_axes = {}
        for axis in designspace.axes:
            axis_order.append(axis.name)
            axis_bounds[axis.name] = (
                axis.map_forward(axis.minimum),
                axis.map_forward(axis.default),
                axis.map_forward(axis.maximum),
            )
            default_design_location[axis.name] = axis_bounds[axis.name][1]
            # Some axes relate to existing OpenType fields and get special attention.
            if axis.tag in {"wght", "wdth", "slnt"}:
                special_axes[axis.tag] = axis

        info_mutator = None
        if do_info:
            masters_info = collect_info_masters(designspace, axis_bounds)
            try:
                info_mutator = Variator.from_masters(masters_info, axis_order)
            except varLib.errors.VarLibError as e:
                raise InstantiatorError(
                    f"Cannot set up fontinfo for interpolation: {e}'"
                ) from e

        kerning_mutator = None
        if do_kerning:
            masters_kerning = collect_kerning_masters(designspace, axis_bounds)
            try:
                kerning_mutator = Variator.from_masters(masters_kerning, axis_order)
            except varLib.errors.VarLibError as e:
                raise InstantiatorError(
                    f"Cannot set up kerning for interpolation: {e}'"
                ) from e

        # left empty as the glyph sources will be loaded later on-demand
        glyph_mutators: Dict[str, Variator] = {}
        source_layers = []
        if do_glyphs:
            # collect (location, source layer) tuples
            for source in designspace.sources:
                if source.layerName is None:
                    layer = source.font.layers.defaultLayer
                else:
                    layer = source.font.layers[source.layerName]
                source_location = source.location
                if source is designspace.default:
                    # sanity check that the source marked as the default really matches
                    # the default location (i.e. is a subset of)
                    assert source_location.items() <= default_design_location.items()
                source_layers.append((source_location, {g.name: g for g in layer}))

        # Construct defaults to copy over
        copy_feature_text: str = default_font.features.text if do_info else ""
        # Kerning groups are taken care of by the kerning Variator.
        copy_nonkerning_groups: Mapping[str, List[str]] = (
            {
                key: glyph_names
                for key, glyph_names in default_font.groups.items()
                if not key.startswith(("public.kern1.", "public.kern2."))
            }
            if do_info
            else {}
        )
        copy_info: Optional[Info] = default_font.info if do_info else None
        if copy_info is not None and copy_info.openTypeOS2Panose is not None:
            # only copy panose values that are shared by all the designspace.sources,
            # and set to 0 those that differ
            panose_sources = [
                source.font.info.openTypeOS2Panose
                for source in designspace.sources
                if source.font.info.openTypeOS2Panose is not None
            ]
            shared_panose = [
                values[0] if len(set(values)) == 1 else 0
                for values in zip(*panose_sources)
            ]
            # defcon already validates openTypeOS2Panose length, while ufoLib2 doesn't;
            # to be safe, ensure we have exactly 10 values (pad with zeros or truncate)
            if len(shared_panose) != 10:
                logger.warning(
                    "openTypeOS2Panose values in designspace sources have invalid "
                    "length, they will be padded/truncated to 10 values"
                )
                shared_panose = (shared_panose + [0] * 10)[:10]
            copy_info = copy.copy(copy_info)
            copy_info.openTypeOS2Panose = shared_panose if any(shared_panose) else None

        copy_lib: Mapping[str, Any] = default_font.lib if do_info else {}

        # The list of glyphs-not-to-export-and-decompose-where-used-as-a-component is
        # supposed to be taken from the Designspace when a Designspace is used as the
        # starting point of the compilation process. It should be exported to all
        # instance libs, where the ufo2ft compilation functions will pick it up.
        skip_export_glyphs = designspace.lib.get("public.skipExportGlyphs", [])

        # The font information (public.fontInfo) in the root <lib> of designspace to
        # copy to all instance libs. May be overridden by instance-specific <lib>
        # public.fontInfo
        designspace_root_lib_font_info = designspace.lib.get("public.fontInfo", {})

        return cls(
            axis_bounds,
            source_layers,
            copy_feature_text,
            copy_nonkerning_groups,
            copy_info,
            copy_lib,
            designspace.rules,
            glyph_mutators,
            info_mutator,
            kerning_mutator,
            round_geometry,
            skip_export_glyphs,
            designspace_root_lib_font_info,
            special_axes,
        )

    @property
    def axis_order(self):
        return list(self.axis_bounds.keys())

    @property
    def default_source_glyphs(self) -> Dict[str, Glyph]:
        return self.source_layers[self.default_source_idx][1]

    @property
    def glyph_names(self) -> KeysView[str]:
        return self.default_source_glyphs.keys()

    @property
    def source_locations(self) -> Iterable[Location]:
        return (
            {**self.default_design_location, **loc} for loc, _ in self.source_layers
        )

    def normalize(self, location: Location) -> Location:
        return varLib.models.normalizeLocation(location, self.axis_bounds)

    def generate_instance(self, instance: designspaceLib.InstanceDescriptor) -> Font:
        """Generate an interpolated instance font object for an
        InstanceDescriptor."""
        if anisotropic(instance.location):
            raise InstantiatorError(
                f"Instance {instance.familyName}-"
                f"{instance.styleName}: Anisotropic location "
                f"{instance.location} not supported by varLib."
            )

        ufo_module = importUfoModule()
        font = ufo_module.Font()

        # Instances may leave out locations that match the default source, so merge
        # default location with the instance's location.
        location = {**self.default_design_location, **instance.location}
        location_normalized = self.normalize(location)

        # Kerning
        if self.kerning_mutator:
            kerning_instance = self.kerning_mutator.instance_at(location_normalized)
            if self.round_geometry:
                kerning_instance.round()
            kerning_instance.extractKerning(font)

        # Info
        if self.info_mutator:
            self._generate_instance_info(instance, location_normalized, location, font)

        # Non-kerning groups. Kerning groups have been taken care of by the kerning
        # instance.
        for key, glyph_names in self.copy_nonkerning_groups.items():
            font.groups[key] = [name for name in glyph_names]

        # Features
        font.features.text = self.copy_feature_text

        # Lib
        #  1. Copy the default lib to the instance.
        font.lib = typing.cast(dict, copy.deepcopy(self.copy_lib))
        #  2. Copy the Designspace's skipExportGlyphs list over to the UFO to
        #     make sure it wins over the default UFO one.
        font.lib["public.skipExportGlyphs"] = [name for name in self.skip_export_glyphs]
        #  3. Write _design_ location to instance's lib.
        font.lib["designspace.location"] = [loc for loc in location.items()]

        # Glyphs
        for glyph_name in self.glyph_names:
            glyph = font.newGlyph(glyph_name)

            try:
                self.generate_glyph_instance(
                    glyph_name, location_normalized, output_glyph=glyph
                )
            except Exception as e:
                # TODO: Figure out what exceptions fontMath/varLib can throw.
                # By default, explode if we cannot generate a glyph instance for
                # whatever reason (usually outline incompatibility)...
                if glyph_name not in self.skip_export_glyphs:
                    raise InstantiatorError(
                        f"Failed to generate instance of glyph {glyph_name!r}: "
                        f"{str(e)}. (Note: the most common cause for an error here is "
                        "that the glyph outlines are not point-for-point compatible or "
                        "have the same starting point or are in the same order in all "
                        "masters.)"
                    ) from e

                # ...except if the glyph is in public.skipExportGlyphs and would
                # therefore be removed from the compiled font anyway. There's not much
                # we can do except leave it empty in the instance and tell the user.
                logger.warning(
                    "Failed to generate instance of glyph '%s', which is marked as "
                    "non-exportable. Glyph will be left empty. Failure reason: %s",
                    glyph_name,
                    e,
                )

        # Process rules
        # The order of the swaps below is independent of the order of glyph names.
        # It depends on the order of the <sub>s in the designspace rules.
        swaps = process_rules_swaps(self.designspace_rules, location, self.glyph_names)
        for name_old, name_new in swaps:
            if name_old != name_new:
                swap_glyph_names(font, name_old, name_new)

        return font

    @cached_property
    def glyph_factory(self) -> Callable[[str], Glyph]:
        glyphs = self.default_source_glyphs
        if len(glyphs) > 0:
            glyph_factory = _getNewGlyphFactory(next(iter(glyphs.values())))
        else:
            raise InstantiatorError("Default source has no glyphs, can't make new ones")
        return glyph_factory

    def new_glyph(self, name: str) -> Glyph:
        return self.glyph_factory(name=name)

    def generate_glyph_instance(
        self,
        glyph_name: str,
        normalized_location: Location,
        output_glyph: Glyph | None = None,
    ) -> Glyph:
        """Generate an instance of a single glyph at the given location.

        The location must be specified using normalized coordinates.
        If output_glyph is None, the instance is generated in a new Glyph object
        and returned. Otherwise, the instance is extracted to the given Glyph object.
        """
        glyph_mutator = self.glyph_mutators.get(glyph_name)
        if glyph_mutator is None:
            sources = collect_glyph_masters(
                self.source_layers,
                glyph_name,
                self.axis_bounds,
                self.default_source_idx,
            )
            try:
                glyph_mutator = self.glyph_mutators[glyph_name] = Variator.from_masters(
                    sources, self.axis_order
                )
            except varLib.errors.VarLibError as e:
                raise InstantiatorError(
                    f"Cannot set up glyph {glyph_name} for interpolation: {e}'"
                ) from e

        glyph_instance = glyph_mutator.instance_at(normalized_location)

        if self.round_geometry:
            glyph_instance = glyph_instance.round()

        if output_glyph is None:
            output_glyph = self.new_glyph(glyph_name)

        # onlyGeometry=True does not set name and unicodes, in ufoLib2 we can't
        # modify a glyph's name. Copy unicodes from default layer.
        glyph_instance.extractGlyph(output_glyph, onlyGeometry=True)
        output_glyph.unicodes = list(self.default_source_glyphs[glyph_name].unicodes)

        return output_glyph

    def _generate_instance_info(
        self,
        instance: designspaceLib.InstanceDescriptor,
        location_normalized: Location,
        location: Location,
        font: Font,
    ) -> None:
        """Generate fontinfo related attributes.

        Separate, as fontinfo treatment is more extensive than the rest.

        The name record priority order follows the order defined in
        https://fonttools.readthedocs.io/en/stable/designspaceLib/index.html#common-lib-key-registry
        and is as follows, from highest to lowest priority:
        1. <instance>/<variable-font> element's <lib> public.fontInfo key
        2. <instance>'s familyName, styleName, postScriptFontName, styleMapFamilyName,
        styleMapStyleName attributes (including multilingual names)
        3. root <lib> public.fontInfo key
        4. non-interpolating metadata from the default font fontinfo.plist
        """
        assert self.info_mutator is not None
        assert self.copy_info is not None

        info_instance = self.info_mutator.instance_at(location_normalized)
        if self.round_geometry:
            info_instance = info_instance.round()

        # If there is only one master (static font), the instance can only be at the
        # default location after the latter has been normalized. It's OK for it to
        # inherit ALL the fontinfo from the default source.
        if self.info_mutator.is_static_font():
            assert all(v == 0.0 for v in location_normalized.values())
            for attribute in ufoLib.fontInfoAttributesVersion3:
                if (value := getattr(self.copy_info, attribute, None)) is not None:
                    setattr(font.info, attribute, copy.deepcopy(value))
        else:
            # Multiple masters: copy interpolating fontinfo metadata from MathInfo
            info_instance.extractInfo(font.info)

            # level 4: Copy the generic, non-interpolating metadata from the default
            # font, except attributes that are instance-specific (see comments above).
            for attribute in UFO_INFO_ATTRIBUTES_TO_COPY_TO_INSTANCES:
                if (value := getattr(self.copy_info, attribute, None)) is not None:
                    setattr(font.info, attribute, copy.deepcopy(value))

        # level 3: copy the designspace root <lib> public.fontInfo key
        if self.designspace_root_lib_font_info:
            merge_public_font_info(
                font,
                override_public_font_info=self.designspace_root_lib_font_info,
                instance_location=location,
            )

        # level 2: add instance-specific family name, style name, etc.
        # from <instance> attributes
        if instance.familyName:
            font.info.familyName = instance.familyName
        if instance.styleName:
            font.info.styleName = instance.styleName
        elif not font.info.styleName:
            # only copy styleName from default UFO fontinfo (level 4)
            # if result styleName is empty at this step
            # as might have gotten a value from root lib key (level 3)
            logger.warning(
                "The given instance or instance at location %s is missing the "
                "stylename attribute, which is required. Copying over the styleName "
                "%s from the default font, which is probably wrong.",
                location,
                self.copy_info.styleName,
            )
            font.info.styleName = self.copy_info.styleName
        if instance.postScriptFontName:
            font.info.postscriptFontName = instance.postScriptFontName
        if instance.styleMapFamilyName:
            font.info.styleMapFamilyName = instance.styleMapFamilyName
        if instance.styleMapStyleName:
            if instance.styleMapStyleName.lower() not in {
                "regular",
                "italic",
                "bold",
                "bold italic",
            }:
                logger.warning(
                    "The given instance or instance at location %s has a styleMapStyleName "
                    "that is not one of the standard values ('Regular', 'Italic', 'Bold', "
                    "'Bold Italic'). This may cause problems in some applications.",
                    location,
                )
            # convert to lowercase as per UFO spec
            font.info.styleMapStyleName = instance.styleMapStyleName.lower()

        # multilingual names overriding; specific for OpenType name records on Windows
        mulitlingual_opentype_font_records = []
        # list out all language tags that are used in the instance
        declared_language_tags = set(
            instance.localisedFamilyName.keys()
            | instance.localisedStyleName.keys()
            | instance.localisedStyleMapFamilyName.keys()
            | instance.localisedStyleMapStyleName.keys()
        )
        OT_TYPOGRAPHIC_FAMILY_NAME_ID = 16
        OT_TYPOGRAPHIC_SUBFAMILY_NAME_ID = 17
        OT_STYLE_MAP_FAMILY_NAME_ID = 1
        OT_STYLE_MAP_STYLE_NAME_ID = 2
        for language_tag in declared_language_tags:
            if language_tag == "en":
                continue
            if font.info.openTypeNameRecords is None:
                font.info.openTypeNameRecords = []
            # currently only make records for Windows language tag
            # (platform 3, platform encoding 1)
            if language_tag in instance.localisedFamilyName:
                # assume is Preferred Family Name (ID=16)
                mulitlingual_opentype_font_records.append(
                    _make_name_record_dict(
                        OT_TYPOGRAPHIC_FAMILY_NAME_ID,
                        instance.localisedFamilyName[language_tag],
                        language_tag,
                    )
                )
            if language_tag in instance.localisedStyleName:
                # assume is Preferred Subfamily Name (ID=17)
                mulitlingual_opentype_font_records.append(
                    _make_name_record_dict(
                        OT_TYPOGRAPHIC_SUBFAMILY_NAME_ID,
                        instance.localisedStyleName[language_tag],
                        language_tag,
                    )
                )
            if language_tag in instance.localisedStyleMapFamilyName:
                # Style Map Family Name (ID=1)
                mulitlingual_opentype_font_records.append(
                    _make_name_record_dict(
                        OT_STYLE_MAP_FAMILY_NAME_ID,
                        instance.localisedStyleMapFamilyName[language_tag],
                        language_tag,
                    )
                )
            elif language_tag in instance.localisedFamilyName:
                # Style Map Family Name (ID=1)
                # autofallback to ID=16 + styleName ID=17
                # (but omit ID=17 if it's standard style)
                full_family_name = instance.localisedFamilyName[language_tag]
                if language_tag in instance.localisedStyleName:
                    full_family_name += " " + instance.localisedStyleName[language_tag]
                elif font.info.styleName.lower() not in {
                    "regular",
                    "italic",
                    "bold",
                    "bold italic",
                }:
                    # if the styleName is not one of the standard styles,
                    # add style name to ID=1
                    full_family_name += " " + font.info.styleName
                mulitlingual_opentype_font_records.append(
                    _make_name_record_dict(
                        OT_STYLE_MAP_FAMILY_NAME_ID,
                        full_family_name,
                        language_tag,
                    )
                )
            if language_tag in instance.localisedStyleMapStyleName:
                # Style Map Subfamily Name (ID=2)
                mulitlingual_opentype_font_records.append(
                    _make_name_record_dict(
                        OT_STYLE_MAP_STYLE_NAME_ID,
                        instance.localisedStyleMapStyleName[language_tag],
                        language_tag,
                    )
                )
        # level 2 (part 2): add multilingual instance-specific family name,
        # style name, etc. from sub-elements
        if mulitlingual_opentype_font_records:
            merge_public_font_info(
                font,
                override_public_font_info={
                    "openTypeNameRecords": mulitlingual_opentype_font_records
                },
                instance_location=location,
            )

        # If the masters haven't set the OS/2 weight and width class, use the
        # user-space values ("input") of the axis mapping in the Designspace file for
        # weight and width axes, if they exist. The slnt axis' value maps 1:1 to
        # italicAngle. Clamp the values to the valid ranges.
        if info_instance.openTypeOS2WeightClass is None and "wght" in self.special_axes:
            weight_axis = self.special_axes["wght"]
            font.info.openTypeOS2WeightClass = weight_class_from_wght_value(
                weight_axis.map_backward(location[weight_axis.name])
            )
        if info_instance.openTypeOS2WidthClass is None and "wdth" in self.special_axes:
            width_axis = self.special_axes["wdth"]
            font.info.openTypeOS2WidthClass = width_class_from_wdth_value(
                width_axis.map_backward(location[width_axis.name])
            )
        if info_instance.italicAngle is None and "slnt" in self.special_axes:
            slant_axis = self.special_axes["slnt"]
            font.info.italicAngle = italic_angle_from_slnt_value(
                slant_axis.map_backward(location[slant_axis.name])
            )

        # Copy instance-specific attributes from the InstanceDescriptor.
        # level 1: public.fontInfo key in <instance><lib>, copy last to override everything else
        if hasattr(instance, "lib") and "public.fontInfo" in instance.lib:
            merge_public_font_info(font, instance.lib["public.fontInfo"], location)

    @property
    def interpolated_layers(self) -> list[InterpolatedLayer]:
        """Return one InterpolatedLayer for each source location."""
        default = self.default_design_location
        return [
            InterpolatedLayer(self, {**default, **loc}, source_layer)
            for loc, source_layer in self.source_layers
        ]

    def replace_source_layers(self, new_layers: list[dict[str, Glyph]]):
        """Replace source layers with `new_layers` and clear the cached glyph models.

        Raises `ValueError` if len(new_layers) != len(self.source_layers).
        """
        self.source_layers[:] = [
            (loc, new_glyphs)
            for (loc, _), new_glyphs in zip_strict(self.source_layers, new_layers)
        ]
        # this forces to reload the glyph variation models when an instance is requested
        self.glyph_mutators.clear()


def _error_msg_no_default(designspace: designspaceLib.DesignSpaceDocument) -> str:
    if any(axis.map for axis in designspace.axes):
        bonus_msg = (
            "For axes with a mapping, the 'default' values should have an "
            "'input=\"...\"' map value, where the corresponding 'output=\"...\"' "
            "value then points to the master source."
        )
    else:
        bonus_msg = ""

    default_location = ", ".join(
        f"{k}: {v}" for k, v in designspace.newDefaultLocation().items()
    )

    return (
        "Can't generate UFOs from this Designspace because there is no default "
        "master source at location {!r}. Check that all 'default' "
        "values of all axes together point to a single actual master source. "
        "{!s}".format(default_location, bonus_msg)
    )


def location_to_key(location: Location) -> LocationKey:
    """Converts a Location into a sorted tuple so it can be used as a dict
    key."""
    return tuple(sorted(location.items()))


def anisotropic(location: Location) -> bool:
    """Tests if any single location value is a MutatorMath-style anisotropic
    value, i.e. is a tuple of (x, y)."""
    return any(isinstance(v, tuple) for v in location.values())


def collect_info_masters(
    designspace: designspaceLib.DesignSpaceDocument, axis_bounds: AxisBounds
) -> List[Tuple[Location, FontMathObject]]:
    """Return master Info objects wrapped by MathInfo."""
    locations_and_masters = []

    for source in designspace.sources:
        if source.layerName is not None and source is not designspace.default:
            continue  # No font info in non-default source layers.

        normalized_location = varLib.models.normalizeLocation(
            source.location, axis_bounds
        )
        locations_and_masters.append(
            (normalized_location, fontMath.MathInfo(source.font.info))
        )

    return locations_and_masters


def collect_kerning_masters(
    designspace: designspaceLib.DesignSpaceDocument, axis_bounds: AxisBounds
) -> List[Tuple[Location, FontMathObject]]:
    """Return master kerning objects wrapped by MathKerning."""

    # Always take the groups from the default source. This also avoids fontMath
    # making a union of all groups it is given.
    groups = designspace.default.font.groups

    locations_and_masters = []

    for source in designspace.sources:
        if source.layerName is not None and source is not designspace.default:
            continue  # No kerning in non-default source layers.

        # If a source has groups, they should match the default's.
        if source.font.groups and source.font.groups != groups:
            logger.warning(
                "The source %s (%s) contains different groups than the default source. "
                "The default source's groups will be used for the instances.",
                source.name,
                source.filename,
            )

        # This assumes that groups of all sources are the same.
        normalized_location = varLib.models.normalizeLocation(
            source.location, axis_bounds
        )
        locations_and_masters.append(
            (normalized_location, fontMath.MathKerning(source.font.kerning, groups))
        )

    return locations_and_masters


def collect_glyph_masters(
    source_layers: List[SourceLayer],
    glyph_name: str,
    axis_bounds: AxisBounds,
    default_source_idx: int,
) -> List[Tuple[Location, FontMathObject]]:
    """Return master glyph objects for glyph_name wrapped by MathGlyph.

    Note: skips empty source glyphs if the default glyph is not empty to almost match
    what ufoProcessor is doing. In e.g. Mutator Sans, the 'S.closed' glyph is left
    empty in one source layer. One could treat this as a source error, but ufoProcessor
    specifically has code to skip that empty glyph and carry on.
    """
    locations_and_masters = []
    default_glyph_empty = False
    other_glyph_empty = False

    for i, (location, source_layer) in enumerate(source_layers):
        this_is_default = i == default_source_idx
        if glyph_name not in source_layer:
            if this_is_default:
                # Default layer must contain every glyph by definition.
                raise InstantiatorError(
                    f"glyph {glyph_name!r} not found in the default source"
                )
            else:
                # Sparse fonts do not and layers may not contain every glyph.
                continue

        source_glyph = source_layer[glyph_name]

        if not (len(source_glyph) or source_glyph.components):
            if this_is_default:
                default_glyph_empty = True
            else:
                other_glyph_empty = True

        normalized_location = varLib.models.normalizeLocation(location, axis_bounds)
        locations_and_masters.append(
            (normalized_location, fontMath.MathGlyph(source_glyph, strict=True))
        )

    # Filter out empty glyphs if the default glyph is not empty.
    if not default_glyph_empty and other_glyph_empty:
        locations_and_masters = [
            (loc, master)
            for loc, master in locations_and_masters
            if master.contours or master.components
        ]

    return locations_and_masters


def width_class_from_wdth_value(wdth_user_value) -> int:
    """Return the OS/2 width class from the wdth axis user value.

    The OpenType 1.8.3 specification states:

        When mapping from 'wdth' values to usWidthClass, interpolate fractional
        values between the mapped values and then round, and clamp to the range
        1 to 9.

    "Mapped values" probably means the in-percent numbers layed out for the OS/2
    width class, so we are forcing these numerical semantics on the user values
    of the wdth axis.
    """
    width_user_value = min(max(wdth_user_value, 50), 200)
    width_user_value_mapped = varLib.models.piecewiseLinearMap(
        width_user_value, WDTH_VALUE_TO_OS2_WIDTH_CLASS
    )
    return fontTools.misc.fixedTools.otRound(width_user_value_mapped)


def weight_class_from_wght_value(wght_user_value) -> int:
    """Return the OS/2 weight class from the wght axis user value."""
    weight_user_value = min(max(wght_user_value, 1), 1000)
    return fontTools.misc.fixedTools.otRound(weight_user_value)


def italic_angle_from_slnt_value(slnt_user_value) -> Union[int, float]:
    """Return the italic angle from the slnt axis user value."""
    slant_user_value = min(max(slnt_user_value, -90), 90)
    return slant_user_value


def swap_glyph_names(font: Any, name_old: str, name_new: str):
    """Swap two existing glyphs in the default layer of a font (outlines,
    width, component references, kerning references, group membership).

    The idea behind swapping instead of overwriting is explained in
    https://github.com/fonttools/fonttools/tree/main/Doc/source/designspaceLib#ufo-instances.
    We need to keep the old glyph around in case any other glyph references
    it; glyphs that are not explicitly substituted by rules should not be
    affected by the rule application.

    The .unicodes are not swapped. The rules mechanism is supposed to swap
    glyphs, not characters.
    """

    if name_old not in font or name_new not in font:
        raise InstantiatorError(
            "Cannot swap glyphs {!r} and {!r}, as either or both are missing".format(
                name_old, name_new
            )
        )

    # 1. Swap outlines and glyph width. Ignore lib content and other properties.
    glyph_old = font[name_old]
    glyph_new = font[name_new]
    glyph_swap = _getNewGlyphFactory(glyph_old)(name="temporary_swap_glyph")

    p = glyph_swap.getPointPen()
    glyph_old.drawPoints(p)
    glyph_swap.width = glyph_old.width

    glyph_old.clearContours()
    glyph_old.clearComponents()
    p = glyph_old.getPointPen()
    glyph_new.drawPoints(p)
    glyph_old.width = glyph_new.width

    glyph_new.clearContours()
    glyph_new.clearComponents()
    p = glyph_new.getPointPen()
    glyph_swap.drawPoints(p)
    glyph_new.width = glyph_swap.width

    # 2. Swap anchors.
    glyph_swap.anchors = [dict(a) for a in glyph_old.anchors]
    glyph_old.anchors = [dict(a) for a in glyph_new.anchors]
    glyph_new.anchors = [dict(a) for a in glyph_swap.anchors]

    # 3. Remap components.
    for g in font:
        for c in g.components:
            if c.baseGlyph == name_old:
                c.baseGlyph = name_new
            elif c.baseGlyph == name_new:
                c.baseGlyph = name_old

    # 4. Swap literal names in kerning.
    kerning_new = {}
    for first, second in font.kerning.keys():
        value = font.kerning[(first, second)]
        if first == name_old:
            first = name_new
        elif first == name_new:
            first = name_old
        if second == name_old:
            second = name_new
        elif second == name_new:
            second = name_old
        kerning_new[(first, second)] = value
    font.kerning.clear()
    font.kerning.update(kerning_new)

    # 5. Swap names in groups.
    for group_name, group_members in font.groups.items():
        group_members_new = []
        for name in group_members:
            if name == name_old:
                group_members_new.append(name_new)
            elif name == name_new:
                group_members_new.append(name_old)
            else:
                group_members_new.append(name)
        font.groups[group_name] = group_members_new


@dataclass(frozen=True)
class Variator:
    """A middle-man class that ingests a mapping of normalized locations to
    masters plus axis definitions and uses varLib to spit out interpolated
    instances at specified normalized locations.

    fontMath objects stand in for the actual master objects from the
    UFO. Upon generating an instance, these objects have to be extracted
    into an actual UFO object.
    """

    masters: List[FontMathObject]
    location_to_master: Mapping[LocationKey, FontMathObject]
    model: varLib.models.VariationModel

    @classmethod
    def from_masters(
        cls, items: List[Tuple[Location, FontMathObject]], axis_order: List[str]
    ):
        masters = []
        master_locations = []
        location_to_master = {}
        for normalized_location, master in items:
            master_locations.append(normalized_location)
            masters.append(master)
            location_to_master[location_to_key(normalized_location)] = master
        model = varLib.models.VariationModel(master_locations, axis_order)

        return cls(masters, location_to_master, model)

    def instance_at(self, normalized_location: Location) -> FontMathObject:
        """Return a FontMathObject for the specified location ready to be
        inflated.

        If an instance location matches a master location, this method
        returns the master data instead of running through varLib. This
        is both an optimization _and_ it enables having a Designspace
        with instances matching their masters without requiring them to
        be compatible. Glyphs.app works this way; it will only generate
        a font from an instance, but compatibility is only required if
        there is actual interpolation to be done. This enables us to
        store incompatible bare masters in one Designspace and having
        arbitrary instance data applied to them.
        """
        normalized_location_key = location_to_key(normalized_location)
        if normalized_location_key in self.location_to_master:
            return copy.deepcopy(self.location_to_master[normalized_location_key])

        return self.model.interpolateFromMasters(normalized_location, self.masters)

    def is_static_font(self):
        return len(self.masters) == 1


@dataclass(frozen=True, repr=False)
class InterpolatedLayer(Mapping):
    """Mapping of glyphs keyed by name, interpolated on demand.

    If the given location corresponds to one of the source layers, and the
    latter contains the glyph, this is used directly; otherwise, a new glyph
    instance is generated on-the-fly at that location, and cached for subsequent
    retrieval.

    This is useful for APIs that expect a dict of glyphs for resolving component
    references, e.g. FontTools pens.
    """

    instantiator: Instantiator
    # axis coordinates for this layer in design space
    location: Location
    # source ufoLib2/defcon Layer (None if location isn't among the source locations)
    source_layer: dict[str, Glyph] | None = None
    _cache: dict[str, Glyph] = field(default_factory=dict)

    @cached_property
    def normalized_location(self):
        return self.instantiator.normalize(self.location)

    def __iter__(self) -> Iterable[str]:
        return iter(self.instantiator.glyph_names)

    def __len__(self) -> int:
        return len(self.instantiator.glyph_names)

    def __getitem__(self, glyph_name: str) -> Glyph:
        try:
            src_glyph = self._get(glyph_name)
            return self._cache.setdefault(
                glyph_name,
                src_glyph if src_glyph is not None else self._interpolate(glyph_name),
            )
        except InstantiatorError as e:
            raise KeyError(glyph_name) from e

    def __repr__(self):
        return (
            f"<{self.__class__.__name__} {self.location} "
            f"({len(self)} glyphs) at 0x{id(self):12x}>"
        )

    def _get(self, glyph_name: str) -> Glyph | None:
        glyph = None
        if self.source_layer is not None:
            glyph = self.source_layer.get(glyph_name)
        return glyph

    def _interpolate(self, glyph_name: str) -> Glyph:
        return self.instantiator.generate_glyph_instance(
            glyph_name, self.normalized_location
        )
