feaLib: Read/write OpenType feature files
fontTools’ feaLib
allows for the creation and parsing of Adobe
Font Development Kit for OpenType feature (.fea
) files. The syntax
of these files is described here.
The fontTools.feaLib.parser.Parser
class can be used to parse files
into an abstract syntax tree, and from there the
fontTools.feaLib.builder.Builder
class can add features to an existing
font file. You can inspect the parsed syntax tree, walk the tree and do clever
things with it, and also generate your own feature files programmatically, by
using the classes in the fontTools.feaLib.ast
module.
Parsing
- class fontTools.feaLib.parser.Parser(featurefile, glyphNames=(), followIncludes=True, includeDir=None, **kwargs)[source]
Bases:
object
Initializes a Parser object.
Example
from fontTools.feaLib.parser import Parser parser = Parser(file, font.getReverseGlyphMap()) parsetree = parser.parse()
Note: the
glyphNames
iterable serves a double role to help distinguish glyph names from ranges in the presence of hyphens and to ensure that glyph names referenced in a feature file are actually part of a font’s glyph set. If the iterable is left empty, no glyph name in glyph set checking takes place, and all glyph tokens containing hyphens are treated as literal glyph names, not as ranges. (Adding a space around the hyphen can, in any case, help to disambiguate ranges from glyph names containing hyphens.)By default, the parser will follow
include()
statements in the feature file. To turn this off, passfollowIncludes=False
. Pass a directory string asincludeDir
to explicitly declare a directory to search included feature files in.- parse()[source]
Parse the file, and return a
fontTools.feaLib.ast.FeatureFile
object representing the root of the abstract syntax tree containing the parsed contents of the file.
- parse_name_()[source]
Parses a name record. See section 9.e.
- parse_featureNames_(tag)[source]
Parses a
featureNames
statement found in stylistic set features. See section 8.c.
- check_glyph_name_in_glyph_set(*names)[source]
Adds a glyph name (just start) or glyph names of a range (start and end) which are not in the glyph set to the “missing list” for future error reporting.
If no glyph set is present, does nothing.
Building
- fontTools.feaLib.builder.addOpenTypeFeatures(font, featurefile, tables=None, debug=False)[source]
Add features from a file to a font. Note that this replaces any features currently present.
- Parameters:
font (feaLib.ttLib.TTFont) – The font object.
featurefile – Either a path or file object (in which case we parse it into an AST), or a pre-parsed AST instance.
tables – If passed, restrict the set of affected tables to those in the list.
debug – Whether to add source debugging information to the font in the
Debg
table
- fontTools.feaLib.builder.addOpenTypeFeaturesFromString(font, features, filename=None, tables=None, debug=False)[source]
Add features from a string to a font. Note that this replaces any features currently present.
- Parameters:
font (feaLib.ttLib.TTFont) – The font object.
features – A string containing feature code.
filename – The directory containing
filename
is used as the root of relativeinclude()
paths; ifNone
is provided, the current directory is assumed.tables – If passed, restrict the set of affected tables to those in the list.
debug – Whether to add source debugging information to the font in the
Debg
table
Generation/Interrogation
In the below, a glyph-containing object is an object of one of the following
classes: GlyphName
, GlyphClass
, GlyphClassName
.
- class fontTools.feaLib.ast.Element(location=None)[source]
Bases:
object
A base class representing “something” in a feature file.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.FeatureFile[source]
Bases:
Block
The top-level element of the syntax tree, containing the whole feature file in its
statements
attribute.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- build(builder)
When handed a ‘builder’ object of comparable interface to
fontTools.feaLib.builder
, walks the statements in this block, calling the builder callbacks.
- statements
Statements contained in the block
- class fontTools.feaLib.ast.Comment(text, location=None)[source]
Bases:
Element
A comment in a feature file.
- text
Text of the comment
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.GlyphName(glyph, location=None)[source]
Bases:
Expression
A single glyph name, such as
cedilla
.- glyph
The name itself as a string
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.GlyphClass(glyphs=None, location=None)[source]
Bases:
Expression
A glyph class, such as
[acute cedilla grave]
.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- add_range(start, end, glyphs)[source]
Add a range (e.g.
A-Z
) to the class.start
andend
are eitherGlyphName
objects or strings representing the start and end glyphs in the class, andglyphs
is the full list ofGlyphName
objects in the range.
- add_cid_range(start, end, glyphs)[source]
Add a range to the class by glyph ID.
start
andend
are the initial and final IDs, andglyphs
is the full list ofGlyphName
objects in the range.
- add_class(gc)[source]
Add glyphs from the given
GlyphClassName
object to the class.
- class fontTools.feaLib.ast.GlyphClassName(glyphclass, location=None)[source]
Bases:
Expression
A glyph class name, such as
@FRENCH_MARKS
. This must be instantiated with aGlyphClassDefinition
object.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.MarkClassName(markClass, location=None)[source]
Bases:
Expression
A mark class name, such as
@FRENCH_MARKS
defined withmarkClass
. This must be instantiated with aMarkClass
object.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.AnonymousBlock(tag, content, location=None)[source]
Bases:
Statement
An anonymous data block.
- tag
string containing the block’s “tag”
- content
block data as string
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.Block(location=None)[source]
Bases:
Statement
A block of statements: feature, lookup, etc.
- statements
Statements contained in the block
- build(builder)[source]
When handed a ‘builder’ object of comparable interface to
fontTools.feaLib.builder
, walks the statements in this block, calling the builder callbacks.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.FeatureBlock(name, use_extension=False, location=None)[source]
Bases:
Block
A named feature block.
- build(builder)[source]
Call the
start_feature
callback on the builder object, visit all the statements in this feature, and then callend_feature
.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- statements
Statements contained in the block
- class fontTools.feaLib.ast.NestedBlock(tag, block_name, location=None)[source]
Bases:
Block
A block inside another block, for example when found inside a
cvParameters
block.- build(builder)[source]
When handed a ‘builder’ object of comparable interface to
fontTools.feaLib.builder
, walks the statements in this block, calling the builder callbacks.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- statements
Statements contained in the block
- class fontTools.feaLib.ast.LookupBlock(name, use_extension=False, location=None)[source]
Bases:
Block
A named lookup, containing
statements
.- build(builder)[source]
When handed a ‘builder’ object of comparable interface to
fontTools.feaLib.builder
, walks the statements in this block, calling the builder callbacks.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- statements
Statements contained in the block
- class fontTools.feaLib.ast.GlyphClassDefinition(name, glyphs, location=None)[source]
Bases:
Statement
Example:
@UPPERCASE = [A-Z];
.- name
class name as a string, without initial
@
- glyphs
a
GlyphClass
object
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.GlyphClassDefStatement(baseGlyphs, markGlyphs, ligatureGlyphs, componentGlyphs, location=None)[source]
Bases:
Statement
Example:
GlyphClassDef @UPPERCASE, [B], [C], [D];
. The parameters must be eitherGlyphClass
orGlyphClassName
objects, orNone
.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.MarkClass(name)[source]
Bases:
object
One or more
markClass
statements for the same mark class.While glyph classes can be defined only once, the feature file format allows expanding mark classes with multiple definitions, each using different glyphs and anchors. The following are two
MarkClassDefinitions
for the sameMarkClass
:markClass [acute grave] <anchor 350 800> @FRENCH_ACCENTS; markClass [cedilla] <anchor 350 -200> @FRENCH_ACCENTS;
The
MarkClass
object is therefore just a container for a list ofMarkClassDefinition
statements.- addDefinition(definition)[source]
Add a
MarkClassDefinition
statement to this mark class.
- class fontTools.feaLib.ast.MarkClassDefinition(markClass, anchor, glyphs, location=None)[source]
Bases:
Statement
A single
markClass
statement. ThemarkClass
should be aMarkClass
object, theanchor
anAnchor
object, and theglyphs
parameter should be a glyph-containing object .Example
mc = MarkClass("FRENCH_ACCENTS") mc.addDefinition( MarkClassDefinition(mc, Anchor(350, 800), GlyphClass([ GlyphName("acute"), GlyphName("grave") ]) ) ) mc.addDefinition( MarkClassDefinition(mc, Anchor(350, -200), GlyphClass([ GlyphName("cedilla") ]) ) ) mc.asFea() # markClass [acute grave] <anchor 350 800> @FRENCH_ACCENTS; # markClass [cedilla] <anchor 350 -200> @FRENCH_ACCENTS;
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.AlternateSubstStatement(prefix, glyph, suffix, replacement, location=None)[source]
Bases:
Statement
A
sub ... from ...
statement.prefix
,glyph
,suffix
andreplacement
should be lists of glyph-containing objects.glyph
should be a one element list.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.Anchor(x, y, name=None, contourpoint=None, xDeviceTable=None, yDeviceTable=None, location=None)[source]
Bases:
Expression
An
Anchor
element, used inside apos
rule.If a
name
is given, this will be used in preference to the coordinates. Other values should be integer.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.AnchorDefinition(name, x, y, contourpoint=None, location=None)[source]
Bases:
Statement
A named anchor definition. (2.e.viii).
name
should be a string.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.AttachStatement(glyphs, contourPoints, location=None)[source]
Bases:
Statement
A
GDEF
tableAttach
statement.- glyphs
- contourPoints
A list of integer contour points
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.AxisValueLocationStatement(tag, values, location=None)[source]
Bases:
Statement
A STAT table Axis Value Location
- Parameters:
tag (str) – a 4 letter axis tag
values (list) – a list of ints and/or floats
- asFea(res='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.BaseAxis(bases, scripts, vertical, location=None)[source]
Bases:
Statement
An axis definition, being either a
VertAxis.BaseTagList/BaseScriptList
pair or aHorizAxis.BaseTagList/BaseScriptList
pair.- bases
A list of baseline tag names as strings
- scripts
A list of script record tuplets (script tag, default baseline tag, base coordinate)
- vertical
Boolean; VertAxis if True, HorizAxis if False
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.CVParametersNameStatement(nameID, platformID, platEncID, langID, string, block_name, location=None)[source]
Bases:
NameRecord
Represent a name statement inside a
cvParameters
block.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- nameID
Name ID as integer (e.g. 9 for designer’s name)
- platformID
Platform ID as integer
- platEncID
Platform encoding ID as integer
- langID
Language ID as integer
- string
Name record value
- class fontTools.feaLib.ast.ChainContextPosStatement(prefix, glyphs, suffix, lookups, location=None)[source]
Bases:
Statement
A chained contextual positioning statement.
prefix
,glyphs
, andsuffix
should be lists of glyph-containing objects .lookups
should be a list of elements representing what lookups to apply at each glyph position. Each element should be aLookupBlock
to apply a single chaining lookup at the given position, a list ofLookupBlock
s to apply multiple lookups, orNone
to apply no lookup. The length of the outer list should equal the length ofglyphs
; the inner lists can be of variable length.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.ChainContextSubstStatement(prefix, glyphs, suffix, lookups, location=None)[source]
Bases:
Statement
A chained contextual substitution statement.
prefix
,glyphs
, andsuffix
should be lists of glyph-containing objects .lookups
should be a list of elements representing what lookups to apply at each glyph position. Each element should be aLookupBlock
to apply a single chaining lookup at the given position, a list ofLookupBlock
s to apply multiple lookups, orNone
to apply no lookup. The length of the outer list should equal the length ofglyphs
; the inner lists can be of variable length.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.CharacterStatement(character, tag, location=None)[source]
Bases:
Statement
Statement used in cvParameters blocks of Character Variant features (cvXX). The Unicode value may be written with either decimal or hexadecimal notation. The value must be preceded by ‘0x’ if it is a hexadecimal value. The largest Unicode value allowed is 0xFFFFFF.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.ConditionsetStatement(name, conditions, location=None)[source]
Bases:
Statement
A variable layout conditionset
- Parameters:
name (str) – the name of this conditionset
conditions (dict) – a dictionary mapping axis tags to a tuple of (min,max) userspace coordinates.
- asFea(res='', indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.CursivePosStatement(glyphclass, entryAnchor, exitAnchor, location=None)[source]
Bases:
Statement
A cursive positioning statement. Entry and exit anchors can either be
Anchor
objects orNone
.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.ElidedFallbackName(names, location=None)[source]
Bases:
Statement
STAT table ElidedFallbackName
- Parameters:
names – a list of
STATNameStatement
objects
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.ElidedFallbackNameID(value, location=None)[source]
Bases:
Statement
STAT table ElidedFallbackNameID
- Parameters:
value – an int pointing to an existing name table name ID
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.Expression(location=None)[source]
Bases:
Element
- asFea(indent='')
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.FeatureNameStatement(nameID, platformID, platEncID, langID, string, location=None)[source]
Bases:
NameRecord
Represents a
sizemenuname
orname
statement.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- nameID
Name ID as integer (e.g. 9 for designer’s name)
- platformID
Platform ID as integer
- platEncID
Platform encoding ID as integer
- langID
Language ID as integer
- string
Name record value
- class fontTools.feaLib.ast.FeatureReferenceStatement(featureName, location=None)[source]
Bases:
Statement
Example:
feature salt;
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.FontRevisionStatement(revision, location=None)[source]
Bases:
Statement
A
head
tableFontRevision
statement.revision
should be a number, and will be formatted to three significant decimal places.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.HheaField(key, value, location=None)[source]
Bases:
Statement
An entry in the
hhea
table.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.IgnorePosStatement(chainContexts, location=None)[source]
Bases:
Statement
An
ignore pos
statement, containing one or more contexts to ignore.chainContexts
should be a list of(prefix, glyphs, suffix)
tuples, with each ofprefix
,glyphs
andsuffix
being glyph-containing objects .- build(builder)[source]
Calls the builder object’s
add_chain_context_pos
callback on each rule context.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.IgnoreSubstStatement(chainContexts, location=None)[source]
Bases:
Statement
An
ignore sub
statement, containing one or more contexts to ignore.chainContexts
should be a list of(prefix, glyphs, suffix)
tuples, with each ofprefix
,glyphs
andsuffix
being glyph-containing objects .- build(builder)[source]
Calls the builder object’s
add_chain_context_subst
callback on each rule context.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.IncludeStatement(filename, location=None)[source]
Bases:
Statement
An
include()
statement.- filename
String containing name of file to include
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.LanguageStatement(language, include_default=True, required=False, location=None)[source]
Bases:
Statement
A
language
statement within a feature.- language
A four-character language tag
- include_default
If false, “exclude_dflt”
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.LanguageSystemStatement(script, language, location=None)[source]
Bases:
Statement
A top-level
languagesystem
statement.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.LigatureCaretByIndexStatement(glyphs, carets, location=None)[source]
Bases:
Statement
A
GDEF
tableLigatureCaretByIndex
statement.glyphs
should be a glyph-containing object, andcarets
should be a list of integers.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.LigatureCaretByPosStatement(glyphs, carets, location=None)[source]
Bases:
Statement
A
GDEF
tableLigatureCaretByPos
statement.glyphs
should be a glyph-containing object, andcarets
should be a list of integers.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.LigatureSubstStatement(prefix, glyphs, suffix, replacement, forceChain, location=None)[source]
Bases:
Statement
A chained contextual substitution statement.
prefix
,glyphs
, andsuffix
should be lists of glyph-containing objects;replacement
should be a single glyph-containing object.If
forceChain
is True, this is expressed as a chaining rule (e.g.sub f' i' by f_i
) even when no context is given.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.LookupFlagStatement(value=0, markAttachment=None, markFilteringSet=None, location=None)[source]
Bases:
Statement
A
lookupflag
statement. Thevalue
should be an integer value representing the flags in use, but not including themarkAttachment
class andmarkFilteringSet
values, which must be specified as glyph-containing objects.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.LookupReferenceStatement(lookup, location=None)[source]
Bases:
Statement
Represents a
lookup ...;
statement to include a lookup in a feature.The
lookup
should be aLookupBlock
object.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.MarkBasePosStatement(base, marks, location=None)[source]
Bases:
Statement
A mark-to-base positioning rule. The
base
should be a glyph-containing object. Themarks
should be a list of (Anchor
,MarkClass
) tuples.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.MarkLigPosStatement(ligatures, marks, location=None)[source]
Bases:
Statement
A mark-to-ligature positioning rule. The
ligatures
must be a glyph-containing object. Themarks
should be a list of lists: each element in the top-level list represents a component glyph, and is made up of a list of (Anchor
,MarkClass
) tuples representing mark attachment points for that position.Example:
m1 = MarkClass("TOP_MARKS") m2 = MarkClass("BOTTOM_MARKS") # ... add definitions to mark classes... glyph = GlyphName("lam_meem_jeem") marks = [ [ (Anchor(625,1800), m1) ], # Attachments on 1st component (lam) [ (Anchor(376,-378), m2) ], # Attachments on 2nd component (meem) [ ] # No attachments on the jeem ] mlp = MarkLigPosStatement(glyph, marks) mlp.asFea() # pos ligature lam_meem_jeem <anchor 625 1800> mark @TOP_MARKS # ligComponent <anchor 376 -378> mark @BOTTOM_MARKS;
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.MarkMarkPosStatement(baseMarks, marks, location=None)[source]
Bases:
Statement
A mark-to-mark positioning rule. The
baseMarks
must be a glyph-containing object. Themarks
should be a list of (Anchor
,MarkClass
) tuples.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.MultipleSubstStatement(prefix, glyph, suffix, replacement, forceChain=False, location=None)[source]
Bases:
Statement
A multiple substitution statement.
- Parameters:
prefix – a list of glyph-containing objects.
glyph – a single glyph-containing object.
suffix – a list of glyph-containing objects.
replacement – a list of glyph-containing objects.
forceChain – If true, the statement is expressed as a chaining rule (e.g.
sub f' i' by f_i
) even when no context is given.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.NameRecord(nameID, platformID, platEncID, langID, string, location=None)[source]
Bases:
Statement
Represents a name record. (Section 9.e.)
- nameID
Name ID as integer (e.g. 9 for designer’s name)
- platformID
Platform ID as integer
- platEncID
Platform encoding ID as integer
- langID
Language ID as integer
- string
Name record value
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.OS2Field(key, value, location=None)[source]
Bases:
Statement
An entry in the
OS/2
table. Mostvalues
should be numbers or strings, apart from when the key isUnicodeRange
,CodePageRange
orPanose
, in which case it should be an array of integers.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.PairPosStatement(glyphs1, valuerecord1, glyphs2, valuerecord2, enumerated=False, location=None)[source]
Bases:
Statement
A pair positioning statement.
glyphs1
andglyphs2
should be glyph-containing objects.valuerecord1
should be aValueRecord
object;valuerecord2
should be either aValueRecord
object orNone
. Ifenumerated
is true, then this is expressed as an enumerated pair.- build(builder)[source]
Calls a callback on the builder object:
If the rule is enumerated, calls
add_specific_pair_pos
on each combination of first and second glyphs.If the glyphs are both single
GlyphName
objects, callsadd_specific_pair_pos
.Else, calls
add_class_pair_pos
.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.ReverseChainSingleSubstStatement(old_prefix, old_suffix, glyphs, replacements, location=None)[source]
Bases:
Statement
A reverse chaining substitution statement. You don’t see those every day.
Note the unusual argument order:
suffix
comes beforeglyphs
.old_prefix
,old_suffix
,glyphs
andreplacements
should be lists of glyph-containing objects.glyphs
andreplacements
should be one-item lists.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.ScriptStatement(script, location=None)[source]
Bases:
Statement
A
script
statement.- script
the script code
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.SinglePosStatement(pos, prefix, suffix, forceChain, location=None)[source]
Bases:
Statement
A single position statement.
prefix
andsuffix
should be lists of glyph-containing objects.pos
should be a one-element list containing a (glyph-containing object,ValueRecord
) tuple.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.SingleSubstStatement(glyphs, replace, prefix, suffix, forceChain, location=None)[source]
Bases:
Statement
A single substitution statement.
Note the unusual argument order:
prefix
and suffix come after the replacementglyphs
.prefix
,suffix
,glyphs
andreplace
should be lists of glyph-containing objects.glyphs
andreplace
should be one-item lists.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.SizeParameters(DesignSize, SubfamilyID, RangeStart, RangeEnd, location=None)[source]
Bases:
Statement
A
parameters
statement.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.Statement(location=None)[source]
Bases:
Element
- asFea(indent='')
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.STATAxisValueStatement(names, locations, flags, location=None)[source]
Bases:
Statement
A STAT table Axis Value Record
- Parameters:
names (list) – a list of
STATNameStatement
objectslocations (list) – a list of
AxisValueLocationStatement
objectsflags (int) – an int
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.STATDesignAxisStatement(tag, axisOrder, names, location=None)[source]
Bases:
Statement
A STAT table Design Axis
- Parameters:
tag (str) – a 4 letter axis tag
axisOrder (int) – an int
names (list) – a list of
STATNameStatement
objects
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.STATNameStatement(nameID, platformID, platEncID, langID, string, location=None)[source]
Bases:
NameRecord
Represents a STAT table
name
statement.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- build(builder)
Calls the builder object’s
add_name_record
callback.
- nameID
Name ID as integer (e.g. 9 for designer’s name)
- platformID
Platform ID as integer
- platEncID
Platform encoding ID as integer
- langID
Language ID as integer
- string
Name record value
- class fontTools.feaLib.ast.SubtableStatement(location=None)[source]
Bases:
Statement
Represents a subtable break.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.TableBlock(name, location=None)[source]
Bases:
Block
A
table ... { }
block.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- build(builder)
When handed a ‘builder’ object of comparable interface to
fontTools.feaLib.builder
, walks the statements in this block, calling the builder callbacks.
- statements
Statements contained in the block
- class fontTools.feaLib.ast.ValueRecord(xPlacement=None, yPlacement=None, xAdvance=None, yAdvance=None, xPlaDevice=None, yPlaDevice=None, xAdvDevice=None, yAdvDevice=None, vertical=False, location=None)[source]
Bases:
Expression
Represents a value record.
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.ValueRecordDefinition(name, value, location=None)[source]
Bases:
Statement
Represents a named value record definition.
- name
Value record name as string
- value
ValueRecord
object
- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.
- class fontTools.feaLib.ast.VheaField(key, value, location=None)[source]
Bases:
Statement
An entry in the
vhea
table.- asFea(indent='')[source]
Returns this element as a string of feature code. For block-type elements (such as
FeatureBlock
), the indent string is added to the start of each line in the output.