blob: f752845048b0985be1951df77fd2745310af7623 [file] [log] [blame]
jvrd4d15132002-05-11 00:59:27 +00001from DefaultTable import DefaultTable
2import otData
3import struct
4from types import TupleType
5
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):
33 import otTables
jvrcfadfd02002-07-22 22:13:57 +000034 cachingStats = None
35 reader = OTTableReader(data, self.tableTag, cachingStats=cachingStats)
jvrd4d15132002-05-11 00:59:27 +000036 tableClass = getattr(otTables, self.tableTag)
37 self.table = tableClass()
38 self.table.decompile(reader, font)
jvrcfadfd02002-07-22 22:13:57 +000039 if 0:
40 stats = [(v, k) for k, v in cachingStats.items()]
41 stats.sort()
42 stats.reverse()
43 print "cachingsstats for ", self.tableTag
44 for v, k in stats:
45 if v < 2:
46 break
47 print v, k
48 print "---", len(stats)
jvrd4d15132002-05-11 00:59:27 +000049
50 def compile(self, font):
jvr823f8cd2006-10-21 14:12:38 +000051 """ Create a top-level OTFWriter for the GPOS/GSUB table.
52 Call the compile method for the the table
jvr1c734522008-03-09 20:13:16 +000053 for each 'converter' record in the table converter list
54 call converter's write method for each item in the value.
jvr823f8cd2006-10-21 14:12:38 +000055 - For simple items, the write method adds a string to the
56 writer's self.items list.
jvr1c734522008-03-09 20:13:16 +000057 - For Struct/Table/Subtable items, it add first adds new writer to the
jvr823f8cd2006-10-21 14:12:38 +000058 to the writer's self.items, then calls the item's compile method.
59 This creates a tree of writers, rooted at the GUSB/GPOS writer, with
60 each writer representing a table, and the writer.items list containing
61 the child data strings and writers.
jvr1c734522008-03-09 20:13:16 +000062 call the getAllData method
jvr823f8cd2006-10-21 14:12:38 +000063 call _doneWriting, which removes duplicates
jvr1c734522008-03-09 20:13:16 +000064 call _gatherTables. This traverses the tables, adding unique occurences to a flat list of tables
65 Traverse the flat list of tables, calling getDataLength on each to update their position
66 Traverse the flat list of tables again, calling getData each get the data in the table, now that
67 pos's and offset are known.
jvr823f8cd2006-10-21 14:12:38 +000068
69 If a lookup subtable overflows an offset, we have to start all over.
70 """
jvrd4d15132002-05-11 00:59:27 +000071 writer = OTTableWriter(self.tableTag)
jvr823f8cd2006-10-21 14:12:38 +000072 writer.parent = None
jvrd4d15132002-05-11 00:59:27 +000073 self.table.compile(writer, font)
jvrcfadfd02002-07-22 22:13:57 +000074 return writer.getAllData()
jvr823f8cd2006-10-21 14:12:38 +000075
jvrd4d15132002-05-11 00:59:27 +000076 def toXML(self, writer, font):
77 self.table.toXML2(writer, font)
78
79 def fromXML(self, (name, attrs, content), font):
80 import otTables
81 if not hasattr(self, "table"):
82 tableClass = getattr(otTables, self.tableTag)
83 self.table = tableClass()
84 self.table.fromXML((name, attrs, content), font)
85
86
87class OTTableReader:
88
jvr64b5c802002-05-11 10:21:36 +000089 """Helper class to retrieve data from an OpenType table."""
90
jvrd4d15132002-05-11 00:59:27 +000091 def __init__(self, data, tableType, offset=0, valueFormat=None, cachingStats=None):
92 self.data = data
93 self.offset = offset
94 self.pos = offset
95 self.tableType = tableType
96 if valueFormat is None:
97 valueFormat = (ValueRecordFactory(), ValueRecordFactory())
98 self.valueFormat = valueFormat
99 self.cachingStats = cachingStats
100
101 def getSubReader(self, offset):
102 offset = self.offset + offset
103 if self.cachingStats is not None:
104 try:
105 self.cachingStats[offset] = self.cachingStats[offset] + 1
106 except KeyError:
107 self.cachingStats[offset] = 1
108
109 subReader = self.__class__(self.data, self.tableType, offset,
110 self.valueFormat, self.cachingStats)
111 return subReader
112
113 def readUShort(self):
114 pos = self.pos
115 newpos = pos + 2
jvre69caf82002-05-13 18:08:19 +0000116 value, = struct.unpack(">H", self.data[pos:newpos])
jvrd4d15132002-05-11 00:59:27 +0000117 self.pos = newpos
118 return value
119
120 def readShort(self):
121 pos = self.pos
122 newpos = pos + 2
jvre69caf82002-05-13 18:08:19 +0000123 value, = struct.unpack(">h", self.data[pos:newpos])
jvrd4d15132002-05-11 00:59:27 +0000124 self.pos = newpos
125 return value
126
127 def readLong(self):
128 pos = self.pos
129 newpos = pos + 4
jvre69caf82002-05-13 18:08:19 +0000130 value, = struct.unpack(">l", self.data[pos:newpos])
jvrd4d15132002-05-11 00:59:27 +0000131 self.pos = newpos
132 return value
133
jvr823f8cd2006-10-21 14:12:38 +0000134 def readULong(self):
135 pos = self.pos
136 newpos = pos + 4
137 value, = struct.unpack(">L", self.data[pos:newpos])
138 self.pos = newpos
139 return value
140
jvrd4d15132002-05-11 00:59:27 +0000141 def readTag(self):
142 pos = self.pos
143 newpos = pos + 4
144 value = self.data[pos:newpos]
145 assert len(value) == 4
146 self.pos = newpos
147 return value
148
149 def readStruct(self, format, size=None):
150 if size is None:
151 size = struct.calcsize(format)
152 else:
153 assert size == struct.calcsize(format)
154 pos = self.pos
155 newpos = pos + size
156 values = struct.unpack(format, self.data[pos:newpos])
157 self.pos = newpos
158 return values
159
160 def setValueFormat(self, format, which):
161 self.valueFormat[which].setFormat(format)
162
163 def readValueRecord(self, font, which):
164 return self.valueFormat[which].readValueRecord(self, font)
165
166
167class OTTableWriter:
168
jvr64b5c802002-05-11 10:21:36 +0000169 """Helper class to gather and assemble data for OpenType tables."""
170
jvrd4d15132002-05-11 00:59:27 +0000171 def __init__(self, tableType, valueFormat=None):
172 self.items = []
173 self.tableType = tableType
174 if valueFormat is None:
175 valueFormat = ValueRecordFactory(), ValueRecordFactory()
176 self.valueFormat = valueFormat
jvrcfadfd02002-07-22 22:13:57 +0000177 self.pos = None
jvrd4d15132002-05-11 00:59:27 +0000178
jvr4105ca02002-07-23 08:43:03 +0000179 # assembler interface
180
181 def getAllData(self):
182 """Assemble all data, including all subtables."""
183 self._doneWriting()
jvr823f8cd2006-10-21 14:12:38 +0000184 tables, extTables = self._gatherTables()
jvr4105ca02002-07-23 08:43:03 +0000185 tables.reverse()
jvr823f8cd2006-10-21 14:12:38 +0000186 extTables.reverse()
jvr4105ca02002-07-23 08:43:03 +0000187 # Gather all data in two passes: the absolute positions of all
188 # subtable are needed before the actual data can be assembled.
189 pos = 0
190 for table in tables:
191 table.pos = pos
192 pos = pos + table.getDataLength()
jvr823f8cd2006-10-21 14:12:38 +0000193
194 for table in extTables:
195 table.pos = pos
196 pos = pos + table.getDataLength()
197
198
jvr4105ca02002-07-23 08:43:03 +0000199 data = []
200 for table in tables:
201 tableData = table.getData()
202 data.append(tableData)
jvr823f8cd2006-10-21 14:12:38 +0000203
204 for table in extTables:
205 tableData = table.getData()
206 data.append(tableData)
207
jvr4105ca02002-07-23 08:43:03 +0000208 return "".join(data)
209
210 def getDataLength(self):
211 """Return the length of this table in bytes, without subtables."""
212 l = 0
jvr823f8cd2006-10-21 14:12:38 +0000213 if hasattr(self, "Extension"):
214 longOffset = 1
215 else:
216 longOffset = 0
jvr4105ca02002-07-23 08:43:03 +0000217 for item in self.items:
218 if hasattr(item, "getData") or hasattr(item, "getCountData"):
jvr823f8cd2006-10-21 14:12:38 +0000219 if longOffset:
220 l = l + 4 # sizeof(ULong)
221 else:
222 l = l + 2 # sizeof(UShort)
jvr4105ca02002-07-23 08:43:03 +0000223 else:
224 l = l + len(item)
225 return l
226
227 def getData(self):
228 """Assemble the data for this writer/table, without subtables."""
229 items = list(self.items) # make a shallow copy
jvr823f8cd2006-10-21 14:12:38 +0000230 if hasattr(self,"Extension"):
231 longOffset = 1
232 else:
233 longOffset = 0
234 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"):
jvr823f8cd2006-10-21 14:12:38 +0000240 if longOffset:
241 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.
247 # If the overflow is to a lookup, or from a lookup to a subtable,
248 # 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
282 raise OTLOffsetOverflowError, overflowErrorRecord
283
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 Esfahbod0ba7aa72013-10-28 12:07:15 +0100291 if type(self) != type(other): return cmp(type(self), type(other))
292 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
jvr823f8cd2006-10-21 14:12:38 +0000307 iRange = range(len(items))
308
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)
322 if internedTables.has_key(item):
323 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)
344 iRange = range(numItems)
345 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
361 if not done.has_key(item):
362 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
382 elif not done.has_key(item):
383 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):
jvr823f8cd2006-10-21 14:12:38 +0000395 subwriter = self.__class__(self.tableType, self.valueFormat)
396 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))
407
408 def writeLong(self, value):
409 self.items.append(struct.pack(">l", value))
410
jvr823f8cd2006-10-21 14:12:38 +0000411 def writeULong(self, value):
412 self.items.append(struct.pack(">L", value))
413
jvrd4d15132002-05-11 00:59:27 +0000414 def writeTag(self, tag):
415 assert len(tag) == 4
416 self.items.append(tag)
417
418 def writeSubTable(self, subWriter):
419 self.items.append(subWriter)
420
421 def writeCountReference(self, table, name):
422 self.items.append(CountReference(table, name))
423
424 def writeStruct(self, format, values):
425 data = apply(struct.pack, (format,) + values)
426 self.items.append(data)
427
jvr823f8cd2006-10-21 14:12:38 +0000428 def writeData(self, data):
429 self.items.append(data)
430
jvrd4d15132002-05-11 00:59:27 +0000431 def setValueFormat(self, format, which):
432 self.valueFormat[which].setFormat(format)
433
434 def writeValueRecord(self, value, font, which):
435 return self.valueFormat[which].writeValueRecord(self, font, value)
436
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
468 return OverflowErrorRecord( (self.tableType, LookupListIndex, SubTableIndex, itemName, itemIndex) )
469
jvrd4d15132002-05-11 00:59:27 +0000470
471class CountReference:
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
jvrcfadfd02002-07-22 22:13:57 +0000476 def getCountData(self):
jvrd4d15132002-05-11 00:59:27 +0000477 return packUShort(self.table[self.name])
478
479
jvr64b5c802002-05-11 10:21:36 +0000480def packUShort(value):
jvrcfadfd02002-07-22 22:13:57 +0000481 assert 0 <= value < 0x10000, value
jvr64b5c802002-05-11 10:21:36 +0000482 return struct.pack(">H", value)
jvrd4d15132002-05-11 00:59:27 +0000483
484
jvr823f8cd2006-10-21 14:12:38 +0000485def packULong(value):
jvrce47e0d2008-03-09 20:48:45 +0000486 assert 0 <= value < 0x100000000, value
jvr823f8cd2006-10-21 14:12:38 +0000487 return struct.pack(">L", value)
488
489
jvrd4d15132002-05-11 00:59:27 +0000490
jvr64b5c802002-05-11 10:21:36 +0000491class TableStack:
492 """A stack of table dicts, working as a stack of namespaces so we can
493 retrieve values from (and store values to) tables higher up the stack."""
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500494 def __init__(self, other=None):
495 self.stack = other.stack[:] if other else []
jvr64b5c802002-05-11 10:21:36 +0000496 def push(self, table):
Matt Fontaine65499c12013-08-05 14:35:12 -0700497 self.stack.append(table)
jvr64b5c802002-05-11 10:21:36 +0000498 def pop(self):
Matt Fontaine65499c12013-08-05 14:35:12 -0700499 self.stack.pop()
jvr64b5c802002-05-11 10:21:36 +0000500 def getTop(self):
Matt Fontaine65499c12013-08-05 14:35:12 -0700501 return self.stack[-1]
jvr64b5c802002-05-11 10:21:36 +0000502 def getValue(self, name):
503 return self.__findTable(name)[name]
504 def storeValue(self, name, value):
505 table = self.__findTable(name)
506 if table[name] is None:
507 table[name] = value
508 else:
509 assert table[name] == value, (table[name], value)
510 def __findTable(self, name):
Matt Fontaine65499c12013-08-05 14:35:12 -0700511 for table in reversed(self.stack):
jvr64b5c802002-05-11 10:21:36 +0000512 if table.has_key(name):
513 return table
514 raise KeyError, name
515
516
Behdad Esfahbod5988cc32013-11-19 17:20:54 -0500517class BaseTable(object):
jvr823f8cd2006-10-21 14:12:38 +0000518 def __init__(self):
519 self.compileStatus = 0 # 0 means table was created
520 # 1 means the table.read() function was called by a table which is subject
521 # to delayed compilation
522 # 2 means that it was subject to delayed compilation, and
523 # has been decompiled
524 # 3 means that the start and end fields have been filled out, and that we
525 # can use the data string rather than compiling from the table data.
526
527 self.recurse = 0
jvrd4d15132002-05-11 00:59:27 +0000528
jvr823f8cd2006-10-21 14:12:38 +0000529 def __getattr__(self, attr):
530 # we get here only when the table does not have the attribute.
531 # This method ovveride exists so that we can try to de-compile
532 # a table which is subject to delayed decompilation, and then try
533 # to get the value again after decompilation.
534 self.recurse +=1
535 if self.recurse > 2:
536 # shouldn't ever get here - we should only get to two levels of recursion.
537 # this guards against self.decompile NOT setting compileStatus to other than 1.
538 raise AttributeError, attr
539 if self.compileStatus == 1:
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500540 self.ensureDecompiled()
jvr823f8cd2006-10-21 14:12:38 +0000541 val = getattr(self, attr)
542 self.recurse -=1
543 return val
544
545 raise AttributeError, attr
546
547
jvr64b5c802002-05-11 10:21:36 +0000548 """Generic base class for all OpenType (sub)tables."""
549
jvrd4d15132002-05-11 00:59:27 +0000550 def getConverters(self):
551 return self.converters
552
553 def getConverterByName(self, name):
554 return self.convertersByName[name]
555
556 def decompile(self, reader, font, tableStack=None):
jvr823f8cd2006-10-21 14:12:38 +0000557 self.compileStatus = 2 # table has been decompiled.
jvrd4d15132002-05-11 00:59:27 +0000558 if tableStack is None:
559 tableStack = TableStack()
jvrf7ef96c2002-09-10 19:26:38 +0000560 self.readFormat(reader)
jvrd4d15132002-05-11 00:59:27 +0000561 table = {}
562 self.__rawTable = table # for debugging
563 tableStack.push(table)
564 for conv in self.getConverters():
565 if conv.name == "SubTable":
566 conv = conv.getConverter(reader.tableType,
567 table["LookupType"])
jvr823f8cd2006-10-21 14:12:38 +0000568 if conv.name == "ExtSubTable":
569 conv = conv.getConverter(reader.tableType,
570 table["ExtensionLookupType"])
jvrd4d15132002-05-11 00:59:27 +0000571 if conv.repeat:
572 l = []
573 for i in range(tableStack.getValue(conv.repeat) + conv.repeatOffset):
574 l.append(conv.read(reader, font, tableStack))
575 table[conv.name] = l
576 else:
577 table[conv.name] = conv.read(reader, font, tableStack)
578 tableStack.pop()
579 self.postRead(table, font)
580 del self.__rawTable # succeeded, get rid of debugging info
jvr823f8cd2006-10-21 14:12:38 +0000581
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500582 def ensureDecompiled(self):
583 if self.compileStatus != 1:
584 return
585 self.decompile(self.reader, self.font, self.tableStack)
586 del self.reader, self.font, self.tableStack
587
jvr823f8cd2006-10-21 14:12:38 +0000588 def preCompile(self):
589 pass # used only by the LookupList class
590
jvrd4d15132002-05-11 00:59:27 +0000591 def compile(self, writer, font, tableStack=None):
592 if tableStack is None:
593 tableStack = TableStack()
594 table = self.preWrite(font)
jvr823f8cd2006-10-21 14:12:38 +0000595
596 if hasattr(self, 'sortCoverageLast'):
597 writer.sortCoverageLast = 1
598
jvrf7ef96c2002-09-10 19:26:38 +0000599 self.writeFormat(writer)
jvrd4d15132002-05-11 00:59:27 +0000600 tableStack.push(table)
601 for conv in self.getConverters():
602 value = table.get(conv.name)
603 if conv.repeat:
604 if value is None:
jvr64b5c802002-05-11 10:21:36 +0000605 value = []
jvrd4d15132002-05-11 00:59:27 +0000606 tableStack.storeValue(conv.repeat, len(value) - conv.repeatOffset)
jvr823f8cd2006-10-21 14:12:38 +0000607 for i in range(len(value)):
608 conv.write(writer, font, tableStack, value[i], i)
jvrd4d15132002-05-11 00:59:27 +0000609 elif conv.isCount:
610 # Special-case Count values.
611 # Assumption: a Count field will *always* precede
612 # the actual array.
613 # We need a default value, as it may be set later by a nested
614 # table. TableStack.storeValue() will then find it here.
615 table[conv.name] = None
616 # We add a reference: by the time the data is assembled
617 # the Count value will be filled in.
618 writer.writeCountReference(table, conv.name)
619 else:
620 conv.write(writer, font, tableStack, value)
621 tableStack.pop()
622
jvrf7ef96c2002-09-10 19:26:38 +0000623 def readFormat(self, reader):
624 pass
625
626 def writeFormat(self, writer):
627 pass
628
jvrd4d15132002-05-11 00:59:27 +0000629 def postRead(self, table, font):
630 self.__dict__.update(table)
631
632 def preWrite(self, font):
Behdad Esfahbodf50d0df2013-11-20 18:38:46 -0500633 self.ensureDecompiled()
jvrd4d15132002-05-11 00:59:27 +0000634 return self.__dict__.copy()
635
636 def toXML(self, xmlWriter, font, attrs=None):
637 tableName = self.__class__.__name__
638 if attrs is None:
639 attrs = []
640 if hasattr(self, "Format"):
jvr64b5c802002-05-11 10:21:36 +0000641 attrs = attrs + [("Format", self.Format)]
jvrd4d15132002-05-11 00:59:27 +0000642 xmlWriter.begintag(tableName, attrs)
643 xmlWriter.newline()
644 self.toXML2(xmlWriter, font)
645 xmlWriter.endtag(tableName)
646 xmlWriter.newline()
647
648 def toXML2(self, xmlWriter, font):
649 # Simpler variant of toXML, *only* for the top level tables (like GPOS, GSUB).
650 # This is because in TTX our parent writes our main tag, and in otBase.py we
651 # do it ourselves. I think I'm getting schizophrenic...
652 for conv in self.getConverters():
653 value = getattr(self, conv.name)
jvr64b5c802002-05-11 10:21:36 +0000654 if conv.repeat:
jvrd4d15132002-05-11 00:59:27 +0000655 for i in range(len(value)):
656 item = value[i]
jvr64b5c802002-05-11 10:21:36 +0000657 conv.xmlWrite(xmlWriter, font, item, conv.name,
658 [("index", i)])
659 else:
660 conv.xmlWrite(xmlWriter, font, value, conv.name, [])
jvrd4d15132002-05-11 00:59:27 +0000661
662 def fromXML(self, (name, attrs, content), font):
663 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 Esfahbod0ba7aa72013-10-28 12:07:15 +0100678 if type(self) != type(other): return cmp(type(self), type(other))
679 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()
699 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."""
746
jvrd4d15132002-05-11 00:59:27 +0000747 def setFormat(self, valueFormat):
748 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:
766 import otTables
767 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
827 def fromXML(self, (name, attrs, content), font):
828 import otTables
829 for k, v in attrs.items():
830 setattr(self, k, int(v))
831 for element in content:
832 if type(element) <> TupleType:
833 continue
834 name, attrs, content = element
835 value = getattr(otTables, name)()
836 for elem2 in content:
837 if type(elem2) <> TupleType:
838 continue
839 value.fromXML(elem2, font)
840 setattr(self, name, value)
841
842 def __cmp__(self, other):
Behdad Esfahbod0ba7aa72013-10-28 12:07:15 +0100843 if type(self) != type(other): return cmp(type(self), type(other))
844 if self.__class__ != other.__class__: return cmp(self.__class__, other.__class__)
jvrd4d15132002-05-11 00:59:27 +0000845
Behdad Esfahbod96b321c2013-08-17 11:11:22 -0400846 return cmp(self.__dict__, other.__dict__)