Merge pull request #137 from embedded-graphics/multiple-plugins

Allow using multiple plugins

Author: bugadani

CHANGELOG.md

@@ -9,6 +9,7 @@ Unreleased
    - `TabSize::default()`
  * [#134] `Tail` plugin
  * [#135] Allow using the built-in plugins without the `plugin` feature.
+ * [#137] Allow using multiple plugins.
 
 ## Changed:
 
@@ -21,6 +22,7 @@ Unreleased
 [#133]: https://github.com/embedded-graphics/embedded-text/pull/133
 [#134]: https://github.com/embedded-graphics/embedded-text/pull/134
 [#135]: https://github.com/embedded-graphics/embedded-text/pull/135
+[#137]: https://github.com/embedded-graphics/embedded-text/pull/137
 
 0.5.0-beta.2 (2021-07-10)
 ==========================

Cargo.toml

@@ -36,6 +36,7 @@ az = "1.1"
 embedded-graphics = "0.7.0"
 ansi-parser = { version = "0.8.0", default-features = false, optional = true }
 as-slice = { version = "0.1.4", optional = true }
+object-chain = "0.1"
 
 [dev-dependencies]
 embedded-graphics-simulator = "0.3.0"

src/lib.rs

@@ -128,6 +128,7 @@ use embedded_graphics::{
     text::renderer::{CharacterStyle, TextRenderer},
     transform::Transform,
 };
+use object_chain::{Chain, ChainElement, Link};
 pub use parser::{ChangeTextStyle, Token};
 pub use rendering::TextBoxProperties;
 
@@ -242,7 +243,7 @@ where
 
     /// Adds a new plugin to the `TextBox`.
     #[inline]
-    pub fn add_plugin<M>(self, plugin: M) -> TextBox<'a, S, M>
+    pub fn add_plugin<M>(self, plugin: M) -> TextBox<'a, S, Chain<M>>
     where
         M: Plugin<'a, <S as TextRenderer>::Color>,
     {
@@ -252,7 +253,35 @@ where
             character_style: self.character_style,
             style: self.style,
             vertical_offset: self.vertical_offset,
-            plugin: PluginWrapper::new(plugin),
+            plugin: PluginWrapper::new(Chain::new(plugin)),
+        };
+        textbox.style.height_mode.apply(&mut textbox);
+
+        textbox
+    }
+}
+
+impl<'a, S, P> TextBox<'a, S, P>
+where
+    <S as TextRenderer>::Color: From<Rgb888>,
+    S: TextRenderer + CharacterStyle,
+    P: Plugin<'a, <S as TextRenderer>::Color> + ChainElement,
+{
+    /// Adds a new plugin to the `TextBox`.
+    #[inline]
+    pub fn add_plugin<M>(self, plugin: M) -> TextBox<'a, S, Link<M, P>>
+    where
+        M: Plugin<'a, <S as TextRenderer>::Color>,
+    {
+        let parent = self.plugin.inner.into_inner();
+
+        let mut textbox = TextBox {
+            text: self.text,
+            bounds: self.bounds,
+            character_style: self.character_style,
+            style: self.style,
+            vertical_offset: self.vertical_offset,
+            plugin: PluginWrapper::new(parent.plugin.append(plugin)),
         };
         textbox.style.height_mode.apply(&mut textbox);
 

src/plugin/mod.rs

@@ -71,7 +71,7 @@ where
     C: PixelColor,
 {
     lookahead: M,
-    plugin: M,
+    pub plugin: M,
     state: ProcessingState,
     peeked_token: (usize, Option<Token<'a, C>>),
 }
@@ -81,7 +81,7 @@ pub(crate) struct PluginWrapper<'a, M, C>
 where
     C: PixelColor,
 {
-    inner: RefCell<PluginInner<'a, M, C>>,
+    pub inner: RefCell<PluginInner<'a, M, C>>,
 }
 
 impl<'a, M, C> Hash for PluginWrapper<'a, M, C>

src/plugin/private.rs

@@ -6,6 +6,7 @@ use embedded_graphics::{
     primitives::Rectangle,
     text::renderer::{CharacterStyle, TextRenderer},
 };
+use object_chain::{Chain, ChainElement, Link};
 
 use crate::{parser::Token, rendering::cursor::Cursor, TextBoxProperties};
 
@@ -70,3 +71,102 @@ where
 }
 
 impl<'a, C> Plugin<'a, C> for super::NoPlugin<C> where C: PixelColor {}
+
+impl<'a, C, P> Plugin<'a, C> for Chain<P>
+where
+    P: Plugin<'a, C>,
+    C: PixelColor,
+    Chain<P>: Clone,
+{
+    fn new_line(&mut self) {
+        self.object.new_line();
+    }
+
+    fn next_token(
+        &mut self,
+        next_token: impl FnMut() -> Option<Token<'a, C>>,
+    ) -> Option<Token<'a, C>> {
+        self.object.next_token(next_token)
+    }
+
+    fn render_token(&mut self, token: Token<'a, C>) -> Option<Token<'a, C>> {
+        self.object.render_token(token)
+    }
+
+    fn post_render<T, D>(
+        &mut self,
+        draw_target: &mut D,
+        character_style: &T,
+        text: &str,
+        bounds: Rectangle,
+    ) -> Result<(), D::Error>
+    where
+        T: TextRenderer<Color = C>,
+        D: DrawTarget<Color = C>,
+    {
+        self.object
+            .post_render(draw_target, character_style, text, bounds)
+    }
+
+    fn on_start_render<S: CharacterStyle>(
+        &mut self,
+        cursor: &mut Cursor,
+        props: TextBoxProperties<'_, S>,
+    ) {
+        self.object.on_start_render(cursor, props)
+    }
+}
+
+impl<'a, C, P, CE> Plugin<'a, C> for Link<P, CE>
+where
+    CE: ChainElement + Plugin<'a, C>,
+    P: Plugin<'a, C>,
+    C: PixelColor,
+    Link<P, CE>: Clone,
+{
+    fn new_line(&mut self) {
+        self.parent.new_line();
+        self.object.new_line();
+    }
+
+    fn next_token(
+        &mut self,
+        mut next_token: impl FnMut() -> Option<Token<'a, C>>,
+    ) -> Option<Token<'a, C>> {
+        let parent = &mut self.parent;
+        let next_token = || parent.next_token(&mut next_token);
+        self.object.next_token(next_token)
+    }
+
+    fn render_token(&mut self, token: Token<'a, C>) -> Option<Token<'a, C>> {
+        self.parent
+            .render_token(token)
+            .and_then(|t| self.object.render_token(t))
+    }
+
+    fn post_render<T, D>(
+        &mut self,
+        draw_target: &mut D,
+        character_style: &T,
+        text: &str,
+        bounds: Rectangle,
+    ) -> Result<(), D::Error>
+    where
+        T: TextRenderer<Color = C>,
+        D: DrawTarget<Color = C>,
+    {
+        self.parent
+            .post_render(draw_target, character_style, text, bounds)?;
+        self.object
+            .post_render(draw_target, character_style, text, bounds)
+    }
+
+    fn on_start_render<S: CharacterStyle>(
+        &mut self,
+        cursor: &mut Cursor,
+        props: TextBoxProperties<'_, S>,
+    ) {
+        self.parent.on_start_render(cursor, props.clone());
+        self.object.on_start_render(cursor, props);
+    }
+}

src/rendering/mod.rs

@@ -30,6 +30,7 @@ use line_iter::LineEndType;
 /// Text box properties.
 ///
 /// This struct holds information about the text box.
+#[derive(Clone)]
 pub struct TextBoxProperties<'a, S> {
     /// The used text box style.
     pub box_style: &'a TextBoxStyle,