Skip to main content

native_theme/model/
border.rs

1// Border specification sub-structs for defaults-level and widget-level border properties
2
3use crate::Rgba;
4use native_theme_derive::ThemeFields;
5use serde::{Deserialize, Serialize};
6
7/// Defaults-level border specification: color, geometry, and opacity.
8///
9/// Used on [`ThemeDefaults`](crate::model::ThemeDefaults) for global border
10/// properties that are inherited by per-widget borders.
11///
12/// **No padding fields:** Padding (`padding_horizontal`, `padding_vertical`)
13/// lives exclusively on [`WidgetBorderSpec`] because padding is a widget-level
14/// layout concern, not a global default. This split (Phase 79, BORDER-01)
15/// eliminated the former "derives-from-presence" rule where the resolver
16/// would fill padding with `0.0` based on whether `line_width` or
17/// `corner_radius` was set -- a confusing proxy heuristic that is no longer
18/// needed.
19///
20/// All fields are optional to support partial overlays -- a DefaultsBorderSpec
21/// with only `color` set will only override the color when merged.
22#[serde_with::skip_serializing_none]
23#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize, ThemeFields)]
24#[serde(default)]
25pub struct DefaultsBorderSpec {
26    /// Border color.
27    pub color: Option<Rgba>,
28    /// Corner radius in logical pixels.
29    #[serde(rename = "corner_radius_px")]
30    pub corner_radius: Option<f32>,
31    /// Large corner radius in logical pixels (defaults only).
32    #[serde(rename = "corner_radius_lg_px")]
33    pub corner_radius_lg: Option<f32>,
34    /// Border stroke width in logical pixels.
35    #[serde(rename = "line_width_px")]
36    pub line_width: Option<f32>,
37    /// Border alpha multiplier 0.0-1.0 (defaults only).
38    pub opacity: Option<f32>,
39    /// Whether the bordered element has a drop shadow.
40    pub shadow_enabled: Option<bool>,
41}
42
43impl_merge!(DefaultsBorderSpec {
44    option { color, corner_radius, corner_radius_lg, line_width, opacity, shadow_enabled }
45});
46
47/// Widget-level border specification: color, geometry, and padding.
48///
49/// Used on per-widget structs for border properties specific to individual
50/// widgets. Unlike [`DefaultsBorderSpec`], includes `padding_horizontal`
51/// and `padding_vertical` (widget-level layout) but omits `corner_radius_lg`
52/// and `opacity` (defaults-only geometry).
53///
54/// Padding fields are widget-only because different widgets need different
55/// internal padding even when sharing the same border geometry from defaults.
56///
57/// All fields are optional to support partial overlays.
58#[serde_with::skip_serializing_none]
59#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize, ThemeFields)]
60#[serde(default)]
61pub struct WidgetBorderSpec {
62    /// Border color.
63    pub color: Option<Rgba>,
64    /// Corner radius in logical pixels.
65    #[serde(rename = "corner_radius_px")]
66    pub corner_radius: Option<f32>,
67    /// Border stroke width in logical pixels.
68    #[serde(rename = "line_width_px")]
69    pub line_width: Option<f32>,
70    /// Whether the bordered element has a drop shadow.
71    pub shadow_enabled: Option<bool>,
72    /// Horizontal padding inside the border in logical pixels.
73    #[serde(rename = "padding_horizontal_px")]
74    pub padding_horizontal: Option<f32>,
75    /// Vertical padding inside the border in logical pixels.
76    #[serde(rename = "padding_vertical_px")]
77    pub padding_vertical: Option<f32>,
78}
79
80impl_merge!(WidgetBorderSpec {
81    option { color, corner_radius, line_width, shadow_enabled, padding_horizontal, padding_vertical }
82});
83
84/// A resolved (non-optional) border specification produced after theme resolution.
85///
86/// Unlike [`DefaultsBorderSpec`] and [`WidgetBorderSpec`], all fields are
87/// required (non-optional) because resolution has already filled in all defaults.
88///
89/// Phase 93-01 (G1): no `Default` derive. `ResolvedBorderSpec` must be
90/// constructed from a fully populated unresolved source; any "zero"
91/// instance is a placeholder sentinel built manually (see
92/// `resolve::validate_helpers::resolved_border_spec_sentinel`).
93#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
94pub struct ResolvedBorderSpec {
95    /// Border color.
96    pub color: Rgba,
97    /// Corner radius in logical pixels.
98    pub corner_radius: f32,
99    /// Large corner radius in logical pixels (defaults only).
100    pub corner_radius_lg: f32,
101    /// Border stroke width in logical pixels.
102    pub line_width: f32,
103    /// Border alpha multiplier 0.0-1.0 (defaults only).
104    pub opacity: f32,
105    /// Whether the bordered element has a drop shadow.
106    pub shadow_enabled: bool,
107    /// Horizontal padding inside the border in logical pixels.
108    pub padding_horizontal: f32,
109    /// Vertical padding inside the border in logical pixels.
110    pub padding_vertical: f32,
111}
112
113#[cfg(test)]
114#[allow(clippy::unwrap_used, clippy::expect_used)]
115mod tests {
116    use super::*;
117
118    // === DefaultsBorderSpec tests ===
119
120    #[test]
121    fn defaults_border_spec_default_is_empty() {
122        assert!(DefaultsBorderSpec::default().is_empty());
123    }
124
125    #[test]
126    fn defaults_border_spec_not_empty_when_color_set() {
127        let bs = DefaultsBorderSpec {
128            color: Some(Rgba::rgb(100, 100, 100)),
129            ..Default::default()
130        };
131        assert!(!bs.is_empty());
132    }
133
134    #[test]
135    fn defaults_border_spec_toml_round_trip_full() {
136        let bs = DefaultsBorderSpec {
137            color: Some(Rgba::rgb(200, 200, 200)),
138            corner_radius: Some(4.0),
139            corner_radius_lg: Some(8.0),
140            line_width: Some(1.0),
141            opacity: Some(0.15),
142            shadow_enabled: Some(true),
143        };
144        let toml_str = toml::to_string(&bs).unwrap();
145        let deserialized: DefaultsBorderSpec = toml::from_str(&toml_str).unwrap();
146        assert_eq!(deserialized, bs);
147    }
148
149    #[test]
150    fn defaults_border_spec_toml_round_trip_partial() {
151        let bs = DefaultsBorderSpec {
152            color: Some(Rgba::rgb(100, 100, 100)),
153            corner_radius: Some(8.0),
154            corner_radius_lg: None,
155            line_width: None,
156            opacity: None,
157            shadow_enabled: None,
158        };
159        let toml_str = toml::to_string(&bs).unwrap();
160        let deserialized: DefaultsBorderSpec = toml::from_str(&toml_str).unwrap();
161        assert_eq!(deserialized, bs);
162        assert!(deserialized.corner_radius_lg.is_none());
163        assert!(deserialized.line_width.is_none());
164        assert!(deserialized.opacity.is_none());
165        assert!(deserialized.shadow_enabled.is_none());
166    }
167
168    #[test]
169    fn defaults_border_spec_merge_overlay_wins() {
170        let mut base = DefaultsBorderSpec {
171            color: Some(Rgba::rgb(100, 100, 100)),
172            corner_radius: Some(4.0),
173            ..Default::default()
174        };
175        let overlay = DefaultsBorderSpec {
176            color: Some(Rgba::rgb(200, 200, 200)),
177            ..Default::default()
178        };
179        base.merge(&overlay);
180        assert_eq!(base.color, Some(Rgba::rgb(200, 200, 200)));
181        // base corner_radius preserved since overlay corner_radius is None
182        assert_eq!(base.corner_radius, Some(4.0));
183    }
184
185    // === WidgetBorderSpec tests ===
186
187    #[test]
188    fn widget_border_spec_default_is_empty() {
189        assert!(WidgetBorderSpec::default().is_empty());
190    }
191
192    #[test]
193    fn widget_border_spec_not_empty_when_color_set() {
194        let bs = WidgetBorderSpec {
195            color: Some(Rgba::rgb(100, 100, 100)),
196            ..Default::default()
197        };
198        assert!(!bs.is_empty());
199    }
200
201    #[test]
202    fn widget_border_spec_toml_round_trip_full() {
203        let bs = WidgetBorderSpec {
204            color: Some(Rgba::rgb(200, 200, 200)),
205            corner_radius: Some(4.0),
206            line_width: Some(1.0),
207            shadow_enabled: Some(true),
208            padding_horizontal: Some(8.0),
209            padding_vertical: Some(6.0),
210        };
211        let toml_str = toml::to_string(&bs).unwrap();
212        let deserialized: WidgetBorderSpec = toml::from_str(&toml_str).unwrap();
213        assert_eq!(deserialized, bs);
214    }
215
216    #[test]
217    fn widget_border_spec_toml_round_trip_partial() {
218        let bs = WidgetBorderSpec {
219            color: Some(Rgba::rgb(100, 100, 100)),
220            corner_radius: Some(8.0),
221            line_width: None,
222            shadow_enabled: None,
223            padding_horizontal: None,
224            padding_vertical: None,
225        };
226        let toml_str = toml::to_string(&bs).unwrap();
227        let deserialized: WidgetBorderSpec = toml::from_str(&toml_str).unwrap();
228        assert_eq!(deserialized, bs);
229        assert!(deserialized.line_width.is_none());
230        assert!(deserialized.shadow_enabled.is_none());
231        assert!(deserialized.padding_horizontal.is_none());
232        assert!(deserialized.padding_vertical.is_none());
233    }
234
235    #[test]
236    fn widget_border_spec_merge_overlay_wins() {
237        let mut base = WidgetBorderSpec {
238            color: Some(Rgba::rgb(100, 100, 100)),
239            corner_radius: Some(4.0),
240            ..Default::default()
241        };
242        let overlay = WidgetBorderSpec {
243            color: Some(Rgba::rgb(200, 200, 200)),
244            ..Default::default()
245        };
246        base.merge(&overlay);
247        assert_eq!(base.color, Some(Rgba::rgb(200, 200, 200)));
248        // base corner_radius preserved since overlay corner_radius is None
249        assert_eq!(base.corner_radius, Some(4.0));
250    }
251
252    // === ResolvedBorderSpec tests ===
253
254    // Phase 93-01 (G1): the former `resolved_border_spec_default` test was
255    // removed because `ResolvedBorderSpec` no longer derives `Default`.
256    // The sentinel zero value is constructed in
257    // `resolve::validate_helpers::resolved_border_spec_sentinel` and is
258    // exercised by the G1 regression tests in `resolve::tests`.
259
260    #[test]
261    fn resolved_border_spec_struct_literal_compiles() {
262        // Field-name compile guard: any rename/remove breaks this struct
263        // literal. Values reproduce the pre-G1 `::default()` output for
264        // documentation only.
265        let rbs = ResolvedBorderSpec {
266            color: Rgba::new(0, 0, 0, 0),
267            corner_radius: 0.0,
268            corner_radius_lg: 0.0,
269            line_width: 0.0,
270            opacity: 0.0,
271            shadow_enabled: false,
272            padding_horizontal: 0.0,
273            padding_vertical: 0.0,
274        };
275        assert_eq!(rbs.padding_horizontal, 0.0);
276        assert_eq!(rbs.padding_vertical, 0.0);
277        assert_eq!(rbs.corner_radius, 0.0);
278        assert_eq!(rbs.corner_radius_lg, 0.0);
279        assert_eq!(rbs.line_width, 0.0);
280        assert_eq!(rbs.opacity, 0.0);
281        assert!(!rbs.shadow_enabled);
282    }
283}