clone
ssh://git@git.notashelf.dev:33/notashelf/beer.gitCommit 5d132d9ac7e1
tarballunverified5 files changed+317-72
@@ -38,6 +38,7 @@ dependencies = [ "calloop-wayland-source", "fontconfig", "freetype-rs",+ "harfbuzz_rs_now", "lru", "pound", "rustix",@@ -224,6 +225,17 @@ dependencies = [ ] [[package]]+name = "harfbuzz_rs_now"+version = "2.3.2"+source = "registry+https://github.com/rust-lang/crates.io-index"+checksum = "e7c409e4222b628232c6190ba76ad2baabfd011cd77c6b3bf8d8f8adb96cbcb7"+dependencies = [+ "bitflags",+ "cc",+ "pkg-config",+]++[[package]] name = "hashbrown" version = "0.17.1" source = "registry+https://github.com/rust-lang/crates.io-index"@@ -607,9 +619,9 @@ dependencies = [ [[package]] name = "toml"-version = "0.9.12+spec-1.1.0"+version = "1.1.2+spec-1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index"-checksum = "cf92845e79fc2e2def6a5d828f0801e29a2f8acc037becc5ab08595c7d5e9863"+checksum = "81f3d15e84cbcd896376e6730314d59fb5a87f31e4b038454184435cd57defee" dependencies = [ "indexmap", "serde_core",@@ -617,14 +629,14 @@ dependencies = [ "toml_datetime", "toml_parser", "toml_writer",- "winnow 0.7.15",+ "winnow", ] [[package]] name = "toml_datetime"-version = "0.7.5+spec-1.1.0"+version = "1.1.1+spec-1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index"-checksum = "92e1cfed4a3038bc5a127e35a2d360f145e1f4b971b551a2ba5fd7aedf7e1347"+checksum = "3165f65f62e28e0115a00b2ebdd37eb6f3b641855f9d636d3cd4103767159ad7" dependencies = [ "serde_core", ]@@ -635,7 +647,7 @@ version = "1.1.2+spec-1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a2abe9b86193656635d2411dc43050282ca48aa31c2451210f4202550afb7526" dependencies = [- "winnow 1.0.3",+ "winnow", ] [[package]]@@ -885,12 +897,6 @@ dependencies = [ [[package]] name = "winnow"-version = "0.7.15"-source = "registry+https://github.com/rust-lang/crates.io-index"-checksum = "df79d97927682d2fd8adb29682d1140b343be4ac0f08fd68b7765d9c059d3945"--[[package]]-name = "winnow" version = "1.0.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0592e1c9d151f854e6fd382574c3a0855250e1d9b2f99d9281c6e6391af352f1"@@ -13,6 +13,7 @@ calloop = { version = "0.14.4", features = ["signals"] } calloop-wayland-source = "0.4.1" fontconfig = "0.11.0" freetype-rs = "0.38.0"+harfbuzz_rs_now = "2.3.2" lru = "0.18.0" pound = "0.1.6" rustix = { version = "1.1.4", features = [@@ -23,10 +24,10 @@ rustix = { version = "1.1.4", features = [ "fs", ] } serde = { version = "1.0.228", features = ["derive"] }-serde_ignored = "0.1.12"+serde_ignored = "0.1.14" smithay-client-toolkit = "0.20.0" thiserror = "2.0.18"-toml = "0.9"+toml = "1.1.2" tracing = "0.1.44" tracing-subscriber = { version = "0.3.23", features = ["env-filter"] } unicode-width = "0.2.2"@@ -10,6 +10,7 @@ libxkbcommon, freetype, fontconfig,+ harfbuzz, }: let cargoTOML = (lib.importTOML ../Cargo.toml).package.version; in@@ -49,6 +50,7 @@ in libxkbcommon freetype fontconfig+ harfbuzz ]; # Install the terminfo entry, and make the Wayland/xkb libraries (loaded via@@ -16,6 +16,7 @@ use fontconfig::{CharSet, Fontconfig, Pattern}; use freetype::bitmap::PixelMode; use freetype::face::{LoadFlag, StyleFlag}; use freetype::{Face, Library, Matrix, Vector};+use harfbuzz_rs_now as harfbuzz; use lru::LruCache; use thiserror::Error; @@ -23,6 +24,9 @@ use thiserror::Error; /// but this caps memory under adversarial all-of-Unicode output. const GLYPH_CACHE_CAP: usize = 4096; +/// Upper bound on cached shaped clusters (base char + combining marks).+const SHAPE_CACHE_CAP: usize = 1024;+ #[derive(Debug, Error)] pub enum FontError { #[error("FreeType: {0}")]@@ -91,8 +95,36 @@ pub enum GlyphData { Color(Vec<u8>), } +/// One shaped glyph in a cluster: a glyph index into a specific face plus the+/// pixel offset, relative to the cell origin and baseline, that HarfBuzz placed+/// it at. `x` grows rightward, `y` upward (away from the baseline).+#[derive(Clone, Copy, Debug)]+pub struct Placed {+ pub gid: u32,+ pub x: i32,+ pub y: i32,+}++/// The result of shaping a base char plus its combining marks: the face the+/// cluster was shaped against and the positioned glyphs to draw, in order.+#[derive(Clone, Debug)]+pub struct ShapedCluster {+ pub face_idx: usize,+ pub glyphs: Vec<Placed>,+}++/// A loaded face plus where it came from, so HarfBuzz can be handed the same+/// font bytes that FreeType rasterizes from.+struct FaceEntry {+ face: Face,+ path: PathBuf,+ index: u32,+ /// HarfBuzz font for this face, built on first shape against it.+ hb: Option<harfbuzz::Owned<harfbuzz::Font<'static>>>,+}+ /// The font set for one terminal: a primary family with lazily-loaded-/// bold/italic variants and per-codepoint fallback faces, plus a glyph cache.+/// bold/italic variants and per-codepoint fallback faces, plus glyph caches. pub struct Fonts { library: Library, fontconfig: Fontconfig,@@ -100,12 +132,17 @@ pub struct Fonts { size_px: u32, metrics: CellMetrics, /// All loaded faces; indices into this vector are stable.- faces: Vec<Face>,+ faces: Vec<FaceEntry>, /// Index of each style variant, by [`Style::index`]; filled on demand. styled: [Option<usize>; 4], /// Fallback faces resolved by coverage, deduplicated by file path. fallbacks: HashMap<PathBuf, usize>,+ /// Glyphs keyed by `char` (the common, unshaped path). cache: LruCache<(char, usize), Glyph>,+ /// Glyphs keyed by `(glyph index, face, style)` (the shaped path).+ gcache: LruCache<(u32, usize, usize), Glyph>,+ /// Shaped clusters keyed by `(cluster string, style)`.+ shape_cache: LruCache<(Box<str>, usize), Option<ShapedCluster>>, } impl fmt::Debug for Fonts {@@ -127,8 +164,9 @@ impl Fonts { let fontconfig = Fontconfig::new().ok_or(FontError::FontconfigInit)?; let regular = resolve_face(&library, &fontconfig, family, Style::default(), size_px)?;- let metrics = cell_metrics(®ular, family)?;+ let metrics = cell_metrics(®ular.face, family)?; + let cap = |n| NonZeroUsize::new(n).expect("cache cap is nonzero"); Ok(Self { library, fontconfig,@@ -138,7 +176,9 @@ impl Fonts { faces: vec![regular], styled: [Some(0), None, None, None], fallbacks: HashMap::new(),- cache: LruCache::new(NonZeroUsize::new(GLYPH_CACHE_CAP).expect("cap is nonzero")),+ cache: LruCache::new(cap(GLYPH_CACHE_CAP)),+ gcache: LruCache::new(cap(GLYPH_CACHE_CAP)),+ shape_cache: LruCache::new(cap(SHAPE_CACHE_CAP)), }) } @@ -152,34 +192,118 @@ impl Fonts { let key = (c, style.index()); if self.cache.get(&key).is_none() { let idx = self.face_for(c, style)?;- let face = &self.faces[idx];+ let face = &self.faces[idx].face; // Synthesize bold/italic only when the resolved face lacks the real // variant (most monospace families ship both).- let flags = face.style_flags();- let synth_bold = style.bold && !flags.contains(StyleFlag::BOLD);- let synth_italic = style.italic && !flags.contains(StyleFlag::ITALIC);+ let (synth_bold, synth_italic) = synth_flags(face, style); let glyph = rasterize(face, c, synth_bold, synth_italic)?; self.cache.put(key, glyph); } Ok(self.cache.get(&key).expect("glyph was just inserted")) } + /// Return the rasterized glyph for glyph index `gid` in `face_idx`,+ /// rasterizing and caching on first use. Used by the shaped path, where+ /// HarfBuzz has already chosen the face and glyph.+ pub fn glyph_indexed(+ &mut self,+ face_idx: usize,+ gid: u32,+ style: Style,+ ) -> Result<&Glyph, FontError> {+ let key = (gid, face_idx, style.index());+ if self.gcache.get(&key).is_none() {+ let face = &self.faces[face_idx].face;+ let (synth_bold, synth_italic) = synth_flags(face, style);+ let glyph = rasterize_index(face, gid, synth_bold, synth_italic)?;+ self.gcache.put(key, glyph);+ }+ Ok(self.gcache.get(&key).expect("glyph was just inserted"))+ }++ /// Shape `base` plus its combining `marks` into positioned glyphs using+ /// HarfBuzz, so marks land where the font's GPOS table wants them rather+ /// than stacked at the origin. Returns `None` when shaping is unavailable or+ /// the cluster has glyphs the face does not cover (`.notdef`), so the caller+ /// can fall back to drawing the marks stacked. Results are cached.+ pub fn shape_cluster(+ &mut self,+ base: char,+ marks: &str,+ style: Style,+ ) -> Option<ShapedCluster> {+ let mut cluster = String::with_capacity(base.len_utf8() + marks.len());+ cluster.push(base);+ cluster.push_str(marks);+ let key = (cluster.clone().into_boxed_str(), style.index());+ if let Some(cached) = self.shape_cache.get(&key) {+ return cached.clone();+ }+ let shaped = self.shape_uncached(base, &cluster, style);+ self.shape_cache.put(key, shaped.clone());+ shaped+ }++ fn shape_uncached(&mut self, base: char, cluster: &str, style: Style) -> Option<ShapedCluster> {+ let face_idx = self.face_for(base, style).ok()?;+ let font = self.hb_font(face_idx)?;+ let buffer = harfbuzz::UnicodeBuffer::new().add_str(cluster);+ let output = harfbuzz::shape(font, buffer, &[]);+ let infos = output.get_glyph_infos();+ let positions = output.get_glyph_positions();+ let mut glyphs = Vec::with_capacity(infos.len());+ let mut pen = 0i32;+ for (info, pos) in infos.iter().zip(positions) {+ // A .notdef means this face does not cover part of the cluster; bail+ // so the caller stacks the marks via per-char fallback instead.+ if info.codepoint == 0 {+ return None;+ }+ glyphs.push(Placed {+ gid: info.codepoint,+ // HarfBuzz positions are 26.6 fixed point at our pixel scale.+ x: (pen + pos.x_offset) >> 6,+ y: pos.y_offset >> 6,+ });+ pen += pos.x_advance;+ }+ Some(ShapedCluster { face_idx, glyphs })+ }++ /// Lazily build the HarfBuzz font for `face_idx` from the same file bytes+ /// FreeType loaded. The bytes are leaked to `'static`: a face lives for the+ /// process, and only the handful actually used to shape clusters allocate.+ fn hb_font(&mut self, face_idx: usize) -> Option<&harfbuzz::Owned<harfbuzz::Font<'static>>> {+ if self.faces[face_idx].hb.is_none() {+ let entry = &self.faces[face_idx];+ let bytes = std::fs::read(&entry.path).ok()?;+ let leaked: &'static [u8] = Box::leak(bytes.into_boxed_slice());+ let face = harfbuzz::Face::from_bytes(leaked, entry.index);+ let mut font = harfbuzz::Font::new(face);+ let scale = self.size_px as i32 * 64;+ font.set_scale(scale, scale);+ font.set_ppem(self.size_px, self.size_px);+ self.faces[face_idx].hb = Some(font);+ }+ self.faces[face_idx].hb.as_ref()+ }+ /// Pick the face that should render `c`: the requested style if it has the /// glyph, then regular, then known fallbacks, then a fresh fontconfig /// coverage match. Falls back to the styled face (rendering `.notdef`). fn face_for(&mut self, c: char, style: Style) -> Result<usize, FontError> { let styled = self.styled_face(style)?;- if face_has_glyph(&self.faces[styled], c) {+ if face_has_glyph(&self.faces[styled].face, c) { return Ok(styled); } if let Some(regular) = self.styled[0] && regular != styled- && face_has_glyph(&self.faces[regular], c)+ && face_has_glyph(&self.faces[regular].face, c) { return Ok(regular); } for &idx in self.fallbacks.values() {- if face_has_glyph(&self.faces[idx], c) {+ if face_has_glyph(&self.faces[idx].face, c) { return Ok(idx); } }@@ -200,8 +324,8 @@ impl Fonts { style, self.size_px, ) {- Ok(face) => {- self.faces.push(face);+ Ok(entry) => {+ self.faces.push(entry); self.faces.len() - 1 } Err(_) => regular,@@ -223,12 +347,17 @@ impl Fonts { if let Some(&idx) = self.fallbacks.get(&path) { return Ok(Some(idx)); }- let index = matched.face_index().unwrap_or(0) as isize;- let face = self.library.new_face(&path, index)?;+ let index = matched.face_index().unwrap_or(0);+ let face = self.library.new_face(&path, index as isize)?; if size_face(&face, self.size_px).is_err() { return Ok(None); }- self.faces.push(face);+ self.faces.push(FaceEntry {+ face,+ path: path.clone(),+ index: index as u32,+ hb: None,+ }); let idx = self.faces.len() - 1; self.fallbacks.insert(path, idx); Ok(Some(idx))@@ -239,19 +368,34 @@ fn face_has_glyph(face: &Face, c: char) -> bool { face.get_char_index(c as usize).is_some_and(|g| g != 0) } +/// Whether bold/italic must be synthesized: only when the requested style is+/// set but the resolved face lacks the real variant.+fn synth_flags(face: &Face, style: Style) -> (bool, bool) {+ let flags = face.style_flags();+ let synth_bold = style.bold && !flags.contains(StyleFlag::BOLD);+ let synth_italic = style.italic && !flags.contains(StyleFlag::ITALIC);+ (synth_bold, synth_italic)+}+ fn resolve_face( library: &Library, fontconfig: &Fontconfig, family: &str, style: Style, size_px: u32,-) -> Result<Face, FontError> {+) -> Result<FaceEntry, FontError> { let font = fontconfig .find(family, Some(style.fontconfig_style())) .map_err(|_| FontError::NoFamily(family.to_owned()))?;- let face = library.new_face(&font.path, font.index.unwrap_or(0) as isize)?;+ let index = font.index.unwrap_or(0);+ let face = library.new_face(&font.path, index as isize)?; size_face(&face, size_px)?;- Ok(face)+ Ok(FaceEntry {+ face,+ path: font.path,+ index: index as u32,+ hb: None,+ }) } /// Set a face to `size_px`. Scalable faces size directly; bitmap-strike faces@@ -312,12 +456,35 @@ fn rasterize( synth_bold: bool, synth_italic: bool, ) -> Result<Glyph, FontError> {+ rasterize_with(face, synth_bold, synth_italic, |face| {+ face.load_char(c as usize, LoadFlag::RENDER | LoadFlag::COLOR)+ })+}++/// Rasterize by glyph index rather than character (the shaped path).+fn rasterize_index(+ face: &Face,+ gid: u32,+ synth_bold: bool,+ synth_italic: bool,+) -> Result<Glyph, FontError> {+ rasterize_with(face, synth_bold, synth_italic, |face| {+ face.load_glyph(gid, LoadFlag::RENDER | LoadFlag::COLOR)+ })+}++fn rasterize_with(+ face: &Face,+ synth_bold: bool,+ synth_italic: bool,+ load: impl FnOnce(&Face) -> Result<(), freetype::Error>,+) -> Result<Glyph, FontError> { // A shear transform fakes italics on a face that has no real oblique. It is // applied to the outline at load time, so reset it immediately after. if synth_italic { face.set_transform(&mut shear_matrix(), &mut Vector { x: 0, y: 0 }); }- let result = face.load_char(c as usize, LoadFlag::RENDER | LoadFlag::COLOR);+ let result = load(face); if synth_italic { face.set_transform(&mut identity_matrix(), &mut Vector { x: 0, y: 0 }); }@@ -456,6 +623,37 @@ mod tests { } #[test]+ fn shapes_a_simple_cluster() {+ let mut f = fonts();+ // Shaping a bare base char yields exactly its one glyph, and that glyph+ // index rasterizes to ink through the shaped path.+ let shaped = f+ .shape_cluster('a', "", Style::default())+ .expect("monospace shapes 'a'");+ assert_eq!(shaped.glyphs.len(), 1);+ let g = f+ .glyph_indexed(shaped.face_idx, shaped.glyphs[0].gid, Style::default())+ .expect("rasterize shaped glyph");+ match &g.data {+ GlyphData::Mask(px) => assert!(px.iter().any(|&p| p > 0), "'a' should have ink"),+ GlyphData::Color(_) => {}+ }+ }++ #[test]+ fn shapes_combining_cluster_without_notdef() {+ // 'e' + combining acute: a covering face shapes it (>=1 glyph, never a+ // .notdef, which `shape_cluster` rejects by returning None); a face+ // missing the mark returns None so the renderer stacks instead. Either+ // outcome is fine - the point is no panic and no notdef leaking through.+ let mut f = fonts();+ if let Some(shaped) = f.shape_cluster('e', "\u{0301}", Style::default()) {+ assert!(!shaped.glyphs.is_empty());+ assert!(shaped.glyphs.iter().all(|g| g.gid != 0));+ }+ }++ #[test] fn glyphs_are_cached() { let mut f = fonts(); f.glyph('a', Style::default()).unwrap();@@ -7,7 +7,7 @@ use std::num::NonZeroU16; -use crate::font::{CellMetrics, Fonts, GlyphData, Style};+use crate::font::{CellMetrics, Fonts, Glyph, GlyphData, Style}; use crate::grid::{Cell, CursorShape, Flags, Grid, Underline}; use crate::theme::{Plane, Rgb, Theme}; @@ -205,19 +205,47 @@ impl Renderer { } let (fg, _) = cell_colors(cell, theme); let origin_x = pad_x + x as i32 * m.width as i32;- if is_braille(cell.c) {+ let style = cell_style(cell);+ // A cell carrying combining marks is shaped as a cluster so the+ // marks land where the font's GPOS table wants them. Shaping returns+ // None for braille (drawn directly) and for clusters the face does+ // not fully cover, both of which fall through to the legacy path.+ let shaped = match &cell.combining {+ Some(marks) if !is_braille(cell.c) => {+ self.fonts.shape_cluster(cell.c, marks, style)+ }+ _ => None,+ };+ if let Some(shaped) = shaped {+ for placed in &shaped.glyphs {+ if let Ok(glyph) = self.fonts.glyph_indexed(shaped.face_idx, placed.gid, style)+ {+ blit_glyph(+ &mut canvas,+ glyph,+ m,+ origin_x + placed.x,+ row_top,+ placed.y,+ fg,+ );+ }+ }+ } else if is_braille(cell.c) { // Drawn directly so the dots are crisp and fill the cell, the // way tools like btop expect, rather than however the fallback // font happens to size its braille glyphs. draw_braille(&mut canvas, cell.c, origin_x, row_top, m, fg);- } else if cell.c != ' ' {- self.draw_glyph(&mut canvas, cell.c, cell_style(cell), origin_x, row_top, fg);- }- // Stack any combining marks over the base glyph; their own bearings- // position them (no shaper, so placement is the font's default).- if let Some(marks) = &cell.combining {- for mark in marks.chars() {- self.draw_glyph(&mut canvas, mark, cell_style(cell), origin_x, row_top, fg);+ } else {+ if cell.c != ' ' {+ self.draw_glyph(&mut canvas, cell.c, style, origin_x, row_top, fg);+ }+ // No shaper available for this cluster: stack the marks over the+ // base using each mark glyph's own bearings.+ if let Some(marks) = &cell.combining {+ for mark in marks.chars() {+ self.draw_glyph(&mut canvas, mark, style, origin_x, row_top, fg);+ } } } draw_decorations(&mut canvas, cell, theme, origin_x, row_top, m, fg);@@ -414,40 +442,50 @@ impl Renderer { return; } };- let (gw, gh) = (glyph.width as i32, glyph.height as i32);- match &glyph.data {- GlyphData::Mask(mask) => {- let baseline = cell_top + m.ascent as i32;- for gy in 0..gh {- for gx in 0..gw {- let a = mask[(gy * gw + gx) as usize];- if a != 0 {- canvas.blend(- origin_x + glyph.left + gx,- baseline - glyph.top + gy,- fg,- a,- );- }+ blit_glyph(canvas, glyph, m, origin_x, cell_top, 0, fg);+ }+}++/// Composite a rasterized glyph into the canvas. `origin_x`/`cell_top` are the+/// cell's top-left; `rise` lifts the glyph above the baseline (HarfBuzz's+/// vertical offset, 0 for the unshaped path).+fn blit_glyph(+ canvas: &mut Canvas,+ glyph: &Glyph,+ m: CellMetrics,+ origin_x: i32,+ cell_top: i32,+ rise: i32,+ fg: Rgb,+) {+ let (gw, gh) = (glyph.width as i32, glyph.height as i32);+ match &glyph.data {+ GlyphData::Mask(mask) => {+ let baseline = cell_top + m.ascent as i32 - rise;+ for gy in 0..gh {+ for gx in 0..gw {+ let a = mask[(gy * gw + gx) as usize];+ if a != 0 {+ canvas.blend(origin_x + glyph.left + gx, baseline - glyph.top + gy, fg, a); } } }- // Colour glyphs (emoji) come from a fixed strike at native size;- // scale them to the line height with nearest-neighbour sampling.- GlyphData::Color(bgra) if gh > 0 => {- let scale = m.height as f32 / gh as f32;- let target_w = (gw as f32 * scale) as i32;- for ty in 0..m.height as i32 {- let sy = ((ty as f32 / scale) as i32).min(gh - 1);- for tx in 0..target_w {- let sx = ((tx as f32 / scale) as i32).min(gw - 1);- let i = ((sy * gw + sx) * 4) as usize;- canvas.over(origin_x + tx, cell_top + ty, &bgra[i..i + 4]);- }+ }+ // Colour glyphs (emoji) come from a fixed strike at native size;+ // scale them to the line height with nearest-neighbour sampling.+ GlyphData::Color(bgra) if gh > 0 => {+ let scale = m.height as f32 / gh as f32;+ let target_w = (gw as f32 * scale) as i32;+ for ty in 0..m.height as i32 {+ let sy = ((ty as f32 / scale) as i32).min(gh - 1);+ for tx in 0..target_w {+ let sx = ((tx as f32 / scale) as i32).min(gw - 1);+ let i = ((sy * gw + sx) * 4) as usize;+ canvas.over(origin_x + tx, cell_top + ty, &bgra[i..i + 4]); } }- GlyphData::Color(_) => {} }+ GlyphData::Color(_) => {} } }