blob: a79d008e0e52274811ebdb5112a78c37e3d75297 [file] [log] [blame]
Behdad Esfahbod54660612013-07-21 18:16:55 -04001#!/usr/bin/python
2
3# Python OpenType Layout Subsetter
Behdad Esfahbod4aa6ce32013-07-22 12:15:36 -04004# Written by: Behdad Esfahbod
Behdad Esfahbod54660612013-07-21 18:16:55 -04005
6import fontTools.ttx
Behdad Esfahbod54660612013-07-21 18:16:55 -04007
Behdad Esfahbod54660612013-07-21 18:16:55 -04008
Behdad Esfahbod02b92062013-07-21 18:40:59 -04009def add_method (*clazzes):
Behdad Esfahbod54660612013-07-21 18:16:55 -040010 def wrapper(method):
Behdad Esfahbod02b92062013-07-21 18:40:59 -040011 for clazz in clazzes:
12 setattr (clazz, method.func_name, method)
Behdad Esfahbod54660612013-07-21 18:16:55 -040013 return wrapper
14
Behdad Esfahbod78661bb2013-07-23 10:23:42 -040015def unique_sorted (l):
16 return sorted ({v:1 for v in l}.keys ())
17
18
Behdad Esfahbod54660612013-07-21 18:16:55 -040019# Subset
Behdad Esfahbod54660612013-07-21 18:16:55 -040020
21@add_method(fontTools.ttLib.tables.otTables.Coverage)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040022def subset_glyphs (self, glyphs):
Behdad Esfahbodd821ea02013-07-23 10:50:43 -040023 "Returns ascending list of remaining coverage values."
Behdad Esfahbod54660612013-07-21 18:16:55 -040024 indices = [i for (i,g) in enumerate (self.glyphs) if g in glyphs]
25 self.glyphs = [g for g in self.glyphs if g in glyphs]
26 return indices
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -040027
Behdad Esfahbod54660612013-07-21 18:16:55 -040028@add_method(fontTools.ttLib.tables.otTables.ClassDef)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040029def subset_glyphs (self, glyphs):
Behdad Esfahbod4aa6ce32013-07-22 12:15:36 -040030 "Returns ascending list of remaining classes."
Behdad Esfahbod54660612013-07-21 18:16:55 -040031 self.classDefs = {g:v for g,v in self.classDefs.items() if g in glyphs}
Behdad Esfahbod78661bb2013-07-23 10:23:42 -040032 return unique_sorted (self.classDefs.values ())
Behdad Esfahbod4aa6ce32013-07-22 12:15:36 -040033
34@add_method(fontTools.ttLib.tables.otTables.ClassDef)
35def remap (self, class_map):
36 "Remaps classes."
37 self.classDefs = {g:class_map.index (v) for g,v in self.classDefs.items()}
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -040038
Behdad Esfahbod54660612013-07-21 18:16:55 -040039@add_method(fontTools.ttLib.tables.otTables.SingleSubst)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040040def subset_glyphs (self, glyphs):
Behdad Esfahbod54660612013-07-21 18:16:55 -040041 if self.Format in [1, 2]:
42 self.mapping = {g:v for g,v in self.mapping.items() if g in glyphs}
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -040043 return len (self.mapping)
Behdad Esfahbod54660612013-07-21 18:16:55 -040044 else:
45 assert 0, "unknown format: %s" % self.Format
46
47@add_method(fontTools.ttLib.tables.otTables.MultipleSubst)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040048def subset_glyphs (self, glyphs):
Behdad Esfahbod54660612013-07-21 18:16:55 -040049 if self.Format == 1:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040050 indices = self.Coverage.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -040051 self.Sequence = [self.Sequence[i] for i in indices]
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -040052 self.SequenceCount = len (self.Sequence)
53 return self.SequenceCount
Behdad Esfahbod54660612013-07-21 18:16:55 -040054 else:
55 assert 0, "unknown format: %s" % self.Format
56
57@add_method(fontTools.ttLib.tables.otTables.AlternateSubst)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040058def subset_glyphs (self, glyphs):
Behdad Esfahbod54660612013-07-21 18:16:55 -040059 if self.Format == 1:
60 self.alternates = {g:v for g,v in self.alternates.items() if g in glyphs}
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -040061 return len (self.alternates)
Behdad Esfahbod54660612013-07-21 18:16:55 -040062 else:
63 assert 0, "unknown format: %s" % self.Format
64
65@add_method(fontTools.ttLib.tables.otTables.LigatureSubst)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040066def subset_glyphs (self, glyphs):
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -040067 if self.Format == 1:
68 self.ligatures = {g:v for g,v in self.ligatures.items() if g in glyphs}
69 self.ligatures = {g:[seq for seq in seqs if all(c in glyphs for c in seq.Component)]
70 for g,seqs in self.ligatures.items()}
71 self.ligatures = {g:v for g,v in self.ligatures.items() if v}
72 return len (self.ligatures)
73 else:
74 assert 0, "unknown format: %s" % self.Format
Behdad Esfahbod54660612013-07-21 18:16:55 -040075
Behdad Esfahbod54660612013-07-21 18:16:55 -040076@add_method(fontTools.ttLib.tables.otTables.ReverseChainSingleSubst)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040077def subset_glyphs (self, glyphs):
Behdad Esfahbod54660612013-07-21 18:16:55 -040078 if self.Format == 1:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040079 indices = self.Coverage.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -040080 self.Substitute = [self.Substitute[i] for i in indices]
81 self.GlyphCount = len (self.Substitute)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040082 return self.GlyphCount and all (c.subset_glyphs (glyphs) for c in self.LookAheadCoverage + self.BacktrackCoverage)
Behdad Esfahbod54660612013-07-21 18:16:55 -040083 else:
84 assert 0, "unknown format: %s" % self.Format
85
86@add_method(fontTools.ttLib.tables.otTables.SinglePos)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040087def subset_glyphs (self, glyphs):
Behdad Esfahbod54660612013-07-21 18:16:55 -040088 if self.Format == 1:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040089 return len (self.Coverage.subset_glyphs (glyphs))
Behdad Esfahbod54660612013-07-21 18:16:55 -040090 elif self.Format == 2:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040091 indices = self.Coverage.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -040092 self.Value = [self.Value[i] for i in indices]
93 self.ValueCount = len (self.Value)
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -040094 return self.ValueCount
Behdad Esfahbod54660612013-07-21 18:16:55 -040095 else:
96 assert 0, "unknown format: %s" % self.Format
97
98@add_method(fontTools.ttLib.tables.otTables.PairPos)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -040099def subset_glyphs (self, glyphs):
Behdad Esfahbod54660612013-07-21 18:16:55 -0400100 if self.Format == 1:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400101 indices = self.Coverage.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -0400102 self.PairSet = [self.PairSet[i] for i in indices]
103 for p in self.PairSet:
104 p.PairValueRecord = [r for r in p.PairValueRecord if r.SecondGlyph in glyphs]
105 p.PairValueCount = len (p.PairValueRecord)
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -0400106 self.PairSet = [p for p in self.PairSet if p.PairValueCount]
Behdad Esfahbod54660612013-07-21 18:16:55 -0400107 self.PairSetCount = len (self.PairSet)
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -0400108 return self.PairSetCount
Behdad Esfahbod54660612013-07-21 18:16:55 -0400109 elif self.Format == 2:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400110 self.Coverage.subset_glyphs (glyphs)
111 class1_map = self.ClassDef1.subset_glyphs (glyphs)
112 class2_map = self.ClassDef2.subset_glyphs (glyphs)
Behdad Esfahbod4aa6ce32013-07-22 12:15:36 -0400113 self.ClassDef1.remap (class1_map)
114 self.ClassDef2.remap (class2_map)
115 self.Class1Record = [self.Class1Record[i] for i in class1_map]
116 for c in self.Class1Record:
117 c.Class2Record = [c.Class2Record[i] for i in class2_map]
118 self.Class1Count = len (class1_map)
119 self.Class2Count = len (class2_map)
120 return self.Coverage and self.Class1Count and self.Class2Count
Behdad Esfahbod54660612013-07-21 18:16:55 -0400121 else:
122 assert 0, "unknown format: %s" % self.Format
123
124@add_method(fontTools.ttLib.tables.otTables.CursivePos)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400125def subset_glyphs (self, glyphs):
Behdad Esfahbod54660612013-07-21 18:16:55 -0400126 if self.Format == 1:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400127 indices = self.Coverage.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -0400128 self.EntryExitRecord = [self.EntryExitRecord[i] for i in indices]
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -0400129 self.EntryExitCount = len (self.EntryExitRecord)
130 return self.EntryExitCount
Behdad Esfahbod54660612013-07-21 18:16:55 -0400131 else:
132 assert 0, "unknown format: %s" % self.Format
133
134@add_method(fontTools.ttLib.tables.otTables.MarkBasePos)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400135def subset_glyphs (self, glyphs):
Behdad Esfahbod54660612013-07-21 18:16:55 -0400136 if self.Format == 1:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400137 mark_indices = self.MarkCoverage.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -0400138 self.MarkArray.MarkRecord = [self.MarkArray.MarkRecord[i] for i in mark_indices]
139 self.MarkArray.MarkCount = len (self.MarkArray.MarkRecord)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400140 base_indices = self.BaseCoverage.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -0400141 self.BaseArray.BaseRecord = [self.BaseArray.BaseRecord[i] for i in base_indices]
142 self.BaseArray.BaseCount = len (self.BaseArray.BaseRecord)
Behdad Esfahbodc6396b72013-07-22 12:31:33 -0400143 # Prune empty classes
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400144 class_indices = unique_sorted (v.Class for v in self.MarkArray.MarkRecord)
Behdad Esfahbodc6396b72013-07-22 12:31:33 -0400145 self.ClassCount = len (class_indices)
146 for m in self.MarkArray.MarkRecord:
147 m.Class = class_indices.index (m.Class)
148 for b in self.BaseArray.BaseRecord:
149 b.BaseAnchor = [b.BaseAnchor[i] for i in class_indices]
150 return self.ClassCount and self.MarkArray.MarkCount and self.BaseArray.BaseCount
Behdad Esfahbod54660612013-07-21 18:16:55 -0400151 else:
152 assert 0, "unknown format: %s" % self.Format
153
154@add_method(fontTools.ttLib.tables.otTables.MarkLigPos)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400155def subset_glyphs (self, glyphs):
Behdad Esfahbod54660612013-07-21 18:16:55 -0400156 if self.Format == 1:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400157 mark_indices = self.MarkCoverage.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -0400158 self.MarkArray.MarkRecord = [self.MarkArray.MarkRecord[i] for i in mark_indices]
159 self.MarkArray.MarkCount = len (self.MarkArray.MarkRecord)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400160 ligature_indices = self.LigatureCoverage.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -0400161 self.LigatureArray.LigatureAttach = [self.LigatureArray.LigatureAttach[i] for i in ligature_indices]
162 self.LigatureArray.LigatureCount = len (self.LigatureArray.LigatureAttach)
Behdad Esfahbodc6396b72013-07-22 12:31:33 -0400163 # Prune empty classes
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400164 class_indices = unique_sorted (v.Class for v in self.MarkArray.MarkRecord)
Behdad Esfahbodc6396b72013-07-22 12:31:33 -0400165 self.ClassCount = len (class_indices)
166 for m in self.MarkArray.MarkRecord:
167 m.Class = class_indices.index (m.Class)
168 for l in self.LigatureArray.LigatureAttach:
169 for c in l.ComponentRecord:
170 c.LigatureAnchor = [c.LigatureAnchor[i] for i in class_indices]
171 return self.ClassCount and self.MarkArray.MarkCount and self.LigatureArray.LigatureCount
Behdad Esfahbod54660612013-07-21 18:16:55 -0400172 else:
173 assert 0, "unknown format: %s" % self.Format
174
175@add_method(fontTools.ttLib.tables.otTables.MarkMarkPos)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400176def subset_glyphs (self, glyphs):
Behdad Esfahbod54660612013-07-21 18:16:55 -0400177 if self.Format == 1:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400178 mark1_indices = self.Mark1Coverage.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -0400179 self.Mark1Array.MarkRecord = [self.Mark1Array.MarkRecord[i] for i in mark1_indices]
180 self.Mark1Array.MarkCount = len (self.Mark1Array.MarkRecord)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400181 mark2_indices = self.Mark2Coverage.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -0400182 self.Mark2Array.Mark2Record = [self.Mark2Array.Mark2Record[i] for i in mark2_indices]
183 self.Mark2Array.MarkCount = len (self.Mark2Array.Mark2Record)
Behdad Esfahbodc6396b72013-07-22 12:31:33 -0400184 # Prune empty classes
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400185 class_indices = unique_sorted (v.Class for v in self.Mark1Array.MarkRecord)
Behdad Esfahbodc6396b72013-07-22 12:31:33 -0400186 self.ClassCount = len (class_indices)
187 for m in self.Mark1Array.MarkRecord:
188 m.Class = class_indices.index (m.Class)
189 for b in self.Mark2Array.Mark2Record:
190 b.Mark2Anchor = [b.Mark2Anchor[i] for i in class_indices]
191 return self.ClassCount and self.Mark1Array.MarkCount and self.Mark2Array.MarkCount
Behdad Esfahbod54660612013-07-21 18:16:55 -0400192 else:
193 assert 0, "unknown format: %s" % self.Format
194
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400195@add_method(fontTools.ttLib.tables.otTables.SingleSubst,
196 fontTools.ttLib.tables.otTables.MultipleSubst,
197 fontTools.ttLib.tables.otTables.AlternateSubst,
198 fontTools.ttLib.tables.otTables.LigatureSubst,
199 fontTools.ttLib.tables.otTables.ReverseChainSingleSubst,
200 fontTools.ttLib.tables.otTables.SinglePos,
201 fontTools.ttLib.tables.otTables.PairPos,
202 fontTools.ttLib.tables.otTables.CursivePos,
203 fontTools.ttLib.tables.otTables.MarkBasePos,
204 fontTools.ttLib.tables.otTables.MarkLigPos,
205 fontTools.ttLib.tables.otTables.MarkMarkPos)
206def subset_lookups (self, lookup_indices):
207 pass
208
209@add_method(fontTools.ttLib.tables.otTables.SingleSubst,
210 fontTools.ttLib.tables.otTables.MultipleSubst,
211 fontTools.ttLib.tables.otTables.AlternateSubst,
212 fontTools.ttLib.tables.otTables.LigatureSubst,
213 fontTools.ttLib.tables.otTables.ReverseChainSingleSubst,
214 fontTools.ttLib.tables.otTables.SinglePos,
215 fontTools.ttLib.tables.otTables.PairPos,
216 fontTools.ttLib.tables.otTables.CursivePos,
217 fontTools.ttLib.tables.otTables.MarkBasePos,
218 fontTools.ttLib.tables.otTables.MarkLigPos,
219 fontTools.ttLib.tables.otTables.MarkMarkPos)
220def collect_lookups (self):
221 return []
222
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400223@add_method(fontTools.ttLib.tables.otTables.ContextSubst, fontTools.ttLib.tables.otTables.ContextPos)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400224def subset_glyphs (self, glyphs):
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400225 if self.Format == 1:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400226 indices = self.Coverage.subset_glyphs (glyphs)
Behdad Esfahbodb7fef902013-07-21 22:48:08 -0400227 self.SubRuleSet = [self.SubRuleSet[i] for i in indices]
228 self.SubRuleSetCount = len (self.SubRuleSet)
229 for rs in self.SubRuleSet:
230 rs.SubRule = [r for r in rs.SubRule
231 if all (g in glyphs for g in r.Input)]
232 rs.SubRuleCount = len (rs.SubRule)
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -0400233 # Prune empty subrulesets
234 return self.SubRuleSetCount
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400235 elif self.Format == 2:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400236 return self.Coverage.subset_glyphs (glyphs) and self.ClassDef.subset_glyphs (glyphs)
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400237 elif self.Format == 3:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400238 return all (c.subset_glyphs (glyphs) for c in self.Coverage)
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400239 else:
240 assert 0, "unknown format: %s" % self.Format
Behdad Esfahbod54660612013-07-21 18:16:55 -0400241
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400242@add_method(fontTools.ttLib.tables.otTables.ChainContextSubst, fontTools.ttLib.tables.otTables.ChainContextPos)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400243def subset_glyphs (self, glyphs):
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400244 if self.Format == 1:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400245 indices = self.Coverage.subset_glyphs (glyphs)
Behdad Esfahbodb7fef902013-07-21 22:48:08 -0400246 self.ChainSubRuleSet = [self.ChainSubRuleSet[i] for i in indices]
247 self.ChainSubRuleSetCount = len (self.ChainSubRuleSet)
248 for rs in self.ChainSubRuleSet:
249 rs.ChainSubRule = [r for r in rs.ChainSubRule
250 if all (g in glyphs for g in r.Backtrack + r.Input + r.LookAhead)]
251 rs.ChainSubRuleCount = len (rs.ChainSubRule)
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -0400252 # Prune empty subrulesets
253 return self.ChainSubRuleSetCount
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400254 elif self.Format == 2:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400255 return self.Coverage.subset_glyphs (glyphs) and \
256 self.LookAheadClassDef.subset_glyphs (glyphs) and \
257 self.BacktrackClassDef.subset_glyphs (glyphs) and \
258 self.InputClassDef.subset_glyphs (glyphs)
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400259 elif self.Format == 3:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400260 return all (c.subset_glyphs (glyphs) for c in self.InputCoverage + self.LookAheadCoverage + self.BacktrackCoverage)
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400261 else:
262 assert 0, "unknown format: %s" % self.Format
Behdad Esfahbod54660612013-07-21 18:16:55 -0400263
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400264@add_method(fontTools.ttLib.tables.otTables.ContextSubst, fontTools.ttLib.tables.otTables.ContextPos,
265 fontTools.ttLib.tables.otTables.ChainContextSubst, fontTools.ttLib.tables.otTables.ChainContextPos)
266def subset_lookups (self, lookup_indices):
267 self.SubstLookupRecord = [ll for ll in self.SubstLookupRecord if ll.LookupListIndex in lookup_indices]
268 for ll in self.SubstLookupRecord:
269 ll.LookupListIndex = lookup_indices.index (ll.LookupListIndex)
270
271@add_method(fontTools.ttLib.tables.otTables.ContextSubst, fontTools.ttLib.tables.otTables.ContextPos,
272 fontTools.ttLib.tables.otTables.ChainContextSubst, fontTools.ttLib.tables.otTables.ChainContextPos)
273def collect_lookups (self):
274 return [ll.LookupListIndex for ll in self.SubstLookupRecord]
275
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400276@add_method(fontTools.ttLib.tables.otTables.ExtensionSubst, fontTools.ttLib.tables.otTables.ExtensionPos)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400277def subset_glyphs (self, glyphs):
Behdad Esfahbod54660612013-07-21 18:16:55 -0400278 if self.Format == 1:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400279 return self.ExtSubTable.subset_glyphs (glyphs)
Behdad Esfahbod54660612013-07-21 18:16:55 -0400280 else:
281 assert 0, "unknown format: %s" % self.Format
282
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400283@add_method(fontTools.ttLib.tables.otTables.ExtensionSubst, fontTools.ttLib.tables.otTables.ExtensionPos)
284def subset_lookups (self, lookup_indices):
285 if self.Format == 1:
286 return self.ExtSubTable.subset_lookups (lookup_indices)
287 else:
288 assert 0, "unknown format: %s" % self.Format
289
290@add_method(fontTools.ttLib.tables.otTables.ExtensionSubst, fontTools.ttLib.tables.otTables.ExtensionPos)
291def collect_lookups (self):
292 if self.Format == 1:
293 return self.ExtSubTable.collect_lookups ()
294 else:
295 assert 0, "unknown format: %s" % self.Format
296
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400297@add_method(fontTools.ttLib.tables.otTables.Lookup)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400298def subset_glyphs (self, glyphs):
299 self.SubTable = [s for s in self.SubTable if s.subset_glyphs (glyphs)]
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -0400300 self.SubTableCount = len (self.SubTable)
301 return self.SubTableCount
302
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400303@add_method(fontTools.ttLib.tables.otTables.Lookup)
304def subset_lookups (self, lookup_indices):
305 for s in self.SubTable:
306 s.subset_lookups (lookup_indices)
307
308@add_method(fontTools.ttLib.tables.otTables.Lookup)
309def collect_lookups (self):
310 return unique_sorted (sum ((s.collect_lookups () for s in self.SubTable), []))
311
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -0400312@add_method(fontTools.ttLib.tables.otTables.LookupList)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400313def subset_glyphs (self, glyphs):
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400314 "Returns the indices of nonempty lookups."
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400315 return [i for (i,l) in enumerate (self.Lookup) if l.subset_glyphs (glyphs)]
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400316
317@add_method(fontTools.ttLib.tables.otTables.LookupList)
318def subset_lookups (self, lookup_indices):
319 self.Lookup = [self.Lookup[i] for i in lookup_indices]
320 self.LookupCount = len (self.Lookup)
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400321 for l in self.Lookup:
322 l.subset_lookups (lookup_indices)
323
324@add_method(fontTools.ttLib.tables.otTables.LookupList)
325def closure_lookups (self, lookup_indices):
326 while True:
327 recurse_lookups = sum ((self.Lookup[i].collect_lookups () for i in lookup_indices), [])
328 recurse_lookups = [l for l in recurse_lookups if l not in lookup_indices]
329 if not recurse_lookups:
330 return lookup_indices
331 lookup_indices = unique_sorted (lookup_indices + recurse_lookups)
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400332
333@add_method(fontTools.ttLib.tables.otTables.Feature)
334def subset_lookups (self, lookup_indices):
335 self.LookupListIndex = [l for l in self.LookupListIndex if l in lookup_indices]
336 # Now map them.
337 self.LookupListIndex = [lookup_indices.index (l) for l in self.LookupListIndex]
338 self.LookupCount = len (self.LookupListIndex)
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -0400339 return self.LookupCount
Behdad Esfahbod54660612013-07-21 18:16:55 -0400340
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400341@add_method(fontTools.ttLib.tables.otTables.Feature)
342def collect_lookups (self):
343 return self.LookupListIndex[:]
344
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400345@add_method(fontTools.ttLib.tables.otTables.FeatureList)
346def subset_lookups (self, lookup_indices):
347 "Returns the indices of nonempty features."
348 feature_indices = [i for (i,f) in enumerate (self.FeatureRecord) if f.Feature.subset_lookups (lookup_indices)]
349 self.FeatureRecord = [self.FeatureRecord[i] for i in feature_indices]
350 self.FeatureCount = len (self.FeatureRecord)
351 return feature_indices
352
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400353@add_method(fontTools.ttLib.tables.otTables.FeatureList)
354def collect_lookups (self, feature_indices):
355 return unique_sorted (sum ((self.FeatureRecord[i].Feature.collect_lookups () for i in feature_indices
356 if i < self.FeatureCount), []))
357
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400358@add_method(fontTools.ttLib.tables.otTables.DefaultLangSys, fontTools.ttLib.tables.otTables.LangSys)
359def subset_features (self, feature_indices):
Behdad Esfahbod69ce1502013-07-22 18:00:31 -0400360 if self.ReqFeatureIndex in feature_indices:
361 self.ReqFeatureIndex = feature_indices.index (self.ReqFeatureIndex)
362 else:
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400363 self.ReqFeatureIndex = 65535
364 self.FeatureIndex = [f for f in self.FeatureIndex if f in feature_indices]
Behdad Esfahbod69ce1502013-07-22 18:00:31 -0400365 # Now map them.
366 self.FeatureIndex = [feature_indices.index (f) for f in self.FeatureIndex if f in feature_indices]
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400367 self.FeatureCount = len (self.FeatureIndex)
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400368 return self.FeatureCount or self.ReqFeatureIndex != 65535
369
370@add_method(fontTools.ttLib.tables.otTables.DefaultLangSys, fontTools.ttLib.tables.otTables.LangSys)
371def collect_features (self):
372 feature_indices = self.FeatureIndex[:]
373 if self.ReqFeatureIndex != 65535:
374 feature_indices.append (self.ReqFeatureIndex)
375 return unique_sorted (feature_indices)
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400376
377@add_method(fontTools.ttLib.tables.otTables.Script)
378def subset_features (self, feature_indices):
379 if self.DefaultLangSys and not self.DefaultLangSys.subset_features (feature_indices):
380 self.DefaultLangSys = None
381 self.LangSysRecord = [l for l in self.LangSysRecord if l.LangSys.subset_features (feature_indices)]
382 self.LangSysCount = len (self.LangSysRecord)
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400383 return self.LangSysCount or self.DefaultLangSys
384
385@add_method(fontTools.ttLib.tables.otTables.Script)
386def collect_features (self):
387 feature_indices = [l.LangSys.collectFeatures () for l in self.LangSysRecord]
388 if self.DefaultLangSys:
389 feature_indices.append (self.DefaultLangSys.collect_features ())
390 return unique_sorted (sum (feature_indices, []))
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400391
392@add_method(fontTools.ttLib.tables.otTables.ScriptList)
393def subset_features (self, feature_indices):
394 self.ScriptRecord = [s for s in self.ScriptRecord if s.Script.subset_features (feature_indices)]
395 self.ScriptCount = len (self.ScriptRecord)
396 return self.ScriptCount
397
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400398@add_method(fontTools.ttLib.tables.otTables.ScriptList)
399def collect_features (self):
400 return unique_sorted (sum ((s.Script.collect_features () for s in self.ScriptRecord), []))
401
Behdad Esfahbodfd3923e2013-07-22 12:48:17 -0400402@add_method(fontTools.ttLib.getTableClass('GSUB'), fontTools.ttLib.getTableClass('GPOS'))
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400403def subset_glyphs (self, glyphs):
404 lookup_indices = self.table.LookupList.subset_glyphs (glyphs)
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400405 self.subset_lookups (lookup_indices)
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400406 self.prune_lookups ()
407 return True
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400408
Behdad Esfahbodfd3923e2013-07-22 12:48:17 -0400409@add_method(fontTools.ttLib.getTableClass('GSUB'), fontTools.ttLib.getTableClass('GPOS'))
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400410def subset_lookups (self, lookup_indices):
411 "Retrains specified lookups, then removes empty features, language systems, and scripts."
Behdad Esfahbodfd3923e2013-07-22 12:48:17 -0400412 self.table.LookupList.subset_lookups (lookup_indices)
413 feature_indices = self.table.FeatureList.subset_lookups (lookup_indices)
414 self.table.ScriptList.subset_features (feature_indices)
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400415
Behdad Esfahbod78661bb2013-07-23 10:23:42 -0400416@add_method(fontTools.ttLib.getTableClass('GSUB'), fontTools.ttLib.getTableClass('GPOS'))
417def prune_lookups (self):
418 "Remove unreferenced lookups"
419 feature_indices = self.table.ScriptList.collect_features ()
420 lookup_indices = self.table.FeatureList.collect_lookups (feature_indices)
421 lookup_indices = self.table.LookupList.closure_lookups (lookup_indices)
422 self.subset_lookups (lookup_indices)
423
Behdad Esfahbodfd3923e2013-07-22 12:48:17 -0400424@add_method(fontTools.ttLib.getTableClass('GDEF'))
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400425def subset_glyphs (self, glyphs):
Behdad Esfahbodfd3923e2013-07-22 12:48:17 -0400426 table = self.table
427 if table.LigCaretList:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400428 indices = table.LigCaretList.Coverage.subset_glyphs (glyphs)
Behdad Esfahbodfd3923e2013-07-22 12:48:17 -0400429 table.LigCaretList.LigGlyph = [table.LigCaretList.LigGlyph[i] for i in indices]
430 table.LigCaretList.LigGlyphCount = len (table.LigCaretList.LigGlyph)
431 if not table.LigCaretList.LigGlyphCount:
432 table.LigCaretList = None
433 if table.MarkAttachClassDef:
434 table.MarkAttachClassDef.classDefs = {g:v for g,v in table.MarkAttachClassDef.classDefs.items() if g in glyphs}
435 if not table.MarkAttachClassDef.classDefs:
436 table.MarkAttachClassDef = None
437 if table.GlyphClassDef:
438 table.GlyphClassDef.classDefs = {g:v for g,v in table.GlyphClassDef.classDefs.items() if g in glyphs}
439 if not table.GlyphClassDef.classDefs:
440 table.GlyphClassDef = None
441 if table.AttachList:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400442 indices = table.AttachList.Coverage.subset_glyphs (glyphs)
Behdad Esfahbodfd3923e2013-07-22 12:48:17 -0400443 table.AttachList.AttachPoint = [table.AttachList.AttachPoint[i] for i in indices]
444 table.AttachList.GlyphCount = len (table.AttachList.AttachPoint)
445 if not table.AttachList.GlyphCount:
446 table.AttachList = None
447 return table.LigCaretList or table.MarkAttachClassDef or table.GlyphClassDef or table.AttachList
Behdad Esfahbodefb984a2013-07-21 22:26:16 -0400448
Behdad Esfahbodfd3923e2013-07-22 12:48:17 -0400449@add_method(fontTools.ttLib.getTableClass('kern'))
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400450def subset_glyphs (self, glyphs):
Behdad Esfahbod5270ec42013-07-22 12:57:02 -0400451 for t in self.kernTables:
452 t.kernTable = {(a,b):v for ((a,b),v) in t.kernTable.items() if a in glyphs and b in glyphs}
453 self.kernTables = [t for t in self.kernTables if t.kernTable]
454 return self.kernTables
Behdad Esfahbodefb984a2013-07-21 22:26:16 -0400455
Behdad Esfahbod75e14fc2013-07-22 14:49:54 -0400456@add_method(fontTools.ttLib.getTableClass('hmtx'), fontTools.ttLib.getTableClass('vmtx'))
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400457def subset_glyphs (self, glyphs):
Behdad Esfahbodc7160442013-07-22 14:29:08 -0400458 self.metrics = {g:v for (g,v) in self.metrics.items() if g in glyphs}
459 return len (self.metrics)
460
Behdad Esfahbod75e14fc2013-07-22 14:49:54 -0400461@add_method(fontTools.ttLib.getTableClass('hdmx'))
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400462def subset_glyphs (self, glyphs):
Behdad Esfahbod75e14fc2013-07-22 14:49:54 -0400463 self.hdmx = {s:{g:v for (g,v) in l.items() if g in glyphs} for (s,l) in self.hdmx.items()}
464
Behdad Esfahbode45d6af2013-07-22 15:29:17 -0400465@add_method(fontTools.ttLib.getTableClass('VORG'))
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400466def subset_glyphs (self, glyphs):
Behdad Esfahbode45d6af2013-07-22 15:29:17 -0400467 self.VOriginRecords = {g:v for (g,v) in self.VOriginRecords.items() if g in glyphs}
468 self.numVertOriginYMetrics = len (self.VOriginRecords)
469 return True # Never drop; has default metrics
470
Behdad Esfahbod8c646f62013-07-22 15:06:23 -0400471@add_method(fontTools.ttLib.getTableClass('post'))
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400472def subset_glyphs (self, glyphs):
Behdad Esfahbod209eb412013-07-22 18:54:36 -0400473 # Drop names
474 # TODO Add option for this.
475 self.extraNames = []
Behdad Esfahbodc9dec9d2013-07-23 10:28:47 -0400476 return True
Behdad Esfahbod653e9742013-07-22 15:17:12 -0400477
Behdad Esfahbod861d9152013-07-22 16:47:24 -0400478@add_method(fontTools.ttLib.getTableClass('glyf'))
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400479def subset_glyphs (self, glyphs):
Behdad Esfahbod861d9152013-07-22 16:47:24 -0400480 self.glyphs = {g:v for (g,v) in self.glyphs.items() if g in glyphs}
481 self.glyphOrder = [g for g in self.glyphOrder if g in glyphs]
482 return len (self.glyphs)
483
Behdad Esfahbod63a576c2013-07-22 18:52:46 -0400484@add_method(fontTools.ttLib.getTableClass('name'))
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400485def subset_glyphs (self, glyphs):
Behdad Esfahbod63a576c2013-07-22 18:52:46 -0400486 # TODO Make sure something remains?
487 # TODO Add option for this.
488 # TODO Drop even more (license, etc)? / Drop completely?
489 self.names = [n for n in self.names if n.platformID == 3 and n.platEncID == 1 and n.langID == 0x0409]
490 return len (self.names)
491
Behdad Esfahbod653e9742013-07-22 15:17:12 -0400492@add_method(fontTools.ttLib.getTableClass('cmap'))
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400493def subset_glyphs (self, glyphs):
Behdad Esfahbodbccf6b12013-07-22 18:43:13 -0400494 # Drop non-Unicode / non-Symbol cmaps
Behdad Esfahbod63a576c2013-07-22 18:52:46 -0400495 # TODO Add option for this
Behdad Esfahbodc9dec9d2013-07-23 10:28:47 -0400496 # TODO Only keep one subtable?
Behdad Esfahbodbccf6b12013-07-22 18:43:13 -0400497 self.tables = [t for t in self.tables if t.platformID == 3 and t.platEncID in [0, 1, 10]]
Behdad Esfahbod653e9742013-07-22 15:17:12 -0400498 for t in self.tables:
Behdad Esfahbod9453a362013-07-22 16:21:24 -0400499 # For reasons I don't understand I need this here
500 # to force decompilation of the cmap format 14.
501 try:
502 getattr (t, "asdf")
503 except AttributeError:
504 pass
Behdad Esfahbodb13d7902013-07-22 16:01:15 -0400505 if t.format == 14:
Behdad Esfahbod9453a362013-07-22 16:21:24 -0400506 # XXX We drop all the default-UVS mappings (g==None)
Behdad Esfahbodb13d7902013-07-22 16:01:15 -0400507 t.uvsDict = {v:[(u,g) for (u,g) in l if g in glyphs] for (v,l) in t.uvsDict.items()}
508 t.uvsDict = {v:l for (v,l) in t.uvsDict.items() if l}
509 else:
510 t.cmap = {u:g for (u,g) in t.cmap.items() if g in glyphs}
511 self.tables = [t for t in self.tables if (t.cmap if t.format != 14 else t.uvsDict)]
Behdad Esfahbod7e4bfc32013-07-22 18:47:32 -0400512 # XXX Convert formats when needed
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400513 # For now, drop format=0 which can't be subset_glyphs easily?
Behdad Esfahbodf3744d92013-07-22 17:04:04 -0400514 self.tables = [t for t in self.tables if t.format != 0]
Behdad Esfahbod653e9742013-07-22 15:17:12 -0400515 return len (self.tables)
516
Behdad Esfahbod8c646f62013-07-22 15:06:23 -0400517
Behdad Esfahbod75e14fc2013-07-22 14:49:54 -0400518# TODO OS/2 ulUnicodeRange / ulCodePageRange?
Behdad Esfahbod1e3551a2013-07-22 18:03:10 -0400519# TODO Drop unneeded GSUB/GPOS entries
520# TODO Move glyf component closure after GSUB/GPOS/etc
Behdad Esfahbod56ebd042013-07-22 13:02:24 -0400521
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400522if __name__ == '__main__':
523
524 import sys
525
Behdad Esfahbod4ae81712013-07-22 11:57:13 -0400526 verbose = False
527 if "--verbose" in sys.argv:
528 verbose = True
529 sys.argv.remove ("--verbose")
Behdad Esfahbod350a5272013-07-22 12:02:16 -0400530 xml = False
531 if "--xml" in sys.argv:
532 xml = True
533 sys.argv.remove ("--xml")
Behdad Esfahbod4ae81712013-07-22 11:57:13 -0400534
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400535 if len (sys.argv) < 3:
536 print >>sys.stderr, "usage: pyotlss.py font-file glyph..."
537 sys.exit (1)
538
539 fontfile = sys.argv[1]
540 glyphs = sys.argv[2:]
541
Behdad Esfahbodc7160442013-07-22 14:29:08 -0400542 # Always include .notdef; anything else?
Behdad Esfahbod0f86ce92013-07-22 17:30:31 -0400543 glyphs.append ('.notdef')
Behdad Esfahbodc7160442013-07-22 14:29:08 -0400544
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400545 font = fontTools.ttx.TTFont (fontfile)
Behdad Esfahbod0f86ce92013-07-22 17:30:31 -0400546 font.disassembleInstructions = False
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400547
548 names = font.getGlyphNames()
549 # Convert to glyph names
550 glyphs = [g if g in names else font.getGlyphName(int(g)) for g in glyphs]
551
Behdad Esfahbod2a784ac2013-07-22 17:00:36 -0400552 # Close over composite glyphs
553 if 'glyf' in font:
554 glyf = font['glyf']
Behdad Esfahbodc9dec9d2013-07-23 10:28:47 -0400555 # XXX Rinse & repeat
Behdad Esfahbod2a784ac2013-07-22 17:00:36 -0400556 for g in glyphs:
557 gl = glyf[g]
558 if gl.isComposite ():
559 for c in gl.components:
560 if c.glyphName not in glyphs:
561 glyphs.append (c.glyphName)
Behdad Esfahbodc9dec9d2013-07-23 10:28:47 -0400562 if verbose:
563 print "Retaining %d glyphs: " % len (glyphs), glyphs
Behdad Esfahbod2a784ac2013-07-22 17:00:36 -0400564
Behdad Esfahbod350a5272013-07-22 12:02:16 -0400565 if xml:
Behdad Esfahbod4ae81712013-07-22 11:57:13 -0400566 import xmlWriter
567 writer = xmlWriter.XMLWriter (sys.stdout)
Behdad Esfahbod4e214e42013-07-22 13:13:49 -0400568
Behdad Esfahbodfc546622013-07-23 10:31:57 -0400569 drop_tables = ['BASE', 'JSTF', 'DSIG', 'EBDT', 'EBLC', 'EBSC', 'PCLT', 'LTSH', 'VDMX']
570 noneed_tables = ['gasp', 'head', 'hhea', 'maxp', 'vhea', 'OS/2', 'loca']
Behdad Esfahbodcd708852013-07-22 14:30:23 -0400571
Behdad Esfahbodb1e1ab62013-07-22 15:24:09 -0400572 # For now drop these
573 drop_tables += ['cvt ', 'fpgm', 'prep']
574
Behdad Esfahbod8842ce22013-07-22 13:01:33 -0400575 for tag in font.keys():
Behdad Esfahbod4e214e42013-07-22 13:13:49 -0400576
Behdad Esfahbodc7160442013-07-22 14:29:08 -0400577 if tag == 'GlyphOrder':
578 continue
579
Behdad Esfahbod4e214e42013-07-22 13:13:49 -0400580 if tag in drop_tables:
Behdad Esfahbodc7160442013-07-22 14:29:08 -0400581 if verbose:
582 print tag, "dropped."
Behdad Esfahbod4e214e42013-07-22 13:13:49 -0400583 del font[tag]
584 continue
585
Behdad Esfahbodcd708852013-07-22 14:30:23 -0400586 if tag in noneed_tables:
587 if verbose:
588 print tag, "intact."
589 continue
590
Behdad Esfahbod8842ce22013-07-22 13:01:33 -0400591 clazz = fontTools.ttLib.getTableClass(tag)
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400592 if 'subset_glyphs' not in vars (clazz):
Behdad Esfahbodc7160442013-07-22 14:29:08 -0400593 if verbose:
Behdad Esfahbod75e14fc2013-07-22 14:49:54 -0400594 print tag, "skipped................"
Behdad Esfahbod02b92062013-07-21 18:40:59 -0400595 continue
Behdad Esfahbod4e214e42013-07-22 13:13:49 -0400596
Behdad Esfahbod8842ce22013-07-22 13:01:33 -0400597 table = font[tag]
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400598 if not table.subset_glyphs (glyphs):
Behdad Esfahbod9d02c2d2013-07-22 11:08:37 -0400599 del font[tag]
Behdad Esfahbod5270ec42013-07-22 12:57:02 -0400600 if verbose:
Behdad Esfahbod0716eb42013-07-23 10:47:03 -0400601 print tag, "subset_glyphs empty; dropped."
Behdad Esfahbod4ae81712013-07-22 11:57:13 -0400602 else:
Behdad Esfahbod350a5272013-07-22 12:02:16 -0400603 if verbose:
Behdad Esfahbodc7160442013-07-22 14:29:08 -0400604 print tag, "subsetted."
605
606 glyphOrder = font.getGlyphOrder()
607 glyphOrder = [g for g in glyphOrder if g in glyphs]
608 font.setGlyphOrder (glyphOrder)
609 font._buildReverseGlyphOrderDict ()
Behdad Esfahbodd1d41bc2013-07-21 23:15:32 -0400610
Behdad Esfahbod0f86ce92013-07-22 17:30:31 -0400611 if xml:
612 for tag in font.keys():
613 writer.begintag (tag)
614 writer.newline ()
615 font[tag].toXML(writer, font)
616 writer.endtag (tag)
617 writer.newline ()
618
Behdad Esfahbod77cda412013-07-22 11:46:50 -0400619 font.save (fontfile + '.subset')