ttx.py revision 5ffb91eb8c7e4350eb76409d29c8a3e6a24cdfbf 
1"""\
2usage: ttx [options] inputfile1 [... inputfileN]
3
4    TTX %s -- From OpenType To XML And Back
5
6    If an input file is a TrueType or OpenType font file, it will be
7       dumped to an TTX file (an XML-based text format).
8    If an input file is a TTX file, it will be compiled to a TrueType
9       or OpenType font file.
10
11    Output files are created so they are unique: an existing file is
12       never overwritten.
13
14    General options:
15    -h Help: print this message
16    -d <outputfolder> Specify a directory where the output files are
17       to be created.
18    -o <outputfile> Specify a file to write the output to.
19    -v Verbose: more messages will be written to stdout about what
20       is being done.
21    -q Quiet: No messages will be written to stdout about what
22       is being done.
23    -a allow virtual glyphs ID's on compile or decompile.
24
25    Dump options:
26    -l List table info: instead of dumping to a TTX file, list some
27       minimal info about each table.
28    -t <table> Specify a table to dump. Multiple -t options
29       are allowed. When no -t option is specified, all tables
30       will be dumped.
31    -x <table> Specify a table to exclude from the dump. Multiple
32       -x options are allowed. -t and -x are mutually exclusive.
33    -s Split tables: save the TTX data into separate TTX files per
34       table and write one small TTX file that contains references
35       to the individual table dumps. This file can be used as
36       input to ttx, as long as the table files are in the
37       same directory.
38    -i Do NOT disassemble TT instructions: when this option is given,
39       all TrueType programs (glyph programs, the font program and the
40       pre-program) will be written to the TTX file as hex data
41       instead of assembly. This saves some time and makes the TTX
42       file smaller.
43    -z <format> Specify a bitmap data export option for EBDT:
44       {'raw', 'row', 'bitwise', 'extfile'} or for the CBDT:
45       {'raw', 'extfile'} Each option does one of the following:
46         -z raw
47            * export the bitmap data as a hex dump
48         -z row
49            * export each row as hex data
50         -z bitwise
51            * export each row as binary in an ASCII art style
52         -z extfile
53            * export the data as external files with XML refences
54       If no export format is specified 'raw' format is used.
55    -e Don't ignore decompilation errors, but show a full traceback
56       and abort.
57    -y <number> Select font number for TrueType Collection,
58       starting from 0.
59
60    Compile options:
61    -m Merge with TrueType-input-file: specify a TrueType or OpenType
62       font file to be merged with the TTX file. This option is only
63       valid when at most one TTX file is specified.
64    -b Don't recalc glyph bounding boxes: use the values in the TTX
65       file as-is.
66"""
67
68
69import sys
70import os
71import getopt
72import re
73from fontTools.ttLib import TTFont
74from fontTools.ttLib.tables.otBase import OTLOffsetOverflowError
75from fontTools.ttLib.tables.otTables import fixLookupOverFlows, fixSubTableOverFlows
76from fontTools.misc.macCreatorType import getMacCreatorAndType
77from fontTools import version
78
79def usage():
80	print __doc__ % version
81	sys.exit(2)
82
83
84numberAddedRE = re.compile("(.*)#\d+$")
85opentypeheaderRE = re.compile('''sfntVersion=['"]OTTO["']''')
86
87def makeOutputFileName(input, outputDir, extension):
88	dir, file = os.path.split(input)
89	file, ext = os.path.splitext(file)
90	if outputDir:
91		dir = outputDir
92	output = os.path.join(dir, file + extension)
93	m = numberAddedRE.match(file)
94	if m:
95		file = m.group(1)
96	n = 1
97	while os.path.exists(output):
98		output = os.path.join(dir, file + "#" + repr(n) + extension)
99		n = n + 1
100	return output
101
102
103class Options:
104
105	listTables = 0
106	outputDir = None
107	outputFile = None
108	verbose = 0
109	quiet = 0
110	splitTables = 0
111	disassembleInstructions = 1
112	mergeFile = None
113	recalcBBoxes = 1
114	allowVID = 0
115	ignoreDecompileErrors = True
116	bitmapGlyphDataFormat = 'raw'
117
118	def __init__(self, rawOptions, numFiles):
119		self.onlyTables = []
120		self.skipTables = []
121		self.fontNumber = -1
122		for option, value in rawOptions:
123			# general options
124			if option == "-h":
125				print __doc__ % version
126				sys.exit(0)
127			elif option == "-d":
128				if not os.path.isdir(value):
129					print "The -d option value must be an existing directory"
130					sys.exit(2)
131				self.outputDir = value
132			elif option == "-o":
133				self.outputFile = value
134			elif option == "-v":
135				self.verbose = 1
136			elif option == "-q":
137				self.quiet = 1
138			# dump options
139			elif option == "-l":
140				self.listTables = 1
141			elif option == "-t":
142				self.onlyTables.append(value)
143			elif option == "-x":
144				self.skipTables.append(value)
145			elif option == "-s":
146				self.splitTables = 1
147			elif option == "-i":
148				self.disassembleInstructions = 0
149			elif option == "-z":
150				validOptions = ('raw', 'row', 'bitwise', 'extfile')
151				if value not in validOptions:
152					print "-z does not allow %s as a format. Use %s" % (option, validOptions)
153					sys.exit(2)
154				self.bitmapGlyphDataFormat = value
155			elif option == "-y":
156				self.fontNumber = int(value)
157			# compile options
158			elif option == "-m":
159				self.mergeFile = value
160			elif option == "-b":
161				self.recalcBBoxes = 0
162			elif option == "-a":
163				self.allowVID = 1
164			elif option == "-e":
165				self.ignoreDecompileErrors = False
166		if self.onlyTables and self.skipTables:
167			print "-t and -x options are mutually exclusive"
168			sys.exit(2)
169		if self.mergeFile and numFiles > 1:
170			print "Must specify exactly one TTX source file when using -m"
171			sys.exit(2)
172
173
174def ttList(input, output, options):
175	import string
176	ttf = TTFont(input, fontNumber=options.fontNumber)
177	reader = ttf.reader
178	tags = reader.keys()
179	tags.sort()
180	print 'Listing table info for "%s":' % input
181	format = "    %4s  %10s  %7s  %7s"
182	print format % ("tag ", "  checksum", " length", " offset")
183	print format % ("----", "----------", "-------", "-------")
184	for tag in tags:
185		entry = reader.tables[tag]
186		checkSum = long(entry.checkSum)
187		if checkSum < 0:
188			checkSum = checkSum + 0x100000000L
189		checksum = "0x" + string.zfill(hex(checkSum)[2:-1], 8)
190		print format % (tag, checksum, entry.length, entry.offset)
191	print
192	ttf.close()
193
194
195def ttDump(input, output, options):
196	if not options.quiet:
197		print 'Dumping "%s" to "%s"...' % (input, output)
198	ttf = TTFont(input, 0, verbose=options.verbose, allowVID=options.allowVID,
199			ignoreDecompileErrors=options.ignoreDecompileErrors,
200			fontNumber=options.fontNumber)
201	ttf.saveXML(output,
202			tables=options.onlyTables,
203			skipTables=options.skipTables,
204			splitTables=options.splitTables,
205			disassembleInstructions=options.disassembleInstructions,
206			bitmapGlyphDataFormat=options.bitmapGlyphDataFormat)
207	ttf.close()
208
209
210def ttCompile(input, output, options):
211	if not options.quiet:
212		print 'Compiling "%s" to "%s"...' % (input, output)
213	ttf = TTFont(options.mergeFile,
214			recalcBBoxes=options.recalcBBoxes,
215			verbose=options.verbose, allowVID=options.allowVID)
216	ttf.importXML(input, quiet=options.quiet)
217	try:
218		ttf.save(output)
219	except OTLOffsetOverflowError, e:
220		# XXX This shouldn't be here at all, it should be as close to the
221		# OTL code as possible.
222		overflowRecord = e.value
223		print "Attempting to fix OTLOffsetOverflowError", e
224		lastItem = overflowRecord
225		while 1:
226			ok = 0
227			if overflowRecord.itemName == None:
228				ok = fixLookupOverFlows(ttf, overflowRecord)
229			else:
230				ok = fixSubTableOverFlows(ttf, overflowRecord)
231			if not ok:
232				raise
233
234			try:
235				ttf.save(output)
236				break
237			except OTLOffsetOverflowError, e:
238				print "Attempting to fix OTLOffsetOverflowError", e
239				overflowRecord = e.value
240				if overflowRecord == lastItem:
241					raise
242
243	if options.verbose:
244		import time
245		print "finished at", time.strftime("%H:%M:%S", time.localtime(time.time()))
246
247
248def guessFileType(fileName):
249	base, ext = os.path.splitext(fileName)
250	try:
251		f = open(fileName, "rb")
252	except IOError:
253		return None
254	cr, tp = getMacCreatorAndType(fileName)
255	if tp in ("sfnt", "FFIL"):
256		return "TTF"
257	if ext == ".dfont":
258		return "TTF"
259	header = f.read(256)
260	head = header[:4]
261	if head == "OTTO":
262		return "OTF"
263	elif head == "ttcf":
264		return "TTC"
265	elif head in ("\0\1\0\0", "true"):
266		return "TTF"
267	elif head.lower() == "<?xm":
268		if opentypeheaderRE.match(header):
269			return "OTX"
270		else:
271			return "TTX"
272	return None
273
274
275def parseOptions(args):
276	try:
277		rawOptions, files = getopt.getopt(args, "ld:o:vqht:x:sim:z:baey:")
278	except getopt.GetoptError:
279		usage()
280
281	if not files:
282		usage()
283
284	options = Options(rawOptions, len(files))
285	jobs = []
286
287	for input in files:
288		tp = guessFileType(input)
289		if tp in ("OTF", "TTF", "TTC"):
290			extension = ".ttx"
291			if options.listTables:
292				action = ttList
293			else:
294				action = ttDump
295		elif tp == "TTX":
296			extension = ".ttf"
297			action = ttCompile
298		elif tp == "OTX":
299			extension = ".otf"
300			action = ttCompile
301		else:
302			print 'Unknown file type: "%s"' % input
303			continue
304
305		if options.outputFile:
306			output = options.outputFile
307		else:
308			output = makeOutputFileName(input, options.outputDir, extension)
309		jobs.append((action, input, output))
310	return jobs, options
311
312
313def process(jobs, options):
314	for action, input, output in jobs:
315		action(input, output, options)
316
317
318def waitForKeyPress():
319	"""Force the DOS Prompt window to stay open so the user gets
320	a chance to see what's wrong."""
321	import msvcrt
322	print '(Hit any key to exit)'
323	while not msvcrt.kbhit():
324		pass
325
326
327def main(args):
328	jobs, options = parseOptions(args)
329	try:
330		process(jobs, options)
331	except KeyboardInterrupt:
332		print "(Cancelled.)"
333	except SystemExit:
334		if sys.platform == "win32":
335			waitForKeyPress()
336		else:
337			raise
338	except:
339		if sys.platform == "win32":
340			import traceback
341			traceback.print_exc()
342			waitForKeyPress()
343		else:
344			raise
345
346
347if __name__ == "__main__":
348	main(sys.argv[1:])
349