Behdad Esfahbod 90417543fd [aat] Match CoreText kerx format 1 history (#6540)
* [test] Probe CoreText kerx stack behavior

Add native CoreText probes for list reuse, excess values, zero values,
duplicate pushes, repeated actions, resets, and long lists. Run them on
macOS 15 and macOS latest to establish the compatibility behavior before
changing the kerx driver.

The local baseline Meson suite passes all 275 tests. Native execution
is intentionally checked by the new macOS probe jobs.

Related: https://github.com/harfbuzz/harfbuzz/pull/6538#issuecomment-6561986849
Assisted-by: OpenAI Codex

* [test] Probe retained kerx history past eight pushes

Add an end-of-text action after twenty repeated push/action entries to
distinguish retained history from an eight-entry rolling window.

The local Meson suite passes all 275 tests.

Assisted-by: OpenAI Codex

* [test] Probe kerx history wraparound and reset reuse

Add native cases around the eight-slot boundary, actions before the
first push, a first push after ignored glyphs, and history reuse after
reset. These distinguish partial-history initialization and cursor
wraparound for the CoreText compatibility implementation.

Testing: all 275 Meson tests pass with the implementation in progress.

Assisted-by: OpenAI Codex

* [test] Verify kerx reset anchors and Arabic examples in CoreText

Measure a reset followed by another action without a push, and include
both versions of the reported Arabic font. Use mapped glyphs for ignored
prefixes so font fallback cannot affect the native position comparison.

Testing: all 275 Meson tests pass with the implementation in progress.

Assisted-by: OpenAI Codex

* [test] Probe long kerx lists after resetting history

Distinguish how reset initializes unused history slots by applying a
long list after a reset with and without a push, and after every push.

Testing: all 275 Meson tests pass with the implementation in progress.

Assisted-by: OpenAI Codex

* [aat] Match CoreText kerx format 1 history

The written kerx rules describe destructive stack pops and a reset flag.
Native CoreText retains an eight-slot circular history, initializes its
unused slots to the first glyph, and ignores reset. Each action list
walks the history independently and wraps after eight values.

Use that behavior for extended kerx while retaining legacy kern rules.
Bound the longer action-list walks by the buffer operation budget and
keep fixed-size history storage. Document the spec discrepancy and add
regressions for reuse, wraparound, initial slots, reset, and both Arabic
examples, plus terminated and unterminated over-budget lists.

Testing: all 275 Meson tests pass. HB and HR match glyph identities,
character indices, positions, and final extents for all 35 native cases
on macOS 15.8.2 and 26.6.2. Both Arabic examples match their GPOS reference.

Fixes: https://github.com/harfbuzz/harfbuzz/issues/6536
Assisted-by: OpenAI Codex

* [ci] Remove exploratory CoreText kerx probe jobs

The native measurements established the compatibility behavior, which
is now covered by the normal shaping regressions in HB and HR. Keep the
manual probe, recorded results, and discrepancy documentation without
adding two native macOS jobs to every pull request.

CI and documentation only; no code or test inputs changed.

Assisted-by: OpenAI Codex

* [test] Run kerx CoreText comparisons with shaping tests

Move the native helper and reference data from .ci into test/shape.
Run the native comparison as a normal CoreText-enabled macOS Meson
shaping test, using the existing macOS CI job. Keep the discrepancy
explanation beside the regression cases and drop the standalone Markdown.

Testing: all 275 Linux Meson tests pass. The comparison runner passes
all 35 recorded cases and rejects an injected position mismatch. The
native helper is unchanged from the macOS 15.8.2 and 26.6.2 measurements.

Assisted-by: OpenAI Codex

* [test] Keep kerx regressions in the shaping suite

Remove the API C budget test, native CoreText C helper, comparison
runner, reference JSON files, and extra Meson test target. Retain the
library fix and normal shaping regressions, with a short explanation of
the native behavior in the shaping test file.

Testing: all 275 Meson tests pass.

Assisted-by: OpenAI Codex
2026-11-01 13:35:37 -07:00
2019-04-21 12:26:07 -04:00
2026-04-06 17:08:50 -06:00
2022-06-21 13:19:08 -06:00
2026-10-22 19:31:32 +03:00
2026-10-22 19:31:32 +03:00
2026-01-24 14:04:46 +02:00
2023-04-14 11:35:34 -06:00
2022-08-03 11:31:34 -06:00
2023-11-06 13:25:42 -07:00

HarfBuzz

HarfBuzz Logo

Linux CI Status macoOS CI Status Windows CI Status OSS-Fuzz Status Coverity Scan Build Status Packaging status OpenSSF Scorecard

HarfBuzz started as a text shaping engine but has grown into a full font platform — the ffmpeg of text shaping. It primarily supports OpenType, but also Apple Advanced Typography.

HarfBuzz shapes the majority of text on modern screens.

HarfBuzz is optimized for robustness, correctness, and performance — in that order. Achieve all.

Try it live at harfbuzz-world.cc — an interactive playground for shaping, subsetting, rasterization, vector output, and GPU rendering, all running in your browser.

Here is a quick map of its components:

Core libraries

Library Description
libharfbuzz Text shaping, draw API, paint API. Highly configurable (see CONFIG.md). Optional integration backends compiled in: hb-ft (FreeType), hb-coretext (macOS), hb-uniscribe (Windows), hb-directwrite (Windows), hb-gdi (Windows), hb-glib, hb-graphite2.
libharfbuzz-subset Font subsetting and variable-font instancing.

Auxiliary libraries

Library Description
libharfbuzz-icu ICU Unicode integration.
libharfbuzz-cairo Cairo rendering integration.
libharfbuzz-gobject GObject/GI bindings.

Rendering libraries

Library Description
libharfbuzz-raster Glyph rasterization to bitmaps, including color fonts. Uses hb-draw and hb-paint.
libharfbuzz-vector Glyph output to vector formats (currently SVG), including color fonts. Uses hb-draw and hb-paint.
libharfbuzz-gpu Encodes glyph outlines for GPU rasterization (Slug algorithm). Provides shader sources in GLSL, WGSL, MSL, and HLSL. Live demo.

Notable missing feature: font hinting (including autohinting) is not implemented. For hinted rasterization, use FreeType or Skrifa.

For simplified builds, amalgamated sources are available: harfbuzz.cc (just libharfbuzz), harfbuzz-subset.cc (just libharfbuzz-subset), or harfbuzz-world.cc (everything, driven by a custom hb-features.h). For a live in-browser playground plus a worked example of the world.cc single-file build, see harfbuzz-world.cc.

Command-line tools

Tool Description
hb-shape Shape text and display glyph output.
hb-view Render shaped text to an image.
hb-subset Subset and optimize fonts.
hb-info Display font metadata.
hb-raster Render glyphs to bitmap images.
hb-vector Render glyphs to vector formats (SVG).
hb-gpu Interactive GPU text rendering.

The canonical source tree and bug trackers are available on github. Both development and user support discussion around HarfBuzz happen on github as well.

For license information, see COPYING.

API stability

The API that comes with hb.h will not change incompatibly. Other, peripheral, headers are more likely to go through minor modifications, but again, we do our best to never change API in an incompatible way. We will never break the ABI.

The API and ABI are stable even across major version number jumps. In fact, current HarfBuzz is API/ABI compatible all the way back to the 0.9.x series. If one day we need to break the API/ABI, that would be called a new library.

As such, we bump the major version number only when we add major new features, the minor version when there is new API, and the micro version when there are bug fixes.

Documentation

For user manual as well as API documentation, check: https://harfbuzz.github.io

Download

Tarball releases and Win32/Win64 binary bundles are available on the github releases page.

Development

For build information, see BUILD.md.

For custom configurations, see CONFIG.md.

For testing and profiling, see TESTING.md.

For using with Python, see README.python.md. There is also uharfbuzz.

For cross-compiling to Windows from Linux or macOS, see README.mingw.md.

To report bugs or submit patches please use github issues and pull-requests.

Developer documents

To get a better idea of where HarfBuzz stands in the text rendering stack you may want to read State of Text Rendering 2024. Here are a few presentation slides about HarfBuzz over the years:

More presentations and papers are available on behdad's website. In particular, the following studies are relevant to HarfBuzz development:

Name

HarfBuzz /hærfˈbɒːz/

From Persian حرف (Harf: letter) and باز (Buzz: open). Transliteration of the Persian calque for OpenType.

As a noun: The Open Source text shaping engine.

As an adjective: Insincerely talkative; glib. A nod to the GNOME project where HarfBuzz originates from.

The logo shows حرف‌باز in the IranNastaliq font, on a Damascus steel background.

Background: Originally there was this font format called TrueType. People and companies started calling their type engines all things ending in Type: FreeType, CoolType, ClearType, etc. And then came OpenType, which is the successor of TrueType. So, for my OpenType implementation, I decided to stick with the concept but use the Persian translation. Which is fitting given that Persian is written in the Arabic script, and OpenType is an extension of TrueType that adds support for complex script rendering, and HarfBuzz is an implementation of OpenType text shaping.

Users

HarfBuzz is used in Android, Chrome, ChromeOS, Firefox, Flutter, GNOME, GTK+, KDE, Qt, LibreOffice, OpenJDK, XeTeX, Adobe Photoshop, Illustrator, InDesign, Microsoft Edge, Amazon Kindle, PlayStation, Godot Engine, Unreal Engine, Figma, Canva, QuarkXPress, Scribus, smart TVs, car displays, and many other places.

xkcd-derived image

Distribution

Packaging status of HarfBuzz

Packaging status

S
Description
HarfBuzz text shaping engine
Readme
125 MiB
0 Stars 1 Watchers 0 Forks
Languages
C++ 73.3%
C 16.2%
Python 3.2%
Hack 2.3%
Meson 1.1%
Other 3.8%