GDEF - The Glyph Definition Table

The Glyph Definition (GDEF) table contains three types of information in three independent tables:

Both the GSUB and GPOS tables reference the GDEF table information to supplement their own data for substituting and positioning glyphs. Even so, a GDEF table is optional for a font, included at the discretion of the font developer. Without a GDEF table, however, the text-processing client may have to define and maintain the GDEF information on its own when substituting and positioning glyphs.

Overview

A client may use any one or more of the three GDEF tables during text processing. This overview explains how each of the three tables are organized and used (See Figure 7a). The rest of this chapter describes the individual GDEF tables and the tables that they reference.
 

DIAGRAM

Figure 7a. High-level organization of GDEF table

Glyph Class Definition Table

The Glyph Class Definition (GlyphClassDef) table identifies four types of glyphs in a font: simple glyphs, ligature glyphs, combining mark glyphs, and glyph components (see Figure 7b). GSUB and GPOS lookups define and use these glyph classes to differentiate the types of glyphs in a string. For example, GPOS uses the glyph classes to distinguish between a simple base glyph and the mark glyph that follows it.
 
DIAGRAM

Figure 7b. A simple glyph, ligature glyph, mark glyph, and glyph components

In addition, a client uses class definitions to apply GSUB and GPOS LookupFlag data correctly. For example, a LookupFlag may specify ignoring ligatures and marks during a glyph operation. If the font does not include a GlyphClassDef table, the client must define and maintain this information when using the GSUB and GPOS tables.

Attachment Point List Table

The Attachment Point List table (AttachmentList) identifies all the attachment points defined in the GPOS table and their associated glyphs so a client can quickly access coordinates for each glyph's attachment points. As a result, the client can cache coordinates for attachment points along with glyph bitmaps and avoid recalculating the attachment points each time it displays a glyph. Without this table, processing speed would be slower because the client would have to decode the GPOS lookups that define attachment points and compile the points in a list.

Ligature Caret List Table

The Ligature Caret List table (LigatureCaretList), particularly useful in Arabic and other scripts with many ligatures, specifies coordinates for positioning carets on all ligatures in a font. The client uses this data to select and highlight ligature components in displayed text (see Figure 7c).

DIAGRAM

Figure 7c. Proper ligature caret postioning

Each ligature can have more than one caret position, with each position defined as an X or Y value on the baseline according to the writing direction of the script or language system. The font developer can use any of three formats to represent a caret coordinate value. One format represents values in design units only, another fine-tunes a value based on a designated contour point, and the third uses a Device table to adjust values at specific font sizes.

Without a Ligature Caret List table, the client would have to define caret positions without knowing the positions of the ligature components. The resulting highlighting or hit-testing might be ambiguous. For example, suppose a client places a caret at the midpoint position along the width of a hyphothetical "wi" ligature. Because the "w" is wider than the "i," that position would not clearly indicate which component is selected. Instead, for accurate selection, the caret should be moved to the right so that either the "w" or "i" could be clearly highlighted.

GDEF Header

The GDEF table begins with a header that consists of a version number (Version), initially set to 0x00010000, an offset to a table defining the types of glyphs in the font (GlyphClassDef), an offset to a list defining attachment points on the glyphs(AttachList), and an offset to a ligature caret list (LigCaretList).

Example 1 at the end of this chapter shows a GDEF Header table.
 
GDEF Header
TypeNameDescription
fixed32VersionVersion of the GDEF table-initially 0x00010000
OffsetGlyphClassDefOffset to class definition table for glyph type-from beginning of GDEF header
OffsetAttachListOffset to list of glyphs with attachment points-from beginning of GDEF header
OffsetLigCaretListOffset to list of positioning points for ligature carets-from beginning of GDEF header
  

Glyph Class Definition Table

The GSUB and GPOS tables use the Glyph Class Definition table (GlyphClassDef) to identify which glyph classes to adjust with lookups.

The table uses the same format as the Class Definition table (for details, see the chapter, Common Table Formats). However, the GlyphClassDef table uses class values already defined in the GlyphClassDef Enumeration list:
 
GlyphClassDef Enumeration List
ClassDescription
1Simple glyph (single character, spacing glyph)
2Ligature glyph (multiple character, spacing glyph)
3Mark glyph (non-spacing combining glyph)
4Component glyph (part of single character, spacing glyph)
  

The font developer does not have to classify every glyph in the font, but any glyph not assigned a class value falls into Class zero (0). For instance, class values might be useful for the Arabic glyphs in a font, but not for the Latin glyphs. Then the GlyphClassDef table will list only Arabic glyphs, and-by default-the Latin glyphs will be assigned to Class 0.

Example 2 at the end of this chapter defines a GlyphClassDef table with a sample glyph for each of the assigned classes.

Attachment List Table

The Attachment List table (AttachList) may be used to cache attachment point coordinates along with glyph bitmaps.

The table consists of an offset to a Coverage table (Coverage) listing all glyphs that define attachment points in the GPOS table, a count of the glyphs with attachment points (GlyphCount), and an array of offsets to AttachPoint tables (AttachPoint). The array lists the AttachPoint tables, one for each glyph in the Coverage table, in the same order as the Coverage Index.
 
AttachList table
TypeNameDescription
OffsetCoverageOffset to Coverage table - from beginning of AttachList table
uint16GlyphCountNumber of glyphs with attachment points
OffsetAttachPoint[GlyphCount]Array of offsets to AttachPoint tables-from beginning of AttachList table-in Coverage Index order
  

An AttachPoint table consists of a count of the attachment points on a single glyph (PointCount) and an array of contour indices of those points (PointIndex), listed in increasing numerical order.

Example 3 at the end of the chapter demonstrates an AttachList table that defines attachment points for two glyphs.
 
AttachPoint table
TypeNameDescription
uint16PointCountNumber of attachment points on this glyph
uint16PointIndex[PointCount]Array of contour point indices -in increasing numerical order
  

Ligature Caret List Table

The Ligature Caret List table (LigCaretList) defines caret positions for all the ligatures in a font. The table consists of an offset to a Coverage table that lists all the ligature glyphs (Coverage), a count of the defined ligatures (LigGlyphCount), and an array of offsets to LigGlyph tables (LigGlyph). The array lists the LigGlyph tables, one for each ligature in the Coverage table, in the same order as the Coverage Index.

Example 4 at the end of this chapter shows a LigCaretList table.
 
LigCaretList table
TypeNameDescription
OffsetCoverageOffset to Coverage table - from beginning of LigCaretList table
uint16LigGlyphCountNumber of ligature glyphs
OffsetLigGlyph[LigGlyphCount]Array of offsets to LigGlyph tables-from beginning of LigCaretList table-in Coverage Index order
  

Ligature Glyph Table

A Ligature Glyph table (LigGlyph) contains the caret coordinates for a single ligature glyph. The number of coordinate values, each defined in a separate CaretValue table, equals the number of components in the ligature minus one (1).

The LigGlyph table consists of a count of the number of CaretValue tables defined for the ligature (CaretCount) and an array of offsets to CaretValue tables (CaretValue).

Example 4 at the end of the chapter shows a LigGlyph table.
 
LigGlyph table
TypeNameDescription
uint16CaretCountNumber of CaretValues for this ligature (components - 1)
OffsetCaretValue[CaretCount]Array of offsets to CaretValue tables-from beginning of LigGlyph table-in increasing coordinate order
  

Caret Values Table

A Caret Values table (CaretValues), which defines caret positions for a ligature, can be any of three possible formats. One format uses design units to define the caret position. The other two formats use a contour point or Device table to fine-tune a caret's position at specific font sizes and device resolutions. Caret coordinates are either X or Y values, depending upon the text direction.

CaretValue Format 1

The first format (CaretValueFormat1) consists of a format identifier (CaretValueFormat), followed by a single coordinate for the caret position (Coordinate). The Coordinate is in design units.

This format has the benefits of small size and simplicity, but the Coordinate value cannot be hinted for fine adjustments at different device resolutions.

Exampel 4 at the end of this chapter shows a CaretValueFormat1 table.
 
CaretValueFormat1 table: Design units only
TypeNameDescription
uint16CaretValueFormatFormat identifier-format = 1
int16CoordinateX or Y value, in design units
  

CaretValue Format 2

The second format (CaretValueFormat2) specifies the caret coordinate in terms of a contour point index on a specific glyph. During font hinting, the contour point on the glyph outline may move. The point's final position after hinting provides the final value for rendering a given font size.

The table contains a format identifier (CaretValueFormat) and a contour point index (CaretValuePoint).

Example 5 at the end of this chapter demonstrates a CaretValueFormat2 table.
 
CaretValueFormat2 table: Contour point
TypeNameDescription
uint16CaretValueFormatFormat identifier-format = 2
uint16CaretValuePointContour point index on glyph
  

CaretValue Format 3

The third format (CaretValueFormat3) also specifies the value in design units, but it uses a Device table rather than a contour point to adjust the value. This format offers the advantage of fine-tuning the Coordinate value for any device resolution. (For more information about Device tables, see the chapter, Common Table Formats.)

The format consists of a format identifier (CaretValueFormat), an X or Y value (Coordinate), and an offset to a Device table (DeviceTable).

Example 6 at the end of this chapter shows a CaretValueFormat3 table.
 
CaretValueFormat3 table: Design units plus Device table
TypeNameDescription
uint16CaretValueFormatFormat identifier-format = 3
int16CoordinateX or Y value, in design units
OffsetDeviceTableOffset to Device table for X or Y value-from beginning of CaretValue table
  

GDEF Table Examples

The rest of this chapter describes examples of all the GDEF table formats. All the examples reflect unique parameters described below, but the samples provide a useful reference for building tables specific to other situations.

The examples have three columns showing hex data, source, and comments.

Example 1: GDEF Header

Example 1 shows a GDEF Header definition with offsets to each of the main tables in GDEF.
 
Example 1
Hex DataSourceComments
 GDEFHeader

TheGDEFHeader
GDEFHeader table definition
000100000x00010000Version
000AGlyphClassDefTableoffset to GlyphClassDef table
0026AttachListTableoffset to AttachList table
0040LigCaretListTableoffset to LigCaretList table
  

Example 2: GlyphClassDef Table

The GlyphClassDef table in Example 2 specifies a glyph for the each of the glyph classes predefined in the GlyphClassDef Enumeration List.
 
Example 2
Hex DataSourceComments
 ClassDefFormat2
GlyphClassDefTable
ClassDef table definition
00022ClassFormat
00044ClassRangeCount
ClassRangeRecord[0]
0024iGlyphIDStart
0024iGlyphIDEnd
00011Class, 1 = simple glyphs
ClassRangeRecord[1]
009FffiLigGlyphIDStart
009FffiLigGlyphIDEnd
00022Class, 2 = ligature glyphs
ClassRangeRecord[2]
0058umlautAccentGlyphIDStart
0058umlautAccentGlyphIDEnd
00033Class, 3 = mark glyphs
ClassRangeRecord[3]
018FCurvedTailComponentGlyphIDStart
018FCurvedTailComponentGlyphIDEnd
00044Class, 4 = component glyphs
  

Example 3: AttachList Table

In Example 3, the AttachList table enumerates the attachment points defined for two glyphs. The GlyphCoverage table identifies the glyphs: "a" and "e." For each covered glyph, an AttachPoint table specifies the attachment point count and point indices: one point for the "a" glyph and two for the "e" glyph.
 
Example 3
Hex DataSourceComments
 AttachList
AttachListTable
AttachList table definition
0012GlyphCoverageoffset to Coverage table
00022GlyphCount
0008aAttachPointAttachPoint[0]
000CeAttachPointAttachPoint[1]
 AttachPoint
aAttachPoint
AttachPoint table definition
00011PointCount
001218PointIndex[0]
 AttachPoint
eAttachPoint
AttachPoint table definition
00022PointCount
000E14PointIndex[0]
001723PointIndex[1]
 CoverageFormat1
GlyphCoverage
Coverage table definition
00011CoverageFormat
00022GlyphCount
001CaGlyphIDGlyphArray[0]
0020eGlyphIDGlyphArray[1]
  

Example 4: LigCaretList Table, LigGlyph Table and CaretValueFormat1 Table

Example 4 defines a list of ligature carets. The LigCoverage table lists all the ligature glyphs that define caret positions. In this example, two ligatures are covered, "ffi" and "fi." For each covered glyph, a LigGlyph table specifies the number of carets for the ligature and their coordinate values. The "fi" ligature defines one caret, positioned between the "f" and "i" components; the "ffi" ligature defines two, one positioned between the two "f" components and the other positioned between the "f" and "i." The CaretValue tables shown here use Format1, where values are specified in design units only.
 
Example 4
Hex DataSourceComments
 LigCaretList
LigCaretListTable
LigCaretList table definition
0008LigCoverageoffset to Coverage table
00022LigGlyphCount
0010fiLigGlyphoffset to LigGlyph table[0]
0014ffiLigGlyphoffset to LigGlyph table[1]
 CoverageFormat1
LigCoverage
Coverage table definition
00011CoverageFormat
00022GlyphCount
009FffiLigGlyphIDGlyphArray[0]
00A5fiLigGlyphIDGlyphArray[1]
 LigGlyph
fiLigGlyph
LigGlyph table definition
00011CaretCount, equals the number of components - 1
000ECaretFICaretValue[0]
 LigGlyph
ffiLigGlyph
LigGlyph table definition
00022CaretCount, equals the number of components - 1
0006CaretFFI1CaretValue[0]
000ECaretFFI2CaretValue[1]
 CaretValueFormat1
CaretFI
CaretValue table definition
00011CaretValueFormat design units only
025B603Coordinate X or Y value
 CaretValueFormat1
CaretFFI1
CaretValue table definition
00011CaretValueFormat design units only
025B603Coordinate X or Y value
 CaretValueFormat1
CaretFFI2
CaretValue table definition
00011CaretValueFormat design units only
04B61206Coordinate X or Y value
  

Example 5: CaretValueFormat2 Table

Example 5 shows a CaretValueFormat2 table that specifies a ligature caret coordinate in terms of a contour point index on a specific glyph. The final position of the caret depends on the location of the contour point on the glyph after hinting.
 
Example 5
Hex DataSourceComments
 CaretValueFormat2
Caret1
CaretValue table definition
00022CaretValueFormat contour point
000D13CaretValuePoint contour point index
  

Example 6: CaretValueFormat3 Table

In Example 6, the CaretValueFormat3 table defines a caret position in design units, but includes a Device table to adjust the X or Y coordinate for the point size and resolution of the output font. Here, the Device table specifies pixel adjustments for font sizes from 12 ppem to 17 ppem.
 
Example 6
Hex DataSourceComments
 CaretValueFormat3
Caret3
CaretValue table definition
00033CaretValueFormat design units plus Device table
04B61206Coordinate X or Y value, design units
0006CaretDeviceoffset to Device table
 DeviceTableFormat2
CaretDevice
Device Table definition
000C12StartSize
001117EndSize
00022DeltaFormat
 1increase 12ppm by 1 pixel
 1increase 13ppm by 1 pixel
 1increase 14ppm by 1 pixel
11111increase 15ppm by 1 pixel
 2increase 16ppm by 1 pixel
22002increase 17ppm by 1 pixel