Merge pull request #157 from embedded-graphics/spaces

Fix space handling when wrapping lines

Author: bugadani

.github/workflows/rust.yml

@@ -116,6 +116,8 @@ jobs:
         compare -metric AE ./assets/styles-plugin.png ./target/screenshots/styles-plugin.png result.png
         EG_SIMULATOR_DUMP="./target/screenshots/styles-static.png" cargo run --example styles-static
         compare -metric AE ./assets/styles-static.png ./target/screenshots/styles-static.png result.png
+        EG_SIMULATOR_DUMP="./target/screenshots/whitespace_control.png" cargo run --example whitespace_control
+        compare -metric AE ./assets/whitespace_control.png ./target/screenshots/whitespace_control.png result.png
 
   docs:
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -1,9 +1,16 @@
 0.5.0 (??)
 ==========
 
+## Fixed:
+
+ * [#157] Fixed carrying whitespace to the next line
+
+## Removed:
+
  * [#155] Removed `TextBox::fit_height` and `TextBox::fit_height_limited`
 
 [#155]: https://github.com/embedded-graphics/embedded-text/pull/155
+[#157]: https://github.com/embedded-graphics/embedded-text/pull/157
 
 0.5.0-beta.4 (2021-08-16)
 =========================

assets/whitespace_control.png

@@ -0,0 +1,62 @@
+//! # Example: whitespace control.
+//!
+//! This example demonstrates the different leading/trailing whitespace options and their effect.
+
+use embedded_graphics::{
+    geometry::AnchorPoint,
+    mono_font::{ascii::FONT_6X10, MonoTextStyleBuilder},
+    pixelcolor::Rgb888,
+    prelude::*,
+    primitives::Rectangle,
+};
+use embedded_graphics_simulator::{OutputSettingsBuilder, SimulatorDisplay, Window};
+use embedded_text::{style::TextBoxStyleBuilder, TextBox};
+use std::convert::Infallible;
+
+fn main() -> Result<(), Infallible> {
+    // Set up the window.
+    let output_settings = OutputSettingsBuilder::new().scale(3).build();
+    let mut window = Window::new("Interactive TextBox demonstration", &output_settings);
+
+    let text = "  Hello, World!\n  \
+        Lorem Ipsum is simply dummy text of the printing and typesetting industry.   \
+        Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when \
+        an unknown printer took a galley of type and scrambled it to make a type specimen book.";
+
+    let character_style = MonoTextStyleBuilder::new()
+        .font(&FONT_6X10)
+        .text_color(Rgb888::WHITE)
+        .background_color(Rgb888::CSS_STEEL_BLUE)
+        .build();
+
+    // Create a simulated display.
+    let mut display = SimulatorDisplay::new(Size::new(255, 140));
+
+    // Create bounding boxes
+    let bounds = Rectangle::new(Point::zero(), Size::new(255, 140));
+
+    // Create and draw the text boxes.
+    TextBox::with_textbox_style(
+        text,
+        bounds.resized(Size::new(128, 255), AnchorPoint::TopLeft),
+        character_style,
+        TextBoxStyleBuilder::default().build(),
+    )
+    .draw(&mut display)?;
+
+    TextBox::with_textbox_style(
+        text,
+        bounds.resized(Size::new(128, 255), AnchorPoint::TopRight),
+        character_style,
+        TextBoxStyleBuilder::default()
+            .leading_spaces(false)
+            .trailing_spaces(true)
+            .build(),
+    )
+    .draw(&mut display)?;
+
+    // Update the window.
+    window.show_static(&display);
+
+    Ok(())
+}

examples/whitespace_control.rs

@@ -250,10 +250,11 @@ where
                         consumed,
                         consumed_width * self.render_trailing_spaces() as u32,
                     )?;
-
-                    self.plugin.consume_partial(consumed as usize);
-                    return Ok(true);
                 }
+
+                self.plugin
+                    .consume_partial((consumed + 1).min(space_count) as usize);
+                return Ok(true);
             }
         }
         Ok(false)
@@ -680,7 +681,15 @@ pub(crate) mod test {
             ],
             &mw,
         );
-        assert_line_elements(&mut parser, 5, &[RenderElement::string("f", 6)], &mw);
+        assert_line_elements(
+            &mut parser,
+            5,
+            &[
+                RenderElement::Space(0, false), // FIXME: why 🤷‍♂️ Should have eaten in prev line
+                RenderElement::string("f", 6),
+            ],
+            &mw,
+        );
     }
 
     #[test]
@@ -750,7 +759,7 @@ pub(crate) mod test {
 
     #[test]
     fn space_wrapping_issue() {
-        let mut parser = Parser::parse("Hello,     s");
+        let mut parser = Parser::parse("Hello,      s");
         let mw = PluginWrapper::new(NoPlugin::<Rgb888>::new());
 
         assert_line_elements(

src/rendering/line_iter.rs

@@ -380,7 +380,7 @@ pub mod test {
             .build();
 
         TextBox::with_textbox_style(
-            "Hello,     s",
+            "Hello,      s",
             Rectangle::new(Point::zero(), size_for(&FONT_6X10, 10, 2)),
             character_style,
             TextBoxStyleBuilder::new()