Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 1 | # Copyright 2013 Google, Inc. All Rights Reserved. |
| 2 | # |
Roozbeh Pournader | 47bee9c | 2013-12-18 00:45:12 -0800 | [diff] [blame] | 3 | # Google Author(s): Behdad Esfahbod, Roozbeh Pournader |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 4 | |
| 5 | """Font merger. |
| 6 | """ |
| 7 | |
Behdad Esfahbod | f63e80e | 2013-12-18 17:14:26 -0500 | [diff] [blame] | 8 | from __future__ import print_function, division |
| 9 | from fontTools.misc.py23 import * |
| 10 | from fontTools import ttLib, cffLib |
Roozbeh Pournader | e219c6c | 2013-12-18 12:15:46 -0800 | [diff] [blame] | 11 | from fontTools.ttLib.tables import otTables, _h_e_a_d |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 12 | from fontTools.ttLib.tables.DefaultTable import DefaultTable |
Behdad Esfahbod | f63e80e | 2013-12-18 17:14:26 -0500 | [diff] [blame] | 13 | from functools import reduce |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 14 | import sys |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 15 | import time |
Behdad Esfahbod | 49028b3 | 2013-12-18 17:34:17 -0500 | [diff] [blame] | 16 | import operator |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 17 | |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 18 | |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 19 | def _add_method(*clazzes, **kwargs): |
Behdad Esfahbod | c855f3a | 2013-09-19 20:09:23 -0400 | [diff] [blame] | 20 | """Returns a decorator function that adds a new method to one or |
| 21 | more classes.""" |
Behdad Esfahbod | c68c0ff | 2013-12-19 14:19:23 -0500 | [diff] [blame] | 22 | allowDefault = kwargs.get('allowDefaultTable', False) |
Behdad Esfahbod | c855f3a | 2013-09-19 20:09:23 -0400 | [diff] [blame] | 23 | def wrapper(method): |
| 24 | for clazz in clazzes: |
Behdad Esfahbod | c68c0ff | 2013-12-19 14:19:23 -0500 | [diff] [blame] | 25 | if not allowDefault: |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 26 | assert clazz != DefaultTable, 'Oops, table class not found.' |
| 27 | assert method.__name__ not in clazz.__dict__, \ |
Behdad Esfahbod | c855f3a | 2013-09-19 20:09:23 -0400 | [diff] [blame] | 28 | "Oops, class '%s' has method '%s'." % (clazz.__name__, |
Behdad Esfahbod | f63e80e | 2013-12-18 17:14:26 -0500 | [diff] [blame] | 29 | method.__name__) |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 30 | setattr(clazz, method.__name__, method) |
Behdad Esfahbod | c855f3a | 2013-09-19 20:09:23 -0400 | [diff] [blame] | 31 | return None |
| 32 | return wrapper |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 33 | |
Roozbeh Pournader | 47bee9c | 2013-12-18 00:45:12 -0800 | [diff] [blame] | 34 | # General utility functions for merging values from different fonts |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 35 | |
Behdad Esfahbod | 49028b3 | 2013-12-18 17:34:17 -0500 | [diff] [blame] | 36 | def equal(lst): |
| 37 | t = iter(lst) |
| 38 | first = next(t) |
| 39 | assert all(item == first for item in t) |
Roozbeh Pournader | e219c6c | 2013-12-18 12:15:46 -0800 | [diff] [blame] | 40 | return first |
Roozbeh Pournader | 47bee9c | 2013-12-18 00:45:12 -0800 | [diff] [blame] | 41 | |
| 42 | def first(lst): |
Behdad Esfahbod | 49028b3 | 2013-12-18 17:34:17 -0500 | [diff] [blame] | 43 | return next(iter(lst)) |
Roozbeh Pournader | 47bee9c | 2013-12-18 00:45:12 -0800 | [diff] [blame] | 44 | |
Roozbeh Pournader | e219c6c | 2013-12-18 12:15:46 -0800 | [diff] [blame] | 45 | def recalculate(lst): |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 46 | return NotImplemented |
Roozbeh Pournader | e219c6c | 2013-12-18 12:15:46 -0800 | [diff] [blame] | 47 | |
| 48 | def current_time(lst): |
Behdad Esfahbod | 49028b3 | 2013-12-18 17:34:17 -0500 | [diff] [blame] | 49 | return int(time.time() - _h_e_a_d.mac_epoch_diff) |
Roozbeh Pournader | e219c6c | 2013-12-18 12:15:46 -0800 | [diff] [blame] | 50 | |
| 51 | def bitwise_or(lst): |
Behdad Esfahbod | 49028b3 | 2013-12-18 17:34:17 -0500 | [diff] [blame] | 52 | return reduce(operator.or_, lst) |
Roozbeh Pournader | e219c6c | 2013-12-18 12:15:46 -0800 | [diff] [blame] | 53 | |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 54 | def avg_int(lst): |
| 55 | lst = list(lst) |
| 56 | return sum(lst) // len(lst) |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 57 | |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 58 | def nonnone(func): |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 59 | """Returns a filter func that when called with a list, |
| 60 | only calls func on the non-None items of the list, and |
| 61 | only so if there's at least one non-None item in the |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 62 | list. Otherwise returns None.""" |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 63 | |
| 64 | def wrapper(lst): |
| 65 | items = [item for item in lst if item is not None] |
| 66 | return func(items) if items else None |
| 67 | |
| 68 | return wrapper |
| 69 | |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 70 | def implemented(func): |
| 71 | """Returns a filter func that when called with a list, |
| 72 | only calls func on the non-NotImplemented items of the list, |
| 73 | and only so if there's at least one item remaining. |
| 74 | Otherwise returns NotImplemented.""" |
| 75 | |
| 76 | def wrapper(lst): |
| 77 | items = [item for item in lst if item is not NotImplemented] |
| 78 | return func(items) if items else NotImplemented |
| 79 | |
| 80 | return wrapper |
| 81 | |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 82 | def sumLists(lst): |
| 83 | l = [] |
| 84 | for item in lst: |
| 85 | l.extend(item) |
| 86 | return l |
| 87 | |
| 88 | def sumDicts(lst): |
| 89 | d = {} |
| 90 | for item in lst: |
| 91 | d.update(item) |
| 92 | return d |
| 93 | |
Behdad Esfahbod | 12dd547 | 2013-12-19 05:58:06 -0500 | [diff] [blame] | 94 | def mergeObjects(lst): |
| 95 | lst = [item for item in lst if item is not None and item is not NotImplemented] |
| 96 | if not lst: |
| 97 | return None # Not all can be NotImplemented |
| 98 | |
| 99 | clazz = lst[0].__class__ |
| 100 | assert all(type(item) == clazz for item in lst), lst |
| 101 | logic = clazz.mergeMap |
| 102 | returnTable = clazz() |
| 103 | |
| 104 | allKeys = set.union(set(), *(vars(table).keys() for table in lst)) |
| 105 | for key in allKeys: |
| 106 | try: |
| 107 | mergeLogic = logic[key] |
| 108 | except KeyError: |
| 109 | try: |
| 110 | mergeLogic = logic['*'] |
| 111 | except KeyError: |
| 112 | raise Exception("Don't know how to merge key %s of class %s" % |
| 113 | (key, clazz.__name__)) |
| 114 | if mergeLogic is NotImplemented: |
| 115 | continue |
| 116 | value = mergeLogic(getattr(table, key, NotImplemented) for table in lst) |
| 117 | if value is not NotImplemented: |
| 118 | setattr(returnTable, key, value) |
| 119 | |
| 120 | return returnTable |
| 121 | |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 122 | |
| 123 | @_add_method(DefaultTable, allowDefaultTable=True) |
Behdad Esfahbod | 3b36f55 | 2013-12-19 04:45:17 -0500 | [diff] [blame] | 124 | def merge(self, m, tables): |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 125 | if not hasattr(self, 'mergeMap'): |
| 126 | m.log("Don't know how to merge '%s'." % self.tableTag) |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 127 | return NotImplemented |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 128 | |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 129 | return m.mergeObjects(self, self.mergeMap, tables) |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 130 | |
| 131 | ttLib.getTableClass('maxp').mergeMap = { |
| 132 | '*': max, |
| 133 | 'tableTag': equal, |
| 134 | 'tableVersion': equal, |
| 135 | 'numGlyphs': sum, |
| 136 | 'maxStorage': max, # FIXME: may need to be changed to sum |
| 137 | 'maxFunctionDefs': sum, |
| 138 | 'maxInstructionDefs': sum, |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 139 | # TODO When we correctly merge hinting data, update these values: |
| 140 | # maxFunctionDefs, maxInstructionDefs, maxSizeOfInstructions |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 141 | } |
Behdad Esfahbod | 65f19d8 | 2013-09-18 21:02:41 -0400 | [diff] [blame] | 142 | |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 143 | ttLib.getTableClass('head').mergeMap = { |
| 144 | 'tableTag': equal, |
| 145 | 'tableVersion': max, |
| 146 | 'fontRevision': max, |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 147 | 'checkSumAdjustment': lambda lst: 0, # We need *something* here |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 148 | 'magicNumber': equal, |
| 149 | 'flags': first, # FIXME: replace with bit-sensitive code |
| 150 | 'unitsPerEm': equal, |
| 151 | 'created': current_time, |
| 152 | 'modified': current_time, |
| 153 | 'xMin': min, |
| 154 | 'yMin': min, |
| 155 | 'xMax': max, |
| 156 | 'yMax': max, |
| 157 | 'macStyle': first, |
| 158 | 'lowestRecPPEM': max, |
| 159 | 'fontDirectionHint': lambda lst: 2, |
| 160 | 'indexToLocFormat': recalculate, |
| 161 | 'glyphDataFormat': equal, |
| 162 | } |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 163 | |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 164 | ttLib.getTableClass('hhea').mergeMap = { |
| 165 | '*': equal, |
| 166 | 'tableTag': equal, |
| 167 | 'tableVersion': max, |
| 168 | 'ascent': max, |
| 169 | 'descent': min, |
| 170 | 'lineGap': max, |
| 171 | 'advanceWidthMax': max, |
| 172 | 'minLeftSideBearing': min, |
| 173 | 'minRightSideBearing': min, |
| 174 | 'xMaxExtent': max, |
| 175 | 'caretSlopeRise': first, # FIXME |
| 176 | 'caretSlopeRun': first, # FIXME |
| 177 | 'caretOffset': first, # FIXME |
| 178 | 'numberOfHMetrics': recalculate, |
| 179 | } |
Behdad Esfahbod | 65f19d8 | 2013-09-18 21:02:41 -0400 | [diff] [blame] | 180 | |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 181 | ttLib.getTableClass('OS/2').mergeMap = { |
| 182 | '*': first, |
| 183 | 'tableTag': equal, |
| 184 | 'version': max, |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 185 | 'xAvgCharWidth': avg_int, # Apparently fontTools doesn't recalc this |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 186 | 'fsType': first, # FIXME |
| 187 | 'panose': first, # FIXME? |
| 188 | 'ulUnicodeRange1': bitwise_or, |
| 189 | 'ulUnicodeRange2': bitwise_or, |
| 190 | 'ulUnicodeRange3': bitwise_or, |
| 191 | 'ulUnicodeRange4': bitwise_or, |
| 192 | 'fsFirstCharIndex': min, |
| 193 | 'fsLastCharIndex': max, |
| 194 | 'sTypoAscender': max, |
| 195 | 'sTypoDescender': min, |
| 196 | 'sTypoLineGap': max, |
| 197 | 'usWinAscent': max, |
| 198 | 'usWinDescent': max, |
| 199 | 'ulCodePageRange1': bitwise_or, |
| 200 | 'ulCodePageRange2': bitwise_or, |
| 201 | 'usMaxContex': max, |
Behdad Esfahbod | db2410a | 2013-12-19 03:30:29 -0500 | [diff] [blame] | 202 | # TODO version 5 |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 203 | } |
Behdad Esfahbod | 71294de | 2013-09-19 19:43:17 -0400 | [diff] [blame] | 204 | |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 205 | ttLib.getTableClass('post').mergeMap = { |
| 206 | '*': first, |
| 207 | 'tableTag': equal, |
| 208 | 'formatType': max, |
| 209 | 'isFixedPitch': min, |
| 210 | 'minMemType42': max, |
| 211 | 'maxMemType42': lambda lst: 0, |
| 212 | 'minMemType1': max, |
| 213 | 'maxMemType1': lambda lst: 0, |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 214 | 'mapping': implemented(sumDicts), |
Behdad Esfahbod | c68c0ff | 2013-12-19 14:19:23 -0500 | [diff] [blame] | 215 | 'extraNames': lambda lst: [], |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 216 | } |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 217 | |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 218 | ttLib.getTableClass('vmtx').mergeMap = ttLib.getTableClass('hmtx').mergeMap = { |
| 219 | 'tableTag': equal, |
| 220 | 'metrics': sumDicts, |
| 221 | } |
Behdad Esfahbod | 65f19d8 | 2013-09-18 21:02:41 -0400 | [diff] [blame] | 222 | |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 223 | ttLib.getTableClass('loca').mergeMap = { |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 224 | '*': recalculate, |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 225 | 'tableTag': equal, |
| 226 | } |
| 227 | |
| 228 | ttLib.getTableClass('glyf').mergeMap = { |
| 229 | 'tableTag': equal, |
| 230 | 'glyphs': sumDicts, |
| 231 | 'glyphOrder': sumLists, |
| 232 | } |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 233 | |
Behdad Esfahbod | be4ecc7 | 2013-09-19 20:37:01 -0400 | [diff] [blame] | 234 | @_add_method(ttLib.getTableClass('glyf')) |
Behdad Esfahbod | 3b36f55 | 2013-12-19 04:45:17 -0500 | [diff] [blame] | 235 | def merge(self, m, tables): |
| 236 | for table in tables: |
Behdad Esfahbod | 4365033 | 2013-09-20 16:33:33 -0400 | [diff] [blame] | 237 | for g in table.glyphs.values(): |
| 238 | # Drop hints for now, since we don't remap |
| 239 | # functions / CVT values. |
| 240 | g.removeHinting() |
| 241 | # Expand composite glyphs to load their |
| 242 | # composite glyph names. |
| 243 | if g.isComposite(): |
| 244 | g.expand(table) |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 245 | return DefaultTable.merge(self, m, tables) |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 246 | |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 247 | ttLib.getTableClass('prep').mergeMap = NotImplemented |
| 248 | ttLib.getTableClass('fpgm').mergeMap = NotImplemented |
| 249 | ttLib.getTableClass('cvt ').mergeMap = NotImplemented |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 250 | |
Behdad Esfahbod | be4ecc7 | 2013-09-19 20:37:01 -0400 | [diff] [blame] | 251 | @_add_method(ttLib.getTableClass('cmap')) |
Behdad Esfahbod | 3b36f55 | 2013-12-19 04:45:17 -0500 | [diff] [blame] | 252 | def merge(self, m, tables): |
Behdad Esfahbod | 71294de | 2013-09-19 19:43:17 -0400 | [diff] [blame] | 253 | # TODO Handle format=14. |
Behdad Esfahbod | 3b36f55 | 2013-12-19 04:45:17 -0500 | [diff] [blame] | 254 | cmapTables = [t for table in tables for t in table.tables |
Behdad Esfahbod | 71294de | 2013-09-19 19:43:17 -0400 | [diff] [blame] | 255 | if t.platformID == 3 and t.platEncID in [1, 10]] |
| 256 | # TODO Better handle format-4 and format-12 coexisting in same font. |
| 257 | # TODO Insert both a format-4 and format-12 if needed. |
Behdad Esfahbod | be4ecc7 | 2013-09-19 20:37:01 -0400 | [diff] [blame] | 258 | module = ttLib.getTableModule('cmap') |
Behdad Esfahbod | 71294de | 2013-09-19 19:43:17 -0400 | [diff] [blame] | 259 | assert all(t.format in [4, 12] for t in cmapTables) |
| 260 | format = max(t.format for t in cmapTables) |
| 261 | cmapTable = module.cmap_classes[format](format) |
| 262 | cmapTable.cmap = {} |
| 263 | cmapTable.platformID = 3 |
| 264 | cmapTable.platEncID = max(t.platEncID for t in cmapTables) |
| 265 | cmapTable.language = 0 |
| 266 | for table in cmapTables: |
| 267 | # TODO handle duplicates. |
| 268 | cmapTable.cmap.update(table.cmap) |
| 269 | self.tableVersion = 0 |
| 270 | self.tables = [cmapTable] |
| 271 | self.numSubTables = len(self.tables) |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 272 | return self |
Behdad Esfahbod | 71294de | 2013-09-19 19:43:17 -0400 | [diff] [blame] | 273 | |
Behdad Esfahbod | c14ab48 | 2013-09-19 21:22:54 -0400 | [diff] [blame] | 274 | |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 275 | otTables.ScriptList.mergeMap = { |
| 276 | 'ScriptCount': sum, |
| 277 | 'ScriptRecord': sumLists, |
| 278 | } |
| 279 | |
| 280 | otTables.FeatureList.mergeMap = { |
| 281 | 'FeatureCount': sum, |
| 282 | 'FeatureRecord': sumLists, |
| 283 | } |
| 284 | |
| 285 | otTables.LookupList.mergeMap = { |
| 286 | 'LookupCount': sum, |
| 287 | 'Lookup': sumLists, |
| 288 | } |
| 289 | |
Behdad Esfahbod | 12dd547 | 2013-12-19 05:58:06 -0500 | [diff] [blame] | 290 | otTables.Coverage.mergeMap = { |
| 291 | 'glyphs': sumLists, |
| 292 | } |
Behdad Esfahbod | c14ab48 | 2013-09-19 21:22:54 -0400 | [diff] [blame] | 293 | |
Behdad Esfahbod | 12dd547 | 2013-12-19 05:58:06 -0500 | [diff] [blame] | 294 | otTables.ClassDef.mergeMap = { |
| 295 | 'classDefs': sumDicts, |
| 296 | } |
Behdad Esfahbod | c14ab48 | 2013-09-19 21:22:54 -0400 | [diff] [blame] | 297 | |
Behdad Esfahbod | 12dd547 | 2013-12-19 05:58:06 -0500 | [diff] [blame] | 298 | otTables.LigCaretList.mergeMap = { |
| 299 | 'Coverage': mergeObjects, |
| 300 | 'LigGlyphCount': sum, |
| 301 | 'LigGlyph': sumLists, |
| 302 | } |
Behdad Esfahbod | c14ab48 | 2013-09-19 21:22:54 -0400 | [diff] [blame] | 303 | |
Behdad Esfahbod | 12dd547 | 2013-12-19 05:58:06 -0500 | [diff] [blame] | 304 | otTables.AttachList.mergeMap = { |
| 305 | 'Coverage': mergeObjects, |
| 306 | 'GlyphCount': sum, |
| 307 | 'AttachPoint': sumLists, |
| 308 | } |
Behdad Esfahbod | c14ab48 | 2013-09-19 21:22:54 -0400 | [diff] [blame] | 309 | |
Behdad Esfahbod | 12dd547 | 2013-12-19 05:58:06 -0500 | [diff] [blame] | 310 | # XXX Renumber MarkFilterSets of lookups |
| 311 | otTables.MarkGlyphSetsDef.mergeMap = { |
| 312 | 'MarkSetTableFormat': equal, |
| 313 | 'MarkSetCount': sum, |
| 314 | 'Coverage': sumLists, |
| 315 | } |
Behdad Esfahbod | c14ab48 | 2013-09-19 21:22:54 -0400 | [diff] [blame] | 316 | |
Behdad Esfahbod | 12dd547 | 2013-12-19 05:58:06 -0500 | [diff] [blame] | 317 | otTables.GDEF.mergeMap = { |
| 318 | '*': mergeObjects, |
| 319 | 'Version': max, |
| 320 | } |
| 321 | |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 322 | otTables.GSUB.mergeMap = otTables.GPOS.mergeMap = { |
| 323 | '*': mergeObjects, |
Behdad Esfahbod | 12dd547 | 2013-12-19 05:58:06 -0500 | [diff] [blame] | 324 | 'Version': max, |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 325 | } |
| 326 | |
| 327 | ttLib.getTableClass('GDEF').mergeMap = \ |
| 328 | ttLib.getTableClass('GSUB').mergeMap = \ |
| 329 | ttLib.getTableClass('GPOS').mergeMap = \ |
| 330 | ttLib.getTableClass('BASE').mergeMap = \ |
| 331 | ttLib.getTableClass('JSTF').mergeMap = \ |
| 332 | ttLib.getTableClass('MATH').mergeMap = \ |
| 333 | { |
| 334 | 'tableTag': equal, |
Behdad Esfahbod | 12dd547 | 2013-12-19 05:58:06 -0500 | [diff] [blame] | 335 | 'table': mergeObjects, |
| 336 | } |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 337 | |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 338 | |
| 339 | @_add_method(otTables.Feature) |
| 340 | def mapLookups(self, lookupMap): |
| 341 | self.LookupListIndex = [lookupMap[i] for i in self.LookupListIndex] |
| 342 | |
| 343 | @_add_method(otTables.FeatureList) |
| 344 | def mapLookups(self, lookupMap): |
| 345 | for f in self.FeatureRecord: |
| 346 | if not f or not f.Feature: continue |
| 347 | f.Feature.mapLookups(lookupMap) |
| 348 | |
| 349 | @_add_method(otTables.DefaultLangSys, |
| 350 | otTables.LangSys) |
| 351 | def mapFeatures(self, featureMap): |
| 352 | self.FeatureIndex = [featureMap[i] for i in self.FeatureIndex] |
| 353 | if self.ReqFeatureIndex != 65535: |
| 354 | self.ReqFeatureIndex = featureMap[self.ReqFeatureIndex] |
| 355 | |
| 356 | @_add_method(otTables.Script) |
| 357 | def mapFeatures(self, featureMap): |
| 358 | if self.DefaultLangSys: |
| 359 | self.DefaultLangSys.mapFeatures(featureMap) |
| 360 | for l in self.LangSysRecord: |
| 361 | if not l or not l.LangSys: continue |
| 362 | l.LangSys.mapFeatures(featureMap) |
| 363 | |
| 364 | @_add_method(otTables.ScriptList) |
Behdad Esfahbod | 398770d | 2013-12-19 15:30:24 -0500 | [diff] [blame^] | 365 | def mapFeatures(self, featureMap): |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 366 | for s in self.ScriptRecord: |
| 367 | if not s or not s.Script: continue |
| 368 | s.Script.mapFeatures(featureMap) |
| 369 | |
| 370 | |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 371 | class Options(object): |
| 372 | |
| 373 | class UnknownOptionError(Exception): |
| 374 | pass |
| 375 | |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 376 | def __init__(self, **kwargs): |
| 377 | |
| 378 | self.set(**kwargs) |
| 379 | |
| 380 | def set(self, **kwargs): |
Behdad Esfahbod | f63e80e | 2013-12-18 17:14:26 -0500 | [diff] [blame] | 381 | for k,v in kwargs.items(): |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 382 | if not hasattr(self, k): |
| 383 | raise self.UnknownOptionError("Unknown option '%s'" % k) |
| 384 | setattr(self, k, v) |
| 385 | |
| 386 | def parse_opts(self, argv, ignore_unknown=False): |
| 387 | ret = [] |
| 388 | opts = {} |
| 389 | for a in argv: |
| 390 | orig_a = a |
| 391 | if not a.startswith('--'): |
| 392 | ret.append(a) |
| 393 | continue |
| 394 | a = a[2:] |
| 395 | i = a.find('=') |
| 396 | op = '=' |
| 397 | if i == -1: |
| 398 | if a.startswith("no-"): |
| 399 | k = a[3:] |
| 400 | v = False |
| 401 | else: |
| 402 | k = a |
| 403 | v = True |
| 404 | else: |
| 405 | k = a[:i] |
| 406 | if k[-1] in "-+": |
| 407 | op = k[-1]+'=' # Ops is '-=' or '+=' now. |
| 408 | k = k[:-1] |
| 409 | v = a[i+1:] |
| 410 | k = k.replace('-', '_') |
| 411 | if not hasattr(self, k): |
| 412 | if ignore_unknown == True or k in ignore_unknown: |
| 413 | ret.append(orig_a) |
| 414 | continue |
| 415 | else: |
| 416 | raise self.UnknownOptionError("Unknown option '%s'" % a) |
| 417 | |
| 418 | ov = getattr(self, k) |
| 419 | if isinstance(ov, bool): |
| 420 | v = bool(v) |
| 421 | elif isinstance(ov, int): |
| 422 | v = int(v) |
| 423 | elif isinstance(ov, list): |
| 424 | vv = v.split(',') |
| 425 | if vv == ['']: |
| 426 | vv = [] |
| 427 | vv = [int(x, 0) if len(x) and x[0] in "0123456789" else x for x in vv] |
| 428 | if op == '=': |
| 429 | v = vv |
| 430 | elif op == '+=': |
| 431 | v = ov |
| 432 | v.extend(vv) |
| 433 | elif op == '-=': |
| 434 | v = ov |
| 435 | for x in vv: |
| 436 | if x in v: |
| 437 | v.remove(x) |
| 438 | else: |
| 439 | assert 0 |
| 440 | |
| 441 | opts[k] = v |
| 442 | self.set(**opts) |
| 443 | |
| 444 | return ret |
| 445 | |
| 446 | |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 447 | class Merger(object): |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 448 | |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 449 | def __init__(self, options=None, log=None): |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 450 | |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 451 | if not log: |
| 452 | log = Logger() |
| 453 | if not options: |
| 454 | options = Options() |
| 455 | |
| 456 | self.options = options |
| 457 | self.log = log |
| 458 | |
| 459 | def merge(self, fontfiles): |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 460 | |
| 461 | mega = ttLib.TTFont() |
| 462 | |
| 463 | # |
| 464 | # Settle on a mega glyph order. |
| 465 | # |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 466 | fonts = [ttLib.TTFont(fontfile) for fontfile in fontfiles] |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 467 | glyphOrders = [font.getGlyphOrder() for font in fonts] |
| 468 | megaGlyphOrder = self._mergeGlyphOrders(glyphOrders) |
| 469 | # Reload fonts and set new glyph names on them. |
| 470 | # TODO Is it necessary to reload font? I think it is. At least |
| 471 | # it's safer, in case tables were loaded to provide glyph names. |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 472 | fonts = [ttLib.TTFont(fontfile) for fontfile in fontfiles] |
Behdad Esfahbod | 3235a04 | 2013-09-19 20:57:33 -0400 | [diff] [blame] | 473 | for font,glyphOrder in zip(fonts, glyphOrders): |
| 474 | font.setGlyphOrder(glyphOrder) |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 475 | mega.setGlyphOrder(megaGlyphOrder) |
| 476 | |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 477 | for font in fonts: |
| 478 | self._preMerge(font) |
| 479 | |
Behdad Esfahbod | f63e80e | 2013-12-18 17:14:26 -0500 | [diff] [blame] | 480 | allTags = reduce(set.union, (list(font.keys()) for font in fonts), set()) |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 481 | allTags.remove('GlyphOrder') |
| 482 | for tag in allTags: |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 483 | |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 484 | clazz = ttLib.getTableClass(tag) |
| 485 | |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 486 | tables = [font.get(tag, NotImplemented) for font in fonts] |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 487 | table = clazz(tag).merge(self, tables) |
| 488 | if table is not NotImplemented and table is not False: |
Behdad Esfahbod | 65f19d8 | 2013-09-18 21:02:41 -0400 | [diff] [blame] | 489 | mega[tag] = table |
Behdad Esfahbod | b640f74 | 2013-09-19 20:12:56 -0400 | [diff] [blame] | 490 | self.log("Merged '%s'." % tag) |
Behdad Esfahbod | 65f19d8 | 2013-09-18 21:02:41 -0400 | [diff] [blame] | 491 | else: |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 492 | self.log("Dropped '%s'." % tag) |
Behdad Esfahbod | b640f74 | 2013-09-19 20:12:56 -0400 | [diff] [blame] | 493 | self.log.lapse("merge '%s'" % tag) |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 494 | |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 495 | self._postMerge(mega) |
| 496 | |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 497 | return mega |
| 498 | |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 499 | def _mergeGlyphOrders(self, glyphOrders): |
Behdad Esfahbod | c2e27fd | 2013-09-20 16:25:48 -0400 | [diff] [blame] | 500 | """Modifies passed-in glyphOrders to reflect new glyph names. |
| 501 | Returns glyphOrder for the merged font.""" |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 502 | # Simply append font index to the glyph name for now. |
Behdad Esfahbod | c2e27fd | 2013-09-20 16:25:48 -0400 | [diff] [blame] | 503 | # TODO Even this simplistic numbering can result in conflicts. |
| 504 | # But then again, we have to improve this soon anyway. |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 505 | mega = [] |
| 506 | for n,glyphOrder in enumerate(glyphOrders): |
| 507 | for i,glyphName in enumerate(glyphOrder): |
Behdad Esfahbod | f63e80e | 2013-12-18 17:14:26 -0500 | [diff] [blame] | 508 | glyphName += "#" + repr(n) |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 509 | glyphOrder[i] = glyphName |
| 510 | mega.append(glyphName) |
| 511 | return mega |
| 512 | |
Behdad Esfahbod | 6baf26e | 2013-12-19 04:47:34 -0500 | [diff] [blame] | 513 | def mergeObjects(self, returnTable, logic, tables): |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 514 | # Right now we don't use self at all. Will use in the future |
| 515 | # for options and logging. |
| 516 | |
| 517 | if logic is NotImplemented: |
| 518 | return NotImplemented |
| 519 | |
| 520 | allKeys = set.union(set(), *(vars(table).keys() for table in tables if table is not NotImplemented)) |
Roozbeh Pournader | 47bee9c | 2013-12-18 00:45:12 -0800 | [diff] [blame] | 521 | for key in allKeys: |
Roozbeh Pournader | e219c6c | 2013-12-18 12:15:46 -0800 | [diff] [blame] | 522 | try: |
Behdad Esfahbod | 6baf26e | 2013-12-19 04:47:34 -0500 | [diff] [blame] | 523 | mergeLogic = logic[key] |
Roozbeh Pournader | e219c6c | 2013-12-18 12:15:46 -0800 | [diff] [blame] | 524 | except KeyError: |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 525 | try: |
Behdad Esfahbod | 6baf26e | 2013-12-19 04:47:34 -0500 | [diff] [blame] | 526 | mergeLogic = logic['*'] |
Behdad Esfahbod | 9e6adb6 | 2013-12-19 04:20:26 -0500 | [diff] [blame] | 527 | except KeyError: |
Behdad Esfahbod | 6baf26e | 2013-12-19 04:47:34 -0500 | [diff] [blame] | 528 | raise Exception("Don't know how to merge key %s of class %s" % |
| 529 | (key, returnTable.__class__.__name__)) |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 530 | if mergeLogic is NotImplemented: |
Roozbeh Pournader | e219c6c | 2013-12-18 12:15:46 -0800 | [diff] [blame] | 531 | continue |
Behdad Esfahbod | 92fd566 | 2013-12-19 04:56:50 -0500 | [diff] [blame] | 532 | value = mergeLogic(getattr(table, key, NotImplemented) for table in tables) |
| 533 | if value is not NotImplemented: |
| 534 | setattr(returnTable, key, value) |
| 535 | |
| 536 | return returnTable |
Roozbeh Pournader | 47bee9c | 2013-12-18 00:45:12 -0800 | [diff] [blame] | 537 | |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 538 | def _preMerge(self, font): |
| 539 | |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 540 | GDEF = font.get('GDEF') |
| 541 | GSUB = font.get('GSUB') |
| 542 | GPOS = font.get('GPOS') |
| 543 | |
| 544 | for t in [GSUB, GPOS]: |
Behdad Esfahbod | 398770d | 2013-12-19 15:30:24 -0500 | [diff] [blame^] | 545 | if not t: continue |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 546 | |
Behdad Esfahbod | 398770d | 2013-12-19 15:30:24 -0500 | [diff] [blame^] | 547 | if t.table.LookupList and t.table.FeatureList: |
| 548 | lookupMap = dict(enumerate(t.table.LookupList.Lookup)) |
| 549 | t.table.FeatureList.mapLookups(lookupMap) |
| 550 | |
| 551 | if t.table.FeatureList and t.table.ScriptList: |
| 552 | featureMap = dict(enumerate(t.table.FeatureList.FeatureRecord)) |
| 553 | t.table.ScriptList.mapFeatures(featureMap) |
| 554 | |
| 555 | # TODO GDEF/Lookup MarkFilteringSets |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 556 | # TODO FeatureParams nameIDs |
| 557 | |
| 558 | def _postMerge(self, font): |
Behdad Esfahbod | 398770d | 2013-12-19 15:30:24 -0500 | [diff] [blame^] | 559 | |
| 560 | GDEF = font.get('GDEF') |
| 561 | GSUB = font.get('GSUB') |
| 562 | GPOS = font.get('GPOS') |
| 563 | |
| 564 | for t in [GSUB, GPOS]: |
| 565 | if not t: continue |
| 566 | |
| 567 | if t.table.LookupList and t.table.FeatureList: |
| 568 | lookupMap = dict((v,i) for i,v in enumerate(t.table.LookupList.Lookup)) |
| 569 | t.table.FeatureList.mapLookups(lookupMap) |
| 570 | |
| 571 | if t.table.FeatureList and t.table.ScriptList: |
| 572 | featureMap = dict((v,i) for i,v in enumerate(t.table.FeatureList.FeatureRecord)) |
| 573 | t.table.ScriptList.mapFeatures(featureMap) |
| 574 | |
| 575 | # TODO GDEF/Lookup MarkFilteringSets |
| 576 | # TODO FeatureParams nameIDs |
Behdad Esfahbod | 2642934 | 2013-12-19 11:53:47 -0500 | [diff] [blame] | 577 | |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 578 | |
| 579 | class Logger(object): |
| 580 | |
| 581 | def __init__(self, verbose=False, xml=False, timing=False): |
| 582 | self.verbose = verbose |
| 583 | self.xml = xml |
| 584 | self.timing = timing |
| 585 | self.last_time = self.start_time = time.time() |
| 586 | |
| 587 | def parse_opts(self, argv): |
| 588 | argv = argv[:] |
| 589 | for v in ['verbose', 'xml', 'timing']: |
| 590 | if "--"+v in argv: |
| 591 | setattr(self, v, True) |
| 592 | argv.remove("--"+v) |
| 593 | return argv |
| 594 | |
| 595 | def __call__(self, *things): |
| 596 | if not self.verbose: |
| 597 | return |
Behdad Esfahbod | f63e80e | 2013-12-18 17:14:26 -0500 | [diff] [blame] | 598 | print(' '.join(str(x) for x in things)) |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 599 | |
| 600 | def lapse(self, *things): |
| 601 | if not self.timing: |
| 602 | return |
| 603 | new_time = time.time() |
Behdad Esfahbod | f63e80e | 2013-12-18 17:14:26 -0500 | [diff] [blame] | 604 | print("Took %0.3fs to %s" %(new_time - self.last_time, |
| 605 | ' '.join(str(x) for x in things))) |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 606 | self.last_time = new_time |
| 607 | |
| 608 | def font(self, font, file=sys.stdout): |
| 609 | if not self.xml: |
| 610 | return |
| 611 | from fontTools.misc import xmlWriter |
| 612 | writer = xmlWriter.XMLWriter(file) |
| 613 | font.disassembleInstructions = False # Work around ttLib bug |
| 614 | for tag in font.keys(): |
| 615 | writer.begintag(tag) |
| 616 | writer.newline() |
| 617 | font[tag].toXML(writer, font) |
| 618 | writer.endtag(tag) |
| 619 | writer.newline() |
| 620 | |
| 621 | |
| 622 | __all__ = [ |
| 623 | 'Options', |
| 624 | 'Merger', |
| 625 | 'Logger', |
| 626 | 'main' |
| 627 | ] |
| 628 | |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 629 | def main(args): |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 630 | |
| 631 | log = Logger() |
| 632 | args = log.parse_opts(args) |
| 633 | |
| 634 | options = Options() |
| 635 | args = options.parse_opts(args) |
| 636 | |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 637 | if len(args) < 1: |
Behdad Esfahbod | f63e80e | 2013-12-18 17:14:26 -0500 | [diff] [blame] | 638 | print("usage: pyftmerge font...", file=sys.stderr) |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 639 | sys.exit(1) |
Behdad Esfahbod | f2d5982 | 2013-09-19 16:16:39 -0400 | [diff] [blame] | 640 | |
| 641 | merger = Merger(options=options, log=log) |
| 642 | font = merger.merge(args) |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 643 | outfile = 'merged.ttf' |
| 644 | font.save(outfile) |
Behdad Esfahbod | b640f74 | 2013-09-19 20:12:56 -0400 | [diff] [blame] | 645 | log.lapse("compile and save font") |
| 646 | |
| 647 | log.last_time = log.start_time |
| 648 | log.lapse("make one with everything(TOTAL TIME)") |
Behdad Esfahbod | 45d2f38 | 2013-09-18 20:47:53 -0400 | [diff] [blame] | 649 | |
| 650 | if __name__ == "__main__": |
| 651 | main(sys.argv[1:]) |