package matrix
Build not yet checked sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>
Fast, modern terminal toolkit for OCaml
Install
dune-project
Dependency
Authors
Maintainers
Sources
mosaic-0.3.0.tbz
sha256=a92cbbcbe016fb19fb0a749222da0e459a9567aef3f4c7340d9bd6b71c53ed6f
sha512=6a7ab054605538bb31a2b73a1a6d093981a2704c9f0af5852221c05735290d74aca7c7282298c4d0f91e86a800e2ccd94b4918af883cd963449c758eb6b272b3
doc/src/matrix.cli/matrix_cli.ml.html
Source file matrix_cli.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 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592module Progress = struct type choice = [ `Auto | `Tty | `Plain | `Quiet | `Json ] type t = [ `Tty | `Plain | `Quiet | `Json ] (* BuildKit's names for its --progress modes (docker build --progress), which buildx, compose and ocaml-console use too. *) let choices = [ ("auto", `Auto); ("tty", `Tty); ("plain", `Plain); ("quiet", `Quiet); ("json", `Json); ] (* A CI job: CI set to anything but "", "0" or "false", the values that say no. cargo counts any value (cargo-util's is_ci, CI or TF_BUILD set); an empty CI is unset here as Ansi.Styling reads its variables, and "0" and "false" are a user turning it off. *) let ci getenv = match getenv "CI" with | None | Some ("" | "0" | "false") -> false | _ -> true let decide ?(progress = `Auto) getenv ~tty ~dumb = let rows = tty && not dumb in match progress with | `Auto -> if rows && not (ci getenv) then `Tty else `Plain | `Tty -> if rows then `Tty else `Plain | (`Plain | `Quiet | `Json) as m -> m end (* Adapting. The adapter reads the program's bytes with Ansi.Parser and keeps the style the program's SGR and OSC 8 select ([want]) apart from the style written on the current line ([have], [link]): a style is written just before the text it applies to, at the styling, and closed at each line end and at the end of each call, so every call's bytes are whole lines of their own and a style never spills into what another writer prints next. *) (* The OSC being read. Only OSC 8 ; params ; uri has an effect, so the adapter knows from the first two bytes whether to keep anything, and of an OSC 8 keeps the URI alone, in [uri]. [Start] is an OSC just opened, [Eight] one that begins with 8, [Params] one past [8 ;], [Uri] one past its params, [Long] one whose URI is longer than [uri_max], [Skip] an OSC that is not OSC 8, and [Outside] no OSC. *) type osc = Outside | Start | Eight | Params | Uri | Long | Skip (* The OSC 8 specification sets no maximum, and "Both VTE and iTerm2 limit the URI to 2083 bytes" (Egmont Koblinger, "Hyperlinks (a.k.a. HTML-like anchors) in terminal emulators"). VTE takes a longer URI as an empty one, which ends the link, and so does the adapter: the text after it stays, unlinked. *) let uri_max = 2083 type adapter = { styling : Ansi.Styling.t; parser : Ansi.Parser.t; mutable want : Ansi.Style.t; mutable have : Ansi.Style.t; mutable link : string option; mutable osc : osc; uri : Buffer.t; mutable cr : bool; } let adapter styling = { styling; parser = Ansi.Parser.create (); want = Ansi.Style.default; have = Ansi.Style.default; link = None; osc = Outside; uri = Buffer.create 64; cr = false; } let close a b = if Option.is_some a.link then ( Buffer.add_string b (Ansi.to_string Ansi.hyperlink_end); a.link <- None); if not (Ansi.Style.equal a.have Ansi.Style.default) then ( Buffer.add_string b "\027[0m"; a.have <- Ansi.Style.default) let open_style a b = match a.styling with | `Plain -> () | #Ansi.Color.depth as depth -> let link = Ansi.Style.link a.want in if link <> a.link then ( Buffer.add_string b (Ansi.to_string (match link with | Some url -> Ansi.hyperlink_start ~params:"" ~url | None -> Ansi.hyperlink_end)); a.link <- link); let want = Ansi.Style.unlink a.want in let want = if depth = `Mono then Ansi.Style.(with_no_fg (with_no_bg want)) else want in Buffer.add_string b (Ansi.Style.sgr_sequence ~depth ~prev:a.have want); a.have <- want let line_end a b = close a b; Buffer.add_char b '\n' (* [osc_data a d i] reads the content [d] of the OSC from [i]. *) let rec osc_data a d i = if i < String.length d then match a.osc with | Start -> a.osc <- (if d.[i] = '8' then Eight else Skip); osc_data a d (i + 1) | Eight -> a.osc <- (if d.[i] = ';' then Params else Skip); osc_data a d (i + 1) | Params -> ( match String.index_from_opt d i ';' with | Some j -> a.osc <- Uri; osc_data a d (j + 1) | None -> ()) | Uri -> let n = String.length d - i in if Buffer.length a.uri + n <= uri_max then Buffer.add_substring a.uri d i n else a.osc <- Long | Outside | Long | Skip -> () (* OSC 8 ; params ; uri sets the link of the text after it, or ends it when the uri is empty or too long. *) let osc_end a = match a.osc with | Uri when Buffer.length a.uri > 0 -> a.want <- Ansi.Style.hyperlink (Buffer.contents a.uri) a.want | Uri | Long -> a.want <- Ansi.Style.unlink a.want | Outside | Start | Eight | Params | Skip -> () let token a b : Ansi.Parser.token -> unit = function | Text s -> a.cr <- false; open_style a b; Buffer.add_string b s | Control '\t' -> a.cr <- false; open_style a b; Buffer.add_char b '\t' | Control '\r' -> if not a.cr then line_end a b; a.cr <- true | Control ('\n' | '\x0b' | '\x0c' | '\x85') -> if a.cr then a.cr <- false else line_end a b | Control _ | Esc _ -> () | Csi { marker = None; intermediates = ""; final = 'm'; params } -> a.want <- Ansi.Style.apply_sgr params a.want | Csi _ -> () | Open Osc -> Buffer.clear a.uri; a.osc <- Start | Open _ -> () | Data d -> osc_data a d 0 | Close (`St | `Bel) -> osc_end a; a.osc <- Outside | Close `Aborted -> a.osc <- Outside let adapt a s = let b = Buffer.create (String.length s + 16) in let (_ : int) = Ansi.Parser.feed a.parser (Bytes.unsafe_of_string s) ~off:0 ~len:(String.length s) (token a b) in close a b; Buffer.contents b let formatter styling write = let a = adapter styling in let pending = Buffer.create 256 in let out_string s off len = Buffer.add_substring pending s off len in let out_flush () = let s = Buffer.contents pending in Buffer.clear pending; let bytes = adapt a s in if bytes <> "" then write bytes in Format.make_formatter out_string out_flush module Lines = Matrix_grid.Lines module Table = struct type column = { floor : int; min : int; max : int; grow : int } (* [share total w] splits [total] cells by the weights [w], which sum to more than [0], by largest remainders, ties to the earlier index. *) let total w = let n = Array.length w in let sum = Array.fold_left ( + ) 0 w in let out = Array.make n 0 and rem = Array.make n 0 in let given = ref 0 in for i = 0 to n - 1 do let p = total * w.(i) in out.(i) <- p / sum; rem.(i) <- p mod sum; given := !given + out.(i) done; for _ = 1 to total - !given do let best = ref (-1) in for i = 0 to n - 1 do if w.(i) > 0 && (!best < 0 || rem.(i) > rem.(!best)) then best := i done; out.(!best) <- out.(!best) + 1; rem.(!best) <- -1 done; out let widths cols ~room = Array.iter (fun c -> if c.floor < 0 || c.min < c.floor || c.max < c.min || c.grow < 0 then invalid_arg (Printf.sprintf "Matrix_cli.Table.widths: column { floor = %d; min = %d; max = \ %d; grow = %d }" c.floor c.min c.max c.grow)) cols; let sum f = Array.fold_left (fun a c -> a + f c) 0 cols in (* Each column's [base], and a share of the room beyond their sum by [weight] when some weight is positive. *) let between base weight = let extra = room - sum base in let w = Array.map weight cols in if extra <= 0 || Array.for_all (fun w -> w = 0) w then Array.map base cols else let s = share extra w in Array.mapi (fun i c -> base c + s.(i)) cols in if room >= sum (fun c -> c.max) then between (fun c -> c.max) (fun c -> c.grow) else if room >= sum (fun c -> c.min) then between (fun c -> c.min) (fun c -> c.max - c.min) else between (fun c -> c.floor) (fun c -> c.min - c.floor) type frame = { edge : Lines.weight option; line : Lines.weight option; pad : int; } type row = Rule of Lines.weight | Row of int | Spanned of int * int list let edge f = if Option.is_some f.edge then 1 else 0 let side f = if Option.is_some f.edge then 1 + f.pad else 0 let gap f = (2 * f.pad) + if Option.is_some f.line then 1 else 0 let chrome f n = if n = 0 then 2 * edge f else (2 * side f) + ((n - 1) * gap f) let width f ws = chrome f (Array.length ws) + Array.fold_left ( + ) 0 ws let row_height = function Rule _ -> 1 | Row h | Spanned (h, _) -> max 0 h let height f rows = (2 * edge f) + List.fold_left (fun a r -> a + row_height r) 0 rows type placed = { row : Matrix_grid.region; cells : Matrix_grid.region array } let place ~x ~y f ws rows = let n = Array.length ws in let total = width f ws in let xs = Array.make n 0 in for i = 0 to n - 1 do xs.(i) <- (if i = 0 then x + side f else xs.(i - 1) + ws.(i - 1) + gap f) done; let cell ~y ~h a b = { Matrix_grid.x = xs.(a); y; width = xs.(b) + ws.(b) - xs.(a); height = h; } in let misfit () = invalid_arg "Matrix_cli.Table.place: spans do not fit the columns" in let spanned ~y ~h spans = let cells = Array.make (List.length spans) (cell ~y ~h 0 0) in let k = ref 0 and col = ref 0 in List.iter (fun span -> if span <= 0 || !col + span > n then misfit (); cells.(!k) <- cell ~y ~h !col (!col + span - 1); incr k; col := !col + span) spans; if !col <> n then misfit (); cells in let _, placed = List.fold_left (fun (y, acc) r -> let h = row_height r in let cells = match r with | Rule _ -> [||] | Row _ -> Array.init n (fun i -> cell ~y ~h i i) | Spanned (_, s) -> if n = 0 && s = [] then [||] else spanned ~y ~h s in ( y + h, { row = { Matrix_grid.x; y; width = total; height = h }; cells } :: acc )) (y + edge f, []) rows in List.rev placed let draw ?glyphs ?style g ~x ~y f ws rows = let w = width f ws and h = height f rows in let l = Lines.create ~x ~y ~width:w ~height:h in Option.iter (fun weight -> Lines.hline ~weight ?style l ~x ~y ~length:w; Lines.hline ~weight ?style l ~x ~y:(y + h - 1) ~length:w; Lines.vline ~weight ?style l ~x ~y ~length:h; Lines.vline ~weight ?style l ~x:(x + w - 1) ~y ~length:h) f.edge; (* A row's lines between its cells reach into the rule or edge above and below it, so that they join it. *) let rec go ~above = function | [] -> () | (r, (p : placed)) :: rest -> (match r with | Rule weight -> Lines.hline ~weight ?style l ~x ~y:p.row.y ~length:w | Row _ | Spanned _ -> ( match f.line with | None -> () | Some weight -> let below = match rest with | (Rule _, _) :: _ -> true | [] -> Option.is_some f.edge | _ -> false in let top = if above then p.row.y - 1 else p.row.y in let bottom = p.row.y + p.row.height - if below then 0 else 1 in Array.iteri (fun i (c : Matrix_grid.region) -> if i > 0 then Lines.vline ~weight ?style l ~x:(c.x - f.pad - 1) ~y:top ~length:(bottom - top + 1)) p.cells)); go ~above:(match r with Rule _ -> true | _ -> false) rest in go ~above:(Option.is_some f.edge) (List.combine rows (place ~x ~y f ws rows)); Matrix_grid.draw_lines ?glyphs g l (* ───── Tables of text ───── *) type align = [ `Left | `Center | `Right ] type overflow = [ `Wrap | `Truncate ] type text_column = { align : align; overflow : overflow } type cell = Ansi.span list let cell ?style text = [ Ansi.span ?style text ] type text_row = Cells of cell array | Separator of Lines.weight let tab_width = 2 (* The widest of the pieces of [s]'s lines between their wrap breaks, without the blanks that end them, which hang where a row wraps. *) let widest_word ~width_method s = let widest = ref 0 in let line l = let start = ref 0 in let piece stop = let e = ref stop in while !e > !start && (l.[!e - 1] = ' ' || l.[!e - 1] = '\t') do decr e done; widest := max !widest (Matrix_text.measure_sub ~width_method ~tab_width l ~pos:!start ~len:(!e - !start)); start := stop in Matrix_text.iter_wrap_breaks (fun ~break_byte_offset:_ ~next_byte_offset ~grapheme_offset:_ -> piece next_byte_offset) l; piece (String.length l) in List.iter line (String.split_on_char '\n' s); !widest let max_content ~width_method s = Matrix_text.Layout.max_width (Matrix_text.Layout.create ~width_method ~tab_width (Matrix_text.Layout.Source.of_string s) ~width:0 ~wrap:`None) let layout ~width_method c width text = let src = Matrix_text.Layout.Source.of_string text in match c.overflow with | `Wrap -> Matrix_text.Layout.create ~width_method ~tab_width src ~width ~wrap:`Word | `Truncate -> Matrix_text.Layout.create ~width_method ~tab_width ~truncate:true src ~width ~wrap:`None (* A cell's text as one text, as Ansi.sanitize_spans leaves it, and the style of the grapheme at each byte offset of it. *) type text = { text : string; starts : int array; styles : Ansi.Style.t array } let text spans = let spans = Array.of_list (Ansi.sanitize_spans spans) in let starts = Array.make (Array.length spans) 0 in for i = 1 to Array.length spans - 1 do starts.(i) <- starts.(i - 1) + String.length spans.(i - 1).Ansi.text done; { text = String.concat "" (Array.to_list (Array.map (fun (s : Ansi.span) -> s.text) spans)); starts; styles = Array.map (fun (s : Ansi.span) -> s.style) spans; } let style_at t off = let i = ref 0 in while !i + 1 < Array.length t.starts && t.starts.(!i + 1) <= off do incr i done; if Array.length t.styles = 0 then Ansi.Style.default else t.styles.(!i) let grid ?glyphs ?style ?(width_method = `Unicode) f ~room cols rows = let rows = List.map (function | Cells cs -> `Cells (Array.map text cs) | Separator w -> `Rule w) rows in let n = Array.length cols in let cells = List.filter_map (function | `Cells cs -> if Array.length cs <> n then invalid_arg (Printf.sprintf "Matrix_cli.Table.grid: a row of %d cells in %d columns" (Array.length cs) n); Some cs | `Rule _ -> None) rows in let need i c = let fold f = List.fold_left (fun a cs -> max a (f cs.(i).text)) 0 cells in let max_ = fold (max_content ~width_method) in let min_ = match c.overflow with | `Truncate -> max_ | `Wrap -> min max_ (fold (widest_word ~width_method)) in { floor = min 1 min_; min = min_; max = max_; grow = 0 } in let needs = Array.mapi need cols and room = room - chrome f n in (* Below the min-content widths, the wrapped columns narrow first, the truncated ones held at theirs, and the truncated ones only once the wrapped ones are at their floors. *) let truncated i = cols.(i).overflow = `Truncate in let held = Array.mapi (fun i c -> if truncated i then { c with floor = c.min } else c) needs in let ws = if room >= Array.fold_left (fun a c -> a + c.floor) 0 held then widths held ~room else widths ~room (Array.mapi (fun i c -> if truncated i then c else { c with min = c.floor; max = c.floor }) needs) in let rows_of cs = let h = ref 1 in Array.iteri (fun i c -> h := max !h (Matrix_text.Layout.row_count (layout ~width_method cols.(i) ws.(i) c.text))) cs; !h in let shape = List.map (function `Cells cs -> Row (rows_of cs) | `Rule w -> Rule w) rows in let g = Matrix_grid.create ~width_method ~width:(max 1 (width f ws)) ~height:(max 1 (height f shape)) () in draw ?glyphs ?style g ~x:0 ~y:0 f ws shape; List.iter2 (fun r (p : placed) -> match r with | `Rule _ -> () | `Cells cs -> Array.iteri (fun i (reg : Matrix_grid.region) -> let c = cs.(i) and col = cols.(i) in let l = layout ~width_method col reg.width c.text in let src = Matrix_text.Layout.source l in for row = 0 to Matrix_text.Layout.row_count l - 1 do (* A line is aligned by its cells up to its last one that is not a blank. *) let ink = ref 0 in Matrix_text.Layout.iter_cells l ~row ~first_column:0 ~last_column:reg.width (fun ~first ~last ~column ~width ~ellipsis -> let t = Matrix_text.Layout.Source.slice src ~first ~last in if ellipsis || (t <> " " && t <> "\t") then ink := column + width); let free = reg.width - !ink in let x = reg.x + match col.align with | `Left -> 0 | `Center -> max 0 free / 2 | `Right -> max 0 free in Matrix_text.Layout.iter_cells l ~row ~first_column:0 ~last_column:reg.width (fun ~first ~last ~column ~width:_ ~ellipsis -> let text = if ellipsis then "…" else Matrix_text.Layout.Source.slice src ~first ~last in let style = style_at c (Matrix_text.Layout.Source.byte_offset src first) in Matrix_grid.draw_text ~style g ~x:(x + column) ~y:(reg.y + row) ~text) done) p.cells) rows (place ~x:0 ~y:0 f ws shape); g end module Tree = struct type guide = { branch : string; last : string; pipe : string; space : string } let single = { branch = "├── "; last = "└── "; pipe = "│ "; space = " " } let ascii = { branch = "|-- "; last = "`-- "; pipe = "| "; space = " " } let fold ~children f roots acc = let rec node lasts x acc = siblings lasts (children x) (f lasts x acc) and siblings lasts xs acc = match xs with | [] -> acc | [ x ] -> node (true :: lasts) x acc | x :: xs -> siblings lasts xs (node (false :: lasts) x acc) in List.fold_left (fun acc r -> node [] r acc) acc roots let rails g lasts = String.concat "" (List.rev_map (fun last -> if last then g.space else g.pipe) lasts) let prefix g = function | [] -> "" | own :: up -> rails g up ^ if own then g.last else g.branch end
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>