#!/usr/bin/env python from __future__ import print_function, absolute_import import sys, os from os.path import dirname, basename, abspath, relpath, join as pjoin sys.path.append(abspath(pjoin(dirname(__file__), 'tools'))) from common import BASEDIR, VENVDIR, getGitHash, getVersion, execproc from collections import OrderedDict import argparse import datetime import errno import glyphsLib import logging import re import signal import subprocess import ufo2ft from functools import partial from fontmake.font_project import FontProject from defcon import Font from fontTools import designspaceLib from fontTools import varLib from fontTools.misc.transform import Transform from fontTools.pens.transformPen import TransformPen from fontTools.pens.reverseContourPen import ReverseContourPen from glyphsLib.interpolation import apply_instance_data from mutatorMath.ufo.document import DesignSpaceDocumentReader from multiprocessing import Process, Queue from ufo2ft.filters.removeOverlaps import RemoveOverlapsFilter from ufo2ft import CFFOptimization log = logging.getLogger(__name__) stripItalic_re = re.compile(r'(?:^|\b)italic(?:\b|$)', re.I | re.U) def stripItalic(name): return stripItalic_re.sub('', name.strip()) def sighandler(signum, frame): sys.stdout.write('\n') sys.stdout.flush() sys.exit(1) def mkdirs(path): try: os.makedirs(path) except OSError as e: if e.errno != errno.EEXIST: raise # raises the error again def fatal(msg): print(sys.argv[0] + ': ' + msg, file=sys.stderr) sys.exit(1) def composedGlyphIsNonTrivial(g): # A non-trivial glyph is one that uses reflecting component transformations. if g.components and len(g.components) > 0: if len(g.components) > 1: return True for c in g.components: # has non-trivial transformation? (i.e. scaled) # Example of optimally trivial transformation: # (1, 0, 0, 1, 0, 0) no scale or offset # Example of scaled transformation matrix: # (-1.0, 0, 0.3311, 1, 1464.0, 0) flipped x axis, sheered and offset # xScale, xyScale, yxScale, yScale, xOffset, yOffset = c.transformation # If glyph is reflected along x or y axes, it won't slant well. if xScale < 0 or yScale < 0: return True return False # Directives are glyph-specific post-processing directives for the compiler. # A directive is added to the "note" section of a glyph and takes the # following form: # # !post:DIRECTIVE # # Where DIRECTIVE is the name of a known directive. # This string can appear anywhere in the glyph note. # Directives are _not_ case sensitive but normalized by str.lower(), meaning # that e.g. "removeoverlap" == "RemoveOverlap" == "REMOVEOVERLAP". # knownDirectives = set([ 'removeoverlap', # applies overlap removal (boolean union) ]) findDirectiveRegEx = re.compile(r'\!post:([^ ]+)', re.I | re.U) def findGlyphDirectives(g): # -> set | None directives = set() if g.note and len(g.note) > 0: for directive in findDirectiveRegEx.findall(g.note): directive = directive.lower() if directive in knownDirectives: directives.add(directive) else: print( 'unknown glyph directive !post:%s in glyph %s' % (directive, g.name), file=sys.stderr ) return directives class VarFontProject(FontProject): def __init__(self, familyName=None, *args, **kwargs): super(VarFontProject, self).__init__(*args, **kwargs) self.familyName = familyName def decompose_glyphs(self, designspace, glyph_filter=lambda g: True): """Move components of UFOs' glyphs to their outlines.""" for ufo in designspace: log.info('Decomposing glyphs for ' + self._font_name(ufo)) for glyph in ufo: if not glyph.components or not glyph_filter(glyph): continue self._deep_copy_contours(ufo, glyph, glyph, Transform()) glyph.clearComponents() def _deep_copy_contours(self, ufo, parent, component, transformation): """Copy contours from component to parent, including nested components.""" for nested in component.components: self._deep_copy_contours( ufo, parent, ufo[nested.baseGlyph], transformation.transform(nested.transformation)) if component != parent: pen = TransformPen(parent.getPen(), transformation) # if the transformation has a negative determinant, it will reverse # the contour direction of the component xx, xy, yx, yy = transformation[:4] if xx*yy - xy*yx < 0: pen = ReverseContourPen(pen) component.draw(pen) def _build_interpolatable_masters( self, designspace, ttf, use_production_names=None, reverse_direction=True, conversion_error=None, feature_writers=None, cff_round_tolerance=None, **kwargs ): """Build OpenType binaries with interpolatable outlines.""" # We decompose any glyph with reflected components to make sure # that fontTools varLib is able to produce properly-slanting interpolation. self._load_designspace_sources(designspace) decomposeGlyphs = set() removeOverlapsGlyphs = set() masters = [s.font for s in designspace.sources] for ufo in masters: if self.familyName is not None: ufo.info.familyName =\ ufo.info.familyName.replace('Inter', self.familyName) ufo.info.styleMapFamilyName =\ ufo.info.styleMapFamilyName.replace('Inter', self.familyName) ufo.info.postscriptFontName =\ ufo.info.postscriptFontName.replace('Inter', self.familyName.replace(' ', '')) ufo.info.macintoshFONDName =\ ufo.info.macintoshFONDName.replace('Inter', self.familyName) ufo.info.openTypeNamePreferredFamilyName =\ ufo.info.openTypeNamePreferredFamilyName.replace('Inter', self.familyName) updateFontVersion(ufo) ufoname = basename(ufo.path) for g in ufo: directives = findGlyphDirectives(g) if g.components and composedGlyphIsNonTrivial(g): decomposeGlyphs.add(g.name) if 'removeoverlap' in directives: if g.components and len(g.components) > 0: decomposeGlyphs.add(g.name) removeOverlapsGlyphs.add(g) self.decompose_glyphs(masters, lambda g: g.name in decomposeGlyphs) if len(removeOverlapsGlyphs) > 0: rmoverlapFilter = RemoveOverlapsFilter(backend='pathops') rmoverlapFilter.start() for g in removeOverlapsGlyphs: log.info( 'Removing overlaps in glyph "%s" of %s', g.name, basename(g.getParent().path) ) rmoverlapFilter.filter(g) if ttf: return ufo2ft.compileInterpolatableTTFsFromDS( designspace, useProductionNames=use_production_names, reverseDirection=reverse_direction, cubicConversionError=conversion_error, featureWriters=feature_writers, inplace=True, ) else: return ufo2ft.compileInterpolatableOTFsFromDS( designspace, useProductionNames=use_production_names, roundTolerance=cff_round_tolerance, featureWriters=feature_writers, inplace=True, ) def updateFontVersion(font, dummy=False): version = getVersion() buildtag = getGitHash() now = datetime.datetime.utcnow() if dummy: version = "1.0" buildtag = "src" now = datetime.datetime(2016, 1, 1, 0, 0, 0, 0) versionMajor, versionMinor = [int(num) for num in version.split(".")] font.info.version = version font.info.versionMajor = versionMajor font.info.versionMinor = versionMinor font.info.woffMajorVersion = versionMajor font.info.woffMinorVersion = versionMinor font.info.year = now.year font.info.openTypeNameVersion = "Version %d.%03d;git-%s" % ( versionMajor, versionMinor, buildtag) font.info.openTypeNameUniqueID = "%s %s:%d:%s" % ( font.info.familyName, font.info.styleName, now.year, buildtag) # creation date & time (YYYY/MM/DD HH:MM:SS) font.info.openTypeHeadCreated = now.strftime("%Y/%m/%d %H:%M:%S") # setFontInfo patches font.info # def setFontInfo(font, weight): # # For UFO3 names, see # https://github.com/unified-font-object/ufo-spec/blob/gh-pages/versions/ # ufo3/fontinfo.plist.md # For OpenType NAME table IDs, see # https://docs.microsoft.com/en-us/typography/opentype/spec/name#name-ids # Add " BETA" to light weights if weight < 400: font.info.styleName = font.info.styleName + " BETA" family = font.info.familyName # i.e. "Inter" style = font.info.styleName # e.g. "Medium Italic" # Update italicAngle isitalic = False if font.info.italicAngle != 0: isitalic = True font.info.italicAngle = float('%.8g' % font.info.italicAngle) else: font.info.italicAngle = 0 # avoid "-0.0" value in UFO # weight font.info.openTypeOS2WeightClass = weight # version (dummy) updateFontVersion(font, dummy=True) # Names family_nosp = re.sub(r'\s', '', family) style_nosp = re.sub(r'\s', '', style) font.info.macintoshFONDName = "%s %s" % (family_nosp, style_nosp) font.info.postscriptFontName = "%s-%s" % (family_nosp, style_nosp) # name ID 16 "Typographic Family name" font.info.openTypeNamePreferredFamilyName = family # name ID 17 "Typographic Subfamily name" font.info.openTypeNamePreferredSubfamilyName = style # name ID 1 "Family name" (legacy, but required) # Restriction: # "shared among at most four fonts that differ only in weight or style" # So we map as follows: # - Regular => "Family", ("regular" | "italic" | "bold" | "bold italic") # - Medium => "Family Medium", ("regular" | "italic") # - Black => "Family Black", ("regular" | "italic") # and so on. subfamily = stripItalic(style).strip() # "A Italic" => "A", "A" => "A" if len(subfamily) == 0: subfamily = "Regular" subfamily_lc = subfamily.lower() if subfamily_lc == "regular" or subfamily_lc == "bold": font.info.styleMapFamilyName = family # name ID 2 "Subfamily name" (legacy, but required) # Value must be one of: "regular", "italic", "bold", "bold italic" if subfamily_lc == "regular": if isitalic: font.info.styleMapStyleName = "italic" else: font.info.styleMapStyleName = "regular" else: # bold if isitalic: font.info.styleMapStyleName = "bold italic" else: font.info.styleMapStyleName = "bold" else: font.info.styleMapFamilyName = (family + ' ' + subfamily).strip() # name ID 2 "Subfamily name" (legacy, but required) if isitalic: font.info.styleMapStyleName = "italic" else: font.info.styleMapStyleName = "regular" class Main(object): def __init__(self): self.tmpdir = pjoin(BASEDIR,'build','tmp') self.quiet = False self.logLevelName = 'WARNING' def log(self, msg): if not self.quiet: print(msg) def main(self, argv): # make ^C instantly exit program signal.signal(signal.SIGINT, sighandler) argparser = argparse.ArgumentParser( description='', usage=''' %(prog)s [options] [] Commands: compile Build font files compile-var Build variable font files glyphsync Generate designspace and UFOs from Glyphs file instancegen Generate instance UFOs for designspace '''.strip().replace('\n ', '\n')) argparser.add_argument('-v', '--verbose', action='store_true', help='Print more details') argparser.add_argument('--debug', action='store_true', help='Print lots of details') argparser.add_argument('-q', '--quiet', action='store_true', help='Only print errors') argparser.add_argument('-C', metavar='', dest='chdir', help='Run as if %(prog)s started in instead of the '+\ 'current working directory.') argparser.add_argument('command', metavar='') # search past base arguments i = 1 while i < len(argv) and argv[i][0] == '-': i = i + 1 i = i + 1 # parse CLI arguments args = argparser.parse_args(argv[1:i]) logFormat = '%(funcName)s: %(message)s' if args.quiet: self.quiet = True if args.debug: fatal("--quiet and --debug are mutually exclusive arguments") if args.verbose: fatal("--quiet and --verbose are mutually exclusive arguments") elif args.debug: logging.basicConfig(level=logging.DEBUG, format=logFormat) self.logLevelName = 'DEBUG' elif args.verbose: logging.basicConfig(level=logging.INFO, format=logFormat) self.logLevelName = 'INFO' else: logFormat = '%(message)s' logging.basicConfig(level=logging.WARNING, format=logFormat) self.logLevelName = 'WARNING' if args.chdir: os.chdir(args.chdir) cmd = 'cmd_' + args.command.replace('-', '_') if not hasattr(self, cmd): fatal('Unrecognized command %s. Try --help' % args.command) getattr(self, cmd)(argv[i:]) def cmd_compile_var(self, argv): argparser = argparse.ArgumentParser( usage='%(prog)s compile-var [-h] [-o ] ', description='Compile variable font file') argparser.add_argument('srcfile', metavar='', help='Source file (.designspace file)') argparser.add_argument('-o', '--output', metavar='', help='Output font file') argparser.add_argument('--name', metavar='', help='Override family name, replacing "Inter"') args = argparser.parse_args(argv) # decide output filename (or check user-provided name) outfilename = args.output if outfilename is None or outfilename == '': outfilename = os.path.splitext(basename(args.srcfile))[0] + '.var.ttf' log.info('setting --output %r' % outfilename) else: outfileext = os.path.splitext(outfilename)[1] if outfileext.lower() != '.ttf': fatal('Invalid file extension %r (expected ".ttf")' % outfileext) mkdirs(dirname(outfilename)) # override family name? familyName = None if args.name is not None and len(args.name) > 0: familyName = args.name project = VarFontProject(verbose=self.logLevelName, familyName=familyName) project.run_from_designspace( args.srcfile, interpolate=False, masters_as_instances=False, use_production_names=True, round_instances=True, output_path=outfilename, output=['variable'], overlaps_backend='pathops', # use Skia's pathops ) self.log("write %s" % outfilename) # Note: we can't run ots-sanitize on the generated file as OTS # currently doesn't support variable fonts. def cmd_compile(self, argv): argparser = argparse.ArgumentParser( usage='%(prog)s compile [-h] [-o ] ', description='Compile font files') argparser.add_argument('srcfile', metavar='', help='Source file (.ufo file)') argparser.add_argument('-o', '--output', metavar='', help='Output font file (.otf, .ttf or .ufo)') argparser.add_argument('--validate', action='store_true', help='Enable ufoLib validation on reading/writing UFO files') args = argparser.parse_args(argv) ext_to_format = { '.ufo': 'ufo', '.otf': 'otf', '.ttf': 'ttf', # non-filename mapping targets: (kept for completeness) # 'ttf-interpolatable', # 'variable', } # decide output filename outfilename = args.output if outfilename is None or outfilename == '': outfilename = os.path.splitext(basename(args.srcfile))[0] + '.otf' log.info('setting --output %r' % outfilename) # build formats list from filename extension formats = [] # for outfilename in args.outputs: ext = os.path.splitext(outfilename)[1] ext_lc = ext.lower() if ext_lc in ext_to_format: formats.append(ext_to_format[ext_lc]) else: fatal('Unsupported output format %s' % ext) # temp file to write to tmpfilename = pjoin(self.tmpdir, basename(outfilename)) mkdirs(self.tmpdir) project = FontProject(verbose=self.logLevelName, validate_ufo=args.validate) ufo = Font(args.srcfile) updateFontVersion(ufo) # if outfile is a ufo, simply move it to outfilename instead # of running ots-sanitize. output_path = tmpfilename if formats[0] == 'ufo': output_path = outfilename # run fontmake to produce OTF/TTF file at tmpfilename project.run_from_ufos( [ ufo ], output_path=output_path, output=formats, use_production_names=True, optimize_cff=CFFOptimization.SUBROUTINIZE, # NONE overlaps_backend='pathops', # use Skia's pathops remove_overlaps=True, ) if output_path == tmpfilename: # Run ots-sanitize on produced OTF/TTF file and write sanitized version # to outfilename self._ots_sanitize(output_path, outfilename) def _ots_sanitize(self, tmpfilename, outfilename): # run through ots-sanitize # for filename in args.output: tmpfile = pjoin(self.tmpdir, tmpfilename) mkdirs(dirname(outfilename)) success = True try: self.log("write %s" % outfilename) otssan_res = subprocess.check_output( ['ots-sanitize', tmpfile, outfilename], # ['cp', tmpfile, outfilename], shell=False ).strip() # Note: ots-sanitize does not exit with an error in many cases where # it fails to sanitize the font. success = str(otssan_res).find('Failed') == -1 except: success = False if len(otssan_res) == 0: otssan_res = 'error' if success: os.unlink(tmpfile) else: fatal('ots-sanitize failed for %s: %s' % (tmpfile, otssan_res)) def _glyphsyncWriteUFO(self, font, weight, ufo_path): # fixup font info setFontInfo(font, weight) # cleanup lib lib = dict() for key, value in font.lib.items(): if key.startswith('com.schriftgestaltung'): continue if key == 'public.postscriptNames': continue lib[key] = value font.lib.clear() font.lib.update(lib) # remove all but the primary (default) layer layers = font.layers defaultLayer = layers.defaultLayer delLayerNames = set() for layer in layers: if layer != defaultLayer: delLayerNames.add(layer.name) for layerName in delLayerNames: del layers[layerName] # process glyphs stripGlyphs = [] glyphOrder = OrderedDict([(k,None) for k in font.lib['public.glyphOrder']]) componentRefs = font.componentReferences for g in font: if not g.lib.get('com.schriftgestaltung.Glyphs.Export', True): del glyphOrder[g.name] g.unicodes = [] if len(componentRefs.get(g.name, [])) == 0: # unused stripGlyphs.append(g.name) g.clearAnchors() del g.lib['com.schriftgestaltung.Glyphs.lastChange'] # update possibly modified glyphorder font.lib['public.glyphOrder'] = list(glyphOrder) # strip unused glyphs for gname in stripGlyphs: log.info( 'Strip unused and unexported glyph "%s" from %s', gname, ufo_path ) del font[gname] # write UFO file self.log("write %s" % relpath(ufo_path, os.getcwd())) font.save(ufo_path) def _genSubsetDesignSpace(self, designspace, tag, filename): ds = designspace italic = False if tag == 'italic': italic = True elif tag != 'upright': raise Exception('unexpected tag ' + tag) for a in ds.axes: if a.tag == "slnt": ds.axes.remove(a) break rmlist = [] hasDefault = not italic for source in designspace.sources: isitalic = source.name.find('italic') != -1 if italic != isitalic: rmlist.append(source) elif italic and not hasDefault: source.copyLib = True source.copyInfo = True source.copyGroups = True source.copyFeatures = True hasDefault = True for source in rmlist: designspace.sources.remove(source) rmlist = [] for instance in designspace.instances: isitalic = instance.name.find('italic') != -1 if italic != isitalic: rmlist.append(instance) for instance in rmlist: designspace.instances.remove(instance) self.log("write %s" % relpath(filename, os.getcwd())) ds.write(filename) def cmd_glyphsync(self, argv): argparser = argparse.ArgumentParser( usage='%(prog)s glyphsync [options]', description='Generates designspace and UFOs from Glyphs file') argparser.add_argument('glyphsfile', metavar='', help='Glyphs source file') argparser.add_argument('-o', '--outdir', metavar='', help='''Write output to . If omitted, designspace and UFOs are written to the directory of the glyphs file. '''.strip().replace('\n ', '')) args = argparser.parse_args(argv) outdir = args.outdir if outdir is None: outdir = dirname(args.glyphsfile) # files master_dir = outdir glyphsfile = args.glyphsfile designspace_file = pjoin(outdir, 'Inter.designspace') instance_dir = pjoin(BASEDIR, 'build', 'ufo') # load glyphs project file self.log("generating %s from %s" % ( relpath(designspace_file, os.getcwd()), relpath(glyphsfile, os.getcwd()) )) font = glyphsLib.GSFont(glyphsfile) # generate designspace from glyphs project designspace = glyphsLib.to_designspace( font, propagate_anchors=False, instance_dir=relpath(instance_dir, master_dir), store_editor_state=False, # do not store glyphs editor UI state in UFOs minimize_glyphs_diffs=True, # do not store glyphs metadata in UFOs ) # strip lib data designspace.lib.clear() # patch and write UFO files # TODO: Only write out-of-date UFOs procs = [] for source in designspace.sources: # source : fontTools.designspaceLib.SourceDescriptor # source.font : defcon.objects.font.Font ufo_path = pjoin(master_dir, source.filename) # no need to also set the relative 'filename' attribute as that # will be auto-updated on writing the designspace document if source.styleName == "Italic Italic": # Workaround for Glyphs limitation # (Base italic master can't be called just Italic, so it's called # "Italic Italic" which is converted here to just "Italic") ufo_path = pjoin(master_dir, 'Inter-Italic.ufo') source.styleName = "Italic" source.name = "italic" source.font.info.styleName = source.styleName elif source.styleName == "Black Italic Italic": ufo_path = pjoin(master_dir, 'Inter-BlackItalic.ufo') source.styleName = "Black Italic" source.name = "blackitalic" source.font.info.styleName = source.styleName elif source.styleName == "Thin Italic Italic": ufo_path = pjoin(master_dir, 'Inter-ThinItalic.ufo') source.styleName = "Thin Italic" source.name = "thinitalic" source.font.info.styleName = source.styleName else: # name "Black" => "black" source.name = source.styleName.lower().replace(' ', '') source.path = ufo_path weight = int(source.location['Weight']) p = Process( target=self._glyphsyncWriteUFO, args=(source.font, weight, ufo_path) ) p.start() procs.append(p) # patch instance names for instance in designspace.instances: # name "Black Italic" => "blackitalic" instance.name = instance.styleName.lower().replace(' ', '') self.log("write %s" % relpath(designspace_file, os.getcwd())) designspace.write(designspace_file) # upright designspace upright_designspace_file = pjoin(outdir, 'Inter-upright.designspace') p = Process( target=self._genSubsetDesignSpace, args=(designspace, 'upright', upright_designspace_file) ) p.start() procs.append(p) # italic designspace italic_designspace_file = pjoin(outdir, 'Inter-italic.designspace') p = Process( target=self._genSubsetDesignSpace, args=(designspace, 'italic', italic_designspace_file) ) p.start() procs.append(p) for p in procs: p.join() def cmd_instancegen(self, argv): argparser = argparse.ArgumentParser( description='Generate UFO instances from designspace') argparser.add_argument('designspacefile', metavar='', help='Designspace file') argparser.add_argument('instances', metavar='', nargs='*', help='Style instances to generate. Omit to generate all.') args = argparser.parse_args(argv) instances = set([s.lower() for s in args.instances]) all_instances = len(instances) == 0 # files designspace_file = args.designspacefile instance_dir = pjoin(BASEDIR, 'build', 'ufo') # DesignSpaceDocumentReader generates UFOs gen = DesignSpaceDocumentReader( designspace_file, ufoVersion=3, roundGeometry=True, verbose=True ) designspace = designspaceLib.DesignSpaceDocument() designspace.read(designspace_file) # Generate UFOs for instances instance_weight = dict() instance_files = set() for instance in designspace.instances: if all_instances or instance.name in instances: filebase = basename(instance.filename) relname = relpath( pjoin(dirname(designspace_file), instance.filename), os.getcwd() ) self.log('generating %s' % relname) gen.readInstance(("name", instance.name)) instance_files.add(instance.filename) instance_weight[filebase] = int(instance.location['Weight']) if not all_instances: instances.remove(instance.name) if len(instances) > 0: fatal('unknown style(s): %s' % ', '.join(list(instances))) ufos = apply_instance_data(designspace_file, instance_files) # patch ufos (list of defcon.Font instances) italicAngleKey = 'com.schriftgestaltung.customParameter.' +\ 'InstanceDescriptorAsGSInstance.italicAngle' for font in ufos: # move italicAngle from lib to info italicAngle = font.lib.get(italicAngleKey) if italicAngle != None: italicAngle = float(italicAngle) del font.lib[italicAngleKey] font.info.italicAngle = italicAngle # clear anchors for g in font: g.clearAnchors() # update font info weight = instance_weight[basename(font.path)] setFontInfo(font, weight) font.save() def checkfont(self, fontfile, q): res, ok = execproc('ots-idempotent', fontfile) # Note: ots-idempotent does not exit with an error in many cases where # it fails to sanitize the font, so we look at its output to determine # success or failure. if not ok or res.find('Failed') != -1: log.error('%s: checkfont ots-idempotent: %s' % (fontfile, res)) q.put(False) return res, ok = execproc('ots-validator-checker', fontfile) if not ok or res.find("didn't crash") == -1: log.error('%s: checkfont ots-validator-checker: %s' % (fontfile, res)) q.put(False) return # ok q.put(True) def cmd_checkfont(self, argv): argparser = argparse.ArgumentParser( usage='%(prog)s checkfont ...', description='Verify integrity of font files') argparser.add_argument('files', metavar='', nargs='+', help='Font files') args = argparser.parse_args(argv) q = Queue() if len(args.files) < 2: self.checkfont(args.files[0], q) else: procs = [] for fontfile in args.files: p = Process(target=self.checkfont, args=(fontfile, q)) p.start() procs.append(p) for p in procs: p.join() for fontfile in args.files: if not q.get(): sys.exit(1) if __name__ == '__main__': Main().main(sys.argv)