blob: bf010b55ead6e35512650e10f89bab5ae6d8d431 [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
Behdad Esfahbode388db52013-11-28 14:26:58 -05006class OverflowErrorRecord(object):
jvr823f8cd2006-10-21 14:12:38 +00007 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 Esfahbode388db52013-11-28 14:26:58 -050035 class GlobalState(object):
Behdad Esfahbod79f73442013-11-26 17:07:37 -050036 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 Esfahbode388db52013-11-28 14:26:58 -050076 class GlobalState(object):
Behdad Esfahbod79f73442013-11-26 17:07:37 -050077 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 Esfahbodc0a9d692013-11-28 06:38:07 -0500140 value, = struct.unpack(">l", b'\0'+self.data[pos:newpos])
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500141 self.pos = newpos
142 return value
143
jvr823f8cd2006-10-21 14:12:38 +0000144 def readULong(self):
145 pos = self.pos
146 newpos = pos + 4
147 value, = struct.unpack(">L", self.data[pos:newpos])
148 self.pos = newpos
149 return value
150
jvrd4d15132002-05-11 00:59:27 +0000151 def readTag(self):
152 pos = self.pos
153 newpos = pos + 4
Behdad Esfahbod960280b2013-11-27 18:16:43 -0500154 value = Tag(self.data[pos:newpos])
jvrd4d15132002-05-11 00:59:27 +0000155 assert len(value) == 4
156 self.pos = newpos
157 return value
Behdad Esfahbod79817042013-11-24 16:59:42 -0500158
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500159 def __setitem__(self, name, value):
160 state = self.localState.copy() if self.localState else dict()
161 state[name] = value
162 self.localState = state
Behdad Esfahbod79817042013-11-24 16:59:42 -0500163
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500164 def __getitem__(self, name):
165 return self.localState[name]
Behdad Esfahbod79817042013-11-24 16:59:42 -0500166
jvrd4d15132002-05-11 00:59:27 +0000167
Behdad Esfahbod3879cf92013-11-22 19:23:35 -0500168class OTTableWriter(object):
jvrd4d15132002-05-11 00:59:27 +0000169
jvr64b5c802002-05-11 10:21:36 +0000170 """Helper class to gather and assemble data for OpenType tables."""
171
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500172 def __init__(self, globalState, localState=None):
jvrd4d15132002-05-11 00:59:27 +0000173 self.items = []
jvrcfadfd02002-07-22 22:13:57 +0000174 self.pos = None
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500175 self.globalState = globalState
176 self.localState = localState
Behdad Esfahbod79817042013-11-24 16:59:42 -0500177
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500178 def __setitem__(self, name, value):
179 state = self.localState.copy() if self.localState else dict()
180 state[name] = value
181 self.localState = state
Behdad Esfahbod79817042013-11-24 16:59:42 -0500182
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500183 def __getitem__(self, name):
184 return self.localState[name]
Behdad Esfahbod79817042013-11-24 16:59:42 -0500185
jvr4105ca02002-07-23 08:43:03 +0000186 # assembler interface
187
188 def getAllData(self):
189 """Assemble all data, including all subtables."""
190 self._doneWriting()
jvr823f8cd2006-10-21 14:12:38 +0000191 tables, extTables = self._gatherTables()
jvr4105ca02002-07-23 08:43:03 +0000192 tables.reverse()
jvr823f8cd2006-10-21 14:12:38 +0000193 extTables.reverse()
jvr4105ca02002-07-23 08:43:03 +0000194 # Gather all data in two passes: the absolute positions of all
195 # subtable are needed before the actual data can be assembled.
196 pos = 0
197 for table in tables:
198 table.pos = pos
199 pos = pos + table.getDataLength()
jvr823f8cd2006-10-21 14:12:38 +0000200
201 for table in extTables:
202 table.pos = pos
203 pos = pos + table.getDataLength()
204
205
jvr4105ca02002-07-23 08:43:03 +0000206 data = []
207 for table in tables:
208 tableData = table.getData()
209 data.append(tableData)
jvr823f8cd2006-10-21 14:12:38 +0000210
211 for table in extTables:
212 tableData = table.getData()
213 data.append(tableData)
214
Behdad Esfahbod821572c2013-11-27 21:09:03 -0500215 return bytesjoin(data)
jvr4105ca02002-07-23 08:43:03 +0000216
217 def getDataLength(self):
218 """Return the length of this table in bytes, without subtables."""
219 l = 0
220 for item in self.items:
221 if hasattr(item, "getData") or hasattr(item, "getCountData"):
Behdad Esfahbode0c2e8e2013-11-25 05:32:17 -0500222 if item.longOffset:
jvr823f8cd2006-10-21 14:12:38 +0000223 l = l + 4 # sizeof(ULong)
224 else:
225 l = l + 2 # sizeof(UShort)
jvr4105ca02002-07-23 08:43:03 +0000226 else:
227 l = l + len(item)
228 return l
229
230 def getData(self):
231 """Assemble the data for this writer/table, without subtables."""
232 items = list(self.items) # make a shallow copy
jvr823f8cd2006-10-21 14:12:38 +0000233 pos = self.pos
234 numItems = len(items)
235 for i in range(numItems):
jvr4105ca02002-07-23 08:43:03 +0000236 item = items[i]
jvr823f8cd2006-10-21 14:12:38 +0000237
jvr4105ca02002-07-23 08:43:03 +0000238 if hasattr(item, "getData"):
Behdad Esfahbode0c2e8e2013-11-25 05:32:17 -0500239 if item.longOffset:
jvr823f8cd2006-10-21 14:12:38 +0000240 items[i] = packULong(item.pos - pos)
241 else:
242 try:
243 items[i] = packUShort(item.pos - pos)
244 except AssertionError:
245 # provide data to fix overflow problem.
Behdad Esfahbod58acba22013-11-24 20:08:05 -0500246 # If the overflow is to a lookup, or from a lookup to a subtable,
jvr823f8cd2006-10-21 14:12:38 +0000247 # just report the current item.
248 if self.name in [ 'LookupList', 'Lookup']:
249 overflowErrorRecord = self.getOverflowErrorRecord(item)
250 else:
251 # overflow is within a subTable. Life is more complicated.
252 # If we split the sub-table just before the current item, we may still suffer overflow.
253 # This is because duplicate table merging is done only within an Extension subTable tree;
254 # when we split the subtable in two, some items may no longer be duplicates.
255 # Get worst case by adding up all the item lengths, depth first traversal.
256 # and then report the first item that overflows a short.
257 def getDeepItemLength(table):
258 if hasattr(table, "getDataLength"):
259 length = 0
260 for item in table.items:
261 length = length + getDeepItemLength(item)
262 else:
263 length = len(table)
264 return length
265
266 length = self.getDataLength()
267 if hasattr(self, "sortCoverageLast") and item.name == "Coverage":
268 # Coverage is first in the item list, but last in the table list,
269 # The original overflow is really in the item list. Skip the Coverage
270 # table in the following test.
271 items = items[i+1:]
272
273 for j in range(len(items)):
274 item = items[j]
275 length = length + getDeepItemLength(item)
276 if length > 65535:
277 break
278 overflowErrorRecord = self.getOverflowErrorRecord(item)
279
280
Behdad Esfahbodcd5aad92013-11-27 02:42:28 -0500281 raise OTLOffsetOverflowError(overflowErrorRecord)
jvr823f8cd2006-10-21 14:12:38 +0000282
Behdad Esfahbod821572c2013-11-27 21:09:03 -0500283 return bytesjoin(items)
jvrd4d15132002-05-11 00:59:27 +0000284
jvrcfadfd02002-07-22 22:13:57 +0000285 def __hash__(self):
286 # only works after self._doneWriting() has been called
287 return hash(self.items)
288
Behdad Esfahbodb7fd2e12013-11-27 18:58:45 -0500289 def __eq__(self, other):
290 if type(self) != type(other):
291 raise TypeError("unordered types %s() < %s()", type(self), type(other))
292 return self.items == other.items
jvrcfadfd02002-07-22 22:13:57 +0000293
jvrcfadfd02002-07-22 22:13:57 +0000294 def _doneWriting(self, internedTables=None):
jvr823f8cd2006-10-21 14:12:38 +0000295 # Convert CountData references to data string items
296 # collapse duplicate table references to a unique entry
297 # "tables" are OTTableWriter objects.
298
299 # For Extension Lookup types, we can
300 # eliminate duplicates only within the tree under the Extension Lookup,
301 # as offsets may exceed 64K even between Extension LookupTable subtables.
jvrcfadfd02002-07-22 22:13:57 +0000302 if internedTables is None:
303 internedTables = {}
304 items = self.items
Behdad Esfahbod97dea0a2013-11-27 03:34:48 -0500305 iRange = list(range(len(items)))
jvr823f8cd2006-10-21 14:12:38 +0000306
307 if hasattr(self, "Extension"):
308 newTree = 1
309 else:
310 newTree = 0
311 for i in iRange:
jvrcfadfd02002-07-22 22:13:57 +0000312 item = items[i]
313 if hasattr(item, "getCountData"):
314 items[i] = item.getCountData()
315 elif hasattr(item, "getData"):
jvr823f8cd2006-10-21 14:12:38 +0000316 if newTree:
317 item._doneWriting()
jvrcfadfd02002-07-22 22:13:57 +0000318 else:
jvr823f8cd2006-10-21 14:12:38 +0000319 item._doneWriting(internedTables)
Behdad Esfahbodbc5e1cb2013-11-27 02:33:03 -0500320 if item in internedTables:
jvr823f8cd2006-10-21 14:12:38 +0000321 items[i] = item = internedTables[item]
322 else:
323 internedTables[item] = item
jvrcfadfd02002-07-22 22:13:57 +0000324 self.items = tuple(items)
325
jvr823f8cd2006-10-21 14:12:38 +0000326 def _gatherTables(self, tables=None, extTables=None, done=None):
327 # Convert table references in self.items tree to a flat
328 # list of tables in depth-first traversal order.
329 # "tables" are OTTableWriter objects.
330 # We do the traversal in reverse order at each level, in order to
331 # resolve duplicate references to be the last reference in the list of tables.
332 # For extension lookups, duplicate references can be merged only within the
333 # writer tree under the extension lookup.
334 if tables is None: # init call for first time.
jvrcfadfd02002-07-22 22:13:57 +0000335 tables = []
jvr823f8cd2006-10-21 14:12:38 +0000336 extTables = []
jvrcfadfd02002-07-22 22:13:57 +0000337 done = {}
jvr823f8cd2006-10-21 14:12:38 +0000338
339 done[self] = 1
340
341 numItems = len(self.items)
Behdad Esfahbod97dea0a2013-11-27 03:34:48 -0500342 iRange = list(range(numItems))
jvr823f8cd2006-10-21 14:12:38 +0000343 iRange.reverse()
344
345 if hasattr(self, "Extension"):
346 appendExtensions = 1
347 else:
348 appendExtensions = 0
349
350 # add Coverage table if it is sorted last.
351 sortCoverageLast = 0
352 if hasattr(self, "sortCoverageLast"):
353 # Find coverage table
354 for i in range(numItems):
355 item = self.items[i]
356 if hasattr(item, "name") and (item.name == "Coverage"):
357 sortCoverageLast = 1
358 break
Behdad Esfahbodbc5e1cb2013-11-27 02:33:03 -0500359 if item not in done:
jvr823f8cd2006-10-21 14:12:38 +0000360 item._gatherTables(tables, extTables, done)
361 else:
362 index = max(item.parent.keys())
363 item.parent[index + 1] = self
364
365 saveItem = None
366 for i in iRange:
367 item = self.items[i]
jvrcfadfd02002-07-22 22:13:57 +0000368 if not hasattr(item, "getData"):
369 continue
jvr823f8cd2006-10-21 14:12:38 +0000370
371 if sortCoverageLast and (i==1) and item.name == 'Coverage':
372 # we've already 'gathered' it above
373 continue
374
375 if appendExtensions:
376 assert extTables != None, "Program or XML editing error. Extension subtables cannot contain extensions subtables"
377 newDone = {}
378 item._gatherTables(extTables, None, newDone)
379
Behdad Esfahbodbc5e1cb2013-11-27 02:33:03 -0500380 elif item not in done:
jvr823f8cd2006-10-21 14:12:38 +0000381 item._gatherTables(tables, extTables, done)
382 else:
383 index = max(item.parent.keys())
384 item.parent[index + 1] = self
385
386
jvrcfadfd02002-07-22 22:13:57 +0000387 tables.append(self)
jvr823f8cd2006-10-21 14:12:38 +0000388 return tables, extTables
jvrcfadfd02002-07-22 22:13:57 +0000389
jvr4105ca02002-07-23 08:43:03 +0000390 # interface for gathering data, as used by table.compile()
jvrcfadfd02002-07-22 22:13:57 +0000391
jvr4105ca02002-07-23 08:43:03 +0000392 def getSubWriter(self):
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500393 subwriter = self.__class__(self.globalState, self.localState)
jvr823f8cd2006-10-21 14:12:38 +0000394 subwriter.parent = {0:self} # because some subtables have idential values, we discard
395 # the duplicates under the getAllData method. Hence some
396 # subtable writers can have more than one parent writer.
397 return subwriter
jvrd4d15132002-05-11 00:59:27 +0000398
399 def writeUShort(self, value):
400 assert 0 <= value < 0x10000
401 self.items.append(struct.pack(">H", value))
402
403 def writeShort(self, value):
404 self.items.append(struct.pack(">h", value))
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500405
406 def writeUInt24(self, value):
407 assert 0 <= value < 0x1000000
Behdad Esfahbodc0a9d692013-11-28 06:38:07 -0500408 b = struct.pack(">L", value)
409 self.items.append(b[1:])
jvrd4d15132002-05-11 00:59:27 +0000410
411 def writeLong(self, value):
412 self.items.append(struct.pack(">l", value))
413
jvr823f8cd2006-10-21 14:12:38 +0000414 def writeULong(self, value):
415 self.items.append(struct.pack(">L", value))
416
jvrd4d15132002-05-11 00:59:27 +0000417 def writeTag(self, tag):
Behdad Esfahbod960280b2013-11-27 18:16:43 -0500418 tag = Tag(tag).tobytes()
jvrd4d15132002-05-11 00:59:27 +0000419 assert len(tag) == 4
420 self.items.append(tag)
421
422 def writeSubTable(self, subWriter):
423 self.items.append(subWriter)
424
425 def writeCountReference(self, table, name):
Behdad Esfahbod79817042013-11-24 16:59:42 -0500426 ref = CountReference(table, name)
427 self.items.append(ref)
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500428 return ref
jvrd4d15132002-05-11 00:59:27 +0000429
430 def writeStruct(self, format, values):
Behdad Esfahbod66214cb2013-11-27 02:18:18 -0500431 data = struct.pack(*(format,) + values)
jvrd4d15132002-05-11 00:59:27 +0000432 self.items.append(data)
433
jvr823f8cd2006-10-21 14:12:38 +0000434 def writeData(self, data):
435 self.items.append(data)
jvrd4d15132002-05-11 00:59:27 +0000436
jvr823f8cd2006-10-21 14:12:38 +0000437 def getOverflowErrorRecord(self, item):
438 LookupListIndex = SubTableIndex = itemName = itemIndex = None
439 if self.name == 'LookupList':
440 LookupListIndex = item.repeatIndex
441 elif self.name == 'Lookup':
442 LookupListIndex = self.repeatIndex
443 SubTableIndex = item.repeatIndex
444 else:
445 itemName = item.name
446 if hasattr(item, 'repeatIndex'):
447 itemIndex = item.repeatIndex
448 if self.name == 'SubTable':
449 LookupListIndex = self.parent[0].repeatIndex
450 SubTableIndex = self.repeatIndex
451 elif self.name == 'ExtSubTable':
452 LookupListIndex = self.parent[0].parent[0].repeatIndex
453 SubTableIndex = self.parent[0].repeatIndex
454 else: # who knows how far below the SubTable level we are! Climb back up to the nearest subtable.
455 itemName = ".".join(self.name, item.name)
456 p1 = self.parent[0]
457 while p1 and p1.name not in ['ExtSubTable', 'SubTable']:
458 itemName = ".".join(p1.name, item.name)
459 p1 = p1.parent[0]
460 if p1:
461 if p1.name == 'ExtSubTable':
462 LookupListIndex = self.parent[0].parent[0].repeatIndex
463 SubTableIndex = self.parent[0].repeatIndex
464 else:
465 LookupListIndex = self.parent[0].repeatIndex
466 SubTableIndex = self.repeatIndex
467
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500468 return OverflowErrorRecord( (self.globalState.tableType, LookupListIndex, SubTableIndex, itemName, itemIndex) )
jvr823f8cd2006-10-21 14:12:38 +0000469
jvrd4d15132002-05-11 00:59:27 +0000470
Behdad Esfahbode388db52013-11-28 14:26:58 -0500471class CountReference(object):
jvrcfadfd02002-07-22 22:13:57 +0000472 """A reference to a Count value, not a count of references."""
jvrd4d15132002-05-11 00:59:27 +0000473 def __init__(self, table, name):
474 self.table = table
475 self.name = name
Behdad Esfahbod79817042013-11-24 16:59:42 -0500476 def setValue(self, value):
477 table = self.table
478 name = self.name
479 if table[name] is None:
480 table[name] = value
481 else:
Behdad Esfahbod1f0eed82013-11-26 18:41:53 -0500482 assert table[name] == value, (name, table[name], value)
jvrcfadfd02002-07-22 22:13:57 +0000483 def getCountData(self):
jvrd4d15132002-05-11 00:59:27 +0000484 return packUShort(self.table[self.name])
485
486
jvr64b5c802002-05-11 10:21:36 +0000487def packUShort(value):
jvrcfadfd02002-07-22 22:13:57 +0000488 assert 0 <= value < 0x10000, value
jvr64b5c802002-05-11 10:21:36 +0000489 return struct.pack(">H", value)
jvrd4d15132002-05-11 00:59:27 +0000490
491
jvr823f8cd2006-10-21 14:12:38 +0000492def packULong(value):
jvrce47e0d2008-03-09 20:48:45 +0000493 assert 0 <= value < 0x100000000, value
jvr823f8cd2006-10-21 14:12:38 +0000494 return struct.pack(">L", value)
495
496
Behdad Esfahbod5988cc32013-11-19 17:20:54 -0500497class BaseTable(object):
jvr823f8cd2006-10-21 14:12:38 +0000498 def __init__(self):
499 self.compileStatus = 0 # 0 means table was created
500 # 1 means the table.read() function was called by a table which is subject
501 # to delayed compilation
502 # 2 means that it was subject to delayed compilation, and
503 # has been decompiled
jvr823f8cd2006-10-21 14:12:38 +0000504
505 self.recurse = 0
jvrd4d15132002-05-11 00:59:27 +0000506
jvr823f8cd2006-10-21 14:12:38 +0000507 def __getattr__(self, attr):
508 # we get here only when the table does not have the attribute.
509 # This method ovveride exists so that we can try to de-compile
510 # a table which is subject to delayed decompilation, and then try
511 # to get the value again after decompilation.
512 self.recurse +=1
513 if self.recurse > 2:
514 # shouldn't ever get here - we should only get to two levels of recursion.
515 # this guards against self.decompile NOT setting compileStatus to other than 1.
Behdad Esfahbodcd5aad92013-11-27 02:42:28 -0500516 raise AttributeError(attr)
jvr823f8cd2006-10-21 14:12:38 +0000517 if self.compileStatus == 1:
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500518 self.ensureDecompiled()
jvr823f8cd2006-10-21 14:12:38 +0000519 val = getattr(self, attr)
520 self.recurse -=1
521 return val
522
Behdad Esfahbodcd5aad92013-11-27 02:42:28 -0500523 raise AttributeError(attr)
jvr823f8cd2006-10-21 14:12:38 +0000524
525
jvr64b5c802002-05-11 10:21:36 +0000526 """Generic base class for all OpenType (sub)tables."""
527
jvrd4d15132002-05-11 00:59:27 +0000528 def getConverters(self):
529 return self.converters
530
531 def getConverterByName(self, name):
532 return self.convertersByName[name]
533
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500534 def decompile(self, reader, font):
jvr823f8cd2006-10-21 14:12:38 +0000535 self.compileStatus = 2 # table has been decompiled.
jvrf7ef96c2002-09-10 19:26:38 +0000536 self.readFormat(reader)
jvrd4d15132002-05-11 00:59:27 +0000537 table = {}
538 self.__rawTable = table # for debugging
Behdad Esfahbod41caf2d2013-11-22 19:12:14 -0500539 converters = self.getConverters()
540 for conv in converters:
jvrd4d15132002-05-11 00:59:27 +0000541 if conv.name == "SubTable":
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500542 conv = conv.getConverter(reader.globalState.tableType,
jvrd4d15132002-05-11 00:59:27 +0000543 table["LookupType"])
jvr823f8cd2006-10-21 14:12:38 +0000544 if conv.name == "ExtSubTable":
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500545 conv = conv.getConverter(reader.globalState.tableType,
jvr823f8cd2006-10-21 14:12:38 +0000546 table["ExtensionLookupType"])
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500547 if conv.name == "FeatureParams":
548 conv = conv.getConverter(reader["FeatureTag"])
jvrd4d15132002-05-11 00:59:27 +0000549 if conv.repeat:
550 l = []
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500551 if conv.repeat in table:
552 countValue = table[conv.repeat]
553 else:
554 # conv.repeat is a propagated count
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500555 countValue = reader[conv.repeat]
Behdad Esfahbod6b6e9fa2013-11-24 22:11:41 -0500556 for i in range(countValue + conv.aux):
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500557 l.append(conv.read(reader, font, table))
jvrd4d15132002-05-11 00:59:27 +0000558 table[conv.name] = l
559 else:
Behdad Esfahbod5b9cabc2013-11-25 04:01:56 -0500560 if conv.aux and not eval(conv.aux, None, table):
561 continue
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500562 table[conv.name] = conv.read(reader, font, table)
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500563 if conv.isPropagated:
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500564 reader[conv.name] = table[conv.name]
Behdad Esfahbod41caf2d2013-11-22 19:12:14 -0500565
jvrd4d15132002-05-11 00:59:27 +0000566 self.postRead(table, font)
Behdad Esfahbod41caf2d2013-11-22 19:12:14 -0500567
jvrd4d15132002-05-11 00:59:27 +0000568 del self.__rawTable # succeeded, get rid of debugging info
jvr823f8cd2006-10-21 14:12:38 +0000569
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500570 def ensureDecompiled(self):
571 if self.compileStatus != 1:
572 return
Behdad Esfahbodf4e61ae2013-11-26 17:37:03 -0500573 self.decompile(self.reader, self.font)
574 del self.reader, self.font
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500575
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500576 def compile(self, writer, font):
Behdad Esfahbod3ac9e632013-11-26 19:42:55 -0500577 self.ensureDecompiled()
jvrd4d15132002-05-11 00:59:27 +0000578 table = self.preWrite(font)
jvr823f8cd2006-10-21 14:12:38 +0000579
580 if hasattr(self, 'sortCoverageLast'):
581 writer.sortCoverageLast = 1
582
jvrf7ef96c2002-09-10 19:26:38 +0000583 self.writeFormat(writer)
jvrd4d15132002-05-11 00:59:27 +0000584 for conv in self.getConverters():
585 value = table.get(conv.name)
586 if conv.repeat:
587 if value is None:
jvr64b5c802002-05-11 10:21:36 +0000588 value = []
Behdad Esfahbod6b6e9fa2013-11-24 22:11:41 -0500589 countValue = len(value) - conv.aux
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500590 if conv.repeat in table:
591 ref = table[conv.repeat]
592 table[conv.repeat] = None
593 ref.setValue(countValue)
594 else:
595 # conv.repeat is a propagated count
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500596 writer[conv.repeat].setValue(countValue)
jvr823f8cd2006-10-21 14:12:38 +0000597 for i in range(len(value)):
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500598 conv.write(writer, font, table, value[i], i)
jvrd4d15132002-05-11 00:59:27 +0000599 elif conv.isCount:
600 # Special-case Count values.
601 # Assumption: a Count field will *always* precede
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500602 # the actual array(s).
jvrd4d15132002-05-11 00:59:27 +0000603 # We need a default value, as it may be set later by a nested
Behdad Esfahbod41caf2d2013-11-22 19:12:14 -0500604 # table. We will later store it here.
jvrd4d15132002-05-11 00:59:27 +0000605 # We add a reference: by the time the data is assembled
606 # the Count value will be filled in.
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500607 ref = writer.writeCountReference(table, conv.name)
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500608 if conv.isPropagated:
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500609 table[conv.name] = None
Behdad Esfahbod79f73442013-11-26 17:07:37 -0500610 writer[conv.name] = ref
Behdad Esfahbodee27eb82013-11-24 17:34:43 -0500611 else:
612 table[conv.name] = ref
jvrd4d15132002-05-11 00:59:27 +0000613 else:
Behdad Esfahbod5b9cabc2013-11-25 04:01:56 -0500614 if conv.aux and not eval(conv.aux, None, table):
615 continue
Behdad Esfahbod078b3632013-11-24 17:08:06 -0500616 conv.write(writer, font, table, value)
Behdad Esfahbod9e1bd2d2013-11-26 19:23:08 -0500617 if conv.isPropagated:
618 writer[conv.name] = value
jvrd4d15132002-05-11 00:59:27 +0000619
jvrf7ef96c2002-09-10 19:26:38 +0000620 def readFormat(self, reader):
621 pass
622
623 def writeFormat(self, writer):
624 pass
625
jvrd4d15132002-05-11 00:59:27 +0000626 def postRead(self, table, font):
627 self.__dict__.update(table)
628
629 def preWrite(self, font):
630 return self.__dict__.copy()
631
632 def toXML(self, xmlWriter, font, attrs=None):
633 tableName = self.__class__.__name__
634 if attrs is None:
635 attrs = []
636 if hasattr(self, "Format"):
jvr64b5c802002-05-11 10:21:36 +0000637 attrs = attrs + [("Format", self.Format)]
jvrd4d15132002-05-11 00:59:27 +0000638 xmlWriter.begintag(tableName, attrs)
639 xmlWriter.newline()
640 self.toXML2(xmlWriter, font)
641 xmlWriter.endtag(tableName)
642 xmlWriter.newline()
643
644 def toXML2(self, xmlWriter, font):
645 # Simpler variant of toXML, *only* for the top level tables (like GPOS, GSUB).
646 # This is because in TTX our parent writes our main tag, and in otBase.py we
647 # do it ourselves. I think I'm getting schizophrenic...
648 for conv in self.getConverters():
jvr64b5c802002-05-11 10:21:36 +0000649 if conv.repeat:
Behdad Esfahbod5b9cabc2013-11-25 04:01:56 -0500650 value = getattr(self, conv.name)
jvrd4d15132002-05-11 00:59:27 +0000651 for i in range(len(value)):
652 item = value[i]
jvr64b5c802002-05-11 10:21:36 +0000653 conv.xmlWrite(xmlWriter, font, item, conv.name,
654 [("index", i)])
655 else:
Behdad Esfahbod5b9cabc2013-11-25 04:01:56 -0500656 if conv.aux and not eval(conv.aux, None, vars(self)):
657 continue
658 value = getattr(self, conv.name)
jvr64b5c802002-05-11 10:21:36 +0000659 conv.xmlWrite(xmlWriter, font, value, conv.name, [])
jvrd4d15132002-05-11 00:59:27 +0000660
Behdad Esfahbod3a9fd302013-11-27 03:19:32 -0500661 def fromXML(self, name, attrs, content, font):
jvrd4d15132002-05-11 00:59:27 +0000662 try:
663 conv = self.getConverterByName(name)
664 except KeyError:
jvrd4d15132002-05-11 00:59:27 +0000665 raise # XXX on KeyError, raise nice error
666 value = conv.xmlRead(attrs, content, font)
jvrd4d15132002-05-11 00:59:27 +0000667 if conv.repeat:
jvr52966bb2002-09-12 16:45:48 +0000668 seq = getattr(self, conv.name, None)
669 if seq is None:
jvrd4d15132002-05-11 00:59:27 +0000670 seq = []
jvr64b5c802002-05-11 10:21:36 +0000671 setattr(self, conv.name, seq)
jvrd4d15132002-05-11 00:59:27 +0000672 seq.append(value)
673 else:
jvr64b5c802002-05-11 10:21:36 +0000674 setattr(self, conv.name, value)
jvrd4d15132002-05-11 00:59:27 +0000675
Behdad Esfahbodb7fd2e12013-11-27 18:58:45 -0500676 def __eq__(self, other):
677 if type(self) != type(other):
678 raise TypeError("unordered types %s() < %s()", type(self), type(other))
Behdad Esfahbod96b321c2013-08-17 11:11:22 -0400679
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500680 self.ensureDecompiled()
Behdad Esfahbodb7fd2e12013-11-27 18:58:45 -0500681 other.ensureDecompiled()
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500682
Behdad Esfahbodb7fd2e12013-11-27 18:58:45 -0500683 return 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
Behdad Esfahbode388db52013-11-28 14:26:58 -0500743class ValueRecordFactory(object):
jvrd4d15132002-05-11 00:59:27 +0000744
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
Behdad Esfahbode388db52013-11-28 14:26:58 -0500791class ValueRecord(object):
jvrd4d15132002-05-11 00:59:27 +0000792
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
Behdad Esfahbodb7fd2e12013-11-27 18:58:45 -0500843 def __eq__(self, other):
844 if type(self) != type(other):
845 raise TypeError("unordered types %s() < %s()", type(self), type(other))
846 return self.__dict__ == other.__dict__