Skip to content
A basic OpenType GSUB and GPOS layout engine.
Python
Branch: master
Clone or download
benkiel Merge pull request #23 from hoeflerco/fix-py3
Make compatible for Python 3 by not converting text to unicode() if the version is 3 or greater
Latest commit 226e6ba Sep 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Lib/compositor
tools
.gitignore
License.txt
MANIFEST.in
README.md
demo.py
setup.py
todo.txt

README.md

compositor

A basic OpenType GSUB and GPOS layout engine written in Python.

Table of Contents


Usage Reference

This document covers the basic usage of the compositor package. For more detailed information read the documentation strings in the source.

Assumptions

Some assumptions about the OpenType fonts being used are made by the package:

  • The font is valid.
  • The font's cmap table contains Platform 3 Encoding 1.
  • The font does not contain GSUB or GPOS lookup types that are not supported by the GSUB or GPOS objects. If an unsupported lookup type is present, the lookup will simply be ignored. It will not raise an error.

The Font Object

Importing

from compositor import Font

Construction

font = Font(path)
path
A path to an OpenType font.

Special Behavior

glyph = font["aGlyphName"]

Returns the glyph object named aGlyphName. This will raise a KeyError if aGlyphName is not in the font.

isThere = "aGlyphName" in font

Returns a boolean representing if aGlyphName is in the font.

Methods

font.keys()

A list of all glyph names in the font.

glyphRecords = font.process(aString)

This is the most important method. It takes a string (Unicode or plain ASCII) and processes it with the features defined in the font's GSUB and GPOS tables. A list of GlyphRecord objects will be returned.

featureTags = font.getFeatureList()

A list of all available features in GSUB and GPOS.

state = font.getFeatureState(featureTag)

Get a boolean representing if a feature is on or not. This assumes that the feature state is consistent in both the GSUB and GPOS tables. A CompositorError will be raised if the feature is inconsistently applied. A CompositorError will be raised if featureTag is not defined in GSUB or GPOS.

font.setFeatureState(self, featureTag, state)

Set the application state of a feature.

Attributes

info
The Info object for the font.

The GlyphRecord Object

Attributes

glyphName
The name of the referenced glyph.
xPlacement
Horizontal placement.
yPlacement
Vertical placement.
xAdvance
Horizontal adjustment for advance.
yAdvance
Vertical adjustment for advance.
alternates
A list of `GlyphRecords` indicating alternates for the glyph.

The Glyph Object

Methods

glyph.draw(pen)

Draws the glyph with a FontTools pen.

Attributes

name
The name of the glyph.
index
The glyph's index within the source font.
width
The width of the glyph.
bounds
The bounding box for the glyph. Formatted as `(xMin, yMin, xMax, yMax)`. If the glyph contains no outlines, this will return `None`.

The Info Object

Attributes

  • familyName
  • styleName
  • unitsPerEm
  • ascender
  • descender

Development

Relationship to the GSUB and GPOS Specification

The Compositor GSUB and GPOS tables adhere as closely as possible to the GSUB and GPOS specification. Every effort has been made to keep terminology consistent. All known deviations from the spec are documented. (The deviations are generally trivial. For example, most the of the subtables don't implement the Count attributes. This is done because the Python iterator provides a more convenient and faster way to deal with iteration than creating a range. Therefore, the Count objects are not needed.)

Object Loading

For performance reasons, when a new font is loaded, all of the GSUB and GPOS data is extracted from the font with fontTools. The data is placed into compositor objects. These objects are then used to process text. This initial loading can be relatively expensive, but the processing speed of the objects is worth the initial expense.

Installation

To install this package, type the following in the command line:

python setup.py install
You can’t perform that action at this time.