264 lines
20 KiB
HTML
264 lines
20 KiB
HTML
|
||
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||
<html><head><title>Python: package fontTools.ttLib</title>
|
||
</head><body bgcolor="#f0f0f8">
|
||
|
||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||
<tr bgcolor="#7799ee">
|
||
<td valign=bottom> <br>
|
||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="fontTools.html"><font color="#ffffff">fontTools</font></a>.ttLib</strong></big></big></font></td
|
||
><td align=right valign=bottom
|
||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/code/fontTools/Lib/fontTools/ttLib/__init__.py">/code/fontTools/Lib/fontTools/ttLib/__init__.py</a></font></td></tr></table>
|
||
<p><tt>fontTools.ttLib -- a package for dealing with TrueType fonts.<br>
|
||
<br>
|
||
This package offers translators to convert TrueType fonts to Python <br>
|
||
objects and vice versa, and additionally from Python to TTX (an XML-based<br>
|
||
text format) and vice versa.<br>
|
||
<br>
|
||
Example interactive session:<br>
|
||
<br>
|
||
Python 1.5.2c1 (#43, Mar 9 1999, 13:06:43) [CW PPC w/GUSI w/MSL]<br>
|
||
Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam<br>
|
||
>>> from fontTools import ttLib<br>
|
||
>>> tt = ttLib.<a href="#TTFont">TTFont</a>("afont.ttf")<br>
|
||
>>> tt['maxp'].numGlyphs<br>
|
||
242<br>
|
||
>>> tt['OS/2'].achVendID<br>
|
||
'B&H '<br>
|
||
>>> tt['head'].unitsPerEm<br>
|
||
2048<br>
|
||
>>> tt.saveXML("afont.ttx")<br>
|
||
Dumping 'LTSH' table...<br>
|
||
Dumping 'OS/2' table...<br>
|
||
Dumping 'VDMX' table...<br>
|
||
Dumping 'cmap' table...<br>
|
||
Dumping 'cvt ' table...<br>
|
||
Dumping 'fpgm' table...<br>
|
||
Dumping 'glyf' table...<br>
|
||
Dumping 'hdmx' table...<br>
|
||
Dumping 'head' table...<br>
|
||
Dumping 'hhea' table...<br>
|
||
Dumping 'hmtx' table...<br>
|
||
Dumping 'loca' table...<br>
|
||
Dumping 'maxp' table...<br>
|
||
Dumping 'name' table...<br>
|
||
Dumping 'post' table...<br>
|
||
Dumping 'prep' table...<br>
|
||
>>> tt2 = ttLib.<a href="#TTFont">TTFont</a>()<br>
|
||
>>> tt2.importXML("afont.ttx")<br>
|
||
>>> tt2['maxp'].numGlyphs<br>
|
||
242<br>
|
||
>>></tt></p>
|
||
<p>
|
||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
<tr bgcolor="#aa55cc">
|
||
<td colspan=3 valign=bottom> <br>
|
||
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||
|
||
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="fontTools.ttLib.macUtils.html">macUtils</a><br>
|
||
<a href="fontTools.ttLib.sfnt.html">sfnt</a><br>
|
||
</td><td width="25%" valign=top><a href="fontTools.ttLib.standardGlyphOrder.html">standardGlyphOrder</a><br>
|
||
<a href="fontTools.ttLib.tables.html"><strong>tables</strong> (package)</a><br>
|
||
</td><td width="25%" valign=top><a href="fontTools.ttLib.test.html"><strong>test</strong> (package)</a><br>
|
||
<a href="fontTools.ttLib.xmlImport.html">xmlImport</a><br>
|
||
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
<tr bgcolor="#ee77aa">
|
||
<td colspan=3 valign=bottom> <br>
|
||
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||
|
||
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||
<td width="100%"><dl>
|
||
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>
|
||
</font></dt><dd>
|
||
<dl>
|
||
<dt><font face="helvetica, arial"><a href="fontTools.ttLib.html#TTLibError">TTLibError</a>
|
||
</font></dt></dl>
|
||
</dd>
|
||
<dt><font face="helvetica, arial"><a href="fontTools.ttLib.html#GlyphOrder">GlyphOrder</a>
|
||
</font></dt><dt><font face="helvetica, arial"><a href="fontTools.ttLib.html#TTFont">TTFont</a>
|
||
</font></dt></dl>
|
||
<p>
|
||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
<tr bgcolor="#ffc8d8">
|
||
<td colspan=3 valign=bottom> <br>
|
||
<font color="#000000" face="helvetica, arial"><a name="GlyphOrder">class <strong>GlyphOrder</strong></a></font></td></tr>
|
||
|
||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||
<td colspan=2><tt>A pseudo table. The glyph order isn't in the font as a separate<br>
|
||
table, but it's nice to present it as such in the TTX format.<br> </tt></td></tr>
|
||
<tr><td> </td>
|
||
<td width="100%">Methods defined here:<br>
|
||
<dl><dt><a name="GlyphOrder-__init__"><strong>__init__</strong></a>(self, tag)</dt></dl>
|
||
|
||
<dl><dt><a name="GlyphOrder-fromXML"><strong>fromXML</strong></a>(self, (name, attrs, content), ttFont)</dt></dl>
|
||
|
||
<dl><dt><a name="GlyphOrder-toXML"><strong>toXML</strong></a>(self, writer, ttFont)</dt></dl>
|
||
|
||
</td></tr></table> <p>
|
||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
<tr bgcolor="#ffc8d8">
|
||
<td colspan=3 valign=bottom> <br>
|
||
<font color="#000000" face="helvetica, arial"><a name="TTFont">class <strong>TTFont</strong></a></font></td></tr>
|
||
|
||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||
<td colspan=2><tt>The main font object. It manages file input and output, and offers<br>
|
||
a convenient way of accessing tables. <br>
|
||
Tables will be only decompiled when neccesary, ie. when they're actually<br>
|
||
accessed. This means that simple operations can be extremely fast.<br> </tt></td></tr>
|
||
<tr><td> </td>
|
||
<td width="100%">Methods defined here:<br>
|
||
<dl><dt><a name="TTFont-__contains__"><strong>__contains__</strong></a> = <a href="#TTFont-has_key">has_key</a>(self, tag)</dt></dl>
|
||
|
||
<dl><dt><a name="TTFont-__delitem__"><strong>__delitem__</strong></a>(self, tag)</dt></dl>
|
||
|
||
<dl><dt><a name="TTFont-__getitem__"><strong>__getitem__</strong></a>(self, tag)</dt></dl>
|
||
|
||
<dl><dt><a name="TTFont-__init__"><strong>__init__</strong></a>(self, file<font color="#909090">=None</font>, res_name_or_index<font color="#909090">=None</font>, sfntVersion<font color="#909090">='<font color="#c040c0">\x00\x01\x00\x00</font>'</font>, checkChecksums<font color="#909090">=0</font>, verbose<font color="#909090">=0</font>, recalcBBoxes<font color="#909090">=1</font>)</dt><dd><tt>The constructor can be called with a few different arguments.<br>
|
||
When reading a font from disk, 'file' should be either a pathname<br>
|
||
pointing to a file, or a readable file object. <br>
|
||
<br>
|
||
It we're running on a Macintosh, 'res_name_or_index' maybe an sfnt <br>
|
||
resource name or an sfnt resource index number or zero. The latter <br>
|
||
case will cause TTLib to autodetect whether the file is a flat file <br>
|
||
or a suitcase. (If it's a suitcase, only the first 'sfnt' resource<br>
|
||
will be read!)<br>
|
||
<br>
|
||
The 'checkChecksums' argument is used to specify how sfnt<br>
|
||
checksums are treated upon reading a file from disk:<br>
|
||
0: don't check (default)<br>
|
||
1: check, print warnings if a wrong checksum is found<br>
|
||
2: check, raise an exception if a wrong checksum is found.<br>
|
||
<br>
|
||
The <a href="#TTFont">TTFont</a> constructor can also be called without a 'file' <br>
|
||
argument: this is the way to create a new empty font. <br>
|
||
In this case you can optionally supply the 'sfntVersion' argument.<br>
|
||
<br>
|
||
If the recalcBBoxes argument is false, a number of things will *not*<br>
|
||
be recalculated upon save/compile:<br>
|
||
1) glyph bounding boxes<br>
|
||
2) maxp font bounding box<br>
|
||
3) hhea min/max values<br>
|
||
(1) is needed for certain kinds of CJK fonts (ask Werner Lemberg ;-).<br>
|
||
Additionally, upon importing an TTX file, this option cause glyphs<br>
|
||
to be compiled right away. This should reduce memory consumption <br>
|
||
greatly, and therefore should have some impact on the time needed <br>
|
||
to parse/compile large fonts.</tt></dd></dl>
|
||
|
||
<dl><dt><a name="TTFont-__len__"><strong>__len__</strong></a>(self)</dt></dl>
|
||
|
||
<dl><dt><a name="TTFont-__setitem__"><strong>__setitem__</strong></a>(self, tag, table)</dt></dl>
|
||
|
||
<dl><dt><a name="TTFont-close"><strong>close</strong></a>(self)</dt><dd><tt>If we still have a reader object, close it.</tt></dd></dl>
|
||
|
||
<dl><dt><a name="TTFont-getGlyphID"><strong>getGlyphID</strong></a>(self, glyphName)</dt></dl>
|
||
|
||
<dl><dt><a name="TTFont-getGlyphName"><strong>getGlyphName</strong></a>(self, glyphID)</dt></dl>
|
||
|
||
<dl><dt><a name="TTFont-getGlyphNames"><strong>getGlyphNames</strong></a>(self)</dt><dd><tt>Get a list of glyph names, sorted alphabetically.</tt></dd></dl>
|
||
|
||
<dl><dt><a name="TTFont-getGlyphNames2"><strong>getGlyphNames2</strong></a>(self)</dt><dd><tt>Get a list of glyph names, sorted alphabetically, <br>
|
||
but not case sensitive.</tt></dd></dl>
|
||
|
||
<dl><dt><a name="TTFont-getGlyphOrder"><strong>getGlyphOrder</strong></a>(self)</dt></dl>
|
||
|
||
<dl><dt><a name="TTFont-getGlyphSet"><strong>getGlyphSet</strong></a>(self, preferCFF<font color="#909090">=1</font>)</dt><dd><tt>Return a generic GlyphSet, which is a dict-like object<br>
|
||
mapping glyph names to glyph objects. The returned glyph objects<br>
|
||
have a .draw() method that supports the Pen protocol, and will<br>
|
||
have an attribute named 'width', but only *after* the .draw() method<br>
|
||
has been called.<br>
|
||
<br>
|
||
If the font is CFF-based, the outlines will be taken from the 'CFF '<br>
|
||
table. Otherwise the outlines will be taken from the 'glyf' table.<br>
|
||
If the font contains both a 'CFF ' and a 'glyf' table, you can use<br>
|
||
the 'preferCFF' argument to specify which one should be taken.</tt></dd></dl>
|
||
|
||
<dl><dt><a name="TTFont-getTableData"><strong>getTableData</strong></a>(self, tag)</dt><dd><tt>Returns raw table data, whether compiled or directly read from disk.</tt></dd></dl>
|
||
|
||
<dl><dt><a name="TTFont-has_key"><strong>has_key</strong></a>(self, tag)</dt></dl>
|
||
|
||
<dl><dt><a name="TTFont-importXML"><strong>importXML</strong></a>(self, file, progress<font color="#909090">=None</font>)</dt><dd><tt>Import a TTX file (an XML-based text format), so as to recreate<br>
|
||
a font object.</tt></dd></dl>
|
||
|
||
<dl><dt><a name="TTFont-isLoaded"><strong>isLoaded</strong></a>(self, tag)</dt><dd><tt>Return true if the table identified by 'tag' has been <br>
|
||
decompiled and loaded into memory.</tt></dd></dl>
|
||
|
||
<dl><dt><a name="TTFont-keys"><strong>keys</strong></a>(self)</dt></dl>
|
||
|
||
<dl><dt><a name="TTFont-save"><strong>save</strong></a>(self, file, makeSuitcase<font color="#909090">=0</font>, reorderTables<font color="#909090">=1</font>)</dt><dd><tt>Save the font to disk. Similarly to the constructor, <br>
|
||
the 'file' argument can be either a pathname or a writable<br>
|
||
file object.<br>
|
||
<br>
|
||
On the Mac, if makeSuitcase is true, a suitcase (resource fork)<br>
|
||
file will we made instead of a flat .ttf file.</tt></dd></dl>
|
||
|
||
<dl><dt><a name="TTFont-saveXML"><strong>saveXML</strong></a>(self, fileOrPath, progress<font color="#909090">=None</font>, tables<font color="#909090">=None</font>, skipTables<font color="#909090">=None</font>, splitTables<font color="#909090">=0</font>, disassembleInstructions<font color="#909090">=1</font>)</dt><dd><tt>Export the font as TTX (an XML-based text file), or as a series of text<br>
|
||
files when splitTables is true. In the latter case, the 'fileOrPath'<br>
|
||
argument should be a path to a directory.<br>
|
||
The 'tables' argument must either be false (dump all tables) or a<br>
|
||
list of tables to dump. The 'skipTables' argument may be a list of tables<br>
|
||
to skip, but only when the 'tables' argument is false.</tt></dd></dl>
|
||
|
||
<dl><dt><a name="TTFont-setGlyphOrder"><strong>setGlyphOrder</strong></a>(self, glyphOrder)</dt></dl>
|
||
|
||
</td></tr></table> <p>
|
||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
<tr bgcolor="#ffc8d8">
|
||
<td colspan=3 valign=bottom> <br>
|
||
<font color="#000000" face="helvetica, arial"><a name="TTLibError">class <strong>TTLibError</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
|
||
|
||
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
|
||
<td width="100%">Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||
<dl><dt><a name="TTLibError-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl>
|
||
|
||
<dl><dt><a name="TTLibError-__init__"><strong>__init__</strong></a>(...)</dt></dl>
|
||
|
||
<dl><dt><a name="TTLibError-__str__"><strong>__str__</strong></a>(...)</dt></dl>
|
||
|
||
</td></tr></table></td></tr></table><p>
|
||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
<tr bgcolor="#eeaa77">
|
||
<td colspan=3 valign=bottom> <br>
|
||
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||
|
||
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||
<td width="100%"><dl><dt><a name="-debugmsg"><strong>debugmsg</strong></a>(msg)</dt></dl>
|
||
<dl><dt><a name="-getTableClass"><strong>getTableClass</strong></a>(tag)</dt><dd><tt>Fetch the packer/unpacker class for a table. <br>
|
||
Return None when no class is found.</tt></dd></dl>
|
||
<dl><dt><a name="-getTableModule"><strong>getTableModule</strong></a>(tag)</dt><dd><tt>Fetch the packer/unpacker module for a table. <br>
|
||
Return None when no module is found.</tt></dd></dl>
|
||
<dl><dt><a name="-identifierToTag"><strong>identifierToTag</strong></a>(ident)</dt><dd><tt>the opposite of <a href="#-tagToIdentifier">tagToIdentifier</a>()</tt></dd></dl>
|
||
<dl><dt><a name="-newTable"><strong>newTable</strong></a>(tag)</dt><dd><tt>Return a new instance of a table.</tt></dd></dl>
|
||
<dl><dt><a name="-reorderFontTables"><strong>reorderFontTables</strong></a>(inFile, outFile, tableOrder<font color="#909090">=None</font>, checkChecksums<font color="#909090">=0</font>)</dt><dd><tt>Rewrite a font file, ordering the tables as recommended by the<br>
|
||
OpenType specification 1.4.</tt></dd></dl>
|
||
<dl><dt><a name="-sortedTagList"><strong>sortedTagList</strong></a>(tagList, tableOrder<font color="#909090">=None</font>)</dt><dd><tt>Return a sorted copy of tagList, sorted according to the OpenType<br>
|
||
specification, or according to a custom tableOrder. If given and not<br>
|
||
None, tableOrder needs to be a list of tag names.</tt></dd></dl>
|
||
<dl><dt><a name="-tagToIdentifier"><strong>tagToIdentifier</strong></a>(tag)</dt><dd><tt>Convert a table tag to a valid (but UGLY) python identifier, <br>
|
||
as well as a filename that's guaranteed to be unique even on a <br>
|
||
caseless file system. Each character is mapped to two characters.<br>
|
||
Lowercase letters get an underscore before the letter, uppercase<br>
|
||
letters get an underscore after the letter. Trailing spaces are<br>
|
||
trimmed. Illegal characters are escaped as two hex bytes. If the<br>
|
||
result starts with a number (as the result of a hex escape), an<br>
|
||
extra underscore is prepended. Examples: <br>
|
||
'glyf' -> '_g_l_y_f'<br>
|
||
'cvt ' -> '_c_v_t'<br>
|
||
'OS/2' -> 'O_S_2f_2'</tt></dd></dl>
|
||
<dl><dt><a name="-tagToXML"><strong>tagToXML</strong></a>(tag)</dt><dd><tt>Similarly to <a href="#-tagToIdentifier">tagToIdentifier</a>(), this converts a TT tag<br>
|
||
to a valid XML element name. Since XML element names are<br>
|
||
case sensitive, this is a fairly simple/readable translation.</tt></dd></dl>
|
||
<dl><dt><a name="-xmlToTag"><strong>xmlToTag</strong></a>(tag)</dt><dd><tt>The opposite of <a href="#-tagToXML">tagToXML</a>()</tt></dd></dl>
|
||
</td></tr></table><p>
|
||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
<tr bgcolor="#55aa55">
|
||
<td colspan=3 valign=bottom> <br>
|
||
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||
|
||
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||
<td width="100%"><strong>OTFTableOrder</strong> = ['head', 'hhea', 'maxp', 'OS/2', 'name', 'cmap', 'post', 'CFF ']<br>
|
||
<strong>TTFTableOrder</strong> = ['head', 'hhea', 'maxp', 'OS/2', 'hmtx', 'LTSH', 'VDMX', 'hdmx', 'cmap', 'fpgm', 'prep', 'cvt ', 'loca', 'glyf', 'kern', 'name', 'post', 'gasp', 'PCLT']<br>
|
||
<strong>endian</strong> = 'big'<br>
|
||
<strong>haveMacSupport</strong> = 1</td></tr></table>
|
||
</body></html> |