Merge pull request #78 from sorairolake/feature/eps

feat: Add EPS support

Author: kennytm

.github/workflows/rust.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        rustc: [1.67.1, stable] # MSVR and current stable rustc
+        rustc: [1.70.0, stable] # MSVR and current stable rustc
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1

Cargo.toml

@@ -4,7 +4,7 @@ description = "QR code encoder in Rust"
 license = "MIT OR Apache-2.0"
 version = "0.14.1"
 edition = "2021"
-rust-version = "1.67.1"
+rust-version = "1.70.0"
 authors = ["kennytm <kennytm@gmail.com>"]
 keywords = ["qrcode"]
 categories = ["encoding", "multimedia::images"]
@@ -25,12 +25,13 @@ image = { version = "0.25", default-features = false, optional = true }
 image = "0.25"
 
 [features]
-default = ["std", "image", "svg", "pic"]
+default = ["std", "image", "svg", "pic", "eps"]
 image = ["dep:image", "std"]
 std = []
 bench = []
 svg = []
 pic = []
+eps = []
 
 [[bin]]
 name = "qrencode"
@@ -49,3 +50,7 @@ required-features = ["svg"]
 [[example]]
 name = "encode_pic"
 required-features = ["pic"]
+
+[[example]]
+name = "encode_eps"
+required-features = ["eps"]

README.md

@@ -59,7 +59,7 @@ fn main() {
         .quiet_zone(false)
         .module_dimensions(2, 1)
         .build();
-    println!("{}", string);
+    println!("{string}");
 }
 ```
 
@@ -102,7 +102,7 @@ fn main() {
         .dark_color(svg::Color("#800000"))
         .light_color(svg::Color("#ffff80"))
         .build();
-    println!("{}", image);
+    println!("{image}");
 }
 ```
 
@@ -122,7 +122,7 @@ fn main() {
         .dark_color(unicode::Dense1x2::Light)
         .light_color(unicode::Dense1x2::Dark)
         .build();
-    println!("{}", image);
+    println!("{image}");
 }
 ```
 
@@ -158,7 +158,7 @@ fn main() {
         .render::<pic::Color>()
         .min_dimensions(1, 1)
         .build();
-    println!("{}", image);
+    println!("{image}");
 }
 ```
 
@@ -178,3 +178,44 @@ p(9,4,1,1)
 …
 ```
 See [`test_annex_i_micro_qr_as_pic.pic`](src/test_annex_i_micro_qr_as_pic.pic) for a full example.
+
+## EPS generation
+
+```rust
+use qrcode::render::eps;
+use qrcode::{EcLevel, QrCode, Version};
+
+fn main() {
+    let code = QrCode::with_version(b"01234567", Version::Micro(2), EcLevel::L).unwrap();
+    let image = code
+        .render()
+        .min_dimensions(200, 200)
+        .dark_color(eps::Color([0.5, 0.0, 0.0]))
+        .light_color(eps::Color([1.0, 1.0, 0.5]))
+        .build();
+    println!("{image}");
+}
+```
+
+Generates [EPS](https://en.wikipedia.org/wiki/Encapsulated_PostScript)
+output that renders as follows:
+
+```postscript
+%!PS-Adobe-3.0 EPSF-3.0
+%%BoundingBox: 0 0 204 204
+%%Pages: 1
+%%EndComments
+gsave
+1 1 0.5 setrgbcolor
+0 0 204 204 rectfill
+grestore
+0.5 0 0 setrgbcolor
+24 180 12 12 rectfill
+36 180 12 12 rectfill
+48 180 12 12 rectfill
+60 180 12 12 rectfill
+72 180 12 12 rectfill
+84 180 12 12 rectfill
+…
+```
+See [`test_annex_i_micro_qr_as_eps.eps`](src/test_annex_i_micro_qr_as_eps.eps) for a full example.

examples/encode_eps.rs

@@ -0,0 +1,13 @@
+use qrcode::render::eps;
+use qrcode::{EcLevel, QrCode, Version};
+
+fn main() {
+    let code = QrCode::with_version(b"01234567", Version::Micro(2), EcLevel::L).unwrap();
+    let image = code
+        .render()
+        .min_dimensions(200, 200)
+        .dark_color(eps::Color([0.5, 0.0, 0.0]))
+        .light_color(eps::Color([1.0, 1.0, 0.5]))
+        .build();
+    println!("{image}");
+}

src/lib.rs

@@ -21,7 +21,7 @@
 //!
 //! // You can also render it into a string.
 //! let string = code.render().light_color(' ').dark_color('#').build();
-//! println!("{}", string);
+//! println!("{string}");
 //! # }
 //! ```
 
@@ -414,3 +414,30 @@ mod pic_tests {
         assert_eq!(&image, expected);
     }
 }
+
+#[cfg(all(test, feature = "eps"))]
+mod eps_tests {
+    use crate::render::eps::Color as EpsColor;
+    use crate::{EcLevel, QrCode, Version};
+
+    #[test]
+    fn test_annex_i_qr_as_eps() {
+        let code = QrCode::new(b"01234567").unwrap();
+        let image = code.render::<EpsColor>().build();
+        let expected = include_str!("test_annex_i_qr_as_eps.eps");
+        assert_eq!(&image, expected);
+    }
+
+    #[test]
+    fn test_annex_i_micro_qr_as_eps() {
+        let code = QrCode::with_version(b"01234567", Version::Micro(2), EcLevel::L).unwrap();
+        let image = code
+            .render()
+            .min_dimensions(200, 200)
+            .dark_color(EpsColor([0.5, 0.0, 0.0]))
+            .light_color(EpsColor([1.0, 1.0, 0.5]))
+            .build();
+        let expected = include_str!("test_annex_i_micro_qr_as_eps.eps");
+        assert_eq!(&image, expected);
+    }
+}

src/optimize.rs

@@ -354,10 +354,8 @@ mod optimize_tests {
         }
         assert!(
             opt_segs == expected,
-            "Optimization gave something better: {} < {} ({:?})",
-            new_len,
-            total_encoded_len(expected, version),
-            opt_segs
+            "Optimization gave something better: {new_len} < {} ({opt_segs:?})",
+            total_encoded_len(expected, version)
         );
     }
 

src/render/eps.rs

@@ -0,0 +1,87 @@
+//! EPS rendering support.
+//!
+//! # Example
+//!
+//! ```
+//! use qrcode::QrCode;
+//! use qrcode::render::eps;
+//!
+//! let code = QrCode::new(b"Hello").unwrap();
+//! let eps = code.render::<eps::Color>().build();
+//! println!("{eps}");
+
+#![cfg(feature = "eps")]
+
+use alloc::format;
+use alloc::string::String;
+use core::fmt::Write;
+
+use crate::render::{Canvas as RenderCanvas, Pixel};
+use crate::types::Color as ModuleColor;
+
+/// An EPS color (`[R, G, B]`).
+///
+/// Each value must be in the range of 0.0 to 1.0.
+#[derive(Copy, Clone, Default, PartialEq, PartialOrd)]
+pub struct Color(pub [f64; 3]);
+
+impl Pixel for Color {
+    type Canvas = Canvas;
+    type Image = String;
+
+    fn default_color(color: ModuleColor) -> Self {
+        Color(color.select(Default::default(), [1.0; 3]))
+    }
+}
+
+#[doc(hidden)]
+pub struct Canvas {
+    eps: String,
+    height: u32,
+}
+
+impl RenderCanvas for Canvas {
+    type Pixel = Color;
+    type Image = String;
+
+    fn new(width: u32, height: u32, dark_pixel: Color, light_pixel: Color) -> Self {
+        Canvas {
+            eps: format!(
+                concat!(
+                    "%!PS-Adobe-3.0 EPSF-3.0\n",
+                    "%%BoundingBox: 0 0 {w} {h}\n",
+                    "%%Pages: 1\n",
+                    "%%EndComments\n",
+                    "gsave\n",
+                    "{bgr} {bgg} {bgb} setrgbcolor\n",
+                    "0 0 {w} {h} rectfill\n",
+                    "grestore\n",
+                    "{fgr} {fgg} {fgb} setrgbcolor\n"
+                ),
+                w = width,
+                h = height,
+                fgr = dark_pixel.0[0],
+                fgg = dark_pixel.0[1],
+                fgb = dark_pixel.0[2],
+                bgr = light_pixel.0[0],
+                bgg = light_pixel.0[1],
+                bgb = light_pixel.0[2],
+            ),
+            height,
+        }
+    }
+
+    fn draw_dark_pixel(&mut self, x: u32, y: u32) {
+        self.draw_dark_rect(x, y, 1, 1);
+    }
+
+    fn draw_dark_rect(&mut self, left: u32, top: u32, width: u32, height: u32) {
+        let bottom = self.height - top;
+        writeln!(self.eps, "{left} {bottom} {width} {height} rectfill").unwrap();
+    }
+
+    fn into_image(mut self) -> String {
+        self.eps.push_str("%%EOF");
+        self.eps
+    }
+}

src/render/mod.rs

@@ -4,6 +4,7 @@ use crate::cast::As;
 use crate::types::Color;
 use core::cmp::max;
 
+pub mod eps;
 pub mod image;
 pub mod pic;
 pub mod string;

src/render/pic.rs

@@ -8,7 +8,7 @@
 //!
 //! let code = QrCode::new(b"Hello").unwrap();
 //! let pic = code.render::<pic::Color>().build();
-//! println!("{}", pic);
+//! println!("{pic}");
 
 #![cfg(feature = "pic")]
 

src/render/svg.rs

@@ -8,7 +8,7 @@
 //!
 //! let code = QrCode::new(b"Hello").unwrap();
 //! let svg_xml = code.render::<svg::Color>().build();
-//! println!("{}", svg_xml);
+//! println!("{svg_xml}");
 
 #![cfg(feature = "svg")]