1use super::types::{CellOccupancyMatrix, CellOccupancyState, GridItem};
4use super::OriginZeroLine;
5use crate::geometry::Line;
6use crate::geometry::{AbsoluteAxis, InBothAbsAxis};
7use crate::style::{AlignItems, GridAutoFlow, OriginZeroGridPlacement, Style};
8use crate::tree::NodeId;
9use crate::util::sys::Vec;
10
11pub(super) fn place_grid_items<'a, ChildIter>(
16 cell_occupancy_matrix: &mut CellOccupancyMatrix,
17 items: &mut Vec<GridItem>,
18 children_iter: impl Fn() -> ChildIter,
19 grid_auto_flow: GridAutoFlow,
20 align_items: AlignItems,
21 justify_items: AlignItems,
22) where
23 ChildIter: Iterator<Item = (usize, NodeId, &'a Style)>,
24{
25 let primary_axis = grid_auto_flow.primary_axis();
26 let secondary_axis = primary_axis.other_axis();
27
28 let map_child_style_to_origin_zero_placement = {
29 let explicit_col_count = cell_occupancy_matrix.track_counts(AbsoluteAxis::Horizontal).explicit;
30 let explicit_row_count = cell_occupancy_matrix.track_counts(AbsoluteAxis::Vertical).explicit;
31 move |(index, node, style): (usize, NodeId, &'a Style)| -> (_, _, _, &'a Style) {
32 let origin_zero_placement = InBothAbsAxis {
33 horizontal: style.grid_column.map(|placement| placement.into_origin_zero_placement(explicit_col_count)),
34 vertical: style.grid_row.map(|placement| placement.into_origin_zero_placement(explicit_row_count)),
35 };
36 (index, node, origin_zero_placement, style)
37 }
38 };
39
40 let mut idx = 0;
42 children_iter()
43 .filter(|(_, _, child_style)| child_style.grid_row.is_definite() && child_style.grid_column.is_definite())
44 .map(map_child_style_to_origin_zero_placement)
45 .for_each(|(index, child_node, child_placement, style)| {
46 idx += 1;
47 #[cfg(test)]
48 println!("Definite Item {idx}\n==============");
49
50 let (row_span, col_span) = place_definite_grid_item(child_placement, primary_axis);
51 record_grid_placement(
52 cell_occupancy_matrix,
53 items,
54 child_node,
55 index,
56 style,
57 align_items,
58 justify_items,
59 primary_axis,
60 row_span,
61 col_span,
62 CellOccupancyState::DefinitelyPlaced,
63 );
64 });
65
66 let mut idx = 0;
68 children_iter()
69 .filter(|(_, _, child_style)| {
70 child_style.grid_placement(secondary_axis).is_definite()
71 && !child_style.grid_placement(primary_axis).is_definite()
72 })
73 .map(map_child_style_to_origin_zero_placement)
74 .for_each(|(index, child_node, child_placement, style)| {
75 idx += 1;
76 #[cfg(test)]
77 println!("Definite Secondary Item {idx}\n==============");
78
79 let (primary_span, secondary_span) =
80 place_definite_secondary_axis_item(&*cell_occupancy_matrix, child_placement, grid_auto_flow);
81
82 record_grid_placement(
83 cell_occupancy_matrix,
84 items,
85 child_node,
86 index,
87 style,
88 align_items,
89 justify_items,
90 primary_axis,
91 primary_span,
92 secondary_span,
93 CellOccupancyState::AutoPlaced,
94 );
95 });
96
97 let primary_axis = grid_auto_flow.primary_axis();
117 let secondary_axis = primary_axis.other_axis();
118 let primary_neg_tracks = cell_occupancy_matrix.track_counts(primary_axis).negative_implicit as i16;
119 let secondary_neg_tracks = cell_occupancy_matrix.track_counts(secondary_axis).negative_implicit as i16;
120 let grid_start_position = (OriginZeroLine(-primary_neg_tracks), OriginZeroLine(-secondary_neg_tracks));
121 let mut grid_position = grid_start_position;
122 let mut idx = 0;
123 children_iter()
124 .filter(|(_, _, child_style)| !child_style.grid_placement(secondary_axis).is_definite())
125 .map(map_child_style_to_origin_zero_placement)
126 .for_each(|(index, child_node, child_placement, style)| {
127 idx += 1;
128 #[cfg(test)]
129 println!("\nAuto Item {idx}\n==============");
130
131 let (primary_span, secondary_span) = place_indefinitely_positioned_item(
133 &*cell_occupancy_matrix,
134 child_placement,
135 grid_auto_flow,
136 grid_position,
137 );
138
139 record_grid_placement(
141 cell_occupancy_matrix,
142 items,
143 child_node,
144 index,
145 style,
146 align_items,
147 justify_items,
148 primary_axis,
149 primary_span,
150 secondary_span,
151 CellOccupancyState::AutoPlaced,
152 );
153
154 grid_position = match grid_auto_flow.is_dense() {
157 true => grid_start_position,
158 false => (primary_span.end, secondary_span.start),
159 }
160 });
161}
162
163fn place_definite_grid_item(
166 placement: InBothAbsAxis<Line<OriginZeroGridPlacement>>,
167 primary_axis: AbsoluteAxis,
168) -> (Line<OriginZeroLine>, Line<OriginZeroLine>) {
169 let primary_span = placement.get(primary_axis).resolve_definite_grid_lines();
171 let secondary_span = placement.get(primary_axis.other_axis()).resolve_definite_grid_lines();
172
173 (primary_span, secondary_span)
174}
175
176fn place_definite_secondary_axis_item(
179 cell_occupancy_matrix: &CellOccupancyMatrix,
180 placement: InBothAbsAxis<Line<OriginZeroGridPlacement>>,
181 auto_flow: GridAutoFlow,
182) -> (Line<OriginZeroLine>, Line<OriginZeroLine>) {
183 let primary_axis = auto_flow.primary_axis();
184 let secondary_axis = primary_axis.other_axis();
185
186 let secondary_axis_placement = placement.get(secondary_axis).resolve_definite_grid_lines();
187 let primary_axis_grid_start_line = cell_occupancy_matrix.track_counts(primary_axis).implicit_start_line();
188 let starting_position = match auto_flow.is_dense() {
189 true => primary_axis_grid_start_line,
190 false => cell_occupancy_matrix
191 .last_of_type(primary_axis, secondary_axis_placement.start, CellOccupancyState::AutoPlaced)
192 .unwrap_or(primary_axis_grid_start_line),
193 };
194
195 let mut position: OriginZeroLine = starting_position;
196 loop {
197 let primary_axis_placement = placement.get(primary_axis).resolve_indefinite_grid_tracks(position);
198
199 let does_fit = cell_occupancy_matrix.line_area_is_unoccupied(
200 primary_axis,
201 primary_axis_placement,
202 secondary_axis_placement,
203 );
204
205 if does_fit {
206 return (primary_axis_placement, secondary_axis_placement);
207 } else {
208 position += 1;
209 }
210 }
211}
212
213fn place_indefinitely_positioned_item(
216 cell_occupancy_matrix: &CellOccupancyMatrix,
217 placement: InBothAbsAxis<Line<OriginZeroGridPlacement>>,
218 auto_flow: GridAutoFlow,
219 grid_position: (OriginZeroLine, OriginZeroLine),
220) -> (Line<OriginZeroLine>, Line<OriginZeroLine>) {
221 let primary_axis = auto_flow.primary_axis();
222
223 let primary_placement_style = placement.get(primary_axis);
224 let secondary_placement_style = placement.get(primary_axis.other_axis());
225
226 let primary_span = primary_placement_style.indefinite_span();
227 let secondary_span = secondary_placement_style.indefinite_span();
228 let has_definite_primary_axis_position = primary_placement_style.is_definite();
229 let primary_axis_grid_start_line = cell_occupancy_matrix.track_counts(primary_axis).implicit_start_line();
230 let primary_axis_grid_end_line = cell_occupancy_matrix.track_counts(primary_axis).implicit_end_line();
231 let secondary_axis_grid_start_line =
232 cell_occupancy_matrix.track_counts(primary_axis.other_axis()).implicit_start_line();
233
234 let line_area_is_occupied = |primary_span, secondary_span| {
235 !cell_occupancy_matrix.line_area_is_unoccupied(primary_axis, primary_span, secondary_span)
236 };
237
238 let (mut primary_idx, mut secondary_idx) = grid_position;
239
240 if has_definite_primary_axis_position {
241 let definite_primary_placement = primary_placement_style.resolve_definite_grid_lines();
242 let defined_primary_idx = definite_primary_placement.start;
243
244 if defined_primary_idx < primary_idx && secondary_idx != secondary_axis_grid_start_line {
246 secondary_idx = secondary_axis_grid_start_line;
247 primary_idx = defined_primary_idx + 1;
248 } else {
249 primary_idx = defined_primary_idx;
250 }
251
252 loop {
255 let primary_span = Line { start: primary_idx, end: primary_idx + primary_span };
256 let secondary_span = Line { start: secondary_idx, end: secondary_idx + secondary_span };
257
258 if line_area_is_occupied(primary_span, secondary_span) {
260 secondary_idx += 1;
261 continue;
262 }
263
264 return (primary_span, secondary_span);
266 }
267 } else {
268 loop {
272 let primary_span = Line { start: primary_idx, end: primary_idx + primary_span };
273 let secondary_span = Line { start: secondary_idx, end: secondary_idx + secondary_span };
274
275 let primary_out_of_bounds = primary_span.end > primary_axis_grid_end_line;
278 if primary_out_of_bounds {
279 secondary_idx += 1;
280 primary_idx = primary_axis_grid_start_line;
281 continue;
282 }
283
284 if line_area_is_occupied(primary_span, secondary_span) {
286 primary_idx += 1;
287 continue;
288 }
289
290 return (primary_span, secondary_span);
292 }
293 }
294}
295
296#[allow(clippy::too_many_arguments)]
299fn record_grid_placement(
300 cell_occupancy_matrix: &mut CellOccupancyMatrix,
301 items: &mut Vec<GridItem>,
302 node: NodeId,
303 index: usize,
304 style: &Style,
305 parent_align_items: AlignItems,
306 parent_justify_items: AlignItems,
307 primary_axis: AbsoluteAxis,
308 primary_span: Line<OriginZeroLine>,
309 secondary_span: Line<OriginZeroLine>,
310 placement_type: CellOccupancyState,
311) {
312 #[cfg(test)]
313 println!("BEFORE placement:");
314 #[cfg(test)]
315 println!("{cell_occupancy_matrix:?}");
316
317 cell_occupancy_matrix.mark_area_as(primary_axis, primary_span, secondary_span, placement_type);
319
320 let (col_span, row_span) = match primary_axis {
322 AbsoluteAxis::Horizontal => (primary_span, secondary_span),
323 AbsoluteAxis::Vertical => (secondary_span, primary_span),
324 };
325 items.push(GridItem::new_with_placement_style_and_order(
326 node,
327 col_span,
328 row_span,
329 style,
330 parent_align_items,
331 parent_justify_items,
332 index as u16,
333 ));
334
335 #[cfg(test)]
336 println!("AFTER placement:");
337 #[cfg(test)]
338 println!("{cell_occupancy_matrix:?}");
339 #[cfg(test)]
340 println!("\n");
341}
342
343#[allow(clippy::bool_assert_comparison)]
344#[cfg(test)]
345mod tests {
346 #![allow(clippy::redundant_clone)]
348
349 mod test_placement_algorithm {
350 use crate::compute::grid::implicit_grid::compute_grid_size_estimate;
351 use crate::compute::grid::types::TrackCounts;
352 use crate::compute::grid::util::*;
353 use crate::compute::grid::CellOccupancyMatrix;
354 use crate::prelude::*;
355 use crate::style::GridAutoFlow;
356
357 use super::super::place_grid_items;
358
359 type ExpectedPlacement = (i16, i16, i16, i16);
360
361 fn placement_test_runner(
362 explicit_col_count: u16,
363 explicit_row_count: u16,
364 children: Vec<(usize, Style, ExpectedPlacement)>,
365 expected_col_counts: TrackCounts,
366 expected_row_counts: TrackCounts,
367 flow: GridAutoFlow,
368 ) {
369 let children_iter = || children.iter().map(|(index, style, _)| (*index, NodeId::from(*index), style));
371 let child_styles_iter = children.iter().map(|(_, style, _)| style);
372 let estimated_sizes = compute_grid_size_estimate(explicit_col_count, explicit_row_count, child_styles_iter);
373 let mut items = Vec::new();
374 let mut cell_occupancy_matrix =
375 CellOccupancyMatrix::with_track_counts(estimated_sizes.0, estimated_sizes.1);
376
377 place_grid_items(
379 &mut cell_occupancy_matrix,
380 &mut items,
381 children_iter,
382 flow,
383 AlignSelf::Start,
384 AlignSelf::Start,
385 );
386
387 let mut sorted_children = children.clone();
389 sorted_children.sort_by_key(|child| child.0);
390 for (idx, ((id, _style, expected_placement), item)) in sorted_children.iter().zip(items.iter()).enumerate()
391 {
392 assert_eq!(item.node, NodeId::from(*id));
393 let actual_placement = (item.column.start, item.column.end, item.row.start, item.row.end);
394 assert_eq!(actual_placement, (*expected_placement).into_oz(), "Item {idx} (0-indexed)");
395 }
396
397 let actual_row_counts = *cell_occupancy_matrix.track_counts(crate::compute::grid::AbsoluteAxis::Vertical);
399 assert_eq!(actual_row_counts, expected_row_counts, "row track counts");
400 let actual_col_counts = *cell_occupancy_matrix.track_counts(crate::compute::grid::AbsoluteAxis::Horizontal);
401 assert_eq!(actual_col_counts, expected_col_counts, "column track counts");
402 }
403
404 #[test]
405 fn test_only_fixed_placement() {
406 let flow = GridAutoFlow::Row;
407 let explicit_col_count = 2;
408 let explicit_row_count = 2;
409 let children = {
410 vec![
411 (1, (line(1), auto(), line(1), auto()).into_grid_child(), (0, 1, 0, 1)),
413 (2, (line(-4), auto(), line(-3), auto()).into_grid_child(), (-1, 0, 0, 1)),
414 (3, (line(-3), auto(), line(-4), auto()).into_grid_child(), (0, 1, -1, 0)),
415 (4, (line(3), span(2), line(5), auto()).into_grid_child(), (2, 4, 4, 5)),
416 ]
417 };
418 let expected_cols = TrackCounts { negative_implicit: 1, explicit: 2, positive_implicit: 2 };
419 let expected_rows = TrackCounts { negative_implicit: 1, explicit: 2, positive_implicit: 3 };
420 placement_test_runner(explicit_col_count, explicit_row_count, children, expected_cols, expected_rows, flow);
421 }
422
423 #[test]
424 fn test_placement_spanning_origin() {
425 let flow = GridAutoFlow::Row;
426 let explicit_col_count = 2;
427 let explicit_row_count = 2;
428 let children = {
429 vec![
430 (1, (line(-1), line(-1), line(-1), line(-1)).into_grid_child(), (2, 3, 2, 3)),
432 (2, (line(-1), span(2), line(-1), span(2)).into_grid_child(), (2, 4, 2, 4)),
433 (3, (line(-4), line(-4), line(-4), line(-4)).into_grid_child(), (-1, 0, -1, 0)),
434 (4, (line(-4), span(2), line(-4), span(2)).into_grid_child(), (-1, 1, -1, 1)),
435 ]
436 };
437 let expected_cols = TrackCounts { negative_implicit: 1, explicit: 2, positive_implicit: 2 };
438 let expected_rows = TrackCounts { negative_implicit: 1, explicit: 2, positive_implicit: 2 };
439 placement_test_runner(explicit_col_count, explicit_row_count, children, expected_cols, expected_rows, flow);
440 }
441
442 #[test]
443 fn test_only_auto_placement_row_flow() {
444 let flow = GridAutoFlow::Row;
445 let explicit_col_count = 2;
446 let explicit_row_count = 2;
447 let children = {
448 let auto_child = (auto(), auto(), auto(), auto()).into_grid_child();
449 vec![
450 (1, auto_child.clone(), (0, 1, 0, 1)),
452 (2, auto_child.clone(), (1, 2, 0, 1)),
453 (3, auto_child.clone(), (0, 1, 1, 2)),
454 (4, auto_child.clone(), (1, 2, 1, 2)),
455 (5, auto_child.clone(), (0, 1, 2, 3)),
456 (6, auto_child.clone(), (1, 2, 2, 3)),
457 (7, auto_child.clone(), (0, 1, 3, 4)),
458 (8, auto_child.clone(), (1, 2, 3, 4)),
459 ]
460 };
461 let expected_cols = TrackCounts { negative_implicit: 0, explicit: 2, positive_implicit: 0 };
462 let expected_rows = TrackCounts { negative_implicit: 0, explicit: 2, positive_implicit: 2 };
463 placement_test_runner(explicit_col_count, explicit_row_count, children, expected_cols, expected_rows, flow);
464 }
465
466 #[test]
467 fn test_only_auto_placement_column_flow() {
468 let flow = GridAutoFlow::Column;
469 let explicit_col_count = 2;
470 let explicit_row_count = 2;
471 let children = {
472 let auto_child = (auto(), auto(), auto(), auto()).into_grid_child();
473 vec![
474 (1, auto_child.clone(), (0, 1, 0, 1)),
476 (2, auto_child.clone(), (0, 1, 1, 2)),
477 (3, auto_child.clone(), (1, 2, 0, 1)),
478 (4, auto_child.clone(), (1, 2, 1, 2)),
479 (5, auto_child.clone(), (2, 3, 0, 1)),
480 (6, auto_child.clone(), (2, 3, 1, 2)),
481 (7, auto_child.clone(), (3, 4, 0, 1)),
482 (8, auto_child.clone(), (3, 4, 1, 2)),
483 ]
484 };
485 let expected_cols = TrackCounts { negative_implicit: 0, explicit: 2, positive_implicit: 2 };
486 let expected_rows = TrackCounts { negative_implicit: 0, explicit: 2, positive_implicit: 0 };
487 placement_test_runner(explicit_col_count, explicit_row_count, children, expected_cols, expected_rows, flow);
488 }
489
490 #[test]
491 fn test_oversized_item() {
492 let flow = GridAutoFlow::Row;
493 let explicit_col_count = 2;
494 let explicit_row_count = 2;
495 let children = {
496 vec![
497 (1, (span(5), auto(), auto(), auto()).into_grid_child(), (0, 5, 0, 1)),
499 ]
500 };
501 let expected_cols = TrackCounts { negative_implicit: 0, explicit: 2, positive_implicit: 3 };
502 let expected_rows = TrackCounts { negative_implicit: 0, explicit: 2, positive_implicit: 0 };
503 placement_test_runner(explicit_col_count, explicit_row_count, children, expected_cols, expected_rows, flow);
504 }
505
506 #[test]
507 fn test_fixed_in_secondary_axis() {
508 let flow = GridAutoFlow::Row;
509 let explicit_col_count = 2;
510 let explicit_row_count = 2;
511 let children = {
512 vec![
513 (1, (span(2), auto(), line(1), auto()).into_grid_child(), (0, 2, 0, 1)),
515 (2, (auto(), auto(), line(2), auto()).into_grid_child(), (0, 1, 1, 2)),
516 (3, (auto(), auto(), line(1), auto()).into_grid_child(), (2, 3, 0, 1)),
517 (4, (auto(), auto(), line(4), auto()).into_grid_child(), (0, 1, 3, 4)),
518 ]
519 };
520 let expected_cols = TrackCounts { negative_implicit: 0, explicit: 2, positive_implicit: 1 };
521 let expected_rows = TrackCounts { negative_implicit: 0, explicit: 2, positive_implicit: 2 };
522 placement_test_runner(explicit_col_count, explicit_row_count, children, expected_cols, expected_rows, flow);
523 }
524
525 #[test]
526 fn test_definite_in_secondary_axis_with_fully_definite_negative() {
527 let flow = GridAutoFlow::Row;
528 let explicit_col_count = 2;
529 let explicit_row_count = 2;
530 let children = {
531 vec![
532 (2, (auto(), auto(), line(2), auto()).into_grid_child(), (0, 1, 1, 2)),
534 (1, (line(-4), auto(), line(2), auto()).into_grid_child(), (-1, 0, 1, 2)),
535 (3, (auto(), auto(), line(1), auto()).into_grid_child(), (-1, 0, 0, 1)),
536 ]
537 };
538 let expected_cols = TrackCounts { negative_implicit: 1, explicit: 2, positive_implicit: 0 };
539 let expected_rows = TrackCounts { negative_implicit: 0, explicit: 2, positive_implicit: 0 };
540 placement_test_runner(explicit_col_count, explicit_row_count, children, expected_cols, expected_rows, flow);
541 }
542
543 #[test]
544 fn test_dense_packing_algorithm() {
545 let flow = GridAutoFlow::RowDense;
546 let explicit_col_count = 4;
547 let explicit_row_count = 4;
548 let children = {
549 vec![
550 (1, (line(2), auto(), line(1), auto()).into_grid_child(), (1, 2, 0, 1)), (2, (span(2), auto(), auto(), auto()).into_grid_child(), (2, 4, 0, 1)), (3, (auto(), auto(), auto(), auto()).into_grid_child(), (0, 1, 0, 1)), ]
555 };
556 let expected_cols = TrackCounts { negative_implicit: 0, explicit: 4, positive_implicit: 0 };
557 let expected_rows = TrackCounts { negative_implicit: 0, explicit: 4, positive_implicit: 0 };
558 placement_test_runner(explicit_col_count, explicit_row_count, children, expected_cols, expected_rows, flow);
559 }
560
561 #[test]
562 fn test_sparse_packing_algorithm() {
563 let flow = GridAutoFlow::Row;
564 let explicit_col_count = 4;
565 let explicit_row_count = 4;
566 let children = {
567 vec![
568 (1, (auto(), span(3), auto(), auto()).into_grid_child(), (0, 3, 0, 1)), (2, (auto(), span(3), auto(), auto()).into_grid_child(), (0, 3, 1, 2)), (3, (auto(), span(1), auto(), auto()).into_grid_child(), (3, 4, 1, 2)), ]
573 };
574 let expected_cols = TrackCounts { negative_implicit: 0, explicit: 4, positive_implicit: 0 };
575 let expected_rows = TrackCounts { negative_implicit: 0, explicit: 4, positive_implicit: 0 };
576 placement_test_runner(explicit_col_count, explicit_row_count, children, expected_cols, expected_rows, flow);
577 }
578
579 #[test]
580 fn test_auto_placement_in_negative_tracks() {
581 let flow = GridAutoFlow::RowDense;
582 let explicit_col_count = 2;
583 let explicit_row_count = 2;
584 let children = {
585 vec![
586 (1, (line(-5), auto(), line(1), auto()).into_grid_child(), (-2, -1, 0, 1)), (2, (auto(), auto(), line(2), auto()).into_grid_child(), (-2, -1, 1, 2)), (3, (auto(), auto(), auto(), auto()).into_grid_child(), (-1, 0, 0, 1)), ]
591 };
592 let expected_cols = TrackCounts { negative_implicit: 2, explicit: 2, positive_implicit: 0 };
593 let expected_rows = TrackCounts { negative_implicit: 0, explicit: 2, positive_implicit: 0 };
594 placement_test_runner(explicit_col_count, explicit_row_count, children, expected_cols, expected_rows, flow);
595 }
596 }
597}