native-theme 0.7.0

Cross-platform native theme detection and loading for Rust GUI applications
Documentation
//! Resolution-time inputs (font DPI, button order, icon theme) captured
//! once per theme-build and passed by reference through the pipeline.
//!
//! Per `docs/archive/v0.5.7_gaps.md` §G7:
//! intentionally NO `impl Default` — runtime-detected types must signal
//! intent at the call site. Use [`ResolutionContext::from_system`] for
//! production, or [`ResolutionContext::for_tests`] for deterministic
//! test values.

use std::borrow::Cow;

use crate::model::DialogButtonOrder;

/// Resolution-time inputs captured once per theme-build.
///
/// Replaces the `font_dpi: Option<f32>` parameter on
/// [`ThemeMode::into_resolved`](crate::theme::ThemeMode::into_resolved) and
/// the corresponding internal `OverlaySource` field.
///
/// Accessibility preferences live on
/// [`SystemTheme`](crate::SystemTheme), NOT here — accessibility is a
/// render-time concern, not a resolve-time concern
/// (`docs/archive/v0.5.7_gaps.md` §G7).
///
/// # Examples
///
/// ```
/// use native_theme::resolve::ResolutionContext;
///
/// // Production: auto-detect from OS.
/// let ctx = ResolutionContext::from_system();
/// assert!(ctx.font_dpi > 0.0);
///
/// // Tests: deterministic values.
/// let ctx = ResolutionContext::for_tests();
/// assert_eq!(ctx.font_dpi, 96.0);
/// assert!(ctx.icon_theme.is_none());
/// ```
#[derive(Clone, Debug)]
pub struct ResolutionContext {
    /// Font DPI for pt-to-px conversion. It must be finite and positive:
    /// resolution rejects any other value as one
    /// [`Error::ResolutionInvalid`](crate::Error::ResolutionInvalid) on the
    /// path `context.font_dpi`, before any point size is converted.
    ///
    /// [`from_system`](Self::from_system) detects it: 72.0 on macOS, 96.0 on
    /// Windows, 96.0 on a GNOME or Budgie desktop (with the `portal` feature;
    /// GNOME's text-scaling factor is carried in
    /// [`AccessibilityPreferences`](crate::AccessibilityPreferences), not in
    /// the DPI; an unrecognised desktop counts as the one
    /// [`SystemTheme::from_system`](crate::SystemTheme::from_system) reads,
    /// its portal backend's once a system read has asked it), and on other
    /// Linux desktops KDE's kcmfonts `forceFontDPI` on an X11
    /// session (with the `kde` feature), then `Xft.dpi`, then xrandr's
    /// physical DPI (with `kde` or `portal`), then 96.0; 96.0 elsewhere. The
    /// detected DPI is cached until
    /// [`invalidate_caches()`](crate::detect::invalidate_caches). When the
    /// OS theme is read
    /// ([`SystemTheme::from_system`](crate::SystemTheme::from_system)), the
    /// reader's own DPI replaces it: KDE's this same cached chain; GNOME's
    /// 96.0, macOS's 72.0 and Windows' 96.0.
    pub font_dpi: f32,
    /// Dialog button ordering (`PrimaryLeft` on KDE and Windows,
    /// `PrimaryRight` elsewhere).
    pub button_order: DialogButtonOrder,
    /// Runtime-detected icon theme name, used when the preset and
    /// per-variant `icon_theme` fields are both `None`. Three-tier
    /// precedence in the pipeline: per-variant → `Theme`-level shared →
    /// this runtime detection.
    ///
    /// [`from_system`](Self::from_system) puts the detected system icon
    /// theme here, or `None` where detection failed;
    /// [`system_icon_theme()`](crate::detect::system_icon_theme) gives the
    /// reason.
    pub icon_theme: Option<Cow<'static, str>>,
}

impl ResolutionContext {
    /// Build the context by auto-detecting from the current OS.
    ///
    /// Calls:
    /// - `crate::detect::system_font_dpi` for `font_dpi` (private)
    /// - `crate::resolve::inheritance::platform_button_order` for
    ///   `button_order`
    /// - [`crate::detect::system_icon_theme`] for `icon_theme`, which
    ///   is `None` where detection fails
    #[must_use]
    pub fn from_system() -> Self {
        Self::with_detected_icon_theme(crate::detect::system_icon_theme())
    }

    /// [`from_system`](Self::from_system), with `detected` as the outcome
    /// of the icon theme's detection.
    pub(crate) fn with_detected_icon_theme(detected: crate::Result<String>) -> Self {
        Self::with_font_dpi(crate::detect::system_font_dpi(), detected)
    }

    /// [`from_system`](Self::from_system) with a `font_dpi` already known,
    /// such as the one a platform reader detected: no DPI detection runs.
    /// `detected` is the outcome of the icon theme's detection.
    pub(crate) fn with_font_dpi(font_dpi: f32, detected: crate::Result<String>) -> Self {
        Self {
            font_dpi,
            button_order: crate::resolve::inheritance::platform_button_order(),
            icon_theme: detected.ok().map(Cow::Owned),
        }
    }

    /// Deterministic values for tests: 96 DPI, `PrimaryRight` button
    /// order, no detected `icon_theme`.
    ///
    /// Tests that need a specific DPI (e.g. 72.0 for Apple point→pixel)
    /// can construct the struct via a literal:
    /// `ResolutionContext { font_dpi: 72.0, ..ResolutionContext::for_tests() }`.
    #[must_use]
    pub fn for_tests() -> Self {
        Self {
            font_dpi: 96.0,
            button_order: DialogButtonOrder::PrimaryRight,
            icon_theme: None,
        }
    }
}

// Intentionally NO `impl Default for ResolutionContext`.
// See module-level doc comment for the signal-intent rationale.

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

    #[test]
    fn with_font_dpi_is_its_arguments() {
        // The pipeline's constructor when the reader supplied a DPI: the
        // context holds that DPI and the given icon-theme outcome, plus
        // the platform's button order; no DPI detection replaces either.
        let ctx = ResolutionContext::with_font_dpi(
            123.3,
            Err(crate::Error::PlatformUnsupported {
                platform: "the test's failing detection",
            }),
        );
        assert_eq!(ctx.font_dpi, 123.3);
        assert!(ctx.icon_theme.is_none());
        assert_eq!(
            ctx.button_order,
            crate::resolve::inheritance::platform_button_order()
        );

        let ctx = ResolutionContext::with_font_dpi(144.0, Ok("detected-theme".to_string()));
        assert_eq!(ctx.font_dpi, 144.0);
        assert_eq!(ctx.icon_theme.as_deref(), Some("detected-theme"));
    }
}