zsui 0.3.0-alpha.2

use serde::{Deserialize, Serialize};

#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
pub enum ZsIcon {
    App,
    Calculator,
    History,
    Backspace,
    Add,
    Search,
    Settings,
    Sidebar,
    Inspector,
    More,
    Attach,
    Enter,
    Send,
    Stop,
    Refresh,
    Retry,
    Code,
    Tool,
    Check,
    Info,
    Success,
    Warning,
    Error,
    Minimize,
    Close,
    Text,
    Image,
    File,
    Folder,
    Save,
    Undo,
    Cut,
    Pin,
    Delete,
    Copy,
    Paste,
    Edit,
    Group,
    Phrase,
    ChevronUp,
    ChevronDown,
    Calendar,
    ChevronLeft,
    ChevronRight,
    PasswordReveal,
}

/// Semantic standalone-icon size resolved through the active desktop profile.
///
/// The values intentionally do not expose raw pixels or one platform's symbol
/// point size. Win32, AppKit and Linux choose their own logical dimensions.
#[cfg(feature = "icon")]
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ZsIconSize {
    /// Compact standalone glyph.
    Small,
    /// Normal standalone glyph.
    #[default]
    Standard,
    /// Large standalone glyph.
    Large,
}

#[cfg(feature = "icon")]
impl ZsIconSize {
    pub(crate) const fn role(self) -> ZsIconRole {
        match self {
            Self::Small => ZsIconRole::Small,
            Self::Standard => ZsIconRole::Standard,
            Self::Large => ZsIconRole::Large,
        }
    }
}

/// Semantic placement of a glyph, independent of the surrounding hit target.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum ZsIconRole {
    /// Compact standalone glyph.
    Small,
    /// Normal standalone glyph.
    #[default]
    Standard,
    /// Large standalone glyph.
    Large,
    /// Glyph inside a navigation row.
    Navigation,
    /// Primary toolbar action glyph.
    Toolbar,
    /// Inline status indicator.
    Status,
    /// Expander or drop-down indicator.
    Disclosure,
    /// Compact tree disclosure indicator.
    TreeDisclosure,
}

impl ZsIconRole {
    pub(crate) const fn logical_size(self, platform: crate::ZsPlatformStyle) -> crate::Dp {
        crate::platform_component_profile::icon_role_size(platform, self)
    }
}

impl ZsIcon {
    pub const ALL: [Self; 45] = [
        Self::App,
        Self::Calculator,
        Self::History,
        Self::Backspace,
        Self::Add,
        Self::Search,
        Self::Settings,
        Self::Sidebar,
        Self::Inspector,
        Self::More,
        Self::Attach,
        Self::Enter,
        Self::Send,
        Self::Stop,
        Self::Refresh,
        Self::Retry,
        Self::Code,
        Self::Tool,
        Self::Check,
        Self::Info,
        Self::Success,
        Self::Warning,
        Self::Error,
        Self::Minimize,
        Self::Close,
        Self::Text,
        Self::Image,
        Self::File,
        Self::Folder,
        Self::Save,
        Self::Undo,
        Self::Cut,
        Self::Pin,
        Self::Delete,
        Self::Copy,
        Self::Paste,
        Self::Edit,
        Self::Group,
        Self::Phrase,
        Self::ChevronUp,
        Self::ChevronDown,
        Self::Calendar,
        Self::ChevronLeft,
        Self::ChevronRight,
        Self::PasswordReveal,
    ];

    pub const fn asset_name(self) -> &'static str {
        match self {
            Self::App => "app",
            Self::Calculator => "calculator",
            Self::History => "history",
            Self::Backspace => "backspace",
            Self::Add => "add",
            Self::Search => "search",
            Self::Settings => "setting",
            Self::Sidebar => "sidebar",
            Self::Inspector => "inspector",
            Self::More => "more",
            Self::Attach => "attach",
            Self::Enter => "enter",
            Self::Send => "send",
            Self::Stop => "stop",
            Self::Refresh => "refresh",
            Self::Retry => "retry",
            Self::Code => "code",
            Self::Tool => "tool",
            Self::Check => "check",
            Self::Info => "info",
            Self::Success => "success",
            Self::Warning => "warning",
            Self::Error => "error",
            Self::Minimize => "min",
            Self::Close => "exit",
            Self::Text | Self::Phrase => "text",
            Self::Image => "image",
            Self::File => "file",
            Self::Folder | Self::Group => "fold",
            Self::Save => "save",
            Self::Undo => "undo",
            Self::Cut => "cut",
            Self::Pin => "top",
            Self::Delete => "del",
            Self::Copy => "copy",
            Self::Paste => "paste",
            Self::Edit => "edit",
            Self::ChevronUp => "chevron-up",
            Self::ChevronDown => "chevron-down",
            Self::Calendar => "calendar",
            Self::ChevronLeft => "chevron-left",
            Self::ChevronRight => "chevron-right",
            Self::PasswordReveal => "password-reveal",
        }
    }

    pub const fn gtk_symbolic_name(self) -> &'static str {
        match self {
            Self::App => "edit-paste-symbolic",
            Self::Calculator => "accessories-calculator-symbolic",
            Self::History => "document-open-recent-symbolic",
            Self::Backspace => "edit-clear-symbolic",
            Self::Add => "list-add-symbolic",
            Self::Search => "edit-find-symbolic",
            Self::Settings => "emblem-system-symbolic",
            Self::Sidebar => "sidebar-show-symbolic",
            Self::Inspector => "document-properties-symbolic",
            Self::More => "view-more-symbolic",
            Self::Attach => "mail-attachment-symbolic",
            Self::Enter => "go-jump-symbolic",
            Self::Send => "mail-send-symbolic",
            Self::Stop => "media-playback-stop-symbolic",
            Self::Refresh => "view-refresh-symbolic",
            Self::Retry => "view-refresh-symbolic",
            Self::Code => "utilities-terminal-symbolic",
            Self::Tool => "applications-engineering-symbolic",
            Self::Check => "emblem-ok-symbolic",
            Self::Info => "dialog-information-symbolic",
            Self::Success => "emblem-ok-symbolic",
            Self::Warning => "dialog-warning-symbolic",
            Self::Error => "dialog-error-symbolic",
            Self::Minimize => "window-minimize-symbolic",
            Self::Close => "window-close-symbolic",
            Self::Text | Self::Phrase => "text-x-generic-symbolic",
            Self::Image => "image-x-generic-symbolic",
            Self::File => "text-x-generic-symbolic",
            Self::Folder | Self::Group => "folder-symbolic",
            Self::Save => "document-save-symbolic",
            Self::Undo => "edit-undo-symbolic",
            Self::Cut => "edit-cut-symbolic",
            Self::Pin => "view-pin-symbolic",
            Self::Delete => "user-trash-symbolic",
            Self::Copy => "edit-copy-symbolic",
            Self::Paste => "edit-paste-symbolic",
            Self::Edit => "document-edit-symbolic",
            Self::ChevronUp => "pan-up-symbolic",
            Self::ChevronDown => "pan-down-symbolic",
            Self::Calendar => "x-office-calendar-symbolic",
            Self::ChevronLeft => "pan-start-symbolic",
            Self::ChevronRight => "pan-end-symbolic",
            Self::PasswordReveal => "view-reveal-symbolic",
        }
    }

    pub const fn windows_fluent_glyph(self) -> &'static str {
        match self {
            Self::App => "\u{E71D}",
            Self::Calculator => "\u{E8EF}",
            Self::History => "\u{E81C}",
            Self::Backspace => "\u{E750}",
            Self::Add => "\u{E710}",
            Self::Search => "\u{E721}",
            Self::Settings => "\u{E713}",
            Self::Sidebar => "\u{E700}",
            Self::Inspector => "\u{E90D}",
            Self::More => "\u{E712}",
            Self::Attach => "\u{E723}",
            Self::Enter => "\u{E751}",
            Self::Send => "\u{E724}",
            Self::Stop => "\u{E71A}",
            Self::Refresh => "\u{E72C}",
            Self::Retry => "\u{E72C}",
            Self::Code => "\u{E943}",
            Self::Tool => "\u{E90F}",
            Self::Check => "\u{E73E}",
            Self::Info => "\u{E946}",
            Self::Success => "\u{E930}",
            Self::Warning => "\u{E7BA}",
            Self::Error => "\u{E783}",
            Self::Minimize => "\u{E921}",
            Self::Close => "\u{E8BB}",
            Self::Text | Self::Phrase => "\u{E8D2}",
            Self::Image => "\u{E8B9}",
            Self::File => "\u{E8A5}",
            Self::Folder => "\u{E8B7}",
            Self::Save => "\u{E74E}",
            Self::Undo => "\u{E7A7}",
            Self::Cut => "\u{E8C6}",
            Self::Pin => "\u{E718}",
            Self::Delete => "\u{E74D}",
            Self::Copy => "\u{E8C8}",
            Self::Paste => "\u{E77F}",
            Self::Edit => "\u{E70F}",
            Self::Group => "\u{E902}",
            Self::ChevronUp => "\u{E70E}",
            Self::ChevronDown => "\u{E70D}",
            Self::Calendar => "\u{E787}",
            Self::ChevronLeft => "\u{E76B}",
            Self::ChevronRight => "\u{E76C}",
            Self::PasswordReveal => "\u{E890}",
        }
    }

    pub const fn windows_mdl2_glyph(self) -> &'static str {
        // The semantic subset used by ZSUI is in the MDL2-compatible PUA range.
        self.windows_fluent_glyph()
    }

    pub const fn fluent_svg_asset_name(self) -> &'static str {
        match self {
            Self::App => "app.svg",
            Self::Calculator => "calculator.svg",
            Self::History => "history.svg",
            Self::Backspace => "backspace.svg",
            Self::Add => "add.svg",
            Self::Search => "search.svg",
            Self::Settings => "settings.svg",
            Self::Sidebar => "sidebar.svg",
            Self::Inspector => "inspector.svg",
            Self::More => "more.svg",
            Self::Attach => "attach.svg",
            Self::Enter => "enter.svg",
            Self::Send => "send.svg",
            Self::Stop => "stop.svg",
            Self::Refresh => "refresh.svg",
            Self::Retry => "refresh.svg",
            Self::Code => "code.svg",
            Self::Tool => "tool.svg",
            Self::Check => "check.svg",
            Self::Info => "info.svg",
            Self::Success => "success.svg",
            Self::Warning => "warning.svg",
            Self::Error => "error.svg",
            Self::Minimize => "minimize.svg",
            Self::Close => "close.svg",
            Self::Text => "text.svg",
            Self::Image => "image.svg",
            Self::File => "file.svg",
            Self::Folder => "folder.svg",
            Self::Save => "save.svg",
            Self::Undo => "undo.svg",
            Self::Cut => "cut.svg",
            Self::Pin => "pin.svg",
            Self::Delete => "delete.svg",
            Self::Copy => "copy.svg",
            Self::Paste => "paste.svg",
            Self::Edit => "edit.svg",
            Self::Group => "group.svg",
            Self::Phrase => "text.svg",
            Self::ChevronUp => "chevron-up.svg",
            Self::ChevronDown => "chevron-down.svg",
            Self::Calendar => "calendar.svg",
            Self::ChevronLeft => "chevron-left.svg",
            Self::ChevronRight => "chevron-right.svg",
            Self::PasswordReveal => "password-reveal.svg",
        }
    }

    #[cfg(any(
        feature = "fluent-icons",
        all(target_os = "macos", feature = "macos-appkit"),
        all(
            target_os = "linux",
            any(feature = "linux-direct-host", feature = "linux-gtk")
        )
    ))]
    pub const fn fluent_svg_bytes(self) -> &'static [u8] {
        match self {
            Self::App => include_bytes!("../assets/fluent-system-icons/regular/app.svg"),
            Self::Calculator => {
                include_bytes!("../assets/fluent-system-icons/regular/calculator.svg")
            }
            Self::History => include_bytes!("../assets/fluent-system-icons/regular/history.svg"),
            Self::Backspace => {
                include_bytes!("../assets/fluent-system-icons/regular/backspace.svg")
            }
            Self::Add => include_bytes!("../assets/fluent-system-icons/regular/add.svg"),
            Self::Search => include_bytes!("../assets/fluent-system-icons/regular/search.svg"),
            Self::Settings => {
                include_bytes!("../assets/fluent-system-icons/regular/settings.svg")
            }
            Self::Sidebar => include_bytes!("../assets/fluent-system-icons/regular/sidebar.svg"),
            Self::Inspector => {
                include_bytes!("../assets/fluent-system-icons/regular/inspector.svg")
            }
            Self::More => include_bytes!("../assets/fluent-system-icons/regular/more.svg"),
            Self::Attach => include_bytes!("../assets/fluent-system-icons/regular/attach.svg"),
            Self::Enter => include_bytes!("../assets/fluent-system-icons/regular/enter.svg"),
            Self::Send => include_bytes!("../assets/fluent-system-icons/regular/send.svg"),
            Self::Stop => include_bytes!("../assets/fluent-system-icons/regular/stop.svg"),
            Self::Refresh => include_bytes!("../assets/fluent-system-icons/regular/refresh.svg"),
            Self::Retry => include_bytes!("../assets/fluent-system-icons/regular/refresh.svg"),
            Self::Code => include_bytes!("../assets/fluent-system-icons/regular/code.svg"),
            Self::Tool => include_bytes!("../assets/fluent-system-icons/regular/tool.svg"),
            Self::Check => include_bytes!("../assets/fluent-system-icons/regular/check.svg"),
            Self::Info => include_bytes!("../assets/fluent-system-icons/regular/info.svg"),
            Self::Success => include_bytes!("../assets/fluent-system-icons/regular/success.svg"),
            Self::Warning => include_bytes!("../assets/fluent-system-icons/regular/warning.svg"),
            Self::Error => include_bytes!("../assets/fluent-system-icons/regular/error.svg"),
            Self::Minimize => {
                include_bytes!("../assets/fluent-system-icons/regular/minimize.svg")
            }
            Self::Close => include_bytes!("../assets/fluent-system-icons/regular/close.svg"),
            Self::Text => include_bytes!("../assets/fluent-system-icons/regular/text.svg"),
            Self::Image => include_bytes!("../assets/fluent-system-icons/regular/image.svg"),
            Self::File => include_bytes!("../assets/fluent-system-icons/regular/file.svg"),
            Self::Folder => include_bytes!("../assets/fluent-system-icons/regular/folder.svg"),
            Self::Save => include_bytes!("../assets/fluent-system-icons/regular/save.svg"),
            Self::Undo => include_bytes!("../assets/fluent-system-icons/regular/undo.svg"),
            Self::Cut => include_bytes!("../assets/fluent-system-icons/regular/cut.svg"),
            Self::Pin => include_bytes!("../assets/fluent-system-icons/regular/pin.svg"),
            Self::Delete => include_bytes!("../assets/fluent-system-icons/regular/delete.svg"),
            Self::Copy => include_bytes!("../assets/fluent-system-icons/regular/copy.svg"),
            Self::Paste => include_bytes!("../assets/fluent-system-icons/regular/paste.svg"),
            Self::Edit => include_bytes!("../assets/fluent-system-icons/regular/edit.svg"),
            Self::Group => include_bytes!("../assets/fluent-system-icons/regular/group.svg"),
            Self::Phrase => include_bytes!("../assets/fluent-system-icons/regular/text.svg"),
            Self::ChevronUp => {
                include_bytes!("../assets/fluent-system-icons/regular/chevron-up.svg")
            }
            Self::ChevronDown => {
                include_bytes!("../assets/fluent-system-icons/regular/chevron-down.svg")
            }
            Self::Calendar => include_bytes!("../assets/fluent-system-icons/regular/calendar.svg"),
            Self::ChevronLeft => {
                include_bytes!("../assets/fluent-system-icons/regular/chevron-left.svg")
            }
            Self::ChevronRight => {
                include_bytes!("../assets/fluent-system-icons/regular/chevron-right.svg")
            }
            Self::PasswordReveal => {
                include_bytes!("../assets/fluent-system-icons/regular/password-reveal.svg")
            }
        }
    }

    pub const fn sf_symbol_name(self) -> &'static str {
        match self {
            Self::App => "square.grid.2x2",
            Self::Calculator => "plus.forwardslash.minus",
            Self::History => "clock.arrow.circlepath",
            Self::Backspace => "delete.backward",
            Self::Add => "plus",
            Self::Search => "magnifyingglass",
            Self::Settings => "gearshape",
            Self::Sidebar => "sidebar.left",
            Self::Inspector => "sidebar.right",
            Self::More => "ellipsis",
            Self::Attach => "paperclip",
            Self::Enter => "return",
            Self::Send => "paperplane",
            Self::Stop => "stop.fill",
            Self::Refresh => "arrow.clockwise",
            Self::Retry => "arrow.clockwise",
            Self::Code => "chevron.left.forwardslash.chevron.right",
            Self::Tool => "wrench.and.screwdriver",
            Self::Check => "checkmark",
            Self::Info => "info.circle",
            Self::Success => "checkmark.circle",
            Self::Warning => "exclamationmark.triangle",
            Self::Error => "exclamationmark.circle",
            Self::Minimize => "minus",
            Self::Close => "xmark",
            Self::Text | Self::Phrase => "textformat",
            Self::Image => "photo",
            Self::File => "doc",
            Self::Folder => "folder",
            Self::Save => "square.and.arrow.down",
            Self::Undo => "arrow.uturn.backward",
            Self::Cut => "scissors",
            Self::Pin => "pin",
            Self::Delete => "trash",
            Self::Copy => "doc.on.doc",
            Self::Paste => "doc.on.clipboard",
            Self::Edit => "pencil",
            Self::Group => "person.2",
            Self::ChevronUp => "chevron.up",
            Self::ChevronDown => "chevron.down",
            Self::Calendar => "calendar",
            Self::ChevronLeft => "chevron.left",
            Self::ChevronRight => "chevron.right",
            Self::PasswordReveal => "eye",
        }
    }

    pub const fn png_24_bytes(self) -> Option<&'static [u8]> {
        match self {
            Self::Search => Some(include_bytes!("../assets/icons/search/search_24x24.png")),
            Self::Settings => Some(include_bytes!("../assets/icons/setting/setting_24x24.png")),
            Self::Minimize => Some(include_bytes!("../assets/icons/min/min_24x24.png")),
            Self::Close => Some(include_bytes!("../assets/icons/exit/exit_24x24.png")),
            Self::Text | Self::Phrase => {
                Some(include_bytes!("../assets/icons/text/text_24x24.png"))
            }
            Self::Image => Some(include_bytes!("../assets/icons/image/image_24x24.png")),
            Self::File => Some(include_bytes!("../assets/icons/file/file_24x24.png")),
            Self::Folder | Self::Group => {
                Some(include_bytes!("../assets/icons/fold/fold_24x24.png"))
            }
            Self::Pin => Some(include_bytes!("../assets/icons/top/top_24x24.png")),
            Self::Delete => Some(include_bytes!("../assets/icons/del/del_24x24.png")),
            Self::App
            | Self::Calculator
            | Self::History
            | Self::Backspace
            | Self::Add
            | Self::Sidebar
            | Self::Inspector
            | Self::More
            | Self::Attach
            | Self::Enter
            | Self::Send
            | Self::Stop
            | Self::Refresh
            | Self::Retry
            | Self::Code
            | Self::Tool
            | Self::Check
            | Self::Info
            | Self::Success
            | Self::Warning
            | Self::Error
            | Self::Save
            | Self::Undo
            | Self::Cut
            | Self::Copy
            | Self::Paste
            | Self::Edit
            | Self::ChevronUp
            | Self::ChevronDown
            | Self::Calendar
            | Self::ChevronLeft
            | Self::ChevronRight => None,
            Self::PasswordReveal => None,
        }
    }
}

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

    #[test]
    fn png_24_assets_cover_shared_clipboard_row_icons() {
        for icon in [
            ZsIcon::Text,
            ZsIcon::Phrase,
            ZsIcon::Image,
            ZsIcon::File,
            ZsIcon::Folder,
            ZsIcon::Pin,
            ZsIcon::Delete,
        ] {
            let bytes = icon.png_24_bytes().expect("row icon should have PNG asset");
            assert!(bytes.starts_with(b"\x89PNG\r\n\x1a\n"));
        }
    }

    #[test]
    fn unavailable_png_assets_are_explicit() {
        assert!(ZsIcon::Copy.png_24_bytes().is_none());
        assert!(ZsIcon::Paste.png_24_bytes().is_none());
        assert!(ZsIcon::Edit.png_24_bytes().is_none());
        assert!(ZsIcon::Save.png_24_bytes().is_none());
        assert!(ZsIcon::Undo.png_24_bytes().is_none());
        assert!(ZsIcon::Cut.png_24_bytes().is_none());
        assert!(ZsIcon::Calculator.png_24_bytes().is_none());
        assert!(ZsIcon::History.png_24_bytes().is_none());
        assert!(ZsIcon::Backspace.png_24_bytes().is_none());
    }

    #[test]
    fn semantic_icons_have_native_symbol_mappings() {
        for icon in ZsIcon::ALL {
            assert_eq!(icon.windows_fluent_glyph().chars().count(), 1);
            assert_eq!(icon.windows_mdl2_glyph().chars().count(), 1);
            assert!(icon.gtk_symbolic_name().ends_with("-symbolic"));
            assert!(!icon.sf_symbol_name().is_empty());
        }
    }

    #[test]
    fn inspector_uses_the_dock_right_glyph_on_windows() {
        assert_eq!(ZsIcon::Inspector.windows_fluent_glyph(), "\u{E90D}");
        assert_eq!(ZsIcon::Inspector.windows_mdl2_glyph(), "\u{E90D}");
    }

    #[test]
    fn enter_uses_the_return_key_glyph_on_windows() {
        assert_eq!(ZsIcon::Enter.windows_fluent_glyph(), "\u{E751}");
        assert_eq!(ZsIcon::Enter.windows_mdl2_glyph(), "\u{E751}");
    }

    #[test]
    fn semantic_icon_sources_keep_retry_success_and_phrase_shapes_aligned() {
        assert_eq!(ZsIcon::Retry.windows_fluent_glyph(), "\u{E72C}");
        assert_eq!(ZsIcon::Retry.sf_symbol_name(), "arrow.clockwise");
        assert_eq!(ZsIcon::Retry.fluent_svg_asset_name(), "refresh.svg");

        assert_eq!(ZsIcon::Success.windows_fluent_glyph(), "\u{E930}");
        assert_eq!(ZsIcon::Success.sf_symbol_name(), "checkmark.circle");
        assert_eq!(ZsIcon::Success.fluent_svg_asset_name(), "success.svg");

        assert_eq!(ZsIcon::Phrase.windows_fluent_glyph(), "\u{E8D2}");
        assert_eq!(ZsIcon::Phrase.sf_symbol_name(), "textformat");
        assert_eq!(ZsIcon::Phrase.fluent_svg_asset_name(), "text.svg");
    }

    #[test]
    #[cfg(any(
        feature = "fluent-icons",
        all(target_os = "macos", feature = "macos-appkit"),
        all(
            target_os = "linux",
            any(feature = "linux-direct-host", feature = "linux-gtk")
        )
    ))]
    fn bundled_fluent_svg_fallback_covers_every_semantic_icon() {
        for icon in ZsIcon::ALL {
            assert!(icon.fluent_svg_asset_name().ends_with(".svg"));
            assert!(icon.fluent_svg_bytes().starts_with(b"<svg"));
        }
        assert!(ZsIcon::ChevronUp
            .fluent_svg_bytes()
            .windows(b"M4.14708 12.3534".len())
            .any(|window| window == b"M4.14708 12.3534"));
    }
}