kitepdf-core/io.github.yuroyami.kitepdf.core.font

Package-level declarations

Types

CFF (Compact Font Format, Adobe Tech Note 5176) parser.

Subsets a CFF font program (the outlines inside an OpenType .otf) down to the glyphs a document uses, and re-emits it as a CID-keyed CFF.

CMap

class CMap

CMap parser for PDF /ToUnicode streams (ISO 32000-1 §9.10.3, Adobe Tech Note 5014).

Contour

data class Contour(val points: List<GlyphPoint>)

One contour = sequence of points around a closed loop.

Encodings

object Encodings

The four simple-font encodings PDF defines, as tables indexed by byte code.

FontFamily

typealias ~~FontFamily~~ = KiteFontFamily

FontSpec

data class FontSpec(val family: KiteFontFamily, val bold: Boolean, val italic: Boolean, val name: String = "", val language: String? = null)

Platform-neutral descriptor for picking a substitute system font when a document font ships no embedded outlines (e.g. the PDF Standard-14, or a CSS font with no @font-face file). Render backends map family + bold + italic to a host typeface, and language to a face that draws that language's own glyph forms. No PDF (or other format) types cross the canvas seam, so every document handler (PDF, EPUB, ...) feeds the same FontSpec.

GlyphBbox

data class GlyphBbox(val xMin: Int, val yMin: Int, val xMax: Int, val yMax: Int)

GlyphList

object GlyphList

The Adobe Glyph List: PostScript glyph name (e.g. "Adieresis", "fi") to Unicode codepoint.

GlyphOutline

data class GlyphOutline(val contours: List<Contour>, val bbox: GlyphBbox)

Parsed glyph outline. TrueType outlines are sequences of contours, where each contour is points with on/off-curve flags. Off-curve points are quadratic Bézier control points; consecutive off-curve points imply an implied on-curve point at their midpoint.

GlyphPoint

data class GlyphPoint(val x: Int, val y: Int, val onCurve: Boolean)

A single glyph point in font design units.

GsubGlyph

class GsubGlyph(var gid: Int, var cluster: Int, var features: Set<String> = emptySet(), val isMark: Boolean = false, val ignorable: GsubGlyph.Ignorable? = null)

One glyph of a run that OpenTypeGsub.substitute reshapes.

Head

data class Head(val flags: Int, val unitsPerEm: Int, val xMin: Int, val yMin: Int, val xMax: Int, val yMax: Int, val indexToLocFormat: Int)

Hhea

data class Hhea(val ascent: Int, val descent: Int, val lineGap: Int, val numberOfHMetrics: Int)

Hmtx

class Hmtx(widths: IntArray)

KiteCjkScript

enum class KiteCjkScript : Enum<KiteCjkScript>

The four written forms of Han characters, plus kana and Hangul, that a CJK substitute face is picked by. Unicode unifies one Han character across them (Unicode 17, 18.1), so the face, not the character, decides which form a reader sees.

KiteFontFamily

enum class KiteFontFamily : Enum<KiteFontFamily>

Broad typeface family a non-embedded font substitutes into.

Maxp

data class Maxp(val numGlyphs: Int)

OpenTypeGsub

class OpenTypeGsub

The substitution half of OpenType shaping: the GSUB table (OpenType 1.9, "GSUB: Glyph Substitution Table").

OpenTypeKern

class OpenTypeKern

Horizontal kerning for an SFNT font, from either the legacy kern table (format 0) or OpenType GPOS pair adjustment (lookup type 2, the kern feature). Returns the x-advance adjustment between two glyphs in font design units. Callers normalise to 1/1000 em like every other advance.

OpenTypeMarks

class OpenTypeMarks

GPOS mark-to-base attachment (lookup type 4): the positioning offset that places a combining mark's anchor onto its base glyph's anchor (Arabic harakat, Hebrew points, Latin/Vietnamese diacritics). The offset is returned in font design units (base anchor − mark anchor); the caller applies it to the mark glyph's origin without touching the pen advance (marks are zero-advance).

PdfFont

class PdfFont

A resolved PDF font.

PdfVerticalMetrics

class PdfVerticalMetrics

Where one glyph of vertical text sits on the pen, and how far it moves the pen, in thousandths of an em (ISO 32000-1, 9.7.4.3). PdfFont.verticalMetrics gives it.

Standard14Widths

object Standard14Widths

Glyph widths for the 14 standard fonts, in 1/1000 em.

Table

data class Table(val tag: String, val offset: Int, val length: Int)

SFNT table location in the byte buffer. Public so TtfCMap can take one as a parameter.

TextGlyph

data class TextGlyph(val byteOffset: Int, val byteCount: Int, val gid: Int, val text: String, val advanceWidth: Double, val outline: KitePath?, val isWordSpace: Boolean, val xOffset: Double = 0.0, val yOffset: Double = 0.0, val advanceAdjust: Double = 0.0)

One glyph laid out from a Tj / TJ show-text byte string.

TrueTypeFont

class TrueTypeFont

Pure-Kotlin TrueType / OpenType font parser.

TrueTypeSubsetter

object TrueTypeSubsetter

Produces a subset TrueType font containing only the glyphs a document uses (plus their composite-glyph dependencies and .notdef).

TtfCMap

class TtfCMap

TrueType / OpenType cmap table: character-code → glyph-index lookup.

TtfFormatException

class TtfFormatException(message: String) : RuntimeException

TtfReader

class TtfReader(val bytes: ByteArray)

Big-endian binary reader for SFNT / TrueType / OpenType tables.

Functions

standardFaceGlyphs

fun standardFaceGlyphs(glyphs: List<TextGlyph>, spec: FontSpec): List<TextGlyph>?

glyphs, a run of host-font text in spec, each with its outline from the bundled face that stands in for spec's generic family (standardFaceOutline), for a canvas whose host has no face of that family, as a browser has none (#593). The outlines are in units of 1000 to the em, and the advances stay the document's. Null when a glyph that draws something has no outline there, so that the run keeps the host's own text.