Skip to main content

layout/taffy/stylo_taffy/
convert.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use style::Atom;
6use stylo_atoms::atom;
7use taffy::MaxTrackSizingFunction;
8use taffy::style_helpers::*;
9
10use super::{as_clamped_i16, stylo};
11
12#[inline]
13pub fn length_percentage(val: &stylo::LengthPercentage) -> taffy::LengthPercentage {
14    match val.unpack() {
15        stylo::UnpackedLengthPercentage::Length(len) => length(len.px()),
16        stylo::UnpackedLengthPercentage::Percentage(percentage) => percent(percentage.0),
17        stylo::UnpackedLengthPercentage::Calc(calc_ref) => {
18            let calc_ptr = calc_ref as *const stylo::CalcLengthPercentage as *const ();
19            taffy::LengthPercentage::calc(calc_ptr)
20        },
21    }
22}
23
24#[inline]
25fn fit_content_function(limit: &stylo::LengthPercentage) -> taffy::Dimension {
26    match limit.unpack() {
27        stylo::UnpackedLengthPercentage::Length(length) => {
28            taffy::Dimension::fit_content_px(length.px())
29        },
30        stylo::UnpackedLengthPercentage::Percentage(percentage) => {
31            taffy::Dimension::fit_content_percent(percentage.0)
32        },
33        stylo::UnpackedLengthPercentage::Calc(calc_ref) => {
34            let calc_ptr = calc_ref as *const stylo::CalcLengthPercentage as *const ();
35            taffy::Dimension::fit_content_calc(calc_ptr)
36        },
37    }
38}
39
40#[inline]
41pub fn dimension(value: &stylo::Size) -> taffy::Dimension {
42    match value {
43        stylo::Size::LengthPercentage(value) => length_percentage(&value.0).into(),
44        stylo::Size::Auto => taffy::Dimension::AUTO,
45        stylo::Size::MaxContent => taffy::Dimension::max_content(),
46        stylo::Size::MinContent => taffy::Dimension::min_content(),
47        stylo::Size::FitContent => taffy::Dimension::fit_content(),
48        stylo::Size::FitContentFunction(limit) => fit_content_function(&limit.0),
49        stylo::Size::Stretch | stylo::Size::WebkitFillAvailable => taffy::Dimension::stretch(),
50
51        // Anchor positioning will be flagged off for time being
52        stylo::Size::AnchorSizeFunction(_) => unreachable!(),
53        stylo::Size::AnchorContainingCalcFunction(_) => unreachable!(),
54    }
55}
56
57#[inline]
58pub fn min_size(value: &stylo::Size) -> taffy::LengthPercentageAuto {
59    match value {
60        stylo::Size::LengthPercentage(value) => length_percentage(&value.0).into(),
61        stylo::Size::Auto => taffy::LengthPercentageAuto::AUTO,
62
63        // TODO: implement other values in Taffy
64        stylo::Size::MaxContent => taffy::LengthPercentageAuto::AUTO,
65        stylo::Size::MinContent => taffy::LengthPercentageAuto::AUTO,
66        stylo::Size::FitContent => taffy::LengthPercentageAuto::AUTO,
67        stylo::Size::FitContentFunction(_) => taffy::LengthPercentageAuto::AUTO,
68        stylo::Size::Stretch | stylo::Size::WebkitFillAvailable => {
69            taffy::LengthPercentageAuto::AUTO
70        },
71
72        // Anchor positioning will be flagged off for time being
73        stylo::Size::AnchorSizeFunction(_) | stylo::Size::AnchorContainingCalcFunction(_) => {
74            unreachable!("Anchor positioning is disabled in stylo")
75        },
76    }
77}
78
79#[inline]
80pub fn max_size(value: &stylo::MaxSize) -> taffy::LengthPercentageAuto {
81    match value {
82        stylo::MaxSize::LengthPercentage(value) => length_percentage(&value.0).into(),
83        stylo::MaxSize::None => taffy::LengthPercentageAuto::AUTO,
84
85        // TODO: implement other values in Taffy
86        stylo::MaxSize::MaxContent => taffy::LengthPercentageAuto::AUTO,
87        stylo::MaxSize::MinContent => taffy::LengthPercentageAuto::AUTO,
88        stylo::MaxSize::FitContent => taffy::LengthPercentageAuto::AUTO,
89        stylo::MaxSize::FitContentFunction(_) => taffy::LengthPercentageAuto::AUTO,
90        stylo::MaxSize::Stretch | stylo::MaxSize::WebkitFillAvailable => {
91            taffy::LengthPercentageAuto::AUTO
92        },
93
94        // Anchor positioning will be flagged off for time being
95        stylo::MaxSize::AnchorSizeFunction(_) | stylo::MaxSize::AnchorContainingCalcFunction(_) => {
96            unreachable!("Anchor positioning is disabled in stylo")
97        },
98    }
99}
100
101#[inline]
102pub fn margin(val: &stylo::MarginVal) -> taffy::LengthPercentageAuto {
103    match val {
104        stylo::MarginVal::Auto => taffy::LengthPercentageAuto::AUTO,
105        stylo::MarginVal::LengthPercentage(val) => length_percentage(val).into(),
106
107        // Anchor positioning will be flagged off for time being
108        stylo::MarginVal::AnchorSizeFunction(_) |
109        stylo::MarginVal::AnchorContainingCalcFunction(_) => {
110            unreachable!("Anchor positioning is disabled in stylo")
111        },
112    }
113}
114
115#[inline]
116pub fn inset(val: &stylo::InsetVal) -> taffy::LengthPercentageAuto {
117    match val {
118        stylo::InsetVal::Auto => taffy::LengthPercentageAuto::AUTO,
119        stylo::InsetVal::LengthPercentage(val) => length_percentage(val).into(),
120
121        // Anchor positioning will be flagged off for time being
122        stylo::InsetVal::AnchorSizeFunction(_) |
123        stylo::InsetVal::AnchorFunction(_) |
124        stylo::InsetVal::AnchorContainingCalcFunction(_) => {
125            unreachable!("Anchor positioning is disabled in stylo")
126        },
127    }
128}
129
130#[inline]
131pub fn is_block(input: stylo::Display) -> bool {
132    matches!(input.outside(), stylo::DisplayOutside::Block) &&
133        matches!(
134            input.inside(),
135            stylo::DisplayInside::Flow | stylo::DisplayInside::FlowRoot
136        )
137}
138
139#[inline]
140pub fn box_generation_mode(input: stylo::Display) -> taffy::BoxGenerationMode {
141    match input.inside() {
142        stylo::DisplayInside::None => taffy::BoxGenerationMode::None,
143        _ => taffy::BoxGenerationMode::Normal,
144    }
145}
146
147#[inline]
148pub fn box_sizing(input: stylo::BoxSizing) -> taffy::BoxSizing {
149    match input {
150        stylo::BoxSizing::BorderBox => taffy::BoxSizing::BorderBox,
151        stylo::BoxSizing::ContentBox => taffy::BoxSizing::ContentBox,
152    }
153}
154
155#[inline]
156pub fn direction(input: stylo::Direction) -> taffy::Direction {
157    match input {
158        stylo::Direction::Ltr => taffy::Direction::Ltr,
159        stylo::Direction::Rtl => taffy::Direction::Rtl,
160    }
161}
162
163#[inline]
164pub fn position(input: stylo::Position) -> taffy::Position {
165    match input {
166        stylo::Position::Static => taffy::Position::Static,
167        stylo::Position::Relative => taffy::Position::Relative,
168        stylo::Position::Absolute => taffy::Position::Absolute,
169        stylo::Position::Fixed => taffy::Position::Fixed,
170        stylo::Position::Sticky => taffy::Position::Sticky,
171    }
172}
173
174#[inline]
175pub fn overflow(input: stylo::Overflow) -> taffy::Overflow {
176    // TODO: Enable Overflow::Clip in servo configuration of stylo
177    match input {
178        stylo::Overflow::Visible => taffy::Overflow::Visible,
179        stylo::Overflow::Hidden => taffy::Overflow::Hidden,
180        stylo::Overflow::Scroll => taffy::Overflow::Scroll,
181        stylo::Overflow::Clip => taffy::Overflow::Clip,
182        // TODO: Support Overflow::Auto in Taffy
183        stylo::Overflow::Auto => taffy::Overflow::Scroll,
184    }
185}
186
187#[inline]
188pub fn aspect_ratio(input: stylo::AspectRatio) -> Option<f32> {
189    match input.ratio {
190        stylo::PreferredRatio::None => None,
191        stylo::PreferredRatio::Ratio(val) => Some(val.0.0 / val.1.0),
192    }
193}
194
195#[inline]
196fn alignment_safety(flags: stylo::AlignFlags) -> taffy::AlignmentSafety {
197    match flags {
198        stylo::AlignFlags::SAFE => taffy::AlignmentSafety::Safe,
199        stylo::AlignFlags::UNSAFE => taffy::AlignmentSafety::Unsafe,
200        _ => taffy::AlignmentSafety::Default,
201    }
202}
203
204#[inline]
205pub fn content_alignment(input: stylo::ContentDistribution) -> taffy::AlignContent {
206    let keyword = match input.primary().value() {
207        stylo::AlignFlags::NORMAL => taffy::AlignContentKeyword::Normal,
208        stylo::AlignFlags::AUTO => taffy::AlignContentKeyword::Normal,
209        stylo::AlignFlags::START => taffy::AlignContentKeyword::Start,
210        stylo::AlignFlags::END => taffy::AlignContentKeyword::End,
211        stylo::AlignFlags::LEFT => taffy::AlignContentKeyword::Start,
212        stylo::AlignFlags::RIGHT => taffy::AlignContentKeyword::End,
213        stylo::AlignFlags::FLEX_START => taffy::AlignContentKeyword::FlexStart,
214        stylo::AlignFlags::STRETCH => taffy::AlignContentKeyword::Stretch,
215        stylo::AlignFlags::FLEX_END => taffy::AlignContentKeyword::FlexEnd,
216        stylo::AlignFlags::CENTER => taffy::AlignContentKeyword::Center,
217        stylo::AlignFlags::SPACE_BETWEEN => taffy::AlignContentKeyword::SpaceBetween,
218        stylo::AlignFlags::SPACE_AROUND => taffy::AlignContentKeyword::SpaceAround,
219        stylo::AlignFlags::SPACE_EVENLY => taffy::AlignContentKeyword::SpaceEvenly,
220        // Should never be hit. But no real reason to panic here.
221        _ => taffy::AlignContentKeyword::Normal,
222    };
223
224    taffy::AlignContent {
225        keyword,
226        safety: alignment_safety(input.primary().flags()),
227    }
228}
229
230#[inline]
231pub fn items_alignment(input: stylo::AlignFlags) -> taffy::AlignItems {
232    self_alignment(input).unwrap_or(taffy::AlignItems::NORMAL)
233}
234
235#[inline]
236pub fn self_alignment(input: stylo::AlignFlags) -> Option<taffy::AlignSelf> {
237    let keyword = match input.value() {
238        stylo::AlignFlags::AUTO => return None,
239        stylo::AlignFlags::NORMAL => taffy::AlignItemsKeyword::Normal,
240        stylo::AlignFlags::STRETCH => taffy::AlignItemsKeyword::Stretch,
241        stylo::AlignFlags::FLEX_START => taffy::AlignItemsKeyword::FlexStart,
242        stylo::AlignFlags::FLEX_END => taffy::AlignItemsKeyword::FlexEnd,
243        stylo::AlignFlags::SELF_START => taffy::AlignItemsKeyword::Start,
244        stylo::AlignFlags::SELF_END => taffy::AlignItemsKeyword::End,
245        stylo::AlignFlags::START => taffy::AlignItemsKeyword::Start,
246        stylo::AlignFlags::END => taffy::AlignItemsKeyword::End,
247        stylo::AlignFlags::LEFT => taffy::AlignItemsKeyword::Start,
248        stylo::AlignFlags::RIGHT => taffy::AlignItemsKeyword::End,
249        stylo::AlignFlags::CENTER => taffy::AlignItemsKeyword::Center,
250        stylo::AlignFlags::BASELINE => taffy::AlignItemsKeyword::Baseline,
251        // Should never be hit. But no real reason to panic here.
252        _ => return None,
253    };
254
255    Some(taffy::AlignItems {
256        keyword,
257        safety: alignment_safety(input.flags()),
258    })
259}
260
261#[inline]
262pub fn gap(input: &stylo::Gap) -> taffy::LengthPercentage {
263    match input {
264        // For Flexbox and CSS Grid the "normal" value is 0px. This may need to be updated
265        // if we ever implement multi-column layout.
266        stylo::Gap::Normal => taffy::LengthPercentage::ZERO,
267        stylo::Gap::LengthPercentage(val) => length_percentage(&val.0),
268    }
269}
270
271// CSS Grid styles
272// ===============
273
274#[inline]
275pub fn grid_auto_flow(input: stylo::GridAutoFlow) -> taffy::GridAutoFlow {
276    let is_row = input.contains(stylo::GridAutoFlow::ROW);
277    let is_dense = input.contains(stylo::GridAutoFlow::DENSE);
278
279    match (is_row, is_dense) {
280        (true, false) => taffy::GridAutoFlow::Row,
281        (true, true) => taffy::GridAutoFlow::RowDense,
282        (false, false) => taffy::GridAutoFlow::Column,
283        (false, true) => taffy::GridAutoFlow::ColumnDense,
284    }
285}
286
287#[inline]
288pub fn grid_line(input: &stylo::GridLine) -> taffy::GridPlacement<Atom> {
289    if input.is_auto() {
290        taffy::GridPlacement::Auto
291    } else if input.is_span {
292        if input.ident.0 != atom!("") {
293            taffy::GridPlacement::NamedSpan(
294                input.ident.0.clone(),
295                as_clamped_i16(input.line_num) as u16,
296            )
297        } else {
298            taffy::GridPlacement::Span(input.line_num as u16)
299        }
300    } else if input.ident.0 != atom!("") {
301        taffy::GridPlacement::NamedLine(input.ident.0.clone(), as_clamped_i16(input.line_num))
302    } else if input.line_num != 0 {
303        taffy::style_helpers::line(as_clamped_i16(input.line_num))
304    } else {
305        taffy::GridPlacement::Auto
306    }
307}
308
309#[inline]
310pub fn track_repeat(input: stylo::RepeatCount<i32>) -> taffy::RepetitionCount {
311    match input {
312        stylo::RepeatCount::Number(count) => {
313            taffy::RepetitionCount::Count(as_clamped_i16(count) as u16)
314        },
315        stylo::RepeatCount::AutoFill => taffy::RepetitionCount::AutoFill,
316        stylo::RepeatCount::AutoFit => taffy::RepetitionCount::AutoFit,
317    }
318}
319
320#[inline]
321pub fn track_size(input: &stylo::TrackSize<stylo::LengthPercentage>) -> taffy::TrackSizingFunction {
322    match input {
323        stylo::TrackSize::Breadth(breadth) => taffy::MinMax {
324            min: min_track(breadth),
325            max: max_track(breadth),
326        },
327        stylo::TrackSize::Minmax(min, max) => taffy::MinMax {
328            min: min_track(min),
329            max: max_track(max),
330        },
331        stylo::TrackSize::FitContent(limit) => taffy::MinMax {
332            min: taffy::MinTrackSizingFunction::AUTO,
333            max: match limit {
334                stylo::TrackBreadth::Breadth(lp) => {
335                    MaxTrackSizingFunction::fit_content(length_percentage(lp))
336                },
337
338                // Are these valid? Taffy doesn't support this in any case
339                stylo::TrackBreadth::Flex(_) => unreachable!(),
340                stylo::TrackBreadth::Auto => unreachable!(),
341                stylo::TrackBreadth::MinContent => unreachable!(),
342                stylo::TrackBreadth::MaxContent => unreachable!(),
343            },
344        },
345    }
346}
347
348#[inline]
349pub fn min_track(
350    input: &stylo::TrackBreadth<stylo::LengthPercentage>,
351) -> taffy::MinTrackSizingFunction {
352    match input {
353        stylo::TrackBreadth::Breadth(lp) => length_percentage(lp).into(),
354        stylo::TrackBreadth::Flex(_) => taffy::MinTrackSizingFunction::AUTO,
355        stylo::TrackBreadth::Auto => taffy::MinTrackSizingFunction::AUTO,
356        stylo::TrackBreadth::MinContent => taffy::MinTrackSizingFunction::MIN_CONTENT,
357        stylo::TrackBreadth::MaxContent => taffy::MinTrackSizingFunction::MAX_CONTENT,
358    }
359}
360
361#[inline]
362pub fn max_track(
363    input: &stylo::TrackBreadth<stylo::LengthPercentage>,
364) -> taffy::MaxTrackSizingFunction {
365    match input {
366        stylo::TrackBreadth::Breadth(lp) => length_percentage(lp).into(),
367        stylo::TrackBreadth::Flex(val) => fr(val.0),
368        stylo::TrackBreadth::Auto => taffy::MaxTrackSizingFunction::AUTO,
369        stylo::TrackBreadth::MinContent => taffy::MaxTrackSizingFunction::MIN_CONTENT,
370        stylo::TrackBreadth::MaxContent => taffy::MaxTrackSizingFunction::MAX_CONTENT,
371    }
372}