package console
All checked builds pass sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>
Colours, tables, trees and progress rows for the terminal
Install
dune-project
Dependency
Authors
Maintainers
Sources
console-0.9.0.tbz
sha256=1c6851dbc38514bf717da9bbe9cddda3c2958b215f934dee69324f1ec243873f
sha512=71bd51d2cbaf945ae153e863c2de189b32f3049c750131cc32e96e43759e4d8b62f9bf8863ff2e80429d56d32209573b85d3da9e0d67ad52bb1106b4c763070f
doc/src/console.input/console_input.ml.html
Source file console_input.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(*--------------------------------------------------------------------------- Copyright (c) 2026 Thomas Gazagnaire. All rights reserved. SPDX-License-Identifier: ISC ---------------------------------------------------------------------------*) (* [Csi_intermediate] is after an intermediate byte of a control sequence, which only intermediates and the final byte follow. [Ss3] is after ESC O, which a terminal in application cursor mode sends before an arrow's letter. *) type esc = Normal | Esc | Csi | Csi_intermediate | Ss3 (* The line is a zipper of grapheme clusters split at the cursor: [left] holds the clusters before the cursor nearest-first (reversed), [right] those at and after it in order. Editing a whole cluster at a time keeps a character and its marks together, on the screen as in the line. *) type t = { mutable left : string list; mutable right : string list; prompt : string; complete : string -> string list; mask : string option; (* replacement echoed for each secret character *) mutable hist : string list; (* submitted lines, newest first, seed included *) mutable pos : int option; (* history index being viewed, newest is 0 *) mutable draft : string; (* line in progress, saved while navigating *) mutable esc : esc; mutable after_cr : bool; (* last byte was '\r', so swallow a following '\n' *) mutable partial : string; (* the start of a character, to be completed *) widths : (string, int) Hashtbl.t; (* the cells of clusters met, a few *) } (* What the editor echoes is text, never a control the terminal acts on. *) let clean = Console_text.sanitize ~keep_newlines:false let v ?(prompt = "") ?(history = []) ?(complete = fun _ -> []) ?mask () = { left = []; right = []; prompt = clean prompt; complete; mask = Option.map clean mask; hist = (if Option.is_some mask then [] else List.rev_map clean history); pos = None; draft = ""; esc = Normal; after_cr = false; partial = ""; widths = Hashtbl.create 64; } let line t = String.concat "" (List.rev_append t.left t.right) let pending t = line t let history t = List.rev t.hist let add = Buffer.add_string let clusters = Width.clusters let display_char t c = match t.mask with Some mask -> mask | None -> c let display t s = String.concat "" (List.map (display_char t) (clusters s)) (* A masked editor measures the replacement glyphs, never the secret characters they conceal. *) let width t s = Width.string_width (display t s) let display_chars t cs = String.concat "" (List.map (display_char t) cs) let cols t cs = Width.string_width (display_chars t cs) (* Move the cursor back over [t.right] after rewriting it, one backspace per cell. *) let reposition t echo = let tail = cols t t.right in if tail > 0 then add echo (String.make tail '\b') (* The cells of the cluster [c], remembered: an edit measures the clusters around the cursor several times. *) let cluster_cells t c = match Hashtbl.find_opt t.widths c with | Some n -> n | None -> let n = Width.string_width c in if Hashtbl.length t.widths >= 1024 then Hashtbl.reset t.widths; Hashtbl.add t.widths c n; n (* [cols t cs], as the sum of the cells of each cluster where the line shows the clusters themselves. *) let cells t cs = match t.mask with | None -> List.fold_left (fun n c -> n + cluster_cells t c) 0 cs | Some _ -> cols t cs let rec take n = function x :: l when n > 0 -> x :: take (n - 1) l | _ -> [] let rec drop n = function _ :: l when n > 0 -> drop (n - 1) l | l -> l (* The number of first clusters of [a] and [b], at most [max], that show the same. *) let rec same t ~max n a b = match (a, b) with | x :: a, y :: b when n < max && String.equal (display_char t x) (display_char t y) -> same t ~max (n + 1) a b | _ -> n (* The clusters [cs] split [at] bytes into their text or, if that is inside a cluster, after it: those before, nearest-first, and those after. *) let split cs ~at = let rec go acc off = function | c :: rest when off < at -> go (c :: acc) (off + String.length c) rest | rest -> (acc, rest) in go [] 0 cs (* The clusters of [text] followed by those of [right] that it changes, with the rest of [right]. An edit changes the clusters from the one before the cursor up to the first one of [right] that is still a cluster of its own after it: past it, the segmenter is in the state it was, as a cluster after another starts with no mark to carry state across it. *) let rec rejoin text taken right = let cs = clusters (text ^ String.concat "" (List.rev taken)) in match (taken, right) with | r :: _, _ when String.equal (List.nth cs (List.length cs - 1)) r -> (cs, List.rev taken, right) | _, [] -> (cs, List.rev taken, []) | _, r :: right -> rejoin text (r :: taken) right (* Replace the cluster before the cursor, and [erased] if any, with that cluster followed by [s]. The line is segmented again from that cluster, since [s] can join the clusters on either side of the cursor and an erased cluster can let its neighbours join. The cursor goes after [s], or after the cluster [s] ends inside, so that it never stands inside a cluster. On the screen, the line is drawn again from its first changed cluster, whole, as a terminal does not join a mark written after the text that follows it; the cells a narrower line leaves are blanked, and the cursor steps back. A cluster of no width with nothing before it to join is dropped, as a terminal drops it in the first column, except from a secret. *) let edit t echo ~erased s = t.pos <- None; let left = if erased = "" then t.left else List.tl t.left in let s = if left <> [] || t.mask <> None then s else match clusters s with | c :: cs when Width.string_width c = 0 -> String.concat "" cs | _ -> s in if s <> "" || erased <> "" then begin let prev, before = match left with c :: l -> ([ c ], l) | [] -> ([], []) in let prev_text = String.concat "" prev in let changed, old_right, rest = rejoin (prev_text ^ s) [] t.right in let now_left, now_right = split changed ~at:(String.length prev_text + String.length s) in t.left <- now_left @ before; t.right <- now_right @ rest; let before_cursor = prev @ if erased = "" then [] else [ erased ] in let was = before_cursor @ old_right in let n = List.length before_cursor in let k = same t ~max:n 0 was changed in let redrawn = drop k changed in let cursor = cells t before_cursor in let kept = if k = n then cursor else cells t (take k was) in let blank = max 0 (cursor + cells t old_right - (kept + cells t redrawn)) in add echo (String.make (cursor - kept) '\b'); add echo (display_chars t redrawn); add echo (display_chars t rest); add echo (String.make blank ' '); add echo (String.make (cells t now_right + cells t rest + blank) '\b') end let insert t echo s = edit t echo ~erased:"" s (* Erase the cluster before the cursor. At the end of the line this is the familiar "\b \b". *) let backspace t echo = match t.left with [] -> () | c :: _ -> edit t echo ~erased:c "" let cursor_left t echo = match t.left with | [] -> () | c :: tl -> t.left <- tl; t.right <- c :: t.right; add echo (String.make (width t c) '\b') let cursor_right t echo = match t.right with | [] -> () | c :: tl -> t.right <- tl; t.left <- c :: t.left; add echo (display_char t c) let submit t echo = let line = line t in t.left <- []; t.right <- []; add echo "\r\n"; (if String.length line > 0 && t.mask = None then match t.hist with | last :: _ when String.equal last line -> () | _ -> t.hist <- line :: t.hist); t.pos <- None; t.draft <- ""; line (* Replace the whole line with [s] (history recall): move to the end, erase every character, then write [s] with the cursor left at its end. *) let recall t echo s = add echo (display_chars t t.right); for _ = 1 to width t (line t) do add echo "\b \b" done; t.left <- List.rev (clusters s); t.right <- []; add echo (display t s) let hist_prev t echo = match (t.mask, t.hist) with | Some _, _ -> () | None, [] -> () | None, _ -> let last = List.length t.hist - 1 in let i = match t.pos with None -> 0 | Some i -> min (i + 1) last in if t.pos = None then t.draft <- line t; t.pos <- Some i; recall t echo (List.nth t.hist i) let hist_next t echo = match (t.mask, t.pos) with | Some _, _ -> () | None, None -> () | None, Some 0 -> t.pos <- None; recall t echo t.draft | None, Some i -> t.pos <- Some (i - 1); recall t echo (List.nth t.hist (i - 1)) (* The longest run of whole clusters every candidate starts with. *) let common_prefix = function | [] -> "" | first :: rest -> let rec common acc a b = match (a, b) with | x :: a, y :: b when String.equal x y -> common (x :: acc) a b | _ -> List.rev acc in String.concat "" (List.fold_left (fun p s -> common [] p (clusters s)) (clusters first) rest) (* The word completion acts on is the run after the last space before the cursor. *) let last_word s = match String.rindex_opt s ' ' with | None -> s | Some i -> String.sub s (i + 1) (String.length s - i - 1) let complete t echo = if t.mask <> None then () else let before = String.concat "" (List.rev t.left) in let word = last_word before in let candidates = List.map clean (t.complete word) in match List.filter (String.starts_with ~prefix:word) candidates with | [] -> () | candidates -> let lcp = common_prefix candidates in if String.length lcp > String.length word then insert t echo (String.sub lcp (String.length word) (String.length lcp - String.length word)); if List.length candidates > 1 then begin add echo "\r\n"; add echo (String.concat " " candidates); add echo "\r\n"; add echo t.prompt; add echo (display t (line t)); reposition t echo end (* [bytes], a character or a maximal part of one that [String.get_utf_8_uchar] reads as no character: inserted, the latter as one replacement character, or kept as typed in a secret. *) let character t echo ~valid bytes = let c = if t.mask <> None then bytes else clean (if valid then bytes else "\xef\xbf\xbd") in if c <> "" then insert t echo c (* [s], a part of a character, is the start of one that more bytes can complete: some continuation byte makes the decoder read further. *) let continues s = List.exists (fun next -> Uchar.utf_decode_length (String.get_utf_8_uchar (s ^ next) 0) > String.length s) [ "\x80"; "\x90"; "\xa0" ] let rec normal t echo lines ~after_cr c = let code = Char.code c in if t.partial <> "" || code >= 0x80 then begin let s = t.partial ^ String.make 1 c in let d = String.get_utf_8_uchar s 0 in let n = Uchar.utf_decode_length d in let valid = Uchar.utf_decode_is_valid d in if (not valid) && n = String.length s && continues s then t.partial <- s else begin t.partial <- ""; character t echo ~valid (String.sub s 0 n); (* The byte that ends no character is read again. *) if n < String.length s then normal t echo lines ~after_cr c end end else match c with | '\027' -> t.esc <- Esc | '\r' -> t.after_cr <- true; lines := submit t echo :: !lines | '\n' -> if not after_cr then lines := submit t echo :: !lines | '\t' -> complete t echo | '\127' | '\008' -> backspace t echo | c when code >= 0x20 -> insert t echo (String.make 1 c) | _ -> () let arrow t echo = function | 'A' -> hist_prev t echo | 'B' -> hist_next t echo | 'C' -> cursor_right t echo | 'D' -> cursor_left t echo | _ -> () (* ECMA-48 5.4: parameter bytes 03/00-03/15, intermediate bytes 02/00-02/15, then the final byte, 04/00-07/14. With intermediates, the final byte names another function than an arrow. *) let csi t echo ~intermediate c = let code = Char.code c in if code >= 0x40 && code <= 0x7e then begin if not intermediate then arrow t echo c; t.esc <- Normal end else if code >= 0x20 && code <= 0x2f then t.esc <- Csi_intermediate else if intermediate || not (code >= 0x30 && code <= 0x3f) then t.esc <- Normal let feed t input = let echo = Buffer.create (String.length input) in let lines = ref [] in String.iter (fun c -> let after_cr = t.after_cr in t.after_cr <- false; match t.esc with | Esc -> t.esc <- (match c with '[' -> Csi | 'O' -> Ss3 | _ -> Normal) | Csi -> csi t echo ~intermediate:false c | Csi_intermediate -> csi t echo ~intermediate:true c | Ss3 -> arrow t echo c; t.esc <- Normal | Normal -> normal t echo lines ~after_cr c) input; (Buffer.contents echo, List.rev !lines)
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>