egui-macview 0.6.0

//! AppKit Vector Symbols, Iconography & CupertinoIcons Engine (SPEC-008).
//!
//! Provides monochrome, resolution-independent AppKit vector iconography
//! powered by the embedded Flutter `CupertinoIcons` TrueType font.
//!
//! Replaces multi-colored host emojis (such as Windows Segoe UI Emoji) with
//! authentic Apple-styled vector symbols that inherit the active theme's
//! foreground color.

use std::fmt;

/// Embedded raw bytes of the `CupertinoIcons.ttf` TrueType font asset.
pub const CUPERTINO_ICONS_FONT_BYTES: &[u8] =
    include_bytes!("../../assets/fonts/CupertinoIcons.ttf");

/// Name key used to register CupertinoIcons in `egui::FontDefinitions`.
pub const CUPERTINO_ICONS_FONT_NAME: &str = "cupertino_icons";

/// Enumeration of monochrome AppKit vector symbols mapped to CupertinoIcons font codepoints.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum MacSymbol {
    /// Magnifying glass search icon (`\u{f4a5}`).
    Search,
    /// Right-pointing navigation chevron (`\u{f3d3}`).
    ChevronRight,
    /// Left-pointing navigation chevron (`\u{f3d2}`).
    ChevronLeft,
    /// Downward-pointing disclosure chevron (`\u{f5d5}`).
    ChevronDown,
    /// Upward-pointing navigation chevron (`\u{f5e5}`).
    ChevronUp,
    /// Sidebar toggle / leading sidebar icon (`\u{f7d6}`).
    SidebarLeading,
    /// Settings gear icon (`\u{f43c}`).
    Gear,
    /// Horizontal sliders / filters icon (`\u{f7dc}`).
    Sliders,
    /// Checkmark verification icon (`\u{f3fd}`).
    Checkmark,
    /// Close / cancel 'x' mark icon (`\u{f404}`).
    Xmark,
    /// Add / plus icon (`\u{f489}`).
    Plus,
    /// Remove / minus icon (`\u{f70f}`).
    Minus,
    /// Clockwise reload / refresh icon (`\u{f49a}`).
    ArrowClockwise,
    /// Counter-clockwise undo / restart icon (`\u{f21c}`).
    ArrowCounterClockwise,
}

impl MacSymbol {
    /// Array of all 14 `MacSymbol` variants in canonical order.
    pub const ALL: [Self; 14] = [
        Self::Search,
        Self::ChevronRight,
        Self::ChevronLeft,
        Self::ChevronDown,
        Self::ChevronUp,
        Self::SidebarLeading,
        Self::Gear,
        Self::Sliders,
        Self::Checkmark,
        Self::Xmark,
        Self::Plus,
        Self::Minus,
        Self::ArrowClockwise,
        Self::ArrowCounterClockwise,
    ];

    /// Returns the character representing the symbol in the CupertinoIcons font.
    #[inline]
    pub const fn as_char(&self) -> char {
        match self {
            Self::Search => '\u{f4a5}',
            Self::ChevronRight => '\u{f3d3}',
            Self::ChevronLeft => '\u{f3d2}',
            Self::ChevronDown => '\u{f5d5}',
            Self::ChevronUp => '\u{f5e5}',
            Self::SidebarLeading => '\u{f7d6}',
            Self::Gear => '\u{f43c}',
            Self::Sliders => '\u{f7dc}',
            Self::Checkmark => '\u{f3fd}',
            Self::Xmark => '\u{f404}',
            Self::Plus => '\u{f489}',
            Self::Minus => '\u{f70f}',
            Self::ArrowClockwise => '\u{f49a}',
            Self::ArrowCounterClockwise => '\u{f21c}',
        }
    }

    /// Returns the string representation of the symbol.
    #[inline]
    pub const fn as_str(&self) -> &'static str {
        match self {
            Self::Search => "\u{f4a5}",
            Self::ChevronRight => "\u{f3d3}",
            Self::ChevronLeft => "\u{f3d2}",
            Self::ChevronDown => "\u{f5d5}",
            Self::ChevronUp => "\u{f5e5}",
            Self::SidebarLeading => "\u{f7d6}",
            Self::Gear => "\u{f43c}",
            Self::Sliders => "\u{f7dc}",
            Self::Checkmark => "\u{f3fd}",
            Self::Xmark => "\u{f404}",
            Self::Plus => "\u{f489}",
            Self::Minus => "\u{f70f}",
            Self::ArrowClockwise => "\u{f49a}",
            Self::ArrowCounterClockwise => "\u{f21c}",
        }
    }

    /// Returns the 32-bit Unicode scalar codepoint of the symbol.
    #[inline]
    pub const fn codepoint(&self) -> u32 {
        self.as_char() as u32
    }
}

impl fmt::Display for MacSymbol {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_str())
    }
}

impl AsRef<str> for MacSymbol {
    #[inline]
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

/// Registers the CupertinoIcons TrueType font with the provided `egui::FontDefinitions`.
///
/// Adds the `"cupertino_icons"` font to `font_data` and installs it as a fallback
/// in both `FontFamily::Proportional` and `FontFamily::Monospace`. This ensures
/// that standard alphanumeric text renders with the user's primary typeface while
/// icon characters fall through to the monochrome Cupertino vector font.
///
/// This function is idempotent: calling it multiple times will not insert duplicate
/// fallback entries into font families.
pub fn setup_symbols_font(fonts: &mut egui::FontDefinitions) {
    fonts.font_data.insert(
        CUPERTINO_ICONS_FONT_NAME.to_owned(),
        std::sync::Arc::new(egui::FontData::from_static(CUPERTINO_ICONS_FONT_BYTES)),
    );

    // Idempotent fallback insertion in proportional family
    let prop_family = fonts
        .families
        .entry(egui::FontFamily::Proportional)
        .or_default();
    if !prop_family.iter().any(|f| f == CUPERTINO_ICONS_FONT_NAME) {
        prop_family.push(CUPERTINO_ICONS_FONT_NAME.to_owned());
    }

    // Idempotent fallback insertion in monospace family
    let mono_family = fonts
        .families
        .entry(egui::FontFamily::Monospace)
        .or_default();
    if !mono_family.iter().any(|f| f == CUPERTINO_ICONS_FONT_NAME) {
        mono_family.push(CUPERTINO_ICONS_FONT_NAME.to_owned());
    }
}