designcraft/crates/render/src/text.rs

488 lines
20 KiB
Rust

//! Composed text → pixels.
//!
//! Glyph outlines of a frame are transformed into frame space and batched per line and run style
//! once, then cached per (composed story allocation, frame id): a composed story is immutable, so
//! the cache entry stays valid for as long as the composition cache hands out the same `Arc`.
//! Each render only fills the lines that intersect the visible rectangle, and lines smaller than
//! the greeking threshold become grey bars without touching any outline.
use std::collections::HashMap;
use std::sync::Arc;
use designcraft_compose::{ComposedStory, FrameText, Line};
use designcraft_doc::ItemId;
use designcraft_fonts::FontDb;
use designcraft_geom::{Affine, BezPath, Rect, Shape};
use vello_cpu::RenderContext;
use vello_cpu::kurbo;
use vello_cpu::peniko;
use crate::{Frame, Renderer, color_of, rect_overlaps};
/// Cached outlines of one composed line.
pub(crate) struct LineGlyphs {
/// Frame-space bounds of everything drawn for the line (empty lines: `None`).
pub bounds: Option<Rect>,
/// Glyph outlines batched per run style.
pub runs: Vec<(u32, BezPath)>,
/// Underline / strikethrough bars: colour swatch, tint, rectangle.
pub decos: Vec<(String, f32, Rect)>,
pub glyphs: usize,
}
pub(crate) struct FrameGlyphs {
pub lines: Vec<LineGlyphs>,
/// Path elements held (cache budget).
pub elements: usize,
}
struct Entry {
/// Keeps the composed story alive so its address can't be reused while cached.
_story: Arc<ComposedStory>,
glyphs: Arc<FrameGlyphs>,
stamp: u64,
}
/// Path cache keyed by (composed story address, frame id).
#[derive(Default)]
pub(crate) struct GlyphCache {
map: HashMap<(usize, ItemId), Entry>,
elements: usize,
clock: u64,
}
/// Roughly 56 bytes per element: ~110 MB of cached outlines.
const MAX_ELEMENTS: usize = 2_000_000;
impl GlyphCache {
pub fn tick(&mut self) {
self.clock += 1;
}
fn get(&mut self, cs: &Arc<ComposedStory>, ft: &FrameText) -> Arc<FrameGlyphs> {
let key = (Arc::as_ptr(cs) as usize, ft.frame);
let stamp = self.clock;
if let Some(e) = self.map.get_mut(&key) {
e.stamp = stamp;
return e.glyphs.clone();
}
let g = Arc::new(build(cs, ft));
self.elements += g.elements;
self.map.insert(key, Entry { _story: cs.clone(), glyphs: g.clone(), stamp });
if self.elements > MAX_ELEMENTS {
self.evict();
}
g
}
/// Drop least recently used entries (never the ones used by the current render) until the
/// cache is at half its budget.
fn evict(&mut self) {
let mut stamps: Vec<(u64, usize, (usize, ItemId))> = self.map.iter().map(|(k, e)| (e.stamp, e.glyphs.elements, *k)).collect();
stamps.sort_unstable_by_key(|s| s.0);
for (stamp, n, k) in stamps {
if self.elements <= MAX_ELEMENTS / 2 || stamp >= self.clock {
break;
}
self.map.remove(&k);
self.elements -= n;
}
}
pub fn clear(&mut self) {
self.map.clear();
self.elements = 0;
}
pub fn len(&self) -> usize {
self.map.len()
}
}
fn transform_el(a: Affine, el: kurbo::PathEl) -> kurbo::PathEl {
use kurbo::PathEl::*;
match el {
MoveTo(p) => MoveTo(a * p),
LineTo(p) => LineTo(a * p),
QuadTo(p1, p2) => QuadTo(a * p1, a * p2),
CurveTo(p1, p2, p3) => CurveTo(a * p1, a * p2, a * p3),
ClosePath => ClosePath,
}
}
fn union(r: Option<Rect>, b: Rect) -> Option<Rect> {
Some(r.map_or(b, |r| r.union(b)))
}
fn build_line(db: &FontDb, cs: &ComposedStory, l: &Line, vertical: bool) -> LineGlyphs {
let mut runs: Vec<(u32, BezPath)> = Vec::new();
let mut decos = Vec::new();
let mut glyphs = 0;
for g in &l.glyphs {
if !g.visible {
continue;
}
let style = &cs.styles[g.style as usize];
for (rule, r) in style.rules(g.x, g.x + g.adv, l.baseline) {
decos.push((rule.color.clone(), rule.tint, r));
}
let outline = db.outline(&g.face, g.gid);
if outline.elements().is_empty() {
continue;
}
let skew = if style.skew != 0.0 { Affine::new([1.0, 0.0, -style.skew.to_radians().tan(), 1.0, 0.0, 0.0]) } else { Affine::IDENTITY };
let mut a = Affine::translate((g.x, l.baseline + g.y)) * skew * Affine::scale_non_uniform(g.sx, g.sy);
if vertical && let Some(turn) = g.vertical_xf(l.baseline) {
// Upright in vertical text.
a = turn * a;
}
let bp = match runs.iter_mut().find(|r| r.0 == g.style) {
Some(r) => &mut r.1,
None => {
runs.push((g.style, BezPath::new()));
&mut runs.last_mut().expect("pushed").1
}
};
for el in outline.elements() {
bp.push(transform_el(a, *el));
}
glyphs += 1;
}
let mut bounds = None;
for (si, bp) in &runs {
let st = &cs.styles[*si as usize];
let sw = if st.stroke != designcraft_color::swatch::NONE { st.stroke_weight } else { 0.0 };
bounds = union(bounds, bp.bounding_box().inflate(sw, sw));
}
for (_, _, r) in &decos {
bounds = union(bounds, *r);
}
LineGlyphs { bounds, runs, decos, glyphs }
}
fn build(cs: &ComposedStory, ft: &FrameText) -> FrameGlyphs {
let db = FontDb::global();
let lines: Vec<LineGlyphs> = ft.lines.iter().map(|l| build_line(db, cs, l, ft.vertical)).collect();
let elements = lines.iter().flat_map(|l| &l.runs).map(|(_, bp)| bp.elements().len()).sum();
FrameGlyphs { lines, elements }
}
/// Conservative frame-space box of a line from its metrics (no outlines needed).
fn line_box(l: &Line) -> Option<Rect> {
let first = l.glyphs.first()?;
let x0 = l.glyphs.iter().map(|g| g.x).fold(first.x, f64::min);
let x1 = l.glyphs.iter().map(|g| g.x + g.adv.max(0.0)).fold(l.end_x, f64::max);
let pad = l.ascent.max(1.0);
Some(Rect::new(x0 - pad, l.baseline - l.ascent - pad, x1 + pad, l.baseline + l.descent.max(0.0) + pad))
}
impl Renderer {
pub(crate) fn draw_text(&mut self, ctx: &mut RenderContext, f: &Frame, cs: &Arc<ComposedStory>, ft: &FrameText, xf: Affine) {
let doc = f.doc;
let m = f.view * xf;
// Visible area in frame space.
if xf.determinant().abs() < 1e-12 {
return;
}
let vis = xf.inverse().transform_rect_bbox(f.visible);
// Decorations under text (shading) and rules.
for d in &ft.decos {
if !rect_overlaps(d.rect, vis) {
continue;
}
if let Some(c) = doc.resolve_color(&d.color, d.tint) {
ctx.set_transform(m);
ctx.set_paint(color_of(&c, 1.0));
ctx.fill_rect(&d.rect);
}
}
if !ft.tables.is_empty() {
self.draw_tables(ctx, f, ft, xf);
}
// Text in fonts that aren't installed: pink behind the glyphs (screen only).
if f.opts.highlight_missing_fonts && cs.styles.iter().any(|s| s.missing_font) {
ctx.set_transform(m);
ctx.set_paint(peniko::Color::from_rgb8(255, 166, 214));
for l in &ft.lines {
for g in l.glyphs.iter().filter(|g| g.adv > 0.0 && cs.styles.get(g.style as usize).is_some_and(|s| s.missing_font)) {
ctx.fill_rect(&kurbo::Rect::new(g.x, l.baseline - l.ascent, g.x + g.adv, l.baseline + l.descent));
}
}
}
if f.opts.highlight_keeps && ft.lines.iter().any(|l| l.keep_violation) {
ctx.set_transform(m);
ctx.set_paint(peniko::Color::from_rgb8(255, 236, 120));
for l in ft.lines.iter().filter(|l| l.keep_violation) {
ctx.fill_rect(&kurbo::Rect::new(l.x0, l.baseline - l.ascent, l.x1, l.baseline + l.descent));
}
}
if f.opts.highlight_hj && ft.lines.iter().any(|l| l.hj > 0) {
ctx.set_transform(m);
for l in ft.lines.iter().filter(|l| l.hj > 0) {
let shade = [0u8, 0xF6, 0xEA, 0xD8][l.hj.min(3) as usize];
ctx.set_paint(peniko::Color::from_rgb8(255, shade, [0u8, 0xB0, 0x70, 0x30][l.hj.min(3) as usize]));
ctx.fill_rect(&kurbo::Rect::new(l.x0, l.baseline - l.ascent, l.end_x.max(l.x0 + 1.0), l.baseline + l.descent));
}
}
if f.opts.highlight_custom_tracking && cs.styles.iter().any(|s| s.custom_tracking) {
ctx.set_transform(m);
ctx.set_paint(peniko::Color::from_rgb8(176, 236, 176));
for l in &ft.lines {
for g in l.glyphs.iter().filter(|g| g.adv > 0.0 && cs.styles.get(g.style as usize).is_some_and(|s| s.custom_tracking)) {
ctx.fill_rect(&kurbo::Rect::new(g.x, l.baseline - l.ascent, g.x + g.adv, l.baseline + l.descent));
}
}
}
if f.opts.tag_markers && cs.styles.iter().any(|s| s.xml_tag.is_some()) {
ctx.set_transform(m);
let px = 1.0 / m.determinant().abs().sqrt().max(1e-9);
for l in &ft.lines {
let tag_of = |g: &designcraft_compose::PlacedGlyph| cs.styles.get(g.style as usize).and_then(|s| s.xml_tag.clone());
let gs: Vec<_> = l.glyphs.iter().filter(|g| g.len > 0).collect();
let mut i = 0;
while i < gs.len() {
let Some(tag) = tag_of(gs[i]) else {
i += 1;
continue;
};
let mut j = i + 1;
while j < gs.len() && tag_of(gs[j]).as_deref() == Some(tag.as_str()) {
j += 1;
}
let c = f.doc.xml.tags.iter().find(|t| t.name == tag).map_or([100, 100, 220], |t| t.color);
ctx.set_paint(peniko::Color::from_rgb8(c[0], c[1], c[2]));
let (x0, x1) = (gs[i].x, gs[j - 1].x + gs[j - 1].adv);
let (top, bot) = (l.baseline - l.ascent, l.baseline + l.descent);
let (w, t) = (2.5 * px, px.max(0.3));
// [ before the element, ] after it.
for (x, dir) in [(x0, 1.0), (x1, -1.0)] {
ctx.fill_rect(&kurbo::Rect::new(x - t / 2.0, top, x + t / 2.0, bot));
for y in [top, bot - t] {
let (a, b) = if dir > 0.0 { (x, x + w) } else { (x - w, x) };
ctx.fill_rect(&kurbo::Rect::new(a, y, b, y + t));
}
}
i = j;
}
}
}
if f.opts.change_markup && cs.styles.iter().any(|s| s.inserted) {
ctx.set_transform(m);
for l in &ft.lines {
for g in l.glyphs.iter().filter(|g| g.adv > 0.0 && cs.styles.get(g.style as usize).is_some_and(|s| s.inserted)) {
ctx.set_paint(peniko::Color::from_rgba8(120, 190, 255, 110));
ctx.fill_rect(&kurbo::Rect::new(g.x, l.baseline - l.ascent, g.x + g.adv, l.baseline + l.descent));
}
}
}
if f.opts.note_indicators
&& let Some(st) = f.doc.story(cs.story).filter(|st| !st.editorial.is_empty())
{
// A small flag at each note anchor, in the notes' amber.
ctx.set_transform(m);
ctx.set_paint(peniko::Color::from_rgb8(232, 160, 32));
for l in &ft.lines {
for g in l.glyphs.iter().filter(|g| st.text.get(g.byte..).is_some_and(|t| t.starts_with(designcraft_doc::NOTE_MARK))) {
let h = l.ascent.max(4.0);
let mut p = BezPath::new();
p.move_to((g.x - h * 0.25, l.baseline - h));
p.line_to((g.x + h * 0.25, l.baseline - h));
p.line_to((g.x, l.baseline - h * 0.55));
p.close_path();
ctx.fill_path(&p);
ctx.fill_rect(&kurbo::Rect::new(g.x - h * 0.03, l.baseline - h * 0.6, g.x + h * 0.03, l.baseline + l.descent * 0.5));
}
}
}
if f.opts.condition_indicators && !f.doc.conditions.is_empty() && cs.styles.iter().any(|s| s.condition.is_some()) {
ctx.set_transform(m);
let px = 1.0 / m.determinant().abs().sqrt().max(1e-9);
for l in &ft.lines {
for g in l.glyphs.iter().filter(|g| g.visible && g.adv > 0.0) {
let Some(name) = cs.styles.get(g.style as usize).and_then(|s| s.condition.as_deref()) else { continue };
let Some(c) = f.doc.conditions.iter().find(|c| c.name == name) else { continue };
ctx.set_paint(peniko::Color::from_rgb8(c.color[0], c.color[1], c.color[2]));
let y = l.baseline + l.descent * 0.6;
ctx.fill_rect(&kurbo::Rect::new(g.x, y, g.x + g.adv, y + 2.0 * px));
}
}
}
let scale = m.determinant().abs().sqrt();
let greek_px = f.opts.greek_below_px;
let mut greek = BezPath::new();
let mut shown: Vec<usize> = Vec::new();
for (i, l) in ft.lines.iter().enumerate() {
let Some(b) = line_box(l) else { continue };
if !rect_overlaps(b, vis) {
continue;
}
if greek_px > 0.0 && l.ascent * scale < greek_px {
if let Some(a) = l.glyphs.first() {
let r = kurbo::Rect::new(a.x, l.baseline - l.ascent * 0.5, l.end_x, l.baseline);
if r.width() > 0.0 {
greek.extend(r.path_elements(0.1));
}
}
continue;
}
shown.push(i);
}
ctx.set_transform(m);
if !shown.is_empty() {
let fg = self.glyphs.get(cs, ft);
// Resolve each style's paints once per frame.
let mut fills: Vec<Option<Option<peniko::Color>>> = vec![None; cs.styles.len()];
let mut fill_of = |si: u32| -> Option<peniko::Color> {
*fills[si as usize].get_or_insert_with(|| {
let st = &cs.styles[si as usize];
doc.resolve_color(&st.fill, st.fill_tint).map(|c| color_of(&c, 1.0))
})
};
for i in shown {
let lg = &fg.lines[i];
let Some(b) = lg.bounds else { continue };
if !rect_overlaps(b, vis) {
continue;
}
self.stats.glyphs += lg.glyphs;
for (si, bp) in &lg.runs {
if let Some(c) = fill_of(*si) {
let st = &cs.styles[*si as usize];
let op = crate::overprints(f, &st.fill, st.fill_tint, false);
if op {
ctx.push_layer(
None,
Some(vello_cpu::peniko::BlendMode::new(vello_cpu::peniko::Mix::Multiply, vello_cpu::peniko::Compose::SrcOver)),
None,
None,
None,
);
}
ctx.set_paint(c);
ctx.fill_path(bp);
if op {
ctx.pop_layer();
}
}
let st = &cs.styles[*si as usize];
if st.stroke != designcraft_color::swatch::NONE
&& let Some(c) = doc.resolve_color(&st.stroke, st.stroke_tint)
{
ctx.set_paint(color_of(&c, 1.0));
ctx.set_stroke(kurbo::Stroke::new(st.stroke_weight));
ctx.stroke_path(bp);
}
}
for (sw, tint, r) in &lg.decos {
if let Some(c) = doc.resolve_color(sw, *tint) {
ctx.set_paint(color_of(&c, 1.0));
ctx.fill_rect(r);
}
}
}
}
if !greek.elements().is_empty() {
ctx.set_paint(color_of(&designcraft_color::Color::gray(0.35), 0.5));
ctx.fill_path(&greek);
}
for n in &ft.notes {
if let Some(nft) = n.text.frames.first() {
self.draw_text(ctx, f, &n.text, nft, xf * Affine::translate(n.origin.to_vec2()));
}
}
// Anchored objects ride on their lines.
if !ft.objects.is_empty()
&& let Some(st) = doc.story(cs.story)
{
for o in &ft.objects {
if let Some(obj) = st.objects.get(o.index) {
self.draw_item(ctx, f, &obj.item, xf * Affine::translate(o.origin.to_vec2()), None);
}
}
}
}
}
impl Renderer {
/// Table fragments: cell fills, cell text, then cell edges and the border.
fn draw_tables(&mut self, ctx: &mut RenderContext, f: &Frame, ft: &FrameText, xf: Affine) {
let doc = f.doc;
for t in &ft.tables {
for c in &t.cells {
if let Some((sw, tint)) = &c.fill
&& let Some(col) = doc.resolve_color(sw, *tint)
{
ctx.set_transform(f.view * xf);
ctx.set_paint(color_of(&col, 1.0));
// Overlap neighbours by half a device pixel so adjacent fills show no seams.
let h = 0.5 * f.px;
ctx.fill_rect(&c.rect.inflate(h, h));
}
}
for c in &t.cells {
if let Some(g) = &c.graphic {
ctx.set_transform(f.view * xf);
ctx.push_clip_layer(&c.clip.to_path(0.1));
self.draw_graphic(ctx, f, g, xf * Affine::translate((c.clip.x0, c.clip.y0)));
ctx.set_transform(f.view * xf);
ctx.pop_layer();
} else if let Some(cft) = c.text.frames.first() {
self.draw_text(ctx, f, &c.text, cft, xf * Affine::translate(c.origin.to_vec2()));
}
}
ctx.set_transform(f.view * xf);
for s in &t.strokes {
let Some(col) = doc.resolve_color(&s.stroke.color, s.stroke.tint) else { continue };
ctx.set_paint(color_of(&col, 1.0));
ctx.set_stroke(cell_stroke(&s.stroke));
ctx.stroke_path(&kurbo::Line::new(s.a, s.b).to_path(0.1));
}
}
}
}
/// Kurbo stroke for a table edge.
fn cell_stroke(s: &designcraft_doc::CellStroke) -> kurbo::Stroke {
let st = kurbo::Stroke::new(s.weight).with_caps(kurbo::Cap::Square);
match &s.kind {
designcraft_doc::StrokeType::Dashed { pattern } if !pattern.is_empty() => {
st.with_caps(kurbo::Cap::Butt).with_dashes(0.0, pattern.iter().copied())
}
designcraft_doc::StrokeType::Dotted => st.with_dashes(0.0, [0.0, s.weight * 2.0]).with_caps(kurbo::Cap::Round),
_ => st,
}
}
impl Renderer {
/// Type on a path: glyphs follow the frame's path.
#[allow(clippy::too_many_arguments)]
pub(crate) fn draw_path_text(
&mut self,
ctx: &mut RenderContext,
f: &Frame,
cs: &Arc<ComposedStory>,
ft: &FrameText,
xf: Affine,
path: &BezPath,
pt: &designcraft_doc::PathType,
) {
let doc = f.doc;
ctx.set_transform(f.view * xf);
for (si, bp) in designcraft_compose::path_glyphs(cs, ft, path, pt) {
let st = &cs.styles[si as usize];
if let Some(c) = doc.resolve_color(&st.fill, st.fill_tint) {
ctx.set_paint(color_of(&c, 1.0));
ctx.fill_path(&bp);
}
if st.stroke != designcraft_color::swatch::NONE
&& let Some(c) = doc.resolve_color(&st.stroke, st.stroke_tint)
{
ctx.set_paint(color_of(&c, 1.0));
ctx.set_stroke(kurbo::Stroke::new(st.stroke_weight));
ctx.stroke_path(&bp);
}
self.stats.glyphs += 1;
}
}
}