BlueGit

timfa posprint

Files

posprint / src / escpos.rs

escpos.rs

escpos.rs 21.0 KiB Download Raw
1use std::path::Path;
2
3use image::GrayImage;
4
5use crate::dsl::{
6 Align, BarcodeMode, BarcodeSymbology, Block, Document, ImageWidth, Inline, QrEcc, QrMode,
7};
8use crate::io::PosMetadata;
9use crate::raster::{self, RasterError};
10use crate::text_wrap::{self, TextWrapStyle};
11
12#[derive(Debug)]
13pub enum EscPosError {
14 Image(String),
15 Barcode(String),
16 Raster(RasterError),
17 Io(String),
18}
19
20pub struct EscPosEncoder {
21 buffer: Vec<u8>,
22 metadata: PosMetadata,
23 base_dir: Option<std::path::PathBuf>,
24}
25
26impl EscPosEncoder {
27 pub fn new(metadata: PosMetadata) -> Self {
28 Self {
29 buffer: Vec::new(),
30 metadata,
31 base_dir: None,
32 }
33 }
34
35 pub fn with_base_dir(mut self, base_dir: impl AsRef<Path>) -> Self {
36 self.base_dir = Some(base_dir.as_ref().to_path_buf());
37 self
38 }
39
40 pub fn encode_document(&mut self, document: &Document) -> Result<&[u8], EscPosError> {
41 self.buffer.clear();
42 self.init();
43 for block in &document.blocks {
44 self.encode_block(block)?;
45 }
46 Ok(&self.buffer)
47 }
48
49 pub fn into_bytes(self) -> Vec<u8> {
50 self.buffer
51 }
52
53 fn init(&mut self) {
54 self.buffer.extend_from_slice(&[0x1B, b'@']);
55 self.buffer.extend_from_slice(&[0x1B, b't', 0]);
56 }
57
58 fn encode_block(&mut self, block: &Block) -> Result<(), EscPosError> {
59 match block {
60 Block::Paragraph { align, inlines } => {
61 self.set_align(*align);
62 let cols = text_wrap::wrap_cols(&self.metadata, TextWrapStyle::Normal);
63 let line = inlines_to_plain(inlines);
64 for part in text_wrap::wrap_text(&line, cols) {
65 self.writeln(&part);
66 }
67 }
68 Block::List { align, items } => {
69 self.set_align(*align);
70 let cols = text_wrap::wrap_cols(&self.metadata, TextWrapStyle::Normal);
71 for item in items {
72 let line = inlines_to_plain(&item.inlines);
73 for part in text_wrap::wrap_bullet_item_at_depth(&line, cols, item.depth) {
74 self.writeln(&part);
75 }
76 }
77 }
78 Block::Heading { level, align, inlines } => {
79 self.set_align(*align);
80 let wrap_style = if *level == 1 {
81 TextWrapStyle::Heading1
82 } else {
83 TextWrapStyle::Heading2
84 };
85 let cols = text_wrap::wrap_cols(&self.metadata, wrap_style);
86 let wrapped = text_wrap::wrap_text(&inlines_to_plain(inlines), cols);
87 if *level == 1 {
88 self.buffer.extend_from_slice(&[0x1D, b'!', 0x11]);
89 } else {
90 self.buffer.extend_from_slice(&[0x1B, b'E', 1]);
91 }
92 for part in &wrapped {
93 self.writeln(part);
94 }
95 if *level == 1 {
96 self.buffer.extend_from_slice(&[0x1D, b'!', 0x00]);
97 } else {
98 self.buffer.extend_from_slice(&[0x1B, b'E', 0]);
99 }
100 }
101 Block::Rule => {
102 let width = self.metadata.chars_per_line() as usize;
103 self.writeln(&"-".repeat(width));
104 }
105 Block::Feed(n) => self.feed(*n),
106 Block::Cut => self.cut(),
107 Block::Image { path, width, align } => {
108 self.set_align(*align);
109 self.encode_image(path, *width)?;
110 }
111 Block::Barcode {
112 mode,
113 symbology,
114 data,
115 height,
116 align,
117 show_text,
118 } => {
119 self.set_align(*align);
120 match mode {
121 BarcodeMode::Native => {
122 self.encode_barcode_native(*symbology, data, *height, *show_text)?;
123 }
124 BarcodeMode::Raster => {
125 let img = raster::render_barcode(*symbology, data, *height as u32)
126 .map_err(EscPosError::Raster)?;
127 let target = self.metadata.printable_dots() as u32;
128 let img = raster::scale_gray_to_print_width(img, target);
129 self.encode_gray_raster(&img, ImageWidth::Default)?;
130 }
131 }
132 }
133 Block::Qr {
134 mode,
135 data,
136 size,
137 ecc,
138 version,
139 align,
140 } => {
141 self.set_align(*align);
142 match mode {
143 QrMode::Native => self.encode_qr_native(data, *size, *ecc)?,
144 QrMode::Raster => {
145 let img = raster::render_qr(data, *version, *ecc, *size as u32)
146 .map_err(EscPosError::Raster)?;
147 self.encode_gray_raster(&img, ImageWidth::Default)?;
148 }
149 }
150 }
151 Block::Date { format, align } => {
152 self.set_align(*align);
153 let text = crate::datetime::format_date(format.as_deref());
154 let cols = text_wrap::wrap_cols(&self.metadata, TextWrapStyle::Normal);
155 for part in text_wrap::wrap_text(&text, cols) {
156 self.writeln(&part);
157 }
158 }
159 Block::Time { format, align } => {
160 self.set_align(*align);
161 let text = crate::datetime::format_time(*format);
162 let cols = text_wrap::wrap_cols(&self.metadata, TextWrapStyle::Normal);
163 for part in text_wrap::wrap_text(&text, cols) {
164 self.writeln(&part);
165 }
166 }
167 }
168 Ok(())
169 }
170
171 fn set_align(&mut self, align: Align) {
172 let n = match align {
173 Align::Left => 0,
174 Align::Center => 1,
175 Align::Right => 2,
176 };
177 self.buffer.extend_from_slice(&[0x1B, b'a', n]);
178 }
179
180 fn writeln(&mut self, text: &str) {
181 // ESC/POS text path is CP437; keep output to ASCII bytes.
182 for ch in text.chars() {
183 if ch.is_ascii() {
184 self.buffer.push(ch as u8);
185 } else {
186 self.buffer.push(b'?');
187 }
188 }
189 self.buffer.push(b'\n');
190 }
191
192 fn feed(&mut self, lines: u8) {
193 if lines == 0 {
194 return;
195 }
196 // ESC d — reliable paper feed after raster graphics (print-bridge uses this too).
197 self.buffer.extend_from_slice(&[0x1B, b'd', lines]);
198 }
199
200 fn cut(&mut self) {
201 self.buffer.extend_from_slice(&[0x1D, b'V', 66, 0]);
202 }
203
204 fn encode_barcode_native(
205 &mut self,
206 symbology: BarcodeSymbology,
207 data: &str,
208 height: u8,
209 show_text: bool,
210 ) -> Result<(), EscPosError> {
211 self.buffer.extend_from_slice(&[0x1D, b'h', height]);
212 self.buffer.extend_from_slice(&[0x1D, b'H', if show_text { 2 } else { 0 }]);
213 // Widest module width (GS w 6) for easier scanning.
214 self.buffer.extend_from_slice(&[0x1D, b'w', 6]);
215 match symbology {
216 BarcodeSymbology::Code128 => {
217 let bytes = data.as_bytes();
218 self.buffer.extend_from_slice(&[0x1D, b'k', 73, bytes.len() as u8]);
219 self.buffer.extend_from_slice(bytes);
220 }
221 BarcodeSymbology::UpcA => {
222 if data.len() != 11 && data.len() != 12 {
223 return Err(EscPosError::Barcode("UPC-A requires 11-12 digits".into()));
224 }
225 self.buffer.extend_from_slice(&[0x1D, b'k', 65, data.len() as u8]);
226 self.buffer.extend_from_slice(data.as_bytes());
227 }
228 BarcodeSymbology::UpcE => {
229 if data.len() != 6 && data.len() != 7 && data.len() != 8 {
230 return Err(EscPosError::Barcode("UPC-E requires 6-8 digits".into()));
231 }
232 self.buffer.extend_from_slice(&[0x1D, b'k', 66, data.len() as u8]);
233 self.buffer.extend_from_slice(data.as_bytes());
234 }
235 BarcodeSymbology::Ean13 => {
236 if data.len() != 12 && data.len() != 13 {
237 return Err(EscPosError::Barcode("EAN13 requires 12-13 digits".into()));
238 }
239 self.buffer.extend_from_slice(&[0x1D, b'k', 67, data.len() as u8]);
240 self.buffer.extend_from_slice(data.as_bytes());
241 }
242 BarcodeSymbology::Ean8 => {
243 if data.len() != 7 && data.len() != 8 {
244 return Err(EscPosError::Barcode("EAN8 requires 7-8 digits".into()));
245 }
246 self.buffer.extend_from_slice(&[0x1D, b'k', 68, data.len() as u8]);
247 self.buffer.extend_from_slice(data.as_bytes());
248 }
249 BarcodeSymbology::Code39 => {
250 self.buffer.extend_from_slice(&[0x1D, b'k', 69, data.len() as u8]);
251 self.buffer.extend_from_slice(data.as_bytes());
252 }
253 BarcodeSymbology::Itf => {
254 if data.len() % 2 != 0 {
255 return Err(EscPosError::Barcode("ITF requires even digit count".into()));
256 }
257 self.buffer.extend_from_slice(&[0x1D, b'k', 70, data.len() as u8]);
258 self.buffer.extend_from_slice(data.as_bytes());
259 }
260 BarcodeSymbology::Codabar => {
261 self.buffer.extend_from_slice(&[0x1D, b'k', 71, data.len() as u8]);
262 self.buffer.extend_from_slice(data.as_bytes());
263 }
264 BarcodeSymbology::Code93 | BarcodeSymbology::Code11 => {
265 return Err(EscPosError::Barcode(format!(
266 "{} requires RASTER mode",
267 symbology.as_str()
268 )));
269 }
270 }
271 self.buffer.push(b'\n');
272 Ok(())
273 }
274
275 fn encode_qr_native(&mut self, data: &str, size: u8, ecc: QrEcc) -> Result<(), EscPosError> {
276 let ecc_level = match ecc {
277 QrEcc::L => 48,
278 QrEcc::M => 49,
279 QrEcc::Q => 50,
280 QrEcc::H => 51,
281 };
282 let store = data.as_bytes();
283 let len = store.len() + 3;
284 let p_l = (len & 0xFF) as u8;
285 let p_h = ((len >> 8) & 0xFF) as u8;
286
287 self.buffer.extend_from_slice(&[0x1D, 0x28, b'k', 4, 0, 49, 65, 50, 0]);
288 self.buffer.extend_from_slice(&[0x1D, 0x28, b'k', 3, 0, 49, 67, size]);
289 self.buffer.extend_from_slice(&[0x1D, 0x28, b'k', 3, 0, 49, 69, ecc_level]);
290 self.buffer.extend_from_slice(&[0x1D, 0x28, b'k', p_l, p_h, 49, 80, 48]);
291 self.buffer.extend_from_slice(store);
292 self.buffer.extend_from_slice(&[0x1D, 0x28, b'k', 3, 0, 49, 81, 48]);
293 self.buffer.push(b'\n');
294 Ok(())
295 }
296
297 fn encode_image(&mut self, path: &str, width: ImageWidth) -> Result<(), EscPosError> {
298 let resolved = resolve_image_path(path, self.base_dir.as_deref());
299 let img = image::open(&resolved).map_err(|e| EscPosError::Image(e.to_string()))?;
300 self.encode_gray_raster(&img.to_luma8(), width)
301 }
302
303 fn encode_gray_raster(&mut self, gray: &GrayImage, width: ImageWidth) -> Result<(), EscPosError> {
304 let (w, h) = gray.dimensions();
305 let target_width = match width {
306 ImageWidth::Percent(pct) => {
307 (self.metadata.printable_dots() as u32 * pct as u32 / 100) as u32
308 }
309 ImageWidth::Dots(d) => d as u32,
310 ImageWidth::Default => self.metadata.printable_dots() as u32,
311 };
312 let new_w = target_width.min(w).max(1);
313 let new_h = ((h as f32) * (new_w as f32 / w as f32)).max(1.0) as u32;
314 let resized = image::imageops::resize(
315 gray,
316 new_w,
317 new_h,
318 image::imageops::FilterType::Nearest,
319 );
320 let bytes_per_row = ((new_w + 7) / 8) as usize;
321 let mut raster = vec![0u8; bytes_per_row * new_h as usize];
322 for y in 0..new_h {
323 for x in 0..new_w {
324 let pixel = resized.get_pixel(x, y).0[0];
325 if pixel < 128 {
326 let byte_index = (y as usize * bytes_per_row) + (x as usize / 8);
327 let bit = 7 - (x % 8);
328 raster[byte_index] |= 1 << bit;
329 }
330 }
331 }
332 let x_l = (bytes_per_row & 0xFF) as u8;
333 let x_h = ((bytes_per_row >> 8) & 0xFF) as u8;
334 let y_l = (new_h & 0xFF) as u8;
335 let y_h = ((new_h >> 8) & 0xFF) as u8;
336 // GS v 0 normal raster — same header as print-bridge / node-escpos:
337 // 1D 76 30 00, xL xH (bytes/row), yL yH (dots), then bitmap bytes.
338 self.buffer
339 .extend_from_slice(&[0x1D, b'v', 0x30, 0x00, x_l, x_h, y_l, y_h]);
340 self.buffer.extend_from_slice(&raster);
341 // LF prints/flushes the raster; without it the next graphic can butt against this one.
342 self.buffer.push(b'\n');
343 Ok(())
344 }
345}
346
347fn resolve_image_path(path: &str, base_dir: Option<&Path>) -> std::path::PathBuf {
348 let p = Path::new(path);
349 if p.is_absolute() {
350 p.to_path_buf()
351 } else if let Some(base) = base_dir {
352 base.join(p)
353 } else {
354 p.to_path_buf()
355 }
356}
357
358fn inlines_to_plain(inlines: &[Inline]) -> String {
359 let mut out = String::new();
360 for inline in inlines {
361 match inline {
362 Inline::Text(t) => out.push_str(t),
363 Inline::Param(t) | Inline::CheckboxParam(t) => out.push_str(t),
364 Inline::Checkbox { checked } => out.push_str(crate::dsl::checkbox_glyph(*checked)),
365 }
366 }
367 out
368}
369
370#[cfg(test)]
371mod tests {
372 use super::*;
373 use crate::dsl::{parse, Block};
374
375 #[test]
376 fn heading_wraps_like_preview_on_narrow_paper() {
377 let doc = parse("# Proof of Transfer").unwrap();
378 let mut enc = EscPosEncoder::new(PosMetadata {
379 page_width_mm: 53.0,
380 ..Default::default()
381 });
382 let bytes = enc.encode_document(&doc).unwrap();
383 let text = String::from_utf8_lossy(bytes);
384 assert!(
385 text.contains("Proof of\n"),
386 "expected word wrap before Transfer, got: {text}"
387 );
388 assert!(
389 text.contains("Transfer\n"),
390 "expected wrapped second line, got: {text}"
391 );
392 }
393
394 #[test]
395 fn encodes_bullet_list_with_hanging_indent() {
396 let doc = parse("- this is a long line").unwrap();
397 let meta = PosMetadata {
398 chars_per_line: Some(15),
399 ..Default::default()
400 };
401 let mut enc = EscPosEncoder::new(meta);
402 let bytes = enc.encode_document(&doc).unwrap();
403 let text = String::from_utf8_lossy(bytes);
404 assert!(text.contains("* this is a\n"));
405 assert!(text.contains(" long line\n"));
406 }
407
408 #[test]
409 fn encodes_nested_bullet_list() {
410 let doc = parse("- outer\n - inner").unwrap();
411 let mut enc = EscPosEncoder::new(PosMetadata::default());
412 let bytes = enc.encode_document(&doc).unwrap();
413 let text = String::from_utf8_lossy(bytes);
414 assert!(text.contains("* outer\n"));
415 assert!(text.contains(" - inner\n"));
416 }
417
418 #[test]
419 fn encodes_inline_checkboxes_as_ascii() {
420 let doc = parse("[] hello [x]").unwrap();
421 let mut enc = EscPosEncoder::new(PosMetadata::default());
422 let bytes = enc.encode_document(&doc).unwrap();
423 let text = String::from_utf8_lossy(bytes);
424 assert!(
425 text.contains("[ ] hello [x]\n"),
426 "expected ASCII checkbox glyphs, got: {text:?}"
427 );
428 }
429
430 #[test]
431 fn encodes_init_and_text() {
432 let doc = parse("Hello").unwrap();
433 let mut enc = EscPosEncoder::new(PosMetadata::default());
434 let bytes = enc.encode_document(&doc).unwrap();
435 assert_eq!(&bytes[0..2], &[0x1B, b'@']);
436 assert!(bytes.windows(5).any(|w| w == b"Hello"));
437 }
438
439 #[test]
440 fn encodes_raster_barcode() {
441 let doc = parse("@barcode RASTER CODE128 TEST").unwrap();
442 let mut enc = EscPosEncoder::new(PosMetadata::default());
443 let bytes = enc.encode_document(&doc).unwrap();
444 assert!(
445 bytes.windows(4).any(|w| w == [0x1D, b'v', 0x30, 0x00]),
446 "expected GS v 0 raster header"
447 );
448 }
449
450 #[test]
451 fn raster_header_matches_print_bridge_format() {
452 let doc = parse("@barcode RASTER CODE128 X").unwrap();
453 let meta = PosMetadata {
454 page_width_mm: 58.0,
455 ..Default::default()
456 };
457 let mut enc = EscPosEncoder::new(meta.clone());
458 let bytes = enc.encode_document(&doc).unwrap();
459 let pos = bytes
460 .windows(4)
461 .position(|w| w == [0x1D, b'v', 0x30, 0x00])
462 .expect("raster header");
463 assert_eq!(&bytes[pos..pos + 4], &[0x1D, b'v', 0x30, 0x00]);
464 let x_bytes = u16::from_le_bytes([bytes[pos + 4], bytes[pos + 5]]);
465 let expected_bytes = ((meta.printable_dots() as u32 + 7) / 8) as u16;
466 assert_eq!(
467 x_bytes, expected_bytes,
468 "barcode raster should span full printable width"
469 );
470 let y_dots = u16::from_le_bytes([bytes[pos + 6], bytes[pos + 7]]);
471 assert!(y_dots > 0);
472 }
473
474 #[test]
475 fn encodes_centered_heading() {
476 let doc = parse(":center:\n# Hello").unwrap();
477 let mut enc = EscPosEncoder::new(PosMetadata::default());
478 let bytes = enc.encode_document(&doc).unwrap();
479 assert!(bytes.windows(3).any(|w| w == [0x1B, b'a', 1]));
480 assert!(bytes.windows(5).any(|w| w == b"Hello"));
481 }
482
483 #[test]
484 fn encodes_date_directive() {
485 let doc = parse("@date DD-YYYY-MM").unwrap();
486 let mut enc = EscPosEncoder::new(PosMetadata::default());
487 let bytes = enc.encode_document(&doc).unwrap();
488 let text = String::from_utf8_lossy(bytes);
489 assert!(text.contains('-'));
490 }
491
492 #[test]
493 fn encodes_cut_directive() {
494 let doc = parse("@cut").unwrap();
495 let mut enc = EscPosEncoder::new(PosMetadata::default());
496 let bytes = enc.encode_document(&doc).unwrap();
497 assert!(bytes.windows(3).any(|w| w == [0x1D, b'V', 66]));
498 }
499
500 #[test]
501 fn feed_uses_esc_d_for_blank_lines() {
502 let doc = parse("A\n\nB").unwrap();
503 let mut enc = EscPosEncoder::new(PosMetadata::default());
504 let bytes = enc.encode_document(&doc).unwrap();
505 assert!(bytes.windows(3).any(|w| w == [0x1B, b'd', 1]));
506 }
507
508 #[test]
509 fn blank_line_between_barcode_and_qr_is_ordered_feed() {
510 let doc = parse("@barcode RASTER CODE128 X\n\n:center:@qr RASTER Y scale=4").unwrap();
511 assert!(matches!(
512 doc.blocks.as_slice(),
513 [
514 Block::Barcode { .. },
515 Block::Feed(1),
516 Block::Qr { .. },
517 ]
518 ));
519 }
520
521 #[test]
522 fn blank_line_between_graphics_feeds_on_print() {
523 let doc = parse("@barcode RASTER CODE128 X\n\n@qr RASTER Y scale=4").unwrap();
524 let mut enc = EscPosEncoder::new(PosMetadata {
525 page_width_mm: 53.0,
526 ..Default::default()
527 });
528 let bytes = enc.encode_document(&doc).unwrap();
529 let raster_positions: Vec<_> = bytes
530 .windows(4)
531 .enumerate()
532 .filter(|(_, w)| *w == [0x1D, b'v', 0x30, 0x00])
533 .map(|(i, _)| i)
534 .collect();
535 assert_eq!(raster_positions.len(), 2);
536 let between = &bytes[raster_positions[0]..raster_positions[1]];
537 assert!(
538 between.windows(3).any(|w| w == [0x1B, b'd', 1]),
539 "expected ESC d feed between raster graphics, got {} bytes",
540 between.len()
541 );
542 }
543
544 #[test]
545 fn raster_graphic_ends_with_line_feed() {
546 let doc = parse("@barcode RASTER CODE128 X").unwrap();
547 let mut enc = EscPosEncoder::new(PosMetadata::default());
548 let bytes = enc.encode_document(&doc).unwrap();
549 let raster_start = bytes
550 .windows(4)
551 .position(|w| w == [0x1D, b'v', 0x30, 0x00])
552 .expect("raster header");
553 assert!(
554 bytes[raster_start..].contains(&b'\n'),
555 "expected LF after raster data"
556 );
557 }
558
559 #[test]
560 fn does_not_auto_cut_without_directive() {
561 let doc = parse("x").unwrap();
562 let mut enc = EscPosEncoder::new(PosMetadata::default());
563 let bytes = enc.encode_document(&doc).unwrap();
564 assert!(!bytes.windows(3).any(|w| w == [0x1D, b'V', 66]));
565 }
566}