chore: change Shape to ModuleShape

erwanvivien · Oct 15, 2023 · ab1ad55 · ab1ad55
1 parent f545c17
commit ab1ad55
Show file tree

Hide file tree

Showing 9 changed files with 201 additions and 198 deletions.
diff --git a/examples/custom.rs b/examples/custom.rs
@@ -1,6 +1,6 @@
 fn main() {
     use fast_qr::{
-        convert::{image::ImageBuilder, Builder, Shape},
+        convert::{image::ImageBuilder, Builder, ModuleShape},
         ModuleType, QRBuilder, Version, ECL,
     };
 
@@ -12,21 +12,21 @@ fn main() {
 
     let mut _img = ImageBuilder::default()
         // Can have many shapes and custom shapes
-        .shape(Shape::Command(|y, x, cell| {
+        .module_shape(ModuleShape::Command(|y, x, cell| {
             match cell.module_type() {
                 ModuleType::FinderPattern | ModuleType::Alignment => String::new(),
                 _ => {
                     // Works thanks to Deref
-                    Shape::Square(y, x, cell)
+                    ModuleShape::Square(y, x, cell)
                 }
             }
         }))
-        .shape_color(
-            Shape::Command(|y, x, cell| {
+        .module_shape_color(
+            ModuleShape::Command(|y, x, cell| {
                 match cell.module_type() {
                     ModuleType::FinderPattern | ModuleType::Alignment => {
                         // Works thanks to Deref
-                        Shape::Circle(y, x, cell)
+                        ModuleShape::Circle(y, x, cell)
                     }
                     _ => String::new(),
                 }

diff --git a/examples/embed.rs b/examples/embed.rs
@@ -1,6 +1,6 @@
 fn main() {
     use fast_qr::{
-        convert::{image::ImageBuilder, Builder, ImageBackgroundShape, Shape},
+        convert::{image::ImageBuilder, Builder, ImageBackgroundShape, ModuleShape},
         QRBuilder, Version, ECL,
     };
 
@@ -11,7 +11,7 @@ fn main() {
         .unwrap();
 
     let mut _img = ImageBuilder::default()
-        .shape(Shape::Square)
+        .module_shape(ModuleShape::Square)
         .fit_width(600)
         .background_color([255, 255, 255, 255])
         // New: embed an image

diff --git a/examples/image.rs b/examples/image.rs
@@ -1,6 +1,6 @@
 fn main() {
     use fast_qr::{
-        convert::{image::ImageBuilder, Builder, Shape},
+        convert::{image::ImageBuilder, Builder, ModuleShape},
         QRBuilder, Version, ECL,
     };
 
@@ -11,14 +11,14 @@ fn main() {
         .unwrap();
 
     let _image = ImageBuilder::default()
-        .shape(Shape::RoundedSquare)
+        .module_shape(ModuleShape::RoundedSquare)
         .fit_width(600)
         .background_color([255, 255, 255, 0]) // transparency
         .to_file(&qrcode, "image.png");
 
     // Or maybe as bytes.
     let _image_as_bytes = ImageBuilder::default()
-        .shape(Shape::RoundedSquare)
+        .module_shape(ModuleShape::RoundedSquare)
         .fit_width(512)
         .background_color([255, 255, 255, 255]) // opaque
         .to_bytes(&qrcode);

diff --git a/examples/svg.rs b/examples/svg.rs
@@ -1,6 +1,6 @@
 fn main() {
     use fast_qr::{
-        convert::{svg::SvgBuilder, Builder, Shape},
+        convert::{svg::SvgBuilder, Builder, ModuleShape},
         QRBuilder, Version, ECL,
     };
 
@@ -11,6 +11,6 @@ fn main() {
         .unwrap();
 
     let _svg = SvgBuilder::default()
-        .shape(Shape::RoundedSquare)
+        .module_shape(ModuleShape::RoundedSquare)
         .to_file(&qrcode, "svg.svg");
 }
diff --git a/src/convert/image.rs b/src/convert/image.rs
@@ -27,7 +27,7 @@ use std::io;
 use crate::QRCode;
 
 use super::Color;
-use super::{svg::SvgBuilder, Builder, Shape};
+use super::{svg::SvgBuilder, Builder, ModuleShape};
 
 use resvg::tiny_skia::{self, Pixmap};
 use resvg::usvg;
@@ -79,8 +79,8 @@ impl Builder for ImageBuilder {
         self
     }
 
-    fn shape(&mut self, shape: Shape) -> &mut Self {
-        self.svg_builder.shape(shape);
+    fn module_shape(&mut self, shape: ModuleShape) -> &mut Self {
+        self.svg_builder.module_shape(shape);
         self
     }
 
@@ -114,8 +114,8 @@ impl Builder for ImageBuilder {
         self
     }
 
-    fn shape_color<C: Into<Color>>(&mut self, shape: Shape, color: C) -> &mut Self {
-        self.svg_builder.shape_color(shape, color);
+    fn module_shape_color<C: Into<Color>>(&mut self, shape: ModuleShape, color: C) -> &mut Self {
+        self.svg_builder.module_shape_color(shape, color);
         self
     }
 }

diff --git a/src/convert/mod.rs b/src/convert/mod.rs
@@ -3,7 +3,6 @@
 #[cfg(feature = "svg")]
 #[cfg_attr(docsrs, doc(cfg(feature = "svg")))]
 pub mod svg;
-use core::ops::Deref;
 
 #[cfg(feature = "svg")]
 use svg::SvgError;
@@ -14,178 +13,12 @@ pub mod image;
 #[cfg(feature = "image")]
 use image::ImageError;
 
-use crate::Module;
-
-/// Converts a position to a module svg
-/// # Example
-///
-/// For the square shape, the svg is `M{x},{y}h1v1h-1`
-///
-/// ```rust
-/// fn square(y: usize, x: usize) -> String {
-///     format!("M{x},{y}h1v1h-1")
-/// }
-/// ```
-pub type ModuleFunction = fn(usize, usize, Module) -> String;
+mod module_shape;
+pub use module_shape::{ModuleFunction, ModuleShape};
 
 #[cfg(all(target_arch = "wasm32", feature = "wasm-bindgen"))]
 use wasm_bindgen::prelude::*;
 
-/// Different possible Shapes to represent modules in a [`crate::QRCode`]
-#[repr(C)]
-#[wasm_bindgen]
-#[cfg(feature = "wasm-bindgen")]
-#[derive(Debug, Clone, Copy, PartialEq, Eq, Ord, PartialOrd)]
-pub enum Shape {
-    /// Square Shape
-    Square,
-    /// Circle Shape
-    Circle,
-    /// RoundedSquare Shape
-    RoundedSquare,
-    /// Vertical Shape
-    Vertical,
-    /// Horizontal Shape
-    Horizontal,
-    /// Diamond Shape
-    Diamond,
-}
-
-/// Different possible Shapes to represent modules in a [`crate::QRCode`]
-#[cfg(not(feature = "wasm-bindgen"))]
-#[derive(Debug, Clone, Copy, PartialEq, Eq, Ord, PartialOrd)]
-pub enum Shape {
-    /// Square Shape
-    Square,
-    /// Circle Shape
-    Circle,
-    /// RoundedSquare Shape
-    RoundedSquare,
-    /// Vertical Shape
-    Vertical,
-    /// Horizontal Shape
-    Horizontal,
-    /// Diamond Shape
-    Diamond,
-    /// Custom Shape with a function / closure
-    /// # Example
-    /// ```rust
-    /// use fast_qr::convert::Shape;
-    /// let command_function = |y, x, cell| {
-    ///     if x % 2 == 0 {
-    ///         // Works thanks to Deref
-    ///         Shape::Square(y, x, cell)
-    ///     } else {
-    ///         // Rectangle
-    ///         format!("M{x},{y}h1v.5h-1")
-    ///     }
-    /// };
-    /// let command = Shape::Command(command_function);
-    /// ```
-    ///
-    /// <svg viewBox="0 0 37 37" xmlns="http://www.w3.org/2000/svg" width="250px">
-    ///     <rect width="37px" height="37px" fill="#ffffff" />
-    ///     <path
-    ///         d="M4,4h1v1h-1M4,5h1v1h-1M4,6h1v1h-1M4,7h1v1h-1M4,8h1v1h-1M4,9h1v1h-1M4,10h1v1h-1M4,12h1v1h-1M4,13h1v1h-1M4,17h1v1h-1M4,19h1v1h-1M4,22h1v1h-1M4,24h1v1h-1M4,26h1v1h-1M4,27h1v1h-1M4,28h1v1h-1M4,29h1v1h-1M4,30h1v1h-1M4,31h1v1h-1M4,32h1v1h-1M5,4h1v.5h-1M5,10h1v.5h-1M5,12h1v.5h-1M5,13h1v.5h-1M5,14h1v.5h-1M5,17h1v.5h-1M5,19h1v.5h-1M5,22h1v.5h-1M5,23h1v.5h-1M5,26h1v.5h-1M5,32h1v.5h-1M6,4h1v1h-1M6,6h1v1h-1M6,7h1v1h-1M6,8h1v1h-1M6,10h1v1h-1M6,12h1v1h-1M6,14h1v1h-1M6,16h1v1h-1M6,18h1v1h-1M6,19h1v1h-1M6,23h1v1h-1M6,24h1v1h-1M6,26h1v1h-1M6,28h1v1h-1M6,29h1v1h-1M6,30h1v1h-1M6,32h1v1h-1M7,4h1v.5h-1M7,6h1v.5h-1M7,7h1v.5h-1M7,8h1v.5h-1M7,10h1v.5h-1M7,13h1v.5h-1M7,15h1v.5h-1M7,18h1v.5h-1M7,21h1v.5h-1M7,23h1v.5h-1M7,26h1v.5h-1M7,28h1v.5h-1M7,29h1v.5h-1M7,30h1v.5h-1M7,32h1v.5h-1M8,4h1v1h-1M8,6h1v1h-1M8,7h1v1h-1M8,8h1v1h-1M8,10h1v1h-1M8,16h1v1h-1M8,17h1v1h-1M8,18h1v1h-1M8,19h1v1h-1M8,20h1v1h-1M8,22h1v1h-1M8,23h1v1h-1M8,24h1v1h-1M8,26h1v1h-1M8,28h1v1h-1M8,29h1v1h-1M8,30h1v1h-1M8,32h1v1h-1M9,4h1v.5h-1M9,10h1v.5h-1M9,12h1v.5h-1M9,13h1v.5h-1M9,14h1v.5h-1M9,15h1v.5h-1M9,16h1v.5h-1M9,19h1v.5h-1M9,22h1v.5h-1M9,26h1v.5h-1M9,32h1v.5h-1M10,4h1v1h-1M10,5h1v1h-1M10,6h1v1h-1M10,7h1v1h-1M10,8h1v1h-1M10,9h1v1h-1M10,10h1v1h-1M10,12h1v1h-1M10,14h1v1h-1M10,16h1v1h-1M10,18h1v1h-1M10,20h1v1h-1M10,22h1v1h-1M10,24h1v1h-1M10,26h1v1h-1M10,27h1v1h-1M10,28h1v1h-1M10,29h1v1h-1M10,30h1v1h-1M10,31h1v1h-1M10,32h1v1h-1M11,12h1v.5h-1M11,13h1v.5h-1M11,15h1v.5h-1M11,16h1v.5h-1M11,17h1v.5h-1M11,18h1v.5h-1M11,19h1v.5h-1M12,6h1v1h-1M12,7h1v1h-1M12,8h1v1h-1M12,10h1v1h-1M12,12h1v1h-1M12,20h1v1h-1M12,22h1v1h-1M12,23h1v1h-1M12,24h1v1h-1M12,25h1v1h-1M12,26h1v1h-1M12,27h1v1h-1M12,30h1v1h-1M12,31h1v1h-1M12,32h1v1h-1M13,9h1v.5h-1M13,11h1v.5h-1M13,12h1v.5h-1M13,13h1v.5h-1M13,14h1v.5h-1M13,15h1v.5h-1M13,16h1v.5h-1M13,18h1v.5h-1M13,20h1v.5h-1M13,25h1v.5h-1M13,26h1v.5h-1M13,27h1v.5h-1M13,28h1v.5h-1M13,29h1v.5h-1M13,30h1v.5h-1M13,32h1v.5h-1M14,4h1v1h-1M14,6h1v1h-1M14,7h1v1h-1M14,9h1v1h-1M14,10h1v1h-1M14,12h1v1h-1M14,13h1v1h-1M14,14h1v1h-1M14,15h1v1h-1M14,16h1v1h-1M14,17h1v1h-1M14,18h1v1h-1M14,19h1v1h-1M14,20h1v1h-1M14,22h1v1h-1M14,24h1v1h-1M14,25h1v1h-1M14,26h1v1h-1M14,27h1v1h-1M15,4h1v.5h-1M15,6h1v.5h-1M15,8h1v.5h-1M15,9h1v.5h-1M15,11h1v.5h-1M15,12h1v.5h-1M15,13h1v.5h-1M15,15h1v.5h-1M15,16h1v.5h-1M15,18h1v.5h-1M15,20h1v.5h-1M15,21h1v.5h-1M15,22h1v.5h-1M15,25h1v.5h-1M15,26h1v.5h-1M15,27h1v.5h-1M15,29h1v.5h-1M15,31h1v.5h-1M16,5h1v1h-1M16,7h1v1h-1M16,9h1v1h-1M16,10h1v1h-1M16,11h1v1h-1M16,12h1v1h-1M16,14h1v1h-1M16,17h1v1h-1M16,24h1v1h-1M16,25h1v1h-1M16,27h1v1h-1M16,30h1v1h-1M16,31h1v1h-1M16,32h1v1h-1M17,5h1v.5h-1M17,6h1v.5h-1M17,8h1v.5h-1M17,9h1v.5h-1M17,12h1v.5h-1M17,16h1v.5h-1M17,18h1v.5h-1M17,20h1v.5h-1M17,23h1v.5h-1M17,24h1v.5h-1M17,25h1v.5h-1M17,26h1v.5h-1M17,28h1v.5h-1M17,29h1v.5h-1M17,31h1v.5h-1M17,32h1v.5h-1M18,4h1v1h-1M18,5h1v1h-1M18,7h1v1h-1M18,9h1v1h-1M18,10h1v1h-1M18,12h1v1h-1M18,13h1v1h-1M18,14h1v1h-1M18,16h1v1h-1M18,19h1v1h-1M18,20h1v1h-1M18,22h1v1h-1M18,24h1v1h-1M18,26h1v1h-1M18,27h1v1h-1M19,4h1v.5h-1M19,6h1v.5h-1M19,7h1v.5h-1M19,8h1v.5h-1M19,12h1v.5h-1M19,13h1v.5h-1M19,16h1v.5h-1M19,21h1v.5h-1M19,22h1v.5h-1M19,24h1v.5h-1M19,28h1v.5h-1M19,29h1v.5h-1M19,31h1v.5h-1M20,5h1v1h-1M20,6h1v1h-1M20,8h1v1h-1M20,9h1v1h-1M20,10h1v1h-1M20,13h1v1h-1M20,14h1v1h-1M20,16h1v1h-1M20,19h1v1h-1M20,20h1v1h-1M20,25h1v1h-1M20,29h1v1h-1M20,30h1v1h-1M20,31h1v1h-1M21,4h1v.5h-1M21,6h1v.5h-1M21,7h1v.5h-1M21,8h1v.5h-1M21,12h1v.5h-1M21,14h1v.5h-1M21,16h1v.5h-1M21,17h1v.5h-1M21,19h1v.5h-1M21,20h1v.5h-1M21,24h1v.5h-1M21,25h1v.5h-1M21,26h1v.5h-1M21,27h1v.5h-1M21,28h1v.5h-1M21,29h1v.5h-1M21,31h1v.5h-1M21,32h1v.5h-1M22,4h1v1h-1M22,7h1v1h-1M22,8h1v1h-1M22,10h1v1h-1M22,13h1v1h-1M22,15h1v1h-1M22,17h1v1h-1M22,19h1v1h-1M22,20h1v1h-1M22,21h1v1h-1M22,23h1v1h-1M22,26h1v1h-1M22,27h1v1h-1M22,29h1v1h-1M23,4h1v.5h-1M23,6h1v.5h-1M23,9h1v.5h-1M23,11h1v.5h-1M23,13h1v.5h-1M23,14h1v.5h-1M23,15h1v.5h-1M23,16h1v.5h-1M23,19h1v.5h-1M23,20h1v.5h-1M23,21h1v.5h-1M23,23h1v.5h-1M23,24h1v.5h-1M23,26h1v.5h-1M23,28h1v.5h-1M23,31h1v.5h-1M24,4h1v1h-1M24,6h1v1h-1M24,7h1v1h-1M24,9h1v1h-1M24,10h1v1h-1M24,12h1v1h-1M24,14h1v1h-1M24,15h1v1h-1M24,16h1v1h-1M24,17h1v1h-1M24,18h1v1h-1M24,19h1v1h-1M24,20h1v1h-1M24,22h1v1h-1M24,23h1v1h-1M24,24h1v1h-1M24,25h1v1h-1M24,26h1v1h-1M24,27h1v1h-1M24,28h1v1h-1M24,30h1v1h-1M25,12h1v.5h-1M25,16h1v.5h-1M25,18h1v.5h-1M25,20h1v.5h-1M25,21h1v.5h-1M25,22h1v.5h-1M25,24h1v.5h-1M25,28h1v.5h-1M25,29h1v.5h-1M25,32h1v.5h-1M26,4h1v1h-1M26,5h1v1h-1M26,6h1v1h-1M26,7h1v1h-1M26,8h1v1h-1M26,9h1v1h-1M26,10h1v1h-1M26,14h1v1h-1M26,16h1v1h-1M26,17h1v1h-1M26,18h1v1h-1M26,19h1v1h-1M26,21h1v1h-1M26,22h1v1h-1M26,23h1v1h-1M26,24h1v1h-1M26,26h1v1h-1M26,28h1v1h-1M27,4h1v.5h-1M27,10h1v.5h-1M27,13h1v.5h-1M27,14h1v.5h-1M27,15h1v.5h-1M27,16h1v.5h-1M27,17h1v.5h-1M27,19h1v.5h-1M27,20h1v.5h-1M27,22h1v.5h-1M27,23h1v.5h-1M27,24h1v.5h-1M27,28h1v.5h-1M27,29h1v.5h-1M28,4h1v1h-1M28,6h1v1h-1M28,7h1v1h-1M28,8h1v1h-1M28,10h1v1h-1M28,12h1v1h-1M28,13h1v1h-1M28,16h1v1h-1M28,20h1v1h-1M28,21h1v1h-1M28,22h1v1h-1M28,24h1v1h-1M28,25h1v1h-1M28,26h1v1h-1M28,27h1v1h-1M28,28h1v1h-1M28,29h1v1h-1M28,30h1v1h-1M28,32h1v1h-1M29,4h1v.5h-1M29,6h1v.5h-1M29,7h1v.5h-1M29,8h1v.5h-1M29,10h1v.5h-1M29,12h1v.5h-1M29,13h1v.5h-1M29,15h1v.5h-1M29,16h1v.5h-1M29,17h1v.5h-1M29,18h1v.5h-1M29,22h1v.5h-1M29,23h1v.5h-1M29,24h1v.5h-1M29,25h1v.5h-1M29,27h1v.5h-1M29,29h1v.5h-1M29,30h1v.5h-1M30,4h1v1h-1M30,6h1v1h-1M30,7h1v1h-1M30,8h1v1h-1M30,10h1v1h-1M30,12h1v1h-1M30,13h1v1h-1M30,14h1v1h-1M30,16h1v1h-1M30,18h1v1h-1M30,20h1v1h-1M30,21h1v1h-1M30,22h1v1h-1M30,23h1v1h-1M30,24h1v1h-1M30,25h1v1h-1M30,26h1v1h-1M30,27h1v1h-1M30,28h1v1h-1M30,30h1v1h-1M30,31h1v1h-1M31,4h1v.5h-1M31,10h1v.5h-1M31,13h1v.5h-1M31,18h1v.5h-1M31,19h1v.5h-1M31,20h1v.5h-1M31,21h1v.5h-1M31,26h1v.5h-1M31,28h1v.5h-1M31,29h1v.5h-1M31,31h1v.5h-1M32,4h1v1h-1M32,5h1v1h-1M32,6h1v1h-1M32,7h1v1h-1M32,8h1v1h-1M32,9h1v1h-1M32,10h1v1h-1M32,14h1v1h-1M32,15h1v1h-1M32,16h1v1h-1M32,17h1v1h-1M32,18h1v1h-1M32,19h1v1h-1M32,22h1v1h-1M32,26h1v1h-1M32,28h1v1h-1M32,30h1v1h-1"
-    ///         fill="#000000" />
-    /// </svg>
-    Command(ModuleFunction),
-}
-
-impl From<Shape> for usize {
-    fn from(shape: Shape) -> Self {
-        match shape {
-            Shape::Square => 0,
-            Shape::Circle => 1,
-            Shape::RoundedSquare => 2,
-            Shape::Vertical => 3,
-            Shape::Horizontal => 4,
-            Shape::Diamond => 5,
-            #[cfg(not(feature = "wasm-bindgen"))]
-            Shape::Command(_) => 6,
-        }
-    }
-}
-
-impl From<String> for Shape {
-    #[allow(clippy::match_same_arms)]
-    fn from(shape: String) -> Self {
-        match shape.to_lowercase().as_str() {
-            "square" => Shape::Square,
-            "circle" => Shape::Circle,
-            "rounded_square" => Shape::RoundedSquare,
-            "vertical" => Shape::Vertical,
-            "horizontal" => Shape::Horizontal,
-            "diamond" => Shape::Diamond,
-
-            _ => Shape::Square,
-        }
-    }
-}
-
-impl From<Shape> for &str {
-    fn from(shape: Shape) -> Self {
-        match shape {
-            Shape::Square => "square",
-            Shape::Circle => "circle",
-            Shape::RoundedSquare => "rounded_square",
-            Shape::Vertical => "vertical",
-            Shape::Horizontal => "horizontal",
-            Shape::Diamond => "diamond",
-            #[cfg(not(feature = "wasm-bindgen"))]
-            Shape::Command(_) => "command",
-        }
-    }
-}
-
-impl Shape {
-    pub(crate) fn square(y: usize, x: usize, _: Module) -> String {
-        format!("M{x},{y}h1v1h-1")
-    }
-
-    pub(crate) fn circle(y: usize, x: usize, _: Module) -> String {
-        format!("M{},{y}.5a.5,.5 0 1,1 0,-.1", x + 1)
-    }
-
-    pub(crate) fn rounded_square(y: usize, x: usize, _: Module) -> String {
-        format!("M{x}.2,{y}.2 {x}.8,{y}.2 {x}.8,{y}.8 {x}.2,{y}.8z")
-    }
-
-    pub(crate) fn horizontal(y: usize, x: usize, _: Module) -> String {
-        format!("M{x},{y}.1h1v.8h-1")
-    }
-
-    pub(crate) fn vertical(y: usize, x: usize, _: Module) -> String {
-        format!("M{x}.1,{y}h.8v1h-.8")
-    }
-
-    pub(crate) fn diamond(y: usize, x: usize, _: Module) -> String {
-        format!("M{x}.5,{y}l.5,.5l-.5,.5l-.5,-.5z")
-    }
-
-    const FUNCTIONS: [ModuleFunction; 6] = [
-        Shape::square,
-        Shape::circle,
-        Shape::rounded_square,
-        Shape::vertical,
-        Shape::horizontal,
-        Shape::diamond,
-    ];
-}
-
-impl Deref for Shape {
-    type Target = ModuleFunction;
-
-    fn deref(&self) -> &Self::Target {
-        let index: usize = (*self).into();
-        match self {
-            #[cfg(not(feature = "wasm-bindgen"))]
-            Self::Command(func) => func,
-            _ => &Self::FUNCTIONS[index],
-        }
-    }
-}
-
 /// Different possible image background shapes
 #[cfg_attr(feature = "wasm-bindgen", repr(C), wasm_bindgen)]
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Ord, PartialOrd)]
@@ -321,9 +154,9 @@ pub trait Builder {
     /// Updates background color (default: #FFFFFF)
     fn background_color<C: Into<Color>>(&mut self, background_color: C) -> &mut Self;
     /// Adds a shape to the shapes list
-    fn shape(&mut self, shape: Shape) -> &mut Self;
+    fn module_shape(&mut self, shape: ModuleShape) -> &mut Self;
     /// Add a shape to the shapes list with a specific color
-    fn shape_color<C: Into<Color>>(&mut self, shape: Shape, color: C) -> &mut Self;
+    fn module_shape_color<C: Into<Color>>(&mut self, shape: ModuleShape, color: C) -> &mut Self;
 
     // Manages the image part