7#include "box_constraints.hpp"
8#include "box_shape.hpp"
10#include "../geometry/module.hpp"
11#include "../utility/module.hpp"
19namespace hi {
inline namespace v1 {
26 size_t first_column = 0;
28 size_t last_column = 0;
30 bool beyond_maximum =
false;
31 value_type value = {};
46 std::convertible_to<value_type>
auto&& value) noexcept :
47 first_column(first_column),
49 last_column(last_column),
51 beyond_maximum(beyond_maximum),
58 constexpr void set_constraints(
box_constraints const& constraints)
noexcept
60 _constraints = constraints;
63 template<hi::axis Axis>
64 [[nodiscard]]
constexpr size_t first()
const noexcept
66 if constexpr (Axis == axis::x) {
68 }
else if constexpr (Axis == axis::y) {
75 template<hi::axis Axis>
76 [[nodiscard]]
constexpr size_t last()
const noexcept
78 if constexpr (Axis == axis::x) {
80 }
else if constexpr (Axis == axis::y) {
87 template<hi::axis Axis>
88 [[nodiscard]]
constexpr size_t span()
const noexcept
90 hi_axiom(first<Axis>() < last<Axis>());
91 return last<Axis>() - first<Axis>();
94 template<hi::axis Axis>
95 [[nodiscard]]
constexpr auto alignment()
const noexcept
97 if constexpr (Axis == axis::x) {
98 return _constraints.alignment.horizontal();
99 }
else if constexpr (Axis == axis::y) {
100 return _constraints.alignment.vertical();
106 template<hi::axis Axis>
107 [[nodiscard]]
constexpr int minimum()
const noexcept
109 if constexpr (Axis == axis::x) {
110 return _constraints.minimum.
width();
111 }
else if constexpr (Axis == axis::y) {
112 return _constraints.minimum.
height();
118 template<hi::axis Axis>
119 [[nodiscard]]
constexpr int preferred()
const noexcept
121 if constexpr (Axis == axis::x) {
122 return _constraints.preferred.
width();
123 }
else if constexpr (Axis == axis::y) {
124 return _constraints.preferred.
height();
130 template<hi::axis Axis>
131 [[nodiscard]]
constexpr int maximum()
const noexcept
133 if constexpr (Axis == axis::x) {
134 return _constraints.maximum.
width();
135 }
else if constexpr (Axis == axis::y) {
136 return _constraints.maximum.
height();
142 template<hi::axis Axis>
143 [[nodiscard]]
constexpr int margin_before(
bool forward)
const noexcept
145 if constexpr (Axis == axis::x) {
147 return _constraints.margins.left();
149 return _constraints.margins.right();
151 }
else if constexpr (Axis == axis::y) {
153 return _constraints.margins.bottom();
155 return _constraints.margins.top();
162 template<hi::axis Axis>
163 [[nodiscard]]
constexpr int margin_after(
bool forward)
const noexcept
165 if constexpr (Axis == axis::x) {
167 return _constraints.margins.right();
169 return _constraints.margins.left();
171 }
else if constexpr (Axis == axis::y) {
173 return _constraints.margins.top();
175 return _constraints.margins.bottom();
182 template<hi::axis Axis>
183 [[nodiscard]]
constexpr int padding_before(
bool forward)
const noexcept
185 if constexpr (Axis == axis::x) {
187 return _constraints.padding.left();
189 return _constraints.padding.right();
191 }
else if constexpr (Axis == axis::y) {
193 return _constraints.padding.bottom();
195 return _constraints.padding.top();
202 template<hi::axis Axis>
203 [[nodiscard]]
constexpr int padding_after(
bool forward)
const noexcept
205 if constexpr (Axis == axis::x) {
207 return _constraints.padding.right();
209 return _constraints.padding.left();
211 }
else if constexpr (Axis == axis::y) {
213 return _constraints.padding.top();
215 return _constraints.padding.bottom();
226template<hi::axis Axis,
typename T>
231 using value_type = T;
232 using alignment_type = std::conditional_t<axis == axis::y, vertical_alignment, horizontal_alignment>;
292 using iterator = constraint_vector::iterator;
293 using const_iterator = constraint_vector::const_iterator;
294 using reverse_iterator = constraint_vector::reverse_iterator;
295 using reference = constraint_vector::reference;
296 using const_reference = constraint_vector::const_reference;
304 [[nodiscard]] constexpr friend
bool
315 _constraints(num), _forward(forward)
317 for (
hilet& cell : cells) {
318 construct_simple_cell(cell);
322 for (
hilet& cell : cells) {
323 construct_span_cell(cell);
328 [[nodiscard]]
constexpr int margin_before() const noexcept
330 return empty() ? 0 : _forward ?
front().margin_before :
back().margin_before;
333 [[nodiscard]]
constexpr int margin_after() const noexcept
335 return empty() ? 0 : _forward ?
back().margin_after :
front().margin_after;
338 [[nodiscard]]
constexpr int padding_before() const noexcept
340 return empty() ? 0 : _forward ?
front().padding_before :
back().padding_before;
343 [[nodiscard]]
constexpr int padding_after() const noexcept
345 return empty() ? 0 : _forward ?
back().padding_after :
front().padding_after;
365 [[nodiscard]]
constexpr int position(cell_type
const& cell)
const noexcept
367 return position(cell.first<
axis>(), cell.last<
axis>());
370 [[nodiscard]]
constexpr int extent(cell_type
const& cell)
const noexcept
372 return extent(cell.first<
axis>(), cell.last<
axis>());
375 [[nodiscard]]
constexpr std::optional<int> guideline(cell_type
const& cell)
const noexcept
377 if (cell.span<
axis>() == 1) {
378 return guideline(cell.first<
axis>());
406 constexpr void layout(
int new_position,
int new_extent, std::optional<int> external_guideline,
int guideline_width)
noexcept
409 for (
auto& constraint : _constraints) {
410 constraint.extent = constraint.preferred;
414 auto [total_extent, count] = layout_shrink(
begin(),
end());
415 while (total_extent > new_extent and count != 0) {
417 std::tie(total_extent, count) = layout_shrink(
begin(),
end(), total_extent - new_extent, count);
422 while (total_extent < new_extent and count != 0) {
424 std::tie(total_extent, count) = layout_expand(
begin(),
end(), new_extent - total_extent, count);
428 if (total_extent < new_extent) {
431 return item.beyond_maximum;
434 hilet todo = new_extent - total_extent;
435 hilet per_extent = narrow_cast<int>((todo + count - 1) / count);
436 for (
auto& constraint : _constraints) {
437 if (constraint.beyond_maximum) {
438 constraint.extent += per_extent;
446 if (total_extent < new_extent and not
empty()) {
448 front().extent += new_extent - total_extent;
452 layout_position(
begin(),
end(), new_position, guideline_width);
454 layout_position(
rbegin(),
rend(), new_position, guideline_width);
457 if (external_guideline and
size() == 1) {
460 front().guideline = *external_guideline;
466 [[nodiscard]]
constexpr size_t size() const noexcept
468 return _constraints.
size();
473 [[nodiscard]]
constexpr bool empty() const noexcept
475 return _constraints.
empty();
480 [[nodiscard]]
constexpr iterator
begin() noexcept
482 return _constraints.
begin();
487 [[nodiscard]]
constexpr const_iterator
begin() const noexcept
489 return _constraints.
begin();
494 [[nodiscard]]
constexpr const_iterator
cbegin() const noexcept
496 return _constraints.
cbegin();
501 [[nodiscard]]
constexpr iterator
end() noexcept
503 return _constraints.
end();
508 [[nodiscard]]
constexpr const_iterator
end() const noexcept
510 return _constraints.
end();
515 [[nodiscard]]
constexpr const_iterator
cend() const noexcept
517 return _constraints.
cend();
522 [[nodiscard]]
constexpr reverse_iterator
rbegin() noexcept
524 return _constraints.
rbegin();
529 [[nodiscard]]
constexpr reverse_iterator
rend() noexcept
531 return _constraints.
rend();
540 [[nodiscard]]
constexpr reference
operator[](
size_t index)
noexcept
543 return _constraints[index];
552 [[nodiscard]]
constexpr const_reference
operator[](
size_t index)
const noexcept
555 return _constraints[index];
563 [[nodiscard]]
constexpr reference
front() noexcept
566 return _constraints.
front();
574 [[nodiscard]]
constexpr const_reference
front() const noexcept
577 return _constraints.
front();
585 [[nodiscard]]
constexpr reference
back() noexcept
588 return _constraints.
back();
596 [[nodiscard]]
constexpr const_reference
back() const noexcept
599 return _constraints.
back();
611 constraint_vector _constraints = {};
615 bool _forward =
true;
634 layout_shrink(const_iterator first, const_iterator last,
int extra = 0,
size_t count = 1) noexcept
641 hilet extra_per = narrow_cast<int>((extra + count - 1) / count);
644 auto new_count = 0_uz;
645 for (
auto it = first_; it != last_; ++it) {
646 it->extent = it->extent -
std::max(extra_per, it->extent - it->minimum);
649 new_extent += it->margin_before;
651 new_extent += it->extent;
653 if (it->extent > it->minimum) {
658 return {new_extent, new_count};
678 layout_expand(const_iterator first, const_iterator last,
int extra = 0,
size_t count = 1) noexcept
685 hilet extra_per = narrow_cast<int>((extra + count - 1) / count);
688 auto new_count = 0_uz;
689 for (
auto it = first_; it != last_; ++it) {
690 it->extent = it->extent +
std::min(extra_per, it->maximum - it->extent);
693 new_extent += it->margin_before;
695 new_extent += it->extent;
697 if (it->extent < it->maximum) {
702 return {new_extent, new_count};
705 constexpr void layout_position(
auto first,
auto last,
int start_position,
int guideline_width)
noexcept
707 auto position = start_position;
708 for (
auto it = first; it != last; ++it) {
709 it->position = position;
711 it->alignment, position, position + it->extent, it->padding_before, it->padding_after, guideline_width);
713 position += it->extent;
714 position += it->margin_after;
725 constexpr void construct_simple_cell(cell_type
const& cell)
noexcept
727 inplace_max(_constraints[cell.first<axis>()].margin_before, cell.margin_before<axis>(_forward));
728 inplace_max(_constraints[cell.last<axis>() - 1].margin_after, cell.margin_after<axis>(_forward));
729 inplace_max(_constraints[cell.first<axis>()].padding_before, cell.padding_before<axis>(_forward));
730 inplace_max(_constraints[cell.last<axis>() - 1].padding_after, cell.padding_after<axis>(_forward));
732 for (
auto i = cell.first<axis>(); i != cell.last<
axis>(); ++i) {
733 _constraints[i].beyond_maximum |= cell.beyond_maximum;
736 if (cell.span<axis>() == 1) {
737 inplace_max(_constraints[cell.first<axis>()].alignment, cell.alignment<axis>());
738 inplace_max(_constraints[cell.first<axis>()].minimum, cell.minimum<axis>());
739 inplace_max(_constraints[cell.first<axis>()].preferred, cell.preferred<axis>());
740 inplace_min(_constraints[cell.first<axis>()].maximum, cell.maximum<axis>());
750 constexpr void construct_span_cell(cell_type
const& cell)
noexcept
752 auto num_cells = narrow_cast<int>(cell.span<axis>());
754 if (cell.span<axis>() > 1) {
756 if (
hilet extra = cell.minimum<axis>() - span_minimum; extra > 0) {
757 hilet extra_per_cell = (extra + num_cells - 1) / num_cells;
758 for (
auto i = cell.first<axis>(); i != cell.last<
axis>(); ++i) {
759 _constraints[i].minimum += extra_per_cell;
763 if (
hilet extra = cell.preferred<axis>() - span_preferred; extra > 0) {
764 hilet extra_per_cell = (extra + num_cells - 1) / num_cells;
765 for (
auto i = cell.first<axis>(); i != cell.last<
axis>(); ++i) {
766 _constraints[i].preferred += extra_per_cell;
770 if (
hilet extra = cell.maximum<axis>() - span_preferred; extra < 0) {
771 hilet extra_per_cell = (extra + num_cells) / num_cells;
772 for (
auto i = cell.first<axis>(); i != cell.last<
axis>(); ++i) {
774 _constraints[i].maximum += extra_per_cell;
784 constexpr void construct_fixup() noexcept
786 for (
auto it =
begin(); it !=
end(); ++it) {
788 if (it + 1 !=
end()) {
789 it->margin_after = (it + 1)->margin_before =
std::max(it->margin_after, (it + 1)->margin_before);
793 inplace_max(it->preferred, it->minimum);
794 inplace_max(it->maximum, it->preferred);
797 if (it->padding_before + it->padding_after > it->minimum) {
798 hilet padding_diff = it->padding_after - it->padding_before;
799 hilet middle = std::clamp(it->minimum / 2 + padding_diff, 0, it->minimum);
800 it->padding_after =
middle;
801 it->padding_before = it->minimum -
middle;
817 auto r_preferred = 0;
822 r_minimum = first->minimum;
823 r_preferred = first->preferred;
824 r_maximum = first->maximum;
825 for (
auto it = first + 1; it != last; ++it) {
826 r_margin += it->margin_before;
827 r_minimum += it->minimum;
828 r_preferred += it->preferred;
829 r_maximum += it->maximum;
832 return {r_minimum + r_margin, r_preferred + r_margin, r_maximum + r_margin};
857 [[nodiscard]]
constexpr int position(const_iterator first, const_iterator last)
const noexcept
861 return first->position;
863 return (last - 1)->position;
874 [[nodiscard]]
constexpr int position(
size_t first,
size_t last)
const noexcept
888 [[nodiscard]]
constexpr int extent(const_iterator first, const_iterator last)
const noexcept
893 for (
auto it = first + 1; it != last; ++it) {
894 r += it->margin_before;
908 [[nodiscard]]
constexpr int extent(
size_t first,
size_t last)
const noexcept
915 [[nodiscard]]
constexpr std::optional<int> guideline(const_iterator it)
const noexcept
917 return it->guideline;
920 [[nodiscard]]
constexpr std::optional<int> guideline(
size_t i)
const noexcept
922 return guideline(
cbegin() + i);
936 using value_type = T;
938 using cell_type = detail::grid_layout_cell<value_type>;
940 using iterator = cell_vector::iterator;
941 using const_iterator = cell_vector::const_iterator;
942 using reference = cell_vector::reference;
943 using const_reference = cell_vector::const_reference;
951 [[nodiscard]]
constexpr friend bool operator==(
grid_layout const&,
grid_layout const&)
noexcept =
default;
953 [[nodiscard]]
constexpr bool empty()
const noexcept
955 return _cells.
empty();
958 [[nodiscard]]
constexpr size_t size()
const noexcept
960 return _cells.
size();
963 [[nodiscard]]
constexpr size_t num_columns()
const noexcept
968 [[nodiscard]]
constexpr size_t num_rows()
const noexcept
973 [[nodiscard]]
constexpr iterator begin()
noexcept
975 return _cells.
begin();
978 [[nodiscard]]
constexpr iterator end()
noexcept
983 [[nodiscard]]
constexpr const_iterator begin()
const noexcept
985 return _cells.
begin();
988 [[nodiscard]]
constexpr const_iterator end()
const noexcept
993 [[nodiscard]]
constexpr const_iterator cbegin()
const noexcept
998 [[nodiscard]]
constexpr const_iterator cend()
const noexcept
1000 return _cells.
cend();
1003 [[nodiscard]]
constexpr const_reference operator[](
size_t i)
const noexcept
1008 [[nodiscard]]
constexpr reference operator[](
size_t i)
noexcept
1021 [[nodiscard]]
constexpr bool cell_in_use(
size_t first_column,
size_t first_row,
size_t last_column,
size_t last_row)
noexcept
1024 hi_axiom(first_column < last_column);
1027 for (
hilet& cell : _cells) {
1028 if (first_column >= cell.last_column) {
1031 if (last_column <= cell.first_column) {
1034 if (first_row >= cell.last_row) {
1037 if (last_row <= cell.first_row) {
1055 template<forward_of<value_type> Value>
1057 size_t first_column,
1062 bool beyond_maximum =
false) noexcept
1068 auto& r = _cells.
emplace_back(first_column, first_row, last_column, last_row, beyond_maximum, std::forward<Value>(value));
1069 update_after_insert_or_delete();
1081 template<forward_of<value_type> Value>
1082 constexpr reference
add_cell(
size_t column,
size_t row, Value&& value,
bool beyond_maximum =
false) noexcept
1084 return add_cell(column, row, column + 1, row + 1, std::forward<Value>(value), beyond_maximum);
1087 constexpr void clear() noexcept
1090 update_after_insert_or_delete();
1093 [[nodiscard]]
constexpr box_constraints constraints(
bool left_to_right)
const noexcept
1096 _row_constraints = {_cells, num_rows(),
false};
1097 _column_constraints = {_cells, num_columns(), left_to_right};
1099 auto r = box_constraints{};
1100 std::tie(r.minimum.width(), r.preferred.width(), r.maximum.width()) = _column_constraints.update_constraints();
1101 r.margins.left() = _column_constraints.margin_before();
1102 r.margins.right() = _column_constraints.margin_after();
1103 r.padding.left() = _column_constraints.padding_before();
1104 r.padding.right() = _column_constraints.padding_after();
1106 std::tie(r.minimum.height(), r.preferred.height(), r.maximum.height()) = _row_constraints.update_constraints();
1107 r.margins.bottom() = _row_constraints.margin_after();
1108 r.margins.top() = _row_constraints.margin_before();
1109 r.padding.bottom() = _row_constraints.padding_after();
1110 r.padding.top() = _row_constraints.padding_before();
1113 if (num_rows() == 1 and num_columns() == 1) {
1114 return hi::alignment{_column_constraints.
front().alignment, _row_constraints.
front().alignment};
1115 }
else if (num_rows() == 1) {
1116 return hi::alignment{_row_constraints.
front().alignment};
1117 }
else if (num_columns() == 1) {
1118 return hi::alignment{_column_constraints.
front().alignment};
1120 return hi::alignment{};
1135 _column_constraints.
layout(shape.x(), shape.width(), shape.centerline, 0);
1136 _row_constraints.
layout(shape.y(), shape.height(), shape.baseline, baseline_adjustment);
1139 for (
auto& cell : _cells) {
1140 cell.shape.rectangle = {
1141 _column_constraints.position(cell),
1142 _row_constraints.position(cell),
1143 _column_constraints.extent(cell),
1144 _row_constraints.extent(cell)};
1145 cell.shape.centerline = _column_constraints.guideline(cell);
1146 cell.shape.baseline = _row_constraints.guideline(cell);
1151 cell_vector _cells = {};
1152 size_t _num_rows = 0;
1153 size_t _num_columns = 0;
1154 mutable detail::grid_layout_axis_constraints<axis::y, value_type> _row_constraints = {};
1155 mutable detail::grid_layout_axis_constraints<axis::x, value_type> _column_constraints = {};
1161 constexpr void sort_cells() noexcept
1163 std::sort(_cells.begin(), _cells.end(), [](cell_type
const& lhs, cell_type
const& rhs) {
1164 if (lhs.first_row != rhs.first_row) {
1165 return lhs.first_row < rhs.first_row;
1167 return lhs.first_column < rhs.first_column;
1174 constexpr void update_after_insert_or_delete() noexcept
1180 for (
hilet& cell : _cells) {
1181 inplace_max(_num_rows, cell.last_row);
1182 inplace_max(_num_columns, cell.last_column);
Utilities for parsing spreadsheet addresses.
#define hi_static_no_default(...)
This part of the code should not be reachable, unless a programming bug.
Definition assert.hpp:308
#define hi_assert(expression,...)
Assert if expression is true.
Definition assert.hpp:184
#define hi_axiom(expression,...)
Specify an axiom; an expression that is true.
Definition assert.hpp:238
#define hilet
Invariant should be the default for variables.
Definition utility.hpp:23
#define hi_forward(x)
Forward a value, based on the decltype of the value.
Definition utility.hpp:29
constexpr std::optional< T > make_guideline(vertical_alignment alignment, T bottom, T top, T padding_bottom, T padding_top, T guideline_width)
Create a guideline between two points.
Definition alignment.hpp:59
axis
An enumeration of the 3 axis for 3D geometry.
Definition axis.hpp:18
@ middle
Align to the vertical-middle.
DOXYGEN BUG.
Definition algorithm.hpp:13
geometry/margins.hpp
Definition cache.hpp:11
constexpr value_type & width() noexcept
Access the x-as-width element from the extent.
Definition extent.hpp:166
constexpr value_type & height() noexcept
Access the y-as-height element from the extent.
Definition extent.hpp:177
2D constraints.
Definition box_constraints.hpp:22
Definition box_shape.hpp:15
Definition grid_layout.hpp:23
Definition grid_layout.hpp:227
constexpr reference operator[](size_t index) noexcept
Get element.
Definition grid_layout.hpp:540
constexpr size_t size() const noexcept
Number of cell on this axis.
Definition grid_layout.hpp:466
constexpr void layout(int new_position, int new_extent, std::optional< int > external_guideline, int guideline_width) noexcept
Layout each cell along an axis.
Definition grid_layout.hpp:406
constexpr const_reference back() const noexcept
Get the last element.
Definition grid_layout.hpp:596
constexpr std::tuple< int, int, int > constraints(cell_type const &cell) const noexcept
Get the minimum, preferred, maximum size of the span.
Definition grid_layout.hpp:360
constexpr bool empty() const noexcept
Check if this axis is empty.
Definition grid_layout.hpp:473
constexpr reference front() noexcept
Get the first element.
Definition grid_layout.hpp:563
constexpr reverse_iterator rend() noexcept
Iterator to the first cell on this axis.
Definition grid_layout.hpp:529
constexpr reverse_iterator rbegin() noexcept
Iterator to the first cell on this axis.
Definition grid_layout.hpp:522
constexpr reference back() noexcept
Get the last element.
Definition grid_layout.hpp:585
constexpr const_iterator end() const noexcept
Iterator to beyond the last cell on this axis.
Definition grid_layout.hpp:508
constexpr const_reference operator[](size_t index) const noexcept
Get element.
Definition grid_layout.hpp:552
constexpr const_iterator cbegin() const noexcept
Iterator to the first cell on this axis.
Definition grid_layout.hpp:494
constexpr iterator end() noexcept
Iterator to beyond the last cell on this axis.
Definition grid_layout.hpp:501
constexpr const_iterator begin() const noexcept
Iterator to the first cell on this axis.
Definition grid_layout.hpp:487
constexpr const_iterator cend() const noexcept
Iterator to beyond the last cell on this axis.
Definition grid_layout.hpp:515
constexpr iterator begin() noexcept
Iterator to the first cell on this axis.
Definition grid_layout.hpp:480
constexpr const_reference front() const noexcept
Get the first element.
Definition grid_layout.hpp:574
Definition grid_layout.hpp:236
int maximum
The maximum width/height of the cells.
Definition grid_layout.hpp:247
int margin_after
The right/bottom margin of the cells.
Definition grid_layout.hpp:255
bool beyond_maximum
Allow this cell to be resized beyond the maximum constraint.
Definition grid_layout.hpp:271
int extent
Size of the cell.
Definition grid_layout.hpp:283
int margin_before
The left/top margin of the cells.
Definition grid_layout.hpp:251
int minimum
The minimum width/height of the cells.
Definition grid_layout.hpp:239
int preferred
The preferred width/height of the cells.
Definition grid_layout.hpp:243
int padding_before
The left/top padding of the cells.
Definition grid_layout.hpp:259
alignment_type alignment
The alignment of the cells.
Definition grid_layout.hpp:267
int position
The position of the cell.
Definition grid_layout.hpp:277
std::optional< int > guideline
The before-position within this cell where to align to.
Definition grid_layout.hpp:289
int padding_after
The right/bottom padding of the cells.
Definition grid_layout.hpp:263
Grid layout algorithm.
Definition grid_layout.hpp:934
constexpr bool cell_in_use(size_t first_column, size_t first_row, size_t last_column, size_t last_row) noexcept
Check if the cell on the grid is already in use.
Definition grid_layout.hpp:1021
constexpr reference add_cell(size_t first_column, size_t first_row, size_t last_column, size_t last_row, Value &&value, bool beyond_maximum=false) noexcept
Check if the cell on the grid is already in use.
Definition grid_layout.hpp:1056
constexpr reference add_cell(size_t column, size_t row, Value &&value, bool beyond_maximum=false) noexcept
Check if the cell on the grid is already in use.
Definition grid_layout.hpp:1082
constexpr void set_layout(box_shape const &shape, int baseline_adjustment) noexcept
Layout the cells based on the width and height.
Definition grid_layout.hpp:1132
T emplace_back(T... args)