Adds a separate wrapping option to allow word to glyph fallback.

pop-os · Feb 2, 2024 · cc75bb6 · cc75bb6
1 parent b7f1506
commit cc75bb6
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 14 deletions.
diff --git a/src/layout.rs b/src/layout.rs
@@ -104,15 +104,18 @@ pub enum Wrap {
     None,
     /// Wraps at a glyph level
     Glyph,
-    /// Word Wrapping
+    /// Wraps at the word level
     Word,
+    /// Wraps at the word level, or fallback to glyph level if a word can't fit on a line by itself
+    WordOrGlyph,
 }
 
 impl Display for Wrap {
     fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
         match self {
             Self::None => write!(f, "No Wrap"),
             Self::Word => write!(f, "Word Wrap"),
+            Self::WordOrGlyph => write!(f, "Word Wrap or Character"),
             Self::Glyph => write!(f, "Character"),
         }
     }

diff --git a/src/shape.rs b/src/shape.rs
@@ -994,10 +994,13 @@ impl ShapeLine {
                             continue;
                         } else if wrap == Wrap::Glyph
                             // Make sure that the word is able to fit on it's own line, if not, fall back to Glyph wrapping.
-                            || word_width > line_width
+                            || (wrap == Wrap::WordOrGlyph && word_width > line_width)
                         {
                             // Commit the current line so that the word starts on the next line.
-                            if word_range_width > 0. && word_width > line_width {
+                            if word_range_width > 0.
+                                && wrap == Wrap::WordOrGlyph
+                                && word_width > line_width
+                            {
                                 add_to_visual_line(
                                     &mut current_visual_line,
                                     span_index,
@@ -1041,7 +1044,7 @@ impl ShapeLine {
                                 }
                             }
                         } else {
-                            // Wrap::Word
+                            // Wrap::Word, Wrap::WordOrGlyph
 
                             // TODO: What if the previous span ended with whitespace and the next
                             // span wraps a new line? Is that possible?
@@ -1117,10 +1120,13 @@ impl ShapeLine {
                             continue;
                         } else if wrap == Wrap::Glyph
                             // Make sure that the word is able to fit on it's own line, if not, fall back to Glyph wrapping.
-                            || word_width > line_width
+                            || (wrap == Wrap::WordOrGlyph && word_width > line_width)
                         {
                             // Commit the current line so that the word starts on the next line.
-                            if word_range_width > 0. && word_width > line_width {
+                            if word_range_width > 0.
+                                && wrap == Wrap::WordOrGlyph
+                                && word_width > line_width
+                            {
                                 add_to_visual_line(
                                     &mut current_visual_line,
                                     span_index,
@@ -1164,7 +1170,7 @@ impl ShapeLine {
                                 }
                             }
                         } else {
-                            // Wrap::Word
+                            // Wrap::Word, Wrap::WordOrGlyph
 
                             // Current word causing a wrap is not whitespace, so we ignore the
                             // previous word if it's a whitespace

diff --git a/tests/images/a_hebrew_word.png b/tests/images/a_hebrew_word.png
diff --git a/tests/images/an_arabic_word.png b/tests/images/an_arabic_word.png
diff --git a/tests/shaping_and_rendering.rs b/tests/shaping_and_rendering.rs
@@ -11,7 +11,7 @@ fn test_hebrew_word_rendering() {
         .font_size(36., 40.)
         .font_attrs(attrs)
         .text("בדיקה")
-        .canvas(120, 60)
+        .canvas(100, 60)
         .validate_text_rendering();
 }
 
@@ -46,7 +46,7 @@ fn test_arabic_word_rendering() {
         .font_size(36., 40.)
         .font_attrs(attrs)
         .text("خالصة")
-        .canvas(120, 60)
+        .canvas(100, 60)
         .validate_text_rendering();
 }
 

diff --git a/tests/wrap_word_fallback.rs b/tests/wrap_word_fallback.rs
@@ -11,7 +11,7 @@ fn wrap_word_fallback() {
 
     let mut buffer = buffer.borrow_with(&mut font_system);
 
-    buffer.set_wrap(Wrap::Word);
+    buffer.set_wrap(Wrap::WordOrGlyph);
     buffer.set_text("Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.", Attrs::new().family(cosmic_text::Family::Name("Inter")), Shaping::Advanced);
     buffer.set_size(50.0, 1000.0);