Files
ghostty-rs/crates/ghostty-font/src/lib.rs
T
ddidderr 389266720d feat(font): add the FreeType-only font backend (font-backend-freetype)
Ghostty can be built with -Dfont-backend=freetype, which uses FreeType
without any font discovery. The Rust port only had fontconfig+freetype
(default on Linux) and the CoreText variants. The new cargo feature
`font-backend-freetype` on ghostty-font (forwarded by ghostty-cli and
the root crate; non-Apple, non-wasm targets) behaves like Zig's mode:
font-family discovery, fallback search and codepoint-map overrides are
skipped (embedded fonts only); +list-fonts and +show-face print Zig's
"built without a font discovery mechanism" message and exit 1; +version
reports `.freetype`. The default backend is unchanged.

Also registers the Rust-only benchmark tooling extensions (--time,
--handler=full, ghostty-synthetic +sgr) in DEVIANT_FIXES.md.

Note: `--all-features` now selects this backend for the workspace.

Test Plan:
- cargo test -p ghostty-font --features font-backend-freetype (198)
- cargo build --features font-backend-freetype && ghostty +list-fonts
2026-10-12 15:56:21 +02:00

118 lines
3.5 KiB
Rust

//! Font engine: metrics, atlas, sprite font, faces (FreeType / CoreText),
//! discovery (fontconfig / CoreText), collections, codepoint resolution,
//! shaping (HarfBuzz / CoreText) and the shared glyph grid. Port of
//! `ZIG/src/font/`. The backend is selected per target (see `backend.rs` and
//! `build.rs`): `fontconfig_freetype` on Linux, `coretext` on Apple targets,
//! `web_canvas` on wasm32.
#![cfg_attr(test, allow(clippy::unwrap_used))]
pub mod atlas;
pub mod backend;
pub mod codepoint_map;
#[cfg(not(target_arch = "wasm32"))]
pub mod codepoint_resolver;
#[cfg(not(target_arch = "wasm32"))]
pub mod collection;
pub mod config_types;
#[cfg(font_coretext)]
pub mod coretext_util;
#[cfg(font_fontconfig)]
pub mod deferred_face;
#[cfg(all(not(target_arch = "wasm32"), not(font_fontconfig), not(font_coretext)))]
#[path = "deferred_face_freetype.rs"]
pub mod deferred_face;
#[cfg(font_coretext)]
#[path = "deferred_face_coretext.rs"]
pub mod deferred_face;
#[cfg(target_arch = "wasm32")]
#[path = "deferred_face_web_canvas.rs"]
pub mod deferred_face;
#[cfg(not(target_arch = "wasm32"))]
pub mod discovery;
#[cfg(not(target_arch = "wasm32"))]
pub mod embedded;
pub mod face;
#[cfg(font_fontconfig)]
pub mod fontconfig;
pub mod glyph;
#[cfg(not(target_arch = "wasm32"))]
pub mod library;
pub mod metrics;
pub mod nerd_font_attributes;
pub mod opentype;
pub mod shape;
pub mod shaper;
#[cfg(not(target_arch = "wasm32"))]
pub mod shared_grid;
#[cfg(not(target_arch = "wasm32"))]
pub mod shared_grid_set;
pub mod sprite;
pub use atlas::Atlas;
pub use backend::{Backend, OPTIONS as options};
/// Whether a font discovery mechanism exists in this build (Zig:
/// `font.Discover != void`; false for the `freetype` and `web_canvas`
/// backends).
pub const HAS_DISCOVERY: bool = cfg!(font_discovery);
pub use codepoint_map::CodepointMap;
#[cfg(not(target_arch = "wasm32"))]
pub use codepoint_resolver::CodepointResolver;
#[cfg(not(target_arch = "wasm32"))]
pub use collection::Collection;
pub use deferred_face::DeferredFace;
#[cfg(not(target_arch = "wasm32"))]
pub use discovery::{Descriptor, Discover};
pub use face::Face;
pub use glyph::Glyph;
#[cfg(not(target_arch = "wasm32"))]
pub use library::Library;
pub use metrics::Metrics;
#[cfg(not(target_arch = "wasm32"))]
pub use shared_grid::SharedGrid;
#[cfg(not(target_arch = "wasm32"))]
pub use shared_grid_set::SharedGridSet;
pub use sprite::{Face as SpriteFace, Sprite};
/// The styles that a family can take.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[repr(u8)]
pub enum Style {
Regular = 0,
Bold = 1,
Italic = 2,
BoldItalic = 3,
}
impl Style {
/// All styles, in discriminant order (Zig: `std.meta.fields(Style)`).
pub const ALL: [Style; 4] = [
Style::Regular,
Style::Bold,
Style::Italic,
Style::BoldItalic,
];
}
/// The presentation for an emoji.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Presentation {
/// U+FE0E
Text = 0,
/// U+FE0F
Emoji = 1,
}
/// A FontIndex that can be used to use the sprite font directly.
#[cfg(not(target_arch = "wasm32"))]
pub const SPRITE_INDEX: collection::Index =
collection::Index::init_special(collection::Special::Sprite);
/// The default font size adjustment we use when loading fallback fonts.
///
/// TODO: Add user configuration for this instead of hard-coding it.
#[cfg(not(target_arch = "wasm32"))]
pub const DEFAULT_FALLBACK_ADJUSTMENT: collection::SizeAdjustment =
collection::SizeAdjustment::IcWidth;