diff --git a/crates/compose/src/breaker.rs b/crates/compose/src/breaker.rs index 2aa9b3ae7..c2db91fb2 100644 --- a/crates/compose/src/breaker.rs +++ b/crates/compose/src/breaker.rs @@ -81,15 +81,21 @@ impl Spacing { if !self.justify || g.locked_advance { return ([0.0; 3], [0.0; 3]); } + // A space that is no break opportunity (No Break, U+00A0) is a box with word-space elasticity. + if g.is_justify_space() { + let (st, sh) = self.space_elastic(g); + return ([st, 0.0, 0.0], [sh, 0.0, 0.0]); + } let natural = g.adv / self.glyph_desired.max(0.01); ( [0.0, g.space * (self.letter_max - self.letter_desired).max(0.0), natural * (self.glyph_max - self.glyph_desired).max(0.0)], [0.0, g.space * (self.letter_desired - self.letter_min).max(0.0), natural * (self.glyph_desired - self.glyph_min).max(0.0)], ) } - /// Word-space stretch and shrink of space glyph `g` (only U+0020 is elastic). + /// Word-space stretch and shrink of space glyph `g` (see [`Glyph::is_word_space`]); none + /// inside a jidori run, whose width is fitted. fn space_elastic(&self, g: &Glyph) -> (f64, f64) { - if g.ch != ' ' && !(g.ch == '\u{3000}' && g.ideographic_space_elastic) { + if !g.is_word_space() || g.locked_advance { return (0.0, 0.0); } (g.space * (self.word_max - self.word_desired).max(0.0), g.space * (self.word_desired - self.word_min).max(0.0)) diff --git a/crates/compose/src/lib.rs b/crates/compose/src/lib.rs index 674259efe..269b9be69 100644 --- a/crates/compose/src/lib.rs +++ b/crates/compose/src/lib.rs @@ -1672,7 +1672,7 @@ fn apply_desired_spacing(glyphs: &mut [Glyph], pp: &ParaProps) { if g.locked_advance { continue; } - if g.ch == ' ' || (g.ch == '\u{3000}' && g.ideographic_space_elastic) { + if g.is_word_space() { g.adv += g.space * (ws - 1.0); } else if !g.is_space() && g.adv > 0.0 { g.adv = g.adv * gs + ls * g.space; @@ -2566,7 +2566,8 @@ fn layout_line( // a line whose last tab is a right, centre, character or right-indent tab is not justified. let seg = last_tab.map_or(0, |(i, _)| i + 1); let seg_justifies = last_tab.is_none_or(|(_, left)| left); - let spaces: Vec = line.iter().enumerate().skip(seg).filter(|(_, g)| g.is_space() && !g.no_break).map(|(i, _)| i).collect(); + // Spaces inside a jidori run keep the run's fitted width, as in the breaker. + let spaces: Vec = line.iter().enumerate().skip(seg).filter(|(_, g)| g.is_justify_space() && !g.locked_advance).map(|(i, _)| i).collect(); let align = match pp.align { Align::TowardsSpine => { if left_page { @@ -2667,7 +2668,7 @@ fn layout_line( let mut ratio_n = 0usize; for &i in &spaces { let g = &line[i]; - if g.ch == ' ' && g.space > 0.0 { + if matches!(g.ch, ' ' | shape::NBSP) && g.space > 0.0 { ratio_sum += (g.adv + add[i]) / g.space; ratio_n += 1; } @@ -2853,7 +2854,7 @@ fn distribute(line: &[Glyph], spaces: &[usize], extra: f64, sp: &Spacing, add: & .iter() .map(|&i| { let g = &line[i]; - if g.ch != ' ' && !(g.ch == '\u{3000}' && g.ideographic_space_elastic) { + if !g.is_word_space() { 0.0 } else if stretch { g.space * (sp.word_max - sp.word_desired).max(0.0) @@ -2863,8 +2864,8 @@ fn distribute(line: &[Glyph], spaces: &[usize], extra: f64, sp: &Spacing, add: & }) .collect(); // Letter gaps: between visible glyphs (not after the line's last glyph). - let last_box = line.iter().rposition(|g| !g.is_space() && g.adv > 0.0).unwrap_or(0); - let is_box = |i: usize, g: &Glyph| i < last_box && !g.is_space() && g.adv > 0.0 && (!g.locked_advance || g.break_after != Some(false)); + let last_box = line.iter().rposition(|g| !g.is_justify_space() && g.adv > 0.0).unwrap_or(0); + let is_box = |i: usize, g: &Glyph| i < last_box && !g.is_justify_space() && g.adv > 0.0 && (!g.locked_advance || g.break_after != Some(false)); let letter: Vec = line .iter() .enumerate() @@ -2881,7 +2882,7 @@ fn distribute(line: &[Glyph], spaces: &[usize], extra: f64, sp: &Spacing, add: & let glyph: Vec = line .iter() .map(|g| { - if g.is_space() || g.adv <= 0.0 || g.locked_advance { + if g.is_justify_space() || g.adv <= 0.0 || g.locked_advance { 0.0 } else { let natural = g.adv / sp.glyph_desired.max(0.01); diff --git a/crates/compose/src/shape.rs b/crates/compose/src/shape.rs index 7c5b9b804..6efbd3660 100644 --- a/crates/compose/src/shape.rs +++ b/crates/compose/src/shape.rs @@ -78,12 +78,24 @@ impl Glyph { pub fn is_space(&self) -> bool { matches!(self.ch, ' ' | '\u{2002}'..='\u{200A}') || (self.ch == '\u{3000}' && self.ideographic_space_elastic) } + /// A space whose width justification and word spacing vary: U+0020, the nonbreaking space + /// U+00A0 and an elastic ideographic space. Fixed-width spaces (U+2002–U+200A, U+202F) get no + /// word-space stretch or shrink. + pub fn is_word_space(&self) -> bool { + matches!(self.ch, ' ' | NBSP) || (self.ch == '\u{3000}' && self.ideographic_space_elastic) + } + /// A space that justification treats as a word space rather than a letter: [`Self::is_space`] + /// plus U+00A0, which is never a break opportunity. + pub fn is_justify_space(&self) -> bool { + self.is_space() || self.ch == NBSP + } pub fn is_letter(&self) -> bool { self.ch.is_alphabetic() || matches!(self.ch, '\'' | '’') } } pub const SOFT_HYPHEN: char = '\u{AD}'; +pub const NBSP: char = '\u{A0}'; /// Shaped paragraph. pub struct ShapedPara { diff --git a/crates/compose/src/tests.rs b/crates/compose/src/tests.rs index eda23af34..97eeb8cd4 100644 --- a/crates/compose/src/tests.rs +++ b/crates/compose/src/tests.rs @@ -622,6 +622,110 @@ fn hyphenation_skips_a_no_break_word_at_the_start() { assert!(!first.hyphenated && first.range.end >= 15, "{:?}", &text[first.range.clone()]); } +/// Natural advance of each glyph of `text` by byte, and a frame width that puts the first three +/// words on a justified line with one word space of extra to share. +fn three_word_measure(text: &str) -> (std::collections::HashMap, f64) { + let (d, sid, _) = doc_with(text, Rect::new(0.0, 0.0, 1000.0, 100.0), ParaAttrs::default()); + let cs = compose_story(&d, sid, &ComposeOptions::default()); + let line = all_lines(&cs)[0]; + let adv = line.glyphs.iter().map(|g| (g.byte, g.adv)).collect::>(); + let third_end = text.find(" dddd").unwrap(); + let gap = line.glyphs.iter().find(|g| g.byte == third_end).unwrap(); + (adv, gap.x - line.x0 + gap.adv + 2.0 * line.x0) +} + +fn justified_first_line(text: &str, width: f64, no_break: Option>) -> Line { + let para = ParaAttrs { align: Some(Align::LeftJustified), word_space_max: Some(4.0), ..Default::default() }; + let (mut d, sid, _) = doc_with(text, Rect::new(0.0, 0.0, width, 1000.0), para); + if let Some(run) = no_break { + d.story_mut(sid).unwrap().format_chars(run, |f| f.over.no_break = Some(true)); + } + let cs = compose_story(&d, sid, &ComposeOptions::default()); + let line = all_lines(&cs)[0].clone(); + assert!((line.end_x - line.x1).abs() < 0.1, "line ends at {} not {}", line.end_x, line.x1); + line +} + +#[test] +fn no_break_spaces_stretch_on_justified_lines() { + let text = "aaaa bbbb cccc dddd eeee ffff gggg hhhh"; + let (natural, width) = three_word_measure(text); + // The run holds one of the line's two spaces, then both. + for run in [0..9, 0..14] { + let line = justified_first_line(text, width, Some(run.clone())); + assert_eq!(text[line.range.clone()].trim_end(), "aaaa bbbb cccc"); + let words = line.glyphs.iter().filter(|g| g.byte < 14); + let (spaces, letters): (Vec<_>, Vec<_>) = words.partition(|g| text.as_bytes()[g.byte] == b' '); + assert_eq!(spaces.len(), 2); + for s in &spaces { + assert!(s.adv > natural[&s.byte] + 1.0 && (s.adv - spaces[0].adv).abs() < 1e-6, "run {run:?}: space at {} is {}", s.byte, s.adv); + } + for g in letters { + assert!((g.adv - natural[&g.byte]).abs() < 1e-6, "run {run:?}: letter at {} is {}", g.byte, g.adv); + } + } +} + +#[test] +fn nonbreaking_space_stretches_and_fixed_width_one_does_not() { + for (nb, stretches) in [('\u{A0}', true), ('\u{202F}', false)] { + let text = format!("aaaa{nb}bbbb cccc dddd eeee ffff gggg hhhh"); + let (natural, width) = three_word_measure(&text); + let line = justified_first_line(&text, width, None); + let nb_glyph = line.glyphs.iter().find(|g| g.byte == 4).unwrap(); + let space = line.glyphs.iter().find(|g| text.as_bytes()[g.byte] == b' ').unwrap(); + assert!(space.adv > natural[&space.byte] + 1.0); + if stretches { + assert!((nb_glyph.adv - space.adv).abs() < 1e-6, "{nb:?}: {} vs {}", nb_glyph.adv, space.adv); + } else { + assert!((nb_glyph.adv - natural[&4]).abs() < 1e-6, "{nb:?}: {} vs {}", nb_glyph.adv, natural[&4]); + } + } +} + +#[test] +fn jidori_run_keeps_its_width_on_a_justified_line() { + fn first_line(text: &str, width: f64, para: ParaAttrs, run: std::ops::Range) -> Line { + let (mut d, sid, _) = doc_with(text, Rect::new(0.0, 0.0, width, 1000.0), para); + d.story_mut(sid).unwrap().format_chars(run, |f| f.over.jidori = Some(6)); + let cs = compose_story(&d, sid, &ComposeOptions::default()); + all_lines(&cs)[0].clone() + } + for sp in ['\u{A0}', ' '] { + let text = format!("aa{sp}aa bbbb cccc dddd eeee ffff gggg hhhh"); + let run = 0..4 + sp.len_utf8(); + let run_width = |l: &Line| l.glyphs.iter().filter(|g| run.contains(&g.byte)).map(|g| g.adv).sum::(); + let ragged = first_line(&text, 1000.0, ParaAttrs::default(), run.clone()); + let gap = ragged.glyphs.iter().find(|g| g.byte == text.find(" dddd").unwrap()).unwrap(); + let width = gap.x - ragged.x0 + gap.adv + 2.0 * ragged.x0; + let para = ParaAttrs { align: Some(Align::LeftJustified), word_space_max: Some(4.0), ..Default::default() }; + let line = first_line(&text, width, para, run.clone()); + assert_eq!(text[line.range.clone()].trim_end(), format!("aa{sp}aa bbbb cccc")); + assert!((line.end_x - line.x1).abs() < 0.1, "{sp:?}: line ends at {} not {}", line.end_x, line.x1); + assert!((run_width(&line) - run_width(&ragged)).abs() < 1e-6, "{sp:?}: run is {} not {}", run_width(&line), run_width(&ragged)); + } +} + +#[test] +fn nonbreaking_space_alone_fills_a_justified_line() { + let text = "10\u{A0}km 1234"; + let (d, sid, _) = doc_with(text, Rect::new(0.0, 0.0, 1000.0, 100.0), ParaAttrs::default()); + let cs = compose_story(&d, sid, &ComposeOptions::default()); + let ragged = all_lines(&cs)[0]; + let natural = ragged.glyphs.iter().map(|g| (g.byte, g.adv)).collect::>(); + let m = ragged.glyphs.iter().find(|g| g.byte == 5).unwrap(); + let width = m.x - ragged.x0 + m.adv + 15.0 + 2.0 * ragged.x0; + let line = justified_first_line(text, width, None); + assert_eq!(text[line.range.clone()].trim_end(), "10\u{A0}km"); + for g in line.glyphs.iter().filter(|g| g.byte < 6) { + if g.byte == 2 { + assert!((g.adv - natural[&2] - 15.0).abs() < 0.1, "U+00A0 is {}", g.adv); + } else { + assert!((g.adv - natural[&g.byte]).abs() < 1e-6, "glyph at {} is {}", g.byte, g.adv); + } + } +} + /// Story of `n` one-line filler paragraphs followed by `extra` paragraphs, in a 2-column frame. fn keep_doc(fillers: usize, extra: &[&str], height: f64) -> (Document, StoryId, Vec) { let mut parts: Vec = (0..fillers).map(|k| format!("Filler {k}")).collect();