brother_ql 3.0.1

//! Printer model definitions and USB configuration
//!
//! This module defines all supported Brother QL printer models and their USB/status identifiers.
//!
//! # Supported Printers
//!
//! ## 5xx Series
//! - [`PrinterModel::QL560`]
//! - [`PrinterModel::QL570`]
//! - [`PrinterModel::QL580N`]
//!
//! ## 6xx Series
//! - [`PrinterModel::QL600`]
//! - [`PrinterModel::QL650TD`]
//!
//! ## 7xx Series
//! - [`PrinterModel::QL700`] ✅ (tested and confirmed working)
//! - [`PrinterModel::QL710W`]
//! - [`PrinterModel::QL720NW`]
//!
//! ## 8xx Series
//! - [`PrinterModel::QL800`]
//! - [`PrinterModel::QL810W`]
//! - [`PrinterModel::QL820NWB`] ✅ (tested and confirmed working)
//!
//! # USB Identification
//!
//! All Brother QL printers use vendor ID `0x04f9` (Brother Industries, Ltd).
//! Each model has a unique product ID for USB enumeration.
//!
//! # Usage
//!
//! With USB connections:
//! ```no_run
//! # use brother_ql::{connection::UsbConnectionInfo, printer::PrinterModel};
//! let info = UsbConnectionInfo::from_model(PrinterModel::QL820NWB);
//! ```
//!
//! Models are also reported in [`StatusInformation`](crate::status::StatusInformation):
//! ```no_run
//! # use brother_ql::connection::PrinterConnection;
//! # fn example(mut conn: impl PrinterConnection) -> Result<(), Box<dyn std::error::Error>> {
//! let status = conn.get_status()?;
//! println!("Printer model: {:?}", status.model);
//! # Ok(())
//! # }
//! ```

use crate::error::StatusParsingError;

macro_rules! printer_models {
    ($($name:ident ($pid:expr, $rcode:expr),)+) => {
        /// Brother QL printer models
        #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
        #[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
        pub enum PrinterModel {
            $(
                #[doc = stringify!($name)]
                $name,
            )+
        }

        impl PrinterModel {
            #[cfg(feature = "usb")]
            pub(crate) const fn product_id(self) -> u16 {
                match self {
                    $(Self::$name => $pid,)+
                }
            }

            #[cfg(feature = "usb")]
            pub(crate) const fn from_product_id(product_id: u16) -> Option<Self> {
                match product_id {
                    $($pid => Some(Self::$name),)+
                    _ => None,
                }
            }
        }

        impl std::fmt::Display for PrinterModel {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                match self {
                    $(Self::$name => {
                        let name = stringify!($name);
                        // Insert a dash between "QL" and the model number
                        if let Some(rest) = name.strip_prefix("QL") {
                            write!(f, "QL-{rest}")
                        } else {
                            write!(f, "{name}")
                        }
                    },)+
                }
            }
        }

        impl TryFrom<u8> for PrinterModel {
            type Error = StatusParsingError;

            fn try_from(value: u8) -> Result<Self, Self::Error> {
                match value {
                    $($rcode => Ok(Self::$name),)+
                    invalid => Err(StatusParsingError {
                        reason: format!("invalid model code {invalid:#x}"),
                    }),
                }
            }
        }
    };
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn display_inserts_dash() {
        assert_eq!(PrinterModel::QL820NWB.to_string(), "QL-820NWB");
        assert_eq!(PrinterModel::QL700.to_string(), "QL-700");
        assert_eq!(PrinterModel::QL560.to_string(), "QL-560");
    }

    #[test]
    fn roundtrip_from_status_byte() {
        assert_eq!(
            PrinterModel::try_from(0x41).unwrap(),
            PrinterModel::QL820NWB
        );
        assert_eq!(PrinterModel::try_from(0x35).unwrap(), PrinterModel::QL700);
        assert!(PrinterModel::try_from(0xFF).is_err());
    }
}

printer_models! {
    // Define all printer constants here. Usage:
    // <enum variant name> (<USB Product ID>, <Raster Model Code>)
    // - <product_id> comes from the printer's USB specification
    // - <Raster Model Code> is specified in the Raster Command Reference
    //   for the status information reply
    QL560   (0x2027, 0x31),
    QL570   (0x2028, 0x32),
    QL580N  (0x2029, 0x33),
    QL600   (0x20C0, 0x47),
    QL650TD (0x201B, 0x51),
    QL700   (0x2042, 0x35),
    QL710W  (0x2043, 0x36),
    QL720NW (0x2044, 0x37),
    QL800   (0x209b, 0x38),
    QL810W  (0x209c, 0x39),
    QL820NWB(0x209d, 0x41),
}