package toffee
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>
CSS layout engine for OCaml (Flexbox, Grid, Block)
Install
dune-project
Dependency
Authors
Maintainers
Sources
mosaic-0.1.0.tbz
sha256=9e4e90d17f9b2af1b07071fe425bc2c519c849c4f1d1ab73cde512be2d874849
sha512=06e9c4a741590942e81a27738d0b5c0413fafec8cf3b7dae047ad69f155e7b718aa4223818dc161b7d028efffcfd3365905e264d6fd31d453910ddfa91dcf9b9
doc/src/toffee.compute/compute.ml.html
Source file compute.ml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335open Geometry open Style open Tree let compute_leaf_layout = Leaf.compute_leaf_layout let compute_block_layout = Compute_block.compute_block_layout let compute_flexbox_layout = Compute_flexbox.compute_flexbox_layout let compute_grid_layout = Compute_grid.compute_grid_layout (** Compute layout for the root node in the tree *) let compute_root_layout (type t) (module Tree : Tree.LAYOUT_PARTIAL_TREE with type t = t) (tree : t) (root : Node_id.t) (available_space : Available_space.t size) : unit = let mut_known_dimensions = ref Size.none in (* Block layout specific setup *) let parent_size = Size.map Available_space.to_option available_space in let style = Tree.get_core_container_style tree root in (if Style.display style = Display.Block then (* Pull these out earlier to avoid borrowing issues *) let aspect_ratio = Style.aspect_ratio style in let calc = Tree.resolve_calc_value tree in let margin = Style.margin style |> Rect.map (fun lpa -> Length_percentage_auto.resolve_or_zero lpa parent_size.width calc) in let padding = Style.padding style |> Rect.map (fun lp -> Length_percentage.resolve_or_zero lp parent_size.width calc) in let border = Style.border style |> Rect.map (fun lp -> Length_percentage.resolve_or_zero lp parent_size.width calc) in let padding_border_size = Rect.sum_axes (Rect.add padding border) in let box_sizing_adjustment = if Style.box_sizing style = Box_sizing.Content_box then padding_border_size else Size.zero in let min_size = Style.min_size style |> fun dims -> Size. { width = Dimension.maybe_resolve dims.width parent_size.width calc; height = Dimension.maybe_resolve dims.height parent_size.height calc; } |> Size.apply_aspect_ratio aspect_ratio |> Size.maybe_add box_sizing_adjustment in let max_size = Style.max_size style |> fun dims -> Size. { width = Dimension.maybe_resolve dims.width parent_size.width calc; height = Dimension.maybe_resolve dims.height parent_size.height calc; } |> Size.apply_aspect_ratio aspect_ratio |> Size.maybe_add box_sizing_adjustment in let clamped_style_size = Style.size style |> fun dims -> Size. { width = Dimension.maybe_resolve dims.width parent_size.width calc; height = Dimension.maybe_resolve dims.height parent_size.height calc; } |> Size.apply_aspect_ratio aspect_ratio |> Size.maybe_add box_sizing_adjustment |> Size.clamp_option min_size max_size in (* If both min and max in a given axis are set and max <= min then this determines the size in that axis *) let min_max_definite_size = Size.map2 (fun min max -> match (min, max) with | Some min_v, Some max_v when max_v <= min_v -> Some min_v | _ -> None) min_size max_size in (* Block nodes automatically stretch fit their width to fit available space if available space is definite *) let available_space_based_size = Size. { width = (match available_space.width with | Available_space.Definite w -> Some (w -. Rect.horizontal_axis_sum margin) | _ -> None); height = None; } in let styled_based_known_dimensions = !mut_known_dimensions |> fun dims -> Size.choose_first dims min_max_definite_size |> fun dims -> Size.choose_first dims clamped_style_size |> fun dims -> Size.choose_first dims available_space_based_size |> fun dims -> Size.maybe_max padding_border_size dims in mut_known_dimensions := styled_based_known_dimensions); (* Recursively compute node layout *) let output = Tree.compute_child_layout tree root (Layout_input.make ~run_mode:Run_mode.Perform_layout ~sizing_mode:Sizing_mode.Inherent_size ~axis:Requested_axis.Both ~known_dimensions:!mut_known_dimensions ~parent_size ~available_space ~vertical_margins_are_collapsible:Line.both_false) in let style = Tree.get_core_container_style tree root in let calc = Tree.resolve_calc_value tree in let padding = Style.padding style |> Rect.map (fun lp -> Length_percentage.resolve_or_zero lp (Available_space.to_option available_space.width) calc) in let border = Style.border style |> Rect.map (fun lp -> Length_percentage.resolve_or_zero lp (Available_space.to_option available_space.width) calc) in let margin = Style.margin style |> Rect.map (fun lpa -> Length_percentage_auto.resolve_or_zero lpa (Available_space.to_option available_space.width) calc) in let scrollbar_size = Size. { width = (if (Style.overflow style).y = Overflow.Scroll then Style.scrollbar_width style else 0.0); height = (if (Style.overflow style).x = Overflow.Scroll then Style.scrollbar_width style else 0.0); } in Tree.set_unrounded_layout tree root (Layout.make ~order:0 ~location:Point.zero ~size:(Layout_output.size output) ~content_size:(Layout_output.content_size output) ~scrollbar_size ~padding ~border (* TODO: support auto margins for root node? *) ~margin) (** Attempts to find a cached layout for the specified node and layout inputs. Uses the provided closure to compute the layout (and then stores the result in the cache) if no cached layout is found. *) let compute_cached_layout (type t) (module Tree : Tree.CACHE_TREE with type t = t) (tree : t) (node : Node_id.t) (inputs : Layout_input.t) (compute_uncached : t -> Node_id.t -> Layout_input.t -> Layout_output.t) : Layout_output.t = let known_dimensions = Layout_input.known_dimensions inputs in let available_space = Layout_input.available_space inputs in let run_mode = Layout_input.run_mode inputs in (* First we check if we have a cached result for the given input *) match Tree.cache_get tree node ~known_dimensions ~available_space ~run_mode with | Some cached_size_and_baselines -> cached_size_and_baselines | None -> let computed_size_and_baselines = compute_uncached tree node inputs in (* Cache result *) Tree.cache_store tree node ~known_dimensions ~available_space ~run_mode computed_size_and_baselines; computed_size_and_baselines (** Rounds the calculated layout to exact pixel values In order to ensure that no gaps in the layout are introduced we: - Always round based on the cumulative x/y coordinates (relative to the viewport) rather than parent-relative coordinates - Compute width/height by first rounding the top/bottom/left/right and then computing the difference rather than rounding the width/height directly See https://github.com/facebook/yoga/commit/aa5b296ac78f7a22e1aeaf4891243c6bb76488e2 for more context In order to prevent inaccuracies caused by rounding already-rounded values, we read from `unrounded_layout` and write to `final_layout`. *) let round_layout (type t) (module Tree : Tree.ROUND_TREE with type t = t) (tree : t) (node_id : Node_id.t) : unit = (* Helper for rounding - matches Rust's round function behavior *) let round f = let epsilon = 1e-6 in if f >= 0.0 then Float.floor (f +. 0.5 +. epsilon) else Float.ceil (f -. 0.5 -. epsilon) in (* Recursive function to apply rounding to all descendants *) let rec round_layout_inner node_id cumulative_x cumulative_y = let unrounded_layout = Tree.get_unrounded_layout tree node_id in let cumulative_x = cumulative_x +. (Layout.location unrounded_layout).x in let cumulative_y = cumulative_y +. (Layout.location unrounded_layout).y in let layout = Layout.make ~order:(Layout.order unrounded_layout) ~location: Point. { x = round (Layout.location unrounded_layout).x; y = round (Layout.location unrounded_layout).y; } ~size: Size. { width = round (cumulative_x +. (Layout.size unrounded_layout).width) -. round cumulative_x; height = round (cumulative_y +. (Layout.size unrounded_layout).height) -. round cumulative_y; } ~content_size: Size. { width = round (cumulative_x +. (Layout.content_size unrounded_layout).width) -. round cumulative_x; height = round (cumulative_y +. (Layout.content_size unrounded_layout).height) -. round cumulative_y; } ~scrollbar_size: Size. { width = round (Layout.scrollbar_size unrounded_layout).width; height = round (Layout.scrollbar_size unrounded_layout).height; } ~border: Rect. { left = round (cumulative_x +. (Layout.border unrounded_layout).left) -. round cumulative_x; right = round (cumulative_x +. (Layout.size unrounded_layout).width) -. round (cumulative_x +. (Layout.size unrounded_layout).width -. (Layout.border unrounded_layout).right); top = round (cumulative_y +. (Layout.border unrounded_layout).top) -. round cumulative_y; bottom = round (cumulative_y +. (Layout.size unrounded_layout).height) -. round (cumulative_y +. (Layout.size unrounded_layout).height -. (Layout.border unrounded_layout).bottom); } ~padding: Rect. { left = round (cumulative_x +. (Layout.padding unrounded_layout).left) -. round cumulative_x; right = round (cumulative_x +. (Layout.size unrounded_layout).width) -. round (cumulative_x +. (Layout.size unrounded_layout).width -. (Layout.padding unrounded_layout).right); top = round (cumulative_y +. (Layout.padding unrounded_layout).top) -. round cumulative_y; bottom = round (cumulative_y +. (Layout.size unrounded_layout).height) -. round (cumulative_y +. (Layout.size unrounded_layout).height -. (Layout.padding unrounded_layout).bottom); } ~margin:(Layout.margin unrounded_layout) in Tree.set_final_layout tree node_id layout; let child_count = Tree.child_count tree node_id in for index = 0 to child_count - 1 do let child = Tree.get_child_id tree node_id index in round_layout_inner child cumulative_x cumulative_y done in round_layout_inner node_id 0.0 0.0 module type CACHE_LAYOUT_PARTIAL_TREE = sig include Tree.LAYOUT_PARTIAL_TREE include Tree.CACHE_TREE with type t := t end (** Creates a layout for this node and its children, recursively. Each hidden node has zero size and is placed at the origin *) let (type t) (module Tree : CACHE_LAYOUT_PARTIAL_TREE with type t = t) (tree : t) (node : Node_id.t) : Layout_output.t = (* Clear cache and set zeroed-out layout for the node *) Tree.cache_clear tree node; Tree.set_unrounded_layout tree node (Layout.with_order 0); (* Perform hidden layout on all children *) let child_count = Tree.child_count tree node in for index = 0 to child_count - 1 do let child_id = Tree.get_child_id tree node index in Tree.compute_child_layout tree child_id Layout_input.hidden |> ignore done; Layout_output.hidden
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>