blob: f1768567092cf0afacebd36c0bb420533fcffaea [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):
291 if hasattr(other, "items"):
292 return cmp(self.items, other.items)
293 else:
294 return cmp(id(self), id(other))
295
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."""
494 def __init__(self):
495 self.stack = []
496 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
jvrd4d15132002-05-11 00:59:27 +0000517class BaseTable:
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:
540 # table.read() has been called, but table has not yet been decompiled
541 # This happens only for extension tables.
542 self.decompile(self.reader, self.font)
543 val = getattr(self, attr)
544 self.recurse -=1
545 return val
546
547 raise AttributeError, attr
548
549
jvr64b5c802002-05-11 10:21:36 +0000550 """Generic base class for all OpenType (sub)tables."""
551
jvrd4d15132002-05-11 00:59:27 +0000552 def getConverters(self):
553 return self.converters
554
555 def getConverterByName(self, name):
556 return self.convertersByName[name]
557
558 def decompile(self, reader, font, tableStack=None):
jvr823f8cd2006-10-21 14:12:38 +0000559 self.compileStatus = 2 # table has been decompiled.
jvrd4d15132002-05-11 00:59:27 +0000560 if tableStack is None:
561 tableStack = TableStack()
jvrf7ef96c2002-09-10 19:26:38 +0000562 self.readFormat(reader)
jvrd4d15132002-05-11 00:59:27 +0000563 table = {}
564 self.__rawTable = table # for debugging
565 tableStack.push(table)
566 for conv in self.getConverters():
567 if conv.name == "SubTable":
568 conv = conv.getConverter(reader.tableType,
569 table["LookupType"])
jvr823f8cd2006-10-21 14:12:38 +0000570 if conv.name == "ExtSubTable":
571 conv = conv.getConverter(reader.tableType,
572 table["ExtensionLookupType"])
jvrd4d15132002-05-11 00:59:27 +0000573 if conv.repeat:
574 l = []
575 for i in range(tableStack.getValue(conv.repeat) + conv.repeatOffset):
576 l.append(conv.read(reader, font, tableStack))
577 table[conv.name] = l
578 else:
579 table[conv.name] = conv.read(reader, font, tableStack)
580 tableStack.pop()
581 self.postRead(table, font)
582 del self.__rawTable # succeeded, get rid of debugging info
jvr823f8cd2006-10-21 14:12:38 +0000583
584 def preCompile(self):
585 pass # used only by the LookupList class
586
jvrd4d15132002-05-11 00:59:27 +0000587 def compile(self, writer, font, tableStack=None):
588 if tableStack is None:
589 tableStack = TableStack()
590 table = self.preWrite(font)
jvr823f8cd2006-10-21 14:12:38 +0000591
592 if hasattr(self, 'sortCoverageLast'):
593 writer.sortCoverageLast = 1
594
jvrf7ef96c2002-09-10 19:26:38 +0000595 self.writeFormat(writer)
jvrd4d15132002-05-11 00:59:27 +0000596 tableStack.push(table)
597 for conv in self.getConverters():
598 value = table.get(conv.name)
599 if conv.repeat:
600 if value is None:
jvr64b5c802002-05-11 10:21:36 +0000601 value = []
jvrd4d15132002-05-11 00:59:27 +0000602 tableStack.storeValue(conv.repeat, len(value) - conv.repeatOffset)
jvr823f8cd2006-10-21 14:12:38 +0000603 for i in range(len(value)):
604 conv.write(writer, font, tableStack, value[i], i)
jvrd4d15132002-05-11 00:59:27 +0000605 elif conv.isCount:
606 # Special-case Count values.
607 # Assumption: a Count field will *always* precede
608 # the actual array.
609 # We need a default value, as it may be set later by a nested
610 # table. TableStack.storeValue() will then find it here.
611 table[conv.name] = None
612 # We add a reference: by the time the data is assembled
613 # the Count value will be filled in.
614 writer.writeCountReference(table, conv.name)
615 else:
616 conv.write(writer, font, tableStack, value)
617 tableStack.pop()
618
jvrf7ef96c2002-09-10 19:26:38 +0000619 def readFormat(self, reader):
620 pass
621
622 def writeFormat(self, writer):
623 pass
624
jvrd4d15132002-05-11 00:59:27 +0000625 def postRead(self, table, font):
626 self.__dict__.update(table)
627
628 def preWrite(self, font):
629 return self.__dict__.copy()
630
631 def toXML(self, xmlWriter, font, attrs=None):
632 tableName = self.__class__.__name__
633 if attrs is None:
634 attrs = []
635 if hasattr(self, "Format"):
jvr64b5c802002-05-11 10:21:36 +0000636 attrs = attrs + [("Format", self.Format)]
jvrd4d15132002-05-11 00:59:27 +0000637 xmlWriter.begintag(tableName, attrs)
638 xmlWriter.newline()
639 self.toXML2(xmlWriter, font)
640 xmlWriter.endtag(tableName)
641 xmlWriter.newline()
642
643 def toXML2(self, xmlWriter, font):
644 # Simpler variant of toXML, *only* for the top level tables (like GPOS, GSUB).
645 # This is because in TTX our parent writes our main tag, and in otBase.py we
646 # do it ourselves. I think I'm getting schizophrenic...
647 for conv in self.getConverters():
648 value = getattr(self, conv.name)
jvr64b5c802002-05-11 10:21:36 +0000649 if conv.repeat:
jvrd4d15132002-05-11 00:59:27 +0000650 for i in range(len(value)):
651 item = value[i]
jvr64b5c802002-05-11 10:21:36 +0000652 conv.xmlWrite(xmlWriter, font, item, conv.name,
653 [("index", i)])
654 else:
655 conv.xmlWrite(xmlWriter, font, value, conv.name, [])
jvrd4d15132002-05-11 00:59:27 +0000656
657 def fromXML(self, (name, attrs, content), font):
658 try:
659 conv = self.getConverterByName(name)
660 except KeyError:
jvrd4d15132002-05-11 00:59:27 +0000661 raise # XXX on KeyError, raise nice error
662 value = conv.xmlRead(attrs, content, font)
jvrd4d15132002-05-11 00:59:27 +0000663 if conv.repeat:
jvr52966bb2002-09-12 16:45:48 +0000664 seq = getattr(self, conv.name, None)
665 if seq is None:
jvrd4d15132002-05-11 00:59:27 +0000666 seq = []
jvr64b5c802002-05-11 10:21:36 +0000667 setattr(self, conv.name, seq)
jvrd4d15132002-05-11 00:59:27 +0000668 seq.append(value)
669 else:
jvr64b5c802002-05-11 10:21:36 +0000670 setattr(self, conv.name, value)
jvrd4d15132002-05-11 00:59:27 +0000671
672 def __cmp__(self, other):
673 # this is only for debugging, so it's ok to barf
674 # when 'other' has no __dict__ or __class__
675 rv = cmp(self.__class__, other.__class__)
676 if not rv:
677 rv = cmp(self.__dict__, other.__dict__)
678 return rv
679 else:
680 return rv
681
682
683class FormatSwitchingBaseTable(BaseTable):
684
jvrcfadfd02002-07-22 22:13:57 +0000685 """Minor specialization of BaseTable, for tables that have multiple
jvr64b5c802002-05-11 10:21:36 +0000686 formats, eg. CoverageFormat1 vs. CoverageFormat2."""
687
jvrd4d15132002-05-11 00:59:27 +0000688 def getConverters(self):
689 return self.converters[self.Format]
690
691 def getConverterByName(self, name):
692 return self.convertersByName[self.Format][name]
693
jvrf7ef96c2002-09-10 19:26:38 +0000694 def readFormat(self, reader):
jvrd4d15132002-05-11 00:59:27 +0000695 self.Format = reader.readUShort()
696 assert self.Format <> 0, (self, reader.pos, len(reader.data))
jvrd4d15132002-05-11 00:59:27 +0000697
jvrf7ef96c2002-09-10 19:26:38 +0000698 def writeFormat(self, writer):
jvrd4d15132002-05-11 00:59:27 +0000699 writer.writeUShort(self.Format)
jvrd4d15132002-05-11 00:59:27 +0000700
701
jvr64b5c802002-05-11 10:21:36 +0000702#
703# Support for ValueRecords
704#
705# This data type is so different from all other OpenType data types that
706# it requires quite a bit of code for itself. It even has special support
707# in OTTableReader and OTTableWriter...
708#
709
jvrd4d15132002-05-11 00:59:27 +0000710valueRecordFormat = [
711# Mask Name isDevice signed
712 (0x0001, "XPlacement", 0, 1),
713 (0x0002, "YPlacement", 0, 1),
714 (0x0004, "XAdvance", 0, 1),
715 (0x0008, "YAdvance", 0, 1),
716 (0x0010, "XPlaDevice", 1, 0),
717 (0x0020, "YPlaDevice", 1, 0),
718 (0x0040, "XAdvDevice", 1, 0),
719 (0x0080, "YAdvDevice", 1, 0),
720# reserved:
721 (0x0100, "Reserved1", 0, 0),
722 (0x0200, "Reserved2", 0, 0),
723 (0x0400, "Reserved3", 0, 0),
724 (0x0800, "Reserved4", 0, 0),
725 (0x1000, "Reserved5", 0, 0),
726 (0x2000, "Reserved6", 0, 0),
727 (0x4000, "Reserved7", 0, 0),
728 (0x8000, "Reserved8", 0, 0),
729]
730
731def _buildDict():
732 d = {}
733 for mask, name, isDevice, signed in valueRecordFormat:
734 d[name] = mask, isDevice, signed
735 return d
736
737valueRecordFormatDict = _buildDict()
738
739
740class ValueRecordFactory:
741
jvr64b5c802002-05-11 10:21:36 +0000742 """Given a format code, this object convert ValueRecords."""
743
jvrd4d15132002-05-11 00:59:27 +0000744 def setFormat(self, valueFormat):
745 format = []
746 for mask, name, isDevice, signed in valueRecordFormat:
747 if valueFormat & mask:
748 format.append((name, isDevice, signed))
749 self.format = format
750
751 def readValueRecord(self, reader, font):
752 format = self.format
753 if not format:
754 return None
755 valueRecord = ValueRecord()
756 for name, isDevice, signed in format:
757 if signed:
758 value = reader.readShort()
759 else:
760 value = reader.readUShort()
761 if isDevice:
762 if value:
763 import otTables
764 subReader = reader.getSubReader(value)
765 value = getattr(otTables, name)()
766 value.decompile(subReader, font)
767 else:
768 value = None
769 setattr(valueRecord, name, value)
770 return valueRecord
771
772 def writeValueRecord(self, writer, font, valueRecord):
773 for name, isDevice, signed in self.format:
774 value = getattr(valueRecord, name, 0)
775 if isDevice:
776 if value:
777 subWriter = writer.getSubWriter()
778 writer.writeSubTable(subWriter)
779 value.compile(subWriter, font)
780 else:
781 writer.writeUShort(0)
782 elif signed:
783 writer.writeShort(value)
784 else:
785 writer.writeUShort(value)
786
787
788class ValueRecord:
789
790 # see ValueRecordFactory
791
792 def getFormat(self):
793 format = 0
794 for name in self.__dict__.keys():
795 format = format | valueRecordFormatDict[name][0]
796 return format
797
798 def toXML(self, xmlWriter, font, valueName, attrs=None):
799 if attrs is None:
800 simpleItems = []
801 else:
802 simpleItems = list(attrs)
803 for mask, name, isDevice, format in valueRecordFormat[:4]: # "simple" values
804 if hasattr(self, name):
805 simpleItems.append((name, getattr(self, name)))
806 deviceItems = []
807 for mask, name, isDevice, format in valueRecordFormat[4:8]: # device records
808 if hasattr(self, name):
809 device = getattr(self, name)
810 if device is not None:
811 deviceItems.append((name, device))
812 if deviceItems:
813 xmlWriter.begintag(valueName, simpleItems)
814 xmlWriter.newline()
815 for name, deviceRecord in deviceItems:
816 if deviceRecord is not None:
817 deviceRecord.toXML(xmlWriter, font)
818 xmlWriter.endtag(valueName)
819 xmlWriter.newline()
820 else:
821 xmlWriter.simpletag(valueName, simpleItems)
822 xmlWriter.newline()
823
824 def fromXML(self, (name, attrs, content), font):
825 import otTables
826 for k, v in attrs.items():
827 setattr(self, k, int(v))
828 for element in content:
829 if type(element) <> TupleType:
830 continue
831 name, attrs, content = element
832 value = getattr(otTables, name)()
833 for elem2 in content:
834 if type(elem2) <> TupleType:
835 continue
836 value.fromXML(elem2, font)
837 setattr(self, name, value)
838
839 def __cmp__(self, other):
840 # this is only for debugging, so it's ok to barf
841 # when 'other' has no __dict__ or __class__
842 rv = cmp(self.__class__, other.__class__)
843 if not rv:
844 rv = cmp(self.__dict__, other.__dict__)
845 return rv
846 else:
847 return rv
848