Merge pull request #1934 from iced-rs/reuse-text-cache-entries

Reuse entries in `text::Cache`
This commit is contained in:
Héctor Ramón 2023-06-28 01:40:53 +02:00 committed by GitHub
commit 8d65e40a11
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 140 additions and 81 deletions

View file

@ -64,8 +64,8 @@ impl text::Renderer for Null {
_font: Font,
_bounds: Size,
_shaping: text::Shaping,
) -> (f32, f32) {
(0.0, 20.0)
) -> Size {
Size::new(0.0, 20.0)
}
fn hit_test(

View file

@ -163,7 +163,7 @@ pub trait Renderer: crate::Renderer {
font: Self::Font,
bounds: Size,
shaping: Shaping,
) -> (f32, f32);
) -> Size;
/// Measures the width of the text as if it were laid out in a single line.
fn measure_width(
@ -173,7 +173,7 @@ pub trait Renderer: crate::Renderer {
font: Self::Font,
shaping: Shaping,
) -> f32 {
let (width, _) = self.measure(
let bounds = self.measure(
content,
size,
LineHeight::Absolute(Pixels(size)),
@ -182,7 +182,7 @@ pub trait Renderer: crate::Renderer {
shaping,
);
width
bounds.width
}
/// Tests whether the provided point is within the boundaries of text

View file

@ -5,7 +5,7 @@ use crate::mouse;
use crate::renderer;
use crate::text;
use crate::widget::Tree;
use crate::{Color, Element, Layout, Length, Pixels, Rectangle, Size, Widget};
use crate::{Color, Element, Layout, Length, Pixels, Rectangle, Widget};
use std::borrow::Cow;
@ -139,18 +139,16 @@ where
let size = self.size.unwrap_or_else(|| renderer.default_size());
let bounds = limits.max();
let (width, height) = renderer.measure(
let bounds = renderer.measure(
&self.content,
size,
self.line_height,
self.font.unwrap_or_else(|| renderer.default_font()),
bounds,
limits.max(),
self.shaping,
);
let size = limits.resolve(Size::new(width, height));
let size = limits.resolve(bounds);
layout::Node::new(size)
}

View file

@ -38,7 +38,7 @@ pub trait Text {
font: Font,
bounds: Size,
shaping: text::Shaping,
) -> (f32, f32);
) -> Size;
/// Tests whether the provided point is within the boundaries of [`Text`]
/// laid out with the given parameters, returning information about

View file

@ -133,7 +133,7 @@ where
font: Font,
bounds: Size,
shaping: text::Shaping,
) -> (f32, f32) {
) -> Size {
self.backend().measure(
content,
size,

View file

@ -42,7 +42,7 @@ impl backend::Text for Backend {
font: Font,
bounds: Size,
shaping: text::Shaping,
) -> (f32, f32) {
) -> Size {
delegate!(
self,
backend,

View file

@ -787,7 +787,7 @@ impl backend::Text for Backend {
font: Font,
bounds: Size,
shaping: text::Shaping,
) -> (f32, f32) {
) -> Size {
self.text_pipeline.measure(
contents,
size,

View file

@ -66,17 +66,10 @@ impl Pipeline {
shaping,
};
let (_, buffer) = self.cache.get_mut().allocate(font_system, key);
let (_, entry) = self.cache.get_mut().allocate(font_system, key);
let (total_lines, max_width) = buffer
.layout_runs()
.enumerate()
.fold((0, 0.0), |(_, max), (i, buffer)| {
(i + 1, buffer.line_w.max(max))
});
let total_height = total_lines as f32 * line_height * scale_factor;
let max_width = max_width * scale_factor;
let max_width = entry.bounds.width * scale_factor;
let total_height = entry.bounds.height * scale_factor;
let bounds = bounds * scale_factor;
@ -94,7 +87,7 @@ impl Pipeline {
let mut swash = cosmic_text::SwashCache::new();
for run in buffer.layout_runs() {
for run in entry.buffer.layout_runs() {
for glyph in run.glyphs {
let physical_glyph = glyph.physical((x, y), scale_factor);
@ -138,12 +131,12 @@ impl Pipeline {
font: Font,
bounds: Size,
shaping: Shaping,
) -> (f32, f32) {
) -> Size {
let mut measurement_cache = self.cache.borrow_mut();
let line_height = f32::from(line_height.to_absolute(Pixels(size)));
let (_, paragraph) = measurement_cache.allocate(
let (_, entry) = measurement_cache.allocate(
&mut self.font_system.borrow_mut(),
Key {
content,
@ -155,14 +148,7 @@ impl Pipeline {
},
);
let (total_lines, max_width) = paragraph
.layout_runs()
.enumerate()
.fold((0, 0.0), |(_, max), (i, buffer)| {
(i + 1, buffer.line_w.max(max))
});
(max_width, line_height * total_lines as f32)
entry.bounds
}
pub fn hit_test(
@ -180,7 +166,7 @@ impl Pipeline {
let line_height = f32::from(line_height.to_absolute(Pixels(size)));
let (_, paragraph) = measurement_cache.allocate(
let (_, entry) = measurement_cache.allocate(
&mut self.font_system.borrow_mut(),
Key {
content,
@ -192,12 +178,22 @@ impl Pipeline {
},
);
let cursor = paragraph.hit(point.x, point.y)?;
let cursor = entry.buffer.hit(point.x, point.y)?;
Some(Hit::CharOffset(cursor.index))
}
}
fn measure(buffer: &cosmic_text::Buffer) -> Size {
let (width, total_lines) = buffer
.layout_runs()
.fold((0.0, 0usize), |(width, total_lines), run| {
(run.line_w.max(width), total_lines + 1)
});
Size::new(width, total_lines as f32 * buffer.metrics().line_height)
}
fn to_family(family: font::Family) -> cosmic_text::Family<'static> {
match family {
font::Family::Name(name) => cosmic_text::Family::Name(name),
@ -354,12 +350,18 @@ impl GlyphCache {
}
struct Cache {
entries: FxHashMap<KeyHash, cosmic_text::Buffer>,
entries: FxHashMap<KeyHash, Entry>,
measurements: FxHashMap<KeyHash, KeyHash>,
recently_used: FxHashSet<KeyHash>,
hasher: HashBuilder,
trim_count: usize,
}
struct Entry {
buffer: cosmic_text::Buffer,
bounds: Size,
}
#[cfg(not(target_arch = "wasm32"))]
type HashBuilder = twox_hash::RandomXxHashBuilder64;
@ -372,6 +374,7 @@ impl Cache {
fn new() -> Self {
Self {
entries: FxHashMap::default(),
measurements: FxHashMap::default(),
recently_used: FxHashSet::default(),
hasher: HashBuilder::default(),
trim_count: 0,
@ -382,20 +385,14 @@ impl Cache {
&mut self,
font_system: &mut cosmic_text::FontSystem,
key: Key<'_>,
) -> (KeyHash, &mut cosmic_text::Buffer) {
let hash = {
let mut hasher = self.hasher.build_hasher();
) -> (KeyHash, &mut Entry) {
let hash = key.hash(self.hasher.build_hasher());
key.content.hash(&mut hasher);
key.size.to_bits().hash(&mut hasher);
key.line_height.to_bits().hash(&mut hasher);
key.font.hash(&mut hasher);
key.bounds.width.to_bits().hash(&mut hasher);
key.bounds.height.to_bits().hash(&mut hasher);
key.shaping.hash(&mut hasher);
if let Some(hash) = self.measurements.get(&hash) {
let _ = self.recently_used.insert(*hash);
hasher.finish()
};
return (*hash, self.entries.get_mut(hash).unwrap());
}
if let hash_map::Entry::Vacant(entry) = self.entries.entry(hash) {
let metrics = cosmic_text::Metrics::new(key.size, key.size * 1.2);
@ -416,7 +413,24 @@ impl Cache {
to_shaping(key.shaping),
);
let _ = entry.insert(buffer);
let bounds = measure(&buffer);
let _ = entry.insert(Entry { buffer, bounds });
for bounds in [
bounds,
Size {
width: key.bounds.width,
..bounds
},
] {
if key.bounds != bounds {
let _ = self.measurements.insert(
Key { bounds, ..key }.hash(self.hasher.build_hasher()),
hash,
);
}
}
}
let _ = self.recently_used.insert(hash);
@ -428,6 +442,8 @@ impl Cache {
if self.trim_count > Self::TRIM_INTERVAL {
self.entries
.retain(|key, _| self.recently_used.contains(key));
self.measurements
.retain(|_, value| self.recently_used.contains(value));
self.recently_used.clear();
@ -448,4 +464,18 @@ struct Key<'a> {
shaping: Shaping,
}
impl Key<'_> {
fn hash<H: Hasher>(self, mut hasher: H) -> KeyHash {
self.content.hash(&mut hasher);
self.size.to_bits().hash(&mut hasher);
self.line_height.to_bits().hash(&mut hasher);
self.font.hash(&mut hasher);
self.bounds.width.to_bits().hash(&mut hasher);
self.bounds.height.to_bits().hash(&mut hasher);
self.shaping.hash(&mut hasher);
hasher.finish()
}
}
type KeyHash = u64;

View file

@ -355,7 +355,7 @@ impl backend::Text for Backend {
font: Font,
bounds: Size,
shaping: core::text::Shaping,
) -> (f32, f32) {
) -> Size {
self.text_pipeline.measure(
contents,
size,

View file

@ -113,15 +113,13 @@ impl Pipeline {
.iter()
.zip(keys.iter())
.filter_map(|(section, key)| {
let buffer = cache.get(key).expect("Get cached buffer");
let entry = cache.get(key).expect("Get cached buffer");
let x = section.bounds.x * scale_factor;
let y = section.bounds.y * scale_factor;
let (max_width, total_height) = measure(buffer);
let max_width = max_width * scale_factor;
let total_height = total_height * scale_factor;
let max_width = entry.bounds.width * scale_factor;
let total_height = entry.bounds.height * scale_factor;
let left = match section.horizontal_alignment {
alignment::Horizontal::Left => x,
@ -145,7 +143,7 @@ impl Pipeline {
let clip_bounds = bounds.intersection(&section_bounds)?;
Some(glyphon::TextArea {
buffer,
buffer: &entry.buffer,
left,
top,
scale: scale_factor,
@ -239,12 +237,12 @@ impl Pipeline {
font: Font,
bounds: Size,
shaping: Shaping,
) -> (f32, f32) {
) -> Size {
let mut measurement_cache = self.cache.borrow_mut();
let line_height = f32::from(line_height.to_absolute(Pixels(size)));
let (_, paragraph) = measurement_cache.allocate(
let (_, entry) = measurement_cache.allocate(
&mut self.font_system.borrow_mut(),
Key {
content,
@ -256,7 +254,7 @@ impl Pipeline {
},
);
measure(paragraph)
entry.bounds
}
pub fn hit_test(
@ -274,7 +272,7 @@ impl Pipeline {
let line_height = f32::from(line_height.to_absolute(Pixels(size)));
let (_, paragraph) = measurement_cache.allocate(
let (_, entry) = measurement_cache.allocate(
&mut self.font_system.borrow_mut(),
Key {
content,
@ -286,20 +284,20 @@ impl Pipeline {
},
);
let cursor = paragraph.hit(point.x, point.y)?;
let cursor = entry.buffer.hit(point.x, point.y)?;
Some(Hit::CharOffset(cursor.index))
}
}
fn measure(buffer: &glyphon::Buffer) -> (f32, f32) {
fn measure(buffer: &glyphon::Buffer) -> Size {
let (width, total_lines) = buffer
.layout_runs()
.fold((0.0, 0usize), |(width, total_lines), run| {
(run.line_w.max(width), total_lines + 1)
});
(width, total_lines as f32 * buffer.metrics().line_height)
Size::new(width, total_lines as f32 * buffer.metrics().line_height)
}
fn to_family(family: font::Family) -> glyphon::Family<'static> {
@ -349,11 +347,17 @@ fn to_shaping(shaping: Shaping) -> glyphon::Shaping {
}
struct Cache {
entries: FxHashMap<KeyHash, glyphon::Buffer>,
entries: FxHashMap<KeyHash, Entry>,
measurements: FxHashMap<KeyHash, KeyHash>,
recently_used: FxHashSet<KeyHash>,
hasher: HashBuilder,
}
struct Entry {
buffer: glyphon::Buffer,
bounds: Size,
}
#[cfg(not(target_arch = "wasm32"))]
type HashBuilder = twox_hash::RandomXxHashBuilder64;
@ -364,12 +368,13 @@ impl Cache {
fn new() -> Self {
Self {
entries: FxHashMap::default(),
measurements: FxHashMap::default(),
recently_used: FxHashSet::default(),
hasher: HashBuilder::default(),
}
}
fn get(&self, key: &KeyHash) -> Option<&glyphon::Buffer> {
fn get(&self, key: &KeyHash) -> Option<&Entry> {
self.entries.get(key)
}
@ -377,20 +382,14 @@ impl Cache {
&mut self,
font_system: &mut glyphon::FontSystem,
key: Key<'_>,
) -> (KeyHash, &mut glyphon::Buffer) {
let hash = {
let mut hasher = self.hasher.build_hasher();
) -> (KeyHash, &mut Entry) {
let hash = key.hash(self.hasher.build_hasher());
key.content.hash(&mut hasher);
key.size.to_bits().hash(&mut hasher);
key.line_height.to_bits().hash(&mut hasher);
key.font.hash(&mut hasher);
key.bounds.width.to_bits().hash(&mut hasher);
key.bounds.height.to_bits().hash(&mut hasher);
key.shaping.hash(&mut hasher);
if let Some(hash) = self.measurements.get(&hash) {
let _ = self.recently_used.insert(*hash);
hasher.finish()
};
return (*hash, self.entries.get_mut(hash).unwrap());
}
if let hash_map::Entry::Vacant(entry) = self.entries.entry(hash) {
let metrics = glyphon::Metrics::new(key.size, key.line_height);
@ -411,7 +410,23 @@ impl Cache {
to_shaping(key.shaping),
);
let _ = entry.insert(buffer);
let bounds = measure(&buffer);
let _ = entry.insert(Entry { buffer, bounds });
for bounds in [
bounds,
Size {
width: key.bounds.width,
..bounds
},
] {
if key.bounds != bounds {
let _ = self.measurements.insert(
Key { bounds, ..key }.hash(self.hasher.build_hasher()),
hash,
);
}
}
}
let _ = self.recently_used.insert(hash);
@ -422,6 +437,8 @@ impl Cache {
fn trim(&mut self) {
self.entries
.retain(|key, _| self.recently_used.contains(key));
self.measurements
.retain(|_, value| self.recently_used.contains(value));
self.recently_used.clear();
}
@ -437,4 +454,18 @@ struct Key<'a> {
shaping: Shaping,
}
impl Key<'_> {
fn hash<H: Hasher>(self, mut hasher: H) -> KeyHash {
self.content.hash(&mut hasher);
self.size.to_bits().hash(&mut hasher);
self.line_height.to_bits().hash(&mut hasher);
self.font.hash(&mut hasher);
self.bounds.width.to_bits().hash(&mut hasher);
self.bounds.height.to_bits().hash(&mut hasher);
self.shaping.hash(&mut hasher);
hasher.finish()
}
}
type KeyHash = u64;