blob: 80b9d80cb674d3e48c1e1e792769f951e5bef630 [file] [log] [blame]
Behdad Esfahbod32c10ee2013-11-27 17:46:17 -05001from __future__ import print_function, division
Behdad Esfahbod30e691e2013-11-27 17:27:45 -05002from fontTools.misc.py23 import *
Behdad Esfahbod2b06aaa2013-11-27 02:34:11 -05003from .DefaultTable import DefaultTable
jvrd4d15132002-05-11 00:59:27 +00004import struct
jvrd4d15132002-05-11 00:59:27 +00005
jvr823f8cd2006-10-21 14:12:38 +00006class OverflowErrorRecord:
7 def __init__(self, overflowTuple):
8 self.tableType = overflowTuple[0]
9 self.LookupListIndex = overflowTuple[1]
10 self.SubTableIndex = overflowTuple[2]
11 self.itemName = overflowTuple[3]
12 self.itemIndex = overflowTuple[4]
13
14 def __repr__(self):
15 return str((self.tableType, "LookupIndex:", self.LookupListIndex, "SubTableIndex:", self.SubTableIndex, "ItemName:", self.itemName, "ItemIndex:", self.itemIndex))
16
17class OTLOffsetOverflowError(Exception):
18 def __init__(self, overflowErrorRecord):
19 self.value = overflowErrorRecord
20
21 def __str__(self):
22 return repr(self.value)
23
jvrd4d15132002-05-11 00:59:27 +000024
25class BaseTTXConverter(DefaultTable):
26
jvr3a6aa232003-09-02 19:23:13 +000027 """Generic base class for TTX table converters. It functions as an
28 adapter between the TTX (ttLib actually) table model and the model
29 we use for OpenType tables, which is necessarily subtly different.
30 """
jvr64b5c802002-05-11 10:21:36 +000031
jvrd4d15132002-05-11 00:59:27 +000032 def decompile(self, data, font):
Behdad Esfahbod2b06aaa2013-11-27 02:34:11 -050033 from . import otTables
Behdad Esfahbod0585b642013-11-22 16:20:59 -050034 cachingStats = None if True else {}
Behdad Esfahbod79f73442013-11-26 17:07:37 -050035 class GlobalState:
36 def __init__(self, tableType, cachingStats):
37 self.tableType = tableType
38 self.cachingStats = cachingStats
39 globalState = GlobalState(tableType=self.tableTag,
40 cachingStats=cachingStats)
41 reader = OTTableReader(data, globalState)
jvrd4d15132002-05-11 00:59:27 +000042 tableClass = getattr(otTables, self.tableTag)
43 self.table = tableClass()
44 self.table.decompile(reader, font)
Behdad Esfahbod0585b642013-11-22 16:20:59 -050045 if cachingStats:
Behdad Esfahbodac1b4352013-11-27 04:15:34 -050046 stats = sorted([(v, k) for k, v in cachingStats.items()])
jvrcfadfd02002-07-22 22:13:57 +000047 stats.reverse()
Behdad Esfahbod3ec6a252013-11-27 04:57:33 -050048 print("cachingsstats for ", self.tableTag)
jvrcfadfd02002-07-22 22:13:57 +000049 for v, k in stats:
50 if v < 2:
51 break
Behdad Esfahbod3ec6a252013-11-27 04:57:33 -050052 print(v, k)
53 print("---", len(stats))
jvrd4d15132002-05-11 00:59:27 +000054
55 def compile(self, font):
jvr823f8cd2006-10-21 14:12:38 +000056 """ Create a top-level OTFWriter for the GPOS/GSUB table.
57 Call the compile method for the the table
jvr1c734522008-03-09 20:13:16 +000058 for each 'converter' record in the table converter list
59 call converter's write method for each item in the value.
jvr823f8cd2006-10-21 14:12:38 +000060 - For simple items, the write method adds a string to the
61 writer's self.items list.
jvr1c734522008-03-09 20:13:16 +000062 - For Struct/Table/Subtable items, it add first adds new writer to the
jvr823f8cd2006-10-21 14:12:38 +000063 to the writer's self.items, then calls the item's compile method.
64 This creates a tree of writers, rooted at the GUSB/GPOS writer, with
65 each writer representing a table, and the writer.items list containing
66 the child data strings and writers.
jvr1c734522008-03-09 20:13:16 +000067 call the getAllData method
jvr823f8cd2006-10-21 14:12:38 +000068 call _doneWriting, which removes duplicates
jvr1c734522008-03-09 20:13:16 +000069 call _gatherTables. This traverses the tables, adding unique occurences to a flat list of tables
70 Traverse the flat list of tables, calling getDataLength on each to update their position
71 Traverse the flat list of tables again, calling getData each get the data in the table, now that
72 pos's and offset are known.
jvr823f8cd2006-10-21 14:12:38 +000073
74 If a lookup subtable overflows an offset, we have to start all over.
75 """
Behdad Esfahbod79f73442013-11-26 17:07:37 -050076 class GlobalState:
77 def __init__(self, tableType):
78 self.tableType = tableType
79 globalState = GlobalState(tableType=self.tableTag)
80 writer = OTTableWriter(globalState)
jvr823f8cd2006-10-21 14:12:38 +000081 writer.parent = None
jvrd4d15132002-05-11 00:59:27 +000082 self.table.compile(writer, font)
jvrcfadfd02002-07-22 22:13:57 +000083 return writer.getAllData()
jvr823f8cd2006-10-21 14:12:38 +000084
jvrd4d15132002-05-11 00:59:27 +000085 def toXML(self, writer, font):
86 self.table.toXML2(writer, font)
87
Behdad Esfahbod3a9fd302013-11-27 03:19:32 -050088 def fromXML(self, name, attrs, content, font):
Behdad Esfahbod2b06aaa2013-11-27 02:34:11 -050089 from . import otTables
jvrd4d15132002-05-11 00:59:27 +000090 if not hasattr(self, "table"):
91 tableClass = getattr(otTables, self.tableTag)
92 self.table = tableClass()
Behdad Esfahbod3a9fd302013-11-27 03:19:32 -050093 self.table.fromXML(name, attrs, content, font)
jvrd4d15132002-05-11 00:59:27 +000094
95
Behdad Esfahbod3879cf92013-11-22 19:23:35 -050096class OTTableReader(object):
Behdad Esfahbod79817042013-11-24 16:59:42 -050097
jvr64b5c802002-05-11 10:21:36 +000098 """Helper class to retrieve data from an OpenType table."""
Behdad Esfahbod3879cf92013-11-22 19:23:35 -050099
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500100 __slots__ = ('data', 'offset', 'pos', 'globalState', 'localState')
Behdad Esfahbod79817042013-11-24 16:59:42 -0500101
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500102 def __init__(self, data, globalState={}, localState=None, offset=0):
jvrd4d15132002-05-11 00:59:27 +0000103 self.data = data
104 self.offset = offset
105 self.pos = offset
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500106 self.globalState = globalState
107 self.localState = localState
Behdad Esfahbod79817042013-11-24 16:59:42 -0500108
Behdad Esfahbod0fac7fe2013-11-24 18:04:29 -0500109 def getSubReader(self, offset):
jvrd4d15132002-05-11 00:59:27 +0000110 offset = self.offset + offset
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500111 cachingStats = self.globalState.cachingStats
112 if cachingStats is not None:
113 cachingStats[offset] = cachingStats.get(offset, 0) + 1
114 return self.__class__(self.data, self.globalState, self.localState, offset)
Behdad Esfahbod79817042013-11-24 16:59:42 -0500115
jvrd4d15132002-05-11 00:59:27 +0000116 def readUShort(self):
117 pos = self.pos
118 newpos = pos + 2
jvre69caf82002-05-13 18:08:19 +0000119 value, = struct.unpack(">H", self.data[pos:newpos])
jvrd4d15132002-05-11 00:59:27 +0000120 self.pos = newpos
121 return value
Behdad Esfahbod79817042013-11-24 16:59:42 -0500122
jvrd4d15132002-05-11 00:59:27 +0000123 def readShort(self):
124 pos = self.pos
125 newpos = pos + 2
jvre69caf82002-05-13 18:08:19 +0000126 value, = struct.unpack(">h", self.data[pos:newpos])
jvrd4d15132002-05-11 00:59:27 +0000127 self.pos = newpos
128 return value
Behdad Esfahbod79817042013-11-24 16:59:42 -0500129
jvrd4d15132002-05-11 00:59:27 +0000130 def readLong(self):
131 pos = self.pos
132 newpos = pos + 4
jvre69caf82002-05-13 18:08:19 +0000133 value, = struct.unpack(">l", self.data[pos:newpos])
jvrd4d15132002-05-11 00:59:27 +0000134 self.pos = newpos
135 return value
Behdad Esfahbod79817042013-11-24 16:59:42 -0500136
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500137 def readUInt24(self):
138 pos = self.pos
139 newpos = pos + 3
Behdad Esfahbod319c5fd2013-11-27 18:13:48 -0500140 value = (byteord(self.data[pos]) << 16) | (byteord(self.data[pos+1]) << 8) | byteord(self.data[pos+2])
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500141 value, = struct.unpack(">H", self.data[pos:newpos])
142 self.pos = newpos
143 return value
144
jvr823f8cd2006-10-21 14:12:38 +0000145 def readULong(self):
146 pos = self.pos
147 newpos = pos + 4
148 value, = struct.unpack(">L", self.data[pos:newpos])
149 self.pos = newpos
150 return value
151
jvrd4d15132002-05-11 00:59:27 +0000152 def readTag(self):
153 pos = self.pos
154 newpos = pos + 4
Behdad Esfahbod960280b2013-11-27 18:16:43 -0500155 value = Tag(self.data[pos:newpos])
jvrd4d15132002-05-11 00:59:27 +0000156 assert len(value) == 4
157 self.pos = newpos
158 return value
Behdad Esfahbod79817042013-11-24 16:59:42 -0500159
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500160 def __setitem__(self, name, value):
161 state = self.localState.copy() if self.localState else dict()
162 state[name] = value
163 self.localState = state
Behdad Esfahbod79817042013-11-24 16:59:42 -0500164
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500165 def __getitem__(self, name):
166 return self.localState[name]
Behdad Esfahbod79817042013-11-24 16:59:42 -0500167
jvrd4d15132002-05-11 00:59:27 +0000168
Behdad Esfahbod3879cf92013-11-22 19:23:35 -0500169class OTTableWriter(object):
jvrd4d15132002-05-11 00:59:27 +0000170
jvr64b5c802002-05-11 10:21:36 +0000171 """Helper class to gather and assemble data for OpenType tables."""
172
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500173 def __init__(self, globalState, localState=None):
jvrd4d15132002-05-11 00:59:27 +0000174 self.items = []
jvrcfadfd02002-07-22 22:13:57 +0000175 self.pos = None
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500176 self.globalState = globalState
177 self.localState = localState
Behdad Esfahbod79817042013-11-24 16:59:42 -0500178
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500179 def __setitem__(self, name, value):
180 state = self.localState.copy() if self.localState else dict()
181 state[name] = value
182 self.localState = state
Behdad Esfahbod79817042013-11-24 16:59:42 -0500183
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500184 def __getitem__(self, name):
185 return self.localState[name]
Behdad Esfahbod79817042013-11-24 16:59:42 -0500186
jvr4105ca02002-07-23 08:43:03 +0000187 # assembler interface
188
189 def getAllData(self):
190 """Assemble all data, including all subtables."""
191 self._doneWriting()
jvr823f8cd2006-10-21 14:12:38 +0000192 tables, extTables = self._gatherTables()
jvr4105ca02002-07-23 08:43:03 +0000193 tables.reverse()
jvr823f8cd2006-10-21 14:12:38 +0000194 extTables.reverse()
jvr4105ca02002-07-23 08:43:03 +0000195 # Gather all data in two passes: the absolute positions of all
196 # subtable are needed before the actual data can be assembled.
197 pos = 0
198 for table in tables:
199 table.pos = pos
200 pos = pos + table.getDataLength()
jvr823f8cd2006-10-21 14:12:38 +0000201
202 for table in extTables:
203 table.pos = pos
204 pos = pos + table.getDataLength()
205
206
jvr4105ca02002-07-23 08:43:03 +0000207 data = []
208 for table in tables:
209 tableData = table.getData()
210 data.append(tableData)
jvr823f8cd2006-10-21 14:12:38 +0000211
212 for table in extTables:
213 tableData = table.getData()
214 data.append(tableData)
215
jvr4105ca02002-07-23 08:43:03 +0000216 return "".join(data)
217
218 def getDataLength(self):
219 """Return the length of this table in bytes, without subtables."""
220 l = 0
221 for item in self.items:
222 if hasattr(item, "getData") or hasattr(item, "getCountData"):
Behdad Esfahbode0c2e8e2013-11-25 05:32:17 -0500223 if item.longOffset:
jvr823f8cd2006-10-21 14:12:38 +0000224 l = l + 4 # sizeof(ULong)
225 else:
226 l = l + 2 # sizeof(UShort)
jvr4105ca02002-07-23 08:43:03 +0000227 else:
228 l = l + len(item)
229 return l
230
231 def getData(self):
232 """Assemble the data for this writer/table, without subtables."""
233 items = list(self.items) # make a shallow copy
jvr823f8cd2006-10-21 14:12:38 +0000234 pos = self.pos
235 numItems = len(items)
236 for i in range(numItems):
jvr4105ca02002-07-23 08:43:03 +0000237 item = items[i]
jvr823f8cd2006-10-21 14:12:38 +0000238
jvr4105ca02002-07-23 08:43:03 +0000239 if hasattr(item, "getData"):
Behdad Esfahbode0c2e8e2013-11-25 05:32:17 -0500240 if item.longOffset:
jvr823f8cd2006-10-21 14:12:38 +0000241 items[i] = packULong(item.pos - pos)
242 else:
243 try:
244 items[i] = packUShort(item.pos - pos)
245 except AssertionError:
246 # provide data to fix overflow problem.
Behdad Esfahbod58acba22013-11-24 20:08:05 -0500247 # If the overflow is to a lookup, or from a lookup to a subtable,
jvr823f8cd2006-10-21 14:12:38 +0000248 # just report the current item.
249 if self.name in [ 'LookupList', 'Lookup']:
250 overflowErrorRecord = self.getOverflowErrorRecord(item)
251 else:
252 # overflow is within a subTable. Life is more complicated.
253 # If we split the sub-table just before the current item, we may still suffer overflow.
254 # This is because duplicate table merging is done only within an Extension subTable tree;
255 # when we split the subtable in two, some items may no longer be duplicates.
256 # Get worst case by adding up all the item lengths, depth first traversal.
257 # and then report the first item that overflows a short.
258 def getDeepItemLength(table):
259 if hasattr(table, "getDataLength"):
260 length = 0
261 for item in table.items:
262 length = length + getDeepItemLength(item)
263 else:
264 length = len(table)
265 return length
266
267 length = self.getDataLength()
268 if hasattr(self, "sortCoverageLast") and item.name == "Coverage":
269 # Coverage is first in the item list, but last in the table list,
270 # The original overflow is really in the item list. Skip the Coverage
271 # table in the following test.
272 items = items[i+1:]
273
274 for j in range(len(items)):
275 item = items[j]
276 length = length + getDeepItemLength(item)
277 if length > 65535:
278 break
279 overflowErrorRecord = self.getOverflowErrorRecord(item)
280
281
Behdad Esfahbodcd5aad92013-11-27 02:42:28 -0500282 raise OTLOffsetOverflowError(overflowErrorRecord)
jvr823f8cd2006-10-21 14:12:38 +0000283
jvr4105ca02002-07-23 08:43:03 +0000284 return "".join(items)
jvrd4d15132002-05-11 00:59:27 +0000285
jvrcfadfd02002-07-22 22:13:57 +0000286 def __hash__(self):
287 # only works after self._doneWriting() has been called
288 return hash(self.items)
289
290 def __cmp__(self, other):
Behdad Esfahbodac1b4352013-11-27 04:15:34 -0500291 if not isinstance(self, type(other)): return cmp(type(self), type(other))
Behdad Esfahbod0ba7aa72013-10-28 12:07:15 +0100292 if self.__class__ != other.__class__: return cmp(self.__class__, other.__class__)
Behdad Esfahbod96b321c2013-08-17 11:11:22 -0400293
294 return cmp(self.items, other.items)
jvrcfadfd02002-07-22 22:13:57 +0000295
jvrcfadfd02002-07-22 22:13:57 +0000296 def _doneWriting(self, internedTables=None):
jvr823f8cd2006-10-21 14:12:38 +0000297 # Convert CountData references to data string items
298 # collapse duplicate table references to a unique entry
299 # "tables" are OTTableWriter objects.
300
301 # For Extension Lookup types, we can
302 # eliminate duplicates only within the tree under the Extension Lookup,
303 # as offsets may exceed 64K even between Extension LookupTable subtables.
jvrcfadfd02002-07-22 22:13:57 +0000304 if internedTables is None:
305 internedTables = {}
306 items = self.items
Behdad Esfahbod97dea0a2013-11-27 03:34:48 -0500307 iRange = list(range(len(items)))
jvr823f8cd2006-10-21 14:12:38 +0000308
309 if hasattr(self, "Extension"):
310 newTree = 1
311 else:
312 newTree = 0
313 for i in iRange:
jvrcfadfd02002-07-22 22:13:57 +0000314 item = items[i]
315 if hasattr(item, "getCountData"):
316 items[i] = item.getCountData()
317 elif hasattr(item, "getData"):
jvr823f8cd2006-10-21 14:12:38 +0000318 if newTree:
319 item._doneWriting()
jvrcfadfd02002-07-22 22:13:57 +0000320 else:
jvr823f8cd2006-10-21 14:12:38 +0000321 item._doneWriting(internedTables)
Behdad Esfahbodbc5e1cb2013-11-27 02:33:03 -0500322 if item in internedTables:
jvr823f8cd2006-10-21 14:12:38 +0000323 items[i] = item = internedTables[item]
324 else:
325 internedTables[item] = item
jvrcfadfd02002-07-22 22:13:57 +0000326 self.items = tuple(items)
327
jvr823f8cd2006-10-21 14:12:38 +0000328 def _gatherTables(self, tables=None, extTables=None, done=None):
329 # Convert table references in self.items tree to a flat
330 # list of tables in depth-first traversal order.
331 # "tables" are OTTableWriter objects.
332 # We do the traversal in reverse order at each level, in order to
333 # resolve duplicate references to be the last reference in the list of tables.
334 # For extension lookups, duplicate references can be merged only within the
335 # writer tree under the extension lookup.
336 if tables is None: # init call for first time.
jvrcfadfd02002-07-22 22:13:57 +0000337 tables = []
jvr823f8cd2006-10-21 14:12:38 +0000338 extTables = []
jvrcfadfd02002-07-22 22:13:57 +0000339 done = {}
jvr823f8cd2006-10-21 14:12:38 +0000340
341 done[self] = 1
342
343 numItems = len(self.items)
Behdad Esfahbod97dea0a2013-11-27 03:34:48 -0500344 iRange = list(range(numItems))
jvr823f8cd2006-10-21 14:12:38 +0000345 iRange.reverse()
346
347 if hasattr(self, "Extension"):
348 appendExtensions = 1
349 else:
350 appendExtensions = 0
351
352 # add Coverage table if it is sorted last.
353 sortCoverageLast = 0
354 if hasattr(self, "sortCoverageLast"):
355 # Find coverage table
356 for i in range(numItems):
357 item = self.items[i]
358 if hasattr(item, "name") and (item.name == "Coverage"):
359 sortCoverageLast = 1
360 break
Behdad Esfahbodbc5e1cb2013-11-27 02:33:03 -0500361 if item not in done:
jvr823f8cd2006-10-21 14:12:38 +0000362 item._gatherTables(tables, extTables, done)
363 else:
364 index = max(item.parent.keys())
365 item.parent[index + 1] = self
366
367 saveItem = None
368 for i in iRange:
369 item = self.items[i]
jvrcfadfd02002-07-22 22:13:57 +0000370 if not hasattr(item, "getData"):
371 continue
jvr823f8cd2006-10-21 14:12:38 +0000372
373 if sortCoverageLast and (i==1) and item.name == 'Coverage':
374 # we've already 'gathered' it above
375 continue
376
377 if appendExtensions:
378 assert extTables != None, "Program or XML editing error. Extension subtables cannot contain extensions subtables"
379 newDone = {}
380 item._gatherTables(extTables, None, newDone)
381
Behdad Esfahbodbc5e1cb2013-11-27 02:33:03 -0500382 elif item not in done:
jvr823f8cd2006-10-21 14:12:38 +0000383 item._gatherTables(tables, extTables, done)
384 else:
385 index = max(item.parent.keys())
386 item.parent[index + 1] = self
387
388
jvrcfadfd02002-07-22 22:13:57 +0000389 tables.append(self)
jvr823f8cd2006-10-21 14:12:38 +0000390 return tables, extTables
jvrcfadfd02002-07-22 22:13:57 +0000391
jvr4105ca02002-07-23 08:43:03 +0000392 # interface for gathering data, as used by table.compile()
jvrcfadfd02002-07-22 22:13:57 +0000393
jvr4105ca02002-07-23 08:43:03 +0000394 def getSubWriter(self):
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500395 subwriter = self.__class__(self.globalState, self.localState)
jvr823f8cd2006-10-21 14:12:38 +0000396 subwriter.parent = {0:self} # because some subtables have idential values, we discard
397 # the duplicates under the getAllData method. Hence some
398 # subtable writers can have more than one parent writer.
399 return subwriter
jvrd4d15132002-05-11 00:59:27 +0000400
401 def writeUShort(self, value):
402 assert 0 <= value < 0x10000
403 self.items.append(struct.pack(">H", value))
404
405 def writeShort(self, value):
406 self.items.append(struct.pack(">h", value))
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500407
408 def writeUInt24(self, value):
409 assert 0 <= value < 0x1000000
Behdad Esfahbodb7a2d792013-11-27 15:19:40 -0500410 self.items.append(''.join(bytechr(v) for v in (value>>16, (value>>8)&0xFF, value&0xff)))
jvrd4d15132002-05-11 00:59:27 +0000411
412 def writeLong(self, value):
413 self.items.append(struct.pack(">l", value))
414
jvr823f8cd2006-10-21 14:12:38 +0000415 def writeULong(self, value):
416 self.items.append(struct.pack(">L", value))
417
jvrd4d15132002-05-11 00:59:27 +0000418 def writeTag(self, tag):
Behdad Esfahbod960280b2013-11-27 18:16:43 -0500419 tag = Tag(tag).tobytes()
jvrd4d15132002-05-11 00:59:27 +0000420 assert len(tag) == 4
421 self.items.append(tag)
422
423 def writeSubTable(self, subWriter):
424 self.items.append(subWriter)
425
426 def writeCountReference(self, table, name):
Behdad Esfahbod79817042013-11-24 16:59:42 -0500427 ref = CountReference(table, name)
428 self.items.append(ref)
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500429 return ref
jvrd4d15132002-05-11 00:59:27 +0000430
431 def writeStruct(self, format, values):
Behdad Esfahbod66214cb2013-11-27 02:18:18 -0500432 data = struct.pack(*(format,) + values)
jvrd4d15132002-05-11 00:59:27 +0000433 self.items.append(data)
434
jvr823f8cd2006-10-21 14:12:38 +0000435 def writeData(self, data):
436 self.items.append(data)
jvrd4d15132002-05-11 00:59:27 +0000437
jvr823f8cd2006-10-21 14:12:38 +0000438 def getOverflowErrorRecord(self, item):
439 LookupListIndex = SubTableIndex = itemName = itemIndex = None
440 if self.name == 'LookupList':
441 LookupListIndex = item.repeatIndex
442 elif self.name == 'Lookup':
443 LookupListIndex = self.repeatIndex
444 SubTableIndex = item.repeatIndex
445 else:
446 itemName = item.name
447 if hasattr(item, 'repeatIndex'):
448 itemIndex = item.repeatIndex
449 if self.name == 'SubTable':
450 LookupListIndex = self.parent[0].repeatIndex
451 SubTableIndex = self.repeatIndex
452 elif self.name == 'ExtSubTable':
453 LookupListIndex = self.parent[0].parent[0].repeatIndex
454 SubTableIndex = self.parent[0].repeatIndex
455 else: # who knows how far below the SubTable level we are! Climb back up to the nearest subtable.
456 itemName = ".".join(self.name, item.name)
457 p1 = self.parent[0]
458 while p1 and p1.name not in ['ExtSubTable', 'SubTable']:
459 itemName = ".".join(p1.name, item.name)
460 p1 = p1.parent[0]
461 if p1:
462 if p1.name == 'ExtSubTable':
463 LookupListIndex = self.parent[0].parent[0].repeatIndex
464 SubTableIndex = self.parent[0].repeatIndex
465 else:
466 LookupListIndex = self.parent[0].repeatIndex
467 SubTableIndex = self.repeatIndex
468
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500469 return OverflowErrorRecord( (self.globalState.tableType, LookupListIndex, SubTableIndex, itemName, itemIndex) )
jvr823f8cd2006-10-21 14:12:38 +0000470
jvrd4d15132002-05-11 00:59:27 +0000471
472class CountReference:
jvrcfadfd02002-07-22 22:13:57 +0000473 """A reference to a Count value, not a count of references."""
jvrd4d15132002-05-11 00:59:27 +0000474 def __init__(self, table, name):
475 self.table = table
476 self.name = name
Behdad Esfahbod79817042013-11-24 16:59:42 -0500477 def setValue(self, value):
478 table = self.table
479 name = self.name
480 if table[name] is None:
481 table[name] = value
482 else:
Behdad Esfahbod1f0eed82013-11-26 18:41:53 -0500483 assert table[name] == value, (name, table[name], value)
jvrcfadfd02002-07-22 22:13:57 +0000484 def getCountData(self):
jvrd4d15132002-05-11 00:59:27 +0000485 return packUShort(self.table[self.name])
486
487
jvr64b5c802002-05-11 10:21:36 +0000488def packUShort(value):
jvrcfadfd02002-07-22 22:13:57 +0000489 assert 0 <= value < 0x10000, value
jvr64b5c802002-05-11 10:21:36 +0000490 return struct.pack(">H", value)
jvrd4d15132002-05-11 00:59:27 +0000491
492
jvr823f8cd2006-10-21 14:12:38 +0000493def packULong(value):
jvrce47e0d2008-03-09 20:48:45 +0000494 assert 0 <= value < 0x100000000, value
jvr823f8cd2006-10-21 14:12:38 +0000495 return struct.pack(">L", value)
496
497
Behdad Esfahbod5988cc32013-11-19 17:20:54 -0500498class BaseTable(object):
jvr823f8cd2006-10-21 14:12:38 +0000499 def __init__(self):
500 self.compileStatus = 0 # 0 means table was created
501 # 1 means the table.read() function was called by a table which is subject
502 # to delayed compilation
503 # 2 means that it was subject to delayed compilation, and
504 # has been decompiled
jvr823f8cd2006-10-21 14:12:38 +0000505
506 self.recurse = 0
jvrd4d15132002-05-11 00:59:27 +0000507
jvr823f8cd2006-10-21 14:12:38 +0000508 def __getattr__(self, attr):
509 # we get here only when the table does not have the attribute.
510 # This method ovveride exists so that we can try to de-compile
511 # a table which is subject to delayed decompilation, and then try
512 # to get the value again after decompilation.
513 self.recurse +=1
514 if self.recurse > 2:
515 # shouldn't ever get here - we should only get to two levels of recursion.
516 # this guards against self.decompile NOT setting compileStatus to other than 1.
Behdad Esfahbodcd5aad92013-11-27 02:42:28 -0500517 raise AttributeError(attr)
jvr823f8cd2006-10-21 14:12:38 +0000518 if self.compileStatus == 1:
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500519 self.ensureDecompiled()
jvr823f8cd2006-10-21 14:12:38 +0000520 val = getattr(self, attr)
521 self.recurse -=1
522 return val
523
Behdad Esfahbodcd5aad92013-11-27 02:42:28 -0500524 raise AttributeError(attr)
jvr823f8cd2006-10-21 14:12:38 +0000525
526
jvr64b5c802002-05-11 10:21:36 +0000527 """Generic base class for all OpenType (sub)tables."""
528
jvrd4d15132002-05-11 00:59:27 +0000529 def getConverters(self):
530 return self.converters
531
532 def getConverterByName(self, name):
533 return self.convertersByName[name]
534
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500535 def decompile(self, reader, font):
jvr823f8cd2006-10-21 14:12:38 +0000536 self.compileStatus = 2 # table has been decompiled.
jvrf7ef96c2002-09-10 19:26:38 +0000537 self.readFormat(reader)
jvrd4d15132002-05-11 00:59:27 +0000538 table = {}
539 self.__rawTable = table # for debugging
Behdad Esfahbod41caf2d2013-11-22 19:12:14 -0500540 converters = self.getConverters()
541 for conv in converters:
jvrd4d15132002-05-11 00:59:27 +0000542 if conv.name == "SubTable":
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500543 conv = conv.getConverter(reader.globalState.tableType,
jvrd4d15132002-05-11 00:59:27 +0000544 table["LookupType"])
jvr823f8cd2006-10-21 14:12:38 +0000545 if conv.name == "ExtSubTable":
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500546 conv = conv.getConverter(reader.globalState.tableType,
jvr823f8cd2006-10-21 14:12:38 +0000547 table["ExtensionLookupType"])
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500548 if conv.name == "FeatureParams":
549 conv = conv.getConverter(reader["FeatureTag"])
jvrd4d15132002-05-11 00:59:27 +0000550 if conv.repeat:
551 l = []
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500552 if conv.repeat in table:
553 countValue = table[conv.repeat]
554 else:
555 # conv.repeat is a propagated count
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500556 countValue = reader[conv.repeat]
Behdad Esfahbod6b6e9fa2013-11-24 22:11:41 -0500557 for i in range(countValue + conv.aux):
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500558 l.append(conv.read(reader, font, table))
jvrd4d15132002-05-11 00:59:27 +0000559 table[conv.name] = l
560 else:
Behdad Esfahbod5b9cabc2013-11-25 04:01:56 -0500561 if conv.aux and not eval(conv.aux, None, table):
562 continue
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500563 table[conv.name] = conv.read(reader, font, table)
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500564 if conv.isPropagated:
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500565 reader[conv.name] = table[conv.name]
Behdad Esfahbod41caf2d2013-11-22 19:12:14 -0500566
jvrd4d15132002-05-11 00:59:27 +0000567 self.postRead(table, font)
Behdad Esfahbod41caf2d2013-11-22 19:12:14 -0500568
jvrd4d15132002-05-11 00:59:27 +0000569 del self.__rawTable # succeeded, get rid of debugging info
jvr823f8cd2006-10-21 14:12:38 +0000570
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500571 def ensureDecompiled(self):
572 if self.compileStatus != 1:
573 return
Behdad Esfahbodf4e61ae2013-11-26 17:37:03 -0500574 self.decompile(self.reader, self.font)
575 del self.reader, self.font
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500576
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500577 def compile(self, writer, font):
Behdad Esfahbod3ac9e632013-11-26 19:42:55 -0500578 self.ensureDecompiled()
jvrd4d15132002-05-11 00:59:27 +0000579 table = self.preWrite(font)
jvr823f8cd2006-10-21 14:12:38 +0000580
581 if hasattr(self, 'sortCoverageLast'):
582 writer.sortCoverageLast = 1
583
jvrf7ef96c2002-09-10 19:26:38 +0000584 self.writeFormat(writer)
jvrd4d15132002-05-11 00:59:27 +0000585 for conv in self.getConverters():
586 value = table.get(conv.name)
587 if conv.repeat:
588 if value is None:
jvr64b5c802002-05-11 10:21:36 +0000589 value = []
Behdad Esfahbod6b6e9fa2013-11-24 22:11:41 -0500590 countValue = len(value) - conv.aux
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500591 if conv.repeat in table:
592 ref = table[conv.repeat]
593 table[conv.repeat] = None
594 ref.setValue(countValue)
595 else:
596 # conv.repeat is a propagated count
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500597 writer[conv.repeat].setValue(countValue)
jvr823f8cd2006-10-21 14:12:38 +0000598 for i in range(len(value)):
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500599 conv.write(writer, font, table, value[i], i)
jvrd4d15132002-05-11 00:59:27 +0000600 elif conv.isCount:
601 # Special-case Count values.
602 # Assumption: a Count field will *always* precede
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500603 # the actual array(s).
jvrd4d15132002-05-11 00:59:27 +0000604 # We need a default value, as it may be set later by a nested
Behdad Esfahbod41caf2d2013-11-22 19:12:14 -0500605 # table. We will later store it here.
jvrd4d15132002-05-11 00:59:27 +0000606 # We add a reference: by the time the data is assembled
607 # the Count value will be filled in.
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500608 ref = writer.writeCountReference(table, conv.name)
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500609 if conv.isPropagated:
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500610 table[conv.name] = None
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500611 writer[conv.name] = ref
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500612 else:
613 table[conv.name] = ref
jvrd4d15132002-05-11 00:59:27 +0000614 else:
Behdad Esfahbod5b9cabc2013-11-25 04:01:56 -0500615 if conv.aux and not eval(conv.aux, None, table):
616 continue
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500617 conv.write(writer, font, table, value)
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500618 if conv.isPropagated:
619 writer[conv.name] = value
jvrd4d15132002-05-11 00:59:27 +0000620
jvrf7ef96c2002-09-10 19:26:38 +0000621 def readFormat(self, reader):
622 pass
623
624 def writeFormat(self, writer):
625 pass
626
jvrd4d15132002-05-11 00:59:27 +0000627 def postRead(self, table, font):
628 self.__dict__.update(table)
629
630 def preWrite(self, font):
631 return self.__dict__.copy()
632
633 def toXML(self, xmlWriter, font, attrs=None):
634 tableName = self.__class__.__name__
635 if attrs is None:
636 attrs = []
637 if hasattr(self, "Format"):
jvr64b5c802002-05-11 10:21:36 +0000638 attrs = attrs + [("Format", self.Format)]
jvrd4d15132002-05-11 00:59:27 +0000639 xmlWriter.begintag(tableName, attrs)
640 xmlWriter.newline()
641 self.toXML2(xmlWriter, font)
642 xmlWriter.endtag(tableName)
643 xmlWriter.newline()
644
645 def toXML2(self, xmlWriter, font):
646 # Simpler variant of toXML, *only* for the top level tables (like GPOS, GSUB).
647 # This is because in TTX our parent writes our main tag, and in otBase.py we
648 # do it ourselves. I think I'm getting schizophrenic...
649 for conv in self.getConverters():
jvr64b5c802002-05-11 10:21:36 +0000650 if conv.repeat:
Behdad Esfahbod5b9cabc2013-11-25 04:01:56 -0500651 value = getattr(self, conv.name)
jvrd4d15132002-05-11 00:59:27 +0000652 for i in range(len(value)):
653 item = value[i]
jvr64b5c802002-05-11 10:21:36 +0000654 conv.xmlWrite(xmlWriter, font, item, conv.name,
655 [("index", i)])
656 else:
Behdad Esfahbod5b9cabc2013-11-25 04:01:56 -0500657 if conv.aux and not eval(conv.aux, None, vars(self)):
658 continue
659 value = getattr(self, conv.name)
jvr64b5c802002-05-11 10:21:36 +0000660 conv.xmlWrite(xmlWriter, font, value, conv.name, [])
jvrd4d15132002-05-11 00:59:27 +0000661
Behdad Esfahbod3a9fd302013-11-27 03:19:32 -0500662 def fromXML(self, name, attrs, content, font):
jvrd4d15132002-05-11 00:59:27 +0000663 try:
664 conv = self.getConverterByName(name)
665 except KeyError:
jvrd4d15132002-05-11 00:59:27 +0000666 raise # XXX on KeyError, raise nice error
667 value = conv.xmlRead(attrs, content, font)
jvrd4d15132002-05-11 00:59:27 +0000668 if conv.repeat:
jvr52966bb2002-09-12 16:45:48 +0000669 seq = getattr(self, conv.name, None)
670 if seq is None:
jvrd4d15132002-05-11 00:59:27 +0000671 seq = []
jvr64b5c802002-05-11 10:21:36 +0000672 setattr(self, conv.name, seq)
jvrd4d15132002-05-11 00:59:27 +0000673 seq.append(value)
674 else:
jvr64b5c802002-05-11 10:21:36 +0000675 setattr(self, conv.name, value)
jvrd4d15132002-05-11 00:59:27 +0000676
677 def __cmp__(self, other):
Behdad Esfahbodac1b4352013-11-27 04:15:34 -0500678 if not isinstance(self, type(other)): return cmp(type(self), type(other))
Behdad Esfahbod0ba7aa72013-10-28 12:07:15 +0100679 if self.__class__ != other.__class__: return cmp(self.__class__, other.__class__)
Behdad Esfahbod96b321c2013-08-17 11:11:22 -0400680
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500681 self.ensureDecompiled()
682
Behdad Esfahbod96b321c2013-08-17 11:11:22 -0400683 return cmp(self.__dict__, other.__dict__)
jvrd4d15132002-05-11 00:59:27 +0000684
685
686class FormatSwitchingBaseTable(BaseTable):
687
jvrcfadfd02002-07-22 22:13:57 +0000688 """Minor specialization of BaseTable, for tables that have multiple
jvr64b5c802002-05-11 10:21:36 +0000689 formats, eg. CoverageFormat1 vs. CoverageFormat2."""
690
jvrd4d15132002-05-11 00:59:27 +0000691 def getConverters(self):
692 return self.converters[self.Format]
693
694 def getConverterByName(self, name):
695 return self.convertersByName[self.Format][name]
696
jvrf7ef96c2002-09-10 19:26:38 +0000697 def readFormat(self, reader):
jvrd4d15132002-05-11 00:59:27 +0000698 self.Format = reader.readUShort()
Behdad Esfahbod180ace62013-11-27 02:40:30 -0500699 assert self.Format != 0, (self, reader.pos, len(reader.data))
jvrd4d15132002-05-11 00:59:27 +0000700
jvrf7ef96c2002-09-10 19:26:38 +0000701 def writeFormat(self, writer):
jvrd4d15132002-05-11 00:59:27 +0000702 writer.writeUShort(self.Format)
jvrd4d15132002-05-11 00:59:27 +0000703
704
jvr64b5c802002-05-11 10:21:36 +0000705#
706# Support for ValueRecords
707#
708# This data type is so different from all other OpenType data types that
709# it requires quite a bit of code for itself. It even has special support
710# in OTTableReader and OTTableWriter...
711#
712
jvrd4d15132002-05-11 00:59:27 +0000713valueRecordFormat = [
714# Mask Name isDevice signed
715 (0x0001, "XPlacement", 0, 1),
716 (0x0002, "YPlacement", 0, 1),
717 (0x0004, "XAdvance", 0, 1),
718 (0x0008, "YAdvance", 0, 1),
719 (0x0010, "XPlaDevice", 1, 0),
720 (0x0020, "YPlaDevice", 1, 0),
721 (0x0040, "XAdvDevice", 1, 0),
722 (0x0080, "YAdvDevice", 1, 0),
723# reserved:
724 (0x0100, "Reserved1", 0, 0),
725 (0x0200, "Reserved2", 0, 0),
726 (0x0400, "Reserved3", 0, 0),
727 (0x0800, "Reserved4", 0, 0),
728 (0x1000, "Reserved5", 0, 0),
729 (0x2000, "Reserved6", 0, 0),
730 (0x4000, "Reserved7", 0, 0),
731 (0x8000, "Reserved8", 0, 0),
732]
733
734def _buildDict():
735 d = {}
736 for mask, name, isDevice, signed in valueRecordFormat:
737 d[name] = mask, isDevice, signed
738 return d
739
740valueRecordFormatDict = _buildDict()
741
742
743class ValueRecordFactory:
744
jvr64b5c802002-05-11 10:21:36 +0000745 """Given a format code, this object convert ValueRecords."""
Behdad Esfahbodd01c44a2013-11-22 15:21:41 -0500746
Behdad Esfahbod601bb942013-11-23 20:20:39 -0500747 def __init__(self, valueFormat):
jvrd4d15132002-05-11 00:59:27 +0000748 format = []
749 for mask, name, isDevice, signed in valueRecordFormat:
750 if valueFormat & mask:
751 format.append((name, isDevice, signed))
752 self.format = format
753
754 def readValueRecord(self, reader, font):
755 format = self.format
756 if not format:
757 return None
758 valueRecord = ValueRecord()
759 for name, isDevice, signed in format:
760 if signed:
761 value = reader.readShort()
762 else:
763 value = reader.readUShort()
764 if isDevice:
765 if value:
Behdad Esfahbod2b06aaa2013-11-27 02:34:11 -0500766 from . import otTables
jvrd4d15132002-05-11 00:59:27 +0000767 subReader = reader.getSubReader(value)
768 value = getattr(otTables, name)()
769 value.decompile(subReader, font)
770 else:
771 value = None
772 setattr(valueRecord, name, value)
773 return valueRecord
774
775 def writeValueRecord(self, writer, font, valueRecord):
776 for name, isDevice, signed in self.format:
777 value = getattr(valueRecord, name, 0)
778 if isDevice:
779 if value:
780 subWriter = writer.getSubWriter()
781 writer.writeSubTable(subWriter)
782 value.compile(subWriter, font)
783 else:
784 writer.writeUShort(0)
785 elif signed:
786 writer.writeShort(value)
787 else:
788 writer.writeUShort(value)
789
790
791class ValueRecord:
792
793 # see ValueRecordFactory
794
795 def getFormat(self):
796 format = 0
797 for name in self.__dict__.keys():
798 format = format | valueRecordFormatDict[name][0]
799 return format
800
801 def toXML(self, xmlWriter, font, valueName, attrs=None):
802 if attrs is None:
803 simpleItems = []
804 else:
805 simpleItems = list(attrs)
806 for mask, name, isDevice, format in valueRecordFormat[:4]: # "simple" values
807 if hasattr(self, name):
808 simpleItems.append((name, getattr(self, name)))
809 deviceItems = []
810 for mask, name, isDevice, format in valueRecordFormat[4:8]: # device records
811 if hasattr(self, name):
812 device = getattr(self, name)
813 if device is not None:
814 deviceItems.append((name, device))
815 if deviceItems:
816 xmlWriter.begintag(valueName, simpleItems)
817 xmlWriter.newline()
818 for name, deviceRecord in deviceItems:
819 if deviceRecord is not None:
820 deviceRecord.toXML(xmlWriter, font)
821 xmlWriter.endtag(valueName)
822 xmlWriter.newline()
823 else:
824 xmlWriter.simpletag(valueName, simpleItems)
825 xmlWriter.newline()
826
Behdad Esfahbod3a9fd302013-11-27 03:19:32 -0500827 def fromXML(self, name, attrs, content, font):
Behdad Esfahbod2b06aaa2013-11-27 02:34:11 -0500828 from . import otTables
jvrd4d15132002-05-11 00:59:27 +0000829 for k, v in attrs.items():
830 setattr(self, k, int(v))
831 for element in content:
Behdad Esfahbodb774f9f2013-11-27 05:17:37 -0500832 if not isinstance(element, tuple):
jvrd4d15132002-05-11 00:59:27 +0000833 continue
834 name, attrs, content = element
835 value = getattr(otTables, name)()
836 for elem2 in content:
Behdad Esfahbodb774f9f2013-11-27 05:17:37 -0500837 if not isinstance(elem2, tuple):
jvrd4d15132002-05-11 00:59:27 +0000838 continue
Behdad Esfahbod3a9fd302013-11-27 03:19:32 -0500839 name2, attrs2, content2 = elem2
840 value.fromXML(name2, attrs2, content2, font)
jvrd4d15132002-05-11 00:59:27 +0000841 setattr(self, name, value)
842
843 def __cmp__(self, other):
Behdad Esfahbodac1b4352013-11-27 04:15:34 -0500844 if not isinstance(self, type(other)): return cmp(type(self), type(other))
Behdad Esfahbod0ba7aa72013-10-28 12:07:15 +0100845 if self.__class__ != other.__class__: return cmp(self.__class__, other.__class__)
jvrd4d15132002-05-11 00:59:27 +0000846
Behdad Esfahbod96b321c2013-08-17 11:11:22 -0400847 return cmp(self.__dict__, other.__dict__)